ItalaApiC  1.3.3
Functions
EnumEntry

Functions

ITALA_API_C ItalaError NODE_EnumEntryGetValue (H_NODE hNode, int64_t *pValue)
 
ITALA_API_C ItalaError NODE_EnumEntryGetSymbolic (H_NODE hNode, char *symbolic, size_t *pSize)
 
ITALA_API_C ItalaError NODE_EnumEntryGetNumericValue (H_NODE hNode, double *pValue)
 
ITALA_API_C ItalaError NODE_EnumEntryIsSelfClearing (H_NODE hNode, bool *pIsSelfClearing)
 

Detailed Description

All the methods related to nodes managed by GenApi.

Function Documentation

◆ NODE_EnumEntryGetValue()

ITALA_API_C ItalaError NODE_EnumEntryGetValue ( H_NODE  hNode,
int64_t *  pValue 
)

Get the integer value of the enum entry.

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

◆ NODE_EnumEntryGetSymbolic()

ITALA_API_C ItalaError NODE_EnumEntryGetSymbolic ( H_NODE  hNode,
char *  symbolic,
size_t *  pSize 
)

Get the symbolic value of the enum entry.

Parameters
[in]hNodeHandle to Node instance, should be an EnumEntry node.
[out]symbolicArray of char, symbolic value.
[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_EnumEntryGetNumericValue()

ITALA_API_C ItalaError NODE_EnumEntryGetNumericValue ( H_NODE  hNode,
double *  pValue 
)

Get the numerical value of the enum entry.

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

◆ NODE_EnumEntryIsSelfClearing()

ITALA_API_C ItalaError NODE_EnumEntryIsSelfClearing ( H_NODE  hNode,
bool *  pIsSelfClearing 
)

Get the self clearing property of the enum entry.

Parameters
[in]hNodeHandle to Node instance, should be an EnumEntry node.
[out]pIsSelfClearingSelf clearing property.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.