CXYPatternTask Class Reference

#include <XYPatternTask.h>

Inheritance diagram for CXYPatternTask:

Collaboration diagram for CXYPatternTask:

List of all members.

Public Types
typedef vector< CXYPoint >	POSITION_DATA
Public Member Functions
	CXYPatternTask ()
virtual	~CXYPatternTask ()
bool	SetParam (string sParam, string sVal)
virtual bool	GetRegistrations (STRING_LIST &List)
virtual bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	Run (CPathAction &DesiredAction)
virtual bool	RegularMailDelivery (double dfTimeNow)
virtual bool	SetControl (CPathAction &DesiredAction, double dfRudder, double dfThrust)
Public Attributes
POSITION_DATA	m_XYPoints
int	m_nRepCounter
int	m_nTotalPositions
int	m_nCurrentPosition
int	m_nTotalRepetitions
double *	m_dfOrbit [XYPATTERN_MAX_TOTAL_POSITIONS]
bool	m_bInitialised
bool	m_bPositionSet
bool	m_bThrustSet
ControlledDOF	m_YawDOF
ControlledDOF	m_XDOF
ControlledDOF	m_YDOF
double	m_dfVicinityRadius
double	m_dfThrust
string	m_sLocation
Protected Types
typedef list< string >	POSITION_LIST
Protected Member Functions
bool	ValidData ()
bool	Initialise ()
void	SetNextPoint ()
Protected Attributes
POSITION_LIST	m_Positions

---

Detailed Description

Definition at line 56 of file XYPatternTask.h.

---

Member Typedef Documentation

typedef vector<CXYPoint> CXYPatternTask::POSITION_DATA

Definition at line 59 of file XYPatternTask.h.

typedef list<string> CXYPatternTask::POSITION_LIST [protected]

Definition at line 96 of file XYPatternTask.h.

---

Constructor & Destructor Documentation

CXYPatternTask::CXYPatternTask

(

)

Definition at line 50 of file XYPatternTask.cpp.

CXYPatternTask::~CXYPatternTask

(

)

[virtual]

Definition at line 75 of file XYPatternTask.cpp.

---

Member Function Documentation

bool CXYPatternTask::GetRegistrations

(

STRING_LIST &

List

)

[virtual]

Reimplemented from CMOOSBehaviour.

Reimplemented in CSteerThenDriveXYPatternTask, and CSurveyTask.

Definition at line 145 of file XYPatternTask.cpp.

bool CXYPatternTask::Initialise

(

)

[protected]

Reimplemented in CSurveyTask.

Definition at line 265 of file XYPatternTask.cpp.

bool CXYPatternTask::OnNewMail

(

MOOSMSG_LIST &

NewMail

)

[virtual]

Reimplemented from CMOOSBehaviour.

Reimplemented in CSteerThenDriveXYPatternTask, and CSurveyTask.

Definition at line 80 of file XYPatternTask.cpp.

bool CXYPatternTask::RegularMailDelivery

(

double

dfTimeNow

)

[virtual]

Implements CMOOSBehaviour.

Reimplemented in CSurveyTask.

Definition at line 161 of file XYPatternTask.cpp.

bool CXYPatternTask::Run

(

CPathAction &

DesiredAction

)

[virtual]

Reimplemented from CMOOSBehaviour.

Reimplemented in CSurveyTask.

Definition at line 177 of file XYPatternTask.cpp.

bool CXYPatternTask::SetControl	(	CPathAction &	DesiredAction,
		double	dfRudder,
		double	dfThrust
	)		[virtual]

Reimplemented in CSteerThenDriveXYPatternTask.

Definition at line 244 of file XYPatternTask.cpp.

void CXYPatternTask::SetNextPoint

(

)

[protected]

Definition at line 359 of file XYPatternTask.cpp.

bool CXYPatternTask::SetParam	(	string	sParam,
		string	sVal
	)		[virtual]

Reimplemented from CMOOSBehaviour.

Reimplemented in CSteerThenDriveXYPatternTask, and CSurveyTask.

Definition at line 288 of file XYPatternTask.cpp.

bool CXYPatternTask::ValidData

(

)

[protected]

Definition at line 279 of file XYPatternTask.cpp.

---

Member Data Documentation

bool CXYPatternTask::m_bInitialised

Definition at line 82 of file XYPatternTask.h.

bool CXYPatternTask::m_bPositionSet

Definition at line 83 of file XYPatternTask.h.

bool CXYPatternTask::m_bThrustSet

Definition at line 84 of file XYPatternTask.h.

double* CXYPatternTask::m_dfOrbit[XYPATTERN_MAX_TOTAL_POSITIONS]

Definition at line 71 of file XYPatternTask.h.

double CXYPatternTask::m_dfThrust

Definition at line 91 of file XYPatternTask.h.

double CXYPatternTask::m_dfVicinityRadius

Definition at line 90 of file XYPatternTask.h.

int CXYPatternTask::m_nCurrentPosition

Definition at line 68 of file XYPatternTask.h.

int CXYPatternTask::m_nRepCounter

Definition at line 62 of file XYPatternTask.h.

int CXYPatternTask::m_nTotalPositions

Definition at line 67 of file XYPatternTask.h.

int CXYPatternTask::m_nTotalRepetitions

Definition at line 69 of file XYPatternTask.h.

POSITION_LIST CXYPatternTask::m_Positions [protected]

Definition at line 97 of file XYPatternTask.h.

string CXYPatternTask::m_sLocation

Definition at line 92 of file XYPatternTask.h.

ControlledDOF CXYPatternTask::m_XDOF

Definition at line 87 of file XYPatternTask.h.

POSITION_DATA CXYPatternTask::m_XYPoints

Definition at line 60 of file XYPatternTask.h.

ControlledDOF CXYPatternTask::m_YawDOF

Definition at line 86 of file XYPatternTask.h.

ControlledDOF CXYPatternTask::m_YDOF

Definition at line 88 of file XYPatternTask.h.

---

The documentation for this class was generated from the following files:

• /home/toby/moos-ivp/MOOS-2375-Oct0611/NavigationAndControl/MOOSTaskLib/XYPatternTask.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/NavigationAndControl/MOOSTaskLib/XYPatternTask.cpp