xmlmanipulators::xmlManipulator Class Reference

xmlManipulator() More...

Inheritance diagram for xmlmanipulators::xmlManipulator:

xmlmanipulators::fuzzingXmlManipulator xmlmanipulators::recordingXmlManipulator

List of all members.

Public Member Functions

def __init__
 Constructor of xmlManipulator.
def loadXMLFile
 Creates XML element tree from XML file using peachXmlReader.
def storeXMLFile
 Stores content of our XML element tree into XML file using peachXmlWriter.
def findRootElement
 Returns node element which tag is named "Peach".
def findServerAgent
 Returns node element which tag is named "Agent" and has attribute "name=ServerAgent".
def findClientAgent
 Returns node element which tag is named "Agent" and has attribute "name=ClientAgent".
def findAgent
 Returns node element which tag is named "Agent" and has value attribute "name" same as given param.
def findPublisher
 Returns node element which tag is named "Publisher" and lies within tag named "Test".
def findLogger
 Returns node element which tag is named "Logger" and lies within tag named "Run".
def setLogger
 Sets value of attribute "value" of tag is named "Logger" and lies within tag named "Run".

Public Attributes

 window
 Main Window of an application.
 tree
 XML Tree which was created by peachXmlReader and is associated with this structure.


Detailed Description

xmlManipulator()

Class used for storing/loading content of Main Widow to/from peach XML file. It's abstract class and is mutual parent of recordingXmlManipulator and fuzzingXmlManipulator.

Author:
Stepan Henek

Member Function Documentation

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

Constructor of xmlManipulator.

Parameters:
self The object pointer.
window Main Window of an application.

def xmlmanipulators::xmlManipulator::findAgent (   self,
  root,
  agentName,
  silent = False 
)

Returns node element which tag is named "Agent" and has value attribute "name" same as given param.

Parameters:
self The object pointer.
agentName Desired "name" attribute value.
root Node where to search for agent subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
Returns:
Tree node which tag is named "Agent" and has attribute "name=ClientAgent", None otherwise

def xmlmanipulators::xmlManipulator::findClientAgent (   self,
  root,
  silent = False 
)

Returns node element which tag is named "Agent" and has attribute "name=ClientAgent".

Parameters:
self The object pointer.
root Node where to search for agent subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
Returns:
Tree node which tag is named "Agent" and has attribute "name=ClientAgent", None otherwise

def xmlmanipulators::xmlManipulator::findLogger (   self,
  root,
  silent = False 
)

Returns node element which tag is named "Logger" and lies within tag named "Run".

Parameters:
self The object pointer.
root Node where to search for run subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
Returns:
Tree node which tag is named "Logger" and lies within tag named "Run", None otherwise

def xmlmanipulators::xmlManipulator::findPublisher (   self,
  root,
  silent = False 
)

Returns node element which tag is named "Publisher" and lies within tag named "Test".

Parameters:
self The object pointer.
root Node where to search for test subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
Returns:
Tree node which tag is named "Publisher" and lies within tag named "Test", None otherwise

def xmlmanipulators::xmlManipulator::findRootElement (   self  ) 

Returns node element which tag is named "Peach".

This element is later referred as root.

See also:
xmlManipulator.tree
Parameters:
self The object pointer.
Returns:
Tree node which tag is named "Peach", None otherwise

def xmlmanipulators::xmlManipulator::findServerAgent (   self,
  root,
  silent = False 
)

Returns node element which tag is named "Agent" and has attribute "name=ServerAgent".

Parameters:
self The object pointer.
root Node where to search for agent subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
Returns:
Tree node which tag is named "Agent" and has attribute "name=ServerAgent", None otherwise

def xmlmanipulators::xmlManipulator::loadXMLFile (   self,
  path,
  silent = False 
)

Creates XML element tree from XML file using peachXmlReader.

See also:
peachXmlReader
Note that this function doesn't modify any widget.

Parameters:
self The object pointer.
path Path to XML file to be loaded.
silent Indicates whether to display error QMessageBox on failure.
Returns:
True on success, False otherwise

def xmlmanipulators::xmlManipulator::setLogger (   self,
  root,
  loggerPath,
  silent = False 
)

Sets value of attribute "value" of tag is named "Logger" and lies within tag named "Run".

Parameters:
self The object pointer.
root Node where to search for run subelement. (No recursive search is performed.)
silent Indicates whether to display error QMessageBox on failure.
loggerPath New value for attribute "value".
Returns:
True on success, False otherwise

def xmlmanipulators::xmlManipulator::storeXMLFile (   self,
  path,
  silent = False 
)

Stores content of our XML element tree into XML file using peachXmlWriter.

See also:
peachXmlWriter
Note that this function doesn't read data from any widget.

Parameters:
self The object pointer.
path Path to XML where to store the tree.
silent Indicates whether to display error QMessageBox on failure.
Returns:
True on success, False otherwise


Member Data Documentation

XML Tree which was created by peachXmlReader and is associated with this structure.

Main Window of an application.


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

Generated on Sun Sep 5 12:41:36 2010 for HotFuzz by  doxygen 1.5.8