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]

destination

destination system.

Returns

true if there acknowledge was sent, false otherwise.

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

void Supervisors::Reporter::Client::consume ( const IMC::ReportControl *  msg )

inline

Consume report messages.

Parameters

[in]

msg

ReportControl message.

References DUNE::IMC::ReportControl::comm_interface, DUNE::IMC::ReportControl::op, DUNE::IMC::ReportControl::OP_REPORT_SENT, DUNE::IMC::ReportControl::OP_REQUEST_REPORT, and DUNE::IMC::ReportControl::sys_dst.

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

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

inline

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

Parameters

[out]

destination

destination 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: