ItalaApiC  1.3.3
Functions

Functions

ITALA_API_C ItalaError NODE_FloatSetValue (H_NODE hNode, double value)
 
ITALA_API_C ItalaError NODE_FloatGetValue (H_NODE hNode, double *pValue)
 
ITALA_API_C ItalaError NODE_FloatGetMin (H_NODE hNode, double *pMin)
 
ITALA_API_C ItalaError NODE_FloatGetMax (H_NODE hNode, double *pMax)
 
ITALA_API_C ItalaError NODE_FloatHasInc (H_NODE hNode, bool *pHasInc)
 
ITALA_API_C ItalaError NODE_FloatGetIncMode (H_NODE hNode, IncMode *pIncMode)
 
ITALA_API_C ItalaError NODE_FloatGetInc (H_NODE hNode, double *pIncrement)
 
ITALA_API_C ItalaError NODE_FloatValidValuesNum (H_NODE hNode, size_t *pNumOfValidValues)
 
ITALA_API_C ItalaError NODE_FloatGetValidValueByIndex (H_NODE hNode, size_t index, double *pValidValue)
 
ITALA_API_C ItalaError NODE_FloatGetRepresentation (H_NODE hNode, Representation *pRepresentation)
 
ITALA_API_C ItalaError NODE_FloatGetUnit (H_NODE hNode, char *unit, size_t *pSize)
 
ITALA_API_C ItalaError NODE_FloatGetDisplayNotation (H_NODE hNode, DisplayNotation *pDisplayNotation)
 
ITALA_API_C ItalaError NODE_FloatGetDisplayPrecision (H_NODE hNode, int64_t *pDisplayPrecision)
 
ITALA_API_C ItalaError NODE_FloatImposeMin (H_NODE hNode, double minImpose)
 
ITALA_API_C ItalaError NODE_FloatImposeMax (H_NODE hNode, double maxImpose)
 

Detailed Description

All the methods related to nodes managed by GenApi.

Function Documentation

◆ NODE_FloatSetValue()

ITALA_API_C ItalaError NODE_FloatSetValue ( H_NODE  hNode,
double  value 
)

Set the value of the float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[in]valueValue to set.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetValue()

ITALA_API_C ItalaError NODE_FloatGetValue ( H_NODE  hNode,
double *  pValue 
)

Get the value of the float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pValueValue of the Node.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetMin()

ITALA_API_C ItalaError NODE_FloatGetMin ( H_NODE  hNode,
double *  pMin 
)

Get the minimum value of the float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pMinMinimum value.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetMax()

ITALA_API_C ItalaError NODE_FloatGetMax ( H_NODE  hNode,
double *  pMax 
)

Get the maximum value of the float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pMaxMaximum value.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatHasInc()

ITALA_API_C ItalaError NODE_FloatHasInc ( H_NODE  hNode,
bool *  pHasInc 
)

Get if the float Node has a software-imposed increment.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pHasIncNode has increment.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetIncMode()

ITALA_API_C ItalaError NODE_FloatGetIncMode ( H_NODE  hNode,
IncMode pIncMode 
)

Get the increment mode of the float Node, if any.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pIncModeIncrement mode.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetInc()

ITALA_API_C ItalaError NODE_FloatGetInc ( H_NODE  hNode,
double *  pIncrement 
)

Get the increment of the float Node, if any.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pIncrementIncrement of the Node.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatValidValuesNum()

ITALA_API_C ItalaError NODE_FloatValidValuesNum ( H_NODE  hNode,
size_t *  pNumOfValidValues 
)

Get the number of possible valid vlaues of the float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pNumOfValidValuesNumber of valid values.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetValidValueByIndex()

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
[in]hNodeHandle to Node instance, should be a Float node.
[in]indexIndex of the valid value.
[out]pValidValueValid value.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetRepresentation()

ITALA_API_C ItalaError NODE_FloatGetRepresentation ( H_NODE  hNode,
Representation pRepresentation 
)

Get recommended representation of a flaot Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pRepresentationRecommended representation.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetUnit()

ITALA_API_C ItalaError NODE_FloatGetUnit ( H_NODE  hNode,
char *  unit,
size_t *  pSize 
)

Get the physical unit name of a float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]unitArray of char, unit name.
[in,out]pSizeMaximum element of the array in input, number of element filled in output.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetDisplayNotation()

ITALA_API_C ItalaError NODE_FloatGetDisplayNotation ( H_NODE  hNode,
DisplayNotation pDisplayNotation 
)

Get the way the float should be converted to a string.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]pDisplayNotationDisplay notation.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatGetDisplayPrecision()

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
[in]hNodeHandle to Node instance, should be a Float node.
[out]pDisplayPrecisionDisplay precision.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatImposeMin()

ITALA_API_C ItalaError NODE_FloatImposeMin ( H_NODE  hNode,
double  minImpose 
)

Restrict minimum value of float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]minImposeValue to imopse as minimum.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_FloatImposeMax()

ITALA_API_C ItalaError NODE_FloatImposeMax ( H_NODE  hNode,
double  maxImpose 
)

Restrict maximum value of float Node.

Parameters
[in]hNodeHandle to Node instance, should be a Float node.
[out]maxImposeValue to imopse as maximum.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.