v_sim.NodeList

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (array)
class	new_fromFrag (frag, label)
	add (id)
	envelope ()
	remove (id)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name	Type	Flags	Short Description
ids	GLib.Array	r/w	node ids
n-nodes	int	r	number of nodes
nodes	v_sim.NodeArray	r/w/co	nodes values are related to

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent	GObject.Object	r

Class Details

class v_sim.NodeList(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

v_sim.NodeListClass

An opaque structure.

New in version 3.8.

classmethod new(array)

Parameters:

array (v_sim.NodeArray) – a v_sim.NodeArray object.

Returns:

a pointer to the v_sim.NodeList it created or None otherwise.

Return type:

v_sim.NodeList

Creates a new v_sim.NodeList storing indexes of nodes from array..

New in version 3.8.

classmethod new_fromFrag(frag, label)

Parameters:

• frag (v_sim.NodeValuesFrag) – a v_sim.NodeValuesFrag object.

• label (str) – a label.

Returns:

a newly created v_sim.NodeList object.

Return type:

v_sim.NodeList

Create a list of nodes from the node labelled by label in frag. When the fragment definition is chaged or the node population is changed, the node list is updated accordingly.

New in version 3.8.

add(id)

Parameters:

id (int) – a node id.

Returns:

True if node is not already existing in the list.

Return type:

bool

Add id to the list of nodes.

New in version 3.8.

envelope()

Returns:

a newly created v_sim.ScalarFieldData.

Return type:

v_sim.ScalarFieldData

Compute a scalarfield corresponding to the envelope of the node list. When the node positions are changed, the scalar field is updated accordingly.

New in version 3.8.

remove(id)

Parameters:

id (int) – a node id.

Returns:

True if the id was actually in the list.

Return type:

bool

Remove id from the list of nodes.

New in version 3.8.

Property Details

v_sim.NodeList.props.ids

Name:

ids

Type:

GLib.Array

Default Value:

None

Flags:

READABLE, WRITABLE

node ids

v_sim.NodeList.props.n_nodes

Name:

n-nodes

Type:

int

Default Value:

0

Flags:

READABLE

number of nodes

v_sim.NodeList.props.nodes

Name:

nodes

Type:

v_sim.NodeArray

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

nodes values are related to