gps.log.out
Interface GPSFileConfInterface

All Known Subinterfaces:

GPSFileInterface

All Known Implementing Classes:

ExternalToolConvert, GPSArray, GPSCompoGPSTrkFile, GPSCSVFile, GPSFile, GpsFileProxyTemplate, GPSGmapsHTMLEncodedFile, GPSGmapsHTMLFile, GPSGoogleStaticMapUrl, GPSGPXFile, GPSKMLFile, GPSKMZFile, GPSNMEAFile, GPSOSMUploadFile, GPSPLTFile, GPSPostGISFile, GPSSqlFile

public interface GPSFileConfInterface

Method Summary

GPSConversionParameters	getParamObject()
void	initialiseFile(BT747Path baseName, java.lang.String extension, int fileSeparationFreq) This function has to be called at some time to initialize the file conversion.
void	setActiveFileFields(GPSRecord activeFileFieldsFormat) Called to set the fields that are active in the current input.
void	setAddLogConditionInfo(boolean addLogConditionInfo)
void	setBadTrackColor(java.lang.String badTrackColor)
void	setFilenameBuilder(BT747FileName filenameBuilder)
void	setFilters(GPSFilter[] ourFilters) Set the track point and way point filters.
void	setGoodTrackColor(java.lang.String goodTrackColor)
void	setImperial(boolean useImperial) Indicate whether Imperial units (miles, knots, mph) should be used.
void	setIncludeTrkComment(boolean isTrkComment)
void	setIncludeTrkName(boolean isIncludeTrkName)
void	setMaxDiff(int maxDiff)
void	setOutputFields(GPSRecord selectedOutputFields) Set the fields that should be written to the output.
void	setOverridePreviousTag(boolean overridePreviousTag)
void	setParamObject(GPSConversionParameters paramObject)
void	setRecordNbrInLogs(boolean recordNbrInLogs)
void	setTimeOffset(int offset) The time offset to apply to the output records in seconds.
void	setTrackSepTime(int time) Set the track separation time.
void	setUserWayPointList(GPSRecord[] list) Entry must be an ordered list (UTC time).
void	setWayPointTimeCorrection(int seconds)

Method Detail

initialiseFile

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

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

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

setTrackSepTime

void setTrackSepTime(int time)

Set the track separation time.

Parameters:

time - Seconds of unavailable positions require before deciding to hava a new track.

setActiveFileFields

void setActiveFileFields(GPSRecord activeFileFieldsFormat)

Called to set the fields that are active in the current input. This is set by the internal algorithm that analyses the input file.

Parameters:

activeFileFieldsFormat -

setOutputFields

void setOutputFields(GPSRecord selectedOutputFields)

Set the fields that should be written to the output. This can be a superset of the active file fields, but only the fields that are both active and selected for output will be available in the output files. This is to be configured from the application.

Parameters:

selectedOutputFields -

setFilters

void setFilters(GPSFilter[] ourFilters)

Set the track point and way point filters. To be called from the application.

Parameters:

ourFilters - Track point and way point filters.

setImperial

void setImperial(boolean useImperial)

Indicate whether Imperial units (miles, knots, mph) should be used.

Parameters:

useImperial - when true, use imperial units.

setUserWayPointList

void setUserWayPointList(GPSRecord[] list)

Entry must be an ordered list (UTC time).

Parameters:

list -

setWayPointTimeCorrection

void setWayPointTimeCorrection(int seconds)

setBadTrackColor

void setBadTrackColor(java.lang.String badTrackColor)

Parameters:

badTrackColor - The badTrackColor to set.

setGoodTrackColor

void setGoodTrackColor(java.lang.String goodTrackColor)

Parameters:

goodTrackColor - The goodTrackColor to set.

setRecordNbrInLogs

void setRecordNbrInLogs(boolean recordNbrInLogs)

Parameters:

recordNbrInLogs - The recordNbrInLogs to set.

setAddLogConditionInfo

void setAddLogConditionInfo(boolean addLogConditionInfo)

setIncludeTrkComment

void setIncludeTrkComment(boolean isTrkComment)

setIncludeTrkName

void setIncludeTrkName(boolean isIncludeTrkName)

setFilenameBuilder

void setFilenameBuilder(BT747FileName filenameBuilder)

setTimeOffset

void setTimeOffset(int offset)

The time offset to apply to the output records in seconds.

Parameters:

offset - The time offset in seconds.

setMaxDiff

void setMaxDiff(int maxDiff)

Parameters:

maxDiff - the maxDiff to set

setOverridePreviousTag

void setOverridePreviousTag(boolean overridePreviousTag)

Parameters:

overridePreviousTag - the overridePreviousTag to set

setParamObject

void setParamObject(GPSConversionParameters paramObject)

getParamObject

GPSConversionParameters getParamObject()