|
||||||||||
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.BetaAngleDetector
public class BetaAngleDetector
Detects when the beta angle of the spacecraft reaches a predetermined value.
The beta angle is the angle between the orbit plane and the vector from
the central body to the sun.
The angle is positive on the side of the plane containing the spacecraft's momentum vector.
The bodies considered are :
The default implementation behaviour is to stop
propagation when the
beta angle 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 | |
---|---|
BetaAngleDetector(double ang)
Constructor for a BetaAngleDetector instance. |
|
BetaAngleDetector(double ang,
double maxCheck,
double threshold)
Constructor for a BetaAngleDetector instance with complimentary parameters. |
|
BetaAngleDetector(double ang,
double maxCheck,
double threshold,
EventDetector.Action action)
Constructor for a BetaAngleDetector instance with complimentary parameters. |
|
BetaAngleDetector(double ang,
double maxCheck,
double threshold,
EventDetector.Action action,
boolean remove)
Constructor for a BetaAngleDetector instance with complimentary parameters. |
Method Summary | |
---|---|
EventDetector.Action |
eventOccurred(SpacecraftState s,
boolean increasing,
boolean forward)
Handles a beta angle event and chooses what to do next. |
double |
g(SpacecraftState s)
Compute the value of the switching function. |
double |
getAngle()
Returns beta angle triggering the event. |
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 BetaAngleDetector(double ang)
ang
- angle in radians triggering the event.public BetaAngleDetector(double ang, double maxCheck, double threshold)
The default implementation behavior is to stop
propagation when the angle is
reached.
ang
- angle in radians triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)
IllegalArgumentException
- if angle is out of range [-Pi / 2 , Pi / 2]public BetaAngleDetector(double ang, double maxCheck, double threshold, EventDetector.Action action)
ang
- angle in radians triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at beta angle detection
IllegalArgumentException
- if angle is out of range [-Pi / 2 , Pi / 2]public BetaAngleDetector(double ang, double maxCheck, double threshold, EventDetector.Action action, boolean remove)
ang
- angle in radians triggering the event.maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at beta angle detectionremove
- if the detector should be removed
IllegalArgumentException
- if angle is out of range [-Pi / 2 , Pi / 2]Method Detail |
---|
public 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 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, attitude.increasing
- if true, the value of the switching function increases when time increases around event.forward
- if true, the integration variable (time) increases during integration.
OrekitException
- if some specific error occurspublic 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 getAngle()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |