Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr Class Reference

Public Member Functions
	__init__ (self, filename=QUALITY_REGISTRY, encoding=UTF8)
	tostring (self)
	Formats the object and its contents to an XML string.
	fromstring (self, msg)
	Formats the object from an XML message string.
	save (self, filename)
	Writes an XML message to file.
	read (self, filename)
	Reads a message from XML file.
	add_plugin (self, name, module, cls)
	Adds a plugin to the registry.
	remove_plugin (self, name)
	Remove a plugin.
	has_plugin (self, name)
	Returns if this registry has the specified plugin.

Public Attributes
	filename = filename
	encoding = encoding
str	header = """<?xml version="1.0" encoding="%s"?>""" % encoding
	element = ET.fromstring(msg)

Member Function Documentation

add_plugin()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.add_plugin	(		self,
			name,
			module,
			cls )

Adds a plugin to the registry.

Parameters

name	- the presentation name of the plugin
module	- the module where the plugin class is defined
cls	- the plugin class, should be a subclass of rave_quality_plugin

fromstring()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.fromstring	(		self,
			msg )

Formats the object from an XML message string.

Parameters

msg	string XML representation of the message.

has_plugin()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.has_plugin	(		self,
			name )

Returns if this registry has the specified plugin.

Parameters

name	- the name of the plugin

Returns

True if the registry has the plugin otherwise False

read()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.read	(		self,
			filename )

Reads a message from XML file.

Parameters

filename

string of the XML file to read.

remove_plugin()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.remove_plugin	(		self,
			name )

Remove a plugin.

Parameters

name	- the name of the plugin to remove

save()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.save	(		self,
			filename )

Writes an XML message to file.

Parameters

filename

string of the file to write.

tostring()

Lib.rave_pgf_quality_registry_mgr.rave_pgf_quality_registry_mgr.tostring

(

self

)

Formats the object and its contents to an XML string.

Suggestion: add line breaks and indentation.

Returns

string XML representation of this message.

---

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

• /github/workspace/Lib/rave_pgf_quality_registry_mgr.py