CDepthInstrument Class Reference

#include <DepthInstrument.h>

Inheritance diagram for CDepthInstrument:

Collaboration diagram for CDepthInstrument:

List of all members.

Public Member Functions
	CDepthInstrument ()
virtual	~CDepthInstrument ()
Protected Types
typedef std::list< double >	DEPTH_HISTORY
Protected Member Functions
bool	Filter (double dfDepth)
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	Iterate ()
bool	OnConnectToServer ()
bool	OnStartUp ()
bool	InitialiseSensor ()
bool	PublishDepth ()
bool	GetDepth ()
Protected Attributes
DEPTH_HISTORY	m_DepthHistory
unsigned int	m_nHistoryLength
bool	m_bFilter
CMOOSDepthSensor *	m_pDepthSensor

---

Detailed Description

The main depth instrument class. Derived from CMOOSApp it handles all data from the sensor interface and sends it to the server

Definition at line 48 of file DepthInstrument.h.

---

Member Typedef Documentation

typedef std::list<double> CDepthInstrument::DEPTH_HISTORY [protected]

Definition at line 67 of file DepthInstrument.h.

---

Constructor & Destructor Documentation

CDepthInstrument::CDepthInstrument

(

)

Definition at line 56 of file DepthInstrument.cpp.

CDepthInstrument::~CDepthInstrument

(

)

[virtual]

Definition at line 65 of file DepthInstrument.cpp.

---

Member Function Documentation

bool CDepthInstrument::Filter

(

double

dfDepth

)

[protected]

Definition at line 253 of file DepthInstrument.cpp.

bool CDepthInstrument::GetDepth

(

)

[protected]

Definition at line 197 of file DepthInstrument.cpp.

bool CDepthInstrument::InitialiseSensor

(

)

[protected, virtual]

called from OnStartUp - overload to execute custom start up code for sensor

Reimplemented from CMOOSInstrument.

Definition at line 245 of file DepthInstrument.cpp.

bool CDepthInstrument::Iterate

(

)

[protected, virtual]

this is where it all happens..

Reimplemented from CMOOSApp.

Definition at line 93 of file DepthInstrument.cpp.

bool CDepthInstrument::OnConnectToServer

(

)

[protected, 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 181 of file DepthInstrument.cpp.

bool CDepthInstrument::OnNewMail

(

MOOSMSG_LIST &

NewMail

)

[protected, 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 70 of file DepthInstrument.cpp.

bool CDepthInstrument::OnStartUp

(

)

[protected, virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 104 of file DepthInstrument.cpp.

bool CDepthInstrument::PublishDepth

(

)

[protected]

Definition at line 237 of file DepthInstrument.cpp.

---

Member Data Documentation

bool CDepthInstrument::m_bFilter [protected]

Definition at line 71 of file DepthInstrument.h.

DEPTH_HISTORY CDepthInstrument::m_DepthHistory [protected]

Definition at line 68 of file DepthInstrument.h.

unsigned int CDepthInstrument::m_nHistoryLength [protected]

Definition at line 69 of file DepthInstrument.h.

CMOOSDepthSensor* CDepthInstrument::m_pDepthSensor [protected]

Definition at line 76 of file DepthInstrument.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iDepth/DepthInstrument.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iDepth/DepthInstrument.cpp