Kodu::PerceptualTaskBase Class Reference
#include <PerceptualTaskBase.h>
Detailed Description
Definition at line 26 of file PerceptualTaskBase.h.
Public Types | |
| enum | TaskStatus_t { TS_IN_PROGRESS = 0, TS_COMPLETE, TS_SUCCESSFUL, TS_FAILURE } |
Public Member Functions | |
| PerceptualTaskBase (PerceptualTaskType_t perceptTaskType, unsigned int taskId) | |
| Constructor. | |
| PerceptualTaskBase (const PerceptualTaskBase &kTask) | |
| Copy constructor. | |
| virtual | ~PerceptualTaskBase () |
| Destructor. | |
| PerceptualTaskBase & | operator= (const PerceptualTaskBase &kTask) |
| Assignment operator. | |
| virtual bool | canExecute (const KoduWorld &)=0 |
| Checks if a task can execute (reimplemented in all derived class). | |
| virtual void | examineTaskResults () |
| Examines the results from a task. | |
| virtual const DualCoding::MapBuilderRequest & | getMapBuilderRequest () |
| Returns the MapBuilder request the robot should perform. | |
| virtual const DualCoding::PilotRequest | getPilotRequest () |
| Returns the Pilot request the robot should perform. | |
| TaskStatus_t | getStatus () const |
| Returns the task's current status. | |
| float | getTaskId () const |
| Returns the task's id. | |
| PerceptualTaskType_t | getType () const |
| Returns the task type. | |
| void | setTaskStatus (TaskStatus_t) |
| virtual bool | taskIsComplete (const KoduWorld &) |
| Checks whether a task is complete. | |
Protected Attributes | |
| PerceptualTaskType_t | type |
| The type of perceptual task. | |
| unsigned int | id |
| The task's id. | |
| DualCoding::MapBuilderRequest | mapreq |
| The MapBuilder request the robot needs to perform. | |
| TaskStatus_t | taskStatus |
| The (current) status of a perceptual task. | |
Member Enumeration Documentation
Definition at line 28 of file PerceptualTaskBase.h.
Constructor & Destructor Documentation
| Kodu::PerceptualTaskBase::PerceptualTaskBase | ( | PerceptualTaskType_t | perceptTaskType, | |
| unsigned int | taskId | |||
| ) |
Constructor.
Definition at line 36 of file PerceptualTaskBase.h.
| Kodu::PerceptualTaskBase::PerceptualTaskBase | ( | const PerceptualTaskBase & | kTask | ) |
Copy constructor.
Definition at line 46 of file PerceptualTaskBase.h.
| virtual Kodu::PerceptualTaskBase::~PerceptualTaskBase | ( | ) | [virtual] |
Destructor.
Definition at line 54 of file PerceptualTaskBase.h.
Member Function Documentation
| virtual bool Kodu::PerceptualTaskBase::canExecute | ( | const KoduWorld & | ) | [pure virtual] |
Checks if a task can execute (reimplemented in all derived class).
Implemented in Kodu::VisualGripperMonitorTask, Kodu::VisualBumpDetectionTask, Kodu::VisualLocalizationTask, and Kodu::VisualNavErrMonTask.
| void Kodu::PerceptualTaskBase::examineTaskResults | ( | ) | [virtual] |
Examines the results from a task.
Reimplemented in Kodu::VisualGripperMonitorTask, Kodu::VisualBumpDetectionTask, and Kodu::VisualNavErrMonTask.
Definition at line 9 of file PerceptualTaskBase.cc.
Referenced by KoduInterpreter::PerceptualMultiplexor::MapBuilderTaskRunner::ExamineMapBuilderResults::doStart().
| const DualCoding::MapBuilderRequest & Kodu::PerceptualTaskBase::getMapBuilderRequest | ( | ) | [virtual] |
Returns the MapBuilder request the robot should perform.
Reimplemented in Kodu::VisualGripperMonitorTask, Kodu::VisualBumpDetectionTask, and Kodu::VisualNavErrMonTask.
Definition at line 14 of file PerceptualTaskBase.cc.
Referenced by KoduInterpreter::PerceptualMultiplexor::MapBuilderTaskRunner::ExecuteMapBuilderTask::doStart().
| virtual const DualCoding::PilotRequest Kodu::PerceptualTaskBase::getPilotRequest | ( | ) | [virtual] |
Returns the Pilot request the robot should perform.
Reimplemented in Kodu::VisualLocalizationTask.
Definition at line 79 of file PerceptualTaskBase.h.
Referenced by KoduInterpreter::PerceptualMultiplexor::PilotTaskRunner::ExecutePilotTask::doStart().
| PerceptualTaskBase::TaskStatus_t Kodu::PerceptualTaskBase::getStatus | ( | ) | const |
Returns the task's current status.
Definition at line 18 of file PerceptualTaskBase.cc.
| float Kodu::PerceptualTaskBase::getTaskId | ( | ) | const |
Returns the task's id.
Definition at line 22 of file PerceptualTaskBase.cc.
Referenced by KoduInterpreter::PerceptualMultiplexor::FailureRecovery::LocalizeAgent::CreateLocalizeTask::doStart(), and KoduInterpreter::PerceptualMultiplexor::MultiplexorEnd::doStart().
| PerceptualTaskType_t Kodu::PerceptualTaskBase::getType | ( | ) | const |
Returns the task type.
Definition at line 26 of file PerceptualTaskBase.cc.
Referenced by KoduInterpreter::PerceptualMultiplexor::FailureRecovery::LocalizeAgent::CreateLocalizeTask::doStart(), KoduInterpreter::PerceptualMultiplexor::FailureRecovery::StartRecovery::doStart(), and Kodu::VisualNavErrMonTask::getMapBuilderRequest().
| PerceptualTaskBase& Kodu::PerceptualTaskBase::operator= | ( | const PerceptualTaskBase & | kTask | ) |
Assignment operator.
Definition at line 59 of file PerceptualTaskBase.h.
| void Kodu::PerceptualTaskBase::setTaskStatus | ( | TaskStatus_t | newStatus | ) |
Definition at line 30 of file PerceptualTaskBase.cc.
Referenced by KoduInterpreter::PerceptualMultiplexor::PilotTaskRunner::SetTaskFailure::doStart(), and KoduInterpreter::PerceptualMultiplexor::PilotTaskRunner::SetTaskSuccess::doStart().
| bool Kodu::PerceptualTaskBase::taskIsComplete | ( | const KoduWorld & | kWorldState | ) | [virtual] |
Checks whether a task is complete.
Reimplemented in Kodu::VisualGripperMonitorTask, and Kodu::VisualNavErrMonTask.
Definition at line 34 of file PerceptualTaskBase.cc.
Member Data Documentation
unsigned int Kodu::PerceptualTaskBase::id [protected] |
The task's id.
Definition at line 97 of file PerceptualTaskBase.h.
Referenced by getTaskId(), and operator=().
The MapBuilder request the robot needs to perform.
Definition at line 98 of file PerceptualTaskBase.h.
Referenced by Kodu::VisualNavErrMonTask::getMapBuilderRequest(), Kodu::VisualBumpDetectionTask::getMapBuilderRequest(), getMapBuilderRequest(), Kodu::VisualGripperMonitorTask::getMapBuilderRequest(), and operator=().
TaskStatus_t Kodu::PerceptualTaskBase::taskStatus [protected] |
The (current) status of a perceptual task.
Definition at line 99 of file PerceptualTaskBase.h.
Referenced by Kodu::VisualBumpDetectionTask::examineTaskResults(), Kodu::VisualGripperMonitorTask::examineTaskResults(), Kodu::VisualLocalizationTask::getPilotRequest(), getStatus(), operator=(), setTaskStatus(), Kodu::VisualNavErrMonTask::taskIsComplete(), taskIsComplete(), and Kodu::VisualGripperMonitorTask::taskIsComplete().
PerceptualTaskType_t Kodu::PerceptualTaskBase::type [protected] |
The type of perceptual task.
Definition at line 96 of file PerceptualTaskBase.h.
Referenced by getType(), and operator=().
The documentation for this class was generated from the following files:
