Package org.orekit.propagation.events

Class LongitudeExtremumDetector

java.lang.Object

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

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

org.orekit.propagation.events.LongitudeExtremumDetector

All Implemented Interfaces:

EventDetector

public class LongitudeExtremumDetector
extends AbstractGeographicalDetector<LongitudeExtremumDetector>

Detector for geographic longitude extremum.

This detector identifies when a spacecraft reaches its extremum longitudes 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
	LongitudeExtremumDetector(double maxCheck, double threshold, BodyShape body)	Build a detector.
	LongitudeExtremumDetector(BodyShape body)	Build a new detector.
	LongitudeExtremumDetector(LongitudeExtremumEventFunction longitudeExtremumEventFunction)	Constructor with event function.
protected	LongitudeExtremumDetector(LongitudeExtremumEventFunction longitudeExtremumEventFunction, EventDetectionSettings detectionSettings, EventHandler handler)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected LongitudeExtremumDetector	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 Details

LongitudeExtremumDetector

public LongitudeExtremumDetector(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 longitude is defined

LongitudeExtremumDetector

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

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the longitude is defined

LongitudeExtremumDetector

public LongitudeExtremumDetector(LongitudeExtremumEventFunction longitudeExtremumEventFunction)

Constructor with event function.

Parameters:

longitudeExtremumEventFunction - event function

Since:

14.0

LongitudeExtremumDetector

protected LongitudeExtremumDetector(LongitudeExtremumEventFunction longitudeExtremumEventFunction,
 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:

longitudeExtremumEventFunction - event function

detectionSettings - event detection settings

handler - event handler to call at event occurrences

Since:

14.0

Method Details

create

protected LongitudeExtremumDetector create(EventDetectionSettings detectionSettings,
 EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LongitudeExtremumDetector>

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 longitude time derivative.

Parameters:

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

Returns:

spacecraft longitude time derivative