Node Class Reference

class common to all nodes More...

#include <Node.h>

Inheritance diagram for Node:

Public Member Functions
	Node ()
	Constructor.
	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Constructor.
	~Node ()
	Destructor.
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 cacheable.
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 cacheable 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 void	GetLockNodes (GenApi::NodeList_t &LockNodes) const
	Gets all nodes which can directly lock this node.
virtual CallbackHandleType	RegisterCallback (CNodeCallback *pCallback)
	Register change callback Takes ownership of the CNodeCallback object.
virtual bool	DeregisterCallback (CallbackHandleType hCallback)
	De register change callback Destroys CNodeCallback object.
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 If a property has multiple values/attribute they come with Tabs as delimiters.
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".
void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Set Node handle.
std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
	Get Node handle.
virtual EAccessMode	GetAccessMode () const
	Base interface overrides.
virtual bool	IsSelector () const
	Selector interface overrides.
virtual void	GetSelectedFeatures (FeatureList_t &) const
	retrieve the group of selected features
virtual void	GetSelectingFeatures (FeatureList_t &) const
	retrieve the group of features selecting this node
virtual void	SetReference (INode *pBase)
	Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
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.
INodeMap *	m_pNodeMap

Detailed Description

class common to all nodes

Constructor & Destructor Documentation

Node() [1/2]

Node

(

)

Constructor.

Node() [2/2]

Node

(

std::shared_ptr< Node::NodeImpl >

pNodeHandle

)

Constructor.

~Node()

~Node

(

)

Destructor.

Member Function Documentation

DeregisterCallback()

virtual bool DeregisterCallback ( CallbackHandleType  hCallback )

virtual

De register change callback Destroys CNodeCallback object.

Returns

true if the callback handle was valid

GetAccessMode()

virtual EAccessMode GetAccessMode ( ) const

virtual

Base interface overrides.

Get the access mode of the node

Reimplemented in PortRecorder, and PortReplay.

GetAlias()

virtual INode * GetAlias ( ) const

virtual

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

GetCachingMode()

virtual ECachingMode GetCachingMode ( ) const

virtual

Get Caching Mode.

GetCastAlias()

virtual INode * GetCastAlias ( ) const

virtual

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

GetChildren()

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

virtual

Get all nodes this node directly depends on.

Parameters

[out]	Children	List of children nodes
	LinkType	The link type

GetDescription()

virtual GenICam::gcstring GetDescription ( ) const

virtual

Get a long description of the node.

GetDeviceName()

virtual GenICam::gcstring GetDeviceName ( ) const

virtual

Get a name of the device.

GetDisplayName()

virtual GenICam::gcstring GetDisplayName ( ) const

virtual

Get a name string for display.

GetDocuURL()

virtual GenICam::gcstring GetDocuURL ( ) const

virtual

Gets a URL pointing to the documentation of that feature.

GetEventID()

virtual GenICam::gcstring GetEventID ( ) const

virtual

Get the EventId of the node.

GetLockNodes()

virtual void GetLockNodes ( GenApi::NodeList_t &  LockNodes ) const

virtual

Gets all nodes which can directly lock this node.

Parameters

[out]

LockNodes

List of lock nodes.

GetName()

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

virtual

Get node name.

GetNameSpace()

virtual GenApi::ENameSpace GetNameSpace ( ) const

virtual

Get name space.

GetNodeHandle()

std::shared_ptr< Node::NodeImpl > GetNodeHandle

(

)

const

Get Node handle.

GetNodeMap()

virtual INodeMap * GetNodeMap ( ) const

virtual

Retrieves the central node map.

GetParents()

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

virtual

Gets all nodes this node is directly depending on.

Parameters

[out]

Parents

List of parent nodes

GetPollingTime()

virtual int64_t GetPollingTime ( ) const

virtual

recommended polling time (for not cacheable nodes)

GetPrincipalInterfaceType()

virtual EInterfaceType GetPrincipalInterfaceType ( ) const

virtual

Get the type of the main interface of a node.

GetProperty()

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.

GetPropertyNames()

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

virtual

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

GetSelectedFeatures()

virtual void GetSelectedFeatures ( FeatureList_t &  ) const

virtual

retrieve the group of selected features

GetSelectingFeatures()

virtual void GetSelectingFeatures ( FeatureList_t &  ) const

virtual

retrieve the group of features selecting this node

GetToolTip()

virtual GenICam::gcstring GetToolTip ( ) const

virtual

Get a short description of the node.

GetVisibility()

virtual EVisibility GetVisibility ( ) const

virtual

Get the recommended visibility of the node.

ImposeAccessMode()

virtual void ImposeAccessMode ( EAccessMode  ImposedAccessMode )

virtual

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

ImposeVisibility()

virtual void ImposeVisibility ( EVisibility  ImposedVisibility )

virtual

Imposes a visibility to the natural visibility of the node.

InvalidateNode()

virtual void InvalidateNode ( )

virtual

Indicates that the node's value may have changed.

Fires the callback on this and all dependent nodes

IsAccessModeCacheable()

virtual EYesNo IsAccessModeCacheable ( ) const

virtual

True if the AccessMode can be cached.

IsCachable()

virtual bool IsCachable ( ) const

virtual

Is the node value cacheable.

IsDeprecated()

virtual bool IsDeprecated ( ) const

virtual

True if the node should not be used any more.

IsFeature()

virtual bool IsFeature ( ) const

virtual

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

IsSelector()

virtual bool IsSelector ( ) const

virtual

Selector interface overrides.

true if this feature selects a group of features

IsStreamable()

virtual bool IsStreamable ( ) const

virtual

True if the node is streamable.

operator!=()

virtual bool operator!= ( int  nullPtr ) const

virtual

operator==()

virtual bool operator== ( int  nullPtr ) const

virtual

RegisterCallback()

virtual CallbackHandleType RegisterCallback ( CNodeCallback *  pCallback )

virtual

Register change callback Takes ownership of the CNodeCallback object.

SetNodeHandle()

void SetNodeHandle

(

std::shared_ptr< Node::NodeImpl >

pNodeHandle

)

Set Node handle.

SetNodeMap()

void SetNodeMap

(

INodeMap *

pNodeMap

)

SetReference() [1/2]

virtual void SetReference ( INode *  pBase )

virtual

Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

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

SetReference() [2/2]

virtual void SetReference ( ISelector *  pBase )

virtual

Reimplemented in PortNode.

Member Data Documentation

m_Callbacks

std::list<CallbackHandleType_t*> m_Callbacks

protected

List of callbacks.

m_pNodeData

std::shared_ptr<Node::NodeImpl> m_pNodeData

protected

m_pNodeMap

INodeMap* m_pNodeMap

protected

---

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

• include/SpinGenApi/Node.h