v_sim.NodeProperty¶

Fields¶

None

Methods¶

	`getArray` ()
	`getValue` (node, value)
	`reset` ()
	`setValue` (node, value)

Details¶

class v_sim.NodeProperty¶

This structure defines a storage for one property for each node of a given v_sim.NodeArray. Use v_sim.NodeArray.property_newPointer() or v_sim.NodeArray.property_newInteger() to create one property.

getArray()¶

Returns:: the v_sim.NodeArray self is attached to.
Return type:: v_sim.NodeArray

Retrieve the v_sim.NodeArray self is attached to.

New in version 3.8.

getValue(node, value)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object ;
value (GObject.Value) – an initialise GObject.Value location.

Returns:

some data associated to the key, stored the given GObject.Value location.

Return type:

GObject.Value

This method is used to retrieve some data associated to the specified node, stored in the given data. These return data should not be freed after used. The read value is stored in the given GObject.Value pointer. This GObject.Value must be of the right type, depending on the creation of the v_sim.NodeProperty.

reset()¶: Reset to zero all values, deallocating allocated memory, if any.

New in version 3.8.

setValue(node, value)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object ;
value (GObject.Value) – A GObject.Value pointer this the value to be stored.

This method is used to store some values associated with the given node of the given nodeArray. These values can be pointers to anything allocated (will be free automatically when the property is deleted) or they can be static values. This depends on the construction of the node property. These values can be retrieved with the v_sim.NodeProperty.getValue() method.

See v_sim.NodeArray.getProperty() to get a property by its name.