NodeMap Class Reference

Contains all nodes of a device or module. More...

Inherits object.

Public Member Functions
None	add_node (self, str key, str kind)
	Adds the given to this node map. More...
bool	remove_node (self, str key)
	Removes the node from this node map either by key or the node itself. More...
cvb.gevserver.Node	try_get_node (self, str name)
	Tries to get the node from the node map. More...

Properties
	is_read_only = property
	bool: Gets whether this node map is read only. More...
	model_name = property
	str: Gets the name of the model, that the XML description is for. More...
	module_name = property
	str: Gets this node map's module name. More...
	nodes = property
	Dict[str, cvb.gevserver.Node]: Gets a dictionary that contains all nodes of this node map.
	transport_layer_namespace = property
	str: Gets the transport layer type of the device.
	vendor_name = property
	str: Gets the name of the vendor, who created the XML description. More...
	xml_file_schema_version = property
	cvb.GenApiVersion: Gets the XML schema version.
	xml_file_version = property
	cvb.GenApiVersion: Gets the XML version.

Detailed Description

Contains all nodes of a device or module.

Member Function Documentation

add_node()

None add_node	(		self,
		str	key,
		str	kind
	)

Adds the given to this node map.

Add a node either by 1) Node only, 2) Node key (name) and value (node) or 3) Node key, value and kind specified in node list. The key will be the full node.name.

Parameters

key : str Key of the node to add. This will be the full name of the node including namespace.

kind : str Kind of node to add.

remove_node()

bool remove_node	(		self,
		str	key
	)

Removes the node from this node map either by key or the node itself.

Parameters

key : str Key of the node to add. This will be the full name of the node including namespace.

Returns

bool True if has been removed; False if node is not present in this node map.

try_get_node()

cvb.gevserver.Node try_get_node	(		self,
		str	name
	)

Tries to get the node from the node map.

Parameters

name : str Name of the node to try to get.

Returns

cvb.gevserver.Node Node retrieved by name. Empty shell if node is not available.

Property Documentation

is_read_only

is_read_only = property

static

bool: Gets whether this node map is read only.

Read only when the server is not in the cvb.gevserver.State.Configuration gevserver.State.

model_name

model_name = property

static

str: Gets the name of the model, that the XML description is for.

Often this name does not match the information of the GenTL port (discovery information).

module_name

module_name = property

static

str: Gets this node map's module name.

This is the device node map.

vendor_name

vendor_name = property

static

str: Gets the name of the vendor, who created the XML description.

Often this name does not match the information of the GenTL port (discovery information).