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>

Inheritance diagram for frepple::CommandReadXMLFile:
frepple::utils::Command

List of all members.

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 execute ()
string getDescription () const
string getFileName ()
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 *)

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 3685 of file model.h.


Constructor & Destructor Documentation

frepple::CommandReadXMLFile::CommandReadXMLFile ( const char *  s = NULL,
bool  v = true,
bool  o = false 
) [inline]

Constructor. If no file or directory name is passed or specified later the standard input will be read during execution of the command.

Definition at line 3690 of file model.h.

frepple::CommandReadXMLFile::CommandReadXMLFile ( const string &  s,
bool  v = true,
bool  o = false 
) [inline]

Constructor.

Definition at line 3694 of file model.h.


Member Function Documentation

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 134 of file model/actions.cpp.

PyObject * frepple::CommandReadXMLFile::executePython ( PyObject *  self,
PyObject *  args 
) [static]

Python interface for this command.

Definition at line 166 of file model/actions.cpp.

string frepple::CommandReadXMLFile::getDescription (  )  const [inline, virtual]

Reimplemented from frepple::utils::Command.

Definition at line 3724 of file model.h.

string frepple::CommandReadXMLFile::getFileName (  )  [inline]

Returns the name of the input file.

Definition at line 3701 of file model.h.

bool frepple::CommandReadXMLFile::getValidate (  )  [inline]

Returns true if the schema validation has been enabled.

Definition at line 3707 of file model.h.

bool frepple::CommandReadXMLFile::getValidateOnly (  )  [inline]

Returns whether we only need to validate to data, or really execute them too.

Definition at line 3714 of file model.h.

void frepple::CommandReadXMLFile::setFileName ( const string &  v  )  [inline]

Update the name of the input file.

Definition at line 3698 of file model.h.

void frepple::CommandReadXMLFile::setValidate ( bool  b  )  [inline]

Enables or disables the validation.

Definition at line 3704 of file model.h.

void frepple::CommandReadXMLFile::setValidateOnly ( bool  b  )  [inline]

Only validate the input, do not really execute it.

Definition at line 3710 of file model.h.


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

Generated on 25 Feb 2010 for frePPLe by  doxygen 1.6.1