Simulators::AcousticModem::Task Struct Reference

Public Member Functions
	Task (const std::string &name, Tasks::Context &ctx)
void	onResourceAcquisition (void)
void	onResourceRelease (void)
void	clearTicket (IMC::UamTxStatus::ValueEnum reason, const std::string &error="")
void	replaceTicket (const Ticket *ticket)
void	sendTxStatus (const Ticket &ticket, IMC::UamTxStatus::ValueEnum value, const std::string &error="")
void	consume (const IMC::UamTxFrame *msg)
void	consume (const IMC::SimAcousticMessage *amsg)
void	consume (const IMC::DevDataText *msg)
void	consume (const IMC::GpsFix *msg)
void	consume (const IMC::SimulatedState *msg)
void	rcvRxFrame (const IMC::SimAcousticMessage *amsg)
void	rcvRxRange (const IMC::SimAcousticMessage *amsg)
void	checkTimeout ()
void	onMain (void)

Public Attributes
Arguments	m_args
Ticket *	m_ticket
Time::Counter< double >	m_timeout
Driver *	m_driver
IMC::SimulatedState *	m_sstate

Constructor & Destructor Documentation

Task()

Simulators::AcousticModem::Task::Task ( const std::string &  name, Tasks::Context &  ctx  )

inline

Constructor.

Parameters

[in]	name	task name.
[in]	ctx	context.

References Simulators::AcousticModem::Arguments::driver_args, Simulators::AcousticModem::DriverArguments::dsize_peak_width, Simulators::AcousticModem::DriverArguments::dst_peak_width, Simulators::AcousticModem::DriverArguments::modem_type, Simulators::AcousticModem::DriverArguments::prng_seed, Simulators::AcousticModem::DriverArguments::prng_type, Simulators::AcousticModem::DriverArguments::tx_speed, Simulators::AcousticModem::DriverArguments::udp_maddr, and Simulators::AcousticModem::DriverArguments::udp_port.

Member Function Documentation

checkTimeout()

void Simulators::AcousticModem::Task::checkTimeout ( void  )

inline

Check timeout counter for overflow if there is an open transmission ticket.

References Simulators::AcousticModem::Ticket::ack.

clearTicket()

void Simulators::AcousticModem::Task::clearTicket ( IMC::UamTxStatus::ValueEnum  reason, const std::string &  error = ""  )

inline

Clear ticket and send status.

Parameters

[in]	reason	status to send.
[in]	error	error message, if available.

consume() [1/5]

void Simulators::AcousticModem::Task::consume ( const IMC::UamTxFrame *  msg )

inline

References Simulators::AcousticModem::Ticket::ack, Simulators::AcousticModem::Ticket::imc_eid, Simulators::AcousticModem::Ticket::imc_sid, Simulators::AcousticModem::Driver::isBusy(), Simulators::AcousticModem::Ticket::seq, and Simulators::AcousticModem::Driver::transmit().

consume() [2/5]

void Simulators::AcousticModem::Task::consume ( const IMC::SimAcousticMessage *  amsg )

inline

consume() [3/5]

void Simulators::AcousticModem::Task::consume ( const IMC::DevDataText *  msg )

inline

References Simulators::AcousticModem::Ticket::ack.

consume() [4/5]

void Simulators::AcousticModem::Task::consume ( const IMC::GpsFix *  msg )

inline

consume() [5/5]

void Simulators::AcousticModem::Task::consume ( const IMC::SimulatedState *  msg )

inline

onMain()

void Simulators::AcousticModem::Task::onMain ( void  )

inline

onResourceAcquisition()

void Simulators::AcousticModem::Task::onResourceAcquisition ( void  )

inline

Initialize resources.

References Simulators::AcousticModem::Arguments::driver_args.

onResourceRelease()

void Simulators::AcousticModem::Task::onResourceRelease ( void  )

inline

Release resources.

rcvRxFrame()

void Simulators::AcousticModem::Task::rcvRxFrame ( const IMC::SimAcousticMessage *  amsg )

inline

Parse SimAcousticMessage into UamRxFrame and send.

Parameters

[in]

amsg

SimAcousticMessage encapsulating UamRxFrame data.

rcvRxRange()

void Simulators::AcousticModem::Task::rcvRxRange ( const IMC::SimAcousticMessage *  amsg )

inline

Parse SimAcousticMessage into UamRxRange and send.

Parameters

[in]

amsg

SimAcousticMessage encapsulating UamRxRange data.

References Simulators::AcousticModem::Driver::distance().

replaceTicket()

void Simulators::AcousticModem::Task::replaceTicket ( const Ticket *  ticket )

inline

Replace current ticket.

Parameters

[in]	ticket	ticket to replae current.
[in]	reason	status to send.

sendTxStatus()

void Simulators::AcousticModem::Task::sendTxStatus ( const Ticket &  ticket, IMC::UamTxStatus::ValueEnum  value, const std::string &  error = ""  )

inline

Send status.

Parameters

[in]	ticket	ticket to return status.
[in]	value	status to send.
[in]	error	error message, if available.

References Simulators::AcousticModem::Ticket::imc_eid, Simulators::AcousticModem::Ticket::imc_sid, and Simulators::AcousticModem::Ticket::seq.

Member Data Documentation

m_args

Arguments Simulators::AcousticModem::Task::m_args

Task arguments.

m_driver

Driver* Simulators::AcousticModem::Task::m_driver

Modem driver handler.

m_sstate

IMC::SimulatedState* Simulators::AcousticModem::Task::m_sstate

Simulated state.

m_ticket

Ticket* Simulators::AcousticModem::Task::m_ticket

Current transmission ticket.

m_timeout

Time::Counter<double> Simulators::AcousticModem::Task::m_timeout

Timeout counter.

Collaboration diagram for Simulators::AcousticModem::Task: