CMOOSJanitor Class Reference

#include <MOOSJanitor.h>

Inheritance diagram for CMOOSJanitor:

Collaboration diagram for CMOOSJanitor:

List of all members.

Classes
class	CResourceCircuit
Public Types
typedef std::map< std::string, CResourceCircuit >	RESOURCEMAP
Public Member Functions
	CMOOSJanitor ()
virtual	~CMOOSJanitor ()
bool	Iterate ()
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	OnConnectToServer ()
bool	OnStartUp ()
Protected Member Functions
bool	DoDiagnostics ()
bool	GetLeaks ()
bool	GetGroundFaults ()
bool	GetSwitchState (const std::string &sResource, bool &bState)
bool	GetTemperature ()
bool	OnSwitch (CMOOSMsg &Msg)
bool	HitTailConeWD ()
bool	SetSwitch (const std::string &sResource, bool bVal)
bool	SetUpSwitches ()
bool	IsBluefinVehicle ()
bool	BootBluefinVehicle ()
Protected Attributes
bool	m_bAutoWatchDog
std::string	m_sVehicleType
RESOURCEMAP	m_Resources
double	m_dfLastWDHit
double	m_dfLastDiagnostic
double	m_dfTemperature

---

Detailed Description

Definition at line 42 of file MOOSJanitor.h.

---

Member Typedef Documentation

typedef std::map<std::string,CResourceCircuit> CMOOSJanitor::RESOURCEMAP

Definition at line 54 of file MOOSJanitor.h.

---

Constructor & Destructor Documentation

CMOOSJanitor::CMOOSJanitor

(

)

Definition at line 49 of file MOOSJanitor.cpp.

CMOOSJanitor::~CMOOSJanitor

(

)

[virtual]

Definition at line 57 of file MOOSJanitor.cpp.

---

Member Function Documentation

bool CMOOSJanitor::BootBluefinVehicle

(

)

[protected]

Definition at line 166 of file MOOSJanitor.cpp.

bool CMOOSJanitor::DoDiagnostics

(

)

[protected]

Definition at line 498 of file MOOSJanitor.cpp.

bool CMOOSJanitor::GetGroundFaults

(

)

[protected]

Definition at line 404 of file MOOSJanitor.cpp.

bool CMOOSJanitor::GetLeaks

(

)

[protected]

Definition at line 461 of file MOOSJanitor.cpp.

bool CMOOSJanitor::GetSwitchState	(	const std::string &	sResource,
		bool &	bState
	)		[protected]

Definition at line 390 of file MOOSJanitor.cpp.

bool CMOOSJanitor::GetTemperature

(

)

[protected]

Definition at line 344 of file MOOSJanitor.cpp.

bool CMOOSJanitor::HitTailConeWD

(

)

[protected]

Definition at line 300 of file MOOSJanitor.cpp.

bool CMOOSJanitor::IsBluefinVehicle

(

)

[protected]

Definition at line 172 of file MOOSJanitor.cpp.

bool CMOOSJanitor::Iterate

(

)

[virtual]

called when the application should iterate. Overload this function in a derived class and within it write all the application specific code. It will be called at approximately nFreq = 1/AppTick Hz

Reimplemented from CMOOSApp.

Definition at line 62 of file MOOSJanitor.cpp.

bool CMOOSJanitor::OnConnectToServer

(

)

[virtual]

Called when the class has succesully connected to the server. Overload this function and place use it to register for notification when variables of interest change

Reimplemented from CMOOSApp.

Definition at line 146 of file MOOSJanitor.cpp.

bool CMOOSJanitor::OnNewMail

(

MOOSMSG_LIST &

NewMail

)

[virtual]

called when new mail has arrived. Overload this method in a derived class to process new mail. It will be called at approximately 1/CommsTick Hz. In this function you'll most likely interate over the collection of mail message received or call a m_Comms::PeekMail() to look for a specific named message.

Parameters:

NewMail

a list of new mail messages

Reimplemented from CMOOSApp.

Definition at line 118 of file MOOSJanitor.cpp.

bool CMOOSJanitor::OnStartUp

(

)

[virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 76 of file MOOSJanitor.cpp.

bool CMOOSJanitor::OnSwitch

(

CMOOSMsg &

Msg

)

[protected]

Definition at line 325 of file MOOSJanitor.cpp.

bool CMOOSJanitor::SetSwitch	(	const std::string &	sResource,
		bool	bVal
	)		[protected]

Definition at line 226 of file MOOSJanitor.cpp.

bool CMOOSJanitor::SetUpSwitches

(

)

[protected]

Definition at line 177 of file MOOSJanitor.cpp.

---

Member Data Documentation

bool CMOOSJanitor::m_bAutoWatchDog [protected]

Definition at line 71 of file MOOSJanitor.h.

double CMOOSJanitor::m_dfLastDiagnostic [protected]

Definition at line 81 of file MOOSJanitor.h.

double CMOOSJanitor::m_dfLastWDHit [protected]

Definition at line 80 of file MOOSJanitor.h.

double CMOOSJanitor::m_dfTemperature [protected]

Definition at line 83 of file MOOSJanitor.h.

RESOURCEMAP CMOOSJanitor::m_Resources [protected]

Definition at line 79 of file MOOSJanitor.h.

std::string CMOOSJanitor::m_sVehicleType [protected]

Definition at line 78 of file MOOSJanitor.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iJanitor/MOOSJanitor.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iJanitor/MOOSJanitor.cpp