WaitForChildren Class Reference
Public Member Functions | |
| WaitForChildren (double timeout) | |
| WaitForChildren (const char *name, double timeout) | |
Protected Member Functions | |
| virtual void | Initialize () |
| virtual void | Execute () |
| virtual bool | IsFinished () |
| virtual void | End () |
| virtual void | Interrupted () |
Detailed Description
Definition at line 12 of file WaitForChildren.h.
Member Function Documentation
| void WaitForChildren::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.
Definition at line 28 of file WaitForChildren.cpp.
| void WaitForChildren::Execute | ( | ) | [protected, virtual] |
The execute method is called repeatedly until this Command either finishes or is canceled.
Implements Command.
Definition at line 24 of file WaitForChildren.cpp.
| void WaitForChildren::Initialize | ( | ) | [protected, virtual] |
The initialize method is called the first time this Command is run after being started.
Implements Command.
Definition at line 20 of file WaitForChildren.cpp.
| void WaitForChildren::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.
Definition at line 32 of file WaitForChildren.cpp.
| bool WaitForChildren::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.
Definition at line 36 of file WaitForChildren.cpp.
The documentation for this class was generated from the following files:
Generated on Thu Jan 12 2012 22:35:38 for WPILibC++ by
1.7.1