Nyx Number Message

Nyx / INDI Number Message. More...

Classes
class	nyx.indi.indi_number.NyxNumberProp
	Base class for INDI / Nyx number properties. More...
class	nyx.indi.indi_number.NyxNumberIntProp
	INDI / Nyx int32_t number property. More...
class	nyx.indi.indi_number.NyxNumberUIntProp
	INDI / Nyx uint32_t number property. More...
class	nyx.indi.indi_number.NyxNumberLongProp
	INDI / Nyx int64_t number property. More...
class	nyx.indi.indi_number.NyxNumberULongProp
	INDI / Nyx uint64_t number property. More...
class	nyx.indi.indi_number.NyxNumberDoubleProp
	INDI / Nyx double number property. More...
class	nyx.indi.indi_number.NyxNumberVector
	INDI / Nyx number vector. More...

Detailed Description

Nyx / INDI Number Message.

---

Class Documentation

nyx::indi::indi_number::NyxNumberProp

class nyx::indi::indi_number::NyxNumberProp

Base class for INDI / Nyx number properties.

Definition at line 38 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberProp:

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).
	format = property()
	Gets or sets the format property of this object (type: str).

Additional Inherited Members
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.NyxObject]	values (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.
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.

nyx::indi::indi_number::NyxNumberIntProp

class nyx::indi::indi_number::NyxNumberIntProp

INDI / Nyx int32_t number property.

Definition at line 61 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberIntProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberIntProp:

Public Member Functions
	__init__ (self, str name, str|None label, str fmt, int min, int max, int step, int value)
	Allocates a new INDI / Nyx int32_t number 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.NyxObject]	values (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.

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.
Public Attributes inherited from nyx.indi.indi_number.NyxNumberProp
	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).
	format = property()
	Gets or sets the format property of this object (type: str).

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_number.NyxNumberIntProp.__init__	(		self,
		str	name,
		str | None	label,
		str	fmt,
		int	min,
		int	max,
		int	step,
		int	value )

Allocates a new INDI / Nyx int32_t number property.

Parameters

name	Property name.
label	Property label.
fmt	Printf-style formatting string (%[flags][width]d).
min	Range min, ignored if min == max.
max	Range max, ignored if min == max.
step	Step size, ignored if step == 0.
value	Initial int32_t value.

Definition at line 69 of file indi_number.py.

nyx::indi::indi_number::NyxNumberUIntProp

class nyx::indi::indi_number::NyxNumberUIntProp

INDI / Nyx uint32_t number property.

Definition at line 124 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberUIntProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberUIntProp:

Public Member Functions
	__init__ (self, str name, str|None label, str fmt, int min, int max, int step, int value)
	Allocates a new INDI / Nyx uint32_t number 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.NyxObject]	values (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.

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.
Public Attributes inherited from nyx.indi.indi_number.NyxNumberProp
	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).
	format = property()
	Gets or sets the format property of this object (type: str).

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_number.NyxNumberUIntProp.__init__	(		self,
		str	name,
		str | None	label,
		str	fmt,
		int	min,
		int	max,
		int	step,
		int	value )

Allocates a new INDI / Nyx uint32_t number property.

Parameters

name	Property name.
label	Property label.
fmt	Printf-style formatting string (%[flags][width]{uoxX}).
min	Range min, ignored if min == max.
max	Range max, ignored if min == max.
step	Step size, ignored if step == 0.
value	Initial uint32_t value.

Definition at line 132 of file indi_number.py.

nyx::indi::indi_number::NyxNumberLongProp

class nyx::indi::indi_number::NyxNumberLongProp

INDI / Nyx int64_t number property.

Definition at line 187 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberLongProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberLongProp:

Public Member Functions
	__init__ (self, str name, str|None label, str fmt, int min, int max, int step, int value)
	Allocates a new INDI / Nyx int64_t number 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.NyxObject]	values (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.

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.
Public Attributes inherited from nyx.indi.indi_number.NyxNumberProp
	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).
	format = property()
	Gets or sets the format property of this object (type: str).

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_number.NyxNumberLongProp.__init__	(		self,
		str	name,
		str | None	label,
		str	fmt,
		int	min,
		int	max,
		int	step,
		int	value )

Allocates a new INDI / Nyx int64_t number property.

Parameters

name	Property name.
label	Property label.
fmt	Printf-style formatting string (%[flags][width]ld).
min	Range min, ignored if min == max.
max	Range max, ignored if min == max.
step	Step size, ignored if step == 0.
value	Initial int64_t value.

Definition at line 195 of file indi_number.py.

nyx::indi::indi_number::NyxNumberULongProp

class nyx::indi::indi_number::NyxNumberULongProp

INDI / Nyx uint64_t number property.

Definition at line 250 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberULongProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberULongProp:

Public Member Functions
	__init__ (self, str name, str|None label, str fmt, int min, int max, int step, int value)
	Allocates a new INDI / Nyx uint64_t number 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.NyxObject]	values (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.

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.
Public Attributes inherited from nyx.indi.indi_number.NyxNumberProp
	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).
	format = property()
	Gets or sets the format property of this object (type: str).

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_number.NyxNumberULongProp.__init__	(		self,
		str	name,
		str | None	label,
		str	fmt,
		int	min,
		int	max,
		int	step,
		int	value )

Allocates a new INDI / Nyx uint64_t number property.

Parameters

name	Property name.
label	Property label.
fmt	Printf-style formatting string (%[flags][width]l{uoxX}).
min	Range min, ignored if min == max.
max	Range max, ignored if min == max.
step	Step size, ignored if step == 0.
value	Initial uint64_t value.

Definition at line 258 of file indi_number.py.

nyx::indi::indi_number::NyxNumberDoubleProp

class nyx::indi::indi_number::NyxNumberDoubleProp

INDI / Nyx double number property.

Definition at line 313 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberDoubleProp:

Collaboration diagram for nyx.indi.indi_number.NyxNumberDoubleProp:

Public Member Functions
	__init__ (self, str name, str|None label, str fmt, float min, float max, float step, float value)
	Allocates a new INDI / Nyx double number 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.NyxObject]	values (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.

Additional Inherited Members
Static Public Member Functions inherited from nyx.obj.NyxObject
NyxObject	from_string (str string)
	Parses a JSON object from a string.
Public Attributes inherited from nyx.indi.indi_number.NyxNumberProp
	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).
	format = property()
	Gets or sets the format property of this object (type: str).

Constructor & Destructor Documentation

__init__()

nyx.indi.indi_number.NyxNumberDoubleProp.__init__	(		self,
		str	name,
		str | None	label,
		str	fmt,
		float	min,
		float	max,
		float	step,
		float	value )

Allocates a new INDI / Nyx double number property.

Parameters

name	Property name.
label	Property label.
fmt	Printf-style formatting string (%[flags][width]l?{fFeEgGaAm}).
min	Range min, ignored if min == max.
max	Range max, ignored if min == max.
step	Step size, ignored if step == 0.
value	Initial double value.

Definition at line 321 of file indi_number.py.

nyx::indi::indi_number::NyxNumberVector

class nyx::indi::indi_number::NyxNumberVector

INDI / Nyx number vector.

Definition at line 396 of file indi_number.py.

Inheritance diagram for nyx.indi.indi_number.NyxNumberVector:

Collaboration diagram for nyx.indi.indi_number.NyxNumberVector:

Public Member Functions
	__init__ (self, str device, str name, enums.NyxState|int|str state, enums.NyxPerm|int|str perm, typing.Iterable[NyxNumberProp] props, **typing.Any opts)
	Allocates a new INDI / Nyx number 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.NyxObject]	values (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: str).
	perm = property()
	Gets or sets the perm 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_number.NyxNumberVector.__init__	(		self,
		str	device,
		str	name,
		enums.NyxState | int | str	state,
		enums.NyxPerm | int | str	perm,
		typing.Iterable[NyxNumberProp]	props,
		**typing.Any	opts )

Allocates a new INDI / Nyx number vector.

Parameters

device	Device name.
name	Vector name.
state	Vector state.
perm	Vector permissions.
props	Properties.
opts	Options (group, label, hints, timeout, message).

Definition at line 404 of file indi_number.py.