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

skElementExecutable 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 <skElementExecutable.h>

Inheritance diagram for skElementExecutable:

skElementObject skExecutable skiExecutable List of all members.

Public Methods

 skElementExecutable ()
 Default Constructor.

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

 skElementExecutable (const skString &scriptLocation, istream &in)
 Constructor taking an input stream containing an XML document.

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

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

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

void load (const skString &fileName, skExecutableContext &context)
 This method causes the to be loaded from a file.

void save (ostream &out)
 Call this method to save the state of the object back to a stream.

void save (const skString &fileName)
 This method saves the current state as an 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.

This version uses the Expat XML parser to read documents.


Constructor & Destructor Documentation

skElementExecutable::skElementExecutable 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

skElementExecutable::skElementExecutable const skString   scriptLocation,
istream &    in
 

Constructor taking an input stream containing an XML document.

Parameters:
scriptLocation the name of the XML source
in a stream containing the XML document

skElementExecutable::skElementExecutable 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 a stream containing the XML document
context context object to receive errors


Member Function Documentation

void skElementExecutable::load const skString   fileName,
skExecutableContext   context
 

This method causes the to be loaded from a file.

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

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

This method causes the to be reloaded.

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

void skElementExecutable::load const skString   scriptLocation,
istream &    in
 

This method causes the to be reloaded.

Parameters:
in - stream containing the

void skElementExecutable::save ostream &    out
 

Call this method to save the state of the object back to a stream.

Exceptions:
IOException if there was an error writing to the stream


The documentation for this class was generated from the following files:
Generated on Mon Dec 16 16:30:12 2002 for Simkin by doxygen1.3-rc1