org.orekit.propagation.events

Class HaloXZPlaneCrossingDetector

java.lang.Object

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

org.orekit.propagation.events.HaloXZPlaneCrossingDetector

All Implemented Interfaces:

EventDetector

public class HaloXZPlaneCrossingDetector
extends AbstractDetector<HaloXZPlaneCrossingDetector>

Detector for XZ Plane crossing.

Since:

10.2

Author:

Vincent Mouraux

Field Summary

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

DEFAULT_MAX_ITER, DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
HaloXZPlaneCrossingDetector(double maxCheck, double threshold) Simple Constructor.

Method Summary

Modifier and Type	Method and Description
protected HaloXZPlaneCrossingDetector	create(double newMaxCheck, double newThreshold, int newMaxIter, EventHandler<? super HaloXZPlaneCrossingDetector> newHandler) Build a new instance.
double	g(SpacecraftState s) Compute the value of the detection function.

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

HaloXZPlaneCrossingDetector

public HaloXZPlaneCrossingDetector(double maxCheck,
                                   double threshold)

Simple Constructor.

Parameters:

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

Method Detail

create

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

Build a new instance.

Specified by:

create in class AbstractDetector<HaloXZPlaneCrossingDetector>

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

g

public double g(SpacecraftState s)

Compute the value of the detection function.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector<HaloXZPlaneCrossingDetector>

Parameters:

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

Returns:

Position on Y axis