frepple::CommandPlanSize Class Reference

This command prints a summary of the dynamically allocated memory to the standard output. This is useful for understanding better the size of your model. More...

#include <model.h>

Inheritance diagram for frepple::CommandPlanSize:
frepple::utils::Command

List of all members.

Public Member Functions

 CommandPlanSize ()
void execute ()
void undo ()
bool undoable () const

Static Public Member Functions

static PyObject * executePython (PyObject *self, PyObject *args)

Detailed Description

This command prints a summary of the dynamically allocated memory to the standard output. This is useful for understanding better the size of your model.

The numbers reported by this function won't match the memory size as reported by the operating system, since the dynamically allocated memory is only a part of the total memory used by a program.

Definition at line 4437 of file model.h.


Constructor & Destructor Documentation

frepple::CommandPlanSize::CommandPlanSize (  )  [inline]

Definition at line 4440 of file model.h.


Member Function Documentation

void frepple::CommandPlanSize::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 203 of file model/library.cpp.

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

Definition at line 4442 of file model.h.

void frepple::CommandPlanSize::undo (  )  [inline, virtual]

This method is undoing the state change of the execute() method.
Reversing the action is not possible for all commands. Command subclasses should override the undo() and undoable() method in case they are reversible.
A couple of notes on how this method should be implemented by the subclasses:

  • Calling the undo() method is harmless if the execute() hasn't been called yet.
  • Calling the undo() method multiple times is harmless and results in the same state change as calling it only once.

Reimplemented from frepple::utils::Command.

Definition at line 4444 of file model.h.

bool frepple::CommandPlanSize::undoable (  )  const [inline, virtual]

Returns true if the execution of this command can be undone.

Reimplemented from frepple::utils::Command.

Definition at line 4445 of file model.h.


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

Generated on 21 Mar 2010 for frePPLe by  doxygen 1.6.1