MOOS

CMOOSInstrument Class Reference

#include <MOOSInstrument.h>

Inheritance diagram for CMOOSInstrument:

List of all members.

Static Public Member Functions
static std::string	Message2NMEA (std::string sMsg)
static bool	DoNMEACheckSum (std::string sNMEA)
Public Attributes
CMOOSLinuxSerialPort	m_Port
Protected Member Functions
virtual bool	OnStartUp ()
virtual bool	InitialiseSensor ()
bool	InitialiseSensorN (int nAttempts, std::string sSensorName)
virtual bool	SetupPort ()
bool	PublishRaw ()
double	GetMagneticOffset ()
void	SetInstrumentErrorMessage (std::string sError)
void	SetPrompt (std::string sPrompt)
Protected Attributes
bool	m_bPublishRaw
std::string	m_sResourceName
double	m_dfMagneticOffset
std::string	m_sPrompt
std::string	m_sInstrumentErrorMessage

---

Detailed Description

Class that derives from CMOOSApp and adds functionality of cross platform serial ports

---

Member Function Documentation

static bool CMOOSInstrument::DoNMEACheckSum (  std::string  sNMEA  )  [static]

performs NMEA string checksum

double CMOOSInstrument::GetMagneticOffset (   )  [protected]

some legacy stuff that should be removed...

bool CMOOSInstrument::InitialiseSensor (   )  [protected, virtual]

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

bool CMOOSInstrument::InitialiseSensorN (  int  nAttempts, std::string  sSensorName )  [protected]

called from OnStartUp class InitialiseSensor N times

static std::string CMOOSInstrument::Message2NMEA (  std::string  sMsg  )  [static]

turns a string into NMEA string

bool CMOOSInstrument::OnStartUp (   )  [protected, virtual]

CMOOSApp overide Reimplemented from CMOOSApp.

bool CMOOSInstrument::PublishRaw (   )  [inline, protected]

returns true if instrument is publishing raw data

bool CMOOSInstrument::SetupPort (   )  [protected, virtual]

Set up the serial port by reading paremters from mission file

---

Member Data Documentation

bool CMOOSInstrument::m_bPublishRaw [protected]

set to true if this instrument should publish the raw incoming data to the DB

double CMOOSInstrument::m_dfMagneticOffset [protected]

some legacy stuff that should be removed...

CMOOSLinuxSerialPort CMOOSInstrument::m_Port

A sensor port

std::string CMOOSInstrument::m_sResourceName [protected]

a place holder for a the name of this sensor resource - rarely used

---

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

• /home/pnewman/code/MOOS/trunk/Core/MOOSLIB/MOOSInstrument.h
• /home/pnewman/code/MOOS/trunk/Core/MOOSLIB/MOOSInstrument.cpp

---