Contains all nodes of a device or module. More...
#include <cvb/genapi/node_map.hpp>
Inherits enable_shared_from_this< NodeMap >.
Classes | |
class | GenApiVersion |
Version information for GenICam related objects. More... | |
Public Member Functions | |
void * | Handle () const noexcept |
Classic API node map handle. More... | |
String | Name () const noexcept |
Name used to access this node map. More... | |
String | Description () const noexcept |
Gets the descriptive text of this node map. More... | |
String | VendorName () const |
Gets the name of the vendor, who created the XML description. More... | |
String | ModelName () const |
Gets the name of the model, that the XML description is for. More... | |
String | TransportLayerNamespace () const |
Gets the transport layer type of the device. More... | |
String | ToolTip () const |
Gets the short descriptive text, if any is available. More... | |
GenApiVersion | XmlFileVersion () const |
Gets the XML version. More... | |
GenApiVersion | XmlFileSchemaVersion () const |
Gets the XML schema version. More... | |
void | PollNodes () |
Polls all nodes of this node map that have a polling time. More... | |
void | LoadSettings (const String &fileName) |
Loads the node values from the gcs file and sets the node values accordingly. More... | |
void | SaveSettings (const String &fileName) const |
Saves all nodes which are streamable. More... | |
template<class RANGE > | |
TypedRange< void, String, RANGE >::type | SaveSettings (const String &fileName, const RANGE &range) const |
Saves all nodes that are in a specific container. More... | |
template<class RANGE > | |
TypedRange< void, NodePtr, RANGE >::type | SaveSettings (const String &fileName, const RANGE &range) const |
Saves all nodes which are in a given container. More... | |
template<class... NAMES> | |
VarArgRange< void, constString &, NAMES... >::type | SaveSettings (const String &fileName, const NAMES &... names) const |
Saves all nodes which are in a given as argument. More... | |
template<class... NODES> | |
VarArgRange< void, constNode &, NODES... >::type | SaveSettings (const String &fileName, const NODES &... nodes) const |
Saves all nodes which are in a given as argument. More... | |
std::vector< String > | AvailableFiles () const |
Gets the currently available file identifiers, which can be downloaded or uploaded. More... | |
void | DownloadFile (const String &fileName, const String &fileSelectorEntryName) const |
Downloads a file from the camera via the GenApi file download. More... | |
std::vector< uint8_t > | DownloadFile (const String &fileSelectorEntryName) const |
Downloads a file from the camera into memory via the GenApi file download. More... | |
void | UploadFile (const String &fileName, const String &fileSelectorEntryName) |
Uploads a file to the camera via the GenApi file upload. More... | |
Cvb::String | ToJson (std::function< void(NodePtr, const std::string &)> serializationErrorCallback=nullptr) |
Serializes all nodes of this nodemap to a json string. More... | |
Cvb::String | ToJson (const std::vector< NodePtr > nodes, std::function< void(NodePtr, const std::string &)> serializationErrorCallback=nullptr) |
Serializes the given nodes to a json string. More... | |
template<class T > | |
std::shared_ptr< T > | Node (const String &name) const |
Get the node with the given name from the node map. More... | |
NodePtr | Node (const String &name) const |
Get the node with the given name from the node map. More... | |
template<class T > | |
std::shared_ptr< T > | TryGetNode (const String &name) const noexcept |
Tries to get the node with the given name from the node map. More... | |
NodePtr | TryGetNode (const String &name) const noexcept |
Tries to get the node with the given name from the node map. More... | |
std::map< String, NodePtr > | Nodes () const |
Get a dictionary contain all nodes of this node map. More... | |
Static Public Member Functions | |
static NodeMapPtr | FromHandle (HandleGuard< NodeMap > &&guard, const String &name, const Device &device) |
Creates a node map from a classic API handle. More... | |
static NodeMapPtr | FromHandle (HandleGuard< NodeMap > &&guard, const String &name, void *provider) |
Creates a node map from a classic API handle. More... | |
Contains all nodes of a device or module.
|
inline |
Gets the currently available file identifiers, which can be downloaded or uploaded.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Gets the descriptive text of this node map.
Does | not throw any exception. |
Downloads a file from the camera via the GenApi file download.
[in] | fileName | Complete path to the file in which the data is to be stored. |
[in] | fileSelectorEntryName | Symbolic name of the EnumerationNode identifying the file to download. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Downloads a file from the camera into memory via the GenApi file download.
[in] | fileSelectorEntryName | Symbolic name of the EnumerationNode identifying the file to download. |
Any | exception derived from std::exception including CvbException. |
|
inlinestatic |
Creates a node map from a classic API handle.
[in] | guard | Life time guard for C-API handle. |
[in] | name | Name of the node map. |
[in] | device | The device this node map belongs to. |
Any | exception derived from std::exception including CvbException. |
The node map takes ownership of the handle, so you must share it before using this function.
|
inlinestatic |
Creates a node map from a classic API handle.
[in] | guard | Life time guard for C-API handle. |
[in] | name | Name of the node map. |
[in] | provider | The raw handle the nodemap belongs to. |
Any | exception derived from std::exception including CvbException. |
The node map takes ownership of the handle, so you must share it before using this function.
|
inlinenoexcept |
Classic API node map handle.
Does | not throw any exception. |
It is normally not necessary to work with this handle.
|
inline |
Loads the node values from the gcs file and sets the node values accordingly.
[in] | fileName | The gcs file name. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the name of the model, that the XML description is for.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Name used to access this node map.
Does | not throw any exception. |
|
inline |
Get the node with the given name from the node map.
[in] | name | Name of the node. |
Any | exception derived from std::exception including CvbException. |
If a name without a namespace prefix is provided "Cust" is searched before "Std."
Get the node with the given name from the node map.
[in] | name | Name of the node. |
Any | exception derived from std::exception including CvbException. |
If a name without a namespace prefix is provided "Cust" is searched before "Std."
Usually you should prefer the template version to get the appropriate node type.
However, is some cases the actual node type might be unknown. In order to get the the node type you may use typeid.
Get a dictionary contain all nodes of this node map.
Any | exception derived from std::exception including CvbException. |
|
inline |
Polls all nodes of this node map that have a polling time.
Any | exception derived from std::exception including CvbException. |
|
inline |
Saves all nodes which are streamable.
[in] | fileName | Full path to gcs file to contain the settings. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Saves all nodes which are in a given as argument.
[in] | fileName | Complete path to gcs file that contains the settings. |
[in] | names | Names of the nodes to save. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Saves all nodes which are in a given as argument.
[in] | fileName | Complete path to gcs file that contains the settings. |
[in] | nodes | Nodes to save. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Saves all nodes that are in a specific container.
[in] | fileName | Complete path to gcs file that contains the settings. |
[in] | range | With node names as Strings. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Saves all nodes which are in a given container.
[in] | fileName | Complete path to gcs file that contains the settings. |
[in] | range | With nodes as pointers. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Serializes the given nodes to a json string.
[in] | nodes | The nodes to serialize. |
[in] | serializationErrorCallback | Callback to call when a node cannot be serialized. If this parameter is nullptr, an exception will be thrown when a node cannot be serialized. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Serializes all nodes of this nodemap to a json string.
[in] | serializationErrorCallback | Callback to call when a node cannot be serialized. If this parameter is nullptr, an exception will be thrown when a node cannot be serialized. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the short descriptive text, if any is available.
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the transport layer type of the device.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Tries to get the node with the given name from the node map.
[in] | name | Name of the node. |
Does | not throw any exception. |
If a name without a namespace prefix is provided "Cust" is searched before "Std."
Tries to get the node with the given name from the node map.
[in] | name | Name of the node. |
Does | not throw any exception. |
If a name without a namespace prefix is provided "Cust" is searched before "Std."
Uploads a file to the camera via the GenApi file upload.
[in] | fileName | Complete path to the file to store data to. |
[in] | fileSelectorEntryName | Symbolic name of the EnumerationNode identifying the file to upload. |
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the name of the vendor, who created the XML description.
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the XML schema version.
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets the XML version.
Any | exception derived from std::exception including CvbException. |