|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.orekit.propagation.events.AbstractDetector
org.orekit.propagation.events.LongitudeDetector
public class LongitudeDetector
Detects when the spacecraft reaches a given local longitude.
The default implementation behaviour is to stop
propagation when the
longitude is reached. This can be changed by using provided constructors.
EventDetector
,
Serialized FormNested Class Summary |
---|
Nested classes/interfaces inherited from interface org.orekit.propagation.events.EventDetector |
---|
EventDetector.Action |
Field Summary |
---|
Fields inherited from class org.orekit.propagation.events.AbstractDetector |
---|
DEFAULT_MAXCHECK, DEFAULT_THRESHOLD |
Fields inherited from interface org.orekit.propagation.events.EventDetector |
---|
DECREASING, INCREASING, INCREASING_DECREASING |
Constructor Summary | |
---|---|
LongitudeDetector(double longitudeToDetect,
Frame bodyFrame)
Constructor for the longitude detector. |
|
LongitudeDetector(double longitudeToDetect,
Frame bodyFrame,
double maxCheck,
double threshold)
Constructor for the longitude detector. |
|
LongitudeDetector(double longitudeToDetect,
Frame bodyFrame,
double maxCheck,
double threshold,
EventDetector.Action action)
Constructor for the longitude detector. |
|
LongitudeDetector(double longitudeToDetect,
Frame bodyFrame,
double maxCheck,
double threshold,
EventDetector.Action action,
boolean remove)
Constructor for the longitude detector. |
Method Summary | |
---|---|
EventDetector.Action |
eventOccurred(SpacecraftState s,
boolean increasing,
boolean forward)
Handle a longitude reaching event and choose what to do next. |
double |
g(SpacecraftState s)
Compute the value of the switching function. |
Frame |
getBodyFrame()
Returns central body frame. |
double |
getLongitudeToDetect()
Returns longitude to detect. |
void |
init(SpacecraftState s0,
AbsoluteDate t)
Initialize event handler at the start of a propagation. |
boolean |
shouldBeRemoved()
This method is called after EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean) has been triggered. |
Methods inherited from class org.orekit.propagation.events.AbstractDetector |
---|
getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getThreshold, resetState |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public LongitudeDetector(double longitudeToDetect, Frame bodyFrame)
The default implementation behavior is to stop
propagation when the expected
longitude is reached.
longitudeToDetect
- the longitude to detectbodyFrame
- the frame of the central body (take care to use a rotative frame to get the right longitude)public LongitudeDetector(double longitudeToDetect, Frame bodyFrame, double maxCheck, double threshold)
The default implementation behavior is to stop
propagation when the expected
longitude is reached.
longitudeToDetect
- the longitude to detectbodyFrame
- the frame of the central body (take care to use a rotative frame to get the right longitude)maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)public LongitudeDetector(double longitudeToDetect, Frame bodyFrame, double maxCheck, double threshold, EventDetector.Action action)
The default implementation behavior is to stop
propagation when the expected
longitude is reached.
longitudeToDetect
- the longitude to detectbodyFrame
- the frame of the central body (take care to use a rotative frame to get the right longitude)maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at longitude detectionpublic LongitudeDetector(double longitudeToDetect, Frame bodyFrame, double maxCheck, double threshold, EventDetector.Action action, boolean remove)
The default implementation behavior is to stop
propagation when the expected
longitude is reached.
longitudeToDetect
- the longitude to detectbodyFrame
- the frame of the central body (take care to use a rotative frame to get the right longitude)maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at longitude detectionremove
- true if detector should be removedMethod Detail |
---|
public void init(SpacecraftState s0, AbsoluteDate t)
AbstractDetector
This method is called once at the start of the propagation. It may be used by the event handler to initialize some internal data if needed.
init
in interface EventDetector
init
in class AbstractDetector
s0
- initial statet
- target time for the integrationpublic EventDetector.Action eventOccurred(SpacecraftState s, boolean increasing, boolean forward) throws OrekitException
The default implementation behavior is to stop
propagation when the expected
longitude is reached.
eventOccurred
in interface EventDetector
eventOccurred
in class AbstractDetector
s
- the current state information : date, kinematics, attitude.increasing
- if true, the value of the switching function increases when times increases around eventforward
- if true, the integration variable (time) increases during integration.
OrekitException
- if some specific error occurspublic boolean shouldBeRemoved()
EventDetector.eventOccurred(org.orekit.propagation.SpacecraftState, boolean, boolean)
has been triggered.
It returns true if the current detector should be removed after first event detection.
WARNING: this method can be called only once a event has been triggered. Before,
the value is not available.
shouldBeRemoved
in interface EventDetector
shouldBeRemoved
in class AbstractDetector
public double g(SpacecraftState s) throws OrekitException
AbstractDetector
g
in interface EventDetector
g
in class AbstractDetector
s
- the current state information: date, kinematics, attitude for forces
and events computation, mass provider, and additional states
OrekitException
- if some specific error occurspublic double getLongitudeToDetect()
public Frame getBodyFrame()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |