cnoid::Task Class Reference

#include <Task.h>

Inheritance diagram for cnoid::Task:

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
TaskPhase *	phase (int index)
TaskPhase *	addPhase (TaskPhase *phase)
TaskPhase *	addPhase (const std::string &caption)
TaskPhase *	lastPhase ()
void	setPreCommand (TaskFunc func)
TaskCommand *	addCommand ()
TaskCommand *	addCommand (const std::string &caption)
TaskCommand *	addToggleCommand ()
TaskCommand *	addToggleCommand (const std::string &caption)
TaskCommand *	lastCommand ()
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() [1/3]

Task::Task

(

)

Task() [2/3]

Task::Task	(	const std::string &	name,
		const std::string &	caption
	)

Task() [3/3]

Task::Task	(	const Task &	org,
		bool	doDeepCopy = true
	)

~Task()

Task::~Task

(

)

Member Function Documentation

addCommand() [1/2]

TaskCommand * Task::addCommand

(

)

addCommand() [2/2]

TaskCommand * Task::addCommand

(

const std::string &

caption

)

addPhase() [1/2]

TaskPhase * Task::addPhase

(

TaskPhase *

phase

)

addPhase() [2/2]

TaskPhase * Task::addPhase

(

const std::string &

caption

)

addToggleCommand() [1/2]

TaskCommand * Task::addToggleCommand

(

)

addToggleCommand() [2/2]

TaskCommand * Task::addToggleCommand

(

const std::string &

caption

)

caption()

const std::string& cnoid::Task::caption ( ) const

inline

commandLevel()

TaskPhaseProxyPtr Task::commandLevel

(

int

level

)

funcToSetCommandLink()

TaskFunc Task::funcToSetCommandLink

(

int

commandIndex

)

const

lastCommand()

TaskCommand * Task::lastCommand

(

)

lastCommandIndex()

int Task::lastCommandIndex

(

)

lastPhase()

TaskPhase * Task::lastPhase

(

)

maxCommandLevel()

int Task::maxCommandLevel

(

)

const

name()

const std::string& cnoid::Task::name ( ) const

inline

numPhases()

int cnoid::Task::numPhases ( ) const

inline

onActivated()

void Task::onActivated ( AbstractTaskSequencer *  sequencer )

virtual

onDeactivated()

void Task::onDeactivated ( AbstractTaskSequencer *  sequencer )

virtual

onMenuRequest()

void Task::onMenuRequest ( TaskMenu &  menu )

virtual

Todo:

The menu API should be moved to the actual implementation class of AbstractTaskSequencer

phase()

TaskPhase * Task::phase

(

int

index

)

restoreState()

void Task::restoreState ( AbstractTaskSequencer *  sequencer, const Mapping &  archive  )

virtual

setCaption()

void Task::setCaption

(

const std::string &

str

)

setName()

void Task::setName

(

const std::string &

str

)

setPreCommand()

void Task::setPreCommand

(

TaskFunc

func

)

storeState()

void Task::storeState ( AbstractTaskSequencer *  sequencer, Mapping &  archive  )

virtual

---

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

• Task.h
• Task.cpp