IConfigurableNodeMap Interface Reference

An INodeMap that can be configured. More...

Inherits INodeMap, and IDictionary< string, IConfigurableNode >.

Inherited by NodeMap.

Public Member Functions
void	Add (IConfigurableNode node)
	Adds the given node to this NodeMap. More...
bool	Remove (IConfigurableNode node)
	Removes the node from this NodeMap. More...
Public Member Functions inherited from INodeMap
bool	TryGetValue< TNode > (string name, out TNode node)
	Tries to get the node with the given name . More...

Properties
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

An INodeMap that can be configured.

Member Function Documentation

Add()

void Add

(

IConfigurableNode

node

)

Adds the given node to this NodeMap.

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

Parameters

node	Node to add.

Remove()

bool Remove

(

IConfigurableNode

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.

Property Documentation

this[string name]

new IConfigurableNode this[string name]

getset

Indexer to retrieve or add a node with the given name from/to this node map.

Parameters

name	Name with or without the namespace prefix.

Returns

GenApi.Node instance.

Exceptions

ArgumentNullException	Thrown if name is null.
KeyNotFoundException	Thrown if name does not exist in this collection when getting a node.

Implements INodeMap.