fr.cnes.sirius.patrius.events.detectors

Class BodyPointLocalTimeAngleDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

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

fr.cnes.sirius.patrius.events.detectors.LocalTimeAngleDetector

fr.cnes.sirius.patrius.events.detectors.BodyPointLocalTimeAngleDetector

All Implemented Interfaces:

EventDetector, Serializable

public class BodyPointLocalTimeAngleDetector
extends LocalTimeAngleDetector

Detects when the local time angle of point on a celestial body is equal to a predetermined value.
The local time is represented by the angle between the projections of the Sun and the zenithal direction of the point; therefore this angle is equal to zero when the local time is 12.00h and Π when the local time is 0.00h (Local Time In Hours = 12.00h + local time angle * 12 / Π).

Since:

4.16

Version:

$Id: BodyPointLocalTimeAngleDetector.java $

Author:

Thales Services Numeriques

See Also:

LocalTimeAngleDetector, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

attributes are mutable and related to propagation.

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

DECREASING, INCREASING, INCREASING_DECREASING

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

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

Constructor Summary

Constructors

Constructor and Description
BodyPointLocalTimeAngleDetector(double localTimeAngle, BodyPoint bodyPoint, double maxCheck, double threshold, CelestialBodyFrame frame, EventDetector.Action action, boolean remove, PVCoordinatesProvider sun, int slopeSelection) Constructor.

Method Summary

Modifier and Type	Method and Description
protected double	computeLocalTime(SpacecraftState state) Compute the local time.
BodyPointLocalTimeAngleDetector	copy() A copy of the detector.
BodyPoint	getBodyPoint() Getter for the body point.

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

computeSunSatAngle, eventOccurred, filterEvent, g, getAction, getFrame, getSun, getTime, init

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

getActionAtEntry, getActionAtExit, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, 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

BodyPointLocalTimeAngleDetector

public BodyPointLocalTimeAngleDetector(double localTimeAngle,
                                       BodyPoint bodyPoint,
                                       double maxCheck,
                                       double threshold,
                                       CelestialBodyFrame frame,
                                       EventDetector.Action action,
                                       boolean remove,
                                       PVCoordinatesProvider sun,
                                       int slopeSelection)
                                throws PatriusException

Constructor.

Parameters:

localTimeAngle - Local time angle triggering the event (in the range [-Π, Π[).
Angle between the projections of the Sun and the zenithal direction in the equatorial plane (Local Time In Hours = 12.00h + localTimeAngle * 12 / Π)

bodyPoint - Body point which zenith direction is used instead of satellite position

maxCheck - Maximum check (see AbstractDetector)

threshold - Threshold (see AbstractDetector)

frame - Frame in relation to which the calculations are made

action - Action performed at local time detection

remove - True if detector should be removed

sun - Sun

slopeSelection - LocalTimeAngleDetector.INCREASING for increasing difference between local time angle and local time angle to detect,
LocalTimeAngleDetector.DECREASING for decreasing difference between local time angle and local time angle to detect,
LocalTimeAngleDetector.INCREASING_DECREASING for both increasing and decreasing difference between local time angle and local time angle to detect.

Throws:

PatriusException - if there is an error when loading the ephemeris files
if the local time angle is not in the range [-Π, Π[
if the frame initialized (not null) and not inertial

Since:

4.16

Method Detail

computeLocalTime

protected double computeLocalTime(SpacecraftState state)
                           throws PatriusException

Compute the local time.

Overrides:

computeLocalTime in class LocalTimeAngleDetector

Parameters:

state - current state

Returns:

local time

Throws:

PatriusException - thrown if computation failed

getBodyPoint

public BodyPoint getBodyPoint()

Getter for the body point.

Returns:

the body point

copy

public BodyPointLocalTimeAngleDetector 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.

Specified by:

copy in interface EventDetector

Overrides:

copy in class LocalTimeAngleDetector

Returns:

a copy of the detector.