Represents a GenAPI node. More...

#include <peak/node_map/peak_node.hpp>

Inheritance diagram for peak::core::nodes::Node:

Public Types
using	ChangedCallback = std::function<void(const std::shared_ptr<Node>& changedNode)>
using	ChangedCallbackHandle = ChangedCallback*

Public Member Functions
	Node ()=delete
virtual	~Node ()
	Node (const Node &other)=delete
Node &	operator= (const Node &other)=delete
	Node (Node &&other)=delete
Node &	operator= (Node &&other)=delete
PEAK_COMMON_NO_DISCARD std::string	Name () const
	Returns the name.
PEAK_COMMON_NO_DISCARD std::string	DisplayName () const
	Returns the display name.
PEAK_COMMON_NO_DISCARD NodeNamespace	Namespace () const
	Returns the namespace the node belongs to.
PEAK_COMMON_NO_DISCARD NodeVisibility	Visibility () const
	Returns the visibility.
PEAK_COMMON_NO_DISCARD NodeAccessStatus	AccessStatus () const
	Returns the access status.
PEAK_COMMON_NO_DISCARD bool	IsReadable () const
	Returns whether the node is currently readable.
PEAK_COMMON_NO_DISCARD bool	IsWriteable () const
	Returns whether the node is currently writeable.
PEAK_COMMON_NO_DISCARD bool	IsAvailable () const
	Returns whether the node is currently either readable or writeable.
PEAK_COMMON_NO_DISCARD bool	IsImplemented () const
	Returns whether the node is implemented.
PEAK_COMMON_NO_DISCARD bool	IsCacheable () const
	Checks whether the node is cacheable.
PEAK_COMMON_NO_DISCARD bool	IsAccessStatusCacheable () const
	Checks whether the node's access status is cacheable.
PEAK_COMMON_NO_DISCARD bool	IsStreamable () const
	Checks whether the node is streamable.
PEAK_COMMON_NO_DISCARD bool	IsDeprecated () const
	Checks whether the node is deprecated.
PEAK_COMMON_NO_DISCARD bool	IsFeature () const
	Checks whether the node is a feature, i.e. it can be reached via category nodes from a category node named "Root".
PEAK_COMMON_NO_DISCARD NodeCachingMode	CachingMode () const
	Returns the caching mode.
PEAK_COMMON_NO_DISCARD int64_t	PollingTime () const
	Returns the polling time.
PEAK_COMMON_NO_DISCARD std::string	ToolTip () const
	Returns the tool tip.
PEAK_COMMON_NO_DISCARD std::string	Description () const
	Returns the description.
PEAK_COMMON_NO_DISCARD NodeType	Type () const
	Returns the type.
PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeMap >	ParentNodeMap () const
	Returns the parent node map.
PEAK_COMMON_NO_DISCARD std::shared_ptr< Node >	FindInvalidatedNode (const std::string &name) const
	Tries to find an invalidated node with the given name.
template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType >	FindInvalidatedNode (const std::string &name) const
	Tries to find an invalidated node with the given name and type.
PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< Node > >	InvalidatedNodes () const
	Returns the invalidated nodes.
PEAK_COMMON_NO_DISCARD std::shared_ptr< Node >	FindInvalidatingNode (const std::string &name) const
	Tries to find an invalidating node with the given name.
template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType >	FindInvalidatingNode (const std::string &name) const
	Tries to find an invalidating node with the given name and type.
PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< Node > >	InvalidatingNodes () const
	Returns the invalidating nodes.
PEAK_COMMON_NO_DISCARD std::shared_ptr< Node >	FindSelectedNode (const std::string &name) const
	Tries to find a selected node with the given name.
template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType >	FindSelectedNode (const std::string &name) const
	Tries to find a selected node with the given name and type.
PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< Node > >	SelectedNodes () const
	Returns the selected nodes.
PEAK_COMMON_NO_DISCARD std::shared_ptr< Node >	FindSelectingNode (const std::string &name) const
	Tries to find a selecting node with the given name.
template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType >	FindSelectingNode (const std::string &name) const
	Tries to find a selecting node with the given name and type.
PEAK_COMMON_NO_DISCARD std::vector< std::shared_ptr< Node > >	SelectingNodes () const
	Returns the selecting nodes.
PEAK_COMMON_NO_DISCARD ChangedCallbackHandle	RegisterChangedCallback (const ChangedCallback &callback)
	Registers a callback for signaling a change to the node.
void	UnregisterChangedCallback (ChangedCallbackHandle callbackHandle)
	Unregisters a changed callback.

Detailed Description

Represents a GenAPI node.

This class allows to interact with a single node of a module. It is the base class for all nodes a module can have.

Member Typedef Documentation

◆ ChangedCallback

using peak::core::nodes::Node::ChangedCallback = std::function<void(const std::shared_ptr<Node>& changedNode)>

The type of changed callbacks.

◆ ChangedCallbackHandle

using peak::core::nodes::Node::ChangedCallbackHandle = ChangedCallback*

The type of changed callback handles.

Constructor & Destructor Documentation

◆ Node() [1/3]

peak::core::nodes::Node::Node ( )

delete

◆ ~Node()

peak::core::nodes::Node::~Node ( )

inlinevirtual

◆ Node() [2/3]

peak::core::nodes::Node::Node ( const Node & other )

delete

◆ Node() [3/3]

peak::core::nodes::Node::Node ( Node && other )

delete

Member Function Documentation

◆ AccessStatus()

NodeAccessStatus peak::core::nodes::Node::AccessStatus ( ) const

inline

Returns the access status.

Returns: Access status

Since: 1.0

Exceptions

IOException	A communication error has occured, e.g. when the device is disconnected.
InternalErrorException	An internal error has occurred.

◆ CachingMode()

NodeCachingMode peak::core::nodes::Node::CachingMode ( ) const

inline

Returns the caching mode.

See Node Caching and Polling Concepts.

Returns: Caching mode

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Description()

std::string peak::core::nodes::Node::Description ( ) const

inline

Returns the description.

Returns: Description

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ DisplayName()

std::string peak::core::nodes::Node::DisplayName ( ) const

inline

Returns the display name.

Returns: Display name

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ FindInvalidatedNode() [1/2]

std::shared_ptr< Node > peak::core::nodes::Node::FindInvalidatedNode ( const std::string & name ) const

inline

Tries to find an invalidated node with the given name.

See Node Caching and Polling Concepts.

This query uses the same scope as InvalidatedNodes: it can return directly and indirectly dependent nodes that become invalid when this node changes.

Parameters

[in] name The name of the invalidated node to find.

Returns: Found node.; If no invalidated node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no invalidated node with the given name
InternalErrorException	An internal error has occurred.

◆ FindInvalidatedNode() [2/2]

template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>

PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType > peak::core::nodes::Node::FindInvalidatedNode ( const std::string & name ) const

inline

Tries to find an invalidated node with the given name and type.

This typed query uses the same scope as InvalidatedNodes: it can return directly and indirectly dependent nodes that become invalid when this node changes.

Parameters

[in] name The name of the invalidated node to find.

Returns: Found node.; If no invalidated node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no invalidated node with the given name
InvalidCastException	The found node cannot be cast to the given type
InternalErrorException	An internal error has occurred.

◆ FindInvalidatingNode() [1/2]

std::shared_ptr< Node > peak::core::nodes::Node::FindInvalidatingNode ( const std::string & name ) const

inline

Tries to find an invalidating node with the given name.

See Node Caching and Polling Concepts.

This query uses the same scope as InvalidatingNodes: it can return only directly connected upstream nodes that can invalidate this node.

Parameters

[in] name The name of the invalidating node to find.

Returns: Found node.; If no invalidating node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no invalidating node with the given name
InternalErrorException	An internal error has occurred.

◆ FindInvalidatingNode() [2/2]

template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>

PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType > peak::core::nodes::Node::FindInvalidatingNode ( const std::string & name ) const

inline

Tries to find an invalidating node with the given name and type.

This typed query uses the same scope as InvalidatingNodes: it can return only directly connected upstream nodes that can invalidate this node.

Parameters

[in] name The name of the invalidating node to find.

Returns: Found node.; If no invalidating node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no invalidating node with the given name
InvalidCastException	The found node cannot be cast to the given type
InternalErrorException	An internal error has occurred.

◆ FindSelectedNode() [1/2]

std::shared_ptr< Node > peak::core::nodes::Node::FindSelectedNode ( const std::string & name ) const

inline

Tries to find a selected node with the given name.

Parameters

[in] name The name of the selected node to find.

Returns: Found node.; If no selected node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no selected node with the given name
InternalErrorException	An internal error has occurred.

◆ FindSelectedNode() [2/2]

template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>

PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType > peak::core::nodes::Node::FindSelectedNode ( const std::string & name ) const

inline

Tries to find a selected node with the given name and type.

Parameters

[in] name The name of the selected node to find.

Returns: Found node.; If no selected node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no selected node with the given name
InvalidCastException	The found node cannot be cast to the given type
InternalErrorException	An internal error has occurred.

◆ FindSelectingNode() [1/2]

std::shared_ptr< Node > peak::core::nodes::Node::FindSelectingNode ( const std::string & name ) const

inline

Tries to find a selecting node with the given name.

Parameters

[in] name The name of the selecting node to find.

Returns: Found node.; If no selecting node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no selecting node with the given name
InternalErrorException	An internal error has occurred.

◆ FindSelectingNode() [2/2]

template<class NodeType, typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>

PEAK_COMMON_NO_DISCARD std::shared_ptr< NodeType > peak::core::nodes::Node::FindSelectingNode ( const std::string & name ) const

inline

Tries to find a selecting node with the given name and type.

Parameters

[in] name The name of the selecting node to find.

Returns: Found node.; If no selecting node with the given name exists, a NotFoundException is thrown.

Since: 1.0

Exceptions

NotFoundException	There is no selecting node with the given name
InvalidCastException	The found node cannot be cast to the given type
InternalErrorException	An internal error has occurred.

◆ InvalidatedNodes()

std::vector< std::shared_ptr< Node > > peak::core::nodes::Node::InvalidatedNodes ( ) const

inline

Returns the invalidated nodes.

See Node Caching and Polling Concepts.

Returns dependent nodes that become invalid when this node changes. The returned set can include both directly and indirectly connected nodes.

Returns: Invalidated nodes

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ InvalidatingNodes()

std::vector< std::shared_ptr< Node > > peak::core::nodes::Node::InvalidatingNodes ( ) const

inline

Returns the invalidating nodes.

See Node Caching and Polling Concepts.

Returns upstream nodes that can invalidate this node. The returned set contains directly connected nodes only.

Returns: Invalidating nodes

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ IsAccessStatusCacheable()

bool peak::core::nodes::Node::IsAccessStatusCacheable ( ) const

inline

Checks whether the node's access status is cacheable.

See Node Caching and Polling Concepts.

Returns: True, if the node's access status is cacheable.; False otherwise.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ IsAvailable()

bool peak::core::nodes::Node::IsAvailable ( ) const

inline

Returns whether the node is currently either readable or writeable.

Exceptions

IOException	A communication error has occurred, e.g. when the device is disconnected.
InternalErrorException	An internal error has occurred.

Since: 1.10

◆ IsCacheable()

bool peak::core::nodes::Node::IsCacheable ( ) const

inline

Checks whether the node is cacheable.

See Node Caching and Polling Concepts.

Returns: True, if the node is cacheable.; False otherwise.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ IsDeprecated()

bool peak::core::nodes::Node::IsDeprecated ( ) const

inline

Checks whether the node is deprecated.

Returns: True, if the node is deprecated.; False otherwise.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ IsFeature()

bool peak::core::nodes::Node::IsFeature ( ) const

inline

Checks whether the node is a feature, i.e. it can be reached via category nodes from a category node named "Root".

Returns: True, if the node is a feature.; False otherwise.

Since: 1.2

Exceptions

InternalErrorException An internal error has occurred.

◆ IsImplemented()

bool peak::core::nodes::Node::IsImplemented ( ) const

inline

Returns whether the node is implemented.

Exceptions

IOException	A communication error has occurred, e.g. when the device is disconnected.
InternalErrorException	An internal error has occurred.

Since: 1.10

◆ IsReadable()

bool peak::core::nodes::Node::IsReadable ( ) const

inline

Returns whether the node is currently readable.

Exceptions

IOException	A communication error has occurred, e.g. when the device is disconnected.
InternalErrorException	An internal error has occurred.

Since: 1.8.1

◆ IsStreamable()

bool peak::core::nodes::Node::IsStreamable ( ) const

inline

Checks whether the node is streamable.

Returns: True, if the node is streamable.; False otherwise.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ IsWriteable()

bool peak::core::nodes::Node::IsWriteable ( ) const

inline

Returns whether the node is currently writeable.

Exceptions

IOException	A communication error has occurred, e.g. when the device is disconnected.
InternalErrorException	An internal error has occurred.

Since: 1.8.1

◆ Name()

std::string peak::core::nodes::Node::Name ( ) const

inline

Returns the name.

Returns: Name

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Namespace()

NodeNamespace peak::core::nodes::Node::Namespace ( ) const

inline

Returns the namespace the node belongs to.

Returns: Namespace the node belongs to

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ operator=() [1/2]

Node & peak::core::nodes::Node::operator= ( const Node & other )

delete

◆ operator=() [2/2]

Node & peak::core::nodes::Node::operator= ( Node && other )

delete

◆ ParentNodeMap()

std::shared_ptr< peak::core::NodeMap > peak::core::nodes::Node::ParentNodeMap ( ) const

inline

Returns the parent node map.

Returns: Parent node map

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ PollingTime()

int64_t peak::core::nodes::Node::PollingTime ( ) const

inline

Returns the polling time.

See Node Caching and Polling Concepts.

Returns: Polling time in milliseconds

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ RegisterChangedCallback()

Node::ChangedCallbackHandle peak::core::nodes::Node::RegisterChangedCallback ( const ChangedCallback & callback )

inline

Registers a callback for signaling a change to the node.

This function registers a callback which gets called every time the node changes. Pass the callback handle returned by this function to UnregisterChangedCallback() to unregister the callback.

Parameters

[in] callback The callback to call if the node has changed.

Returns: Callback handle

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ SelectedNodes()

std::vector< std::shared_ptr< Node > > peak::core::nodes::Node::SelectedNodes ( ) const

inline

Returns the selected nodes.

Returns: Selected nodes

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ SelectingNodes()

std::vector< std::shared_ptr< Node > > peak::core::nodes::Node::SelectingNodes ( ) const

inline

Returns the selecting nodes.

Returns: Selecting nodes

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ ToolTip()

std::string peak::core::nodes::Node::ToolTip ( ) const

inline

Returns the tool tip.

Returns: Tool tip

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Type()

NodeType peak::core::nodes::Node::Type ( ) const

inline

Returns the type.

The returned type is necessary to know the type the node has to be casted to if you want to access the full functionality of the node.

Returns: Type

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ UnregisterChangedCallback()

void peak::core::nodes::Node::UnregisterChangedCallback ( Node::ChangedCallbackHandle callbackHandle )

inline

Unregisters a changed callback.

This function unregisters a changed callback by taking its handle.

Parameters

[in] callbackHandle The handle of the callback to unregister.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Visibility()

NodeVisibility peak::core::nodes::Node::Visibility ( ) const

inline

Returns the visibility.

Returns: Visibility

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

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

peak/node_map/peak_node.hpp

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ ChangedCallback

◆ ChangedCallbackHandle

Constructor & Destructor Documentation

◆ Node() [1/3]

◆ ~Node()

◆ Node() [2/3]

◆ Node() [3/3]

Member Function Documentation

◆ AccessStatus()

◆ CachingMode()

◆ Description()

◆ DisplayName()

◆ FindInvalidatedNode() [1/2]

◆ FindInvalidatedNode() [2/2]

◆ FindInvalidatingNode() [1/2]

◆ FindInvalidatingNode() [2/2]

◆ FindSelectedNode() [1/2]

◆ FindSelectedNode() [2/2]

◆ FindSelectingNode() [1/2]

◆ FindSelectingNode() [2/2]

◆ InvalidatedNodes()

◆ InvalidatingNodes()

◆ IsAccessStatusCacheable()

◆ IsAvailable()

◆ IsCacheable()

◆ IsDeprecated()

◆ IsFeature()

◆ IsImplemented()

◆ IsReadable()

◆ IsStreamable()

◆ IsWriteable()

◆ Name()

◆ Namespace()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ParentNodeMap()

◆ PollingTime()

◆ RegisterChangedCallback()

◆ SelectedNodes()

◆ SelectingNodes()

◆ ToolTip()

◆ Type()

◆ UnregisterChangedCallback()

◆ Visibility()