GevServer NodeMap. More...

Inherits NodeDictionaryBase< Node >, and IConfigurableNodeMap.

Public Member Functions
bool	TryGetValue< TNode > (string name, out TNode node)
	Tries to get the node with the given name . More...

void	Add (Node node)
	Adds the given node to this NodeMap. More...

bool	Remove (Node node)
	Removes the node from this NodeMap. More...

Public Member Functions inherited from NodeDictionaryBase< Node >
void	Dispose ()
	Disposes of this dictionary and all its nodes.

bool	ContainsKey (string key)
	Gets whether this dictionaries contains the given key . More...

bool	Remove (string key)
	Removes the node identified by the given key . More...

void	Add (IConfigurableNode node)
	Adds the given node to this NodeMap. More...

bool	Remove (IConfigurableNode node)
	Removes the node from this NodeMap. More...

bool	TryGetValue< TNode > (string name, out TNode node)
	Tries to get the node with the given name . More...

Protected Member Functions
override void	Dispose (bool disposing)
	Disposes of all Nodes if disposing . More...

override void	AddNode (string key, Node value)
	Adds the given value to this NodeMap. More...

override bool	RemoveNode (string key)
	Removes a Node from this NodeMap by its key . More...

Protected Member Functions inherited from NodeDictionaryBase< Node >
virtual void	Dispose (bool disposing)
	Dispose implementation. More...

abstract void	AddNode (string key, TNode value)
	Adds a new TNode value associated to the given key . More...

abstract bool	RemoveNode (string key)
	Removes the node at the given key . More...

TNode	GetNode (string key)
	Actual implementation for getting nodes. More...

bool	TryGetNode (string key, out TNode value)
	Tries to get the TNode value with the given key . More...

Properties
GevServer	Server `[get]`
	Gets the GevServer object this node map belongs to.

override bool	IsReadOnly `[get]`
	Gets whether this dictionary is read only. More...

string	ModelName `[get]`
	Gets the model name of the Server.

string	ModuleName `[get]`
	Gets this NodeMaps module name. More...

string	TransportLayerNamespace `[get]`
	Gets this NodeMaps transport layer namespace. More...

string	VendorName `[get]`
	Gets the device vendor name of the Server.

GenApiVersion	XmlFileSchemaVersion `[get]`
	Gets the GenICam GenApi schema version this Server creates.

GenApiVersion	XmlFileVersion `[get, set]`
	Gets or sets the version of this server's GenApi XML description. More...

Properties inherited from NodeDictionaryBase< Node >
bool	IsDisposed `[get]`
	Gets whether this dictionary has been disposed.

IDictionary< string, TNode >	Nodes `[get]`
	Gets the dictionary holding all node objects.

TNode	this[string key] `[get, set]`
	Indexer of this dictionary to get/add TNode objects. More...

int	Count `[get]`
	Gets the number of TNodes in this dictionary.

abstract bool	IsReadOnly `[get]`
	Gets whether this dictionary is read only.

ICollection< string >	Keys `[get]`
	Gets the keys for all nodes.

ICollection< TNode >	Values `[get]`
	Gets all the TNodes in this dictionary.

Properties inherited from IConfigurableNodeMap
new IConfigurableNode	this[string name] `[get, set]`
	Indexer to retrieve or add a node with the given name from/to this node map. More...

new GenApiVersion	XmlFileVersion `[get, set]`
	Gets or sets the XML version.

Properties inherited from INodeMap
new INode	this[string name] `[get]`
	Indexer to retrieve a node with the given name from this node map. More...

string	ModuleName `[get]`
	Gets the GenTL module name this node map refers to.

string	VendorName `[get]`
	Gets the name of the vendor who created the XML description. More...

string	ModelName `[get]`
	Gets the name of the model that the XML description is for. More...

string	TransportLayerNamespace `[get]`
	Gets the transport layer type of the device.

GenApiVersion	XmlFileVersion `[get]`
	Gets the XML version.

GenApiVersion	XmlFileSchemaVersion `[get]`
	Gets the XML schema version.

Detailed Description

GevServer NodeMap.

Member Function Documentation

◆ Add()

void Add ( Node node )

Adds the given node to this NodeMap.

The key will be the full node .Node.Name.

Parameters

node	Node to add.

◆ AddNode()

override void AddNode	(	string	key,
		Node	value
	)

protected

Adds the given value to this NodeMap.

Parameters

key	Must be value .Node.Name.
value	The Node to add.

◆ Dispose()

override void Dispose ( bool disposing )

protectedvirtual

Disposes of all Nodes if disposing .

Parameters

disposing true if called from IDisposable.Dispose; false if called from finalizer.

Reimplemented from NodeDictionaryBase< Node >.

◆ Remove()

bool Remove ( Node node )

Removes the node from this NodeMap.

Parameters

node	Node to remove.

Returns: true if node has been removed; false if not present in this NodeMap.

◆ RemoveNode()

override bool RemoveNode ( string key )

protectedvirtual

Removes a Node from this NodeMap by its key .

Parameters

key	Key to identify the Node to remove.

Returns: true if key has been removed; false if not present in this NodeMap.

Implements NodeDictionaryBase< Node >.

◆ TryGetValue< TNode >()

bool TryGetValue< TNode >	(	string	name,
		out TNode	node
	)

Tries to get the node with the given name .

Template Parameters

TNode Type of node to retrieve.

Parameters

name	Name with or without the namespace prefix.
node	Node instance; `null` if not found.

Returns: true if node with given name exists and is of type TNode.

Implements INodeMap.

Type Constraints

TNode

:

INode

Property Documentation

◆ IsReadOnly

override bool IsReadOnly

get

Gets whether this dictionary is read only.

Read only when the Server is not in the GevServerState.Configuration GevServer.State.

◆ ModuleName

string ModuleName

get

Gets this NodeMaps module name.

This is the Device NodeMap.

Implements INodeMap.

◆ TransportLayerNamespace

string TransportLayerNamespace

get

Gets this NodeMaps transport layer namespace.

This is always GEV.

Implements INodeMap.

◆ XmlFileVersion

GenApiVersion XmlFileVersion

getset

Gets or 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 GenApiVersion for a description of the version components.

Implements IConfigurableNodeMap.


Contact Legal Privacy Statement	Copyright © 2024.
	All rights reserved.

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Add()

◆ AddNode()

◆ Dispose()

◆ Remove()

◆ RemoveNode()

◆ TryGetValue< TNode >()

Property Documentation

◆ IsReadOnly

◆ ModuleName

◆ TransportLayerNamespace

◆ XmlFileVersion