DUNE: Uniform Navigational Environment  2019.02.0
Sensors::DataStore::Task Struct Reference

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onUpdateParameters (void)
 
void onEntityResolution (void)
 
void onResourceInitialization (void)
 
void consume (const IMC::EstimatedState *msg)
 
void consume (const IMC::Temperature *msg)
 
void consume (const IMC::Conductivity *msg)
 
void consume (const IMC::LogBookEntry *msg)
 
void consume (const IMC::PlanControl *msg)
 
void consume (const IMC::SonarData *msg)
 
void sendHistoricMessages ()
 
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
 
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

Arguments m_args
 
IMC::EstimatedState m_state
 
IMC::HistoricCTD m_ctd
 
IMC::HistoricSonarData m_sonar
 
Time::Counter< fp64_t > m_ctd_counter
 
Time::Counter< fp64_t > m_sss_counter
 
Time::Counter< fp64_t > m_tel_counter
 
int m_ctd_entity
 
bool m_got_ctd
 

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::BasicEntitygetLocalEntity (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 >
Parameterparam (const std::string &name, T &var)
 
template<typename Y , typename T >
Parameterparam (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 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 onReportEntityState (void)
 
virtual void onResourceAcquisition (void)
 
virtual void onResourceRelease (void)
 
virtual void onRequestActivation (void)
 
virtual void onRequestDeactivation (void)
 
virtual void onActivation (void)
 
virtual void onDeactivation (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
Contextm_ctx
 
std::vector
< Entities::BasicEntity * > 
m_entities
 

Constructor & Destructor Documentation

Member Function Documentation

void Sensors::DataStore::Task::consume ( const IMC::EstimatedState *  msg)
inline

References m_state.

void Sensors::DataStore::Task::consume ( const IMC::Temperature *  msg)
inline

References m_ctd, m_ctd_entity, and m_got_ctd.

void Sensors::DataStore::Task::consume ( const IMC::Conductivity *  msg)
inline

References m_ctd, m_ctd_entity, and m_got_ctd.

void Sensors::DataStore::Task::consume ( const IMC::LogBookEntry *  msg)
inline
void Sensors::DataStore::Task::consume ( const IMC::SonarData *  msg)
inline
void Sensors::DataStore::Task::onEntityResolution ( void  )
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 Sensors::DataStore::Arguments::ctd_label, DUNE::Tasks::Context::entities, m_args, m_ctd_entity, DUNE::Tasks::Task::m_ctx, DUNE::Entities::EntityDataBase::resolve(), and DUNE::Tasks::Task::war().

void Sensors::DataStore::Task::onMain ( void  )
inlinevirtual
void Sensors::DataStore::Task::onResourceInitialization ( void  )
inlinevirtual

On resource initialization.

Reimplemented from DUNE::Tasks::Task.

References DUNE::Tasks::Task::setEntityState().

void Sensors::DataStore::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 Sensors::DataStore::Arguments::ctd_period, Sensors::DataStore::Arguments::log_events, m_args, m_ctd_counter, m_sss_counter, m_tel_counter, DUNE::Tasks::Task::setEntityState(), Sensors::DataStore::Arguments::sss_period, and Sensors::DataStore::Arguments::telemetry_period.

Member Data Documentation

Arguments Sensors::DataStore::Task::m_args
IMC::HistoricCTD Sensors::DataStore::Task::m_ctd

Referenced by consume(), and sendHistoricMessages().

Time::Counter<fp64_t> Sensors::DataStore::Task::m_ctd_counter
int Sensors::DataStore::Task::m_ctd_entity

Referenced by consume(), and onEntityResolution().

bool Sensors::DataStore::Task::m_got_ctd

Referenced by consume(), and sendHistoricMessages().

IMC::HistoricSonarData Sensors::DataStore::Task::m_sonar
Time::Counter<fp64_t> Sensors::DataStore::Task::m_sss_counter
IMC::EstimatedState Sensors::DataStore::Task::m_state

Referenced by consume(), and sendHistoricMessages().

Time::Counter<fp64_t> Sensors::DataStore::Task::m_tel_counter
Collaboration diagram for Sensors::DataStore::Task:
Collaboration graph