OceanLoading Class Reference
[GPS solution algorithms and Tropospheric]

#include <OceanLoading.hpp>

Collaboration diagram for OceanLoading:

[legend]List of all members.

---

Detailed Description

This class computes the effect of ocean tides at a given position and epoch.

A typical way to use this class follows:

      // Create a time object
   DayTime time(2004, 25, 0.0);

      // Object to store results
   Triple tides;

      // Load ocean loading object with ocean tides harmonics data
   OceanLoading ocean("EBRE.BLQ");

      // Compute ocean loading effect in Up-East-North [UEN]
      // reference frame
   tides = ocean.getOceanLoading("EBRE", time);

This model neglects minor tides and nodal modulations, which may lead to errors up to 5 mm (RMS) at high latitutes. For more details, please see:

http://tai.bipm.org/iers/convupdt/convupdt_c7.html

Definition at line 80 of file OceanLoading.hpp.

Public Member Functions
	OceanLoading (string filename="oceanloading.blq")
	Common constructor.
Triple	getOceanLoading (const string &name, const DayTime &t) throw (InvalidRequest)
	Returns the effect of ocean tides loading (meters) at the given station and epoch, in the Up-East-North (UEN) reference frame.
virtual string	getFilename (void) const
	Returns the name of BLQ file containing ocean tides harmonics data.
virtual OceanLoading &	setFilename (const string &name)
	Sets the name of BLQ file containing ocean tides harmonics data.
virtual	~OceanLoading ()
	Destructor.

---

Constructor & Destructor Documentation

OceanLoading (  string  filename = "oceanloading.blq"  )  [inline]

Common constructor. Parameters: filename  Name of BLQ file containing ocean tide harmonics data. Warning: If filename is not given, this class will look for a file named "oceanloading.blq" in the current directory. Definition at line 92 of file OceanLoading.hpp.

virtual ~OceanLoading (   )  [inline, virtual]

Destructor. Definition at line 127 of file OceanLoading.hpp.

---

Member Function Documentation

virtual string getFilename (  void   )  const [inline, virtual]

Returns the name of BLQ file containing ocean tides harmonics data. Definition at line 115 of file OceanLoading.hpp.

Triple getOceanLoading (  const string &  name, const DayTime &  t )  throw (InvalidRequest)

Returns the effect of ocean tides loading (meters) at the given station and epoch, in the Up-East-North (UEN) reference frame. Parameters: name  Station name (case is NOT relevant). time  Epoch to look up Returns: a Triple with the ocean tidas loading effect, in meters and in the UEN reference frame. Exceptions: InvalidRequest  If the request can not be completed for any reason, this is thrown. The text may have additional information about the reason the request failed. Definition at line 52 of file OceanLoading.cpp. References gpstk::cos().

OceanLoading & setFilename (  const string &  name  )  [virtual]

Sets the name of BLQ file containing ocean tides harmonics data. Parameters: name  Name of BLQ tides harmonics data file. Definition at line 103 of file OceanLoading.cpp. References BLQDataReader::open().

---

The documentation for this class was generated from the following files:

• OceanLoading.hpp
• OceanLoading.cpp

---