![]() |
DUNE: Uniform Navigational Environment
2.6.0-rc4
|
Public Member Functions | |
| Task (const std::string &name, Tasks::Context &ctx) | |
| void | onActivation (void) |
| void | onDeactivation (void) |
| void | onUpdateParameters (void) |
| void | consume (const IMC::EstimatedState *msg) |
| void | onRemoteActions (const IMC::RemoteActions *msg) |
| void | onConnectionTimeout (void) |
| void | actuateThruster (unsigned i) |
| void | actuate (void) |
Public Member Functions inherited from DUNE::Control::BasicRemoteOperation | |
| BasicRemoteOperation (const std::string &name, Tasks::Context &ctx) | |
| virtual | ~BasicRemoteOperation (void) |
| void | consume (const IMC::RemoteActions *message) |
| void | consume (const IMC::RemoteActionsRequest *message) |
| void | consume (const IMC::ControlLoops *message) |
Public Member Functions inherited from DUNE::Tasks::Periodic | |
| Periodic (const std::string &name, Context &ctx) | |
| virtual | ~Periodic (void) |
| void | setFrequency (double freq) |
| double | getFrequency (void) const |
| double | getRunTime (void) const |
| unsigned | getRunCount (void) const |
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 |
| 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 |
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 | |
| Matrix | m_thruster |
| Matrix | m_forces |
| IMC::DesiredVelocity | m_dvel |
| float | m_start_depth |
| float | m_start_heading |
| float | m_depth |
| float | m_h_ref |
| bool | m_dh_data |
| Arguments | m_args |
Additional Inherited Members | |
Public Types inherited from DUNE::Concurrency::Runnable | |
| enum | State { StateStarting, StateRunning, StateStopping, StateDead, StateUnknown } |
Protected Member Functions inherited from DUNE::Control::BasicRemoteOperation | |
| void | addActionButton (const std::string &action) |
| void | addActionAxis (const std::string &action) |
| void | setConnectionTimeout (const float tout) |
| virtual void | onRemoteActions (const IMC::RemoteActions *message) |
| virtual void | onConnectionResumed (void) |
| virtual void | onResourceInitialization (void) |
| void | enableControlLoops (uint32_t mask) |
| void | disableControlLoops (uint32_t mask) |
Protected Member Functions inherited from DUNE::Tasks::Task | |
| const char * | getEntityLabel (void) const |
| void | setEntityLabel (const std::string &label) |
| 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) |
| 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 > | |
| Parameter & | param (const std::string &name, T &var) |
| template<typename Y , typename T > | |
| Parameter & | param (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 void | onEntityReservation (void) |
| virtual void | onEntityResolution (void) |
| virtual void | onReportEntityState (void) |
| virtual void | onResourceAcquisition (void) |
| virtual void | onResourceRelease (void) |
| virtual void | onRequestActivation (void) |
| virtual void | onRequestDeactivation (void) |
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 | |
| Context & | m_ctx |
|
inline |
References Control::ROV::RemoteOperation::Arguments::actuat, DUNE::Control::BasicRemoteOperation::addActionAxis(), DUNE::Control::BasicRemoteOperation::addActionButton(), Control::ROV::RemoteOperation::Arguments::as_control, DUNE::Tasks::Parameter::defaultValue(), Control::ROV::RemoteOperation::Arguments::depth_deadzone, Control::ROV::RemoteOperation::Arguments::depth_rate, Control::ROV::RemoteOperation::Arguments::dh_control, Control::ROV::RemoteOperation::Arguments::heading_rate, m_args, Control::ROV::RemoteOperation::Arguments::max_speed, and DUNE::Tasks::Task::param().
|
inlinevirtual |
Reimplemented from DUNE::Control::BasicRemoteOperation.
References Control::ROV::RemoteOperation::Arguments::actuat, actuateThruster(), Control::ROV::RemoteOperation::Arguments::as_control, Control::ROV::RemoteOperation::Arguments::dh_control, DUNE::Tasks::Task::dispatch(), m_args, m_depth, m_dh_data, m_forces, m_h_ref, m_thruster, and Control::ROV::RemoteOperation::Arguments::max_speed.
Referenced by onActivation(), onConnectionTimeout(), and onDeactivation().
|
inline |
References DUNE::Tasks::Task::dispatch(), m_thruster, and DUNE::Math::trimValue().
Referenced by actuate().
|
inline |
References DUNE::Tasks::Task::getSystemId(), m_dh_data, m_start_depth, and m_start_heading.
|
inlinevirtual |
Called when the task starts/resumes normal execution.
Reimplemented from DUNE::Tasks::Task.
References actuate(), Control::ROV::RemoteOperation::Arguments::as_control, Control::ROV::RemoteOperation::Arguments::dh_control, DUNE::Control::BasicRemoteOperation::disableControlLoops(), DUNE::Control::BasicRemoteOperation::enableControlLoops(), DUNE::Math::Matrix::fill(), m_args, m_depth, m_h_ref, m_start_depth, m_start_heading, and m_thruster.
|
inlinevirtual |
Reimplemented from DUNE::Control::BasicRemoteOperation.
References actuate(), Control::ROV::RemoteOperation::Arguments::as_control, Control::ROV::RemoteOperation::Arguments::dh_control, DUNE::Control::BasicRemoteOperation::disableControlLoops(), DUNE::Math::Matrix::fill(), m_args, m_depth, m_h_ref, m_start_depth, m_start_heading, and m_thruster.
|
inlinevirtual |
Called when the task stops normal execution and enters an idleness state.
Reimplemented from DUNE::Tasks::Task.
References actuate(), Control::ROV::RemoteOperation::Arguments::dh_control, DUNE::Control::BasicRemoteOperation::disableControlLoops(), DUNE::Math::Matrix::fill(), m_args, and m_thruster.
|
inline |
References Control::ROV::RemoteOperation::Arguments::as_control, DUNE::Tasks::Task::debug(), Control::ROV::RemoteOperation::Arguments::depth_deadzone, Control::ROV::RemoteOperation::Arguments::depth_rate, Control::ROV::RemoteOperation::Arguments::dh_control, DUNE::Math::Matrix::get(), Control::ROV::RemoteOperation::Arguments::heading_rate, m_args, m_depth, m_forces, m_h_ref, m_start_depth, and m_start_heading.
|
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 Control::ROV::RemoteOperation::Arguments::heading_rate, m_args, and DUNE::Tasks::Task::paramChanged().
| Arguments Control::ROV::RemoteOperation::Task::m_args |
Task arguments.
Referenced by actuate(), onActivation(), onConnectionTimeout(), onDeactivation(), onRemoteActions(), onUpdateParameters(), and Task().
| float Control::ROV::RemoteOperation::Task::m_depth |
Current vehicle depth.
Referenced by actuate(), onActivation(), onConnectionTimeout(), and onRemoteActions().
| bool Control::ROV::RemoteOperation::Task::m_dh_data |
| IMC::DesiredVelocity Control::ROV::RemoteOperation::Task::m_dvel |
Desired Velocity message.
| Matrix Control::ROV::RemoteOperation::Task::m_forces |
Vector of forces to apply.
Referenced by actuate(), and onRemoteActions().
| float Control::ROV::RemoteOperation::Task::m_h_ref |
Current heading or heading rate reference.
Referenced by actuate(), onActivation(), onConnectionTimeout(), and onRemoteActions().
| float Control::ROV::RemoteOperation::Task::m_start_depth |
Starting depth.
Referenced by consume(), onActivation(), onConnectionTimeout(), and onRemoteActions().
| float Control::ROV::RemoteOperation::Task::m_start_heading |
Starting heading.
Referenced by consume(), onActivation(), onConnectionTimeout(), and onRemoteActions().
| Matrix Control::ROV::RemoteOperation::Task::m_thruster |
Thruster actuation vector.
Referenced by actuate(), actuateThruster(), onActivation(), onConnectionTimeout(), and onDeactivation().
