Class Spinnaker::GenApi::Node¶

class common to all nodes

#include <Node.h>

Inherits the following classes: INode

Inherited by the following classes: Spinnaker::GenApi::CSelectorSet, Spinnaker::GenApi::PortNode, Spinnaker::GenApi::ValueNode

Public Functions¶

Type	Name
virtual bool	DeregisterCallback (CallbackHandleType hCallback)
virtual EAccessMode	GetAccessMode () const Base interface overrides.
virtual INode *	GetAlias () const
virtual ECachingMode	GetCachingMode () const
virtual INode *	GetCastAlias () const
virtual void	GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const Get all nodes this node directly depends on.
virtual GenICam::gcstring	GetDescription () const
virtual GenICam::gcstring	GetDeviceName () const
virtual GenICam::gcstring	GetDisplayName () const
virtual GenICam::gcstring	GetDocuURL () const
virtual GenICam::gcstring	GetEventID () const
virtual void	GetLockNodes (GenApi::NodeList_t & LockNodes) const Gets all nodes which can directly lock this node.
virtual GenICam::gcstring	GetName (bool FullQualified=false) const
virtual GenApi::ENameSpace	GetNameSpace () const
std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
virtual INodeMap *	GetNodeMap () const
virtual void	GetParents (GenApi::NodeList_t & Parents) const Gets all nodes this node is directly depending on.
virtual int64_t	GetPollingTime () const
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual bool	GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
virtual void	GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const
virtual void	GetSelectedFeatures (FeatureList_t &) const
virtual void	GetSelectingFeatures (FeatureList_t &) const
virtual GenICam::gcstring	GetToolTip () const
virtual EVisibility	GetVisibility () const
virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)
virtual void	ImposeVisibility (EVisibility ImposedVisibility)
virtual void	InvalidateNode ()
virtual EYesNo	IsAccessModeCacheable () const
virtual bool	IsCachable () const
virtual bool	IsDeprecated () const
virtual bool	IsFeature () const
virtual bool	IsSelector () const Selector interface overrides.
virtual bool	IsStreamable () const
	Node ()
	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
virtual CallbackHandleType	RegisterCallback (CNodeCallback * pCallback)
void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
void	SetNodeMap (INodeMap * pNodeMap)
virtual void	SetReference (INode * pBase) Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void	SetReference (ISelector * pBase)
virtual bool	operator!= (int nullPtr) const
virtual bool	operator== (int nullPtr) const
	~Node ()

Protected Attributes¶

Type	Name
std::list< CallbackHandleType_t * >	m_Callbacks
std::shared_ptr< Node::NodeImpl >	m_pNodeData
INodeMap *	m_pNodeMap

Public Functions Documentation¶

function DeregisterCallback¶

virtual bool GenApi::Node::DeregisterCallback (
    CallbackHandleType hCallback
)

De register change callback Destroys CNodeCallback object

Returns:

true if the callback handle was valid

function GetAccessMode¶

Base interface overrides.

virtual EAccessMode GenApi::Node::GetAccessMode () const

Get the access mode of the node

function GetAlias¶

virtual INode * GenApi::Node::GetAlias () const

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

function GetCachingMode¶

virtual ECachingMode GenApi::Node::GetCachingMode () const

Get Caching Mode

function GetCastAlias¶

virtual INode * GenApi::Node::GetCastAlias () const

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

function GetChildren¶

Get all nodes this node directly depends on.

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

Parameters:

Children List of children nodes
LinkType The link type

function GetDescription¶

virtual GenICam::gcstring GenApi::Node::GetDescription () const

Get a long description of the node

function GetDeviceName¶

virtual GenICam::gcstring GenApi::Node::GetDeviceName () const

Get a name of the device

function GetDisplayName¶

virtual GenICam::gcstring GenApi::Node::GetDisplayName () const

Get a name string for display

function GetDocuURL¶

virtual GenICam::gcstring GenApi::Node::GetDocuURL () const

Gets a URL pointing to the documentation of that feature

function GetEventID¶

virtual GenICam::gcstring GenApi::Node::GetEventID () const

Get the EventId of the node

function GetLockNodes¶

Gets all nodes which can directly lock this node.

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

Parameters:

LockNodes List of lock nodes.

function GetName¶

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

Get node name

function GetNameSpace¶

virtual GenApi::ENameSpace GenApi::Node::GetNameSpace () const

Get name space

function GetNodeHandle¶

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

Get Node handle

function GetNodeMap¶

virtual INodeMap * GenApi::Node::GetNodeMap () const

Retrieves the central node map

function GetParents¶

Gets all nodes this node is directly depending on.

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

Parameters:

Parents List of parent nodes

function GetPollingTime¶

virtual int64_t GenApi::Node::GetPollingTime () const

recommended polling time (for not cacheable nodes)

function GetPrincipalInterfaceType¶

virtual EInterfaceType GenApi::Node::GetPrincipalInterfaceType () const

Get the type of the main interface of a node

function GetProperty¶

virtual bool GenApi::Node::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

function GetPropertyNames¶

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

Returns a list of the names all properties set during initialization

function GetSelectedFeatures¶

virtual void GenApi::Node::GetSelectedFeatures (
    FeatureList_t &
) const

retrieve the group of selected features

function GetSelectingFeatures¶

virtual void GenApi::Node::GetSelectingFeatures (
    FeatureList_t &
) const

retrieve the group of features selecting this node

function GetToolTip¶

virtual GenICam::gcstring GenApi::Node::GetToolTip () const

Get a short description of the node

function GetVisibility¶

virtual EVisibility GenApi::Node::GetVisibility () const

Get the recommended visibility of the node

function ImposeAccessMode¶

virtual void GenApi::Node::ImposeAccessMode (
    EAccessMode ImposedAccessMode
)

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

function ImposeVisibility¶

virtual void GenApi::Node::ImposeVisibility (
    EVisibility ImposedVisibility
)

Imposes a visibility to the natural visibility of the node

function InvalidateNode¶

virtual void GenApi::Node::InvalidateNode ()

Indicates that the node's value may have changed. Fires the callback on this and all dependent nodes

function IsAccessModeCacheable¶

virtual EYesNo GenApi::Node::IsAccessModeCacheable () const

True if the AccessMode can be cached

function IsCachable¶

virtual bool GenApi::Node::IsCachable () const

Is the node value cacheable

function IsDeprecated¶

virtual bool GenApi::Node::IsDeprecated () const

True if the node should not be used any more

function IsFeature¶

virtual bool GenApi::Node::IsFeature () const

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

function IsSelector¶

Selector interface overrides.

virtual bool GenApi::Node::IsSelector () const

true if this feature selects a group of features

function IsStreamable¶

virtual bool GenApi::Node::IsStreamable () const

True if the node is streamable

function Node [1/2]¶

GenApi::Node::Node ()

Constructor

function Node [2/2]¶

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

Constructor

function RegisterCallback¶

virtual CallbackHandleType GenApi::Node::RegisterCallback (
    CNodeCallback * pCallback
)

Register change callback Takes ownership of the CNodeCallback object

function SetNodeHandle¶

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

Set Node handle

function SetNodeMap¶

void GenApi::Node::SetNodeMap (
    INodeMap * pNodeMap
)

function SetReference [1/2]¶

Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

virtual void GenApi::Node::SetReference (
    INode * pBase
)

function SetReference [2/2]¶

virtual void GenApi::Node::SetReference (
    ISelector * pBase
)

function operator!=¶

virtual bool GenApi::Node::operator!= (
    int nullPtr
) const

function operator==¶

virtual bool GenApi::Node::operator== (
    int nullPtr
) const

function ~Node¶

GenApi::Node::~Node ()

Destructor

Protected Attributes Documentation¶

variable m_Callbacks¶

std::list<CallbackHandleType_t*> Spinnaker::GenApi::Node::m_Callbacks;

List of callbacks

variable m_pNodeData¶

std::shared_ptr<Node::NodeImpl> Spinnaker::GenApi::Node::m_pNodeData;

variable m_pNodeMap¶

INodeMap* Spinnaker::GenApi::Node::m_pNodeMap;

The documentation for this class was generated from the following file C:/workspace/include/SpinGenApi/Node.h