|
||||||||||
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.AnomalyDetector
public class AnomalyDetector
Detects when the anomaly of the spacecraft reaches a predetermined value, θ.
Anomaly is not defined for all kinds of orbits: this detector will detect anomaly events only if the
corresponding orbit is not a circular orbit, otherwise it may trigger events randomly.
The default implementation behaviour is to stop
propagation
when the anomaly θ 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 | |
---|---|
AnomalyDetector(PositionAngle angleType,
double angle)
Constructor for an AnomalyDetector instance. |
|
AnomalyDetector(PositionAngle angleType,
double angle,
double maxCheck,
double threshold)
Constructor for an AnomalyDetector instance with complementary parameters. |
|
AnomalyDetector(PositionAngle angleType,
double angle,
double maxCheck,
double threshold,
EventDetector.Action action)
Constructor for an AnomalyDetector instance with complementary parameters. |
|
AnomalyDetector(PositionAngle angleType,
double angle,
double maxCheck,
double threshold,
EventDetector.Action action,
boolean remove)
Constructor for an AnomalyDetector instance with complementary parameters. |
Method Summary | |
---|---|
EventDetector.Action |
eventOccurred(SpacecraftState s,
boolean increasing,
boolean forward)
Handle an anomaly event and choose what to do next. |
double |
g(SpacecraftState s)
Compute the value of the switching function. |
double |
getAnomaly()
Get the anomaly to detect. |
PositionAngle |
getAnomalyType()
Get the type of anomaly 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 AnomalyDetector(PositionAngle angleType, double angle)
angleType
- true, eccentric or mean anomaly.angle
- anomaly value triggering the event.public AnomalyDetector(PositionAngle angleType, double angle, double maxCheck, double threshold)
The default implementation behaviour is to stop
propagation
when the anomaly is reached.
angleType
- true, eccentric or mean anomaly.angle
- anomaly value triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)public AnomalyDetector(PositionAngle angleType, double angle, double maxCheck, double threshold, EventDetector.Action action)
angleType
- true, eccentric or mean anomaly.angle
- anomaly value triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at anomaly detectionpublic AnomalyDetector(PositionAngle angleType, double angle, double maxCheck, double threshold, EventDetector.Action action, boolean remove)
angleType
- true, eccentric or mean anomaly.angle
- anomaly value triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at anomaly detectionremove
- if detector should be removedMethod Detail |
---|
public EventDetector.Action eventOccurred(SpacecraftState s, boolean increasing, boolean forward) throws OrekitException
eventOccurred
in interface EventDetector
eventOccurred
in class AbstractDetector
s
- the current state information : date, kinematics, attitudeincreasing
- 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()
AbstractDetector
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 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 double getAnomaly()
public PositionAngle getAnomalyType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |