IntegerNode Class Reference

Represents a integer number. More...

#include <cvb/genapi/integer_node.hpp>

Inherits SelectorNode.

Inherited by IntRegNode.

Public Member Functions
std::int64_t	Value () const
	Gets the value of this integer node.
void	SetValue (std::int64_t value)
	Sets the value of this integer node.
std::int64_t	Min () const
	Gets the minimal allowed number for this value.
std::int64_t	Max () const
	Gets the maximal allowed number for this value.
std::int64_t	Increment () const
	Gets the increment of this value.
NumberRepresentation	Representation () const
	Gets how the value is to be represented.
String	Unit () const
	Gets the unit of this node's value.
Public Member Functions inherited from SelectorNode
bool	IsSelector () const
	Returns whether this node selects at least one other node.
std::vector< ValueNodePtr >	SelectedNodes () const
	Gets all nodes selected by this one.
Public Member Functions inherited from ValueNode
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

Represents a integer number.

Member Function Documentation

Increment()

std::int64_t Increment ( ) const

inline

Gets the increment of this value.

Returns

Step width.

Exceptions

Any	exception derived from std::exception including CvbException.

The node can take values that are multiples of this one.

Max()

std::int64_t Max ( ) const

inline

Gets the maximal allowed number for this value.

Returns

Maximal value.

Exceptions

Any	exception derived from std::exception including CvbException.

Min()

std::int64_t Min ( ) const

inline

Gets the minimal allowed number for this value.

Returns

Minimal value.

Exceptions

Any	exception derived from std::exception including CvbException.

Representation()

NumberRepresentation Representation ( ) const

inline

Gets how the value is to be represented.

Returns

Number representation.

Exceptions

Any	exception derived from std::exception including CvbException.

SetValue()

void SetValue ( std::int64_t value )

inline

Sets the value of this integer node.

Parameters

[in]

value

The new value.

Exceptions

Any	exception derived from std::exception including CvbException.

Unit()

String Unit ( ) const

inline

Gets the unit of this node's value.

Returns

Unit of this node as text.

Exceptions

Any	exception derived from std::exception including CvbException.

Value()

std::int64_t Value ( ) const

inline

Gets the value of this integer node.

Returns

The current value.

Exceptions

Any	exception derived from std::exception including CvbException.