CADVInstrument Class Reference

#include <ADVInstrument.h>

Inheritance diagram for CADVInstrument:

Collaboration diagram for CADVInstrument:

List of all members.

Classes
struct	SendTermPair
Public Member Functions
	CADVInstrument ()
virtual	~CADVInstrument ()
Protected Member Functions
bool	InitialiseSensor ()
bool	Iterate ()
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	OnConnectToServer ()
bool	OnStartUp ()
bool	GetData ()
bool	PublishData ()

---

Detailed Description

Definition at line 42 of file ADVInstrument.h.

---

Constructor & Destructor Documentation

CADVInstrument::CADVInstrument

(

)

Definition at line 44 of file ADVInstrument.cpp.

CADVInstrument::~CADVInstrument

(

)

[virtual]

Definition at line 52 of file ADVInstrument.cpp.

---

Member Function Documentation

bool CADVInstrument::GetData

(

)

[protected]

The ADV returns data about the velocity of the robot Currently using it in ASCII mode. The returned strings are recognized in the ParseADVReply(string &sWhat) method, thus eliminating the need of a 'for()' loop to grab all data in this method.

Definition at line 243 of file ADVInstrument.cpp.

bool CADVInstrument::InitialiseSensor

(

)

[protected, virtual]

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

Reimplemented from CMOOSInstrument.

Definition at line 168 of file ADVInstrument.cpp.

bool CADVInstrument::Iterate

(

)

[protected, virtual]

this is where it all happens..

Reimplemented from CMOOSApp.

Definition at line 59 of file ADVInstrument.cpp.

bool CADVInstrument::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 156 of file ADVInstrument.cpp.

bool CADVInstrument::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 133 of file ADVInstrument.cpp.

bool CADVInstrument::OnStartUp

(

)

[protected, virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 71 of file ADVInstrument.cpp.

bool CADVInstrument::PublishData

(

)

[protected]

Definition at line 149 of file ADVInstrument.cpp.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iADV/ADVInstrument.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iADV/ADVInstrument.cpp