fr.cnes.sirius.patrius.events.detectors

Class BodyPointSolarIncidenceDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

fr.cnes.sirius.patrius.events.detectors.AbstractSolarIncidenceDetector

fr.cnes.sirius.patrius.events.detectors.BodyPointSolarIncidenceDetector

All Implemented Interfaces:

EventDetector, Serializable

public class BodyPointSolarIncidenceDetector
extends AbstractSolarIncidenceDetector

Body point solar incidence detector.

The solar incidence is the angle between the interest point-satellite vector and the interest point-sun vector (the interest point being described by a BodyPoint).
This detector discriminates among increasing g events and decreasing g events.
The default implementation is to stop propagation when the reference solar incidence is reached. This can be changed by using provided constructors.

This detector can take into account signal propagation duration through AbstractSignalPropagationDetector.setPropagationDelayType(PropagationDelayType, Frame) (default is signal being instantaneous).

Since:

4.17

Author:

bonitt

See Also:

EventDetector, Serialized Form

Concurrency :

thread-hostile

Concurrency comment :

the celestial body is thread hostile itself

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

AbstractSignalPropagationDetector.EventDatationType, AbstractSignalPropagationDetector.PropagationDelayType

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

EventDetector.Action

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSolarIncidenceDetector

bodyShape, incidenceRef, sun

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
BodyPointSolarIncidenceDetector(double incidence, BodyPoint interestPoint, double maxCheck, double threshold) Constructor for the body point solar incidence detector.
BodyPointSolarIncidenceDetector(double incidence, BodyPoint interestPoint, double maxCheck, double threshold, EventDetector.Action action) Constructor for the body point solar incidence detector.
BodyPointSolarIncidenceDetector(double incidence, BodyPoint interestPoint, double maxCheck, double threshold, EventDetector.Action action, boolean remove) Constructor for the body point solar incidence detector.
BodyPointSolarIncidenceDetector(double incidence, BodyPoint interestPoint, double maxCheck, double threshold, EventDetector.Action action, boolean remove, PVCoordinatesProvider sun) Constructor for the body point solar incidence detector with Sun choice.
BodyPointSolarIncidenceDetector(int slopeSelectionIn, double incidence, BodyPoint interestPoint, double maxCheck, double threshold, EventDetector.Action actionAtIncreasing, EventDetector.Action actionAtDecreasing, boolean removeAtIncreasing, boolean removeAtDecreasing, PVCoordinatesProvider sun) Constructor for the body point solar incidence detector with Sun choice.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
BodyPoint	getInterestPoint() Getter for the interest point.
BodyPoint	getInterestPoint(SpacecraftState state) Define the interest point.

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSolarIncidenceDetector

eventOccurred, g, getBodyShape, getIncidence, getSun

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.AbstractSignalPropagationDetector

getEmitter, getEpsilonSignalPropagation, getEventDatationType, getInertialFrame, getLinkTypeHandler, getMaxIterSignalPropagation, getOtherDate, getPropagationDelayType, getReceiver, getSignalEmissionDate, getSignalEmissionDate, getSignalReceptionDate, getSignalReceptionDate, setEpsilonSignalPropagation, setMaxIterSignalPropagation, setPropagationDelayType

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

Constructor Detail

BodyPointSolarIncidenceDetector

public BodyPointSolarIncidenceDetector(double incidence,
                                       BodyPoint interestPoint,
                                       double maxCheck,
                                       double threshold)
                                throws PatriusException

Constructor for the body point solar incidence detector.

The default implementation behavior is to stop propagation when the local time is reached.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

interestPoint - The interest point

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

Throws:

PatriusException - if there is an error when loading the ephemeris files

BodyPointSolarIncidenceDetector

public BodyPointSolarIncidenceDetector(double incidence,
                                       BodyPoint interestPoint,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action)
                                throws PatriusException

Constructor for the body point solar incidence detector.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

interestPoint - The interest point

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

Throws:

PatriusException - if there is an error when loading the ephemeris files

BodyPointSolarIncidenceDetector

public BodyPointSolarIncidenceDetector(double incidence,
                                       BodyPoint interestPoint,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action,
                                       boolean remove)
                                throws PatriusException

Constructor for the body point solar incidence detector.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

interestPoint - The interest point

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

remove - True if detector should be removed at nadir point solar incidence detection

Throws:

PatriusException - if there is an error when loading the ephemeris files

BodyPointSolarIncidenceDetector

public BodyPointSolarIncidenceDetector(double incidence,
                                       BodyPoint interestPoint,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action action,
                                       boolean remove,
                                       PVCoordinatesProvider sun)

Constructor for the body point solar incidence detector with Sun choice.

Parameters:

incidence - The incidence to detect (set 0. to detect the terminator)

interestPoint - The interest point

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

action - Action performed at nadir point solar incidence detection

remove - True if detector should be removed at nadir point solar incidence detection

sun - The sun

BodyPointSolarIncidenceDetector

public BodyPointSolarIncidenceDetector(int slopeSelectionIn,
                                       double incidence,
                                       BodyPoint interestPoint,
                                       double maxCheck,
                                       double threshold,
                                       EventDetector.Action actionAtIncreasing,
                                       EventDetector.Action actionAtDecreasing,
                                       boolean removeAtIncreasing,
                                       boolean removeAtDecreasing,
                                       PVCoordinatesProvider sun)

Constructor for the body point solar incidence detector with Sun choice.

Parameters:

slopeSelectionIn - The g-function slope selection (0, 1 or 2)

incidence - The incidence to detect (set 0. to detect the terminator)

interestPoint - The interest point

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

actionAtIncreasing - Action performed at nadir point solar incidence detection at increasing g event

actionAtDecreasing - Action performed at nadir point solar incidence detection at decreasing g event

removeAtIncreasing - True if detector should be removed at nadir point solar incidence detection at increasing g event

removeAtDecreasing - True if detector should be removed at nadir point solar incidence detection at decreasing g event

sun - The sun

Method Detail

getInterestPoint

public BodyPoint getInterestPoint(SpacecraftState state)

Define the interest point.

Specified by:

getInterestPoint in class AbstractSolarIncidenceDetector

Parameters:

state - the current state information

Returns:

the interest point

getInterestPoint

public BodyPoint getInterestPoint()

Getter for the interest point.

Returns:

the interest point.

copy

public EventDetector copy()

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.

The following attributes are not deeply copied:

• inbodyShape: PVCoordinatesProvider

Returns:

a copy of the detector.