frepple::CommandReadXMLString Class Reference

This command is used for reading XML input from a certain string. More...

#include <model.h>

Inheritance diagram for frepple::CommandReadXMLString:
frepple::utils::Command

List of all members.

Public Member Functions

 CommandReadXMLString (const bool v=true, const bool o=false)
 CommandReadXMLString (const string &s, const bool v=true, const bool o=false)
void endElement (XMLInput &, const Attribute &, const DataElement &)
void execute ()
string getData ()
string getDescription () const
bool getValidate ()
bool getValidateOnly ()
void setData (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 from a certain string.

The command is not thread-safe: multiple threads can simultaneously access the same objects.

Definition at line 3755 of file model.h.


Constructor & Destructor Documentation

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

Constructor.

Definition at line 3759 of file model.h.

frepple::CommandReadXMLString::CommandReadXMLString ( const bool  v = true,
const bool  o = false 
) [inline]

Default constructor.

Definition at line 3763 of file model.h.


Member Function Documentation

void frepple::CommandReadXMLString::endElement ( XMLInput ,
const Attribute ,
const DataElement  
)
void frepple::CommandReadXMLString::execute (  )  [virtual]

The commit action reads the input.

Implements frepple::utils::Command.

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

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

Python interface for this command.

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

string frepple::CommandReadXMLString::getData (  )  [inline]

Returns the data string.

Definition at line 3770 of file model.h.

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

Reimplemented from frepple::utils::Command.

Definition at line 3792 of file model.h.

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

Returns true if the schema validation has been enabled.

Definition at line 3776 of file model.h.

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

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

Definition at line 3783 of file model.h.

void frepple::CommandReadXMLString::setData ( const string &  v  )  [inline]

Updates the data string.

Definition at line 3767 of file model.h.

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

Enables or disables the validation.

Definition at line 3773 of file model.h.

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

Only validate the input, do not really execute it.

Definition at line 3779 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