v_sim.NodeValuesPole¶

Subclasses:: None

Methods¶

Inherited:: v_sim.NodeValuesFarray (15), v_sim.NodeValues (16), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (arr, label)
	`getAt` (node, order)
	`setDiAt` (node, val)
	`setDiAtDbl` (node, val)
	`setMonoAt` (node, val)
	`setMonoAtDbl` (node, val)
	`setQuadAt` (node, val)
	`setQuadAtDbl` (node, val)

Virtual Methods¶

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

Properties¶

Inherited:: v_sim.NodeValuesFarray (5), v_sim.NodeValues (6)

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.NodeValuesFarray`	r

Class Details¶

class v_sim.NodeValuesPole(**kwargs)¶

Bases:: v_sim.NodeValuesFarray
Abstract:: No
Structure:: v_sim.NodeValuesPoleClass

Common name to refer to a #_VisuNodeValuesPole.

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.NodeValuesPole object.

Return type:

v_sim.NodeValuesPole

Create a new pole field located on nodes.

New in version 3.8.

getAt(node, order)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
order (v_sim.PoleOrder) – a v_sim.PoleOrder value.

Returns:

the coordinates of pole for node.

Return type:

[float]

Retrieves the pole hosted on node.

New in version 3.8.

setDiAt(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a di-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the di-pole hosted at node.

New in version 3.8.

setDiAtDbl(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a di-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the di-pole hosted at node.

New in version 3.8.

setMonoAt(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a mono-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the mono-pole hosted at node.

New in version 3.8.

setMonoAtDbl(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a mono-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the mono-pole hosted at node.

New in version 3.8.

setQuadAt(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a quadru-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the quadru-pole hosted at node.

New in version 3.8.

setQuadAtDbl(node, val)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
val (float) – a quadru-pole value.

Returns:

True if pole for node is indeed changed.

Return type:

bool

Changes the quadru-pole hosted at node.

New in version 3.8.