Package org.orekit.propagation.events

Class FieldLongitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.events.FieldAbstractDetector<FieldLongitudeRangeCrossingDetector<T>,T>

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

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldEventDetector<T>

public class FieldLongitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>
extends FieldAbstractDetector<FieldLongitudeRangeCrossingDetector<T>,T>

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldLongitudeRangeCrossingDetector(Field<T> field, OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Build a new detector.
protected	FieldLongitudeRangeCrossingDetector(FieldAdaptableInterval<T> maxCheck, T threshold, int maxIter, FieldEventHandler<T> handler, OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Private constructor with full parameters.
	FieldLongitudeRangeCrossingDetector(T maxCheck, T threshold, OneAxisEllipsoid body, double fromLongitude, double toLongitude)	Build a detector.

Method Summary

Modifier and Type	Method	Description
protected FieldLongitudeRangeCrossingDetector<T>	create(FieldAdaptableInterval<T> newMaxCheck, T newThreshold, int newMaxIter, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> 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.FieldAbstractDetector

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldLongitudeRangeCrossingDetector

public FieldLongitudeRangeCrossingDetector(Field<T> field,
                                           OneAxisEllipsoid body,
                                           double fromLongitude,
                                           double toLongitude)

Build a new detector.

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

Parameters:

field - the type of numbers to use.

body - body on which the longitude is defined

fromLongitude - longitude to be crossed, lower range boundary

toLongitude - longitude to be crossed, upper range boundary

FieldLongitudeRangeCrossingDetector

public FieldLongitudeRangeCrossingDetector(T maxCheck,
                                           T 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

FieldLongitudeRangeCrossingDetector

protected FieldLongitudeRangeCrossingDetector(FieldAdaptableInterval<T> maxCheck,
                                              T threshold,
                                              int maxIter,
                                              FieldEventHandler<T> 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 FieldLongitudeRangeCrossingDetector<T> create(FieldAdaptableInterval<T> newMaxCheck,
                                                        T newThreshold,
                                                        int newMaxIter,
                                                        FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

create in class FieldAbstractDetector<FieldLongitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

newMaxCheck - maximum checking interval

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 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 T g(FieldSpacecraftState<T> 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.

Specified by:

g in interface FieldEventDetector<T extends CalculusFieldElement<T>>

Specified by:

g in class FieldAbstractDetector<FieldLongitudeRangeCrossingDetector<T extends CalculusFieldElement<T>>,T extends CalculusFieldElement<T>>

Parameters:

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

Returns:

positive if spacecraft inside the range