pt.lsts.neptus.util.bathymetry

Class TidCachedData

java.lang.Object

pt.lsts.neptus.util.bathymetry.TidCachedData

All Implemented Interfaces:

TidePredictionFinder

public class TidCachedData
extends java.lang.Object

Author:

Paulo Dias

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.SortedSet<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak>	cachedData
protected boolean	loading
protected java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
TidCachedData(java.io.File file) Loads the Tide file.

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.util.Date d) Tests if the date is within data.
static void	convertTideTxtIntoTid()
java.util.Date	fetchData(java.lang.String portName, java.util.Date aroundDate)
protected java.io.File	getFileToSave(java.lang.String portName)
java.lang.String	getName() The harbor/location name.
java.util.Vector<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak>	getTidePeaks()
java.lang.Float	getTidePrediction(java.util.Date date, boolean print) Method that each class that implements this one must provide that transforms a date into a height.
void	loadFile(java.io.File f)
static void	main(java.lang.String[] args)
void	saveFile(java.lang.String port, java.io.File f)
static void	test(java.lang.String[] args)
void	update(java.util.Vector<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak> newData)

Methods inherited from class java.lang.Object

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

Field Detail

loading

protected boolean loading

cachedData

protected java.util.SortedSet<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak> cachedData

name

protected java.lang.String name

Constructor Detail

TidCachedData

public TidCachedData(java.io.File file)

Loads the Tide file.

Parameters:

file -

Method Detail

loadFile

public void loadFile(java.io.File f)
              throws java.lang.Exception

Throws:

java.lang.Exception

saveFile

public void saveFile(java.lang.String port,
                     java.io.File f)
              throws java.lang.Exception

Throws:

java.lang.Exception

getFileToSave

protected java.io.File getFileToSave(java.lang.String portName)

Parameters:

portName -

Returns:

fetchData

public java.util.Date fetchData(java.lang.String portName,
                                java.util.Date aroundDate)
                         throws java.lang.Exception

Throws:

java.lang.Exception

convertTideTxtIntoTid

public static void convertTideTxtIntoTid()

test

public static void test(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getName

public java.lang.String getName()

Description copied from interface: TidePredictionFinder

The harbor/location name.

Specified by:

getName in interface TidePredictionFinder

Returns:

update

public void update(java.util.Vector<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak> newData)

getTidePeaks

public java.util.Vector<pt.lsts.neptus.util.bathymetry.CachedData.TidePeak> getTidePeaks()

contains

public boolean contains(java.util.Date d)

Description copied from interface: TidePredictionFinder

Tests if the date is within data.

Specified by:

contains in interface TidePredictionFinder

Returns:

getTidePrediction

public java.lang.Float getTidePrediction(java.util.Date date,
                                         boolean print)
                                  throws java.lang.Exception

Description copied from interface: TidePredictionFinder

Method that each class that implements this one must provide that transforms a date into a height.

Specified by:

getTidePrediction in interface TidePredictionFinder

Returns:

returns 0 in case the tide cannot be predicted

Throws:

java.lang.Exception