DUNE: Uniform Navigational Environment  2016.05.0
DUNE::Control::ProxyPathController Class Reference

Detailed Description

ProxyPathController PathController with the capability to control the path of a system with an id different from the vehicle's id.

Public Member Functions

 ProxyPathController (const std::string &name, Tasks::Context &ctx)
virtual ~ProxyPathController (void)
void onEntityResolution (void)
virtual bool sourceFilter (const IMC::EstimatedState *es)
- Public Member Functions inherited from DUNE::Control::PathController
 PathController (std::string name, Tasks::Context &ctx)
virtual ~PathController (void)
void onEntityReservation (void)
void consume (const IMC::Brake *brake)
void consume (const IMC::EstimatedState *es)
void consume (const IMC::ControlLoops *cl)
void consume (const IMC::DesiredPath *dp)
void consume (const IMC::NavigationUncertainty *nu)
void consume (const IMC::Distance *dist)
void consume (const IMC::DesiredZ *zref)
void consume (const IMC::DesiredSpeed *dspeed)
virtual void onUpdateParameters (void)
virtual void onResourceInitialization (void)
virtual void onResourceRelease (void)
virtual void onPathActivation (void)
virtual void onPathDeactivation (void)
virtual void onPathStartup (const IMC::EstimatedState &state, const TrackingState &ts)
virtual void step (const IMC::EstimatedState &state, const TrackingState &ts)=0
virtual void loiter (const IMC::EstimatedState &state, const TrackingState &ts)
virtual bool hasSpecificZControl (void) const
void signalError (const std::string &msg)
void enableControlLoops (uint32_t mask)
void disableControlLoops (uint32_t mask)
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)

Additional Inherited Members

- Public Types inherited from DUNE::Concurrency::Runnable
enum  State {
  StateStarting, StateRunning, StateStopping, StateDead,
- 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 onReportEntityState (void)
virtual void onResourceAcquisition (void)
virtual void onRequestActivation (void)
virtual void onRequestDeactivation (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
< Entities::BasicEntity * > 

Constructor & Destructor Documentation

DUNE::Control::ProxyPathController::ProxyPathController ( const std::string &  name,
Tasks::Context ctx 
DUNE::Control::ProxyPathController::~ProxyPathController ( void  )


References DUNE::Memory::clear().

Member Function Documentation

void DUNE::Control::ProxyPathController::onEntityResolution ( void  )

Entity reservation callback.

Reimplemented from DUNE::Tasks::Task.

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

bool DUNE::Control::ProxyPathController::sourceFilter ( const IMC::EstimatedState es)

Handler for EstimatedState source id filter.

This is called when an EstimatedState is received. By default it only passes EstimatedState messages from the system itself.

[in]esEstimatedState message.
true if the message is NOT allowed to pass.

Reimplemented from DUNE::Control::PathController.

References DUNE::Tasks::SourceFilter::match().

Collaboration diagram for DUNE::Control::ProxyPathController:
Collaboration graph