Contains all nodes of the GevServer. More...
#include <cvb/gevserver/node_map.hpp>
Inherits enable_shared_from_this< NodeMap >.
Public Member Functions | |
void * | Handle () const noexcept |
Get the native handle of the server. More... | |
ServerPtr | Server () |
Get the shared pointer of the server. More... | |
std::map< String, NodePtr > | Nodes () const |
Get a dictionary containing all nodes of this node map. More... | |
void | AddNode (const String &key, const NodePtr &value) |
Adds the given value to this NodeMap. More... | |
void | AddNode (const String &key, const NodePtr &value, const NodeList &kind) |
Adds the given value to this NodeMap. More... | |
void | AddNode (const NodePtr &value) |
Adds the given value to this NodeMap. More... | |
bool | RemoveNode (const Node &node) |
Removes the node from this NodeMap. More... | |
bool | RemoveNode (const String &key) |
Removes a Node from this NodeMap by its key . More... | |
bool | IsReadOnly () const |
Gets whether this node map is read only. More... | |
String | ModelName () const |
Gets the model name of the Server. | |
String | ModuleName () const noexcept |
Gets this NodeMaps module name. More... | |
String | TransportLayerNamespace () const noexcept |
Gets this NodeMaps transport layer namespace. More... | |
String | VendorName () const noexcept |
Get the device vendor name of the Server. More... | |
GenApi::NodeMap::GenApiVersion | XmlFileSchemaVersion () const noexcept |
Gets the GenICam GenApi XML schema version this server creates. More... | |
GenApi::NodeMap::GenApiVersion | XmlFileVersion () const noexcept |
Gets the version of this server's GenApi XML description. More... | |
void | SetXmlFileVersion (const GenApi::NodeMap::GenApiVersion &genApiVersion) const |
Sets the version of this server's GenApi XML description. 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 |
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 from the node map. More... | |
Contains all nodes of the GevServer.
|
inline |
Adds the given value to this NodeMap.
key | Must be value .Node::Name. |
value | The Node to add. |
|
inlinenoexcept |
Get the native handle of the server.
Any | exception derived from std::exception including CvbException. |
|
inline |
Gets whether this node map is read only.
Read only when the Server is not in the GevServer::State::Configuration GevServer::State.
|
inlinenoexcept |
|
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" and lastly node name without namespace.
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 node type you may use typeid.
Get a dictionary containing all nodes of this node map.
Any | exception derived from std::exception including CvbException. |
|
inline |
|
inline |
Get the shared pointer of the server.
Any | exception derived from std::exception including CvbException. |
|
inline |
Sets the version of this server's GenApi XML description.
It is mandatory to increase the version information when you change anything about the GenApi XML description.
To distinguish between different GenApi XML feature sets use the GevServer::UserVersion property.
See GenApi::GenApiVersion for a description of the version components.
|
inlinenoexcept |
Gets this NodeMaps transport layer namespace.
This is always GEV.
|
inline |
Tries to 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."
Tries to get the node from the node map.
[in] | name | Name of the node to get. |
Does | not throw any exception. |
|
inlinenoexcept |
Get the device vendor name of the Server.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Gets the GenICam GenApi XML schema version this server creates.
Any | exception derived from std::exception including CvbException. |
|
inlinenoexcept |
Gets the version of this server's GenApi XML description.
It is mandatory to increase the version information when you change anything about the GenApi XML description.
To distinguish between different GenApi XML feature sets use the GevServer::UserVersion property.
See GenApi::GenApiVersion for a description of the version components.