Spinnaker C++
2.6.0.0
Public Member Functions | Protected Attributes | List of all members
Node Class Reference

class common to all nodes More...

Inheritance diagram for Node:
CSelectorSet PortNode ValueNode PortReplay BooleanNode CategoryNode CommandNode EnumEntryNode EnumNode FloatNode IntegerNode RegisterNode StringNode

Public Member Functions

 Node ()
 Constructor. More...
 
 Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Constructor. More...
 
 ~Node ()
 Destructor. More...
 
virtual GenICam::gcstring GetName (bool FullQualified=false) const
 Get node name. More...
 
virtual GenApi::ENameSpace GetNameSpace () const
 Get name space. More...
 
virtual EVisibility GetVisibility () const
 Get the recommended visibility of the node. More...
 
virtual void InvalidateNode ()
 Indicates that the node's value may have changed. More...
 
virtual bool IsCachable () const
 Is the node value cacheable. More...
 
virtual EYesNo IsAccessModeCacheable () const
 True if the AccessMode can be cached. More...
 
virtual ECachingMode GetCachingMode () const
 Get Caching Mode. More...
 
virtual int64_t GetPollingTime () const
 recommended polling time (for not cacheable nodes) More...
 
virtual GenICam::gcstring GetToolTip () const
 Get a short description of the node. More...
 
virtual GenICam::gcstring GetDescription () const
 Get a long description of the node. More...
 
virtual GenICam::gcstring GetDisplayName () const
 Get a name string for display. More...
 
virtual GenICam::gcstring GetDeviceName () const
 Get a name of the device. More...
 
virtual void GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const
 Get all nodes this node directly depends on. More...
 
virtual void GetParents (GenApi::NodeList_t &Parents) const
 Gets all nodes this node is directly depending on. More...
 
virtual CallbackHandleType RegisterCallback (CNodeCallback *pCallback)
 Register change callback Takes ownership of the CNodeCallback object. More...
 
virtual bool DeregisterCallback (CallbackHandleType hCallback)
 De register change callback Destroys CNodeCallback object. More...
 
virtual INodeMapGetNodeMap () const
 Retrieves the central node map. More...
 
virtual GenICam::gcstring GetEventID () const
 Get the EventId of the node. More...
 
virtual bool IsStreamable () const
 True if the node is streamable. More...
 
virtual void GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const
 Returns a list of the names all properties set during initialization. More...
 
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. More...
 
virtual void ImposeAccessMode (EAccessMode ImposedAccessMode)
 Imposes an access mode to the natural access mode of the node. More...
 
virtual void ImposeVisibility (EVisibility ImposedVisibility)
 Imposes a visibility to the natural visibility of the node. More...
 
virtual INodeGetAlias () const
 Retrieves the a node which describes the same feature in a different way. More...
 
virtual INodeGetCastAlias () const
 Retrieves the a node which describes the same feature so that it can be casted. More...
 
virtual GenICam::gcstring GetDocuURL () const
 Gets a URL pointing to the documentation of that feature. More...
 
virtual bool IsDeprecated () const
 True if the node should not be used any more. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
virtual bool IsFeature () const
 True if the node can be reached via category nodes from a category node named "Root". More...
 
void SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Set Node handle. More...
 
std::shared_ptr< Node::NodeImpl > GetNodeHandle () const
 Get Node handle. More...
 
virtual EAccessMode GetAccessMode () const
 Base interface overrides. More...
 
virtual bool IsSelector () const
 Selector interface overrides. More...
 
virtual void GetSelectedFeatures (FeatureList_t &) const
 retrieve the group of selected features More...
 
virtual void GetSelectingFeatures (FeatureList_t &) const
 retrieve the group of features selecting this node More...
 
virtual void SetReference (INode *pBase)
 Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl. More...
 
virtual void SetReference (ISelector *pBase)
 
void SetNodeMap (INodeMap *pNodeMap)
 
virtual bool operator== (int nullPtr) const
 
virtual bool operator!= (int nullPtr) const
 

Protected Attributes

std::shared_ptr< Node::NodeImpl > m_pNodeData
 
std::list< CallbackHandleType_t * > m_Callbacks
 List of callbacks. More...
 
INodeMapm_pNodeMap
 

Detailed Description

class common to all nodes

Constructor & Destructor Documentation

Node ( )

Constructor.

Node ( std::shared_ptr< Node::NodeImpl >  pNodeHandle)

Constructor.

~Node ( )

Destructor.

Member Function Documentation

virtual bool DeregisterCallback ( CallbackHandleType  hCallback)
virtual

De register change callback Destroys CNodeCallback object.

Returns
true if the callback handle was valid
virtual EAccessMode GetAccessMode ( ) const
virtual

Base interface overrides.

Get the access mode of the node

Reimplemented in PortRecorder, and PortReplay.

virtual INode* GetAlias ( ) const
virtual

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

virtual ECachingMode GetCachingMode ( ) const
virtual

Get Caching Mode.

virtual INode* GetCastAlias ( ) const
virtual

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

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

Get all nodes this node directly depends on.

Parameters
[out]ChildrenList of children nodes
LinkTypeThe link type
virtual GenICam::gcstring GetDescription ( ) const
virtual

Get a long description of the node.

virtual GenICam::gcstring GetDeviceName ( ) const
virtual

Get a name of the device.

virtual GenICam::gcstring GetDisplayName ( ) const
virtual

Get a name string for display.

virtual GenICam::gcstring GetDocuURL ( ) const
virtual

Gets a URL pointing to the documentation of that feature.

virtual GenICam::gcstring GetEventID ( ) const
virtual

Get the EventId of the node.

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

Get node name.

virtual GenApi::ENameSpace GetNameSpace ( ) const
virtual

Get name space.

std::shared_ptr<Node::NodeImpl> GetNodeHandle ( ) const

Get Node handle.

virtual INodeMap* GetNodeMap ( ) const
virtual

Retrieves the central node map.

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

Gets all nodes this node is directly depending on.

Parameters
[out]ParentsList of parent nodes
virtual int64_t GetPollingTime ( ) const
virtual

recommended polling time (for not cacheable nodes)

virtual EInterfaceType GetPrincipalInterfaceType ( ) const
virtual

Get the type of the main interface of a node.

virtual bool GetProperty ( const GenICam::gcstring PropertyName,
GenICam::gcstring ValueStr,
GenICam::gcstring AttributeStr 
)
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 GetPropertyNames ( GenICam::gcstring_vector &  PropertyNames) const
virtual

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

virtual void GetSelectedFeatures ( FeatureList_t &  ) const
virtual

retrieve the group of selected features

virtual void GetSelectingFeatures ( FeatureList_t &  ) const
virtual

retrieve the group of features selecting this node

virtual GenICam::gcstring GetToolTip ( ) const
virtual

Get a short description of the node.

virtual EVisibility GetVisibility ( ) const
virtual

Get the recommended visibility of the node.

virtual void ImposeAccessMode ( EAccessMode  ImposedAccessMode)
virtual

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

virtual void ImposeVisibility ( EVisibility  ImposedVisibility)
virtual

Imposes a visibility to the natural visibility of the node.

virtual void InvalidateNode ( )
virtual

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

virtual EYesNo IsAccessModeCacheable ( ) const
virtual

True if the AccessMode can be cached.

virtual bool IsCachable ( ) const
virtual

Is the node value cacheable.

virtual bool IsDeprecated ( ) const
virtual

True if the node should not be used any more.

virtual bool IsFeature ( ) const
virtual

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

virtual bool IsSelector ( ) const
virtual

Selector interface overrides.

true if this feature selects a group of features

virtual bool IsStreamable ( ) const
virtual

True if the node is streamable.

virtual bool operator!= ( int  nullPtr) const
virtual
virtual bool operator== ( int  nullPtr) const
virtual
virtual CallbackHandleType RegisterCallback ( CNodeCallback pCallback)
virtual

Register change callback Takes ownership of the CNodeCallback object.

void SetNodeHandle ( std::shared_ptr< Node::NodeImpl >  pNodeHandle)

Set Node handle.

void SetNodeMap ( INodeMap pNodeMap)
virtual void SetReference ( INode pBase)
virtual

Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

Reimplemented in FloatNode, PortNode, IntegerNode, EnumNode, CEnumerationTRef< EnumT >, StringNode, ValueNode, RegisterNode, BooleanNode, CommandNode, EnumEntryNode, CategoryNode, StringRegNode, FloatRegNode, and IntRegNode.

virtual void SetReference ( ISelector pBase)
virtual

Member Data Documentation

std::list<CallbackHandleType_t*> m_Callbacks
protected

List of callbacks.

std::shared_ptr<Node::NodeImpl> m_pNodeData
protected
INodeMap* m_pNodeMap
protected

The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference