DUNE: Uniform Navigational Environment
2.5.1
|
Public Member Functions | |
Task (const std::string &name, Tasks::Context &ctx) | |
void | onResourceAcquisition (void) |
void | onResourceRelease (void) |
void | onUpdateParameters (void) |
void | onResourceInitialization (void) |
bool | consumeResult (Results value) |
void | addResult (Results value) |
void | setAndSendState (EntityStates state) |
void | onEntityResolution (void) |
void | onReportEntityState (void) |
unsigned | channelToFrequency (unsigned channel) |
void | handleConfigParam (std::auto_ptr< NMEAReader > &stn) |
void | handleMiniPacket (std::auto_ptr< NMEAReader > &stn) |
void | handleTransponderTravelTimes (std::auto_ptr< NMEAReader > &stn) |
void | processInput (double timeout=c_cmd_reply_tout) |
void | ping (void) |
void | fullAcousticReport (void) |
void | consume (const IMC::LblConfig *msg) |
void | consume (const IMC::QueryEntityState *msg) |
void | consume (const IMC::SoundSpeed *msg) |
void | consume (const IMC::EstimatedState *msg) |
void | consume (const IMC::VehicleMedium *msg) |
void | consume (const IMC::PlanControlState *msg) |
void | consume (const IMC::FuelLevel *msg) |
void | reportRanges (double now) |
void | configureModem (const std::string &code, const std::string ¶meter, const unsigned value) |
void | sendDelayedCommand (const std::string &cmd, double delay_bef, double delay_aft) |
void | sendCommand (const std::string &cmd) |
void | logCommand (const std::string &cmd) |
void | onMain (void) |
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 |
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 |
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) |
State | getState (void) |
bool | isCreated (void) |
bool | isStopping (void) |
bool | isRunning (void) |
bool | isStarting (void) |
bool | isDead (void) |
Public Attributes | |
std::vector< Beacon > | m_beacons |
SerialPort * | m_uart |
IMC::LblRange | m_range |
IMC::LblDetection | m_detect |
IMC::EntityState | m_states [STA_MAX] |
IMC::DevDataText | m_cmds |
char | m_bfr [c_bfr_size] |
Arguments | m_args |
EntityStates | m_state |
unsigned | m_addr |
unsigned | m_result |
double | m_last_input |
double | m_sound_speed |
int | m_sound_speed_eid |
IMC::EstimatedState | m_estate |
Counter< double > | m_report_timer |
bool | m_stop_comms |
float | m_progress |
float | m_fuel_level |
float | m_fuel_conf |
Static Public Attributes | |
static const unsigned | c_plan_addr |
static const int | c_bfr_size |
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 | |
const char * | getEntityLabel (void) const |
void | setEntityLabel (const std::string &label) |
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) |
unsigned int | resolveEntity (const std::string &label) const |
std::string | resolveEntity (unsigned int id) const |
bool | stopping (void) |
bool | isActive (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 > | |
void | bind (T *task_obj, const std::vector< std::string > &list) |
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 void | onEntityReservation (void) |
virtual void | onRequestActivation (void) |
virtual void | onRequestDeactivation (void) |
virtual void | onActivation (void) |
virtual void | onDeactivation (void) |
Protected Member Functions inherited from DUNE::Concurrency::Thread | |
void | startImpl (void) |
void | stopImpl (void) |
void | joinImpl (void) |
void | setPriorityImpl (Scheduler::Policy policy, unsigned priority) |
Protected Attributes inherited from DUNE::Tasks::Task | |
Context & | m_ctx |
|
inline |
References DUNE::Tasks::Parameter::defaultValue(), DUNE::Tasks::Parameter::description(), Sensors::MLBL::Arguments::good_range_age, m_args, m_states, m_stop_comms, Sensors::MLBL::Arguments::mpk_delay_aft, Sensors::MLBL::Arguments::mpk_delay_bef, Sensors::MLBL::Arguments::only_underwater, DUNE::Tasks::Task::param(), DUNE::Tasks::Task::paramActive(), Sensors::MLBL::Arguments::ping_period, Sensors::MLBL::Arguments::ping_tout, Sensors::MLBL::Arguments::report, Sensors::MLBL::Arguments::report_delay_aft, Sensors::MLBL::Arguments::report_delay_bef, Sensors::MLBL::Arguments::report_period, Sensors::MLBL::Arguments::rx_length, Sensors::MLBL::Arguments::sound_speed_def, Sensors::MLBL::Arguments::sound_speed_elabel, Sensors::MLBL::STA_ACTIVE, Sensors::MLBL::STA_BOOT, Sensors::MLBL::STA_ERR_COM, Sensors::MLBL::STA_ERR_SRC, Sensors::MLBL::STA_ERR_STP, Sensors::MLBL::STA_IDLE, Sensors::MLBL::STA_NO_BEACONS, Sensors::MLBL::Arguments::turn_around_time, Sensors::MLBL::Arguments::tx_length, Sensors::MLBL::Arguments::uart_baud, Sensors::MLBL::Arguments::uart_dev, DUNE::Tasks::Parameter::units(), DUNE::Tasks::Parameter::values(), and DUNE::Tasks::Parameter::visibility().
|
inline |
References m_result.
Referenced by handleConfigParam(), handleTransponderTravelTimes(), and processInput().
|
inline |
Referenced by consume().
|
inline |
Configure a modem parameter.
[in] | code | NMEA code of the message to be transmitted. |
[in] | parameter | modem parameter to be configured. |
[in] | value | new configuration value. |
References processInput(), and sendCommand().
Referenced by onResourceInitialization().
|
inline |
References channelToFrequency(), Sensors::MLBL::Beacon::delay, Sensors::MLBL::Beacon::depth, DUNE::Tasks::Task::dispatch(), Sensors::MLBL::Beacon::id, DUNE::Tasks::Task::isActive(), Sensors::MLBL::Beacon::lat, Sensors::MLBL::Beacon::lon, m_args, m_beacons, m_state, Sensors::MLBL::Beacon::name, Sensors::MLBL::Beacon::ping_cmd, Sensors::MLBL::Arguments::ping_tout, Sensors::MLBL::Beacon::rx_channel, Sensors::MLBL::Beacon::rx_frequency, Sensors::MLBL::Arguments::rx_length, Sensors::MLBL::STA_ACTIVE, Sensors::MLBL::STA_ERR_COM, Sensors::MLBL::STA_ERR_SRC, Sensors::MLBL::STA_ERR_STP, Sensors::MLBL::STA_IDLE, Sensors::MLBL::Beacon::tx_channel, Sensors::MLBL::Beacon::tx_frequency, and Sensors::MLBL::Arguments::tx_length.
|
inline |
References onReportEntityState().
|
inline |
References m_sound_speed, and m_sound_speed_eid.
|
inline |
References m_estate.
|
inline |
References m_args, m_stop_comms, and Sensors::MLBL::Arguments::only_underwater.
|
inline |
References m_progress.
|
inline |
References m_fuel_conf, and m_fuel_level.
|
inline |
References m_result.
Referenced by handleMiniPacket(), onResourceInitialization(), ping(), and reportRanges().
|
inline |
References DUNE::Tasks::Task::consumeMessages(), Sensors::MLBL::Arguments::good_range_age, m_addr, m_args, m_beacons, m_estate, m_fuel_conf, m_fuel_level, m_progress, and sendCommand().
Referenced by onMain().
|
inline |
|
inline |
References c_plan_addr, consumeResult(), DUNE::Tasks::Task::dispatch(), DUNE::Tasks::Task::err(), DUNE::Tasks::Task::getSystemId(), DUNE::Tasks::Task::inf(), m_addr, m_args, Sensors::MLBL::Arguments::mpk_delay_aft, Sensors::MLBL::Arguments::mpk_delay_bef, Sensors::MLBL::RS_MPK_ACKD, Sensors::MLBL::RS_MPK_SENT, Sensors::MLBL::RS_MPK_STAR, sendDelayedCommand(), and DUNE::Tasks::Task::war().
Referenced by processInput().
|
inline |
References addResult(), DUNE::Tasks::Task::dispatch(), m_beacons, m_detect, m_range, m_sound_speed, Sensors::MLBL::RS_PNG_TIME, and DUNE::Tasks::Task::war().
Referenced by processInput().
|
inline |
Log NMEA message.
[in] | cmd | NMEA message to be logged. |
References DUNE::Tasks::Task::dispatch(), and m_cmds.
Referenced by sendCommand().
|
inlinevirtual |
Called when the task is instructed to resolve all the entity identifiers it needs for normal execution.
See resolveEntity(). Derived classes that need to resolve entity identifiers should override this function.
Reimplemented from DUNE::Tasks::Task.
References DUNE::Tasks::Task::inf(), m_args, m_sound_speed, m_sound_speed_eid, DUNE::Tasks::Task::resolveEntity(), Sensors::MLBL::Arguments::sound_speed_def, and Sensors::MLBL::Arguments::sound_speed_elabel.
|
inlinevirtual |
Implements DUNE::Tasks::Task.
References fullAcousticReport(), DUNE::Tasks::Task::isActive(), m_args, m_beacons, m_last_input, m_report_timer, m_state, m_stop_comms, DUNE::Time::Counter< T >::overflow(), ping(), processInput(), Sensors::MLBL::Arguments::report, reportRanges(), DUNE::Time::Counter< T >::reset(), Sensors::MLBL::STA_ERR_COM, DUNE::Tasks::Task::stopping(), and DUNE::Tasks::Task::waitForMessages().
|
inlinevirtual |
Called when the task is instructed to report the state of its entities.
Derived classes that need to report the state of entities other than the main entity should override this function to dispatch the EntityState of those entities.
Reimplemented from DUNE::Tasks::Task.
References DUNE::Tasks::Task::dispatch(), m_state, and m_states.
Referenced by consume().
|
inlinevirtual |
Called when the task is instructed to acquire resources whose configuration is defined by run-time parameters.
Reimplemented from DUNE::Tasks::Task.
References m_args, m_uart, setAndSendState(), Sensors::MLBL::STA_BOOT, Sensors::MLBL::Arguments::uart_baud, and Sensors::MLBL::Arguments::uart_dev.
|
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 DUNE::Tasks::Context::config, configureModem(), consumeResult(), DUNE::Parsers::Config::get(), DUNE::Tasks::Task::getSystemName(), m_addr, m_args, m_beacons, DUNE::Tasks::Task::m_ctx, m_state, m_states, Sensors::MLBL::RS_CTO_ACKD, Sensors::MLBL::RS_NRV_ACKD, Sensors::MLBL::RS_SRC_ACKD, Sensors::MLBL::RS_TAT_ACKD, Sensors::MLBL::RS_XST_ACKD, setAndSendState(), Sensors::MLBL::STA_ERR_SRC, Sensors::MLBL::STA_ERR_STP, Sensors::MLBL::STA_IDLE, Sensors::MLBL::STA_NO_BEACONS, and Sensors::MLBL::Arguments::turn_around_time.
|
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.
References m_uart.
|
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 m_args, m_report_timer, m_sound_speed, Sensors::MLBL::Arguments::report_period, DUNE::Time::Counter< T >::setTop(), and Sensors::MLBL::Arguments::sound_speed_def.
|
inline |
References consumeResult(), m_args, m_beacons, m_state, Sensors::MLBL::Arguments::ping_period, Sensors::MLBL::Arguments::ping_tout, processInput(), Sensors::MLBL::RS_PNG_ACKD, Sensors::MLBL::RS_PNG_TIME, Sensors::MLBL::Arguments::rx_length, sendCommand(), Sensors::MLBL::STA_ACTIVE, Sensors::MLBL::Arguments::tx_length, and DUNE::Tasks::Task::war().
Referenced by onMain().
|
inline |
References addResult(), c_bfr_size, DUNE::Tasks::Task::consumeMessages(), DUNE::Tasks::Task::dispatch(), DUNE::Tasks::Task::err(), handleConfigParam(), handleMiniPacket(), handleTransponderTravelTimes(), DUNE::Tasks::Task::isActive(), m_bfr, m_cmds, m_last_input, m_state, m_uart, Sensors::MLBL::RS_MPK_ACKD, Sensors::MLBL::RS_MPK_SENT, Sensors::MLBL::RS_MPK_STAR, Sensors::MLBL::RS_PNG_ACKD, Sensors::MLBL::STA_ACTIVE, Sensors::MLBL::STA_IDLE, and Sensors::MLBL::STA_NO_BEACONS.
Referenced by configureModem(), onMain(), ping(), reportRanges(), and sendDelayedCommand().
|
inline |
References consumeResult(), DUNE::Tasks::Task::debug(), Sensors::MLBL::Arguments::good_range_age, m_addr, m_args, m_beacons, Sensors::MLBL::Arguments::mpk_delay_aft, Sensors::MLBL::Arguments::mpk_delay_bef, processInput(), Sensors::MLBL::Arguments::report_delay_aft, Sensors::MLBL::Arguments::report_delay_bef, Sensors::MLBL::RS_MPK_ACKD, Sensors::MLBL::RS_MPK_SENT, Sensors::MLBL::RS_MPK_STAR, and sendDelayedCommand().
Referenced by onMain().
|
inline |
Send command to modem and log it.
[in] | cmd | NMEA message to be transmitted. |
References logCommand(), and m_uart.
Referenced by configureModem(), fullAcousticReport(), ping(), and sendDelayedCommand().
|
inline |
Send a command to the modem processing input before and after.
[in] | cmd | NMEA message to be transmitted. |
[in] | delay_bef | time to process input from modem before. |
[in] | delay_aft | time to process input from modem after. |
References processInput(), and sendCommand().
Referenced by handleMiniPacket(), and reportRanges().
|
inline |
References DUNE::Tasks::Task::dispatch(), m_state, and m_states.
Referenced by onResourceAcquisition(), and onResourceInitialization().
|
static |
Referenced by processInput().
|
static |
Referenced by handleMiniPacket().
unsigned Sensors::MLBL::Task::m_addr |
Referenced by fullAcousticReport(), handleConfigParam(), handleMiniPacket(), onResourceInitialization(), and reportRanges().
Arguments Sensors::MLBL::Task::m_args |
std::vector<Beacon> Sensors::MLBL::Task::m_beacons |
Referenced by consume(), fullAcousticReport(), handleTransponderTravelTimes(), onMain(), onResourceInitialization(), ping(), and reportRanges().
char Sensors::MLBL::Task::m_bfr[c_bfr_size] |
Referenced by processInput().
IMC::DevDataText Sensors::MLBL::Task::m_cmds |
Referenced by logCommand(), and processInput().
IMC::LblDetection Sensors::MLBL::Task::m_detect |
Referenced by handleTransponderTravelTimes().
IMC::EstimatedState Sensors::MLBL::Task::m_estate |
Referenced by consume(), and fullAcousticReport().
float Sensors::MLBL::Task::m_fuel_conf |
Last fuel level confidence.
Referenced by consume(), and fullAcousticReport().
float Sensors::MLBL::Task::m_fuel_level |
Last fuel level.
Referenced by consume(), and fullAcousticReport().
double Sensors::MLBL::Task::m_last_input |
Referenced by onMain(), and processInput().
float Sensors::MLBL::Task::m_progress |
Last progress.
Referenced by consume(), and fullAcousticReport().
IMC::LblRange Sensors::MLBL::Task::m_range |
Referenced by handleTransponderTravelTimes().
Counter<double> Sensors::MLBL::Task::m_report_timer |
Report timer.
Referenced by onMain(), and onUpdateParameters().
unsigned Sensors::MLBL::Task::m_result |
Referenced by addResult(), and consumeResult().
double Sensors::MLBL::Task::m_sound_speed |
Referenced by consume(), handleTransponderTravelTimes(), onEntityResolution(), and onUpdateParameters().
int Sensors::MLBL::Task::m_sound_speed_eid |
Sound speed entity id.
Referenced by consume(), and onEntityResolution().
EntityStates Sensors::MLBL::Task::m_state |
Referenced by consume(), onMain(), onReportEntityState(), onResourceInitialization(), ping(), processInput(), and setAndSendState().
IMC::EntityState Sensors::MLBL::Task::m_states[STA_MAX] |
Referenced by onReportEntityState(), onResourceInitialization(), setAndSendState(), and Task().
bool Sensors::MLBL::Task::m_stop_comms |
SerialPort* Sensors::MLBL::Task::m_uart |
Referenced by onResourceAcquisition(), onResourceRelease(), processInput(), and sendCommand().