MOOS 0.2375
Public Member Functions | Protected Member Functions | Protected Attributes
CMVSim Class Reference

#include <MVSim.h>

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

List of all members.

Public Member Functions

virtual bool OnConnectToServer ()
virtual bool OnStartUp ()
 CMVSim ()
virtual ~CMVSim ()

Protected Member Functions

bool LogStartConditions ()
bool OpenLogFile ()
bool MakeBeacon (std::string sConfig)
bool MakeAUV (std::string sConfig)
 Simply make an AUV object.
bool Clean ()
CSixDOFAUVGetSubscriber (const std::string &sName)
bool DoRegistrations ()
void PostResults ()
bool Initialise ()
bool NeedToMail ()
bool Iterate ()
bool OnNewMail (MOOSMSG_LIST &NewMail)

Protected Attributes

bool m_bRealTime
CSimEnvironment m_Environment
SIM_ENTITY_LIST m_Entities
CSimParams m_Params
bool m_bInitialised
double m_dfUpdateRate
double m_dfLastMailed
double m_dfStartTime
double m_dfSimulatorTime
double m_dfOldSimulatorTime

Detailed Description

Definition at line 62 of file MVSim.h.


Constructor & Destructor Documentation

CMVSim::CMVSim ( )

Definition at line 53 of file MVSim.cpp.

CMVSim::~CMVSim ( ) [virtual]

Definition at line 70 of file MVSim.cpp.


Member Function Documentation

bool CMVSim::Clean ( ) [protected]

Definition at line 497 of file MVSim.cpp.

bool CMVSim::DoRegistrations ( ) [protected]

Definition at line 82 of file MVSim.cpp.

CSixDOFAUV * CMVSim::GetSubscriber ( const std::string &  sName) [protected]

Definition at line 152 of file MVSim.cpp.

bool CMVSim::Initialise ( ) [protected]

Definition at line 307 of file MVSim.cpp.

bool CMVSim::Iterate ( ) [protected, 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 177 of file MVSim.cpp.

bool CMVSim::LogStartConditions ( ) [protected]

Definition at line 722 of file MVSim.cpp.

bool CMVSim::MakeAUV ( std::string  sConfig) [protected]

Simply make an AUV object.

Definition at line 516 of file MVSim.cpp.

bool CMVSim::MakeBeacon ( std::string  sConfig) [protected]

Definition at line 611 of file MVSim.cpp.

bool CMVSim::NeedToMail ( ) [protected]

Definition at line 291 of file MVSim.cpp.

bool CMVSim::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 76 of file MVSim.cpp.

bool CMVSim::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:
NewMaila list of new mail messages

Reimplemented from CMOOSApp.

Definition at line 107 of file MVSim.cpp.

bool CMVSim::OnStartUp ( ) [virtual]

called just before the main app loop is entered. Specific initialisation code can be written in an overloaded version of this function

over load this if you want to do something fancy at statup...

Reimplemented from CMOOSApp.

Definition at line 298 of file MVSim.cpp.

bool CMVSim::OpenLogFile ( ) [protected]

Definition at line 709 of file MVSim.cpp.

void CMVSim::PostResults ( ) [protected]

Definition at line 387 of file MVSim.cpp.


Member Data Documentation

Definition at line 91 of file MVSim.h.

Definition at line 81 of file MVSim.h.

double CMVSim::m_dfLastMailed [protected]

Definition at line 96 of file MVSim.h.

double CMVSim::m_dfOldSimulatorTime [protected]

Definition at line 99 of file MVSim.h.

double CMVSim::m_dfSimulatorTime [protected]

Definition at line 98 of file MVSim.h.

double CMVSim::m_dfStartTime [protected]

Definition at line 97 of file MVSim.h.

double CMVSim::m_dfUpdateRate [protected]

Definition at line 92 of file MVSim.h.

Definition at line 85 of file MVSim.h.

Definition at line 82 of file MVSim.h.

Definition at line 89 of file MVSim.h.


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