gnsstk::OceanLoading Class Reference

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
CommonTime 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 92 of file OceanLoading.hpp.

#include <OceanLoading.hpp>

Public Member Functions
virtual std::string	getFilename (void) const
	Returns the name of BLQ file containing ocean tides harmonics data. More...
Triple	getOceanLoading (const std::string &name, const CommonTime &t)
	OceanLoading (std::string filename="oceanloading.blq")
virtual OceanLoading &	setFilename (const std::string &name)
virtual	~OceanLoading ()
	Destructor. More...

Private Member Functions
virtual Vector< double >	getArg (const CommonTime &time)

Private Attributes
BLQDataReader	blqData
	Object to read BLQ ocean tides harmonics data file. More...
std::string	fileData
	Name of BLQ file containing ocean tides harmonics data. More...

Constructor & Destructor Documentation

OceanLoading()

gnsstk::OceanLoading::OceanLoading ( std::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 104 of file OceanLoading.hpp.

~OceanLoading()

virtual gnsstk::OceanLoading::~OceanLoading ( )

inlinevirtual

Destructor.

Definition at line 138 of file OceanLoading.hpp.

Member Function Documentation

getArg()

Vector< double > gnsstk::OceanLoading::getArg ( const CommonTime &  time )

privatevirtual

Compute the value of the corresponding astronomical arguments, in radians. This routine is based on IERS routine ARG.f.

Parameters

time	Epoch of interest

Returns

A Vector<double> of 11 elements with the corresponding astronomical arguments to be used in ocean loading model.

Definition at line 138 of file OceanLoading.cpp.

getFilename()

virtual std::string gnsstk::OceanLoading::getFilename ( void  ) const

inlinevirtual

Returns the name of BLQ file containing ocean tides harmonics data.

Definition at line 126 of file OceanLoading.hpp.

getOceanLoading()

Triple gnsstk::OceanLoading::getOceanLoading	(	const std::string &	name,
		const CommonTime &	t
	)

Returns the effect of ocean tides loading (meters) at the given station and epoch, in the Up-East-North (UEN) reference frame.

Parameters

[in]	name	Station name (case is NOT relevant).
[in]	t	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 67 of file OceanLoading.cpp.

setFilename()

OceanLoading & gnsstk::OceanLoading::setFilename ( const std::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 117 of file OceanLoading.cpp.

Member Data Documentation

blqData

BLQDataReader gnsstk::OceanLoading::blqData

private

Object to read BLQ ocean tides harmonics data file.

Definition at line 138 of file OceanLoading.hpp.

fileData

std::string gnsstk::OceanLoading::fileData

private

Name of BLQ file containing ocean tides harmonics data.

Definition at line 149 of file OceanLoading.hpp.

---

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

• OceanLoading.hpp
• OceanLoading.cpp