DUNE: Uniform Navigational Environment  2019.02.0
DUNE::Maneuvers::AbstractLoiter Class Referenceabstract

Detailed Description

Abstract Loiter behavior.

Public Member Functions

 AbstractLoiter (Maneuvers::Maneuver *task)
 
virtual ~AbstractLoiter (void)
 
virtual void onPathControlState (const IMC::PathControlState *pcs)
 
virtual void onEstimatedState (const IMC::EstimatedState *msg)
 
virtual bool isLoitering (void) const =0
 

Protected Attributes

Maneuvers::Maneuverm_task
 

Constructor & Destructor Documentation

DUNE::Maneuvers::AbstractLoiter::AbstractLoiter ( Maneuvers::Maneuver task)
inline

Constructor.

Parameters
[in]taskpointer to Maneuver task.
virtual DUNE::Maneuvers::AbstractLoiter::~AbstractLoiter ( void  )
inlinevirtual

Destructor.

Member Function Documentation

virtual bool DUNE::Maneuvers::AbstractLoiter::isLoitering ( void  ) const
pure virtual

Are we loiterting already?

Returns
true if loitering, false otherwise.

Implemented in DUNE::Maneuvers::FigureEight, and DUNE::Maneuvers::Circular.

virtual void DUNE::Maneuvers::AbstractLoiter::onEstimatedState ( const IMC::EstimatedState msg)
inlinevirtual

On EstimatedState message.

Parameters
[in]msgpointer to EstimatedState message

Reimplemented in DUNE::Maneuvers::FigureEight.

virtual void DUNE::Maneuvers::AbstractLoiter::onPathControlState ( const IMC::PathControlState pcs)
inlinevirtual

On PathControlState message.

Parameters
[in]pcspointer to PathControlState message

Reimplemented in DUNE::Maneuvers::FigureEight, and DUNE::Maneuvers::Circular.

Member Data Documentation

Maneuvers::Maneuver* DUNE::Maneuvers::AbstractLoiter::m_task
protected

Pointer to task.

Collaboration diagram for DUNE::Maneuvers::AbstractLoiter:
Collaboration graph