v_sim.Sourceable¶

Implementations:: v_sim.DataColorizer, v_sim.GlExtNodeVectors

Methods¶

	`dispose` ()
	`follow` (data)
	`getConstNodeModel` ()
	`getNodeModel` ()
	`getSource` ()
	`init` ()
	`setNodeModel` (model)
	`setSource` (source)

Virtual Methods¶

do_modelChanged ()

Properties¶

Name	Type	Flags	Short Description
`model`	`v_sim.NodeValues`	r/w	node property associated to the object
`source`	`str`	r/w	name of the source property

Signals¶

None

Fields¶

None

Class Details¶

class v_sim.Sourceable¶

Bases:: GObject.GInterface
Structure:: v_sim.SourceableInterface

Interface object.

New in version 3.8.

dispose()¶: This method should be called in the dispose() method of self to ensure that any data referenced in a v_sim.SourceableData structure are released.

New in version 3.8.

follow(data)¶

Parameters:: data (v_sim.Data or None) – a v_sim.Data object.
Returns:: True if the followed data is actually changed.
Return type:: bool

Set the v_sim.NodeValues self is based on by polling the node property of data referenced by the source name of self (see v_sim.Sourceable.setSource()). If self is not following any named property, this call does nothing. If self is following a named property and data is None, the node model is set to None also.

New in version 3.8.

getConstNodeModel()¶

Returns:: the associated model.
Return type:: v_sim.NodeValues

Retrieves associated model, if any.

New in version 3.8.

getNodeModel()¶

Returns:: the associated model.
Return type:: v_sim.NodeValues

Retrieves associated model, if any.

New in version 3.8.

getSource()¶

Returns:: a property name.
Return type:: str or None

Retrieves the name of the property model should be bound to retrieve its v_sim.NodeValues model.

New in version 3.8.

init()¶: Method used in initialisation of the object to allocate a v_sim.SourceableData structure. This structure should be store by the implementer of the sourceable interface and returned by the getSource() virtual method.

New in version 3.8.

setNodeModel(model)¶

Parameters:: model (v_sim.NodeValues or None) – a v_sim.NodeValues object.
Returns:: True if changed.
Return type:: bool

Set model to self.

New in version 3.8.

setSource(source)¶

Parameters:: source (str) – a property name.
Returns:: True if the value is actually changed.
Return type:: bool

self can be bound to a specific v_sim.NodeValues defined by its name. When source is not None and self attached to a v_sim.Data, its model is changed to match any v_sim.NodeValues of its current v_sim.NodeArray with the label source.

New in version 3.8.

do_modelChanged() virtual¶: called whenever the underlying model is changed.

Property Details¶

v_sim.Sourceable.props.model¶

Name:: model
Type:: v_sim.NodeValues
Default Value:: None
Flags:: READABLE, WRITABLE

node property associated to the object

v_sim.Sourceable.props.source¶

Name:: source
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE

name of the source property