DUNE: Uniform Navigational Environment  2019.02.1
Autonomy::TextActions::Task Struct Reference

Classes

struct  Arguments
 

Public Member Functions

 Task (const std::string &name, Tasks::Context &ctx)
 
void onResourceInitialization (void)
 
void consume (const IMC::PlanControlState *msg)
 
void consume (const IMC::VehicleState *msg)
 
void consume (const IMC::TextMessage *msg)
 
void consume (const IMC::PlanGeneration *msg)
 
void consume (const IMC::PlanControl *msg)
 
bool checkNumber (const std::string &str)
 
void splitCommand (const std::string &text, std::string &cmd, std::string &args)
 
void reply (const std::string &origin, const std::string &text)
 
void handleCommand (const std::string &origin, const std::string &cmd, const std::string &args)
 
void handleErrorsCommand (const std::string &origin)
 
void handleChangeNumCommand (const std::string &origin, const std::string &args)
 
void handleInfoCommand (const std::string &origin)
 
void handleRebootCommand (const std::string &origin, const std::string &args)
 
void handleStartCommand (const std::string &origin, const std::string &args, bool ignore_errors=true)
 
void handleAbortCommand (const std::string &origin, const std::string &args)
 
void handleHelpCommand (const std::string &origin)
 
void handlePlanGeneratorCommand (const std::string &origin, const std::string &cmd, const std::string &args)
 
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

IMC::PlanControlState * m_pcs
 
IMC::VehicleState * m_vstate
 
IMC::TextMessage * m_last
 
int m_reqid
 
struct Autonomy::TextActions::Task::Arguments m_args
 

Additional Inherited Members

- Public Types inherited from DUNE::Concurrency::Runnable
- 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 onResourceRelease (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)
 
unsigned getPriorityImpl (void)
 
- Protected Attributes inherited from DUNE::Tasks::Task
Contextm_ctx
 
std::vector< Entities::BasicEntity * > m_entities
 

Constructor & Destructor Documentation

Member Function Documentation

bool Autonomy::TextActions::Task::checkNumber ( const std::string &  str)
inline

Checks if a string is a phone number.

Referenced by handleChangeNumCommand().

void Autonomy::TextActions::Task::consume ( const IMC::PlanControlState *  msg)
inline
void Autonomy::TextActions::Task::consume ( const IMC::VehicleState *  msg)
inline
void Autonomy::TextActions::Task::consume ( const IMC::TextMessage *  msg)
inline
void Autonomy::TextActions::Task::consume ( const IMC::PlanGeneration *  msg)
inline

Handles responses from PlanGeneration requests.

References m_args, reply(), and Autonomy::TextActions::Task::Arguments::valid_cmds.

void Autonomy::TextActions::Task::consume ( const IMC::PlanControl *  msg)
inline

! Handles responses from PlanControl requests

References reply(), and splitCommand().

void Autonomy::TextActions::Task::handleAbortCommand ( const std::string &  origin,
const std::string &  args 
)
inline
void Autonomy::TextActions::Task::handleChangeNumCommand ( const std::string &  origin,
const std::string &  args 
)
inline

Execute command 'phone' for the one in args or for origin if the args is null.

References checkNumber(), DUNE::Tasks::Task::dispatch(), Autonomy::TextActions::Task::Arguments::help_url, m_args, reply(), splitCommand(), and DUNE::Tasks::Task::war().

Referenced by handleCommand().

void Autonomy::TextActions::Task::handleCommand ( const std::string &  origin,
const std::string &  cmd,
const std::string &  args 
)
inline

Parse incoming command and run it.

Parameters
originThe original sender
cmdThe command to be executed
argsThe arguments of the command (if any)

References handleAbortCommand(), handleChangeNumCommand(), handleErrorsCommand(), handleHelpCommand(), handleInfoCommand(), handlePlanGeneratorCommand(), handleRebootCommand(), and handleStartCommand().

Referenced by consume().

void Autonomy::TextActions::Task::handleErrorsCommand ( const std::string &  origin)
inline

Execute command 'ERRORS'.

References reply().

Referenced by handleCommand().

void Autonomy::TextActions::Task::handleHelpCommand ( const std::string &  origin)
inline

Execute command 'HELP'.

References Autonomy::TextActions::Task::Arguments::help_url, m_args, and reply().

Referenced by handleCommand().

void Autonomy::TextActions::Task::handleInfoCommand ( const std::string &  origin)
inline

Execute command 'INFO'.

References reply(), and DUNE::Tasks::Task::war().

Referenced by handleCommand().

void Autonomy::TextActions::Task::handlePlanGeneratorCommand ( const std::string &  origin,
const std::string &  cmd,
const std::string &  args 
)
inline

Sends a PlanGeneration request resulting from an unknown command.

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

Referenced by handleCommand().

void Autonomy::TextActions::Task::handleRebootCommand ( const std::string &  origin,
const std::string &  args 
)
inline

Execute command 'REBOOT'.

References DUNE::Tasks::Task::dispatch(), reply(), and DUNE::Tasks::Task::war().

Referenced by handleCommand().

void Autonomy::TextActions::Task::handleStartCommand ( const std::string &  origin,
const std::string &  args,
bool  ignore_errors = true 
)
inline

Execute command 'START'.

References DUNE::Tasks::Task::dispatch(), DUNE::Tasks::Task::inf(), and reply().

Referenced by handleCommand().

void Autonomy::TextActions::Task::onMain ( void  )
inlinevirtual
void Autonomy::TextActions::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 Autonomy::TextActions::Task::reply ( const std::string &  origin,
const std::string &  text 
)
inline
void Autonomy::TextActions::Task::splitCommand ( const std::string &  text,
std::string &  cmd,
std::string &  args 
)
inline

! Splits the text into command and arguments

Parameters
[in]textThe text to be split
[out]cmdThe first word of the text
[out]argsThe remaining text or empty string if text has just one word.

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

Referenced by consume(), and handleChangeNumCommand().

Member Data Documentation

struct Autonomy::TextActions::Task::Arguments Autonomy::TextActions::Task::m_args
IMC::TextMessage* Autonomy::TextActions::Task::m_last

last received message

IMC::PlanControlState* Autonomy::TextActions::Task::m_pcs

last received PlanControlState

int Autonomy::TextActions::Task::m_reqid

Transmission request id.

Referenced by reply().

IMC::VehicleState* Autonomy::TextActions::Task::m_vstate

last received VehicleState

Collaboration diagram for Autonomy::TextActions::Task:
Collaboration graph