Float#
Functions
-
ITALA_API_C ItalaError NODE_FloatSetValue(H_NODE hNode, double value)#
Set the value of the float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
value – [in] Value to set.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetValue(H_NODE hNode, double *pValue)#
Get the value of the float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pValue – [out] Value of the Node.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetMin(H_NODE hNode, double *pMin)#
Get the minimum value of the float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pMin – [out] Minimum value.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetMax(H_NODE hNode, double *pMax)#
Get the maximum value of the float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pMax – [out] Maximum value.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatHasInc(H_NODE hNode, bool *pHasInc)#
Get if the float Node has a software-imposed increment.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pHasInc – [out] Node has increment.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetIncMode(H_NODE hNode, IncMode *pIncMode)#
Get the increment mode of the float Node, if any.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pIncMode – [out] Increment mode.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetInc(H_NODE hNode, double *pIncrement)#
Get the increment of the float Node, if any.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pIncrement – [out] Increment of the Node.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatValidValuesNum(H_NODE hNode, size_t *pNumOfValidValues)#
Get the number of possible valid vlaues of the float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pNumOfValidValues – [out] Number of valid values.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetValidValueByIndex(H_NODE hNode, size_t index, double *pValidValue)#
Get valid value of the float Node, given a specific index.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float 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_FloatGetRepresentation(H_NODE hNode, Representation *pRepresentation)#
Get recommended representation of a flaot Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pRepresentation – [out] Recommended representation.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetUnit(H_NODE hNode, char *unit, size_t *pSize)#
Get the physical unit name of a float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float 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_FloatGetDisplayNotation(H_NODE hNode, DisplayNotation *pDisplayNotation)#
Get the way the float should be converted to a string.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pDisplayNotation – [out] Display notation.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatGetDisplayPrecision(H_NODE hNode, int64_t *pDisplayPrecision)#
Get the precision to be used when converting the float to a string.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
pDisplayPrecision – [out] Display precision.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.
-
ITALA_API_C ItalaError NODE_FloatImposeMin(H_NODE hNode, double minImpose)#
Restrict minimum value of float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float 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_FloatImposeMax(H_NODE hNode, double maxImpose)#
Restrict maximum value of float Node.
- Parameters:
hNode – [in] Handle to Node instance, should be a Float node.
maxImpose – [out] Value to imopse as maximum.
- Returns:
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.