WaitUntilCommand Class Reference
Public Member Functions | |
| WaitUntilCommand (double time) | |
| WaitUntilCommand (const char *name, double time) | |
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 WaitUntilCommand.h.
Constructor & Destructor Documentation
| WaitUntilCommand::WaitUntilCommand | ( | double | time | ) |
A WaitCommand will wait until a certain match time before finishing. This will wait until the game clock reaches some value, then continue to the next command.
- See also:
- CommandGroup
Definition at line 17 of file WaitUntilCommand.cpp.
Member Function Documentation
| void WaitUntilCommand::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 45 of file WaitUntilCommand.cpp.
| void WaitUntilCommand::Execute | ( | ) | [protected, virtual] |
The execute method is called repeatedly until this Command either finishes or is canceled.
Implements Command.
Definition at line 33 of file WaitUntilCommand.cpp.
| void WaitUntilCommand::Initialize | ( | ) | [protected, virtual] |
The initialize method is called the first time this Command is run after being started.
Implements Command.
Definition at line 29 of file WaitUntilCommand.cpp.
| void WaitUntilCommand::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 49 of file WaitUntilCommand.cpp.
| bool WaitUntilCommand::IsFinished | ( | ) | [protected, virtual] |
Check if we've reached the actual finish time.
Implements Command.
Definition at line 40 of file WaitUntilCommand.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