v_sim.PairSet¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` ()
	`get` (ele1, ele2)
	`getFromLink` (link)
	`getNthPair` (pos)
	`iter_new` (all)
	`setModel` (nodes)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`data`	`v_sim.Data`	r	data elements come from
`pairs`	`GLib.Array`	r	set of pairs

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`links-changed`	Gets emitted when any of the `v_sim.Pair` of set has a change (addition or removal) in its list of `v_sim.PairLink`.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r
priv	`v_sim.PairSetPrivate`	r

Class Details¶

class v_sim.PairSet(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: v_sim.PairSetClass

An opaque structure.

classmethod new()¶

Returns:: a new v_sim.PairSet object.
Return type:: v_sim.PairSet

Define an object to handle all possible v_sim.Pair for a given v_sim.NodeArray.

New in version 3.8.

get(ele1, ele2)¶

Parameters:

ele1 (v_sim.Element) – a v_sim.Element object.
ele2 (v_sim.Element) – a v_sim.Element object.

Returns:

the v_sim.Pair stored in self linking ele1 and ele2.

Return type:

v_sim.Pair

Retrieve the v_sim.Pair linking ele1 and ele2 as stroed in self if it exists, or None if not.

New in version 3.8.

getFromLink(link)¶

Parameters:: link (v_sim.PairLink) – a v_sim.PairLink object.
Returns:: the v_sim.Pair stored in self containing link.
Return type:: v_sim.Pair

Retrieve the v_sim.Pair stored in self that contains link, or None if none.

New in version 3.8.

getNthPair(pos)¶

Parameters:: pos (int) – an integer.
Returns:: the nth v_sim.Pair in self.
Return type:: v_sim.Pair

Retrieve the nth v_sim.Pair stored in self.

New in version 3.8.

iter_new(all)¶

Parameters:: all (bool) – a boolean.
Returns:: a v_sim.PairSetIter location.
Return type:: iter: v_sim.PairSetIter

Creates an iterator over all the v_sim.PairLink of a set of v_sim.Pair. If all is False, only visible v_sim.PairLink, see v_sim.PairLink.setDrawn(), are iterated on.

New in version 3.8.

setModel(nodes)¶

Parameters:: nodes (v_sim.Data) – a v_sim.Data object.
Returns:: True if model is actually changed.
Return type:: bool

Binds nodes population and unit to self.

New in version 3.8.

Signal Details¶

v_sim.PairSet.signals.links_changed(pair_set, pair)¶

Signal Name:

links-changed

Flags:

RUN_LAST, NO_RECURSE, NO_HOOKS

Parameters:

pair_set (v_sim.PairSet) – The object which received the signal
pair (v_sim.Pair) – the v_sim.Pair that has changing links.

Gets emitted when any of the v_sim.Pair of set has a change (addition or removal) in its list of v_sim.PairLink.

New in version 3.8.

Property Details¶

v_sim.PairSet.props.data¶

Name:: data
Type:: v_sim.Data
Default Value:: None
Flags:: READABLE

data elements come from

v_sim.PairSet.props.pairs¶

Name:: pairs
Type:: GLib.Array
Default Value:: None
Flags:: READABLE

set of pairs