Class execution_metrics

Inheritance Relationships

Base Type

  • public rmetrics::base_metrics

Derived Type

Class Documentation

class execution_metrics : public virtual rmetrics::base_metrics

Interface defining metrics that can be collected on tasks as they are executed.

Subclassed by cosm::ta::executable_task

Public Functions

execution_metrics(void) = default
~execution_metrics(void) override = default
virtual bool task_aborted(void) const = 0

This function should return TRUE iff the task has been aborted (not completed), and only on the timestep on which it has done so.

virtual bool task_at_interface(void) const = 0

If TRUE, then the robot is currently at a task interface for this task.

virtual bool task_completed(void) const = 0

This function should return TRUE iff when the task has been completed (not aborted), and only on the timestep on which it has done so.

virtual const ta::time_estimate &task_exec_estimate(void) const = 0

Return the current execution time estimate for a task. Execution estimate should include interface time.

virtual const ta::time_estimate &task_interface_estimate(size_t i) const = 0

Return the current interface time estimate for interface i for a task.

virtual int task_last_active_interface(void) const = 0
virtual rtypes::timestep task_last_exec_time(void) const = 0

This function should return the execution time of the most recent execution of this task. Execution time includes interface time.

virtual rtypes::timestep task_last_interface_time(size_t i) const = 0

This function should return the interface time of the most recent interface time for the task.