fr.cnes.sirius.patrius.events.sensor

Class MaskingDetector

java.lang.Object

fr.cnes.sirius.patrius.propagation.events.AbstractDetector

fr.cnes.sirius.patrius.events.sensor.MaskingDetector

All Implemented Interfaces:

EventDetector, Serializable

public class MaskingDetector
extends AbstractDetector

Sensor masking detector.

The default implementation behaviour is to continue propagation at raising and to stop propagation at setting. This can be changed by using provided constructors.

Since:

1.2 HISTORY VERSION::FA:231:03/04/2014:bad updating of the assembly's tree of frames VERSION::DM:190:29/07/2014: Modified maneuvers in retro-propagation case (added forward parameter to eventOccurred signature) END-HISTORY

Version:

$Id$

Author:

Thomas Trapier

See Also:

SensorModel, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

The use of a not thread-safe SensorModel makes this class not thread-safe.

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

AbstractDetector.PropagationDelayType

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.propagation.events.EventDetector

EventDetector.Action

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.propagation.events.AbstractDetector

DEFAULT_MAXCHECK, DEFAULT_THRESHOLD

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
MaskingDetector(Assembly assembly, String partName, double maxCheck, double threshold) Constructor for the sensor masking detector.
MaskingDetector(SensorModel sensorModel, double maxCheck, double threshold) Constructor for the sensor masking detector.
MaskingDetector(SensorModel sensorModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting) Constructor for the sensor masking detector.
MaskingDetector(SensorModel sensorModel, double maxCheck, double threshold, EventDetector.Action raising, EventDetector.Action setting, boolean removeRaising, boolean removeSetting) Constructor for the sensor masking detector.

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 "masking" event and choose what to do next.
double	g(SpacecraftState s) Compute the value of the switching function.
Assembly	getAssembly() Get the assembly.
String	getMaskingObjectName() Get the masking object.
String	getMaskingPartName() Get the masking part.
SensorModel	getSensor() Get the sensor.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize event handler at the start of a propagation.
boolean	shouldBeRemoved() This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.propagation.SpacecraftState, boolean, boolean) has been triggered.

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

getMaxCheckInterval, getMaxIterationCount, getPropagationDelayType, getSignalEmissionDate, getSignalReceptionDate, getSlopeSelection, getThreshold, resetState, setPropagationDelayType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MaskingDetector

public MaskingDetector(SensorModel sensorModel,
                       double maxCheck,
                       double threshold)

Constructor for the sensor masking detector.

The default implementation behavior is to continue propagation at raising and to stop propagation at setting.

Parameters:

sensorModel - the spacecraft's sensor model. A main target and some masking objects must have been set to compute this detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

MaskingDetector

public MaskingDetector(SensorModel sensorModel,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action raising,
                       EventDetector.Action setting)

Constructor for the sensor masking detector.

Parameters:

sensorModel - the spacecraft's sensor model. A main target and some masking objects must have been set to compute this detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

MaskingDetector

public MaskingDetector(SensorModel sensorModel,
                       double maxCheck,
                       double threshold,
                       EventDetector.Action raising,
                       EventDetector.Action setting,
                       boolean removeRaising,
                       boolean removeSetting)

Constructor for the sensor masking detector.

Parameters:

sensorModel - the spacecraft's sensor model. A main target and some masking objects must have been set to compute this detection.

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

raising - action performed when propagation at raising

setting - action performed when propagation at setting

removeRaising - true if detector should be removed at raising

removeSetting - true if detector should be removed at setting

Since:

3.1

MaskingDetector

public MaskingDetector(Assembly assembly,
                       String partName,
                       double maxCheck,
                       double threshold)

Constructor for the sensor masking detector.

Parameters:

assembly - the spacecraft's model

partName - the name of the part supporting the sensor

maxCheck - maximal checking interval (s)

threshold - convergence threshold (s)

Method Detail

init

public void init(SpacecraftState s0,
                 AbsoluteDate t)

Initialize event handler at the start of a propagation.

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.

Specified by:

init in interface EventDetector

Overrides:

init in class AbstractDetector

Parameters:

s0 - initial state

t - target time for the integration

eventOccurred

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

Handle "masking" event and choose what to do next.

Specified by:

eventOccurred in interface EventDetector

Specified by:

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 propagation raising or setting.

Throws:

PatriusException - if some specific error occurs

shouldBeRemoved

public boolean shouldBeRemoved()

This method is called after EventDetector.eventOccurred(fr.cnes.sirius.patrius.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.

Specified by:

shouldBeRemoved in interface EventDetector

Specified by:

shouldBeRemoved in class AbstractDetector

Returns:

true if the current detector should be removed after first event detection

g

public 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

getMaskingObjectName

public String getMaskingObjectName()

Get the masking object.

Returns:

the first masking object name (to be used in the user eventOccured method)

getMaskingPartName

public String getMaskingPartName()

Get the masking part.

Returns:

first masking spacecraft's part name if the first masking part is a spacecraft, "none" otherwise (to be used in the user eventOccured method)

getSensor

public SensorModel getSensor()

Get the sensor.

Returns:

the sensor

getAssembly

public Assembly getAssembly()

Get the assembly.

Returns:

the assembly

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.

The following attributes are not deeply copied:

• sensor: SensorModel

Returns:

a copy of the detector.