GenApi::INode#

Module: GenICam / GenApi Node Interfaces and Access Mode Check Functions

Interface common to all nodes.

#include <GenApi/INode.h>

Inherits from GenApi::IBase

Public Functions#

Additional inherited members#

Public Functions inherited from GenApi::IBase

Public Functions Documentation#

function GetName#

virtual GenICam::gcstring GetName(
    bool FullQualified =false
) const =0

Get node name.

function GetNameSpace#

virtual GenApi::ENameSpace GetNameSpace() const =0

Get name space.

function GetVisibility#

virtual EVisibility GetVisibility() const =0

Get the recommended visibility of the node.

function InvalidateNode#

virtual void InvalidateNode() =0

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

function IsCachable#

virtual bool IsCachable() const =0

Is the node value cachable.

function IsAccessModeCacheable#

virtual EYesNo IsAccessModeCacheable() const =0

True if the AccessMode can be cached.

function GetCachingMode#

virtual ECachingMode GetCachingMode() const =0

Get Caching Mode.

function GetPollingTime#

virtual int64_t GetPollingTime() const =0

recommended polling time (for not cachable nodes)

function GetToolTip#

virtual GenICam::gcstring GetToolTip() const =0

Get a short description of the node.

function GetDescription#

virtual GenICam::gcstring GetDescription() const =0

Get a long description of the node.

function GetDisplayName#

virtual GenICam::gcstring GetDisplayName() const =0

Get a name string for display.

function GetDeviceName#

virtual GenICam::gcstring GetDeviceName() const =0

Get a name of the device.

function GetChildren#

virtual void GetChildren(
    GenApi::NodeList_t & Children,
    ELinkType LinkType =ctReadingChildren
) const =0

Get all nodes this node directly depends on.

Parameters:

• Children List of children nodes
• LinkType The link type

function GetParents#

virtual void GetParents(
    GenApi::NodeList_t & Parents
) const =0

Gets all nodes this node is directly depending on.

Parameters:

• Parents List of parent nodes

function RegisterCallback#

virtual CallbackHandleType RegisterCallback(
    CNodeCallback * pCallback
) =0

Register change callback.

Takes ownership of the CNodeCallback object

function DeregisterCallback#

virtual bool DeregisterCallback(
    CallbackHandleType hCallback
) =0

De register change callback.

Return: true if the callback handle was valid

Destroys CNodeCallback object

function GetNodeMap#

virtual INodeMap * GetNodeMap() const =0

Retrieves the central node map.

function GetEventID#

virtual GenICam::gcstring GetEventID() const =0

Get the EventId of the node.

function IsStreamable#

virtual bool IsStreamable() const =0

True if the node is streamable.

function GetPropertyNames#

virtual void GetPropertyNames(
    GenICam::gcstring_vector & PropertyNames
) const =0

Returns a list of the names all properties set during initialization.

function GetProperty#

virtual bool GetProperty(
    const GenICam::gcstring & PropertyName,
    GenICam::gcstring & ValueStr,
    GenICam::gcstring & AttributeStr
) =0

Retrieves a property plus an additional attribute by name.

If a property has multiple values/attribute they come with Tabs as delimiters

function ImposeAccessMode#

virtual void ImposeAccessMode(
    EAccessMode ImposedAccessMode
) =0

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

function ImposeVisibility#

virtual void ImposeVisibility(
    EVisibility ImposedVisibility
) =0

Imposes a visibility to the natural visibility of the node.

function GetAlias#

virtual INode * GetAlias() const =0

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

function GetCastAlias#

virtual INode * GetCastAlias() const =0

Retrieves the a node which describes the same feature so that it can be casted.

function GetDocuURL#

virtual GenICam::gcstring GetDocuURL() const =0

Gets a URL pointing to the documentation of that feature.

function IsDeprecated#

virtual bool IsDeprecated() const =0

True if the node should not be used any more.

function GetPrincipalInterfaceType#

virtual EInterfaceType GetPrincipalInterfaceType() const =0

Get the type of the main interface of a node.

function IsFeature#

virtual bool IsFeature() const =0

True if the node can be reached via category nodes from a category node named "Root".

function GetAccessMode#

virtual EAccessMode GetAccessMode() const =0

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode