SimulatorSonarFileRecordFactory Class Reference

The factory class used to parse a sonar file. More...

#include <SimulatorSonarFileRecordFactory.h>

Inheritance diagram for SimulatorSonarFileRecordFactory:

[legend]Collaboration diagram for SimulatorSonarFileRecordFactory:

[legend]List of all members.

Public Types
enum	RecordEnumerator {   DATA_START, DATA_STOP, DEPTH, IMAGE,   POSITION }
Public Member Functions
	SimulatorSonarFileRecordFactory (const LPCTSTR &fqfn)
	Ctor.
	~SimulatorSonarFileRecordFactory ()
	Dtor.
SmartPointer< SystemRecord >	record ()
	Read the record at the current file position.
bool	operator++ ()
	Advance to the next record.

---

Detailed Description

The factory class used to parse a sonar file.

This class is the base class for classes that are able to parse sonar files. These files are characterized by having a number of record types multplexed into a single file. The ordering of these records is determined by the sonar in question but are usually produced at the time the data is collected. Sub classes of this class effecively de-multiplex these records.

Because of the nature of these data objects of this type do not, generally, support radom access (e.g. seek()).

Definition at line 29 of file SimulatorSonarFileRecordFactory.h.

---

Member Enumeration Documentation

enum SimulatorSonarFileRecordFactory::RecordEnumerator

Enumerator:

DATA_START
DATA_STOP
DEPTH
IMAGE
POSITION

Definition at line 61 of file SimulatorSonarFileRecordFactory.h.

---

Constructor & Destructor Documentation

SimulatorSonarFileRecordFactory::SimulatorSonarFileRecordFactory

(

const LPCTSTR &

fqfn

)

Ctor.

Attach to the sonar file.

Parameters:

fqfn

The sonar file.

SimulatorSonarFileRecordFactory::~SimulatorSonarFileRecordFactory

(

)

Dtor.

---

Member Function Documentation

SmartPointer<SystemRecord> SimulatorSonarFileRecordFactory::record

(

)

[virtual]

Read the record at the current file position.

Returns:

The record. This record will be NOGO if the record cannot be read. In this case this object may be NOGO if there is an urrecoverable error in the input data stream.

Implements SonarFileRecordFactory.

bool SimulatorSonarFileRecordFactory::operator++

(

)

[virtual]

Advance to the next record.

Returns:

true if able to advance to the next record. If false then either an error has occured or the file is at eof. In the former case go() will be false and in the latter case eof will be false.

Implements SonarFileRecordFactory.

---

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

• SimulatorSonarFileRecordFactory.h

Generated on Sat Nov 22 12:37:36 2008 for Swath Sonar by Doxygen 1.5.1