ItalaApiC  1.3.3
Modules | Functions

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)
 

Detailed Description

All the methods related to nodes managed by GenApi.

Function Documentation

◆ NODE_GetName()

ITALA_API_C ItalaError NODE_GetName ( H_NODE  hNode,
char *  name,
size_t *  pSize 
)

Get the node name.

Parameters
[in]hNodeHandle to Node instance.
[out]nameThe name of the Node.
[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_GetNameSpace()

ITALA_API_C ItalaError NODE_GetNameSpace ( H_NODE  hNode,
NameSpace pNameSpace 
)

Get the node namespace.

Parameters
[in]hNodeHandle to Node instance.
[out]pNameSpaceNamespace retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetVisibility()

ITALA_API_C ItalaError NODE_GetVisibility ( H_NODE  hNode,
Visibility pVisibility 
)

Get the node visibility.

Parameters
[in]hNodeHandle to Node instance.
[out]pVisibilityVisibility retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_InvalidateNode()

ITALA_API_C ItalaError NODE_InvalidateNode ( H_NODE  hNode)

Invalidate the current node.

Parameters
[in]hNodeHandle to Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_IsCachable()

ITALA_API_C ItalaError NODE_IsCachable ( H_NODE  hNode,
bool *  pIsCachable 
)

Get if the node is cachable or not.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsCachableTrue if cachable, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_IsAccessModeCacheable()

ITALA_API_C ItalaError NODE_IsAccessModeCacheable ( H_NODE  hNode,
bool *  pIsAccessModeCacheable 
)

Get if the node access mode is cachable or not.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsAccessModeCacheableTrue if access mode is cachable, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetCachingMode()

ITALA_API_C ItalaError NODE_GetCachingMode ( H_NODE  hNode,
CachingMode pCachingMode 
)

Get the node caching mode.

Parameters
[in]hNodeHandle to Node instance.
[out]pCachingModeCaching mode retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetPollingTime()

ITALA_API_C ItalaError NODE_GetPollingTime ( H_NODE  hNode,
int64_t *  pPollingTime 
)

Get the node polling time.

Parameters
[in]hNodeHandle to Node instance.
[out]pPollingTimePolling time retrived.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetToolTip()

ITALA_API_C ItalaError NODE_GetToolTip ( H_NODE  hNode,
char *  toolTip,
size_t *  pSize 
)

Get the node tooltip.

Parameters
[in]hNodeHandle to Node instance.
[out]toolTipThe tooltip of the Node.
[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_GetDescription()

ITALA_API_C ItalaError NODE_GetDescription ( H_NODE  hNode,
char *  description,
size_t *  pSize 
)

Get the node description.

Parameters
[in]hNodeHandle to Node instance.
[out]descriptionThe description of the Node.
[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_GetDisplayName()

ITALA_API_C ItalaError NODE_GetDisplayName ( H_NODE  hNode,
char *  displayName,
size_t *  pSize 
)

Get the node diplay name.

Parameters
[in]hNodeHandle to Node instance.
[out]displayNameThe display name of the Node.
[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_GetDeviceName()

ITALA_API_C ItalaError NODE_GetDeviceName ( H_NODE  hNode,
char *  deviceName,
size_t *  pSize 
)

Get the node device name.

Parameters
[in]hNodeHandle to Node instance.
[out]deviceNameThe device name of the Node.
[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_GetChildrenNum()

ITALA_API_C ItalaError NODE_GetChildrenNum ( H_NODE  hNode,
LinkType  linkType,
size_t *  pNumChildren 
)

Get the number of childer Node.

Parameters
[in]hNodeHandle to Node instance.
[in]linkTypeThe link type.
[out]pNumChildrenNumber of children nodes.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetChildrenByIndex()

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.

Parameters
[in]hNodeHandle to Node instance.
[in]indexIndex of Node.
[in]linkTypeThe link type.
[out]phNodeChildrenHandle to children Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetParentNum()

ITALA_API_C ItalaError NODE_GetParentNum ( H_NODE  hNode,
size_t *  pNumParent 
)

Get the number of parent Node.

Parameters
[in]hNodeHandle to Node instance.
[out]pNumParentNumber of parent nodes.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetParentByIndex()

ITALA_API_C ItalaError NODE_GetParentByIndex ( H_NODE  hNode,
size_t  index,
H_NODE *  phNodeParent 
)

Get a parent node, given the specific index.

Parameters
[in]hNodeHandle to Node instance.
[in]indexIndex of Node.
[out]phNodeParentHandle to parent Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_RegisterCallback()

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.

Parameters
[in]hNodeHandle to Node instance.
[in]callbackThe method to execute as callback.
[in]pContextContext of the callback.
[out]phNodeCallbackHandle to NodeCallback instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_DeregisterCallback()

ITALA_API_C ItalaError NODE_DeregisterCallback ( H_NODE  hNode,
H_NODECALLBACK  hNodeCallback 
)

Unsubscribe a NodeCallbackFunction instance to the current node.

Parameters
[in]hNodeHandle to Node instance.
[in]hNodeCallbackHandle to NodeCallback instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetNodeMap()

ITALA_API_C ItalaError NODE_GetNodeMap ( H_NODE  hNode,
H_NODEMAP *  phNodeMap 
)

Get the nodemap relative to this node.

Parameters
[in]hNodeHandle to Node instance.
[out]phNodeMapHandle to NodeMap instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetEventId()

ITALA_API_C ItalaError NODE_GetEventId ( H_NODE  hNode,
char *  eventId,
size_t *  pSize 
)

Get the node event id.

Parameters
[in]hNodeHandle to Node instance.
[out]eventIdThe event id of the Node.
[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_IsStreamable()

ITALA_API_C ItalaError NODE_IsStreamable ( H_NODE  hNode,
bool *  pIsStreamable 
)

Get if the node is streamable or not.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsStreamableTrue if is streamable, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetPropertyNamesNum()

ITALA_API_C ItalaError NODE_GetPropertyNamesNum ( H_NODE  hNode,
size_t *  pNumOfProperty 
)

Get the property name number of the Node.

Parameters
[in]hNodeHandle to Node instance.
[out]pNumOfPropertyName number of the node.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetPropertyNameByIndex()

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.

Parameters
[in]hNodeHandle to Node instance.
[in]indexIndex of Node.
[out]propertyNameHandle to parent Node instance.
[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_GetProperty()

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.

Parameters
[in]hNodeHandle to Node instance.
[in]propertyNameName of the property.
[out]valuesValues of the property.
[in,out]pSizeValueMaximum element of the values array in input, number of element filled in output.
[out]attributesAttributes of the property.
[in,out]pSizeAttributesMaximum element of the attributes array in input, number of element filled in output.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_ImposedAccessMode()

ITALA_API_C ItalaError NODE_ImposedAccessMode ( H_NODE  hNode,
AccessMode  imposedAccessMode 
)

Imposes an access mode to the natural access mode of the node.

Parameters
[in]hNodeHandle to Node instance.
[out]imposedAccessModeImposed access mode to set.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_ImposedVisibility()

ITALA_API_C ItalaError NODE_ImposedVisibility ( H_NODE  hNode,
Visibility  imposedVisibility 
)

Imposes a visibility to the natural visibility of the node.

Parameters
[in]hNodeHandle to Node instance.
[out]imposedVisibilityImposed visibility to set.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetAlias()

ITALA_API_C ItalaError NODE_GetAlias ( H_NODE  hNode,
H_NODE *  phNodeAlias 
)

Retrieves the node which describes the same feature in a different way.

Parameters
[in]hNodeHandle to Node instance.
[out]phNodeAliasHandle to alias Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetCastAlias()

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

Parameters
[in]hNodeHandle to Node instance.
[out]phNodeCastAliasHandle to cast alias Node instance.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetDocuURL()

ITALA_API_C ItalaError NODE_GetDocuURL ( H_NODE  hNode,
char *  docuURL,
size_t *  pSize 
)

Get the node documentation URL.

Parameters
[in]hNodeHandle to Node instance.
[out]docuURLThe documentation URL of the Node.
[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_IsDeprecated()

ITALA_API_C ItalaError NODE_IsDeprecated ( H_NODE  hNode,
bool *  pIsDeprecated 
)

Get if the node is deprecated or not.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsDeprecatedTrue if is deprecated, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetPrincipalInterfaceType()

ITALA_API_C ItalaError NODE_GetPrincipalInterfaceType ( H_NODE  hNode,
InterfaceType pInterfaceType 
)

Get the type of the main interface of a node.

Parameters
[in]hNodeHandle to Node instance.
[out]pInterfaceTypeInterface type of the Node.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_IsFeature()

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".

Parameters
[in]hNodeHandle to Node instance.
[out]pIsFeatureTrue if can be reached via category nodes, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_GetAccessMode()

ITALA_API_C ItalaError NODE_GetAccessMode ( H_NODE  hNode,
AccessMode pAccessMode 
)

Get the access mode of a node.

Parameters
[in]hNodeHandle to Node instance.
[out]pAccessModeAccess mode of the Node.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ NODE_ToString()

ITALA_API_C ItalaError NODE_ToString ( H_NODE  hNode,
char *  value,
size_t *  pSize 
)

Get the node as a string.

Parameters
[in]hNodeHandle to Node instance.
[out]valueThe string of the Node.
[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_IsValueCacheValid()

ITALA_API_C ItalaError NODE_IsValueCacheValid ( H_NODE  hNode,
bool *  pIsCacheValid 
)

Checks if the value comes from cache or is requested from another node.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsCacheValidTrue if the value comes from cache, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ IsNodeReadable()

ITALA_API_C ItalaError IsNodeReadable ( H_NODE  hNode,
bool *  pIsReadable 
)

Checks if the node is readable.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsReadableTrue if the node is readable, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ IsNodeWritable()

ITALA_API_C ItalaError IsNodeWritable ( H_NODE  hNode,
bool *  pIsWritable 
)

Checks if the node is writable.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsWritableTrue if the node is writable, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ IsNodeImplemented()

ITALA_API_C ItalaError IsNodeImplemented ( H_NODE  hNode,
bool *  pIsImplemented 
)

Checks if the node is implemented.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsImplementedTrue if the node is implemented, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

◆ IsNodeAvailable()

ITALA_API_C ItalaError IsNodeAvailable ( H_NODE  hNode,
bool *  pIsAvailable 
)

Checks if the node is available.

Parameters
[in]hNodeHandle to Node instance.
[out]pIsAvailableTrue if the node is available, false otherwise.
Returns
ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.