CBatteryInstrument Class Reference

#include <BatteryInstrument.h>

Inheritance diagram for CBatteryInstrument:

Collaboration diagram for CBatteryInstrument:

List of all members.

Public Member Functions
bool	OnNewMail (MOOSMSG_LIST &NewMail)
bool	Iterate ()
bool	OnConnectToServer ()
bool	OnStartUp ()
bool	InitialiseSensor ()
	CBatteryInstrument ()
virtual	~CBatteryInstrument ()
Protected Member Functions
bool	MakeDriver ()
bool	PublishData ()
bool	GetData ()
Protected Attributes
CBatteryDriver *	m_pBatterySensor
string	m_sWarningFlag
double	m_dfLastIteration

---

Detailed Description

Definition at line 46 of file BatteryInstrument.h.

---

Constructor & Destructor Documentation

CBatteryInstrument::CBatteryInstrument

(

)

Definition at line 57 of file BatteryInstrument.cpp.

CBatteryInstrument::~CBatteryInstrument

(

)

[virtual]

Definition at line 63 of file BatteryInstrument.cpp.

---

Member Function Documentation

bool CBatteryInstrument::GetData

(

)

[protected]

Definition at line 194 of file BatteryInstrument.cpp.

bool CBatteryInstrument::InitialiseSensor

(

)

[virtual]

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

Reimplemented from CMOOSInstrument.

Definition at line 189 of file BatteryInstrument.cpp.

bool CBatteryInstrument::Iterate

(

)

[virtual]

called when the application should iterate. Overload this function in a derived class and within it write all the application specific code. It will be called at approximately nFreq = 1/AppTick Hz

Reimplemented from CMOOSApp.

Definition at line 101 of file BatteryInstrument.cpp.

bool CBatteryInstrument::MakeDriver

(

)

[protected]

Definition at line 249 of file BatteryInstrument.cpp.

bool CBatteryInstrument::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 95 of file BatteryInstrument.cpp.

bool CBatteryInstrument::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:

NewMail

a list of new mail messages

Reimplemented from CMOOSApp.

Definition at line 70 of file BatteryInstrument.cpp.

bool CBatteryInstrument::OnStartUp

(

)

[virtual]

CMOOSApp overide

Reimplemented from CMOOSInstrument.

Definition at line 122 of file BatteryInstrument.cpp.

bool CBatteryInstrument::PublishData

(

)

[protected]

Definition at line 199 of file BatteryInstrument.cpp.

---

Member Data Documentation

double CBatteryInstrument::m_dfLastIteration [protected]

Definition at line 66 of file BatteryInstrument.h.

CBatteryDriver* CBatteryInstrument::m_pBatterySensor [protected]

Definition at line 64 of file BatteryInstrument.h.

string CBatteryInstrument::m_sWarningFlag [protected]

Definition at line 65 of file BatteryInstrument.h.

---

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

• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iBattery/BatteryInstrument.h
• /home/toby/moos-ivp/MOOS-2375-Oct0611/Instruments/Ocean/iBattery/BatteryInstrument.cpp