| MOOS 0.2375 | 
#include <MOOSInstrument.h>


| Public Member Functions | |
| CMOOSInstrument () | |
| virtual | ~CMOOSInstrument () | 
| 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 | 
Class that derives from CMOOSApp and adds functionality of cross platform serial ports
Definition at line 43 of file MOOSInstrument.h.
| CMOOSInstrument::CMOOSInstrument | ( | ) | 
Definition at line 49 of file MOOSInstrument.cpp.
| CMOOSInstrument::~CMOOSInstrument | ( | ) |  [virtual] | 
Definition at line 58 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::DoNMEACheckSum | ( | std::string | sNMEA | ) |  [static] | 
performs NMEA string checksum
now compare to what we recived..
Definition at line 153 of file MOOSInstrument.cpp.
| double CMOOSInstrument::GetMagneticOffset | ( | ) |  [protected] | 
some legacy stuff that should be removed...
Definition at line 127 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::InitialiseSensor | ( | ) |  [protected, virtual] | 
called from OnStartUp - overload to execute custom start up code for sensor
Reimplemented in CGPSInstrument, CADVInstrument, CBatteryInstrument, CCompassInstrument, CDepthInstrument, CDVLInstrument, CINSInstrument, CLBLInstrument, and CRelayBoard.
Definition at line 121 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::InitialiseSensorN | ( | int | nAttempts, | 
| std::string | sSensorName | ||
| ) |  [protected] | 
called from OnStartUp class InitialiseSensor N times
Definition at line 87 of file MOOSInstrument.cpp.
| string CMOOSInstrument::Message2NMEA | ( | std::string | sMsg | ) |  [static] | 
turns a string into NMEA string
sMsg should NOT have $ sign at the front input sMsg, output is $sMsg*CHKSUM eg Msg= "MOOS,MOOSDATA" output would be something like "$MOOS,MOOSDATA*A7\r\n"
Definition at line 192 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::OnStartUp | ( | ) |  [protected, virtual] | 
CMOOSApp overide
Reimplemented from CMOOSApp.
Reimplemented in CGPSInstrument, CMOOSActuation, CADVInstrument, CBatteryInstrument, CCompassInstrument, CDepthInstrument, CDVLInstrument, CINSInstrument, CMOOSJanitor, CLBLInstrument, and CRelayBoard.
Definition at line 107 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::PublishRaw | ( | ) |  [inline, protected] | 
returns true if instrument is publishing raw data
Definition at line 80 of file MOOSInstrument.h.
| void CMOOSInstrument::SetInstrumentErrorMessage | ( | std::string | sError | ) |  [protected] | 
Definition at line 147 of file MOOSInstrument.cpp.
| void CMOOSInstrument::SetPrompt | ( | std::string | sPrompt | ) |  [protected] | 
Definition at line 142 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::SetupPort | ( | ) |  [protected, virtual] | 
Set up the serial port by reading paremters from mission file
Definition at line 63 of file MOOSInstrument.cpp.
| bool CMOOSInstrument::m_bPublishRaw  [protected] | 
set to true if this instrument should publish the raw incoming data to the DB
Definition at line 77 of file MOOSInstrument.h.
| double CMOOSInstrument::m_dfMagneticOffset  [protected] | 
some legacy stuff that should be removed...
Definition at line 86 of file MOOSInstrument.h.
A sensor port
Definition at line 54 of file MOOSInstrument.h.
| std::string CMOOSInstrument::m_sInstrumentErrorMessage  [protected] | 
Definition at line 94 of file MOOSInstrument.h.
| std::string CMOOSInstrument::m_sPrompt  [protected] | 
Definition at line 93 of file MOOSInstrument.h.
| std::string CMOOSInstrument::m_sResourceName  [protected] | 
a place holder for a the name of this sensor resource - rarely used
Definition at line 80 of file MOOSInstrument.h.
 1.7.4
 1.7.4