ItalaApiC  1.3.3
Functions

Functions

ITALA_API_C ItalaError NODE_IntegerSetValue (H_NODE hNode, int64_t value)
 
ITALA_API_C ItalaError NODE_IntegerGetValue (H_NODE hNode, int64_t *pValue)
 
ITALA_API_C ItalaError NODE_IntegerGetMin (H_NODE hNode, int64_t *pMin)
 
ITALA_API_C ItalaError NODE_IntegerGetMax (H_NODE hNode, int64_t *pMax)
 
ITALA_API_C ItalaError NODE_IntegerGetIncMode (H_NODE hNode, IncMode *pIncMode)
 
ITALA_API_C ItalaError NODE_IntegerGetInc (H_NODE hNode, int64_t *pIncrement)
 
ITALA_API_C ItalaError NODE_IntegerValidValuesNum (H_NODE hNode, size_t *pNumOfValidValues)
 
ITALA_API_C ItalaError NODE_IntegerGetValidValueByIndex (H_NODE hNode, size_t index, int64_t *pValidValue)
 
ITALA_API_C ItalaError NODE_IntegerGetRepresentation (H_NODE hNode, Representation *pRepresentation)
 
ITALA_API_C ItalaError NODE_IntegerGetUnit (H_NODE hNode, char *unit, size_t *pSize)
 
ITALA_API_C ItalaError NODE_IntegerImposeMin (H_NODE hNode, int64_t minImpose)
 
ITALA_API_C ItalaError NODE_IntegerImposeMax (H_NODE hNode, int64_t maxImpose)
 

Detailed Description

All the methods related to nodes managed by GenApi.

Function Documentation

◆ NODE_IntegerSetValue()

ITALA_API_C ItalaError NODE_IntegerSetValue ( H_NODE  hNode,
int64_t  value 
)

Set the value of the integer Node.

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

◆ NODE_IntegerGetValue()

ITALA_API_C ItalaError NODE_IntegerGetValue ( H_NODE  hNode,
int64_t *  pValue 
)

Get the value of the integer Node.

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

◆ NODE_IntegerGetMin()

ITALA_API_C ItalaError NODE_IntegerGetMin ( H_NODE  hNode,
int64_t *  pMin 
)

Get the minimum value of the integer Node.

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

◆ NODE_IntegerGetMax()

ITALA_API_C ItalaError NODE_IntegerGetMax ( H_NODE  hNode,
int64_t *  pMax 
)

Get the maximum value of the integer Node.

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

◆ NODE_IntegerGetIncMode()

ITALA_API_C ItalaError NODE_IntegerGetIncMode ( H_NODE  hNode,
IncMode pIncMode 
)

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

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

◆ NODE_IntegerGetInc()

ITALA_API_C ItalaError NODE_IntegerGetInc ( H_NODE  hNode,
int64_t *  pIncrement 
)

Get the increment of the integer Node, if any.

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

◆ NODE_IntegerValidValuesNum()

ITALA_API_C ItalaError NODE_IntegerValidValuesNum ( H_NODE  hNode,
size_t *  pNumOfValidValues 
)

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

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

◆ NODE_IntegerGetValidValueByIndex()

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

◆ NODE_IntegerGetRepresentation()

ITALA_API_C ItalaError NODE_IntegerGetRepresentation ( H_NODE  hNode,
Representation pRepresentation 
)

Get recommended representation of a integer Node.

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

◆ NODE_IntegerGetUnit()

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

Get the physical unit name of a integer Node.

Parameters
[in]hNodeHandle to Node instance, should be a Integer 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_IntegerImposeMin()

ITALA_API_C ItalaError NODE_IntegerImposeMin ( H_NODE  hNode,
int64_t  minImpose 
)

Restrict minimum value of integer Node.

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

◆ NODE_IntegerImposeMax()

ITALA_API_C ItalaError NODE_IntegerImposeMax ( H_NODE  hNode,
int64_t  maxImpose 
)

Restrict maximum value of integer Node.

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