frepple::CommandReadXMLFile Class Reference
This command is used for reading XML input. The input comes either from a flatfile, or from the standard input. More...
#include <model.h>
Public Member Functions | |
| CommandReadXMLFile (const string &s, bool v=true, bool o=false) | |
| CommandReadXMLFile (const char *s=NULL, bool v=true, bool o=false) | |
| void | endElement (XMLInput &, const Attribute &, const DataElement &) |
| void | execute () |
| string | getDescription () const |
| string | getFileName () |
| virtual size_t | getSize () const |
| virtual const MetaClass & | getType () const |
| bool | getValidate () |
| bool | getValidateOnly () |
| void | setFileName (const string &v) |
| void | setValidate (bool b) |
| void | setValidateOnly (bool b) |
Static Public Member Functions | |
| static PyObject * | executePython (PyObject *, PyObject *) |
Static Public Attributes | |
| static const MetaClass | metadata |
Detailed Description
This command is used for reading XML input. The input comes either from a flatfile, or from the standard input.The command is not thread-safe: multiple threads can simultaneously access the same objects.
Definition at line 3585 of file model.h.
Constructor & Destructor Documentation
| frepple::CommandReadXMLFile::CommandReadXMLFile | ( | const char * | s = NULL, |
|
| bool | v = true, |
|||
| bool | o = false | |||
| ) | [inline] |
| frepple::CommandReadXMLFile::CommandReadXMLFile | ( | const string & | s, | |
| bool | v = true, |
|||
| bool | o = false | |||
| ) | [inline] |
Member Function Documentation
| void frepple::CommandReadXMLFile::endElement | ( | XMLInput & | , | |
| const Attribute & | , | |||
| const DataElement & | ||||
| ) | [virtual] |
Called while restoring the model from an XML-file. This is called when the corresponding close element tag is encountered, and the Data() member of pElement is also valid. NOTE: each object receives both its own beginElement so it can process its own element tag attributes, and its own endElement so it can process its own character data.
Reimplemented from frepple::utils::Command.
Definition at line 153 of file model/actions.cpp.
| void frepple::CommandReadXMLFile::execute | ( | ) | [virtual] |
The commit action reads the input. If a filename is specified (either in the constructor or with the setFileName function), a flat file is read. Otherwise, the standard input is read.
Implements frepple::utils::Command.
Definition at line 164 of file model/actions.cpp.
| PyObject * frepple::CommandReadXMLFile::executePython | ( | PyObject * | self, | |
| PyObject * | args | |||
| ) | [static] |
Python interface for this command.
Definition at line 199 of file model/actions.cpp.
| string frepple::CommandReadXMLFile::getDescription | ( | ) | const [inline, virtual] |
| string frepple::CommandReadXMLFile::getFileName | ( | ) | [inline] |
| virtual size_t frepple::CommandReadXMLFile::getSize | ( | ) | const [inline, virtual] |
Return the memory size of the object in bytes.
Implements frepple::utils::Object.
| virtual const MetaClass& frepple::CommandReadXMLFile::getType | ( | ) | const [inline, virtual] |
This returns the type information on the object, a bit similar to the standard type_info information.
Implements frepple::utils::Object.
| bool frepple::CommandReadXMLFile::getValidate | ( | ) | [inline] |
| bool frepple::CommandReadXMLFile::getValidateOnly | ( | ) | [inline] |
| void frepple::CommandReadXMLFile::setFileName | ( | const string & | v | ) | [inline] |
| void frepple::CommandReadXMLFile::setValidate | ( | bool | b | ) | [inline] |
| void frepple::CommandReadXMLFile::setValidateOnly | ( | bool | b | ) | [inline] |
Member Data Documentation
const MetaClass frepple::CommandReadXMLFile::metadata [static] |
The documentation for this class was generated from the following files:
Documentation generated by
