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(EventDetectionSettings detectionSettings, EventHandler handler)	Protected constructor with full parameters.

Method Summary

Modifier and Type	Method	Description
protected HaloXZPlaneCrossingDetector	create(EventDetectionSettings detectionSettings, 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

getDetectionSettings, 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.EventDetector

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold

Constructor Detail

HaloXZPlaneCrossingDetector

public HaloXZPlaneCrossingDetector(double maxCheck,
                                   double threshold)

Simple Constructor.

Parameters:

maxCheck - maximum checking interval (s)

threshold - convergence threshold (s)

HaloXZPlaneCrossingDetector

protected HaloXZPlaneCrossingDetector(EventDetectionSettings detectionSettings,
                                      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:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

Since:

13.0

Method Detail

create

protected HaloXZPlaneCrossingDetector create(EventDetectionSettings detectionSettings,
                                             EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<HaloXZPlaneCrossingDetector>

Parameters:

detectionSettings - detection settings

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.

Parameters:

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

Returns:

Position on Y axis