CSWPyCommand Class Reference

Inheritance diagram for CSWPyCommand:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void initialize ()=0
virtual void step ()=0
virtual void cleanup ()=0
virtual std::string getDetails () const
void setProgress (double fProgress)
void finished ()

Detailed Description

The base class of Commands that are defined in python.


Member Function Documentation

virtual void CSWPyCommand::initialize (  )  [pure virtual]

This is called directly before execution (before the first step() is called).

Implements ARSTD::Command.

virtual void CSWPyCommand::step (  )  [pure virtual]

This is called periodically about every 10ms while executing. If the command is done finished() must be called. If finished() is never called the command never stops executing.

Implements ARSTD::Command.

virtual void CSWPyCommand::cleanup (  )  [pure virtual]

This is called directly after finishing of execution or on breaking.

Implements ARSTD::Command.

virtual std::string CSWPyCommand::getDetails (  )  const [virtual]

Returns some interesting stuff about the current command state.

Returns:
The detailed state depend command description.

Reimplemented from ARSTD::Command.

void CSWPyCommand::setProgress ( double  fProgress  ) 

Sets the progress of command execution.

Parameters:
fProgress The new progress of the execution in range [0, 1].

Reimplemented from ARSTD::Command.

void CSWPyCommand::finished (  ) 

This indicates the execution environment that the command is done.

Warning:
This method is only valid to call inside step().

Reimplemented from ARSTD::Command.


Generated at 2 Jan 2007 for project CodeSubWars. www.codesubwars.org