peak::core::nodes::StringNode Class Reference

Represents a GenAPI string node. More...

#include <peak/node_map/peak_string_node.hpp>

Inheritance diagram for peak::core::nodes::StringNode:

Public Types
using	NodeDataType = std::string
using	NodeHasRange = std::false_type
Public Types inherited from peak::core::nodes::Node
using	ChangedCallback = std::function<void(const std::shared_ptr<Node>& changedNode)>
using	ChangedCallbackHandle = ChangedCallback*

Public Member Functions
	StringNode ()=delete
	~StringNode () override=default
	StringNode (const StringNode &other)=delete
StringNode &	operator= (const StringNode &other)=delete
	StringNode (StringNode &&other)=delete
StringNode &	operator= (StringNode &&other)=delete
int64_t	MaximumLength () const
	Returns the maximum length.
std::string	Value (NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
	Returns the value.
void	SetValue (const std::string &value)
	Sets the given value.
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.
std::string	DisplayName () const
	Returns the display name.
NodeNamespace	Namespace () const
	Returns the namespace the node belongs to.
NodeVisibility	Visibility () const
	Returns the visibility.
NodeAccessStatus	AccessStatus () const
	Returns the access status.
bool	IsReadable () const
	Returns whether the node is currently readable.
bool	IsWriteable () const
	Returns whether the node is currently writeable.
bool	IsAvailable () const
	Returns whether the node is currently either readable or writeable.
bool	IsImplemented () const
	Returns whether the node is implemented.
bool	IsCacheable () const
	Checks whether the node is cacheable.
bool	IsAccessStatusCacheable () const
	Checks whether the node's access status is cacheable.
bool	IsStreamable () const
	Checks whether the node is streamable.
bool	IsDeprecated () const
	Checks whether the node is deprecated.
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".
NodeCachingMode	CachingMode () const
	Returns the caching mode.
int64_t	PollingTime () const
	Returns the polling time.
std::string	ToolTip () const
	Returns the tool tip.
std::string	Description () const
	Returns the description.
NodeType	Type () const
	Returns the type.
std::shared_ptr< NodeMap >	ParentNodeMap () const
	Returns the parent node map.
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>
std::shared_ptr< NodeType >	FindInvalidatedNode (const std::string &name) const
	Tries to find an invalidated node with the given name and type.
std::vector< std::shared_ptr< Node > >	InvalidatedNodes () const
	Returns the invalidated nodes.
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>
std::shared_ptr< NodeType >	FindInvalidatingNode (const std::string &name) const
	Tries to find an invalidating node with the given name and type.
std::vector< std::shared_ptr< Node > >	InvalidatingNodes () const
	Returns the invalidating nodes.
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>
std::shared_ptr< NodeType >	FindSelectedNode (const std::string &name) const
	Tries to find a selected node with the given name and type.
std::vector< std::shared_ptr< Node > >	SelectedNodes () const
	Returns the selected nodes.
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>
std::shared_ptr< NodeType >	FindSelectingNode (const std::string &name) const
	Tries to find a selecting node with the given name and type.
std::vector< std::shared_ptr< Node > >	SelectingNodes () const
	Returns the selecting nodes.
ChangedCallbackHandle	RegisterChangedCallback (const ChangedCallback &callback)
	Registers a callback for signaling a change to the node.
void	UnregisterChangedCallback (ChangedCallbackHandle callbackHandle)
	Unregisters a changed callback.

Static Public Attributes
static constexpr auto	NodeType = nodes::NodeType::String

Detailed Description

Represents a GenAPI string node.

Member Typedef Documentation

NodeDataType

using peak::core::nodes::StringNode::NodeDataType = std::string

NodeHasRange

using peak::core::nodes::StringNode::NodeHasRange = std::false_type

Constructor & Destructor Documentation

StringNode() [1/3]

peak::core::nodes::StringNode::StringNode ( )

delete

~StringNode()

peak::core::nodes::StringNode::~StringNode ( )

overridedefault

StringNode() [2/3]

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

delete

StringNode() [3/3]

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

delete

Member Function Documentation

MaximumLength()

int64_t peak::core::nodes::StringNode::MaximumLength ( ) const

inline

Returns the maximum length.

Returns

Maximum length

Since

1.0

Exceptions

InternalErrorException

An internal error has occurred.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

SetValue()

void peak::core::nodes::StringNode::SetValue ( const std::string & value )

inline

Sets the given value.

Parameters

[in]

value

The value to set.

Since

1.0

Exceptions

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

Value()

std::string peak::core::nodes::StringNode::Value ( NodeCacheUsePolicy cacheUsePolicy = NodeCacheUsePolicy::UseCache ) const

inline

Returns the value.

Parameters

[in]

cacheUsePolicy

A flag telling whether the value should be read using the internal cache.

Returns

Value

Since

1.0

Exceptions

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

Member Data Documentation

NodeType

auto peak::core::nodes::StringNode::NodeType = nodes::NodeType::String

staticconstexpr

---

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

• peak/node_map/peak_string_node.hpp