ItalaApiC  1.3.3
Functions
Enumeration

Functions

ITALA_API_C ItalaError NODE_EnumerationGetSymbolicsNum (H_NODE hNode, size_t *pNumOfSymbolics)
 
ITALA_API_C ItalaError NODE_EnumerationGetSymbolicByIndex (H_NODE hNode, size_t index, char *symbolic, size_t *pSize)
 
ITALA_API_C ItalaError NODE_EnumerationGetEntriesNum (H_NODE hNode, size_t *pNumOfEntries)
 
ITALA_API_C ItalaError NODE_EnumerationGetEntryByIndex (H_NODE hNode, size_t index, H_NODE *phEnumEntry)
 
ITALA_API_C ItalaError NODE_EnumerationSetIntValue (H_NODE hNode, int64_t value)
 
ITALA_API_C ItalaError NODE_EnumerationGetIntValue (H_NODE hNode, int64_t *pValue)
 
ITALA_API_C ItalaError NODE_EnumerationGetEntryByName (H_NODE hNode, const char *name, H_NODE *phEnumEntry)
 
ITALA_API_C ItalaError NODE_EnumerationGetEntryByIntValue (H_NODE hNode, int64_t value, H_NODE *phEnumEntry)
 
ITALA_API_C ItalaError NODE_EnumerationGetCurrentEntry (H_NODE hNode, H_NODE *phEnumEntry)
 

Detailed Description

All the methods related to nodes managed by GenApi.

Function Documentation

◆ NODE_EnumerationGetSymbolicsNum()

ITALA_API_C ItalaError NODE_EnumerationGetSymbolicsNum ( H_NODE  hNode,
size_t *  pNumOfSymbolics 
)

Get the number of symbolic in the enumeratinon Node.

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

◆ NODE_EnumerationGetSymbolicByIndex()

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

Get the symbolic in the enumeratinon Node, given a specif index.

Parameters
[in]hNodeHandle to Node instance, should be an Enumeration node.
[in]indexIndex of the symbolic.
[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_EnumerationGetEntriesNum()

ITALA_API_C ItalaError NODE_EnumerationGetEntriesNum ( H_NODE  hNode,
size_t *  pNumOfEntries 
)

Get the number of entries in the enumeratinon Node.

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

◆ NODE_EnumerationGetEntryByIndex()

ITALA_API_C ItalaError NODE_EnumerationGetEntryByIndex ( H_NODE  hNode,
size_t  index,
H_NODE *  phEnumEntry 
)

Get the enem entry in the enumeratinon Node, given a specific index.

Parameters
[in]hNodeHandle to Node instance, should be an Enumeration node.
[in]indexIndex of the symbolic.
[out]phEnumEntryHandle to enum entry Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_EnumerationSetIntValue()

ITALA_API_C ItalaError NODE_EnumerationSetIntValue ( H_NODE  hNode,
int64_t  value 
)

Set the value of the Node by integer.

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

◆ NODE_EnumerationGetIntValue()

ITALA_API_C ItalaError NODE_EnumerationGetIntValue ( H_NODE  hNode,
int64_t *  pValue 
)

Get the integer value of the enumeration Node.

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

◆ NODE_EnumerationGetEntryByName()

ITALA_API_C ItalaError NODE_EnumerationGetEntryByName ( H_NODE  hNode,
const char *  name,
H_NODE *  phEnumEntry 
)

Get the entry by name of the enumeration Node.

Parameters
[in]hNodeHandle to Node instance, should be an Enumeration node.
[in]nameName of the enum entry to retrive.
[out]phEnumEntryHandle to enum entry Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_EnumerationGetEntryByIntValue()

ITALA_API_C ItalaError NODE_EnumerationGetEntryByIntValue ( H_NODE  hNode,
int64_t  value,
H_NODE *  phEnumEntry 
)

Get the enem entry in the enumeratinon Node, given the integer value of it.

Parameters
[in]hNodeHandle to Node instance, should be an Enumeration node.
[in]valueValue of the enum entry to retrive.
[out]phEnumEntryHandle to enum entry Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_EnumerationGetCurrentEntry()

ITALA_API_C ItalaError NODE_EnumerationGetCurrentEntry ( H_NODE  hNode,
H_NODE *  phEnumEntry 
)

Get the current enem entry in the enumeratinon Node.

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