FakeRecord Class Reference

A class used to generate fake sonar telegrams from some models. More...

#include <FakeRecord.h>

Collaboration diagram for FakeRecord:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 FakeRecord (FakeBathymetry &bathymetry, FakeMotion &motion, FakeTide &tide, FakeTime &ftime)
 Ctor.
 ~FakeRecord ()
 Dtor.
bool advance ()
 Advanes the state of the machine by emitting at least one of the least frequent record types to the output file.

Detailed Description

A class used to generate fake sonar telegrams from some models.

An object of the class is used generate sonar telegrams from a set of input data. The data are bathymetry, motion and tide.

Definition at line 15 of file FakeRecord.h.


Constructor & Destructor Documentation

FakeRecord::FakeRecord ( FakeBathymetry bathymetry,
FakeMotion &  motion,
FakeTide &  tide,
FakeTime &  ftime 
)

Ctor.

Parameters:
bathymetry The bathymetry model.
motion The motion model.
tide The tide model.
ftime The time model

FakeRecord::~FakeRecord (  ) 

Dtor.


Member Function Documentation

bool FakeRecord::advance (  ) 

Advanes the state of the machine by emitting at least one of the least frequent record types to the output file.

The number of other records required to achieve this are emmitted.

Returns:
If all records to be emited where emited then return true. A false return can be interpreted as a fatal error and there is not point in continueing.


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