Integer¶
Functions
- ITALA_API_C ItalaError NODE_IntegerSetValue (H_NODE hNode, int64_t value)
Set the value of the integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
value – [in] Value to set.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetValue (H_NODE hNode, int64_t *pValue)
Get the value of the integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pValue – [out] Value of the Node.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetMin (H_NODE hNode, int64_t *pMin)
Get the minimum value of the integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pMin – [out] Minimum value.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetMax (H_NODE hNode, int64_t *pMax)
Get the maximum value of the integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pMax – [out] Maximum value.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetIncMode (H_NODE hNode, IncMode *pIncMode)
Get the increment mode of the integer Node, if any.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pIncMode – [out] Increment mode.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetInc (H_NODE hNode, int64_t *pIncrement)
Get the increment of the integer Node, if any.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pIncrement – [out] Increment of the Node.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerValidValuesNum (H_NODE hNode, size_t *pNumOfValidValues)
Get the number of possible valid vlaues of the integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pNumOfValidValues – [out] Number of valid values.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetValidValueByIndex (H_NODE hNode, size_t index, int64_t *pValidValue)
Get valid value of the integer Node, given a specific index.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
index – [in] Index of the valid value.
pValidValue – [out] Valid value.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetRepresentation (H_NODE hNode, Representation *pRepresentation)
Get recommended representation of a integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
pRepresentation – [out] Recommended representation.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerGetUnit (H_NODE hNode, char *unit, size_t *pSize)
Get the physical unit name of a integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
unit – [out] Array of char, unit name.
pSize – [inout] Maximum element of the array in input, number of element filled in output.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerImposeMin (H_NODE hNode, int64_t minImpose)
Restrict minimum value of integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
minImpose – [out] Value to imopse as minimum.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
- ITALA_API_C ItalaError NODE_IntegerImposeMax (H_NODE hNode, int64_t maxImpose)
Restrict maximum value of integer Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Integer node.
maxImpose – [out] Value to imopse as maximum.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.