BFModule.BFGTLUtils.EnumerationNode#

class BFModule.BFGTLUtils.EnumerationNode#

Bases: BaseNode

__init__(*args, **kwargs)#

Overloaded function.

  1. __init__(self: BFModule.BFGTLUtils.EnumerationNode) -> None

  2. __init__(self: BFModule.BFGTLUtils.EnumerationNode, enumerationNode: BFModule.BFGTLUtils.EnumerationNode) -> None

  3. __init__(self: BFModule.BFGTLUtils.EnumerationNode, baseNode: BFModule.BFGTLUtils.BaseNode) -> None

Methods

__init__(*args, **kwargs)

Overloaded function.

assign(self, arg0)

Attributes

Description

Retrieve the node description.

DisplayName

Retrieve the node display name.

Entries

Return a list of the enumeration entry nodes.

Entry

The selected enumeration entry.

EntryCount

The number of child node entries in this enumeration.

EntryName

The name of the currently selected enumeration entry.

EntryNames

A list of the enumeration entry names, in the original order.

EntrySymbolic

The symbolic name of the currently selected enumeration entry.

EntrySymbolics

A list of the enumeration entry symbolic names, in the original order.

EntryValue

The integer value of the currently selected enumeration entry.

EntryValues

A list of the enumeration entry values, in the original order.

Name

Retrieve the node name.

NodeAccess

Retrieve the node accessibility.

NodeType

Retrieve the node type.

ToolTip

Retrieve the node tool-tip.

Valid

This instance represents a valid node.

isNull

Check if node in NULL or not valid.

property Description#

Retrieve the node description.

Type:

str

property DisplayName#

Retrieve the node display name.

Type:

str

property Entries#

Return a list of the enumeration entry nodes.

Type:

list

property Entry#

The selected enumeration entry.

Type:

EnumEntryNode

property EntryCount#

The number of child node entries in this enumeration.

Type:

int

property EntryName#

The name of the currently selected enumeration entry.

Type:

str

property EntryNames#

A list of the enumeration entry names, in the original order.

Type:

list

property EntrySymbolic#

The symbolic name of the currently selected enumeration entry.

Type:

str

property EntrySymbolics#

A list of the enumeration entry symbolic names, in the original order.

Type:

list

property EntryValue#

The integer value of the currently selected enumeration entry.

Type:

int

property EntryValues#

A list of the enumeration entry values, in the original order.

Type:

list

property Name#

Retrieve the node name.

Type:

str

property NodeAccess#

Retrieve the node accessibility.

Type:

BFGTLAccess

property NodeType#

Retrieve the node type.

Type:

BFGTLNodeType

property ToolTip#

Retrieve the node tool-tip.

Type:

str

property Valid#

This instance represents a valid node.

Getter:

Returns TRUE if valid, FALSE otherwise

Type:

bool

assign(self: BFModule.BFGTLUtils.EnumerationNode, arg0: BFModule.BFGTLUtils.BaseNode) BFModule.BFGTLUtils.EnumerationNode#
property isNull#

Check if node in NULL or not valid.

Getter:

Returns TRUE if NULL, FALSE otherwise

Type:

bool