Represents a GenAPI register node. More...

#include <peak/node_map/peak_register_node.hpp>

Inheritance diagram for peak::core::nodes::RegisterNode:

Public Member Functions
	RegisterNode ()=delete

	~RegisterNode () override=default

	RegisterNode (const RegisterNode &other)=delete

RegisterNode &	operator= (const RegisterNode &other)=delete

	RegisterNode (RegisterNode &&other)=delete

RegisterNode &	operator= (RegisterNode &&other)=delete

uint64_t	Address () const
	Returns the address. More...

size_t	Length () const
	Returns the length. More...

std::vector< uint8_t >	Read (size_t numBytes, NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
	Reads a given amount of bytes. More...

void	Write (const std::vector< uint8_t > &bytes)
	Writes a given amount of bytes. More...

Public Member Functions inherited from peak::core::nodes::Node
	Node ()=delete

virtual	~Node ()

	Node (const Node &other)=delete

Node &	operator= (const Node &other)=delete

	Node (Node &&other)=delete

Node &	operator= (Node &&other)=delete

std::string	Name () const
	Returns the name. More...

std::string	DisplayName () const
	Returns the display name. More...

NodeNamespace	Namespace () const
	Returns the namespace the node belongs to. More...

NodeVisibility	Visibility () const
	Returns the visibility. More...

NodeAccessStatus	AccessStatus () const
	Returns the access status. More...

bool	IsCacheable () const
	Checks whether the node is cacheable. More...

bool	IsAccessStatusCacheable () const
	Checks whether the node's access status is cacheable. More...

bool	IsStreamable () const
	Checks whether the node is streamable. More...

bool	IsDeprecated () const
	Checks whether the node is deprecated. More...

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". More...

NodeCachingMode	CachingMode () const
	Returns the caching mode. More...

int64_t	PollingTime () const
	Returns the polling time. More...

std::string	ToolTip () const
	Returns the tool tip. More...

std::string	Description () const
	Returns the description. More...

NodeType	Type () const
	Returns the type. More...

std::shared_ptr< NodeMap >	ParentNodeMap () const
	Returns the parent node map. More...

std::shared_ptr< Node >	FindInvalidatedNode (const std::string &name) const
	Tries to find an invalidated node with the given name. More...

template<class NodeType , typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
std::shared_ptr< NodeType >	FindInvalidatedNode (const std::string &name) const
	Tries to find an invalidated node with the given name and type. More...

std::vector< std::shared_ptr< Node > >	InvalidatedNodes () const
	Returns the invalidated nodes. More...

std::shared_ptr< Node >	FindInvalidatingNode (const std::string &name) const
	Tries to find an invalidating node with the given name. More...

template<class NodeType , typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
std::shared_ptr< NodeType >	FindInvalidatingNode (const std::string &name) const
	Tries to find an invalidating node with the given name and type. More...

std::vector< std::shared_ptr< Node > >	InvalidatingNodes () const
	Returns the invalidating nodes. More...

std::shared_ptr< Node >	FindSelectedNode (const std::string &name) const
	Tries to find a selected node with the given name. More...

template<class NodeType , typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
std::shared_ptr< NodeType >	FindSelectedNode (const std::string &name) const
	Tries to find a selected node with the given name and type. More...

std::vector< std::shared_ptr< Node > >	SelectedNodes () const
	Returns the selected nodes. More...

std::shared_ptr< Node >	FindSelectingNode (const std::string &name) const
	Tries to find a selecting node with the given name. More...

template<class NodeType , typename std::enable_if< std::is_base_of< Node, NodeType >::value, int >::type = 0>
std::shared_ptr< NodeType >	FindSelectingNode (const std::string &name) const
	Tries to find a selecting node with the given name and type. More...

std::vector< std::shared_ptr< Node > >	SelectingNodes () const
	Returns the selecting nodes. More...

ChangedCallbackHandle	RegisterChangedCallback (const ChangedCallback &callback)
	Registers a callback for signaling a change to the node. More...

void	UnregisterChangedCallback (ChangedCallbackHandle callbackHandle)
	Unregisters a changed callback. More...

Additional Inherited Members
Public Types inherited from peak::core::nodes::Node
using	ChangedCallback = std::function< void(const std::shared_ptr< Node > &changedNode)>

using	ChangedCallbackHandle = ChangedCallback *

Detailed Description

Represents a GenAPI register node.

Constructor & Destructor Documentation

◆ RegisterNode() [1/3]

peak::core::nodes::RegisterNode::RegisterNode ( )

delete

◆ ~RegisterNode()

peak::core::nodes::RegisterNode::~RegisterNode ( )

overridedefault

◆ RegisterNode() [2/3]

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

delete

◆ RegisterNode() [3/3]

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

delete

Member Function Documentation

◆ Address()

uint64_t peak::core::nodes::RegisterNode::Address ( ) const

inline

Returns the address.

Returns: Address

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Length()

size_t peak::core::nodes::RegisterNode::Length ( ) const

inline

Returns the length.

Returns: Length

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ Read()

std::vector< uint8_t > peak::core::nodes::RegisterNode::Read	(	size_t	numBytes,
		NodeCacheUsePolicy	cacheUsePolicy = `NodeCacheUsePolicy::UseCache`
	)		const

inline

Reads a given amount of bytes.

Parameters

[in]	numBytes	The amount of bytes to read.
[in]	cacheUsePolicy	A flag telling whether the value should be read using the internal cache.

Returns: Read bytes

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Write()

void peak::core::nodes::RegisterNode::Write ( const std::vector< uint8_t > & bytes )

inline

Writes a given amount of bytes.

Parameters

[in] bytes The bytes to write.

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_register_node.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RegisterNode() [1/3]

◆ ~RegisterNode()

◆ RegisterNode() [2/3]

◆ RegisterNode() [3/3]

Member Function Documentation

◆ Address()

◆ Length()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Read()

◆ Write()