Represents a GenAPI integer node. More...

#include <peak/node_map/peak_integer_node.hpp>

Inheritance diagram for peak::core::nodes::IntegerNode:

Public Types
using	NodeDataType = int64_t
using	NodeHasRange = std::true_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
	IntegerNode ()=delete
	~IntegerNode () override=default
	IntegerNode (const IntegerNode &other)=delete
IntegerNode &	operator= (const IntegerNode &other)=delete
	IntegerNode (IntegerNode &&other)=delete
IntegerNode &	operator= (IntegerNode &&other)=delete
PEAK_COMMON_NO_DISCARD int64_t	Minimum () const
	Returns the minimum.
PEAK_COMMON_NO_DISCARD int64_t	Maximum () const
	Returns the maximum.
PEAK_COMMON_NO_DISCARD int64_t	Increment () const
	Returns the increment.
PEAK_COMMON_NO_DISCARD NodeIncrementType	IncrementType () const
	Returns the increment type.
PEAK_COMMON_NO_DISCARD peak::common::Range64	Range () const
	Returns the range of value values for this node.
PEAK_COMMON_NO_DISCARD peak::common::Interval64	Interval () const
	Returns the interval of value values for this node.
PEAK_COMMON_NO_DISCARD std::vector< int64_t >	ValidValues () const
	Returns the valid values.
PEAK_COMMON_NO_DISCARD NodeRepresentation	Representation () const
	Returns the representation.
PEAK_COMMON_NO_DISCARD std::string	Unit () const
	Returns the unit.
PEAK_COMMON_NO_DISCARD int64_t	Value (NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
	Returns the value.
void	SetValue (int64_t 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
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.

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

Detailed Description

Represents a GenAPI integer node.

Member Typedef Documentation

◆ NodeDataType

using peak::core::nodes::IntegerNode::NodeDataType = int64_t

◆ NodeHasRange

using peak::core::nodes::IntegerNode::NodeHasRange = std::true_type

Constructor & Destructor Documentation

◆ IntegerNode() [1/3]

peak::core::nodes::IntegerNode::IntegerNode ( )

delete

◆ ~IntegerNode()

peak::core::nodes::IntegerNode::~IntegerNode ( )

overridedefault

◆ IntegerNode() [2/3]

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

delete

◆ IntegerNode() [3/3]

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

delete

Member Function Documentation

◆ Increment()

int64_t peak::core::nodes::IntegerNode::Increment ( ) const

inline

Returns the increment.

Returns: Increment

Since: 1.0

Exceptions

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

◆ IncrementType()

NodeIncrementType peak::core::nodes::IntegerNode::IncrementType ( ) const

inline

Returns the increment type.

Returns: Increment type

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Interval()

peak::common::Interval64 peak::core::nodes::IntegerNode::Interval ( ) const

inline

Returns the interval of value values for this node.

Returns: peak::common::Interval64 interval of values for this node.

Since: 1.17

Exceptions

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

◆ Maximum()

int64_t peak::core::nodes::IntegerNode::Maximum ( ) const

inline

Returns the maximum.

Returns: Maximum

Since: 1.0

Exceptions

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

◆ Minimum()

int64_t peak::core::nodes::IntegerNode::Minimum ( ) const

inline

Returns the minimum.

Returns: Minimum

Since: 1.0

Exceptions

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

◆ operator=() [1/2]

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

delete

◆ operator=() [2/2]

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

delete

◆ Range()

peak::common::Range64 peak::core::nodes::IntegerNode::Range ( ) const

inline

Returns the range of value values for this node.

Note: If this Node does not support a constant increment, the increment value is set to zero.

Returns: peak::common::Range64 range of values for this node.

Since: 1.17

Exceptions

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

◆ Representation()

NodeRepresentation peak::core::nodes::IntegerNode::Representation ( ) const

inline

Returns the representation.

Returns: Representation

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ SetValue()

void peak::core::nodes::IntegerNode::SetValue ( int64_t 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.

◆ Unit()

std::string peak::core::nodes::IntegerNode::Unit ( ) const

inline

Returns the unit.

Returns: Unit

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ ValidValues()

std::vector< int64_t > peak::core::nodes::IntegerNode::ValidValues ( ) const

inline

Returns the valid values.

This function returns a list of valid values. A numeric node can have a list of valid values if it does not have a constant increment.

Returns: Valid values

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Value()

int64_t peak::core::nodes::IntegerNode::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. See Node Caching and Polling Concepts.

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::IntegerNode::NodeType = nodes::NodeType::Integer

staticconstexpr

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

peak/node_map/peak_integer_node.hpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ NodeDataType

◆ NodeHasRange

Constructor & Destructor Documentation

◆ IntegerNode() [1/3]

◆ ~IntegerNode()

◆ IntegerNode() [2/3]

◆ IntegerNode() [3/3]

Member Function Documentation

◆ Increment()

◆ IncrementType()

◆ Interval()

◆ Maximum()

◆ Minimum()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Range()

◆ Representation()

◆ SetValue()

◆ Unit()

◆ ValidValues()

◆ Value()

Member Data Documentation

◆ NodeType