ItalaApiC
1.3.3
|
Modules | |
Boolean | |
Category | |
Command | |
EnumEntry | |
Enumeration | |
Float | |
Integer | |
Register | |
Selector | |
String | |
Functions | |
ITALA_API_C ItalaError | NODE_GetName (H_NODE hNode, char *name, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetNameSpace (H_NODE hNode, NameSpace *pNameSpace) |
ITALA_API_C ItalaError | NODE_GetVisibility (H_NODE hNode, Visibility *pVisibility) |
ITALA_API_C ItalaError | NODE_InvalidateNode (H_NODE hNode) |
ITALA_API_C ItalaError | NODE_IsCachable (H_NODE hNode, bool *pIsCachable) |
ITALA_API_C ItalaError | NODE_IsAccessModeCacheable (H_NODE hNode, bool *pIsAccessModeCacheable) |
ITALA_API_C ItalaError | NODE_GetCachingMode (H_NODE hNode, CachingMode *pCachingMode) |
ITALA_API_C ItalaError | NODE_GetPollingTime (H_NODE hNode, int64_t *pPollingTime) |
ITALA_API_C ItalaError | NODE_GetToolTip (H_NODE hNode, char *toolTip, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetDescription (H_NODE hNode, char *description, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetDisplayName (H_NODE hNode, char *displayName, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetDeviceName (H_NODE hNode, char *deviceName, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetChildrenNum (H_NODE hNode, LinkType linkType, size_t *pNumChildren) |
ITALA_API_C ItalaError | NODE_GetChildrenByIndex (H_NODE hNode, size_t index, LinkType linkType, H_NODE *phNodeChildren) |
ITALA_API_C ItalaError | NODE_GetParentNum (H_NODE hNode, size_t *pNumParent) |
ITALA_API_C ItalaError | NODE_GetParentByIndex (H_NODE hNode, size_t index, H_NODE *phNodeParent) |
ITALA_API_C ItalaError | NODE_RegisterCallback (H_NODE hNode, NodeCallbackFunction callback, void *pContext, H_NODECALLBACK *phNodeCallback) |
ITALA_API_C ItalaError | NODE_DeregisterCallback (H_NODE hNode, H_NODECALLBACK hNodeCallback) |
ITALA_API_C ItalaError | NODE_GetNodeMap (H_NODE hNode, H_NODEMAP *phNodeMap) |
ITALA_API_C ItalaError | NODE_GetEventId (H_NODE hNode, char *eventId, size_t *pSize) |
ITALA_API_C ItalaError | NODE_IsStreamable (H_NODE hNode, bool *pIsStreamable) |
ITALA_API_C ItalaError | NODE_GetPropertyNamesNum (H_NODE hNode, size_t *pNumOfProperty) |
ITALA_API_C ItalaError | NODE_GetPropertyNameByIndex (H_NODE hNode, size_t index, char *propertyName, size_t *pSize) |
ITALA_API_C ItalaError | NODE_GetProperty (H_NODE hNode, const char *propertyName, char *values, size_t *pSizeValue, char *attributes, size_t *pSizeAttributes) |
ITALA_API_C ItalaError | NODE_ImposedAccessMode (H_NODE hNode, AccessMode imposedAccessMode) |
ITALA_API_C ItalaError | NODE_ImposedVisibility (H_NODE hNode, Visibility imposedVisibility) |
ITALA_API_C ItalaError | NODE_GetAlias (H_NODE hNode, H_NODE *phNodeAlias) |
ITALA_API_C ItalaError | NODE_GetCastAlias (H_NODE hNode, H_NODE *phNodeCastAlias) |
ITALA_API_C ItalaError | NODE_GetDocuURL (H_NODE hNode, char *docuURL, size_t *pSize) |
ITALA_API_C ItalaError | NODE_IsDeprecated (H_NODE hNode, bool *pIsDeprecated) |
ITALA_API_C ItalaError | NODE_GetPrincipalInterfaceType (H_NODE hNode, InterfaceType *pInterfaceType) |
ITALA_API_C ItalaError | NODE_IsFeature (H_NODE hNode, bool *pIsFeature) |
ITALA_API_C ItalaError | NODE_GetAccessMode (H_NODE hNode, AccessMode *pAccessMode) |
ITALA_API_C ItalaError | NODE_ToString (H_NODE hNode, char *value, size_t *pSize) |
ITALA_API_C ItalaError | NODE_IsValueCacheValid (H_NODE hNode, bool *pIsCacheValid) |
ITALA_API_C ItalaError | IsNodeReadable (H_NODE hNode, bool *pIsReadable) |
ITALA_API_C ItalaError | IsNodeWritable (H_NODE hNode, bool *pIsWritable) |
ITALA_API_C ItalaError | IsNodeImplemented (H_NODE hNode, bool *pIsImplemented) |
ITALA_API_C ItalaError | IsNodeAvailable (H_NODE hNode, bool *pIsAvailable) |
All the methods related to nodes managed by GenApi.
ITALA_API_C ItalaError NODE_GetName | ( | H_NODE | hNode, |
char * | name, | ||
size_t * | pSize | ||
) |
Get the node name.
[in] | hNode | Handle to Node instance. |
[out] | name | The name of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetNameSpace | ( | H_NODE | hNode, |
NameSpace * | pNameSpace | ||
) |
Get the node namespace.
[in] | hNode | Handle to Node instance. |
[out] | pNameSpace | Namespace retrived. |
ITALA_API_C ItalaError NODE_GetVisibility | ( | H_NODE | hNode, |
Visibility * | pVisibility | ||
) |
Get the node visibility.
[in] | hNode | Handle to Node instance. |
[out] | pVisibility | Visibility retrived. |
ITALA_API_C ItalaError NODE_InvalidateNode | ( | H_NODE | hNode | ) |
Invalidate the current node.
[in] | hNode | Handle to Node instance. |
ITALA_API_C ItalaError NODE_IsCachable | ( | H_NODE | hNode, |
bool * | pIsCachable | ||
) |
Get if the node is cachable or not.
[in] | hNode | Handle to Node instance. |
[out] | pIsCachable | True if cachable, false otherwise. |
ITALA_API_C ItalaError NODE_IsAccessModeCacheable | ( | H_NODE | hNode, |
bool * | pIsAccessModeCacheable | ||
) |
Get if the node access mode is cachable or not.
[in] | hNode | Handle to Node instance. |
[out] | pIsAccessModeCacheable | True if access mode is cachable, false otherwise. |
ITALA_API_C ItalaError NODE_GetCachingMode | ( | H_NODE | hNode, |
CachingMode * | pCachingMode | ||
) |
Get the node caching mode.
[in] | hNode | Handle to Node instance. |
[out] | pCachingMode | Caching mode retrived. |
ITALA_API_C ItalaError NODE_GetPollingTime | ( | H_NODE | hNode, |
int64_t * | pPollingTime | ||
) |
Get the node polling time.
[in] | hNode | Handle to Node instance. |
[out] | pPollingTime | Polling time retrived. |
ITALA_API_C ItalaError NODE_GetToolTip | ( | H_NODE | hNode, |
char * | toolTip, | ||
size_t * | pSize | ||
) |
Get the node tooltip.
[in] | hNode | Handle to Node instance. |
[out] | toolTip | The tooltip of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetDescription | ( | H_NODE | hNode, |
char * | description, | ||
size_t * | pSize | ||
) |
Get the node description.
[in] | hNode | Handle to Node instance. |
[out] | description | The description of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetDisplayName | ( | H_NODE | hNode, |
char * | displayName, | ||
size_t * | pSize | ||
) |
Get the node diplay name.
[in] | hNode | Handle to Node instance. |
[out] | displayName | The display name of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetDeviceName | ( | H_NODE | hNode, |
char * | deviceName, | ||
size_t * | pSize | ||
) |
Get the node device name.
[in] | hNode | Handle to Node instance. |
[out] | deviceName | The device name of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetChildrenNum | ( | H_NODE | hNode, |
LinkType | linkType, | ||
size_t * | pNumChildren | ||
) |
Get the number of childer Node.
[in] | hNode | Handle to Node instance. |
[in] | linkType | The link type. |
[out] | pNumChildren | Number of children nodes. |
ITALA_API_C ItalaError NODE_GetChildrenByIndex | ( | H_NODE | hNode, |
size_t | index, | ||
LinkType | linkType, | ||
H_NODE * | phNodeChildren | ||
) |
Get a children node, given the specific index.
[in] | hNode | Handle to Node instance. |
[in] | index | Index of Node. |
[in] | linkType | The link type. |
[out] | phNodeChildren | Handle to children Node instance. |
ITALA_API_C ItalaError NODE_GetParentNum | ( | H_NODE | hNode, |
size_t * | pNumParent | ||
) |
Get the number of parent Node.
[in] | hNode | Handle to Node instance. |
[out] | pNumParent | Number of parent nodes. |
ITALA_API_C ItalaError NODE_GetParentByIndex | ( | H_NODE | hNode, |
size_t | index, | ||
H_NODE * | phNodeParent | ||
) |
Get a parent node, given the specific index.
[in] | hNode | Handle to Node instance. |
[in] | index | Index of Node. |
[out] | phNodeParent | Handle to parent Node instance. |
ITALA_API_C ItalaError NODE_RegisterCallback | ( | H_NODE | hNode, |
NodeCallbackFunction | callback, | ||
void * | pContext, | ||
H_NODECALLBACK * | phNodeCallback | ||
) |
Subscribes a NodeCallbackFunction instance to the current node. The implementation must be provided by the client code.
[in] | hNode | Handle to Node instance. |
[in] | callback | The method to execute as callback. |
[in] | pContext | Context of the callback. |
[out] | phNodeCallback | Handle to NodeCallback instance. |
ITALA_API_C ItalaError NODE_DeregisterCallback | ( | H_NODE | hNode, |
H_NODECALLBACK | hNodeCallback | ||
) |
Unsubscribe a NodeCallbackFunction instance to the current node.
[in] | hNode | Handle to Node instance. |
[in] | hNodeCallback | Handle to NodeCallback instance. |
ITALA_API_C ItalaError NODE_GetNodeMap | ( | H_NODE | hNode, |
H_NODEMAP * | phNodeMap | ||
) |
Get the nodemap relative to this node.
[in] | hNode | Handle to Node instance. |
[out] | phNodeMap | Handle to NodeMap instance. |
ITALA_API_C ItalaError NODE_GetEventId | ( | H_NODE | hNode, |
char * | eventId, | ||
size_t * | pSize | ||
) |
Get the node event id.
[in] | hNode | Handle to Node instance. |
[out] | eventId | The event id of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_IsStreamable | ( | H_NODE | hNode, |
bool * | pIsStreamable | ||
) |
Get if the node is streamable or not.
[in] | hNode | Handle to Node instance. |
[out] | pIsStreamable | True if is streamable, false otherwise. |
ITALA_API_C ItalaError NODE_GetPropertyNamesNum | ( | H_NODE | hNode, |
size_t * | pNumOfProperty | ||
) |
Get the property name number of the Node.
[in] | hNode | Handle to Node instance. |
[out] | pNumOfProperty | Name number of the node. |
ITALA_API_C ItalaError NODE_GetPropertyNameByIndex | ( | H_NODE | hNode, |
size_t | index, | ||
char * | propertyName, | ||
size_t * | pSize | ||
) |
Get a property name, given the specific index.
[in] | hNode | Handle to Node instance. |
[in] | index | Index of Node. |
[out] | propertyName | Handle to parent Node instance. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_GetProperty | ( | H_NODE | hNode, |
const char * | propertyName, | ||
char * | values, | ||
size_t * | pSizeValue, | ||
char * | attributes, | ||
size_t * | pSizeAttributes | ||
) |
Get a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters.
[in] | hNode | Handle to Node instance. |
[in] | propertyName | Name of the property. |
[out] | values | Values of the property. |
[in,out] | pSizeValue | Maximum element of the values array in input, number of element filled in output. |
[out] | attributes | Attributes of the property. |
[in,out] | pSizeAttributes | Maximum element of the attributes array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_ImposedAccessMode | ( | H_NODE | hNode, |
AccessMode | imposedAccessMode | ||
) |
Imposes an access mode to the natural access mode of the node.
[in] | hNode | Handle to Node instance. |
[out] | imposedAccessMode | Imposed access mode to set. |
ITALA_API_C ItalaError NODE_ImposedVisibility | ( | H_NODE | hNode, |
Visibility | imposedVisibility | ||
) |
Imposes a visibility to the natural visibility of the node.
[in] | hNode | Handle to Node instance. |
[out] | imposedVisibility | Imposed visibility to set. |
ITALA_API_C ItalaError NODE_GetAlias | ( | H_NODE | hNode, |
H_NODE * | phNodeAlias | ||
) |
Retrieves the node which describes the same feature in a different way.
[in] | hNode | Handle to Node instance. |
[out] | phNodeAlias | Handle to alias Node instance. |
ITALA_API_C ItalaError NODE_GetCastAlias | ( | H_NODE | hNode, |
H_NODE * | phNodeCastAlias | ||
) |
Retrieves the a node which describes the same feature so that it can be casted
[in] | hNode | Handle to Node instance. |
[out] | phNodeCastAlias | Handle to cast alias Node instance. |
ITALA_API_C ItalaError NODE_GetDocuURL | ( | H_NODE | hNode, |
char * | docuURL, | ||
size_t * | pSize | ||
) |
Get the node documentation URL.
[in] | hNode | Handle to Node instance. |
[out] | docuURL | The documentation URL of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_IsDeprecated | ( | H_NODE | hNode, |
bool * | pIsDeprecated | ||
) |
Get if the node is deprecated or not.
[in] | hNode | Handle to Node instance. |
[out] | pIsDeprecated | True if is deprecated, false otherwise. |
ITALA_API_C ItalaError NODE_GetPrincipalInterfaceType | ( | H_NODE | hNode, |
InterfaceType * | pInterfaceType | ||
) |
Get the type of the main interface of a node.
[in] | hNode | Handle to Node instance. |
[out] | pInterfaceType | Interface type of the Node. |
ITALA_API_C ItalaError NODE_IsFeature | ( | H_NODE | hNode, |
bool * | pIsFeature | ||
) |
Get if the node can be reached via category nodes from a category node named "Root".
[in] | hNode | Handle to Node instance. |
[out] | pIsFeature | True if can be reached via category nodes, false otherwise. |
ITALA_API_C ItalaError NODE_GetAccessMode | ( | H_NODE | hNode, |
AccessMode * | pAccessMode | ||
) |
Get the access mode of a node.
[in] | hNode | Handle to Node instance. |
[out] | pAccessMode | Access mode of the Node. |
ITALA_API_C ItalaError NODE_ToString | ( | H_NODE | hNode, |
char * | value, | ||
size_t * | pSize | ||
) |
Get the node as a string.
[in] | hNode | Handle to Node instance. |
[out] | value | The string of the Node. |
[in,out] | pSize | Maximum element of the array in input, number of element filled in output. |
ITALA_API_C ItalaError NODE_IsValueCacheValid | ( | H_NODE | hNode, |
bool * | pIsCacheValid | ||
) |
Checks if the value comes from cache or is requested from another node.
[in] | hNode | Handle to Node instance. |
[out] | pIsCacheValid | True if the value comes from cache, false otherwise. |
ITALA_API_C ItalaError IsNodeReadable | ( | H_NODE | hNode, |
bool * | pIsReadable | ||
) |
Checks if the node is readable.
[in] | hNode | Handle to Node instance. |
[out] | pIsReadable | True if the node is readable, false otherwise. |
ITALA_API_C ItalaError IsNodeWritable | ( | H_NODE | hNode, |
bool * | pIsWritable | ||
) |
Checks if the node is writable.
[in] | hNode | Handle to Node instance. |
[out] | pIsWritable | True if the node is writable, false otherwise. |
ITALA_API_C ItalaError IsNodeImplemented | ( | H_NODE | hNode, |
bool * | pIsImplemented | ||
) |
Checks if the node is implemented.
[in] | hNode | Handle to Node instance. |
[out] | pIsImplemented | True if the node is implemented, false otherwise. |
ITALA_API_C ItalaError IsNodeAvailable | ( | H_NODE | hNode, |
bool * | pIsAvailable | ||
) |
Checks if the node is available.
[in] | hNode | Handle to Node instance. |
[out] | pIsAvailable | True if the node is available, false otherwise. |