xmlmanipulators::projectXml Class Reference

projectXml() More...

List of all members.

Public Member Functions
def	__init__
	Constructor of xmlManipulator.
def	validateXML
	Validates opened XML file whether it matches given schema projectXml::pathToSchema.
def	getProjectXmlContent
	Function which reads project XML and returns all its stored content.
def	getProjectInfo
	Function which reads project XML and returns part of its stored content.
def	storeProjectXmlContent
	Function which stores given params into project XML.
Public Attributes
	window
	window Main Window of an application.
Static Public Attributes
tuple	pathToSchema = QString(sys.path[0] + "/GUI/schema/project.xsd")
	path where project XML schema is stored (used for validation)

---

Detailed Description

projectXml()

Class for project XML handling It stores / loads some necessary project related info into / form project XML file. It also contains validation function which check whether the given project XML file is valid.

Author:

Stepan Henek

---

Member Function Documentation

def xmlmanipulators::projectXml::__init__	(		self,
			window
	)

Constructor of xmlManipulator.

Parameters:

	self	The object pointer.
	window	Main Window of an application. (Used for gaining access to all its subwidgets).

def xmlmanipulators::projectXml::getProjectInfo	(		self,
			path,
			silent = False
	)

Function which reads project XML and returns part of its stored content.

Returned elements are :

projectName - name of the project projectDescription - description of the project projectAuthor - author of the project

Parameters:

	self	The object pointer.
	path	Path to project XML file.
	silent	Indicates whether to display error QMessageBox on failure.

Returns:

False on error, list of consisting of project Name, Description and Author on success.

def xmlmanipulators::projectXml::getProjectXmlContent	(		self,
			path,
			silent = False
	)

Function which reads project XML and returns all its stored content.

Stored content elements are :

projectName - name of the project projectDescription - description of the project projectAuthor - author of the project iterationCount - count of iterations in recording part startRecordingClient - indicator whether start recording client startRecordingServer - indicator whether start recording server strategy - selected strategy in fuzzing part params - params given in the fuzzing part seedEnabled - indicator whether random seed is enabled seed - random seed seedIteration - iteration in which seed starts to affect fuzzing startFuzzingClient - indicator whether start fuzzing client startFuzzingServer - indicator whether start fuzzing server

Parameters:

	self	The object pointer.
	path	Path to project XML file.
	silent	Indicates whether to display error QMessageBox on failure.

Returns:

False on error, list of stored content elements on success.

def xmlmanipulators::projectXml::storeProjectXmlContent	(		self,
			path,
			name,
			description,
			author,
			iterationCount,
			startRecordingClient,
			startRecordingServer,
			strategy,
			params,
			seedEnabled,
			seed,
			seedIteration,
			startFuzzingClient,
			startFuzzingServer,
			silent = False
	)

Function which stores given params into project XML.

Parameters:

	self	The object pointer.
	path	Path to file whereto store params.
	name	Name of the project.
	description	Description of the project.
	author	Author of the project.
	iterationCount	Count of iterations in recording part.
	startRecordingClient	Indicator whether start recording client.
	startRecordingServer	Indicator whether start recording server.
	strategy	Selected strategy in fuzzing part.
	params	Params given in the fuzzing part.
	seedEnabled	Indicator whether random seed is enabled.
	seed	Random seed.
	seedIteration	Iteration in which seed starts to affect fuzzing.
	startFuzzingClient	Indicator whether start fuzzing client.
	startFuzzingServer	Indicator whether start fuzzing server.
	silent	Indicates whether to display error QMessageBox on failure.

Returns:

False on error, list of stored content elements on success.

def xmlmanipulators::projectXml::validateXML	(		self,
			file,
			silent = False
	)

Validates opened XML file whether it matches given schema projectXml::pathToSchema.

Parameters:

	self	The object pointer.
	file	opened QFile stucture associated with XML file
	silent	Indicates whether to display error QMessageBox on failure.

Returns:

True when it matches, False otherwise

---

Member Data Documentation

tuple xmlmanipulators::projectXml::pathToSchema = QString(sys.path[0] + "/GUI/schema/project.xsd") [static]

path where project XML schema is stored (used for validation)

xmlmanipulators::projectXml::window

window Main Window of an application.

(Used for gaining access to all its subwidgets).

---

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

• GUI/xmlmanipulators.py