Package org.orekit.propagation.events

Class PlaneCrossingDetector

java.lang.Object

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

org.orekit.propagation.events.PlaneCrossingDetector

All Implemented Interfaces:

EventDetector

public class PlaneCrossingDetector
extends AbstractDetector<PlaneCrossingDetector>

Finder for plane crossing events.

Since:

14.0

Author:

Romain Serra

See Also:

PlaneCrossingFunction

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
PlaneCrossingDetector(EventDetectionSettings detectionSettings, EventHandler handler, PlaneCrossingFunction planeCrossingFunction)	Constructor with detection settings and handler.

Method Summary

Modifier and Type	Method	Description
protected PlaneCrossingDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the switching function.

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

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

finish, getMaxCheckInterval, getMaxIterationCount, getThreshold, reset

Constructor Detail

PlaneCrossingDetector

public PlaneCrossingDetector(EventDetectionSettings detectionSettings,
                             EventHandler handler,
                             PlaneCrossingFunction planeCrossingFunction)

Constructor with detection settings and handler.

Parameters:

detectionSettings - event detection settings

handler - event handler to call at event occurrences

planeCrossingFunction - event function

Method Detail

create

protected PlaneCrossingDetector create(EventDetectionSettings detectionSettings,
                                       EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<PlaneCrossingDetector>

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)

Description copied from interface: EventDetector

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Parameters:

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

Returns:

value of the switching function