v_sim.NodeValuesShell¶

Subclasses:: None

Methods¶

Inherited:: v_sim.NodeValuesFrag (6), v_sim.NodeValues (17), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (arr, label)
	`compute` (id, factor)
	`getLevel` ()
	`getRoot` ()
	`setLevel` (level)

Virtual Methods¶

Inherited:: v_sim.NodeValues (4), GObject.Object (7)

Properties¶

Inherited:: v_sim.NodeValues (6)

Name	Type	Flags	Short Description
`level`	`int`	r/w	Level of recursion in shell building.
`root`	`int`	r/w	Id of the root node, or -1 if not any.

Signals¶

Inherited:: v_sim.NodeValues (1), GObject.Object (1)

Fields¶

Inherited:: v_sim.NodeValues (1), GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.NodeValuesFrag`	r
priv	`v_sim.NodeValuesShellPrivate`	r

Class Details¶

class v_sim.NodeValuesShell(**kwargs)¶

Bases:: v_sim.NodeValuesFrag
Abstract:: No
Structure:: v_sim.NodeValuesShellClass

Common name to refer to a #_VisuNodeValuesShell.

classmethod new(arr, label)¶

Parameters:

arr (v_sim.NodeArray) – a v_sim.NodeArray object.
label (str) – a translatable label.

Returns:

a newly created v_sim.NodeValuesShell object.

Return type:

v_sim.NodeValuesShell

Create a new shell field.

New in version 3.8.

compute(id, factor)¶

Parameters:

id (int) – a node id.
factor (float) – a afctor.

Returns:

True if computation succeed.

Return type:

bool

Compute the neighbouring shells of node id. The neighbour tables is computed within factor (for the sphere radii).

New in version 3.8.

getLevel()¶

Returns:: an integer value.
Return type:: int

Retrieves the current level of recursion that is done to look for neighbouring shells.

New in version 3.8.

getRoot()¶

Returns:: the node id taken as reference, or -1 if none has been set.
Return type:: int

Retrieve the node id used as reference for shell computation.

New in version 3.8.

setLevel(level)¶

Parameters:: level (int) – an integer value.
Returns:: True if the value is actually changed.
Return type:: bool

Defines the level of recursion that is done to look for neighbouring shells.

New in version 3.8.

Property Details¶

v_sim.NodeValuesShell.props.level¶

Name:: level
Type:: int
Default Value:: 5
Flags:: READABLE, WRITABLE

Level of recursion in shell building.

v_sim.NodeValuesShell.props.root¶

Name:: root
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE

Id of the root node, or -1 if not any.