frepple::CommandErase Class Reference

This command deletes part of the model or the plan from memory. More...

#include <model.h>

Inheritance diagram for frepple::CommandErase:
frepple::utils::Command

List of all members.

Public Member Functions

 CommandErase (bool staticAlso=false)
void execute ()
bool getDeleteStaticModel () const
string getDescription () const
void setDeleteStaticModel (bool b)

Static Public Member Functions

static PyObject * executePython (PyObject *, PyObject *)

Detailed Description

This command deletes part of the model or the plan from memory.

The class allows the following modes to control what to delete:

Definition at line 3951 of file model.h.


Constructor & Destructor Documentation

frepple::CommandErase::CommandErase ( bool  staticAlso = false  )  [inline]

Definition at line 3954 of file model.h.


Member Function Documentation

void frepple::CommandErase::execute (  )  [virtual]

This method is used to actually execute the action.
A couple of notes on how this method should be implemented by the subclasses:

  • Calling the method multiple times is harmless and results in the same state change as calling it only once.

Implements frepple::utils::Command.

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

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

Python interface to this command.

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

bool frepple::CommandErase::getDeleteStaticModel (  )  const [inline]

Definition at line 3965 of file model.h.

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

Reimplemented from frepple::utils::Command.

Definition at line 3961 of file model.h.

void frepple::CommandErase::setDeleteStaticModel ( bool  b  )  [inline]

Definition at line 3966 of file model.h.


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

Generated on 25 Sep 2009 for frePPLe by  doxygen 1.6.1