CGPSInstrument Class Reference

#include <GPSInstrument.h>

Inheritance diagram for CGPSInstrument:

Collaboration diagram for CGPSInstrument:

List of all members.

Classes
struct	CGPSData
Public Member Functions
	CGPSInstrument ()
virtual	~CGPSInstrument ()
Protected Member Functions
bool	ParseNMEAString (const std::string &sNMEAString, CGPSData &out_data)
bool	InitialiseSensor ()
bool	Iterate ()
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	OnConnectToServer ()
bool	OnStartUp ()
bool	GetData ()
bool	PublishData ()
Protected Attributes
CMOOSGeodesy	m_Geodesy
std::string	m_sType
bool	m_bCombineMessages

---

Detailed Description

Definition at line 45 of file GPSInstrument.h.

---

Constructor & Destructor Documentation

CGPSInstrument::CGPSInstrument

(

)

Definition at line 50 of file GPSInstrument.cpp.

CGPSInstrument::~CGPSInstrument

(

)

[virtual]

Definition at line 56 of file GPSInstrument.cpp.

---

Member Function Documentation

bool CGPSInstrument::GetData

(

)

[protected]

Definition at line 299 of file GPSInstrument.cpp.

bool CGPSInstrument::InitialiseSensor

(

)

[protected, virtual]

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

Reimplemented from CMOOSInstrument.

Definition at line 203 of file GPSInstrument.cpp.

bool CGPSInstrument::Iterate

(

)

[protected, virtual]

this is where it all happens..

Reimplemented from CMOOSApp.

Definition at line 64 of file GPSInstrument.cpp.

bool CGPSInstrument::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 186 of file GPSInstrument.cpp.

bool CGPSInstrument::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 172 of file GPSInstrument.cpp.

bool CGPSInstrument::OnStartUp

(

)

[protected, virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 75 of file GPSInstrument.cpp.

bool CGPSInstrument::ParseNMEAString	(	const std::string &	sNMEAString,
		CGPSData &	out_data
	)		[protected]

Definition at line 391 of file GPSInstrument.cpp.

bool CGPSInstrument::PublishData

(

)

[protected]

Definition at line 179 of file GPSInstrument.cpp.

---

Member Data Documentation

bool CGPSInstrument::m_bCombineMessages [protected]

Definition at line 82 of file GPSInstrument.h.

CMOOSGeodesy CGPSInstrument::m_Geodesy [protected]

Definition at line 72 of file GPSInstrument.h.

std::string CGPSInstrument::m_sType [protected]

Definition at line 81 of file GPSInstrument.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Common/iGPS/GPSInstrument.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Common/iGPS/GPSInstrument.cpp