Package org.orekit.propagation.events

Class LatitudeExtremumDetector

java.lang.Object

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

org.orekit.propagation.events.AbstractGeographicalDetector<LatitudeExtremumDetector>

org.orekit.propagation.events.LatitudeExtremumDetector

All Implemented Interfaces:

EventDetector

public class LatitudeExtremumDetector
extends AbstractGeographicalDetector<LatitudeExtremumDetector>

Detector for geographic latitude extremum.

This detector identifies when a spacecraft reaches its extremum latitudes with respect to a central body.

Since:

7.1

Author:

Luc Maisonobe

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
	LatitudeExtremumDetector(double maxCheck, double threshold, BodyShape body)	Build a detector.
	LatitudeExtremumDetector(BodyShape body)	Build a new detector.
	LatitudeExtremumDetector(LatitudeExtremumEventFunction latitudeExtremumEventFunction)	Constructor with event function.
protected	LatitudeExtremumDetector(LatitudeExtremumEventFunction latitudeExtremumEventFunction, EventDetectionSettings detectionSettings, EventHandler handler)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected LatitudeExtremumDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the detection function.

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

getBodyShape

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

checkIfForward, 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, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

LatitudeExtremumDetector

public LatitudeExtremumDetector(BodyShape body)

Build a new detector.

The new instance uses default values for maximal checking interval (AbstractDetector.DEFAULT_MAX_CHECK) and convergence threshold (AbstractDetector.DEFAULT_THRESHOLD).

Parameters:

body - body on which the latitude is defined

LatitudeExtremumDetector

public LatitudeExtremumDetector(double maxCheck,
                                double threshold,
                                BodyShape body)

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the latitude is defined

LatitudeExtremumDetector

public LatitudeExtremumDetector(LatitudeExtremumEventFunction latitudeExtremumEventFunction)

Constructor with event function.

Parameters:

latitudeExtremumEventFunction - event function

Since:

14.0

LatitudeExtremumDetector

protected LatitudeExtremumDetector(LatitudeExtremumEventFunction latitudeExtremumEventFunction,
                                   EventDetectionSettings detectionSettings,
                                   EventHandler handler)

Protected constructor with full parameters.

This constructor is not public as users are expected to use the builder API with the various withXxx() methods to set up the instance in a readable manner without using a huge amount of parameters.

Parameters:

latitudeExtremumEventFunction - event function

detectionSettings - event detection settings

handler - event handler to call at event occurrences

Method Detail

create

protected LatitudeExtremumDetector create(EventDetectionSettings detectionSettings,
                                          EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LatitudeExtremumDetector>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

g

public double g(SpacecraftState s)

Compute the value of the detection function.

The value is the spacecraft latitude time derivative.

Parameters:

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

Returns:

spacecraft latitude time derivative