Enumerations used by NyxNode

Enumerations used by NyxNode. More...

Classes
class	nyx.indi.enums.NyxState
	Vector state hint. More...
class	nyx.indi.enums.NyxPerm
	Vector permission hint. More...
class	nyx.indi.enums.NyxRule
	Switch vector rule hint. More...
class	nyx.indi.enums.NyxOnOff
	Switch state. More...

Detailed Description

Enumerations used by NyxNode.

---

Class Documentation

nyx::indi::enums::NyxState

class nyx::indi::enums::NyxState

Vector state hint.

Symbol	Value	Description
NyxState.IDLE	400	State is idle.
NyxState.OK	401	State is ok.
NyxState.BUSY	402	State is busy.
NyxState.ALERT	403	State is alert.

Definition at line 24 of file enums.py.

Inheritance diagram for nyx.indi.enums.NyxState:

Collaboration diagram for nyx.indi.enums.NyxState:

Static Public Member Functions
int	to_int (NyxState|int|str value)
	Converts a NyxState value as an integer.
str	to_str (NyxState|int|str value)
	Converts a NyxState value as a string.

Member Function Documentation

to_int()

int nyx.indi.enums.NyxState.to_int ( NyxState | int | str value )

static

Converts a NyxState value as an integer.

Parameters

value

The value to convert.

Returns

The NyxState value as an integer.

Definition at line 44 of file enums.py.

to_str()

str nyx.indi.enums.NyxState.to_str ( NyxState | int | str value )

static

Converts a NyxState value as a string.

Parameters

value

The value to convert.

Returns

The NyxState value as a string.

Definition at line 57 of file enums.py.

nyx::indi::enums::NyxPerm

class nyx::indi::enums::NyxPerm

Vector permission hint.

Symbol	Value	Description
NyxPerm.RO	500	Read only.
NyxPerm.WO	501	Write only.
NyxPerm.RW	502	Read & write.

Definition at line 81 of file enums.py.

Inheritance diagram for nyx.indi.enums.NyxPerm:

Collaboration diagram for nyx.indi.enums.NyxPerm:

Static Public Member Functions
int	to_int (NyxPerm|int|str value)
	Converts a NyxPerm value as an integer.
str	to_str (NyxPerm|int|str value)
	Converts a NyxPerm value as a string.

Member Function Documentation

to_int()

int nyx.indi.enums.NyxPerm.to_int ( NyxPerm | int | str value )

static

Converts a NyxPerm value as an integer.

Parameters

value

The value to convert.

Returns

The NyxPerm value as an integer.

Definition at line 99 of file enums.py.

to_str()

str nyx.indi.enums.NyxPerm.to_str ( NyxPerm | int | str value )

static

Converts a NyxPerm value as a string.

Parameters

value

The value to convert.

Returns

The NyxPerm value as a string.

Definition at line 112 of file enums.py.

nyx::indi::enums::NyxRule

class nyx::indi::enums::NyxRule

Switch vector rule hint.

Symbol	Value	Description
NyxRule.ONE_OF_MANY	600	Only one switch of many can be ON (e.g., radio buttons).
NyxRule.AT_MOST_ONE	601	At most one switch can be ON, but all switches can be off.
NyxRule.ANY_OF_MANY	602	Any number of switches can be ON (e.g., check boxes).

Definition at line 135 of file enums.py.

Inheritance diagram for nyx.indi.enums.NyxRule:

Collaboration diagram for nyx.indi.enums.NyxRule:

Static Public Member Functions
int	nyx_rule_int (NyxRule|int|str value)
	Converts a NyxRule value as an integer.
str	nyx_rule_str (NyxRule|int|str value)
	Converts a NyxRule value as a string.

Member Function Documentation

nyx_rule_int()

int nyx.indi.enums.NyxRule.nyx_rule_int ( NyxRule | int | str value )

static

Converts a NyxRule value as an integer.

Parameters

value

The value to convert.

Returns

The NyxRule value as an integer.

Definition at line 153 of file enums.py.

nyx_rule_str()

str nyx.indi.enums.NyxRule.nyx_rule_str ( NyxRule | int | str value )

static

Converts a NyxRule value as a string.

Parameters

value

The value to convert.

Returns

The NyxRule value as a string.

Definition at line 166 of file enums.py.

nyx::indi::enums::NyxOnOff

class nyx::indi::enums::NyxOnOff

Switch state.

Symbol	Value	Description
NyxOnOff.ON	700	Switch is ON.
NyxOnOff.OFF	701	Switch is OFF.

Definition at line 189 of file enums.py.

Inheritance diagram for nyx.indi.enums.NyxOnOff:

Collaboration diagram for nyx.indi.enums.NyxOnOff:

Static Public Member Functions
int	to_int (NyxOnOff|int|str|bool value)
	Converts a NyxOnOff value as an integer.
str	to_str (NyxOnOff|int|str|bool value)
	Converts a NyxOnOff value as a string.

Member Function Documentation

to_int()

int nyx.indi.enums.NyxOnOff.to_int ( NyxOnOff | int | str | bool value )

static

Converts a NyxOnOff value as an integer.

Parameters

value

The value to convert.

Returns

The NyxOnOff value as an integer.

Definition at line 205 of file enums.py.

to_str()

str nyx.indi.enums.NyxOnOff.to_str ( NyxOnOff | int | str | bool value )

static

Converts a NyxOnOff value as a string.

Parameters

value

The value to convert.

Returns

The NyxOnOff value as a string.

Definition at line 222 of file enums.py.