Skip to content

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#

Name
virtual GenICam::gcstring GetName(bool FullQualified =false) const
Get node name.
virtual GenApi::ENameSpace GetNameSpace() const
Get name space.
virtual EVisibility GetVisibility() const
Get the recommended visibility of the node.
virtual void InvalidateNode()
Indicates that the node's value may have changed.
virtual bool IsCachable() const
Is the node value cachable.
virtual EYesNo IsAccessModeCacheable() const
True if the AccessMode can be cached.
virtual ECachingMode GetCachingMode() const
Get Caching Mode.
virtual int64_t GetPollingTime() const
recommended polling time (for not cachable nodes)
virtual GenICam::gcstring GetToolTip() const
Get a short description of the node.
virtual GenICam::gcstring GetDescription() const
Get a long description of the node.
virtual GenICam::gcstring GetDisplayName() const
Get a name string for display.
virtual GenICam::gcstring GetDeviceName() const
Get a name of the device.
virtual void GetChildren(GenApi::NodeList_t & Children, ELinkType LinkType =ctReadingChildren) const
Get all nodes this node directly depends on.
virtual void GetParents(GenApi::NodeList_t & Parents) const
Gets all nodes this node is directly depending on.
virtual CallbackHandleType RegisterCallback(CNodeCallback * pCallback)
Register change callback.
virtual bool DeregisterCallback(CallbackHandleType hCallback)
De register change callback.
virtual INodeMap * GetNodeMap() const
Retrieves the central node map.
virtual GenICam::gcstring GetEventID() const
Get the EventId of the node.
virtual bool IsStreamable() const
True if the node is streamable.
virtual void GetPropertyNames(GenICam::gcstring_vector & PropertyNames) const
Returns a list of the names all properties set during initialization.
virtual bool GetProperty(const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
Retrieves a property plus an additional attribute by name.
virtual void ImposeAccessMode(EAccessMode ImposedAccessMode)
Imposes an access mode to the natural access mode of the node.
virtual void ImposeVisibility(EVisibility ImposedVisibility)
Imposes a visibility to the natural visibility of the node.
virtual INode * GetAlias() const
Retrieves the a node which describes the same feature in a different way.
virtual INode * GetCastAlias() const
Retrieves the a node which describes the same feature so that it can be casted.
virtual GenICam::gcstring GetDocuURL() const
Gets a URL pointing to the documentation of that feature.
virtual bool IsDeprecated() const
True if the node should not be used any more.
virtual EInterfaceType GetPrincipalInterfaceType() const
Get the type of the main interface of a node.
virtual bool IsFeature() const
True if the node can be reached via category nodes from a category node named "Root".
virtual EAccessMode GetAccessMode() const
Get the access mode of the node.

Additional inherited members#

Public Functions inherited from GenApi::IBase

Name
virtual ~IBase()
Virtual destructor enforcing virtual destructor on all derived classes.

Public Functions Documentation#

GetName#

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

Get node name.

GetNameSpace#

virtual GenApi::ENameSpace GetNameSpace() const 

Get name space.

GetVisibility#

virtual EVisibility GetVisibility() const 

Get the recommended visibility of the node.

InvalidateNode#

virtual void InvalidateNode() 

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

IsCachable#

virtual bool IsCachable() const 

Is the node value cachable.

IsAccessModeCacheable#

virtual EYesNo IsAccessModeCacheable() const 

True if the AccessMode can be cached.

GetCachingMode#

virtual ECachingMode GetCachingMode() const 

Get Caching Mode.

GetPollingTime#

virtual int64_t GetPollingTime() const 

recommended polling time (for not cachable nodes)

GetToolTip#

virtual GenICam::gcstring GetToolTip() const 

Get a short description of the node.

GetDescription#

virtual GenICam::gcstring GetDescription() const 

Get a long description of the node.

GetDisplayName#

virtual GenICam::gcstring GetDisplayName() const 

Get a name string for display.

GetDeviceName#

virtual GenICam::gcstring GetDeviceName() const 

Get a name of the device.

GetChildren#

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

Get all nodes this node directly depends on.

Parameters:

  • Children List of children nodes
  • LinkType The link type

GetParents#

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

Gets all nodes this node is directly depending on.

Parameters:

  • Parents List of parent nodes

RegisterCallback#

virtual CallbackHandleType RegisterCallback(
    CNodeCallback * pCallback
) 

Register change callback.

Takes ownership of the CNodeCallback object

DeregisterCallback#

virtual bool DeregisterCallback(
    CallbackHandleType hCallback
) 

De register change callback.

Return: true if the callback handle was valid

Destroys CNodeCallback object

GetNodeMap#

virtual INodeMap * GetNodeMap() const 

Retrieves the central node map.

GetEventID#

virtual GenICam::gcstring GetEventID() const 

Get the EventId of the node.

IsStreamable#

virtual bool IsStreamable() const 

True if the node is streamable.

GetPropertyNames#

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

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

GetProperty#

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

Retrieves a property plus an additional attribute by name.

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

ImposeAccessMode#

virtual void ImposeAccessMode(
    EAccessMode ImposedAccessMode
) 

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

ImposeVisibility#

virtual void ImposeVisibility(
    EVisibility ImposedVisibility
) 

Imposes a visibility to the natural visibility of the node.

GetAlias#

virtual INode * GetAlias() const 

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

GetCastAlias#

virtual INode * GetCastAlias() const 

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

GetDocuURL#

virtual GenICam::gcstring GetDocuURL() const 

Gets a URL pointing to the documentation of that feature.

IsDeprecated#

virtual bool IsDeprecated() const 

True if the node should not be used any more.

GetPrincipalInterfaceType#

virtual EInterfaceType GetPrincipalInterfaceType() const 

Get the type of the main interface of a node.

IsFeature#

virtual bool IsFeature() const 

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

GetAccessMode#

virtual EAccessMode GetAccessMode() const 

Get the access mode of the node.

Reimplemented by: Pylon::CArrayParameter::GetAccessMode


Updated on 5 July 2022 at 15:30:01