HiveMind
Public Member Functions | List of all members
IInterloc Class Referenceabstract

#include <IInterloc.h>

Inheritance diagram for IInterloc:
Inheritance graph
Collaboration diagram for IInterloc:
Collaboration graph

Public Member Functions

virtual std::optional< RelativePositiongetRobotPosition (uint16_t robotId) const =0
 Returns the last known relative position of a given robot. More...
 
virtual bool isLineOfSight (uint16_t robotId) const =0
 Tells if a robot is in line of sight. More...
 
virtual const PositionsTablegetPositionsTable () const =0
 Returns the position table for all robots in the swarm. More...
 
virtual void process ()=0
 Spins the interloc task checking if any updates happened. Processing them and pushing update values to the output queue. More...
 

Member Function Documentation

◆ getPositionsTable()

virtual const PositionsTable& IInterloc::getPositionsTable ( ) const
pure virtual

Returns the position table for all robots in the swarm.

Returns
The position table

Implemented in Interloc.

Here is the caller graph for this function:

◆ getRobotPosition()

virtual std::optional<RelativePosition> IInterloc::getRobotPosition ( uint16_t  robotId) const
pure virtual

Returns the last known relative position of a given robot.

Parameters
robotIdThe ID of the robot to get the position
Returns
The relative position of the robot

Implemented in Interloc.

Here is the caller graph for this function:

◆ isLineOfSight()

virtual bool IInterloc::isLineOfSight ( uint16_t  robotId) const
pure virtual

Tells if a robot is in line of sight.

Parameters
robotIdThe ID of the robot to get
Returns
Is in line of sight

Implemented in Interloc.

◆ process()

virtual void IInterloc::process ( )
pure virtual

Spins the interloc task checking if any updates happened. Processing them and pushing update values to the output queue.

Implemented in Interloc.

Here is the caller graph for this function:

The documentation for this class was generated from the following file: