org.orekit.propagation.events

Class LongitudeExtremumDetector

java.lang.Object

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

org.orekit.propagation.events.LongitudeExtremumDetector

All Implemented Interfaces:

Serializable, EventDetector

public class LongitudeExtremumDetector
extends AbstractDetector<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

See Also:

Serialized Form

Field Summary

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
LongitudeExtremumDetector(double maxCheck, double threshold, OneAxisEllipsoid body) Build a detector.
LongitudeExtremumDetector(OneAxisEllipsoid body) Build a new detector.

Method Summary

Modifier and Type	Method and Description
protected LongitudeExtremumDetector	create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<? super LongitudeExtremumDetector> newHandler) Build a new instance.
double	g(SpacecraftState s) Compute the value of the detection function.
BodyShape	getBody() Get the body on which the geographic zone is defined.

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

eventOccurred, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, init, isForward, resetState, withHandler, withMaxCheck, withMaxIter, withThreshold

Methods inherited from class java.lang.Object

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

Constructor Detail

LongitudeExtremumDetector

public LongitudeExtremumDetector(OneAxisEllipsoid body)

Build a new detector.

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

Parameters:

body - body on which the longitude is defined

LongitudeExtremumDetector

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

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the longitude is defined

Method Detail

create

protected LongitudeExtremumDetector create(double newMaxCheck,
                                           double newThreshold,
                                           int newMaxIter,
                                           EventHandler<? super LongitudeExtremumDetector> newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LongitudeExtremumDetector>

Parameters:

newMaxCheck - maximum checking interval (s)

newThreshold - convergence threshold (s)

newMaxIter - maximum number of iterations in the event time search

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getBody

public BodyShape getBody()

Get the body on which the geographic zone is defined.

Returns:

body on which the geographic zone is defined

g

public double g(SpacecraftState s)
         throws OrekitException

Compute the value of the detection function.

The value is the spacecraft longitude time derivative.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector<LongitudeExtremumDetector>

Parameters:

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

Returns:

spacecraft longitude time derivative

Throws:

OrekitException - if some specific error occurs