Package org.orekit.propagation.events

Class AbstractTopocentricDetector<T extends AbstractDetector<T>>

java.lang.Object

org.orekit.propagation.events.AbstractDetector<T>

org.orekit.propagation.events.AbstractTopocentricDetector<T>

All Implemented Interfaces:

EventDetector

Direct Known Subclasses:

ElevationDetector, ElevationExtremumDetector, GroundAtNightDetector

public abstract class AbstractTopocentricDetector<T extends AbstractDetector<T>>
extends AbstractDetector<T>

Abstract class for detectors using a topocentric frame.

Since:

13.1

Author:

Romain Serra

See Also:

TopocentricFrame

Field Summary

Fields inherited from class org.orekit.propagation.events.AbstractDetector

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractTopocentricDetector(EventFunction eventFunction, EventDetectionSettings detectionSettings, EventHandler handler, TopocentricFrame topocentricFrame)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
double	getElevation(SpacecraftState s)	Get the elevation value.
TopocentricFrame	getTopocentricFrame()	Getter for the topocentric frame.

Methods inherited from class org.orekit.propagation.events.AbstractDetector

checkIfForward, create, getDetectionSettings, getEventFunction, getHandler, init, isForward, withDetectionSettings, withHandler, withMaxCheck, withMaxCheck, withMaxIter, withThreshold

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.EventDetector

finish, g, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

AbstractTopocentricDetector

protected AbstractTopocentricDetector(EventFunction eventFunction,
                                      EventDetectionSettings detectionSettings,
                                      EventHandler handler,
                                      TopocentricFrame topocentricFrame)

Protected constructor with full parameters.

Parameters:

eventFunction - event function

detectionSettings - event detection settings

handler - event handler to call at event occurrences

topocentricFrame - topocentric frame

Since:

14.0

Method Detail

getTopocentricFrame

public TopocentricFrame getTopocentricFrame()

Getter for the topocentric frame.

Returns:

frame

getElevation

public double getElevation(SpacecraftState s)

Get the elevation value.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

spacecraft elevation