CommandNode Class Reference

A node that can be executed. More...

#include <cvb/gevserver/command_node.hpp>

Inherits ValueNode.

Public Member Functions
GenApi::AccessMode	AccessMode () const override
	Gets the access mode by querying all ValueConfigs for it. More...
GenApi::CacheMode	CacheMode () const override
	Gets the cache mode by querying all ValueConfigs for it. More...
bool	IsStreamable () const override
	Commands are never streamable.
bool	IsDone () const
	If this command is readable, the execution state can be queried.
void	Execute ()
	Executes this command.
template<class Rep , class Period >
std::chrono::duration< Rep, Period >	PollingTime () const
	Gets the polling time of this value. More...
template<class Rep , class Period >
void	SetPollingTime (const std::chrono::duration< Rep, Period > &timespan)
	Sets the polling time of this value. More...
template<class T >
T	CommandConfig () const
	Gets and sets the command value configuration of this command node. More...
template<class T >
void	SetCommandConfig (const T &)
	Sets the command value configuration of this command node. More...
template<class T >
T	ValueConfig () const
	Gets and sets the value configuration of this command node. More...
template<class T >
void	SetValueConfig (const T &)
	Sets the value configuration of this command node. More...
void	FromString (const String &value) override
	Executes if value is "true". More...
String	ToString () const override
	Gets the IsDone status as a string. More...
Public Member Functions inherited from ValueNode
virtual bool	IsStreamable () const
	Gets whether this node should be used when the camera settings are stored. More...
virtual void	SetIsStreamable (const std::int64_t &value)
	Sets whether this node should be used when the camera settings are stored. More...
template<class Rep , class Period >
std::chrono::duration< Rep, Period >	PollingTime () const
	Gets the polling time of this value. More...
virtual String	ToString () const
	Returns this node's value as a string representation. More...
virtual void	FromString (const String &value)
	Sets this node's value from the string value. More...
EventCookie	RegisterEventWrittenUpdated (std::function< void(ValueNode &)> handler)
	Register a listener to node written event. More...
void	UnregisterEventWrittenUpdated (EventCookie eventCookie) noexcept
	Manually unregister a listener to the node written event. More...
EventCookie	RegisterEventOnReadUpdated (std::function< void(ValueNode &)> handler)
	Register a listener to node on read event. More...
void	UnregisterEventOnReadUpdated (EventCookie eventCookie) noexcept
	Manually unregister a listener to the node on read event. More...
Public Member Functions inherited from Node
void	Add (const NodePtr &item, const NodeList &kind)
	Adds a Node item . More...
bool	Remove (const NodePtr &item, const NodeList &kind)
	Remove a single Node item from this collection. More...
void *	Handle () const noexcept
	Classic API node handle. More...
NodeMapPtr	NodeMap () const
	Gets the node map of this GevServer node.
String	ToolTip () const
	Gets the short descriptive text of this node. More...
void	SetToolTip (const String &value)
	Sets the short descriptive text of this node. More...
String	Description () const
	Gets the long descriptive text of this node. More...
void	SetDescription (const String &value)
	Sets the long descriptive text of this node. More...
virtual GenApi::AccessMode	AccessMode () const
	Gets the GenApi::AccessMode of this node.
Cvb::GenApi::AccessMode	ImposedAccessMode () const
	Gets the node's default AccessMode. More...
void	SetImposedAccessMode (const Cvb::GenApi::AccessMode &accessMode)
	Overrides the node's default AccessMode.
bool	IsImplemented () const
	Helper to check whether this node is implemented. More...
IntegerBaseNodePtr	IsImplementedConfig () const
	Gets the node that specifies whether a node is implemented in the device or not.
void	SetIsImplementedConfig (const IntegerBaseNodePtr &node)
	Sets the node that specifies whether a node is implemented in the device or not. More...
bool	IsAvailable () const
	Helper to check whether this node is available. More...
IntegerBaseNodePtr	IsAvailableConfig () const
	Gets the node that specifies whether a node is currently available or not. More...
void	SetIsAvailableConfig (const IntegerBaseNodePtr &node)
	Sets the node that specifies whether a node is currently available or not. More...
bool	IsReadable () const
	Helper to check whether this node is readable. More...
bool	IsWritable () const
	Helper to check whether this node is writable. More...
IntegerBaseNodePtr	IsLockedConfig () const
	Gets the node that specifies whether a node is currently read only or not. More...
void	SetIsLockedConfig (const IntegerBaseNodePtr &node)
	Sets the node that specifies whether a node is currently read only or not. More...
virtual Cvb::GenApi::CacheMode	CacheMode () const
	Gets the cache mode of this node. More...
Cvb::GenApi::Visibility	Visibility () const
	Gets the complexity level of this node. More...
void	SetVisibility (const Cvb::GenApi::Visibility &value)
	Gets the complexity level of this node. More...
NodePtr	AliasNode () const
	Gets the node that is an alias value for this node. More...
void	SetAliasNode (const NodePtr &value)
	Sets the node that is an alias value for this node. More...
String	Name () const
	Gets the full name of this node. More...
String	NameOnly () const
	Gets the name of this node without namespace. More...
GevServer::Namespace	Namespace () const
	Gets the namespace this node is in. 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
	Gets whether this node is considered a feature node. More...
bool	IsDeprecated () const
	Gets whether this node is considered deprecated. More...
String	DisplayName () const
	Gets the display name of this node. More...
void	SetDisplayName (const String &value)
	Sets the display name of 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...
template<class NodeT , class ValueConfigNodeType >
ValueNodePtr	GetTerminalRegisterNode (const NodeT *node, std::function< bool(Node *)> f) const
	Try to get terminal register node. More...

Static Public Member Functions
static CommandNodePtr	Create (const String &name, const GevServer::Namespace &nameSpace)
	Creates a new CommandNode with the given name and nameSpace . More...
static CommandNodePtr	Create (const String &name)
	Creates a new CommandNode with the given name . More...
Static Public Member Functions inherited from Node
static NodePtr	FromName (const NodeMapPtr &nodeMap, const String &name)
	Factory to create the appropriate Node object on the given nodeMap based on the given name . More...
template<class T , class... ARGS>
static std::shared_ptr< T >	FromHandle (HandleGuard< Node > &&guard, ARGS &&... args)
	Factory to create the appropriate Node object based on the given handle . More...

Additional Inherited Members
Protected Member Functions inherited from Node
template<class T >
std::vector< std::shared_ptr< T > >	GetDependentNodes (const NodeList &type) const
	Gets the nodes categorized by this node. More...
Static Protected Member Functions inherited from Node
static String	EnsureNodeNameOnly (const String &name)
	Throws if the given name has a namespace prefix. More...
static NodePtr	FromHandle (HandleGuard< Node > &&guard, const NodeMapPtr &nodeMap)
	Factory to create the appropriate Node object based on the given handle . More...
static GevServer::Namespace	ParseNamespace (const String &name)
	Gets the Namespace from the given name . More...
static String	ParseName (const String &name)
	Gets the name part of the given node name . More...
static GevServer::NodeType	NodeType (void *handle)
	Gets the node type from the nodes native handle. More...

Detailed Description

A node that can be executed.

Member Function Documentation

AccessMode()

GenApi::AccessMode AccessMode ( ) const

inlineoverridevirtual

Gets the access mode by querying all ValueConfigs for it.

Returns

The effective access mode.

Reimplemented from Node.

CacheMode()

GenApi::CacheMode CacheMode ( ) const

inlineoverridevirtual

Gets the cache mode by querying all ValueConfigs for it.

Returns

The effective cache mode.

Reimplemented from Node.

CommandConfig()

T CommandConfig ( ) const

inline

Gets and sets the command value configuration of this command node.

This defines whether this command stores the command value or the value is referenced to another node.

Create() [1/2]

static CommandNodePtr Create ( const String &  name )

inlinestatic

Creates a new CommandNode with the given name .

If the name does not contain a namespace prefix the Namespace::Custom is used.

You must add this node to a NodeMap before most operations are possible!

Parameters

name	Name with optional namespace prefix.

Create() [2/2]

static CommandNodePtr Create ( const String &  name, const GevServer::Namespace &  nameSpace  )

inlinestatic

Creates a new CommandNode with the given name and nameSpace .

You must add this node to a NodeMap before most operations are possible!

Parameters

name	Node name without namespace prefix.
nameSpace	Namespace to place the node in.

FromString()

void FromString ( const String &  value )

inlineoverridevirtual

Executes if value is "true".

Parameters

value

"true" to execute.

Reimplemented from ValueNode.

PollingTime()

std::chrono::duration< Rep, Period > PollingTime ( ) const

inline

Gets the polling time of this value.

If this node is not intended to be polled TimeSpan.Zero is used.

SetCommandConfig()

void SetCommandConfig ( const T &  )

inline

Sets the command value configuration of this command node.

This defines whether this command stores the command value or the value is referenced to another node.

Set operation is only possible as long as the GevServer is in GevServer::State::Configuration GevServer::State.

SetPollingTime()

void SetPollingTime ( const std::chrono::duration< Rep, Period > &  timespan )

inline

Sets the polling time of this value.

If this node is not intended to be polled TimeSpan.Zero is used.

SetValueConfig()

void SetValueConfig ( const T &  )

inline

Sets the value configuration of this command node.

This defines whether this command stores the value or the value is referenced to another node.

Set operation is only possible as long as the GevServer is in GevServer::State::Configuration GevServer::State.

ToString()

String ToString ( ) const

inlineoverridevirtual

Gets the IsDone status as a string.

Returns

"true" if is done.

Reimplemented from ValueNode.

ValueConfig()

T ValueConfig ( ) const

inline

Gets and sets the value configuration of this command node.

This defines whether this command stores the value or the value is referenced to another node.