Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

skMSXMLExecutable Class Reference

This class is a base class for objects which store their data and methods in an XML document Each instance is associated with an XML document which is loaded on construction. More...

#include <skMSXMLExecutable.h>

Inheritance diagram for skMSXMLExecutable:

skMSXMLElementObject skExecutable skiExecutable List of all members.

Public Member Functions

 skMSXMLExecutable ()
 Default Constructor.

 skMSXMLExecutable (const skString &fileName, skExecutableContext &context)
 Constructor - passed the name of a file to load an XML document from.

 skMSXMLExecutable (const skString &scriptLocation, const skString &in, skExecutableContext &context)
 Constructor taking a String containing an XML document.

void load (const skString &scriptLocation, const skString &in, skExecutableContext &context)
 This method causes the XML to be reloaded.

void load (const skString &fileName, skExecutableContext &context)
 This method causes the XML to be loaded from a file.If there is an error, this method throws an skXMLParseException.

void save (const skString &fileName)
 This method saves the current state as an XML document out to the given file.


Detailed Description

This class is a base class for objects which store their data and methods in an XML document Each instance is associated with an XML document which is loaded on construction.


Constructor & Destructor Documentation

skMSXMLExecutable::skMSXMLExecutable const skString fileName,
skExecutableContext context
 

Constructor - passed the name of a file to load an XML document from.

Parameters:
fileName name of XML file
context context object to receive errors

skMSXMLExecutable::skMSXMLExecutable const skString scriptLocation,
const skString in,
skExecutableContext context
 

Constructor taking a String containing an XML document.

Parameters:
scriptLocation the name of the XML source
in - string containing the XML
context context object to receive errors


Member Function Documentation

void skMSXMLExecutable::load const skString fileName,
skExecutableContext context
 

This method causes the XML to be loaded from a file.If there is an error, this method throws an skXMLParseException.

Parameters:
fileName name of XML file
context context object to receive errors

void skMSXMLExecutable::load const skString scriptLocation,
const skString in,
skExecutableContext context
 

This method causes the XML to be reloaded.

If there is an error, this method throws an skXMLParseException.

Parameters:
scriptLocation the name of the XML source
in - string containing the XML
context context object to receive errors

void skMSXMLExecutable::save const skString fileName  ) 
 

This method saves the current state as an XML document out to the given file.

Parameters:
fileName name of XML file


The documentation for this class was generated from the following files:
Generated on Fri Dec 17 20:27:35 2004 for Simkin by doxygen1.3