Package tritechgemini.fileio

Class ECDFileCatalog

java.lang.Object

tritechgemini.fileio.GeminiFileCatalog<ECDImageRecord>

tritechgemini.fileio.ECDFileCatalog

All Implemented Interfaces:

Serializable

public class ECDFileCatalog
extends GeminiFileCatalog<ECDImageRecord>

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEAD_MSG
static final int	HEAD_VERSION
static final int	MASK_DEFAULT
static final int	MASK_TIS_
static final int	MASK_TIS_PA
static final int	MASK_TIS_QI
static final int	MASK_TIS_RB
static final int	MASK_TIS_SCAN
static final int	MASK_TIS_SHRP
static final int	MASK_TIS_TGT
static final int	MASK_TIS_XYZ

Fields inherited from class tritechgemini.fileio.GeminiFileCatalog

ARISEND, DATEND, ECDEND, GLFEND

Constructor Summary

Constructors

Constructor	Description
ECDFileCatalog(String filePath)

Method Summary

Modifier and Type	Method	Description
boolean	buildCatalogue(ArrayList<ECDImageRecord> imageRecords)	Catalogue the file.
protected void	checkDeserialisedCatalog(String filePath2)	Called just after a catalogue object has been deserialised, giving the opportunity to check anything.
boolean	loadFullRecord(ECDImageRecord geminiRecord)	fully load a record (if it isn't already).
void	stopCatalogStream()	Stop streaming the catalog.
CatalogStreamSummary	streamCatalog(CatalogStreamObserver streamObserver)	Start a full forwards only read of the catalog from start to end, sending all records through to the streamObserver.

Methods inherited from class tritechgemini.fileio.GeminiFileCatalog

analyseCatalog, cDateToMillis, createCatalogue, findRecordForIDandTime, findRecordForIndexandTime, findRecordIndex, findRelativeRecord, freeAllImageData, freeImageData, getCatalogException, getCatalogName, getFileCatalog, getFilePath, getFirstRecordTime, getFullRecord, getImageRecords, getLastRecordTime, getMaxSonarFrames, getNumRecords, getNumSonars, getRecord, getRecordByIndex, getRecordIndex, getSonarIDs, getSonarInfo, getSonarRecord, getTimeZone, readSerializedCatalog, setImageRecords, setTimeZone, timedLoadFullRecord, writeSerializedCatalog

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

HEAD_VERSION

public static final int HEAD_VERSION

See Also:

• Constant Field Values

HEAD_MSG

public static final String HEAD_MSG

See Also:

• Constant Field Values

MASK_DEFAULT

public static final int MASK_DEFAULT

See Also:

• Constant Field Values

MASK_TIS_QI

public static final int MASK_TIS_QI

See Also:

• Constant Field Values

MASK_TIS_PA

public static final int MASK_TIS_PA

See Also:

• Constant Field Values

MASK_TIS_SCAN

public static final int MASK_TIS_SCAN

See Also:

• Constant Field Values

MASK_TIS_RB

public static final int MASK_TIS_RB

See Also:

• Constant Field Values

MASK_TIS_TGT

public static final int MASK_TIS_TGT

See Also:

• Constant Field Values

MASK_TIS_XYZ

public static final int MASK_TIS_XYZ

See Also:

• Constant Field Values

MASK_TIS_SHRP

public static final int MASK_TIS_SHRP

See Also:

• Constant Field Values

MASK_TIS_

public static final int MASK_TIS_

See Also:

• Constant Field Values

Constructor Details

ECDFileCatalog

public ECDFileCatalog(String filePath)

Method Details

buildCatalogue

public boolean buildCatalogue(ArrayList<ECDImageRecord> imageRecords)
                       throws Exception

Description copied from class: GeminiFileCatalog

Catalogue the file. i.e. go through the file and get the times and file positions of every record in the file.

Specified by:

buildCatalogue in class GeminiFileCatalog<ECDImageRecord>

Parameters:

imageRecords -

Returns:

true if catalog created successfully

Throws:

Exception

loadFullRecord

public boolean loadFullRecord(ECDImageRecord geminiRecord)
                       throws IOException

Description copied from class: GeminiFileCatalog

fully load a record (if it isn't already). This may involve going back to the file and getting and unpacking the raw data.

Specified by:

loadFullRecord in class GeminiFileCatalog<ECDImageRecord>

Parameters:

geminiRecord -

Returns:

true if load sucessful.

Throws:

IOException

streamCatalog

public CatalogStreamSummary streamCatalog(CatalogStreamObserver streamObserver)
                                   throws CatalogException

Description copied from class: GeminiFileCatalog

Start a full forwards only read of the catalog from start to end, sending all records through to the streamObserver.

Whatever calls this will almost definitely want to do so in a separate worker thread because the call will block until the read has finished.

Specified by:

streamCatalog in class GeminiFileCatalog<ECDImageRecord>

Parameters:

streamObserver - observer to get catalog data.

Returns:

number of records read.

Throws:

CatalogException

stopCatalogStream

public void stopCatalogStream()

Description copied from class: GeminiFileCatalog

Stop streaming the catalog.

Specified by:

stopCatalogStream in class GeminiFileCatalog<ECDImageRecord>

checkDeserialisedCatalog

protected void checkDeserialisedCatalog(String filePath2)

Description copied from class: GeminiFileCatalog

Called just after a catalogue object has been deserialised, giving the opportunity to check anything. note that the file path is set elsewhere to allow for the possibility that the absolute path to the file may have changed, so it's probably not necessary to do anything here.

Specified by:

checkDeserialisedCatalog in class GeminiFileCatalog<ECDImageRecord>

Parameters:

filePath2 -