Package org.orekit.propagation.events

Class LongitudeRangeCrossingDetector

java.lang.Object

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

org.orekit.propagation.events.LongitudeRangeCrossingDetector

All Implemented Interfaces:

EventDetector

public class LongitudeRangeCrossingDetector
extends AbstractDetector<LongitudeRangeCrossingDetector>

Detector for geographic longitude crossing.

This detector identifies when a spacecraft crosses a fixed longitude range with respect to a central body.

Since:

12.0

Author:

Alberto Ferrero

Field Summary

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	LongitudeRangeCrossingDetector(double maxCheck, double threshold, OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Build a detector.
	LongitudeRangeCrossingDetector(OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Build a new detector.
protected	LongitudeRangeCrossingDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler, OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Private constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected LongitudeRangeCrossingDetector	create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the detection function.
OneAxisEllipsoid	getBody()	Get the body on which the geographic zone is defined.
double	getFromLongitude()	Get the fixed longitude range to be crossed (radians), lower boundary.
double	getToLongitude()	Get the fixed longitude range to be crossed (radians), upper boundary.

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

create, getDetectionSettings, getHandler, getMaxCheckInterval, getMaxIterationCount, getThreshold, 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

Constructor Detail

LongitudeRangeCrossingDetector

public LongitudeRangeCrossingDetector(OneAxisEllipsoid body,
                                      double fromLongitude,
                                      double toLongitude)

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

fromLongitude - longitude to be crossed, lower range boundary

toLongitude - longitude to be crossed, upper range boundary

LongitudeRangeCrossingDetector

public LongitudeRangeCrossingDetector(double maxCheck,
                                      double threshold,
                                      OneAxisEllipsoid body,
                                      double fromLongitude,
                                      double toLongitude)

Build a detector.

Parameters:

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

body - body on which the longitude is defined

fromLongitude - longitude to be crossed, lower range boundary

toLongitude - longitude to be crossed, upper range boundary

LongitudeRangeCrossingDetector

protected LongitudeRangeCrossingDetector(AdaptableInterval maxCheck,
                                         double threshold,
                                         int maxIter,
                                         EventHandler handler,
                                         OneAxisEllipsoid body,
                                         double fromLongitude,
                                         double toLongitude)

Private constructor with full parameters.

This constructor is private 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:

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

maxIter - maximum number of iterations in the event time search

handler - event handler to call at event occurrences

body - body on which the longitude is defined

fromLongitude - longitude to be crossed, lower range boundary

toLongitude - longitude to be crossed, upper range boundary

Method Detail

create

protected LongitudeRangeCrossingDetector create(AdaptableInterval newMaxCheck,
                                                double newThreshold,
                                                int newMaxIter,
                                                EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<LongitudeRangeCrossingDetector>

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 WARNING: this method will be removed in 13.0. It doesn't have the deprecated annotation because the method is abstract and shall be implemented

getBody

public OneAxisEllipsoid getBody()

Get the body on which the geographic zone is defined.

Returns:

body on which the geographic zone is defined

getFromLongitude

public double getFromLongitude()

Get the fixed longitude range to be crossed (radians), lower boundary.

Returns:

fixed lower boundary longitude range to be crossed (radians)

getToLongitude

public double getToLongitude()

Get the fixed longitude range to be crossed (radians), upper boundary.

Returns:

fixed upper boundary longitude range to be crossed (radians)

g

public double g(SpacecraftState s)

Compute the value of the detection function.

The value is positive if the spacecraft longitude is inside the longitude range. The longitude value is reflected from [-PI, +PI] to [0, 2 PI] to ensure continuity.

Parameters:

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

Returns:

positive if spacecraft inside the range