Collaboration diagram for Nyx Number messages:

Functions
__NYX_INLINE__ nyx_dict_t *	nyx_number_prop_new_int (STR_t name, __NYX_NULLABLE__ STR_t label, STR_t format, int32_t min, int32_t max, int32_t step, int32_t value)
	Allocates a new INDI / Nyx `int32_t` number property.

__NYX_INLINE__ nyx_dict_t *	nyx_number_prop_new_uint (STR_t name, __NYX_NULLABLE__ STR_t label, STR_t format, uint32_t min, uint32_t max, uint32_t step, uint32_t value)
	Allocates a new INDI / Nyx `uint32_t` number property.

__NYX_INLINE__ nyx_dict_t *	nyx_number_prop_new_long (STR_t name, __NYX_NULLABLE__ STR_t label, STR_t format, int64_t min, int64_t max, int64_t step, int64_t value)
	Allocates a new INDI / Nyx `int64_t` number property.

__NYX_INLINE__ nyx_dict_t *	nyx_number_prop_new_ulong (STR_t name, __NYX_NULLABLE__ STR_t label, STR_t format, uint64_t min, uint64_t max, uint64_t step, uint64_t value)
	Allocates a new INDI / Nyx `uint64_t` number property.

__NYX_INLINE__ nyx_dict_t *	nyx_number_prop_new_double (STR_t name, __NYX_NULLABLE__ STR_t label, STR_t format, double min, double max, double step, double value)
	Allocates a new INDI / Nyx `double` number property.

__NYX_INLINE__ bool	nyx_number_prop_set_int (nyx_dict_t *prop, int32_t value)
	Sets the new value of the provided property object.

__NYX_INLINE__ int32_t	nyx_number_prop_get_int (const nyx_dict_t *prop)
	Gets the current value of the provided property object.

__NYX_INLINE__ bool	nyx_number_prop_set_uint (nyx_dict_t *prop, uint32_t value)
	Sets the new value of the provided property object.

__NYX_INLINE__ uint32_t	nyx_number_prop_get_uint (const nyx_dict_t *prop)
	Gets the current value of the provided property object.

__NYX_INLINE__ bool	nyx_number_prop_set_long (nyx_dict_t *prop, int64_t value)
	Sets the new value of the provided property object.

__NYX_INLINE__ int64_t	nyx_number_prop_get_long (const nyx_dict_t *prop)
	Gets the current value of the provided property object.

__NYX_INLINE__ bool	nyx_number_prop_set_ulong (nyx_dict_t *prop, uint64_t value)
	Sets the new value of the provided property object.

__NYX_INLINE__ uint64_t	nyx_number_prop_get_ulong (const nyx_dict_t *prop)
	Gets the current value of the provided property object.

__NYX_INLINE__ bool	nyx_number_prop_set_double (nyx_dict_t *prop, double value)
	Sets the new value of the provided property object.

__NYX_INLINE__ double	nyx_number_prop_get_double (const nyx_dict_t *prop)
	Gets the current value of the provided property object.

nyx_dict_t *	nyx_number_vector_new (STR_t device, STR_t name, nyx_state_t state, nyx_perm_t perm, nyx_dict_t props[], __NYX_NULLABLE__ const nyx_opts_t opts)
	Allocates a new INDI / Nyx number vector.

Detailed Description

Nyx Number messages

Function Documentation

◆ nyx_number_prop_new_int()

__NYX_INLINE__ nyx_dict_t * nyx_number_prop_new_int	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		STR_t	format,
		int32_t	min,
		int32_t	max,
		int32_t	step,
		int32_t	value
	)

Allocates a new INDI / Nyx int32_t number property.

Parameters

name	Property name.
label	Property label.
format	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.

Returns: The new property object.

Definition at line 2074 of file nyx_node.h.

◆ nyx_number_prop_new_uint()

__NYX_INLINE__ nyx_dict_t * nyx_number_prop_new_uint	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		STR_t	format,
		uint32_t	min,
		uint32_t	max,
		uint32_t	step,
		uint32_t	value
	)

Allocates a new INDI / Nyx uint32_t number property.

Parameters

name	Property name.
label	Property label.
format	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.

Returns: The new property object.

Definition at line 2093 of file nyx_node.h.

◆ nyx_number_prop_new_long()

__NYX_INLINE__ nyx_dict_t * nyx_number_prop_new_long	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		STR_t	format,
		int64_t	min,
		int64_t	max,
		int64_t	step,
		int64_t	value
	)

Allocates a new INDI / Nyx int64_t number property.

Parameters

name	Property name.
label	Property label.
format	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.

Returns: The new property object.

Definition at line 2112 of file nyx_node.h.

◆ nyx_number_prop_new_ulong()

__NYX_INLINE__ nyx_dict_t * nyx_number_prop_new_ulong	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		STR_t	format,
		uint64_t	min,
		uint64_t	max,
		uint64_t	step,
		uint64_t	value
	)

Allocates a new INDI / Nyx uint64_t number property.

Parameters

name	Property name.
label	Property label.
format	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.

Returns: The new property object.

Definition at line 2131 of file nyx_node.h.

◆ nyx_number_prop_new_double()

__NYX_INLINE__ nyx_dict_t * nyx_number_prop_new_double	(	STR_t	name,
		__NYX_NULLABLE__ STR_t	label,
		STR_t	format,
		double	min,
		double	max,
		double	step,
		double	value
	)

Allocates a new INDI / Nyx double number property.

Parameters

name	Property name.
label	Property label.
format	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.

Returns: The new property object.

Definition at line 2150 of file nyx_node.h.

◆ nyx_number_prop_set_int()

__NYX_INLINE__ bool nyx_number_prop_set_int	(	nyx_dict_t *	prop,
		int32_t	value
	)

Sets the new value of the provided property object.

Parameters

prop	Property object.
value	New value.

Returns: true if the value was modified, false otherwise.

Definition at line 2183 of file nyx_node.h.

◆ nyx_number_prop_get_int()

__NYX_INLINE__ int32_t nyx_number_prop_get_int ( const nyx_dict_t * prop )

Gets the current value of the provided property object.

Parameters

prop	Property object.

Returns: The current value.

Definition at line 2196 of file nyx_node.h.

◆ nyx_number_prop_set_uint()

__NYX_INLINE__ bool nyx_number_prop_set_uint	(	nyx_dict_t *	prop,
		uint32_t	value
	)

Sets the new value of the provided property object.

Parameters

prop	Property object.
value	New value.

Returns: true if the value was modified, false otherwise.

Definition at line 2210 of file nyx_node.h.

◆ nyx_number_prop_get_uint()

__NYX_INLINE__ uint32_t nyx_number_prop_get_uint ( const nyx_dict_t * prop )

Gets the current value of the provided property object.

Parameters

prop	Property object.

Returns: The current value.

Definition at line 2223 of file nyx_node.h.

◆ nyx_number_prop_set_long()

__NYX_INLINE__ bool nyx_number_prop_set_long	(	nyx_dict_t *	prop,
		int64_t	value
	)

Sets the new value of the provided property object.

Parameters

prop	Property object.
value	New value.

Returns: true if the value was modified, false otherwise.

Definition at line 2237 of file nyx_node.h.

◆ nyx_number_prop_get_long()

__NYX_INLINE__ int64_t nyx_number_prop_get_long ( const nyx_dict_t * prop )

Gets the current value of the provided property object.

Parameters

prop	Property object.

Returns: The current value.

Definition at line 2250 of file nyx_node.h.

◆ nyx_number_prop_set_ulong()

__NYX_INLINE__ bool nyx_number_prop_set_ulong	(	nyx_dict_t *	prop,
		uint64_t	value
	)

Sets the new value of the provided property object.

Parameters

prop	Property object.
value	New value.

Returns: true if the value was modified, false otherwise.

Definition at line 2264 of file nyx_node.h.

◆ nyx_number_prop_get_ulong()

__NYX_INLINE__ uint64_t nyx_number_prop_get_ulong ( const nyx_dict_t * prop )

Gets the current value of the provided property object.

Parameters

prop	Property object.

Returns: The current value.

Definition at line 2277 of file nyx_node.h.

◆ nyx_number_prop_set_double()

__NYX_INLINE__ bool nyx_number_prop_set_double	(	nyx_dict_t *	prop,
		double	value
	)

Sets the new value of the provided property object.

Parameters

prop	Property object.
value	New value.

Returns: true if the value was modified, false otherwise.

Definition at line 2291 of file nyx_node.h.

◆ nyx_number_prop_get_double()

__NYX_INLINE__ double nyx_number_prop_get_double ( const nyx_dict_t * prop )

Gets the current value of the provided property object.

Parameters

prop	Property object.

Returns: The current value.

Definition at line 2304 of file nyx_node.h.

◆ nyx_number_vector_new()

nyx_dict_t * nyx_number_vector_new	(	STR_t	device,
		STR_t	name,
		nyx_state_t	state,
		nyx_perm_t	perm,
		nyx_dict_t *	props[],
		__NYX_NULLABLE__ const nyx_opts_t *	opts
	)

Allocates a new INDI / Nyx number vector.

Parameters

device	Device name.
name	Vector name.
state	Vector state.
perm	Vector permissions.
props	Array of properties with `NULL` sentinel.
opts	Options (group, label, hints, timeout, message).

Returns: The new vector object.

Functions

Detailed Description

Function Documentation

◆ nyx_number_prop_new_int()

◆ nyx_number_prop_new_uint()

◆ nyx_number_prop_new_long()

◆ nyx_number_prop_new_ulong()

◆ nyx_number_prop_new_double()

◆ nyx_number_prop_set_int()

◆ nyx_number_prop_get_int()

◆ nyx_number_prop_set_uint()

◆ nyx_number_prop_get_uint()

◆ nyx_number_prop_set_long()

◆ nyx_number_prop_get_long()

◆ nyx_number_prop_set_ulong()

◆ nyx_number_prop_get_ulong()

◆ nyx_number_prop_set_double()

◆ nyx_number_prop_get_double()

◆ nyx_number_vector_new()