Class nest_zone_metrics

Defined in File nest_zone_metrics.hpp

Inheritance Relationships

Base Type

public rmetrics::base_metrics

Derived Type

public cosm::spatial::fsm::util_hfsm (Class util_hfsm)

Class Documentation

class nest_zone_metrics : public virtual rmetrics::base_metrics

Metrics to be collected about robots as the enter/exit/move in the nest.

Subclassed by cosm::spatial::fsm::util_hfsm

Public Functions

nest_zone_metrics(const nest_zone_metrics&) = delete

nest_zone_metrics(nest_zone_metrics&&) = delete

nest_zone_metrics(void) = default

~nest_zone_metrics(void) override = default

virtual bool entered_nest(void) const = 0: If TRUE, then a robot has just begun entered the nest. This should return FALSE on all subsequent steps the robot is in the nest.

virtual bool exited_nest(void) const = 0: If TRUE, then a robot has just exited the nest. This should return FALSE on all previous steps the robot is in the nest, and all steps afterwards.

virtual bool in_nest(void) const = 0: If TRUE, then a robot is currently in the nest.

virtual rtypes::timestep nest_duration(void) const = 0: If exited_nest() returns TRUE, then this should return the # timesteps the robot was in the nest.

virtual rtypes::timestep nest_entry_time(void) const = 0: If entered_nest() returns TRUE, then this should return the current timestep.

nest_zone_metrics &operator=(const nest_zone_metrics&) = delete

nest_zone_metrics &operator=(nest_zone_metrics&&) = delete