Nyx Node
Loading...
Searching...
No Matches
Nyx Text Message

Nyx / INDI Text Message. More...

Classes

class  nyx.indi.indi_text.NyxTextProp
 INDI / Nyx text property. More...
class  nyx.indi.indi_text.NyxTextVector
 INDI / Nyx text vector. More...

Detailed Description

Nyx / INDI Text Message.


Class Documentation

◆ nyx::indi::indi_text::NyxTextProp

class nyx::indi::indi_text::NyxTextProp

INDI / Nyx text property.

Definition at line 38 of file indi_text.py.

Inheritance diagram for nyx.indi.indi_text.NyxTextProp:
Collaboration diagram for nyx.indi.indi_text.NyxTextProp:

Public Member Functions

 __init__ (self, str name, str|None label=None, str|None value=None)
 Allocates a new INDI / Nyx text property.
Public Member Functions inherited from nyx.json.json_dict.NyxDict
 __init__ (self, int|None ptr=None)
 Allocates a new JSON dict object or wraps one.
None clear (self)
 Clears the content of this JSON dict object.
None __delitem__ (self, str key)
 Deletes the entry of the provided key.
obj.NyxObject __getitem__ (self, str key)
 Gets the JSON object of the provided key.
bool __setitem__ (self, str key, obj.NyxObject value)
 Sets a JSON object in this JSON dict object.
int __len__ (self)
 Gets the number of items in this JSON dict object.
typing.Iterator[str] keys (self)
 Iterates over the keys of this JSON dict object.
typing.Iterator[obj.NyxObjectvalues (self)
 Iterates over the values of this JSON dict object.
typing.Iterator[typing.Tuple[str, obj.NyxObject]] items (self)
 Iterates over the key/value pairs of this JSON dict object.
Public Member Functions inherited from nyx.obj.NyxObject
 __init__ (self, int ptr)
 Wraps a C JSON object pointer.
typing.Callable on (self, typing.Callable callback)
 Registers a callback triggered when clients modify this object.
bool notify (self)
 Notifies this Nyx / INDI object to the clients.
str to_string (self, bool json_string=True)
 Returns a string representing this JSON object.
NyxXMLDoc to_xmldoc (self)
 Converts this JSON Nyx / INDI command to the XML one.

Public Attributes

 name = property()
 Gets or sets the name property of this object (type: str).
 label = property()
 Gets or sets the label property of this object (type: str).
 value = property()
 Gets or sets the value property of this object (type: str).

Additional Inherited Members

Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject from_string (str string)
 Parses a JSON object from a string.

Constructor & Destructor Documentation

◆ __init__()

nyx.indi.indi_text.NyxTextProp.__init__ ( self,
str name,
str | None label = None,
str | None value = None )

Allocates a new INDI / Nyx text property.

Parameters
nameProperty name.
labelProperty label.
valueInitial text value.

Definition at line 46 of file indi_text.py.

◆ nyx::indi::indi_text::NyxTextVector

class nyx::indi::indi_text::NyxTextVector

INDI / Nyx text vector.

Definition at line 104 of file indi_text.py.

Inheritance diagram for nyx.indi.indi_text.NyxTextVector:
Collaboration diagram for nyx.indi.indi_text.NyxTextVector:

Public Member Functions

 __init__ (self, str device, str name, enums.NyxState|int|str state, enums.NyxPerm|int|str perm, typing.Iterable[NyxTextProp] props, **typing.Any opts)
 Allocates a new INDI / Nyx text vector.
Public Member Functions inherited from nyx.json.json_dict.NyxDict
 __init__ (self, int|None ptr=None)
 Allocates a new JSON dict object or wraps one.
None clear (self)
 Clears the content of this JSON dict object.
None __delitem__ (self, str key)
 Deletes the entry of the provided key.
obj.NyxObject __getitem__ (self, str key)
 Gets the JSON object of the provided key.
bool __setitem__ (self, str key, obj.NyxObject value)
 Sets a JSON object in this JSON dict object.
int __len__ (self)
 Gets the number of items in this JSON dict object.
typing.Iterator[str] keys (self)
 Iterates over the keys of this JSON dict object.
typing.Iterator[obj.NyxObjectvalues (self)
 Iterates over the values of this JSON dict object.
typing.Iterator[typing.Tuple[str, obj.NyxObject]] items (self)
 Iterates over the key/value pairs of this JSON dict object.
Public Member Functions inherited from nyx.obj.NyxObject
 __init__ (self, int ptr)
 Wraps a C JSON object pointer.
typing.Callable on (self, typing.Callable callback)
 Registers a callback triggered when clients modify this object.
bool notify (self)
 Notifies this Nyx / INDI object to the clients.
str to_string (self, bool json_string=True)
 Returns a string representing this JSON object.
NyxXMLDoc to_xmldoc (self)
 Converts this JSON Nyx / INDI command to the XML one.

Public Attributes

 device = property()
 Gets or sets the device property of this object (type: str).
 name = property()
 Gets or sets the name property of this object (type: str).
 state = property()
 Gets or sets the state property of this object (type: NyxState).
 perm = property()
 Gets or sets the perm property of this object (type: NyxPerm).

Additional Inherited Members

Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject from_string (str string)
 Parses a JSON object from a string.

Constructor & Destructor Documentation

◆ __init__()

nyx.indi.indi_text.NyxTextVector.__init__ ( self,
str device,
str name,
enums.NyxState | int | str state,
enums.NyxPerm | int | str perm,
typing.Iterable[NyxTextProp] props,
**typing.Any opts )

Allocates a new INDI / Nyx text vector.

Parameters
deviceDevice name.
nameVector name.
stateVector state.
permVector permissions.
propsProperties.
optsOptions (group, label, hints, timeout, message).

Definition at line 112 of file indi_text.py.