DUNE: Uniform Navigational Environment  2019.02.0
Transports::CommManager::Task Struct Reference

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onUpdateParameters (void)
 
void consume (const IMC::PlanControlState *msg)
 
void consume (const IMC::FuelLevel *msg)
 
void consume (const IMC::EstimatedState *msg)
 
void consume (const IMC::VehicleState *msg)
 
void consume (const IMC::VehicleMedium *msg)
 
void consume (const IMC::PlanSpecification *msg)
 
void sendViaSatellite (const IMC::TransmissionRequest *msg)
 
void sendViaSms (const IMC::TransmissionRequest *msg)
 
void clearTimeouts ()
 
void consume (const IMC::IridiumTxStatus *msg)
 
void consume (const IMC::SmsStatus *msg)
 
void answer (const IMC::TransmissionRequest *req, std::string info, int status)
 
void consume (const IMC::TransmissionRequest *msg)
 
void onResourceRelease (void)
 
void onResourceInitialization (void)
 
IMC::StateReport * produceReport ()
 
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::PlanControlState * m_pstate
 
IMC::FuelLevel * m_fuel
 
IMC::EstimatedState * m_estate
 
IMC::VehicleState * m_vstate
 
IMC::VehicleMedium * m_vmedium
 
Time::Counter< float > m_iridium_timer
 
Time::Counter< float > m_clean_timer
 
int m_plan_chksum
 
int m_reqid
 
std::map< int,
IMC::TransmissionRequest * > 
m_transmission_requests
 

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 onEntityResolution (void)
 
virtual void onReportEntityState (void)
 
virtual void onResourceAcquisition (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

Transports::CommManager::Task::Task ( const std::string &  name,
Tasks::Context &  ctx 
)
inline

Member Function Documentation

void Transports::CommManager::Task::answer ( const IMC::TransmissionRequest *  req,
std::string  info,
int  status 
)
inline
void Transports::CommManager::Task::clearTimeouts ( )
inline

References answer(), and m_transmission_requests.

Referenced by onMain().

void Transports::CommManager::Task::consume ( const IMC::PlanControlState *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::FuelLevel *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::EstimatedState *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::VehicleState *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::VehicleMedium *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::PlanSpecification *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::IridiumTxStatus *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::SmsStatus *  msg)
inline
void Transports::CommManager::Task::consume ( const IMC::TransmissionRequest *  msg)
inline
void Transports::CommManager::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 DUNE::Tasks::Task::setEntityState().

void Transports::CommManager::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.

References m_estate, m_fuel, m_pstate, and m_vstate.

void Transports::CommManager::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 Transports::CommManager::Arguments::iridium_period, m_args, and m_iridium_timer.

IMC::StateReport* Transports::CommManager::Task::produceReport ( )
inline

References m_estate, m_fuel, m_plan_chksum, m_pstate, and m_vstate.

Referenced by onMain().

void Transports::CommManager::Task::sendViaSatellite ( const IMC::TransmissionRequest *  msg)
inline

Member Data Documentation

Arguments Transports::CommManager::Task::m_args

Referenced by onMain(), onUpdateParameters(), and Task().

Time::Counter<float> Transports::CommManager::Task::m_clean_timer

Referenced by onMain(), and Task().

IMC::EstimatedState* Transports::CommManager::Task::m_estate
IMC::FuelLevel* Transports::CommManager::Task::m_fuel
Time::Counter<float> Transports::CommManager::Task::m_iridium_timer

Referenced by onMain(), and onUpdateParameters().

int Transports::CommManager::Task::m_plan_chksum

Referenced by consume(), and produceReport().

IMC::PlanControlState* Transports::CommManager::Task::m_pstate
int Transports::CommManager::Task::m_reqid

Referenced by sendViaSatellite(), and sendViaSms().

std::map<int, IMC::TransmissionRequest*> Transports::CommManager::Task::m_transmission_requests
IMC::VehicleMedium* Transports::CommManager::Task::m_vmedium

Referenced by consume(), and onMain().

IMC::VehicleState* Transports::CommManager::Task::m_vstate
Collaboration diagram for Transports::CommManager::Task:
Collaboration graph