Package org.orekit.propagation.events

Class SingleDateDetector

java.lang.Object

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

org.orekit.propagation.events.SingleDateDetector

All Implemented Interfaces:

EventDetector, TimeShiftable<SingleDateDetector>, TimeStamped

public class SingleDateDetector
extends AbstractDetector<SingleDateDetector>
implements TimeStamped, TimeShiftable<SingleDateDetector>

Finder for single date detection. The event function is positive after, negative before.

Since:

14.0

Author:

Romain Serra

See Also:

DateDetector

Field Summary

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

DEFAULT_MAX_CHECK, DEFAULT_MAX_ITER, DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor	Description
SingleDateDetector(EventDetectionSettings detectionSettings, EventHandler eventHandler, AbsoluteDate date)	Full constructor.
SingleDateDetector(EventHandler eventHandler, AbsoluteDate date)	Build a new instance with default detection settings.
SingleDateDetector(AbsoluteDate date)	Build a new instance with default detection settings and event handler (stop on event).

Method Summary

Modifier and Type	Method	Description
protected SingleDateDetector	create(EventDetectionSettings detectionSettings, EventHandler newHandler)	Build a new instance.
double	g(SpacecraftState s)	Compute the value of the switching function.
AbsoluteDate	getDate()	Get the date.
SingleDateEventFunction	getEventFunction()	Get the event function.
SingleDateDetector	shiftedBy(double dt)	Get a time-shifted instance.
SingleDateDetector	withDate(AbsoluteDate newDate)	Create new instance with input date.

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

checkIfForward, 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, reset

Methods inherited from interface org.orekit.time.TimeShiftable

shiftedBy

Methods inherited from interface org.orekit.time.TimeStamped

durationFrom

Constructor Detail

SingleDateDetector

public SingleDateDetector(EventDetectionSettings detectionSettings,
                          EventHandler eventHandler,
                          AbsoluteDate date)

Full constructor.

Parameters:

detectionSettings - event detection settings

eventHandler - event handler

date - event date

SingleDateDetector

public SingleDateDetector(EventHandler eventHandler,
                          AbsoluteDate date)

Build a new instance with default detection settings.

Parameters:

eventHandler - event handler

date - event date

SingleDateDetector

public SingleDateDetector(AbsoluteDate date)

Build a new instance with default detection settings and event handler (stop on event).

Parameters:

date - event date

Method Detail

create

protected SingleDateDetector create(EventDetectionSettings detectionSettings,
                                    EventHandler newHandler)

Build a new instance.

Specified by:

create in class AbstractDetector<SingleDateDetector>

Parameters:

detectionSettings - detection settings

newHandler - event handler to call at event occurrences

Returns:

a new instance of the appropriate sub-type

getEventFunction

public SingleDateEventFunction getEventFunction()

Get the event function. It defines g both for double and Field.

Specified by:

getEventFunction in interface EventDetector

Overrides:

getEventFunction in class AbstractDetector<SingleDateDetector>

Returns:

event function

g

public double g(SpacecraftState s)

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.

Specified by:

g in interface EventDetector

Parameters:

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

Returns:

value of the switching function

getDate

public AbsoluteDate getDate()

Get the date.

Specified by:

getDate in interface TimeStamped

Returns:

date attached to the object

shiftedBy

public SingleDateDetector shiftedBy(double dt)

Get a time-shifted instance.

Specified by:

shiftedBy in interface TimeShiftable<SingleDateDetector>

Parameters:

dt - time shift in seconds

Returns:

a new instance, shifted with respect to instance (which is not changed)

withDate

public SingleDateDetector withDate(AbsoluteDate newDate)

Create new instance with input date.

Parameters:

newDate - new date to be detected

Returns:

new detector