|
||||||||||
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.SolarTimeAngleDetector
public class SolarTimeAngleDetector
Detects when the solar time angle of a spacecraft is equal to a predetermined value.
The solar time is represented by the angle between the projections of the Sun in the osculator orbital
plane and the satellite position; therefore this angle is equal to zero when the solar time is
12.00h and Π when the solar time is 0.00h (Solar Time In Hours = 12.00h + solar time angle * 12 / Π).
The default implementation is to stop
propagation when the solar time
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 | |
---|---|
SolarTimeAngleDetector(double solarTimeAngle)
Constructor for a SolarTimeDetector instance. |
|
SolarTimeAngleDetector(double solarTimeAngle,
double maxCheck,
double threshold)
Constructor for a SolarTimeDetector instance with complimentary parameters. |
|
SolarTimeAngleDetector(double solarTimeAngle,
double maxCheck,
double threshold,
EventDetector.Action action)
Constructor for a SolarTimeDetector instance with complimentary parameters. |
|
SolarTimeAngleDetector(double solarTimeAngle,
double maxCheck,
double threshold,
EventDetector.Action action,
boolean remove)
Constructor for a SolarTimeDetector instance with complimentary parameters. |
Method Summary | |
---|---|
EventDetector.Action |
eventOccurred(SpacecraftState s,
boolean increasing,
boolean forward)
Handle a solar time angle event and choose what to do next. |
double |
g(SpacecraftState s)
Compute the value of the switching function. |
double |
getTime()
Get solar time angle 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 SolarTimeAngleDetector(double solarTimeAngle) throws OrekitException
solarTimeAngle
- satellite solar time angle triggering the event (in the range [-Π, Π[).
Angle between the projection of the Sun in the osculator orbital plane and the satellite position
(Solar Time In Hours = 12.00h + solar time angle * 12 / Π).
OrekitException
- error when loading the ephemeris files or solar time angle not in the range [-Π, Π[public SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold) throws OrekitException
solarTimeAngle
- satellite solar time angle triggering the event (in the range [-Π, Π[).
Angle between the projection of the Sun in the osculator orbital plane and the satellite position
(Solar Time In Hours = 12.00h + solar time angle * 12 / Π).maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)
OrekitException
- error when loading the ephemeris files or solar time angle not in the range [-Π, Π[public SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, EventDetector.Action action) throws OrekitException
solarTimeAngle
- satellite solar time angle triggering the event (in the range [-Π, Π[).
Angle between the projection of the Sun in the osculator orbital plane and the satellite position
(Solar Time In Hours = 12.00h + solar time angle * 12 / Π).maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at solar time detection
OrekitException
- error when loading the ephemeris files or solar time angle not in the range [-Π, Π[public SolarTimeAngleDetector(double solarTimeAngle, double maxCheck, double threshold, EventDetector.Action action, boolean remove) throws OrekitException
solarTimeAngle
- satellite solar time angle triggering the event (in the range [-Π, Π[).
Angle between the projection of the Sun in the osculator orbital plane and the satellite position
(Solar Time In Hours = 12.00h + solar time angle * 12 / Π).maxCheck
- maximum check (see AbstractDetector
)threshold
- threshold (see AbstractDetector
)action
- action performed at solar time detectionremove
- true if detector should be removed
OrekitException
- error when loading the ephemeris files or solar time angle not in the range [-Π, Π[Method Detail |
---|
public EventDetector.Action eventOccurred(SpacecraftState s, boolean increasing, boolean forward) throws OrekitException
The default implementation behavior is to stop
propagation when the solar time
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 time increases around event.forward
- 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 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 getTime()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |