Choreonoid  1.5
Public Member Functions | List of all members
cnoid::Task Class Reference

#include <Task.h>

Inheritance diagram for cnoid::Task:
cnoid::Referenced

Public Member Functions

 Task ()
 
 Task (const std::string &name, const std::string &caption)
 
 Task (const Task &org, bool doDeepCopy=true)
 
 ~Task ()
 
const std::string & name () const
 
void setName (const std::string &str)
 
const std::string & caption () const
 
void setCaption (const std::string &str)
 
int numPhases () const
 
TaskPhasephase (int index)
 
TaskPhaseaddPhase (TaskPhase *phase)
 
TaskPhaseaddPhase (const std::string &caption)
 
TaskPhaselastPhase ()
 
void setPreCommand (TaskFunc func)
 
TaskCommandaddCommand ()
 
TaskCommandaddCommand (const std::string &caption)
 
TaskCommandaddToggleCommand ()
 
TaskCommandaddToggleCommand (const std::string &caption)
 
TaskCommandlastCommand ()
 
int lastCommandIndex ()
 
TaskPhaseProxyPtr commandLevel (int level)
 
int maxCommandLevel () const
 
TaskFunc funcToSetCommandLink (int commandIndex) const
 
virtual void onActivated (AbstractTaskSequencer *sequencer)
 
virtual void onDeactivated (AbstractTaskSequencer *sequencer)
 
virtual void storeState (AbstractTaskSequencer *sequencer, Mapping &archive)
 
virtual void restoreState (AbstractTaskSequencer *sequencer, const Mapping &archive)
 
virtual void onMenuRequest (TaskMenu &menu)
 
- Public Member Functions inherited from cnoid::Referenced
virtual ~Referenced ()
 
void addRef ()
 
void releaseRef ()
 

Additional Inherited Members

- Protected Member Functions inherited from cnoid::Referenced
 Referenced ()
 
 Referenced (const Referenced &org)
 
int refCount () const
 

Constructor & Destructor Documentation

Task::Task ( )
Task::Task ( const std::string &  name,
const std::string &  caption 
)
Task::Task ( const Task org,
bool  doDeepCopy = true 
)
Task::~Task ( )

Member Function Documentation

TaskCommand * Task::addCommand ( )
TaskCommand * Task::addCommand ( const std::string &  caption)
TaskPhase * Task::addPhase ( TaskPhase phase)
TaskPhase * Task::addPhase ( const std::string &  caption)
TaskCommand * Task::addToggleCommand ( )
TaskCommand * Task::addToggleCommand ( const std::string &  caption)
const std::string& cnoid::Task::caption ( ) const
inline
TaskPhaseProxyPtr Task::commandLevel ( int  level)
TaskFunc Task::funcToSetCommandLink ( int  commandIndex) const
TaskCommand * Task::lastCommand ( )
int Task::lastCommandIndex ( )
TaskPhase * Task::lastPhase ( )
int Task::maxCommandLevel ( ) const
const std::string& cnoid::Task::name ( ) const
inline
int cnoid::Task::numPhases ( ) const
inline
void Task::onActivated ( AbstractTaskSequencer sequencer)
virtual
void Task::onDeactivated ( AbstractTaskSequencer sequencer)
virtual
void Task::onMenuRequest ( TaskMenu menu)
virtual
Todo:
The menu API should be moved to the actual implementation class of AbstractTaskSequencer
TaskPhase * Task::phase ( int  index)
void Task::restoreState ( AbstractTaskSequencer sequencer,
const Mapping archive 
)
virtual
void Task::setCaption ( const std::string &  str)
void Task::setName ( const std::string &  str)
void Task::setPreCommand ( TaskFunc  func)
void Task::storeState ( AbstractTaskSequencer sequencer,
Mapping archive 
)
virtual

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