CVB++ 14.0
EnumerationNode Class Reference

A node that presents a choice of values. More...

#include <cvb/genapi/enumeration_node.hpp>

Inherits SelectorNode.

Public Member Functions

String Value () const
 Gets the symbolic value of this enumeration. More...
 
void SetValue (const String &value)
 Sets the symbolic value of this enumeration. More...
 
std::vector< EnumEntryNodePtrEntries () const
 Gets all enum entries of this enumeration. More...
 
- Public Member Functions inherited from SelectorNode
bool IsSelector () const
 Returns whether this node selects at least one other node. More...
 
std::vector< ValueNodePtrSelectedNodes () const
 Gets all nodes selected by this one. More...
 
- Public Member Functions inherited from ValueNode
void Invalidate ()
 Invalidates the values of this node. More...
 
bool IsStreamable () const
 Returns whether this node should be used when saving camera settings. More...
 
virtual String ToString () const
 Returns this node's value as a string representation. More...
 
virtual void FromString (const String &value)
 Sets the value of this node from the string value. More...
 
ReadWriteVerify VerifyMode () const
 Returns how the values in this node are verified. More...
 
void SetVerifyMode (ReadWriteVerify readWriteVerify)
 Sets how values are verified in this node. More...
 
std::chrono::milliseconds PollingTime () const
 Gets the polling time of this value. More...
 
- Public Member Functions inherited from Node
void * Handle () const noexcept
 Classic API node handle. More...
 
String Name () const
 Gets the full name of this node. More...
 
String DisplayName () const
 Gets the display name of this node. More...
 
String ToolTip () const
 Gets the short descriptive text of this node. More...
 
String Description () const
 Gets the long descriptive text of this node. More...
 
Cvb::GenApi::AccessMode AccessMode () const
 Gets the access mode of this node. More...
 
bool IsImplemented () const
 Helper to check whether this node is implemented. More...
 
bool IsAvailable () const
 Helper to check whether this node is available. More...
 
bool IsReadable () const
 Helper to check whether this node is readable. More...
 
bool IsWriteable () const
 Helper to check whether this node is writable. More...
 
Cvb::GenApi::CacheMode CacheMode () const
 Gets the cache mode of this node. More...
 
String EventID () const
 Nodes with an event identifier may become invalidated, if an event / message is delivered from the device. More...
 
bool IsFeature () const
 Returns whether this node is considered a feature node. More...
 
bool IsDeprecated () const
 Gets whether this node is considered deprecated. More...
 
Cvb::GenApi::Visibility Visibility () const
 Gets the complexity level of this node. More...
 
NodePtr AliasNode () const
 Gets the node, that is an alias value for this node. More...
 
EventCookie RegisterEventUpdated (std::function< void(Node &)> handler)
 Register a listener to node updated event. More...
 
void UnregisterEventUpdated (EventCookie eventCookie) noexcept
 Manually unregister a listener to the node updated event. More...
 
NodeMapPtr NodeMap () const noexcept
 Gets the node map this node resides in. More...
 

Detailed Description

A node that presents a choice of values.

Member Function Documentation

◆ Entries()

std::vector< EnumEntryNodePtr > Entries ( ) const
inline

Gets all enum entries of this enumeration.

Returns
Vector with all enum entries of this enumeration.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ SetValue()

void SetValue ( const String value)
inline

Sets the symbolic value of this enumeration.

Parameters
[in]valueThe symbolic value as string.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Value()

String Value ( ) const
inline

Gets the symbolic value of this enumeration.

Returns
The symbolic value as string.
Exceptions
Anyexception derived from std::exception including CvbException.