org.orekit.tutorials.yaml

Class TutorialStationDisplacement

java.lang.Object

org.orekit.tutorials.yaml.TutorialStationDisplacement

public class TutorialStationDisplacement
extends Object

Initial data to initialize the station displacement.

Data are read from a YAML file. Station displacement are:

• Tidal displacement: displacement of reference points due to tidal effects.
• Ocean loading: displacement of reference points due to ocean loading.

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
TutorialStationDisplacement()

Method Summary

Modifier and Type	Method and Description
boolean	isWithOceanLoadingCorrection() Get the flag for the computation of ocean loading correction.
boolean	isWithTidalCorrection() Get the flag for the computation of the tidal displacement.
boolean	removePermanentDeformation() Get the flag for permanent deformation.
void	setRemovePermanentDeformation(boolean removePermanentDeformation) Set the flag for permanent deformation.
void	setWithOceanLoadingCorrection(boolean withOceanLoadingCorrection) Set the flag for the computation of ocean loading correction.
void	setWithTidalCorrection(boolean withTidalCorrection) Set the flag for the computation of the tidal displacement.

Methods inherited from class java.lang.Object

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

Constructor Detail

TutorialStationDisplacement

public TutorialStationDisplacement()

Method Detail

isWithTidalCorrection

public boolean isWithTidalCorrection()

Get the flag for the computation of the tidal displacement.

Returns:

true if tidal displacement are computed

setWithTidalCorrection

public void setWithTidalCorrection(boolean withTidalCorrection)

Set the flag for the computation of the tidal displacement.

Parameters:

withTidalCorrection - true if tidal displacement are computed

removePermanentDeformation

public boolean removePermanentDeformation()

Get the flag for permanent deformation.

Returns:

if true, the station coordinates are considered mean tide and already include the permanent deformation, hence it should be removed from the displacement to avoid considering it twice; if false, the station coordinates are considered conventional tide free so the permanent deformation must be included in the displacement

setRemovePermanentDeformation

public void setRemovePermanentDeformation(boolean removePermanentDeformation)

Set the flag for permanent deformation.

Parameters:

removePermanentDeformation - if true, the station coordinates are considered mean tide and already include the permanent deformation, hence it should be removed from the displacement to avoid considering it twice; if false, the station coordinates are considered conventional tide free so the permanent deformation must be included in the displacement

isWithOceanLoadingCorrection

public boolean isWithOceanLoadingCorrection()

Get the flag for the computation of ocean loading correction.

Returns:

true if ocean loading correction is computed

setWithOceanLoadingCorrection

public void setWithOceanLoadingCorrection(boolean withOceanLoadingCorrection)

Set the flag for the computation of ocean loading correction.

Parameters:

withOceanLoadingCorrection - true if ocean loading correction is computed