All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
GenApi::INode Struct Referenceabstract

Interface common to all nodes. More...

#include <GenApi/INode.h>

Inheritance diagram for GenApi::INode:
Inheritance graph
[legend]

Public Member Functions

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

Detailed Description

Interface common to all nodes.

Member Function Documentation

virtual bool GenApi::INode::DeregisterCallback ( CallbackHandleType  hCallback)
pure virtual

De register change callback.

Destroys CNodeCallback object

Returns
true if the callback handle was valid
virtual void GenApi::INode::GetChildren ( GenApi::NodeList_t Children,
ELinkType  LinkType = ctReadingChildren 
) const
pure virtual

Get all nodes this node directly depends on.

Parameters
[out]ChildrenList of children nodes
LinkTypeThe link type
virtual void GenApi::INode::GetParents ( GenApi::NodeList_t Parents) const
pure virtual

Gets all nodes this node is directly depending on.

Parameters
[out]ParentsList of parent nodes
virtual bool GenApi::INode::GetProperty ( const GenICam::gcstring PropertyName,
GenICam::gcstring ValueStr,
GenICam::gcstring AttributeStr 
)
pure virtual

Retrieves a property plus an additional attribute by name.

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

virtual void GenApi::INode::InvalidateNode ( )
pure virtual

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

virtual CallbackHandleType GenApi::INode::RegisterCallback ( CNodeCallback pCallback)
pure virtual

Register change callback.

Takes ownership of the CNodeCallback object


The documentation for this struct was generated from the following file:

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)