Represents a GenAPI float node. More...

#include <peak/node_map/peak_float_node.hpp>

Inheritance diagram for peak::core::nodes::FloatNode:

Public Types
using	NodeDataType = double
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
	FloatNode ()=delete
	~FloatNode () override=default
	FloatNode (const FloatNode &other)=delete
FloatNode &	operator= (const FloatNode &other)=delete
	FloatNode (FloatNode &&other)=delete
FloatNode &	operator= (FloatNode &&other)=delete
double	Minimum () const
	Returns the minimum.
double	Maximum () const
	Returns the maximum.
double	Increment () const
	Returns the increment.
NodeIncrementType	IncrementType () const
	Returns the increment type.
std::vector< double >	ValidValues () const
	Returns the valid values.
NodeRepresentation	Representation () const
	Returns the representation.
std::string	Unit () const
	Returns the unit.
NodeDisplayNotation	DisplayNotation () const
	Returns the display notation.
int64_t	DisplayPrecision () const
	Returns the display precision.
bool	HasConstantIncrement () const
	Checks whether the node has a constant increment.
double	Value (NodeCacheUsePolicy cacheUsePolicy=NodeCacheUsePolicy::UseCache) const
	Returns the value.
void	SetValue (double 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::Float

Detailed Description

Represents a GenAPI float node.

Member Typedef Documentation

◆ NodeDataType

using peak::core::nodes::FloatNode::NodeDataType = double

◆ NodeHasRange

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

Constructor & Destructor Documentation

◆ FloatNode() [1/3]

peak::core::nodes::FloatNode::FloatNode ( )

delete

◆ ~FloatNode()

peak::core::nodes::FloatNode::~FloatNode ( )

overridedefault

◆ FloatNode() [2/3]

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

delete

◆ FloatNode() [3/3]

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

delete

Member Function Documentation

◆ DisplayNotation()

NodeDisplayNotation peak::core::nodes::FloatNode::DisplayNotation ( ) const

inline

Returns the display notation.

Returns: Display notation

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ DisplayPrecision()

int64_t peak::core::nodes::FloatNode::DisplayPrecision ( ) const

inline

Returns the display precision.

Returns: Display precision

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ HasConstantIncrement()

bool peak::core::nodes::FloatNode::HasConstantIncrement ( ) const

inline

Checks whether the node has a constant increment.

Returns: True, if the node has a constant increment.; False otherwise.

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Increment()

double peak::core::nodes::FloatNode::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::FloatNode::IncrementType ( ) const

inline

Returns the increment type.

Returns: Increment type

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ Maximum()

double peak::core::nodes::FloatNode::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()

double peak::core::nodes::FloatNode::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]

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

delete

◆ operator=() [2/2]

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

delete

◆ Representation()

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

inline

Returns the representation.

Returns: Representation

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ SetValue()

void peak::core::nodes::FloatNode::SetValue ( double 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::FloatNode::Unit ( ) const

inline

Returns the unit.

Returns: Unit

Since: 1.0

Exceptions

InternalErrorException An internal error has occurred.

◆ ValidValues()

std::vector< double > peak::core::nodes::FloatNode::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()

double peak::core::nodes::FloatNode::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::FloatNode::NodeType = nodes::NodeType::Float

staticconstexpr

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

peak/node_map/peak_float_node.hpp

Public Types

Public Member Functions

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ NodeDataType

◆ NodeHasRange

Constructor & Destructor Documentation

◆ FloatNode() [1/3]

◆ ~FloatNode()

◆ FloatNode() [2/3]

◆ FloatNode() [3/3]

Member Function Documentation

◆ DisplayNotation()

◆ DisplayPrecision()

◆ HasConstantIncrement()

◆ Increment()

◆ IncrementType()

◆ Maximum()

◆ Minimum()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Representation()

◆ SetValue()

◆ Unit()

◆ ValidValues()

◆ Value()

Member Data Documentation

◆ NodeType