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.FieldAbstractGeographicalDetector<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 FieldAbstractGeographicalDetector<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_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Modifier	Constructor	Description
	FieldLongitudeRangeCrossingDetector(Field<T> field, BodyShape body, double fromLongitude, double toLongitude)	Build a new detector.
protected	FieldLongitudeRangeCrossingDetector(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> handler, BodyShape body, double fromLongitude, double toLongitude)	Protected constructor with full parameters.
	FieldLongitudeRangeCrossingDetector(T maxCheck, T threshold, BodyShape body, double fromLongitude, double toLongitude)	Build a detector.

Method Summary

Modifier and Type	Method	Description
protected FieldLongitudeRangeCrossingDetector<T>	create(FieldEventDetectionSettings<T> detectionSettings, FieldEventHandler<T> newHandler)	Build a new instance.
T	g(FieldSpacecraftState<T> s)	Compute the value of the detection function.
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.
LongitudeRangeCrossingDetector	toEventDetector(EventHandler eventHandler)	Build non-Field instance.

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

getBodyShape

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

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

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Details

FieldLongitudeRangeCrossingDetector

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

Build a new detector.

The new instance uses default values for maximal checking interval (FieldAbstractDetector.DEFAULT_MAX_CHECK) 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,
 BodyShape 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(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> handler,
 BodyShape body,
 double fromLongitude,
 double toLongitude)

Protected 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:

detectionSettings - event detection settings

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

Since:

13.0

Method Details

create

protected FieldLongitudeRangeCrossingDetector<T> create(FieldEventDetectionSettings<T> detectionSettings,
 FieldEventHandler<T> newHandler)

Build a new instance.

Specified by:

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

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

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.

Parameters:

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

Returns:

positive if spacecraft inside the range

toEventDetector

public LongitudeRangeCrossingDetector toEventDetector(EventHandler eventHandler)

Build non-Field instance.

Overrides:

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

Parameters:

eventHandler - event handler

Returns:

event detector