INodeMap Interface Reference

Read-only dictionary holding all INodes of a device or module. More...

Inherits IDictionary< string, INode >.

Inherited by NodeMap, and IConfigurableNodeMap.

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

Properties
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

Read-only dictionary holding all INodes of a device or module.

Member Function Documentation

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.

Implemented in NodeMap, and NodeMap.

Type Constraints

TNode

:

INode

Property Documentation

ModelName

string ModelName

get

Gets the name of the model that the XML description is for.

Attention: often this name does not match the information of the GenTL port (discovery information).

Implemented in NodeMap, and NodeMap.

this[string name]

new INode this[string name]

get

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

Parameters

name	Name with or without the namespace prefix.

Returns

Node instance.

Exceptions

ArgumentNullException	Thrown if name is null.
KeyNotFoundException	Thrown if name does not exist in this collection.

Implemented in NodeMap, and IConfigurableNodeMap.

VendorName

string VendorName

get

Gets the name of the vendor who created the XML description.

Attention: often this name does not match the information of the GenTL port (discovery information).

Implemented in NodeMap, and NodeMap.