Package 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

Modifier	Constructor	Description
	HaloXZPlaneCrossingDetector(double maxCheck, double threshold)	Simple Constructor.
protected	HaloXZPlaneCrossingDetector(AdaptableInterval maxCheck, double threshold, int maxIter, EventHandler handler)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected HaloXZPlaneCrossingDetector	create(AdaptableInterval newMaxCheck, double newThreshold, int newMaxIter, EventHandler 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

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

HaloXZPlaneCrossingDetector

public HaloXZPlaneCrossingDetector(double maxCheck,
                                   double threshold)

Simple Constructor.

Parameters:

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

HaloXZPlaneCrossingDetector

protected HaloXZPlaneCrossingDetector(AdaptableInterval maxCheck,
                                      double threshold,
                                      int maxIter,
                                      EventHandler handler)

Protected constructor with full parameters.

This constructor is not public 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

threshold - convergence threshold (s)

maxIter - maximum number of iterations in the event time search

handler - event handler to call at event occurrences

Method Detail

create

protected HaloXZPlaneCrossingDetector create(AdaptableInterval newMaxCheck,
                                             double newThreshold,
                                             int newMaxIter,
                                             EventHandler 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 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

g

public double g(SpacecraftState s)

Compute the value of the detection function.

Parameters:

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

Returns:

Position on Y axis