DUNE: Uniform Navigational Environment  2016.05.0
Plan::DB::Task Struct Reference

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onResourceAcquisition (void)
 
void onResourceRelease (void)
 
void consume (const IMC::PlanControl *pc)
 
void consume (const IMC::PowerOperation *po)
 
void consume (const IMC::PlanDB *req)
 
void onChange (const IMC::PlanDB &req)
 
void onChange (double time, uint16_t sid, const std::string &sname)
 
void setPlan (const IMC::PlanDB &req)
 
void storeInDB (const IMC::PlanSpecification *spec)
 
void deletePlan (const IMC::PlanDB &req)
 
void getPlan (const IMC::PlanDB &req)
 
void getPlanInfo (const IMC::PlanDB &req)
 
void clearDatabase (const IMC::PlanDB &req)
 
void getDatabaseState (const IMC::PlanDB &req)
 
void answer (uint8_t type, const char *desc)
 
void inProgress (const char *msg="in progress")
 
void onFailure (const char *errmsg)
 
void onSuccess (const char *msg=DTR("OK"))
 
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)
 
State getState (void)
 
bool isCreated (void)
 
bool isStopping (void)
 
bool isRunning (void)
 
bool isStarting (void)
 
bool isDead (void)
 

Public Attributes

Arguments m_args
 
Database::Connection * m_db
 
IMC::PlanDB m_reply
 
IMC::PlanDBInformation m_plan_info
 
Database::Statement * m_insert_plan_stmt
 
Database::Statement * m_delete_plan_stmt
 
Database::Statement * m_plan_iterator_stmt
 
Database::Statement * m_query_plan_stmt
 
Database::Statement * m_get_plan_stmt
 
Database::Statement * m_delete_all_plans_stmt
 
Database::Statement * m_lastchange_update_stmt
 
Database::Statement * m_lastchange_query_stmt
 
uint16_t m_local_reqid
 

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)
 
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 onResourceInitialization (void)
 
virtual void onUpdateParameters (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)
 
- Protected Attributes inherited from DUNE::Tasks::Task
Contextm_ctx
 
std::vector
< Entities::BasicEntity * > 
m_entities
 

Constructor & Destructor Documentation

Plan::DB::Task::Task ( const std::string &  name,
Tasks::Context &  ctx 
)
inline

Member Function Documentation

void Plan::DB::Task::answer ( uint8_t  type,
const char *  desc 
)
inline
void Plan::DB::Task::clearDatabase ( const IMC::PlanDB &  req)
inline
void Plan::DB::Task::consume ( const IMC::PlanControl *  pc)
inline
void Plan::DB::Task::consume ( const IMC::PowerOperation *  po)
inline
void Plan::DB::Task::consume ( const IMC::PlanDB *  req)
inline
void Plan::DB::Task::deletePlan ( const IMC::PlanDB &  req)
inline
void Plan::DB::Task::getDatabaseState ( const IMC::PlanDB &  req)
inline
void Plan::DB::Task::getPlan ( const IMC::PlanDB &  req)
inline

References m_get_plan_stmt, m_reply, onFailure(), and onSuccess().

Referenced by consume().

void Plan::DB::Task::getPlanInfo ( const IMC::PlanDB &  req)
inline
void Plan::DB::Task::inProgress ( const char *  msg = "in progress")
inline
void Plan::DB::Task::onChange ( const IMC::PlanDB &  req)
inline
void Plan::DB::Task::onChange ( double  time,
uint16_t  sid,
const std::string &  sname 
)
inline
void Plan::DB::Task::onFailure ( const char *  errmsg)
inline
void Plan::DB::Task::onMain ( void  )
inlinevirtual
void Plan::DB::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_db, m_delete_all_plans_stmt, m_delete_plan_stmt, m_get_plan_stmt, m_insert_plan_stmt, m_lastchange_query_stmt, m_lastchange_update_stmt, m_plan_iterator_stmt, and m_query_plan_stmt.

Referenced by consume().

void Plan::DB::Task::onSuccess ( const char *  msg = DTR("OK"))
inline
void Plan::DB::Task::setPlan ( const IMC::PlanDB &  req)
inline

References inProgress(), onFailure(), and storeInDB().

Referenced by consume().

void Plan::DB::Task::storeInDB ( const IMC::PlanSpecification *  spec)
inline

Member Data Documentation

Arguments Plan::DB::Task::m_args

Referenced by onResourceAcquisition(), and Task().

Database::Connection* Plan::DB::Task::m_db
Database::Statement* Plan::DB::Task::m_delete_all_plans_stmt
Database::Statement* Plan::DB::Task::m_delete_plan_stmt
Database::Statement* Plan::DB::Task::m_get_plan_stmt
Database::Statement* Plan::DB::Task::m_insert_plan_stmt
Database::Statement* Plan::DB::Task::m_lastchange_query_stmt
Database::Statement* Plan::DB::Task::m_lastchange_update_stmt
uint16_t Plan::DB::Task::m_local_reqid

Referenced by consume(), and onResourceAcquisition().

IMC::PlanDBInformation Plan::DB::Task::m_plan_info

Referenced by getPlanInfo(), and storeInDB().

Database::Statement* Plan::DB::Task::m_plan_iterator_stmt
Database::Statement* Plan::DB::Task::m_query_plan_stmt
IMC::PlanDB Plan::DB::Task::m_reply
Collaboration diagram for Plan::DB::Task:
Collaboration graph