DUNE: Uniform Navigational Environment  2019.02.0
Supervisors::Reporter::Client Class Reference

Detailed Description

This class is a client-side API to use reporter supervisor.

Author
José Braga

Public Member Functions

 Client (Tasks::Task *task, CommInterface interface, float time=0.0, bool wait_ack=false)
 
void consume (const IMC::ReportControl *msg)
 
bool trigger (std::string *destination=NULL)
 
bool ack (const std::string destination="")
 

Constructor & Destructor Documentation

Supervisors::Reporter::Client::Client ( Tasks::Task task,
CommInterface  interface,
float  time = 0.0,
bool  wait_ack = false 
)
inline

Constructor.

Member Function Documentation

bool Supervisors::Reporter::Client::ack ( const std::string  destination = "")
inline

Call this function to acknowledge that report was sent.

Parameters
[in]destinationdestination system.
Returns
true if there acknowledge was sent, false otherwise.

Referenced by Sensors::MLBL::Task::fullAcousticReport(), and Sensors::MLBL::Task::reportRanges().

bool Supervisors::Reporter::Client::trigger ( std::string *  destination = NULL)
inline

Call this function to see if there are reports to be sent.

Parameters
[out]destinationdestination system.
Returns
true if there are reports to be sent, false otherwise.

Referenced by Transports::UAN::Task::onMain(), Sensors::MLBL::Task::onMain(), Transports::Radio::Task::radioReport(), and Monitors::Emergency::Task::sendScheduled().

Collaboration diagram for Supervisors::Reporter::Client:
Collaboration graph