fr.cnes.sirius.patrius.events.detectors

Class FlightDomainExcessDetector

java.lang.Object

fr.cnes.sirius.patrius.events.AbstractDetector

fr.cnes.sirius.patrius.events.detectors.FlightDomainExcessDetector

All Implemented Interfaces:

EventDetector, Serializable

public final class FlightDomainExcessDetector
extends AbstractDetector

See Also:

Serialized Form

Nested Class Summary

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

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

Fields inherited from interface fr.cnes.sirius.patrius.events.EventDetector

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
FlightDomainExcessDetector(RotationOrder order, double[][] angMinMax, Frame refFrame) Constructor for an FlightDomainExcessDetector instance.
FlightDomainExcessDetector(RotationOrder order, double[][] angMinMax, Frame refFrame, double maxCheck, double threshold) Constructor for an FlightDomainExcessDetector instance with complementary parameters.
FlightDomainExcessDetector(RotationOrder order, double[][] angMinMax, Frame refFrame, double maxCheck, double threshold, EventDetector.Action ascending, EventDetector.Action descending) Constructor for an FlightDomainExcessDetector instance with complementary parameters.

Method Summary

Modifier and Type	Method and Description
EventDetector	copy() A copy of the detector.
EventDetector.Action	eventOccurred(SpacecraftState s, boolean increasing, boolean forward) Handle a flight domain event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
void	setAttitudeRepresentedFrame(Frame desiredRepFrame, Frame satAttFrame) Define the frame represented by the attitude law and the desired flight domain represented frame

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

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

FlightDomainExcessDetector

public FlightDomainExcessDetector(RotationOrder order,
                                  double[][] angMinMax,
                                  Frame refFrame)

Constructor for an FlightDomainExcessDetector instance.

Parameters:

order - rotation order for euler sequence.

angMinMax - angles thresholds [min,max][1,2,3].

refFrame - reference frame with respect to which the angles are to be computed

See Also:

PositionAngle

FlightDomainExcessDetector

public FlightDomainExcessDetector(RotationOrder order,
                                  double[][] angMinMax,
                                  Frame refFrame,
                                  double maxCheck,
                                  double threshold)

Constructor for an FlightDomainExcessDetector instance with complementary parameters.

Parameters:

order - rotation order for euler sequence.

angMinMax - angles thresholds [min,max][1,2,3].

refFrame - reference frame with respect to which the angles are to be computed

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

FlightDomainExcessDetector

public FlightDomainExcessDetector(RotationOrder order,
                                  double[][] angMinMax,
                                  Frame refFrame,
                                  double maxCheck,
                                  double threshold,
                                  EventDetector.Action ascending,
                                  EventDetector.Action descending)

Constructor for an FlightDomainExcessDetector instance with complementary parameters.

Parameters:

order - rotation order for euler sequence.

angMinMax - angles thresholds [min,max][1,2,3].

refFrame - reference frame with respect to which the angles are to be computed

maxCheck - maximum check (see AbstractDetector)

threshold - threshold (see AbstractDetector)

ascending - action performed when ascending

descending - action performed when descending

Method Detail

eventOccurred

public final EventDetector.Action eventOccurred(SpacecraftState s,
                                                boolean increasing,
                                                boolean forward)
                                         throws PatriusException

Handle a flight domain event and choose what to do next.

Specified by:

eventOccurred in interface EventDetector

Overrides:

eventOccurred in class AbstractDetector

Parameters:

s - the current state information : date, kinematics, attitude

increasing - if true, the value of the switching function increases when times increases around event

forward - if true, the integration variable (time) increases during integration.

Returns:

the action performed when flight domain excess is reached.

Throws:

PatriusException - if some specific error occurs

setAttitudeRepresentedFrame

public final void setAttitudeRepresentedFrame(Frame desiredRepFrame,
                                              Frame satAttFrame)

Define the frame represented by the attitude law and the desired flight domain represented frame

Parameters:

desiredRepFrame - the desired represented frame of the flight domain

satAttFrame - the satellite attitude law frame

g

public final double g(SpacecraftState s)
               throws PatriusException

Compute the value of the switching function. This function must be continuous (at least in its roots neighborhood), as the integrator will need to find its roots to locate the events.

Specified by:

g in interface EventDetector

Specified by:

g in class AbstractDetector

Parameters:

s - the current state information: date, kinematics, attitude for forces and events computation, mass provider, and additional states

Returns:

value of the switching function

Throws:

PatriusException - if some specific error occurs

copy

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

Returns:

a copy of the detector.