AbstractElevationEventFunction (OREKIT 14.0-SNAPSHOT API)

java.lang.Object
- org.orekit.propagation.events.functions.AbstractElevationEventFunction

All Implemented Interfaces:

EventFunction

Direct Known Subclasses:

MaskedElevationEventFunction, MinimumElevationEventFunction
```
public abstract class AbstractElevationEventFunction
extends Object
implements EventFunction
```
Abstract class for elevation event function.

Since:

14.0

Author:

Romain Serra

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`AbstractElevationEventFunction(AtmosphericRefractionModel refractionModel, TopocentricFrame topo)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected double`	`applyRefraction(double elevation)`	Apply refraction correction if applicable.
`protected <T extends CalculusFieldElement<T>> T`	`applyRefraction(T elevation)`	Apply refraction correction if applicable (Field version).
`AtmosphericRefractionModel`	`getRefractionModel()`	Returns the currently configured refraction model.
`TopocentricFrame`	`getTopocentricFrame()`	Getter for the topocentric frame.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.events.functions.EventFunction
dependsOnMainVariablesOnly, dependsOnTimeOnly, value, value

- Constructor Detail
  - AbstractElevationEventFunction
```
protected AbstractElevationEventFunction(AtmosphericRefractionModel refractionModel,
                                         TopocentricFrame topo)
```
    Constructor.
    
    Parameters:
    
    refractionModel - reference to refraction model (can be null in which case no correction is applied)
    
    topo - reference to a topocentric model
- Method Detail
  - getRefractionModel
```
public AtmosphericRefractionModel getRefractionModel()
```
    Returns the currently configured refraction model.
    
    Returns:
    
    refraction model
  - getTopocentricFrame
```
public TopocentricFrame getTopocentricFrame()
```
    Getter for the topocentric frame.
    
    Returns:
    
    frame
  - applyRefraction
```
protected double applyRefraction(double elevation)
```
    Apply refraction correction if applicable.
    
    Parameters:
    
    elevation - value before correction
    
    Returns:
    
    apparent elevation
  - applyRefraction
```
protected <T extends CalculusFieldElement<T>> T applyRefraction(T elevation)
```
    Apply refraction correction if applicable (Field version).
    
    Type Parameters:
    
    T - field type
    
    Parameters:
    
    elevation - value before correction
    
    Returns:
    
    apparent elevation