Node that logically groups other nodes. More...

#include <cvb/gevserver/category_node.hpp>

Public Member Functions
void	FromString (const String &value) override
	Not supported.

String	ToString () const override
	Gets the value of the alias node, if any is present. Empty string otherwise.

GenApi::AccessMode	AccessMode () const noexcept override
	Categories are always read only.

Cvb::GenApi::CacheMode	CacheMode () const noexcept override
	Nothing to cache here.

template<class Rep, class Period>
std::chrono::duration< Rep, Period >	PollingTime () const noexcept
	Nothing to poll.

bool	IsStreamable () const override
	Categories are never streamable.

void	SetIsStreamable (const std::int64_t &) override
	Sets whether this node should be used when the camera settings are stored.

std::vector< NodePtr >	Nodes () const
	Gets the nodes categorized by this node.

Public Member Functions inherited from ValueNode
template<class Rep, class Period>
std::chrono::duration< Rep, Period >	PollingTime () const
	Gets the polling time of this value.

EventCookie	RegisterEventWrittenUpdated (std::function< void(ValueNode &)> handler)
	Register a listener to node written event.

void	UnregisterEventWrittenUpdated (EventCookie eventCookie) noexcept
	Manually unregister a listener to the node written event.

EventCookie	RegisterEventOnReadUpdated (std::function< void(ValueNode &)> handler)
	Register a listener to node on read event.

void	UnregisterEventOnReadUpdated (EventCookie eventCookie) noexcept
	Manually unregister a listener to the node on read event.

Public Member Functions inherited from Node
void	Add (const NodePtr &item, const NodeList &kind)
	Adds a Node item .

bool	Remove (const NodePtr &item, const NodeList &kind)
	Remove a single Node item from this collection.

void *	Handle () const noexcept
	Classic API node handle.

NodeMapPtr	NodeMap () const
	Gets the node map of this GevServer node.

String	ToolTip () const
	Gets the short descriptive text of this node.

void	SetToolTip (const String &value)
	Sets the short descriptive text of this node.

String	Description () const
	Gets the long descriptive text of this node.

void	SetDescription (const String &value)
	Sets the long descriptive text of this node.

Cvb::GenApi::AccessMode	ImposedAccessMode () const
	Gets the node's default AccessMode.

void	SetImposedAccessMode (const Cvb::GenApi::AccessMode &accessMode)
	Overrides the node's default AccessMode.

bool	IsImplemented () const
	Helper to check whether this node is implemented.

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.

bool	IsAvailable () const
	Helper to check whether this node is available.

IntegerBaseNodePtr	IsAvailableConfig () const
	Gets the node that specifies whether a node is currently available or not.

void	SetIsAvailableConfig (const IntegerBaseNodePtr &node)
	Sets the node that specifies whether a node is currently available or not.

bool	IsReadable () const
	Helper to check whether this node is readable.

bool	IsWritable () const
	Helper to check whether this node is writable.

IntegerBaseNodePtr	IsLockedConfig () const
	Gets the node that specifies whether a node is currently read only or not.

void	SetIsLockedConfig (const IntegerBaseNodePtr &node)
	Sets the node that specifies whether a node is currently read only or not.

Cvb::GenApi::Visibility	Visibility () const
	Gets the complexity level of this node.

void	SetVisibility (const Cvb::GenApi::Visibility &value)
	Gets the complexity level of this node.

NodePtr	AliasNode () const
	Gets the node that is an alias value for this node.

void	SetAliasNode (const NodePtr &value)
	Sets the node that is an alias value for this node.

String	Name () const
	Gets the full name of this node.

String	NameOnly () const
	Gets the name of this node without namespace.

GevServer::Namespace	Namespace () const
	Gets the namespace this node is in.

String	EventID () const
	Nodes with an event identifier may become invalidated if an event/message is delivered from the device.

bool	IsFeature () const
	Gets whether this node is considered a feature node.

bool	IsDeprecated () const
	Gets whether this node is considered deprecated.

String	DisplayName () const
	Gets the display name of this node.

void	SetDisplayName (const String &value)
	Sets the display name of 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.

template<class NodeT, class ValueConfigNodeType>
ValueNodePtr	GetTerminalRegisterNode (const NodeT node, std::function< bool(Node )> f) const
	Try to get terminal register node.

Static Public Member Functions
static CategoryNodePtr	Create (const String &name, const GevServer::Namespace &nameSpace)
	Creates a new CategoryNode with the given name and nameSpace .

static CategoryNodePtr	Create (const String &name)
	Creates a new CategoryNode with the given name .

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 .

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 .

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.

Static Protected Member Functions inherited from Node
static String	EnsureNodeNameOnly (const String &name)
	Throws if the given name has a namespace prefix.

static NodePtr	FromHandle (HandleGuard< Node > &&guard, const NodeMapPtr &nodeMap)
	Factory to create the appropriate Node object based on the given handle .

static GevServer::Namespace	ParseNamespace (const String &name)
	Gets the Namespace from the given name .

static String	ParseName (const String &name)
	Gets the name part of the given node name .

static GevServer::NodeType	NodeType (void *handle)
	Gets the node type from the nodes native handle.

Detailed Description

Node that logically groups other nodes.

Member Function Documentation

◆ AccessMode()

GenApi::AccessMode AccessMode ( ) const

inlineoverridevirtualnoexcept

Categories are always read only.

Returns: AccessMode::ReadOnly

Reimplemented from Node.

◆ CacheMode()

Cvb::GenApi::CacheMode CacheMode ( ) const

inlineoverridevirtualnoexcept

Nothing to cache here.

Returns: CacheMode::NoCache

Reimplemented from Node.

◆ Create() [1/2]

static CategoryNodePtr Create ( const String & name )

inlinestatic

Creates a new CategoryNode 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 CategoryNodePtr Create	(	const String &	name,
		const GevServer::Namespace &	nameSpace )

inlinestatic

Creates a new CategoryNode 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

Not supported.

Parameters

[in] value Ignored.

Exceptions

Does	not throw any exception.

Reimplemented from ValueNode.

◆ Nodes()

std::vector< NodePtr > Nodes ( ) const

inline

Gets the nodes categorized by this node.

Returns: Vector with all categorized nodes.

Exceptions

Does	not throw any exception.

◆ PollingTime()

template<class Rep, class Period>

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

inlinenoexcept

Nothing to poll.

Returns: std::chrono::milliseconds::zero()

Exceptions

Any	exception derived from std::exception including CvbException.

◆ SetIsStreamable()

void SetIsStreamable ( const std::int64_t & value )

inlineoverridevirtual

Sets whether this node should be used when the camera settings are stored.

Exceptions

Any	exception derived from std::exception including CvbException.

Reimplemented from ValueNode.

◆ ToString()

String ToString ( ) const

inlineoverridevirtual

Gets the value of the alias node, if any is present. Empty string otherwise.

Returns: Alias value or empty string.

Reimplemented from ValueNode.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AccessMode()

◆ CacheMode()

◆ Create() [1/2]

◆ Create() [2/2]

◆ FromString()

◆ Nodes()

◆ PollingTime()

◆ SetIsStreamable()

◆ ToString()