NodeMapEnumerator Class Reference

Lazy enumeration of node maps. More...

#include <cvb/genapi/node_map_enumerator.hpp>

Public Member Functions
	NodeMapEnumerator (NodeMapEnumerator &&other) noexcept
	Move constructor.
NodeMapEnumerator &	operator= (NodeMapEnumerator &&other) noexcept
	Move operator.
void *	Handle () const noexcept
	Classic API device handle.
std::vector< String >	Names () const
	Get the names of all available node maps.
NodeMapPtr	operator[] (const String &name) const
	Name based node map access.
NodeMapPtr	NodeMap (const String &name) const
	Name based node map access.

Static Public Member Functions
template<class T>
static NodeMapEnumerator	FromObject (const T &object)
	Create a node map enumerator for a given object.

Detailed Description

Lazy enumeration of node maps.

Lazy enumeration of node maps.

Enumerates node maps (lazy) that belong to a arbitrary object respectively it's handle on demand.

Attention

Access to this class is not thread safe.

Enumerates node maps (lazy) that belong to a arbitrary object respectively it's handle on demand.

Attention

Access to this class is not thread safe.

Constructor & Destructor Documentation

NodeMapEnumerator()

NodeMapEnumerator ( NodeMapEnumerator && other )

inlinenoexcept

Move constructor.

Parameters

[in]

other

The other object.

Exceptions

Does	not throw any exception.

Member Function Documentation

FromObject()

template<class T>

static NodeMapEnumerator FromObject ( const T & object )

inlinestatic

Create a node map enumerator for a given object.

Parameters

[in]

object

That has a handle.

Exceptions

Any	exception derived from std::exception including CvbException.

Attention

The node map enumerator shares the lifetime of the given object. In order to free resources held by the object the enumerator must also be destroyed. This method will only throw if sharing fails.

Handle()

void * Handle ( ) const

inlinenoexcept

Classic API device handle.

Returns

Classic API handle.

Exceptions

Does	not throw any exception.

It is normally not necessary to work with this handle.

Names()

std::vector< String > Names ( ) const

inline

Get the names of all available node maps.

Returns

A list of all node map names

Exceptions

Any	exception derived from std::exception including CvbException.

The list may be empty.

NodeMap()

NodeMapPtr NodeMap ( const String & name ) const

inline

Name based node map access.

Parameters

[in]

name

Name of the node map.

Returns

A pointer to the node map

Exceptions

Any	exception derived from std::exception including CvbException.

If the node map does not exists the access will throw.

operator=()

NodeMapEnumerator & operator= ( NodeMapEnumerator && other )

inlinenoexcept

Move operator.

Parameters

[in]

other

The other object.

Returns

The object

Exceptions

Does	not throw any exception.

operator[]()

NodeMapPtr operator[] ( const String & name ) const

inline

Name based node map access.

Parameters

[in]

name

Name of the node map.

Returns

A pointer to the node map

Exceptions

Any	exception derived from std::exception including CvbException.

If the node map does not exists the access will throw.