Class block_transportee_metrics

Inheritance Relationships

Base Type

  • public rmetrics::base_metrics

Class Documentation

class block_transportee_metrics : public rmetrics::base_metrics

Defines the metrics to be collected from crepr::sim_block3D objects and their derived classes about the process of transportation from their original location in the arena after distribution to their final destination (nest, structure, etc).

Metrics should be collected upon deposition at the block’s final location, rather than every timestep.

Public Functions

block_transportee_metrics(void) = default
virtual rtypes::timestep initial_wait_time(void) const = 0

Return the amount of time that the block sits in the arena after being distributed but before it is picked up for the first time.

virtual rtypes::timestep total_transport_time(void) const = 0

Return the total amount of time that it took from the first pickup to when the block was deposited at its final destination.

virtual size_t total_transporters(void) const = 0

Return the total # of robots that have carried the block since it was originally distributed in the arena until it arrives at its final destination.

virtual crepr::block_type type(void) const = 0

Return the type of the block block_transported.