fr.cnes.sirius.patrius.events.detectors

Class PlaneCrossingDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.PlaneCrossingDetector

All Implemented Interfaces:

EventDetector, Serializable

Direct Known Subclasses:

NodeDetector

public class PlaneCrossingDetector
extends AbstractDetector

Class for plane crossing events detection.

Author:

Mathilde Lefevre

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.events.EventDetector

EventDetector.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected Frame	referenceFrame Frame for plane definition.

Fields inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

actionAtEntry, actionAtExit, DEFAULT_MAXCHECK, DEFAULT_MAXITER, DEFAULT_THRESHOLD, removeAtEntry, removeAtExit, shouldBeRemovedFlag

Fields inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
PlaneCrossingDetector(Vector3D normalVector, Frame referenceFrame, EventDetector.Action ascendingCrossing, EventDetector.Action descendingCrossing, boolean removeIncreasingCrossing, boolean removeDecreasingCrossing, double maxCheckIn, double thresholdIn) Constructor with default coordinates (0,0,0) for reference point and actions to be performed in both directions.
PlaneCrossingDetector(Vector3D normalVector, Frame referenceFrame, int slopeSelection, EventDetector.Action action, boolean removeCrossing, double maxCheckIn, double thresholdIn) Constructor with default coordinates (0,0,0) for reference point and one detection in the given direction.
PlaneCrossingDetector(Vector3D point, Vector3D normalVector, Frame referenceFrame, EventDetector.Action increasingCrossing, EventDetector.Action decreasingCrossing, boolean removeAscendingCrossing, boolean removeDescendingCrossing, double maxCheckIn, double thresholdIn) Constructor for case with different actions at increasing crossing and decreasing crossing.
PlaneCrossingDetector(Vector3D point, Vector3D normalVector, Frame referenceFrame, int slopeSelection, EventDetector.Action action, boolean removeCrossing, double maxCheckIn, double thresholdIn) Constructor for case with action at descending or ascending crossing.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle an event and choose what to do next.
double	g(SpacecraftState s) Event detection function.
Frame	getFrame() Getter for the frame for plane definition.
Vector3D	getNormalVector() Getter for the normal vector to the plane used for plane definition.
Vector3D	getPoint() Getter for the point belonging to the plane used for plane definition.

Methods inherited from class fr.cnes.sirius.patrius.events.AbstractDetector

filterEvent, getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, init, isRemoveAtEntry, isRemoveAtExit, logEventsOverTimeInterval, resetState, setMaxCheckInterval, setMaxIter, shouldBeRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

referenceFrame

protected final Frame referenceFrame

Frame for plane definition.

Constructor Detail

PlaneCrossingDetector

public PlaneCrossingDetector(Vector3D normalVector,
                             Frame referenceFrame,
                             int slopeSelection,
                             EventDetector.Action action,
                             boolean removeCrossing,
                             double maxCheckIn,
                             double thresholdIn)

Constructor with default coordinates (0,0,0) for reference point and one detection in the given direction.

Parameters:

slopeSelection - The direction in which the detection is performed.

referenceFrame - The reference frame where the plane is considered.

normalVector - A normal vector to the plane.

action - The action to perform at considered crossing.

removeCrossing - True if the detector has to be removed after first detection.

maxCheckIn - Maximum checking interval (s).

thresholdIn - Convergence threshold (s).

PlaneCrossingDetector

public PlaneCrossingDetector(Vector3D normalVector,
                             Frame referenceFrame,
                             EventDetector.Action ascendingCrossing,
                             EventDetector.Action descendingCrossing,
                             boolean removeIncreasingCrossing,
                             boolean removeDecreasingCrossing,
                             double maxCheckIn,
                             double thresholdIn)

Constructor with default coordinates (0,0,0) for reference point and actions to be performed in both directions.

Parameters:

referenceFrame - The reference frame where the plane is defined.

normalVector - A normal vector to the plane.

ascendingCrossing - The action to perform at ascending crossing.

descendingCrossing - The action to perform at descending crossing.

removeIncreasingCrossing - True if the detector at increasing crossing has to be removed after detection.

removeDecreasingCrossing - True if the detector at decreasing crossing has to be removed after detection.

maxCheckIn - Maximum checking interval (s).

thresholdIn - Convergence threshold (s).

PlaneCrossingDetector

public PlaneCrossingDetector(Vector3D point,
                             Vector3D normalVector,
                             Frame referenceFrame,
                             int slopeSelection,
                             EventDetector.Action action,
                             boolean removeCrossing,
                             double maxCheckIn,
                             double thresholdIn)

Constructor for case with action at descending or ascending crossing.

Parameters:

slopeSelection - The direction in which the detection has to be performed.

referenceFrame - The reference frame where the plane is defined.

point - A point belonging to the plane.

normalVector - A normal vector to the plane.

action - The action to be performed at considered crossing.

removeCrossing - True if the detector has to be removed after first detection.

maxCheckIn - Maximum checking interval (s).

thresholdIn - Convergence threshold (s).

PlaneCrossingDetector

public PlaneCrossingDetector(Vector3D point,
                             Vector3D normalVector,
                             Frame referenceFrame,
                             EventDetector.Action increasingCrossing,
                             EventDetector.Action decreasingCrossing,
                             boolean removeAscendingCrossing,
                             boolean removeDescendingCrossing,
                             double maxCheckIn,
                             double thresholdIn)

Constructor for case with different actions at increasing crossing and decreasing crossing.

Parameters:

referenceFrame - The reference frame where the plane is defined.

point - A point belonging to the plane.

normalVector - A normal vector to the plane.

increasingCrossing - The action to be performed at increasing crossing.

decreasingCrossing - The action to be performed at decreasing crossing.

removeIncreasingCrossing - True if the detection at increasing crossing has to be performed once.

removeDecreasingCrossing - True if the detection at decreasing crossing has to be performed once.

maxCheckIn - Maximum checking interval (s).

thresholdIn - Convergence threshold (s).

Method Detail

getFrame

public Frame getFrame()

Getter for the frame for plane definition.

Returns:

referenceFrame

getPoint

public Vector3D getPoint()

Getter for the point belonging to the plane used for plane definition.

Returns:

point

getNormalVector

public Vector3D getNormalVector()

Getter for the normal vector to the plane used for plane definition.

Returns:

normalVector

copy

public EventDetector copy()

Description copied from interface: EventDetector

A copy of the detector. By default copy is deep. If not, detector javadoc will specify which attribute is not fully copied. In that case, the attribute reference is passed.

Returns:

a copy of the considered PlaneCrossingDetector.

g

public double g(SpacecraftState s)
         throws PatriusException

Event detection function. The plane crossing occurs when the position vector of the spacecraft with respect to the point defining the plane and the normal vector to the plane are normal.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

s - Spacecraft state at a given moment.

Returns:

the value of the dot product between the satellite position and the normal to the plane.

Throws:

PatriusException - if some specific error occurs

eventOccurred

public EventDetector.Action eventOccurred(SpacecraftState s,
                                          boolean increasing,
                                          boolean forward)
                                   throws PatriusException

Description copied from class: AbstractDetector

Handle an event and choose what to do next.

The scheduling between this method and the PatriusStepHandler method handleStep() is to call this method first and handleStep afterwards. This scheduling allows the propagator to pass true as the isLast parameter to the step handler to make it aware the step will be the last one if this method returns EventDetector.Action.STOP. As the interpolator may be used to navigate back throughout the last step (as OrekitStepNormalizer does for example), user code called by this method and user code called by step handlers may experience apparently out of order values of the independent time variable. As an example, if the same user object implements both this EventDetector interface and the OrekitFixedStepHandler interface, a forward integration may call its eventOccurred method with a state at 2000-01-01T00:00:10 first and call its handleStep method with a state at 2000-01-01T00:00:09 afterwards. Such out of order calls are limited to the size of the integration step for variable step handlers and to the size of the fixed step for fixed step handlers.

Specified by:

eventOccurred in interface EventDetector

Overrides:

eventOccurred in class AbstractDetector

Parameters:

s - The spacecraft state at the moment the event occurs.

increasing - if true, the value of the switching function increases when times increases around event

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed when ascending or/and descending crossing is reached.

Throws:

PatriusException