MOOS 0.2375
Public Member Functions | Protected Member Functions
CCompassInstrument Class Reference

#include <CompassInstrument.h>

Inheritance diagram for CCompassInstrument:
Inheritance graph
[legend]
Collaboration diagram for CCompassInstrument:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 CCompassInstrument ()
virtual ~CCompassInstrument ()
bool Iterate ()
bool OnNewMail (MOOSMSG_LIST &NewMail)
bool OnConnectToServer ()
bool OnStartUp ()

Protected Member Functions

bool UpdateWithMagneticDegrees (double dfMagDegrees)
double True2Yaw (double dfTrueHeading)
double Magnetic2True (double dfMagnetic)
bool ParseCompassData (std::string &sWhat)
bool InitialiseSensor ()
bool GetData ()
bool PublishData ()

Detailed Description

Definition at line 42 of file CompassInstrument.h.


Constructor & Destructor Documentation

CCompassInstrument::CCompassInstrument ( )

Definition at line 45 of file CompassInstrument.cpp.

CCompassInstrument::~CCompassInstrument ( ) [virtual]

Definition at line 50 of file CompassInstrument.cpp.


Member Function Documentation

bool CCompassInstrument::GetData ( ) [protected]

Definition at line 160 of file CompassInstrument.cpp.

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

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

Reimplemented from CMOOSInstrument.

Definition at line 153 of file CompassInstrument.cpp.

bool CCompassInstrument::Iterate ( ) [virtual]

this is where it all happens..

Reimplemented from CMOOSApp.

Definition at line 58 of file CompassInstrument.cpp.

double CCompassInstrument::Magnetic2True ( double  dfMagnetic) [protected]

Definition at line 224 of file CompassInstrument.cpp.

bool CCompassInstrument::OnConnectToServer ( ) [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 136 of file CompassInstrument.cpp.

bool CCompassInstrument::OnNewMail ( MOOSMSG_LIST NewMail) [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:
NewMaila list of new mail messages

Reimplemented from CMOOSApp.

Definition at line 117 of file CompassInstrument.cpp.

bool CCompassInstrument::OnStartUp ( ) [virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 77 of file CompassInstrument.cpp.

bool CCompassInstrument::ParseCompassData ( std::string &  sWhat) [protected]

Definition at line 207 of file CompassInstrument.cpp.

bool CCompassInstrument::PublishData ( ) [protected]

Definition at line 70 of file CompassInstrument.cpp.

double CCompassInstrument::True2Yaw ( double  dfTrueHeading) [protected]

Definition at line 229 of file CompassInstrument.cpp.

bool CCompassInstrument::UpdateWithMagneticDegrees ( double  dfMagDegrees) [protected]

Definition at line 234 of file CompassInstrument.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines