Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)

void	onUpdateParameters (void)

void	onResourceRelease (void)

void	onResourceAcquisition (void)

void	onResourceInitialization (void)

void	onActivation (void)

void	onDeactivation (void)

void	consume (const IMC::GpsFix *msg)

void	consume (const IMC::ReportControl *msg)

void	consume (const IMC::TextMessage *msg)

void	consume (const IMC::Abort *msg)

void	consume (const IMC::Heartbeat *msg)

void	consume (const IMC::FuelLevel *msg)

void	consume (const IMC::Voltage *msg)

void	consume (const IMC::PlanControlState *msg)

void	consume (const IMC::VehicleMedium *msg)

void	consume (const IMC::VehicleState *msg)

char	vehicleStateChar (const uint8_t vstate)

void	sendSMS (const char *prefix, unsigned timeout, std::string recipient="")

void	sendScheduled (void)

void	sendDistress (void)

void	task (void)

Public Member Functions inherited from DUNE::Tasks::Periodic
	Periodic (const std::string &name, Context &ctx)

virtual	~Periodic (void)

void	setFrequency (double freq)

double	getFrequency (void) const

double	getRunTime (void) const

unsigned	getRunCount (void) const

Public Member Functions inherited from DUNE::Tasks::Task
	Task (const std::string &name, Context &context)

virtual	~Task (void)

const char *	getName (void) const

const char *	getSystemName (void) const

unsigned int	getSystemId (void) const

unsigned int	getEntityId (void) const

unsigned int	resolveEntity (const std::string &label) const

std::string	resolveEntity (unsigned int id) const

DebugLevel	getDebugLevel (void) const

uint16_t	getActivationTime (void) const

uint16_t	getDeactivationTime (void) const

unsigned int	resolveSystemName (const std::string &name) const

const char *	resolveSystemId (unsigned int id) const

void	loadConfig (void)

void	setPriority (unsigned int value)

unsigned int	getPriority (void) const

void	inf (const char *format,...) DUNE_PRINTF_FORMAT(2

void void	war (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void	err (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void	cri (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void	debug (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void	trace (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void void	spew (const char *format,...) DUNE_PRINTF_FORMAT(2

void void void void void void void void	dispatch (IMC::Message *msg, unsigned int flags=0)

void	dispatch (IMC::Message &msg, unsigned int flags=0)

void	dispatchReply (const IMC::Message &original, IMC::Message &msg, unsigned int flags=0)

void	receive (const IMC::Message *msg)

void	reserveEntities (void)

void	resolveEntities (void)

void	acquireResources (void)

void	releaseResources (void)

void	initializeResources (void)

void	updateParameters (bool act_deact=true)

void	writeParamsXML (std::ostream &os) const

const char *	getEntityLabel (void) const

void	setEntityLabel (const std::string &label)

Public Member Functions inherited from DUNE::Tasks::AbstractTask
	AbstractTask (void)

virtual	~AbstractTask (void)

Public Member Functions inherited from DUNE::Concurrency::Thread
	Thread (void)

virtual	~Thread (void)

int	getProcessorUsage (void)

Public Member Functions inherited from DUNE::Concurrency::Runnable
	Runnable (void)

virtual	~Runnable (void)

void	start (void)

void	stop (void)

void	join (void)

void	stopAndJoin (void)

void	setPriority (Scheduler::Policy policy, unsigned priority)

unsigned	getPriority (void)

State	getState (void)

bool	isCreated (void)

bool	isStopping (void)

bool	isRunning (void)

bool	isStarting (void)

bool	isDead (void)

Public Attributes
std::string	m_emsg

float	m_fuel

float	m_fuel_conf

float	m_bat_voltage

bool	m_in_mission

float	m_progress

unsigned	m_req

uint8_t	m_vstate

Counter< double >	m_lost_coms_timer

DUNE::Monitors::MediumHandler	m_hand

Supervisors::Reporter::Client *	m_reporter

Arguments	m_args

Additional Inherited Members
Public Types inherited from DUNE::Concurrency::Runnable
enum	State { StateStarting, StateRunning, StateStopping, StateDead, StateUnknown }

Protected Member Functions inherited from DUNE::Tasks::Task
void	setEntityState (IMC::EntityState::StateEnum state, Status::Code code)

void	setEntityState (IMC::EntityState::StateEnum state, const std::string &description)

IMC::EntityState::StateEnum	getEntityState (void) const

unsigned int	reserveEntity (const std::string &label)

template<typename E >
E *	reserveEntity (const std::string &label)

Entities::BasicEntity *	getLocalEntity (const std::string &label)

bool	stopping (void)

bool	isActive (void) const

bool	isActivating (void) const

bool	isDeactivating (void) const

void	waitForMessages (double timeout)

void	consumeMessages (void)

template<typename T >
Parameter &	param (const std::string &name, T &var)

template<typename Y , typename T >
Parameter &	param (const std::string &name, T &var)

template<typename T >
bool	paramChanged (T &var)

void	paramActive (Parameter::Scope def_scope, Parameter::Visibility def_visibility, bool def_value=false)

void	setParamSectionEditor (const std::string &name)

template<typename M , typename T >
void	bind (T task_obj, void(T::consumer)(const M *)=&T::consume)

template<typename T >
void	bind (T *task_obj, const std::vector< uint32_t > &list)

template<typename T , typename M >
void	bind (T task_obj, const std::vector< uint32_t > &list, void(T::consumer)(const M *)=&T::consume)

template<typename T >
void	bind (T *task_obj, const std::vector< std::string > &list)

void	bind (unsigned int message_id, AbstractConsumer *consumer)

void	requestActivation (void)

void	requestDeactivation (void)

void	activate (void)

void	activationFailed (const std::string &reason)

void	deactivate (void)

void	deactivationFailed (const std::string &reason)

virtual bool	onWriteParamsXML (std::ostream &os) const

virtual void	onEntityReservation (void)

virtual void	onEntityResolution (void)

virtual void	onReportEntityState (void)

virtual void	onRequestActivation (void)

virtual void	onRequestDeactivation (void)

virtual void	onQueryEntityParameters (const IMC::QueryEntityParameters *msg)

virtual void	onSetEntityParameters (const IMC::SetEntityParameters *msg)

virtual void	onPushEntityParameters (const IMC::PushEntityParameters *msg)

virtual void	onPopEntityParameters (const IMC::PopEntityParameters *msg)

Protected Member Functions inherited from DUNE::Concurrency::Thread
void	startImpl (void)

void	stopImpl (void)

void	joinImpl (void)

void	setPriorityImpl (Scheduler::Policy policy, unsigned priority)

unsigned	getPriorityImpl (void)

Protected Attributes inherited from DUNE::Tasks::Task
Context &	m_ctx

std::vector< Entities::BasicEntity * >	m_entities

Constructor & Destructor Documentation

◆ Task()

Monitors::Emergency::Task::Task	(	const std::string &	name,
		Tasks::Context &	ctx
	)

inline

References Monitors::Emergency::Arguments::heartbeat_tout, Monitors::Emergency::Arguments::interface, Monitors::Emergency::Arguments::recipient, Monitors::Emergency::Arguments::sms_abort_ttl, and Monitors::Emergency::Arguments::sms_lost_coms_ttl.

Member Function Documentation

◆ consume() [1/10]

void Monitors::Emergency::Task::consume ( const IMC::GpsFix * msg )

inline

◆ consume() [2/10]

void Monitors::Emergency::Task::consume ( const IMC::ReportControl * msg )

inline

References Supervisors::Reporter::Client::consume().

◆ consume() [3/10]

void Monitors::Emergency::Task::consume ( const IMC::TextMessage * msg )

inline

References Monitors::Emergency::Arguments::sms_lost_coms_ttl.

◆ consume() [4/10]

void Monitors::Emergency::Task::consume ( const IMC::Abort * msg )

inline

References Monitors::Emergency::Arguments::sms_abort_ttl.

◆ consume() [5/10]

void Monitors::Emergency::Task::consume ( const IMC::Heartbeat * msg )

inline

◆ consume() [6/10]

void Monitors::Emergency::Task::consume ( const IMC::FuelLevel * msg )

inline

◆ consume() [7/10]

void Monitors::Emergency::Task::consume ( const IMC::Voltage * msg )

inline

◆ consume() [8/10]

void Monitors::Emergency::Task::consume ( const IMC::PlanControlState * msg )

inline

◆ consume() [9/10]

void Monitors::Emergency::Task::consume ( const IMC::VehicleMedium * msg )

inline

References DUNE::Monitors::MediumHandler::isUnderwater(), and DUNE::Monitors::MediumHandler::update().

◆ consume() [10/10]

void Monitors::Emergency::Task::consume ( const IMC::VehicleState * msg )

inline

◆ onActivation()

void Monitors::Emergency::Task::onActivation ( void )

inlinevirtual

Called when the task starts/resumes normal execution.

Reimplemented from DUNE::Tasks::Task.

◆ onDeactivation()

void Monitors::Emergency::Task::onDeactivation ( void )

inlinevirtual

Called when the task stops normal execution and enters an idleness state.

Reimplemented from DUNE::Tasks::Task.

◆ onResourceAcquisition()

void Monitors::Emergency::Task::onResourceAcquisition ( void )

inlinevirtual

Called when the task is instructed to acquire resources whose configuration is defined by run-time parameters.

Reimplemented from DUNE::Tasks::Task.

References Supervisors::Reporter::IS_GSM.

◆ onResourceInitialization()

void Monitors::Emergency::Task::onResourceInitialization ( void )

inlinevirtual

Called when the task is instructed to initialize resources acquired previously or whose initialization depends on run-time parameters.

Reimplemented from DUNE::Tasks::Task.

References Monitors::Emergency::Arguments::heartbeat_tout.

◆ onResourceRelease()

void Monitors::Emergency::Task::onResourceRelease ( void )

inlinevirtual

Called when the task is instructed to release resources.

Derived classes that override this function must not assume that any resource was previously acquired. This function must be implemented in such a way that it can be called at any time.

Reimplemented from DUNE::Tasks::Task.

◆ onUpdateParameters()

void Monitors::Emergency::Task::onUpdateParameters ( void )

inlinevirtual

Called when the task is instructed to update its run-time parameters.

Derived classes that need to compute auxiliary values based on run-time parameters should override this function.

Reimplemented from DUNE::Tasks::Task.

References Monitors::Emergency::Arguments::heartbeat_tout.

◆ sendDistress()

void Monitors::Emergency::Task::sendDistress ( void )

inline

Send distress messages if active and not underwater, or, if not executing mission and waiting at water surface.

References DUNE::Monitors::MediumHandler::isUnderwater(), DUNE::Monitors::MediumHandler::isWaterSurface(), and Monitors::Emergency::Arguments::sms_lost_coms_ttl.

◆ sendScheduled()

void Monitors::Emergency::Task::sendScheduled ( void )

inline

Send all scheduled reports.

References DUNE::Monitors::MediumHandler::isUnderwater(), Monitors::Emergency::Arguments::recipient, Monitors::Emergency::Arguments::sms_lost_coms_ttl, and Supervisors::Reporter::Client::trigger().

◆ sendSMS()

void Monitors::Emergency::Task::sendSMS	(	const char *	prefix,
		unsigned	timeout,
		std::string	recipient = `""`
	)

inline

Send SMS request.

Parameters

[in]	prefix	message prefix.
[in]	timeout	time to live.
[in]	recipient	destination recipient.

References Monitors::Emergency::Arguments::interface, and Monitors::Emergency::Arguments::recipient.

◆ task()

void Monitors::Emergency::Task::task ( void )

inlinevirtual

The task to be executed on each cycle.

Implements DUNE::Tasks::Periodic.

◆ vehicleStateChar()

char Monitors::Emergency::Task::vehicleStateChar ( const uint8_t vstate )

inline

Member Data Documentation

◆ m_args

Arguments Monitors::Emergency::Task::m_args

Task arguments.

◆ m_bat_voltage

float Monitors::Emergency::Task::m_bat_voltage

Batteries voltage.

◆ m_emsg

std::string Monitors::Emergency::Task::m_emsg

Emergency message.

◆ m_fuel

float Monitors::Emergency::Task::m_fuel

Fuel level.

◆ m_fuel_conf

float Monitors::Emergency::Task::m_fuel_conf

Confidence in fuel level.

◆ m_hand

DUNE::Monitors::MediumHandler Monitors::Emergency::Task::m_hand

Medium handler.

◆ m_in_mission

bool Monitors::Emergency::Task::m_in_mission

True if executing plan.

◆ m_lost_coms_timer

Counter<double> Monitors::Emergency::Task::m_lost_coms_timer

Lost communications timer.

◆ m_progress

float Monitors::Emergency::Task::m_progress

Executing plan's progress.

◆ m_reporter

Supervisors::Reporter::Client* Monitors::Emergency::Task::m_reporter

Reporter API.

◆ m_req

unsigned Monitors::Emergency::Task::m_req

Iridium request identifier.

◆ m_vstate

uint8_t Monitors::Emergency::Task::m_vstate

Vehicle State.

Collaboration diagram for Monitors::Emergency::Task:

Public Member Functions

Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ Task()

Member Function Documentation

◆ consume() [1/10]

◆ consume() [2/10]

◆ consume() [3/10]

◆ consume() [4/10]

◆ consume() [5/10]

◆ consume() [6/10]

◆ consume() [7/10]

◆ consume() [8/10]

◆ consume() [9/10]

◆ consume() [10/10]

◆ onActivation()

◆ onDeactivation()

◆ onResourceAcquisition()

◆ onResourceInitialization()

◆ onResourceRelease()

◆ onUpdateParameters()

◆ sendDistress()

◆ sendScheduled()

◆ sendSMS()

◆ task()

◆ vehicleStateChar()

Member Data Documentation

◆ m_args

◆ m_bat_voltage

◆ m_emsg

◆ m_fuel

◆ m_fuel_conf

◆ m_hand

◆ m_in_mission

◆ m_lost_coms_timer

◆ m_progress

◆ m_reporter

◆ m_req

◆ m_vstate