StartCommand Class Reference

Inheritance diagram for StartCommand:

List of all members.

Public Member Functions
	StartCommand (Command *commandToStart)
Protected Member Functions
virtual void	Initialize ()
virtual void	Execute ()
virtual bool	IsFinished ()
virtual void	End ()
virtual void	Interrupted ()

---

Member Function Documentation

void StartCommand::End

(

)

[protected, virtual]

Called when the command ended peacefully. This is where you may want to wrap up loose ends, like shutting off a motor that was being used in the command.

Implements Command.

void StartCommand::Execute

(

)

[protected, virtual]

The execute method is called repeatedly until this Command either finishes or is canceled.

Implements Command.

void StartCommand::Initialize

(

)

[protected, virtual]

The initialize method is called the first time this Command is run after being started.

Implements Command.

void StartCommand::Interrupted

(

)

[protected, virtual]

Called when the command ends because somebody called cancel() or another command shared the same requirements as this one, and booted it out.

This is where you may want to wrap up loose ends, like shutting off a motor that was being used in the command.

Generally, it is useful to simply call the end() method within this method

Implements Command.

bool StartCommand::IsFinished

(

)

[protected, virtual]

Returns whether this command is finished. If it is, then the command will be removed and end() will be called.

It may be useful for a team to reference the isTimedOut() method for time-sensitive commands.

Returns:

whether this command is finished.

See also:

Command::isTimedOut() isTimedOut()

Implements Command.

---

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

• Commands/StartCommand.h
• Commands/StartCommand.cpp