opcua.common.xmlexporter.XmlExporter Class Reference

List of all members.

Public Member Functions
def	__init__
def	add_etree_datatype
def	add_etree_method
def	add_etree_object
def	add_etree_object_type
def	add_etree_reference_type
def	add_etree_variable
def	add_etree_variable_type
def	add_variable_common
def	build_etree
def	dump_etree
def	indent
def	member_to_etree
def	node_to_etree
def	value_to_etree
def	write_xml
Public Attributes
	aliases
	etree
	logger
	server
Private Member Functions
def	_add_alias_els
def	_add_idxs_from_uris
def	_add_namespace_uri_els
def	_add_namespaces
def	_add_node_common
def	_add_ref_els
def	_add_sub_el
def	_bname_to_string
def	_extobj_to_etree
def	_get_ns_idxs_of_nodes
def	_make_idx_dict
def	_node_to_string
def	_val_to_etree
def	_value_to_etree
Private Attributes
	_addr_idx_to_xml_idx

---

Detailed Description

Definition at line 15 of file xmlexporter.py.

---

Constructor & Destructor Documentation

def opcua.common.xmlexporter.XmlExporter.__init__	(		self,
			server
	)

Definition at line 17 of file xmlexporter.py.

---

Member Function Documentation

def opcua.common.xmlexporter.XmlExporter._add_alias_els

(

self

)

[private]

Definition at line 306 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_idxs_from_uris	(		self,
			idxs,
			uris,
			ns_array
	)		[private]

Definition at line 92 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_namespace_uri_els	(		self,
			uris
	)		[private]

Definition at line 298 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_namespaces	(		self,
			nodes,
			uris
	)		[private]

Definition at line 52 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_node_common	(		self,
			nodetype,
			node
	)		[private]

Definition at line 179 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_ref_els	(		self,
			parent_el,
			obj
	)		[private]

Definition at line 318 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._add_sub_el	(		self,
			el,
			name,
			text
	)		[private]

Definition at line 159 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._bname_to_string	(		self,
			bname
	)		[private]

Definition at line 173 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._extobj_to_etree	(		self,
			val_el,
			name,
			dtype,
			val
	)		[private]

Definition at line 400 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._get_ns_idxs_of_nodes	(		self,
			nodes
	)		[private]

get a list of all indexes used or references by nodes

Definition at line 77 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._make_idx_dict	(		self,
			idxs,
			ns_array
	)		[private]

Definition at line 68 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._node_to_string	(		self,
			nodeid
	)		[private]

Definition at line 164 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._val_to_etree	(		self,
			el,
			dtype,
			val
	)		[private]

Definition at line 345 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter._value_to_etree	(		self,
			el,
			type_name,
			dtype,
			val
	)		[private]

Definition at line 371 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_datatype	(		self,
			obj
	)

Add a UA data type element to the XML etree

Definition at line 291 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_method	(		self,
			node
	)

Definition at line 273 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_object	(		self,
			node
	)

Add a UA object element to the XML etree

Definition at line 198 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_object_type	(		self,
			node
	)

Add a UA object type element to the XML etree

Definition at line 208 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_reference_type	(		self,
			obj
	)

Definition at line 284 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_variable	(		self,
			node
	)

Add a UA variable element to the XML etree

Definition at line 234 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_etree_variable_type	(		self,
			node
	)

Add a UA variable type element to the XML etree

Definition at line 259 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.add_variable_common	(		self,
			node,
			el
	)

Definition at line 218 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.build_etree	(		self,
			node_list,
			uris = None
	)

Create an XML etree object from a list of nodes; custom namespace uris are optional
Namespaces used by nodes are always exported for consistency.
Args:
    node_list: list of Node objects for export
    uris: list of namespace uri strings

Returns:

Definition at line 31 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.dump_etree

(

self

)

Dump etree to console for debugging
Returns:

Definition at line 124 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.indent	(		self,
			elem,
			level = 0
	)

copy and paste from http://effbot.org/zone/element-lib.htm#prettyprint
it basically walks your tree and adds spaces and newlines so the tree is
printed in a nice way

Definition at line 411 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.member_to_etree	(		self,
			el,
			name,
			dtype,
			val
	)

Definition at line 336 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.node_to_etree	(		self,
			node
	)

Add the necessary XML sub elements to the etree for exporting the node
Args:
    node: Node object which will be added to XML etree

Returns:

Definition at line 132 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.value_to_etree	(		self,
			el,
			dtype_name,
			dtype,
			node
	)

Definition at line 364 of file xmlexporter.py.

def opcua.common.xmlexporter.XmlExporter.write_xml	(		self,
			xmlpath,
			pretty = True
	)

Write the XML etree in the exporter object to a file
Args:
    xmlpath: string representing the path/file name

Returns:

Definition at line 100 of file xmlexporter.py.

---

Member Data Documentation

opcua::common::xmlexporter.XmlExporter::_addr_idx_to_xml_idx [private]

Definition at line 17 of file xmlexporter.py.

opcua::common::xmlexporter.XmlExporter::aliases

Definition at line 17 of file xmlexporter.py.

opcua::common::xmlexporter.XmlExporter::etree

Definition at line 17 of file xmlexporter.py.

opcua::common::xmlexporter.XmlExporter::logger

Definition at line 17 of file xmlexporter.py.

opcua::common::xmlexporter.XmlExporter::server

Definition at line 17 of file xmlexporter.py.

---

The documentation for this class was generated from the following file:

• xmlexporter.py