Node#

Typedefs

typedef void (*NodeCallbackFunction)(H_NODE hNode, void *pContext)#

Functions

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

Get the node name.

Parameters:
  • hNode[in] Handle to Node instance.

  • name[out] The name of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetNameSpace(H_NODE hNode, NameSpace *pNameSpace)#

Get the node namespace.

Parameters:
  • hNode[in] Handle to Node instance.

  • pNameSpace[out] Namespace retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetVisibility(H_NODE hNode, Visibility *pVisibility)#

Get the node visibility.

Parameters:
  • hNode[in] Handle to Node instance.

  • pVisibility[out] Visibility retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_InvalidateNode(H_NODE hNode)#

Invalidate the current node.

Parameters:
  • hNode[in] Handle to Node instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_IsCachable(H_NODE hNode, bool *pIsCachable)#

Get if the node is cachable or not.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsCachable[out] True if cachable, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_IsAccessModeCacheable(H_NODE hNode, bool *pIsAccessModeCacheable)#

Get if the node access mode is cachable or not.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsAccessModeCacheable[out] True if access mode is cachable, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetCachingMode(H_NODE hNode, CachingMode *pCachingMode)#

Get the node caching mode.

Parameters:
  • hNode[in] Handle to Node instance.

  • pCachingMode[out] Caching mode retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetPollingTime(H_NODE hNode, int64_t *pPollingTime)#

Get the node polling time.

Parameters:
  • hNode[in] Handle to Node instance.

  • pPollingTime[out] Polling time retrived.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node tooltip.

Parameters:
  • hNode[in] Handle to Node instance.

  • toolTip[out] The tooltip of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node description.

Parameters:
  • hNode[in] Handle to Node instance.

  • description[out] The description of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node diplay name.

Parameters:
  • hNode[in] Handle to Node instance.

  • displayName[out] The display name of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node device name.

Parameters:
  • hNode[in] Handle to Node instance.

  • deviceName[out] The device name of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the number of childer Node.

Parameters:
  • hNode[in] Handle to Node instance.

  • linkType[in] The link type.

  • pNumChildren[out] Number of children nodes.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • index[in] Index of Node.

  • linkType[in] The link type.

  • phNodeChildren[out] Handle to children Node instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetParentNum(H_NODE hNode, size_t *pNumParent)#

Get the number of parent Node.

Parameters:
  • hNode[in] Handle to Node instance.

  • pNumParent[out] Number of parent nodes.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get a parent node, given the specific index.

Parameters:
  • hNode[in] Handle to Node instance.

  • index[in] Index of Node.

  • phNodeParent[out] Handle to parent Node instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • callback[in] The method to execute as callback.

  • pContext[in] Context of the callback.

  • phNodeCallback[out] Handle to NodeCallback instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_DeregisterCallback(H_NODE hNode, H_NODECALLBACK hNodeCallback)#

Unsubscribe a NodeCallbackFunction instance to the current node.

Parameters:
  • hNode[in] Handle to Node instance.

  • hNodeCallback[in] Handle to NodeCallback instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetNodeMap(H_NODE hNode, H_NODEMAP *phNodeMap)#

Get the nodemap relative to this node.

Parameters:
  • hNode[in] Handle to Node instance.

  • phNodeMap[out] Handle to NodeMap instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node event id.

Parameters:
  • hNode[in] Handle to Node instance.

  • eventId[out] The event id of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_IsStreamable(H_NODE hNode, bool *pIsStreamable)#

Get if the node is streamable or not.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsStreamable[out] True if is streamable, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetPropertyNamesNum(H_NODE hNode, size_t *pNumOfProperty)#

Get the property name number of the Node.

Parameters:
  • hNode[in] Handle to Node instance.

  • pNumOfProperty[out] Name number of the node.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • index[in] Index of Node.

  • propertyName[out] Handle to parent Node instance.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • propertyName[in] Name of the property.

  • values[out] Values of the property.

  • pSizeValue[inout] Maximum element of the values array in input, number of element filled in output.

  • attributes[out] Attributes of the property.

  • pSizeAttributes[inout] Maximum 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.

ITALA_API_C ItalaError NODE_ImposedAccessMode(H_NODE hNode, AccessMode imposedAccessMode)#

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

Parameters:
  • hNode[in] Handle to Node instance.

  • imposedAccessMode[out] Imposed access mode to set.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_ImposedVisibility(H_NODE hNode, Visibility imposedVisibility)#

Imposes a visibility to the natural visibility of the node.

Parameters:
  • hNode[in] Handle to Node instance.

  • imposedVisibility[out] Imposed visibility to set.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • phNodeAlias[out] Handle to alias Node instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • phNodeCastAlias[out] Handle to cast alias Node instance.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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

Get the node documentation URL.

Parameters:
  • hNode[in] Handle to Node instance.

  • docuURL[out] The documentation URL of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_IsDeprecated(H_NODE hNode, bool *pIsDeprecated)#

Get if the node is deprecated or not.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsDeprecated[out] True if is deprecated, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetPrincipalInterfaceType(H_NODE hNode, InterfaceType *pInterfaceType)#

Get the type of the main interface of a node.

Parameters:
  • hNode[in] Handle to Node instance.

  • pInterfaceType[out] Interface type of the Node.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • pIsFeature[out] True if can be reached via category nodes, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_GetAccessMode(H_NODE hNode, AccessMode *pAccessMode)#

Get the access mode of a node.

Parameters:
  • hNode[in] Handle to Node instance.

  • pAccessMode[out] Access mode of the Node.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError NODE_FromString(H_NODE hNode, const char *valueStr)#
ITALA_API_C ItalaError NODE_ToString(H_NODE hNode, char *value, size_t *pSize)#

Get the node as a string.

Parameters:
  • hNode[in] Handle to Node instance.

  • value[out] The string of the Node.

  • pSize[inout] Maximum element of the array in input, number of element filled in output.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

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:
  • hNode[in] Handle to Node instance.

  • pIsCacheValid[out] True if the value comes from cache, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError IsNodeReadable(H_NODE hNode, bool *pIsReadable)#

Checks if the node is readable.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsReadable[out] True if the node is readable, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError IsNodeWritable(H_NODE hNode, bool *pIsWritable)#

Checks if the node is writable.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsWritable[out] True if the node is writable, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError IsNodeImplemented(H_NODE hNode, bool *pIsImplemented)#

Checks if the node is implemented.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsImplemented[out] True if the node is implemented, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.

ITALA_API_C ItalaError IsNodeAvailable(H_NODE hNode, bool *pIsAvailable)#

Checks if the node is available.

Parameters:
  • hNode[in] Handle to Node instance.

  • pIsAvailable[out] True if the node is available, false otherwise.

Returns:

ItalaError the error code; return ItalaErrorSuccess (0) if no errors occures.