#include <MOOSBehaviour.h>

Inheritance diagram for CMOOSBehaviour:

Collaboration diagram for CMOOSBehaviour:

Classes
class	CControllerGains
class	ControlledDOF
class	CXYPoint
Public Member Functions
virtual void	SetTime (double dfTimeNow)
virtual bool	ReInitialise ()
bool	Start ()
void	SetPriority (int nPriority)
int	GetPriority ()
void	SetName (string sName)
bool	SetGains (CControllerGains NewGains)
double	GetCreationTime ()
double	GetStartTime ()
bool	HasNewRegistration ()
void	SetMissionFileReader (CProcessConfigReader *pMissionFileReader)
string	GetName ()
virtual bool	SetParam (string sParam, string sVal)
virtual bool	GetNotifications (MOOSMSG_LIST &List)
virtual bool	GetRegistrations (STRING_LIST &List)
virtual bool	OnNewMail (MOOSMSG_LIST &NewMail)
virtual bool	RegularMailDelivery (double dfTimeNow)=0
virtual bool	Run (CPathAction &DesiredAction)
	CMOOSBehaviour ()
virtual	~CMOOSBehaviour ()
bool	ShouldRun ()
Protected Member Functions
virtual bool	OnStart ()
bool	OnError (string sReason)
bool	DebugNotify (const string &sStr)
double	GetTimeNow ()
virtual bool	OnTimeOut ()
virtual bool	OnEvent (const string &sReason="", bool bVerbalNotify=true)
virtual void	Stop (const string &sReason="DONE")
virtual bool	OnComplete ()
bool	PeekMail (MOOSMSG_LIST &Mail, const string &sKey, CMOOSMsg &Msg)
Protected Attributes
double	m_dfIterateTime
unsigned int	m_nPriority
MOOSMSG_LIST	m_Notifications
CProcessConfigReader *	m_pMissionFileReader
string	m_sName
string	m_sLogPath
bool	m_bActive
bool	m_bComplete
bool	m_bNewRegistrations
STRING_LIST	m_StartFlags
STRING_LIST	m_CompleteFlags
STRING_LIST	m_EventFlags
double	m_dfTimeOut
double	m_dfStartTime
double	m_dfCreationTime
CPitchZPID	m_ZPID
CScalarPID	m_YawPID
CControllerGains	m_Gains

Detailed Description

Definition at line 56 of file MOOSBehaviour.h.

Constructor & Destructor Documentation

CMOOSBehaviour::CMOOSBehaviour ( )

Definition at line 80 of file MOOSBehaviour.cpp.

CMOOSBehaviour::~CMOOSBehaviour ( ) [virtual]

Definition at line 102 of file MOOSBehaviour.cpp.

Member Function Documentation

bool CMOOSBehaviour::DebugNotify ( const string & sStr ) [protected]

Definition at line 542 of file MOOSBehaviour.cpp.

double CMOOSBehaviour::GetCreationTime ( )

Definition at line 537 of file MOOSBehaviour.cpp.

string CMOOSBehaviour::GetName ( )

Definition at line 464 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::GetNotifications ( MOOSMSG_LIST & List ) [virtual]

Reimplemented in CConstantDepthTask, CDiveTask, COverallTimeOut, CPilotTask, CSeabedTrack, CSurveyTask, and CThirdPartyTask.

Definition at line 255 of file MOOSBehaviour.cpp.

int CMOOSBehaviour::GetPriority ( )

Definition at line 647 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::GetRegistrations ( STRING_LIST & List ) [virtual]

Reimplemented in CAGVHeadingSpeedTask, CConstantDepthTask, CConstantHeadingTask, CDiveTask, CEndMission, CGoToWayPoint, CHoldingPatternTask, CLimitAltitude, CLimitBox, CLimitDepth, COrbitTask, CPilotTask, CSeabedTrack, CSteerThenDriveXYPatternTask, CSurveyTask, CThirdPartyTask, CTimerTask, CTrackLineTask, CVariableHeadingTask, CVehicleFrameWayPointTask, CXYPatternTask, and CZPatternTask.

Definition at line 144 of file MOOSBehaviour.cpp.

double CMOOSBehaviour::GetStartTime ( )

Definition at line 532 of file MOOSBehaviour.cpp.

double CMOOSBehaviour::GetTimeNow ( ) [inline, protected]

Definition at line 131 of file MOOSBehaviour.h.

bool CMOOSBehaviour::HasNewRegistration ( )

Definition at line 513 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnComplete ( ) [protected, virtual]

Reimplemented in CSteerThenDriveXYPatternTask.

Definition at line 262 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnError ( string sReason ) [protected]

Definition at line 552 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnEvent	(	const string &	sReason = `""`,
		bool	bVerbalNotify = `true`
	)		`[protected, virtual]`

Definition at line 469 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnNewMail ( MOOSMSG_LIST & NewMail ) [virtual]

Reimplemented in CAGVHeadingSpeedTask, CConstantDepthTask, CConstantHeadingTask, CDiveTask, CEndMission, CGoToWayPoint, CHoldingPatternTask, CLimitAltitude, CLimitBox, CLimitDepth, COrbitTask, CPilotTask, CSeabedTrack, CSteerThenDriveXYPatternTask, CSurveyTask, CThirdPartyTask, CTimerTask, CTrackLineTask, CVariableHeadingTask, CVehicleFrameWayPointTask, CXYPatternTask, and CZPatternTask.

Definition at line 112 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnStart ( ) [protected, virtual]

Reimplemented in CSurveyTask.

Definition at line 689 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::OnTimeOut ( ) [protected, virtual]

Reimplemented in COverallTimeOut, and CTimerTask.

Definition at line 498 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::PeekMail	(	MOOSMSG_LIST &	Mail,
		const string &	sKey,
		CMOOSMsg &	Msg
	)		`[protected]`

Definition at line 902 of file MOOSCommClient.cpp.

virtual bool CMOOSBehaviour::RegularMailDelivery ( double dfTimeNow ) [pure virtual]

bool CMOOSBehaviour::ReInitialise ( ) [virtual]

Definition at line 657 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::Run ( CPathAction & DesiredAction ) [virtual]

Reimplemented in CConstantDepthTask, CConstantHeadingTask, CDiveTask, CEndMission, CGoToDepth, CGoToWayPoint, CHoldingPatternTask, CLimitAltitude, CLimitBox, CLimitDepth, COrbitTask, COverallTimeOut, CPilotTask, CSeabedTrack, CSurveyTask, CThirdPartyTask, CTimerTask, CTrackLineTask, CVariableHeadingTask, CVehicleFrameWayPointTask, CXYPatternTask, and CZPatternTask.

Definition at line 107 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::SetGains ( CMOOSBehaviour::CControllerGains NewGains )

Definition at line 564 of file MOOSBehaviour.cpp.

void CMOOSBehaviour::SetMissionFileReader ( CProcessConfigReader * pMissionFileReader )

Definition at line 492 of file MOOSBehaviour.cpp.

void CMOOSBehaviour::SetName ( string sName )

Definition at line 642 of file MOOSBehaviour.cpp.

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

Reimplemented in CAGVHeadingSpeedTask, CConstantDepthTask, CConstantHeadingTask, CDiveTask, CEndMission, CGoToDepth, CGoToWayPoint, CHoldingPatternTask, CLimitAltitude, CLimitBox, CLimitDepth, COrbitTask, COverallTimeOut, CPilotTask, CSeabedTrack, CSteerThenDriveXYPatternTask, CSurveyTask, CThirdPartyTask, CTimerTask, CTrackLineTask, CVehicleFrameWayPointTask, CXYPatternTask, and CZPatternTask.

Definition at line 384 of file MOOSBehaviour.cpp.

void CMOOSBehaviour::SetPriority ( int nPriority )

Definition at line 652 of file MOOSBehaviour.cpp.

void CMOOSBehaviour::SetTime ( double dfTimeNow ) [virtual]

Reimplemented in CSurveyTask.

Definition at line 682 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::ShouldRun ( )

Definition at line 270 of file MOOSBehaviour.cpp.

bool CMOOSBehaviour::Start ( )

Definition at line 344 of file MOOSBehaviour.cpp.

void CMOOSBehaviour::Stop ( const string & sReason = "DONE" ) [protected, virtual]

Definition at line 365 of file MOOSBehaviour.cpp.

Member Data Documentation

bool CMOOSBehaviour::m_bActive [protected]

Definition at line 174 of file MOOSBehaviour.h.

bool CMOOSBehaviour::m_bComplete [protected]

Definition at line 175 of file MOOSBehaviour.h.

bool CMOOSBehaviour::m_bNewRegistrations [protected]

Definition at line 176 of file MOOSBehaviour.h.

STRING_LIST CMOOSBehaviour::m_CompleteFlags [protected]

Definition at line 179 of file MOOSBehaviour.h.

double CMOOSBehaviour::m_dfCreationTime [protected]

Definition at line 183 of file MOOSBehaviour.h.

double CMOOSBehaviour::m_dfIterateTime [protected]

Definition at line 130 of file MOOSBehaviour.h.

double CMOOSBehaviour::m_dfStartTime [protected]

Definition at line 182 of file MOOSBehaviour.h.

double CMOOSBehaviour::m_dfTimeOut [protected]

Definition at line 181 of file MOOSBehaviour.h.

STRING_LIST CMOOSBehaviour::m_EventFlags [protected]

Definition at line 180 of file MOOSBehaviour.h.

CControllerGains CMOOSBehaviour::m_Gains [protected]

Definition at line 189 of file MOOSBehaviour.h.

MOOSMSG_LIST CMOOSBehaviour::m_Notifications [protected]

Definition at line 142 of file MOOSBehaviour.h.

unsigned int CMOOSBehaviour::m_nPriority [protected]

Definition at line 138 of file MOOSBehaviour.h.

CProcessConfigReader* CMOOSBehaviour::m_pMissionFileReader [protected]

Definition at line 145 of file MOOSBehaviour.h.

string CMOOSBehaviour::m_sLogPath [protected]

Definition at line 173 of file MOOSBehaviour.h.

string CMOOSBehaviour::m_sName [protected]

Definition at line 172 of file MOOSBehaviour.h.

STRING_LIST CMOOSBehaviour::m_StartFlags [protected]

Definition at line 178 of file MOOSBehaviour.h.

CScalarPID CMOOSBehaviour::m_YawPID [protected]

Definition at line 187 of file MOOSBehaviour.h.

CPitchZPID CMOOSBehaviour::m_ZPID [protected]

Definition at line 186 of file MOOSBehaviour.h.

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

/home/toby/moos-ivp/MOOS-2375-Oct0611/NavigationAndControl/MOOSTaskLib/MOOSBehaviour.h
/home/toby/moos-ivp/MOOS-2375-Oct0611/Core/MOOSLIB/MOOSCommClient.cpp
/home/toby/moos-ivp/MOOS-2375-Oct0611/NavigationAndControl/MOOSTaskLib/MOOSBehaviour.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation