IDS peak genericC++ v1.17.0
Loading...
Searching...
No Matches
peak::core::nodes::EnumerationEntryNode Class Reference
IDS peak genericAPI » C++ » Device Control » Node

Represents a GenAPI enumeration entry node. More...

#include <peak/node_map/peak_enumeration_entry_node.hpp>

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

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

 EnumerationEntryNode ()=delete
 ~EnumerationEntryNode () override=default
 EnumerationEntryNode (const EnumerationEntryNode &other)=delete
EnumerationEntryNode & operator= (const EnumerationEntryNode &other)=delete
 EnumerationEntryNode (EnumerationEntryNode &&other)=delete
EnumerationEntryNode & operator= (EnumerationEntryNode &&other)=delete
PEAK_COMMON_NO_DISCARD bool IsSelfClearing () const
 Checks whether the node is self clearing.
PEAK_COMMON_NO_DISCARD std::string SymbolicValue () const
 Returns the symbolic value (i.e. name/string value) of the enum entry.
PEAK_COMMON_NO_DISCARD std::string StringValue () const
 Returns the symbolic value (i.e. name/string value) of the enum entry.
PEAK_COMMON_NO_DISCARD int64_t Value () const
 Returns the numeric value of the enum entry.
PEAK_COMMON_NO_DISCARD int64_t NumericValue () const
 Returns the numeric value of the enum entry.
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::EnumerationEntry

Detailed Description

Represents a GenAPI enumeration entry node.

Member Typedef Documentation

◆ NodeDataType

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

◆ NodeHasRange

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

Constructor & Destructor Documentation

◆ EnumerationEntryNode() [1/3]

peak::core::nodes::EnumerationEntryNode::EnumerationEntryNode ( )
delete

◆ ~EnumerationEntryNode()

peak::core::nodes::EnumerationEntryNode::~EnumerationEntryNode ( )
overridedefault

◆ EnumerationEntryNode() [2/3]

peak::core::nodes::EnumerationEntryNode::EnumerationEntryNode ( const EnumerationEntryNode & other)
delete

◆ EnumerationEntryNode() [3/3]

peak::core::nodes::EnumerationEntryNode::EnumerationEntryNode ( EnumerationEntryNode && other)
delete

Member Function Documentation

◆ IsSelfClearing()

bool peak::core::nodes::EnumerationEntryNode::IsSelfClearing ( ) const
inline

Checks whether the node is self clearing.

Returns
True, if the node is self clearing.
False otherwise.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ NumericValue()

PEAK_COMMON_NO_DISCARD int64_t peak::core::nodes::EnumerationEntryNode::NumericValue ( ) const
inline

Returns the numeric value of the enum entry.

Returns
Value.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ operator=() [1/2]

EnumerationEntryNode & peak::core::nodes::EnumerationEntryNode::operator= ( const EnumerationEntryNode & other)
delete

◆ operator=() [2/2]

EnumerationEntryNode & peak::core::nodes::EnumerationEntryNode::operator= ( EnumerationEntryNode && other)
delete

◆ StringValue()

PEAK_COMMON_NO_DISCARD std::string peak::core::nodes::EnumerationEntryNode::StringValue ( ) const
inline

Returns the symbolic value (i.e. name/string value) of the enum entry.

Returns
Symbolic value.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ SymbolicValue()

std::string peak::core::nodes::EnumerationEntryNode::SymbolicValue ( ) const
inline

Returns the symbolic value (i.e. name/string value) of the enum entry.

Returns
Symbolic value.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

◆ Value()

int64_t peak::core::nodes::EnumerationEntryNode::Value ( ) const
inline

Returns the numeric value of the enum entry.

Returns
Value.
Since
1.0
Exceptions
InternalErrorExceptionAn internal error has occurred.

Member Data Documentation

◆ NodeType

auto peak::core::nodes::EnumerationEntryNode::NodeType = nodes::NodeType::EnumerationEntry
staticconstexpr
The documentation for this class was generated from the following file: