gps.log.out
Class GPSArray

java.lang.Object
  gps.log.out.GPSFile
      gps.log.out.GPSArray

All Implemented Interfaces:

GPSFileConverterInterface, GPSFileConfInterface, GPSFileInterface

public final class GPSArray
extends GPSFile

Class to output to an internal array.

Author:

Mario De Weerd

Field Summary

Fields inherited from class gps.log.out.GPSFile

FILE_SPLIT_NONE, FILE_SPLIT_ONE_FILE_PER_DAY, FILE_SPLIT_ONE_FILE_PER_TRACK

Constructor Summary

GPSArray()

Method Summary

void	finaliseFile() Method called when all parsing is finished and the last file has to be closed.
GPSRecord[]	getGpsTrackPoints()
GPSRecord[]	getGpsWayPoints()
TracksAndWayPoints	getResult()
void	initialiseFile(BT747Path baseName, java.lang.String extension, int fileSeparationFreq) This function has to be called at some time to initialize the file conversion.
boolean	needPassToFindFieldsActivatedInLog()
boolean	nextPass() Called when the input file has been parsed.
void	writeRecord(GPSRecord s) Called for any new position.

Methods inherited from class gps.log.out.GPSFile

addLogRecord, cachedRecordIsNeeded, getBadTrackColor, getErrorInfo, getFilesCreated, getGoodTrackColor, getMaxDiff, getNbrFilesCreated, getParamObject, getUserWayPointList, isAddLogConditionInfo, isOverridePreviousTag, isRecordNbrInLogs, setActiveFileFields, setAddLogConditionInfo, setBadTrackColor, setFilenameBuilder, setFilters, setGoodTrackColor, setImperial, setIncludeTrkComment, setIncludeTrkName, setMaxDiff, setOutputFields, setOverridePreviousTag, setParamObject, setRecordNbrInLogs, setTimeOffset, setTrackSepTime, setUserWayPointList, setWayPointTimeCorrection, writeLogFmtHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

GPSArray

public GPSArray()

Method Detail

initialiseFile

public void initialiseFile(BT747Path baseName,
                           java.lang.String extension,
                           int fileSeparationFreq)

Description copied from class: GPSFile

This function has to be called at some time to initialize the file conversion. Other parameters can be set through other methods.

Specified by:

initialiseFile in interface GPSFileConfInterface

Overrides:

initialiseFile in class GPSFile

Parameters:

baseName - Base name of the output file. This value will be provided to the filename builder.

extension - Extension of the output file. This value will be provided to the filename builder.

fileSeparationFreq - Indicates how the file must be separated.

See Also:

AppSettings.SPLIT_ONE_FILE, AppSettings.SPLIT_ONE_FILE_PER_DAY, AppSettings.SPLIT_ONE_FILE_PER_TRACK

needPassToFindFieldsActivatedInLog

public final boolean needPassToFindFieldsActivatedInLog()

Specified by:

needPassToFindFieldsActivatedInLog in interface GPSFileConverterInterface

Overrides:

needPassToFindFieldsActivatedInLog in class GPSFile

finaliseFile

public void finaliseFile()

Description copied from class: GPSFile

Method called when all parsing is finished and the last file has to be closed.
This method can be extended. It closes the output file by default, so super() should be called once other handling is finished.

Specified by:

finaliseFile in interface GPSFileConverterInterface

Overrides:

finaliseFile in class GPSFile

nextPass

public final boolean nextPass()

Description copied from class: GPSFile

Called when the input file has been parsed. This method checks if other passes are needed and performs some closing operations if that is not the case.
This method must be extended, call super.nextPass() and then update nbrOfPassesToGo.

Specified by:

nextPass in interface GPSFileConverterInterface

Overrides:

nextPass in class GPSFile

Returns:

true if analysis must go on.

writeRecord

public final void writeRecord(GPSRecord s)

Description copied from class: GPSFile

Called for any new position. This method is called by the input analysis class and should be extended for the output format. The extension must call super(). That will make sure that the appropriate files are opened, and the GPSFile.t property set.

Overrides:

writeRecord in class GPSFile

Parameters:

s - information regarding the position.

getGpsTrackPoints

public final GPSRecord[] getGpsTrackPoints()

getGpsWayPoints

public final GPSRecord[] getGpsWayPoints()

getResult

public final TracksAndWayPoints getResult()

Returns:

the result