ArActionInput Class Reference
Action for taking input from outside to control the robot. More...
#include <ArActionInput.h>
Inherits ArAction.
Public Member Functions | |
| ArActionInput (const char *name="Input") | |
| Constructor. More... | |
| void | clear (void) |
| Clears it so its not using vel or heading. | |
| void | deltaHeadingFromCurrent (double delta) |
| Increment/decrement the heading from current. | |
| virtual ArActionDesired * | fire (ArActionDesired currentDesired) |
| virtual ArActionDesired * | getDesired (void) |
| virtual const ArActionDesired * | getDesired (void) const |
| void | setHeading (double heading) |
| Sets a heading. | |
| void | setRotVel (double rotVel) |
| Sets a rotational velocity. | |
| void | setVel (double vel) |
| Set velocity (cancels deltaVel) | |
| virtual | ~ArActionInput () |
| Destructor. | |
 Public Member Functions inherited from ArAction | |
| virtual void | activate (void) |
| Activate the action. | |
| ArAction (const char *name, const char *description="") | |
| Constructor. | |
| virtual void | deactivate (void) |
| Deactivate the action. | |
| virtual const ArArg * | getArg (int number) const |
| Gets the numbered argument. More... | |
| virtual ArArg * | getArg (int number) |
| Gets the numbered argument. | |
| virtual const char * | getDescription (void) const |
| Gets the long description of the action. | |
| virtual const char * | getName (void) const |
| Gets the name of the action. | |
| virtual int | getNumArgs (void) const |
| Find the number of arguments this action takes. | |
| ArRobot * | getRobot () const |
| Get the robot we are controlling, which was set by setRobot() | |
| virtual bool | isActive (void) const |
| Returns whether the action is active or not. | |
| virtual void | log (bool verbose=true) const |
| Log information about this action using ArLog. | |
| virtual void | setRobot (ArRobot *robot) |
| Sets the robot this action is driving. More... | |
| virtual | ~ArAction () |
| Desructor. | |
Protected Types | |
| enum | RotRegime { NONE, ROTVEL, DELTAHEADING, SETHEADING } |
Protected Attributes | |
| ArActionDesired | myDesired |
| RotRegime | myRotRegime |
| double | myRotVal |
| bool | myUsingVel |
| double | myVelSet |
| Protected Attributes inherited from ArAction | |
| std::map< int, ArArg > | myArgumentMap |
| std::string | myDescription |
| bool | myIsActive |
| std::string | myName |
| int | myNumArgs |
| ArRobot * | myRobot |
| The robot we are controlling, set by the action resolver using setRobot() | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ArAction | |
| static bool | getDefaultActivationState (void) |
| Gets the default activation state for all ArActions. | |
| static void | setDefaultActivationState (bool defaultActivationState) |
| Sets the default activation state for all ArActions. | |
| Protected Member Functions inherited from ArAction | |
| void | setNextArgument (ArArg const &arg) |
| Sets the argument type for the next argument (must only be used in a constructor!) | |
| Static Protected Attributes inherited from ArAction | |
| static bool | ourDefaultActivationState = true |
Detailed Description
Action for taking input from outside to control the robot.
This action sets up how we want to drive
Constructor & Destructor Documentation
◆ ArActionInput()
| ArActionInput::ArActionInput | ( | const char * | name = "Input" | ) |
Constructor.
- Parameters
-
name name of the action
The documentation for this class was generated from the following files:
- ArActionInput.h
- ArActionInput.cpp
