Itala SDK - Documentation

Node¶

class itala.itala.INode(*args, **kwargs)¶

Bases: IBase

Interface common to all nodes

property alias: INode¶: Retrieves the a node which describes the same feature in a different way

property caching_mode: GENAPI_NAMESPACE::ECachingMode¶: Get Caching Mode

property cast_alias: INode¶: Retrieves the a node which describes the same feature so that it can be casted

property children: None¶: Get all nodes this node directly depends on. :type Children: GENAPI_NAMESPACE::NodeList_t, out :param Children: List of children nodes :type LinkType: int, optional :param LinkType: The link type

deregister_callback(hCallback: GENAPI_NAMESPACE::CallbackHandleType) → bool¶

De register change callback Destroys CNodeCallback object

rtype:: boolean
return:: true if the callback handle was valid

property description: str¶: Get a long description of the node

property device_name: str¶: Get a name of the device

property display_name: str¶: Get a name string for display

property docu_url: str¶: Gets a URL pointing to the documentation of that feature

property event_id: str¶: Get the EventId of the node

get_property(PropertyName: str) → None¶: Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters

impose_access_mode(ImposedAccessMode: GENAPI_NAMESPACE::EAccessMode) → None¶: Imposes an access mode to the natural access mode of the node

impose_visibility(ImposedVisibility: GENAPI_NAMESPACE::EVisibility) → None¶: Imposes a visibility to the natural visibility of the node

invalidate_node() → None¶: Indicates that the node’s value may have changed. Fires the callback on this and all dependent nodes

is_access_mode_cacheable() → GENAPI_NAMESPACE::EYesNo¶: True if the AccessMode can be cached

is_cachable() → bool¶: Is the node value cachable

is_deprecated() → bool¶: True if the node should not be used any more

is_feature() → bool¶: True if the node can be reached via category nodes from a category node named “Root”

is_selector() → bool¶: true iff this feature selects a group of features

is_streamable() → bool¶: True if the node is streamable

property name¶

property name_full_qualified¶

property name_space: GENAPI_NAMESPACE::ENameSpace¶: Get name space

property node_map: INodeMap¶: Retrieves the central node map

property parents: None¶: Gets all nodes this node is directly depending on :type Parents: GENAPI_NAMESPACE::NodeList_t, out :param Parents: List of parent nodes

property polling_time: int¶: recommended polling time (for not cachable nodes)

property principal_interface_type: GENAPI_NAMESPACE::EInterfaceType¶: Get the type of the main interface of a node

property property_names: None¶: Returns a list of the names all properties set during initialization

register_callback(INPUT: PyNodeCallback) → GENAPI_NAMESPACE::CallbackHandleType¶: Register change callback Takes ownership of the CNodeCallback object

property selected_features: None¶: retrieve the group of selected features

property selecting_features: None¶: retrieve the group of features selecting this node

property thisown¶: The membership flag

property tooltip: str¶: Get a short description of the node

property visibility: GENAPI_NAMESPACE::EVisibility¶: Get the recommended visibility of the node