Package aris.fileio

Class ARISFileCatalog

java.lang.Object

tritechgemini.fileio.GeminiFileCatalog<ARISImageRecord>

aris.fileio.ARISFileCatalog

All Implemented Interfaces:

Serializable

public class ARISFileCatalog
extends GeminiFileCatalog<ARISImageRecord>

File catalog for ARIS sonar files. file format is very simple compared to Tritech files. Details are at https://github.com/SoundMetrics/aris-file-sdk/tree/master

Author:

Doug Gillespie

See Also:

• Serialized Form

Field Summary

Fields inherited from class tritechgemini.fileio.GeminiFileCatalog

ARISEND, DATEND, ECDEND, GLFEND

Constructor Summary

Constructors

Constructor	Description
ARISFileCatalog(String filePath)

Method Summary

Modifier and Type	Method	Description
boolean	buildCatalogue(ArrayList<ARISImageRecord> imageRecords)	Catalogue the file.
protected void	checkDeserialisedCatalog(String filePath)	Called just after a catalogue object has been deserialised, giving the opportunity to check anything.
boolean	loadFullRecord(ARISImageRecord arisRecord)	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

Constructor Details

ARISFileCatalog

public ARISFileCatalog(String filePath)

Method Details

checkDeserialisedCatalog

protected void checkDeserialisedCatalog(String filePath)

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<ARISImageRecord>

Parameters:

filePath -

buildCatalogue

public boolean buildCatalogue(ArrayList<ARISImageRecord> 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<ARISImageRecord>

Parameters:

imageRecords -

Returns:

true if catalog created successfully

Throws:

Exception

loadFullRecord

public boolean loadFullRecord(ARISImageRecord arisRecord)
                       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<ARISImageRecord>

Parameters:

arisRecord -

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<ARISImageRecord>

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<ARISImageRecord>