ValueNode Class Reference

Base class for all nodes, that have a value. More...

#include <cvb/genapi/value_node.hpp>

Inherits Node.

Inherited by BooleanNode, CategoryNode, CommandNode, EnumEntryNode, FloatNode, SelectorNode, and StringNode.

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

Detailed Description

Base class for all nodes, that have a value.

Member Function Documentation

FromString()

virtual void FromString ( const String & value )

inlinevirtual

Sets the value of this node from the string value.

Parameters

[in]

value

New value as a string.

Exceptions

Any	exception derived from std::exception including CvbException.

Invalidate()

void Invalidate ( )

inline

Invalidates the values of this node.

Exceptions

Any	exception derived from std::exception including CvbException.

Invalidate deletes all caches for all nodes on which this node depends (value, min, max, increment,...).

IsStreamable()

bool IsStreamable ( ) const

inline

Returns whether this node should be used when saving camera settings.

Returns

True if the node is streamable, otherwise false.

Exceptions

Any	exception derived from std::exception including CvbException.

PollingTime()

std::chrono::milliseconds PollingTime ( ) const

inline

Gets the polling time of this value.

Returns

std::chrono::milliseconds

Exceptions

Any	exception derived from std::exception including CvbException.

If this node is not intended to be polled, a zero time span is returned.

SetVerifyMode()

void SetVerifyMode ( ReadWriteVerify readWriteVerify )

inline

Sets how values are verified in this node.

Parameters

[in]

readWriteVerify

The new verify mode.

Exceptions

Any	exception derived from std::exception including CvbException.

ToString()

virtual String ToString ( ) const

inlinevirtual

Returns this node's value as a string representation.

Returns

Value as a string.

Exceptions

Any	exception derived from std::exception including CvbException.

VerifyMode()

ReadWriteVerify VerifyMode ( ) const

inline

Returns how the values in this node are verified.

Returns

The current verify mode.

Exceptions

Any	exception derived from std::exception including CvbException.