fr.cnes.sirius.patrius.events.detectors

Class NthOccurrenceDetector

java.lang.Object

fr.cnes.sirius.patrius.events.detectors.IntervalOccurrenceDetector

fr.cnes.sirius.patrius.events.detectors.NthOccurrenceDetector

All Implemented Interfaces:

EventDetector, Serializable

public class NthOccurrenceDetector
extends IntervalOccurrenceDetector

This event detector detects the nth occurrence of an underlying event detector.

However the IntervalOccurrenceDetector.eventOccurred(SpacecraftState, boolean, boolean) method is triggered at every event of the underlying detector. As a result, the behaviour of this detector is the following:

• Before and after the nth occurrence, the IntervalOccurrenceDetector.eventOccurred(SpacecraftState, boolean, boolean) returns Action.CONTINUE.
• At the nth occurrence, the IntervalOccurrenceDetector.eventOccurred(SpacecraftState, boolean, boolean) returns the user-provided action.

Warning: the IntervalOccurrenceDetector.eventOccurred(SpacecraftState, boolean, boolean) method is triggered at every occurrence of the underlying detector, not only at nth occurrence. Hence, overloading this detector should be performed carefully: in the overloaded eventOccurred() method, the check IntervalOccurrenceDetector.getCurrentOccurrence() == getOccurence() should be performed first to ensure we are at nth occurrence before calling super.eventOccurred().

Since:

1.3

Version:

$Id: NthOccurrenceDetector.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

use of internal mutable attributes

Nested Class Summary

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

EventDetector.Action

Field Summary

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

DECREASING, INCREASING, INCREASING_DECREASING

Constructor Summary

Constructors

Constructor and Description
NthOccurrenceDetector(EventDetector eventToDetect, int occurrence, EventDetector.Action actionAtOccurrence) Constructor.
NthOccurrenceDetector(EventDetector eventToDetect, int occurrence, EventDetector.Action actionAtOccurrence, boolean remove) Constructor.

Method Summary

Modifier and Type	Method and Description
int	getOccurence() Get the occurrence to detect.

Methods inherited from class fr.cnes.sirius.patrius.events.detectors.IntervalOccurrenceDetector

copy, eventOccurred, filterEvent, g, getActionAtOccurrence, getCurrentOccurrence, getEvent, getFirstOccurrence, getLastOccurrence, getMaxCheckInterval, getMaxIterationCount, getSlopeSelection, getStep, getThreshold, init, isRemoveAtOccurrence, processEventOccurrence, resetState, shouldBeRemoved, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

NthOccurrenceDetector

public NthOccurrenceDetector(EventDetector eventToDetect,
                             int occurrence,
                             EventDetector.Action actionAtOccurrence)

Constructor.

Parameters:

eventToDetect - event to detect

occurrence - occurrence of the event to detect

actionAtOccurrence - action at event nth occurrence

NthOccurrenceDetector

public NthOccurrenceDetector(EventDetector eventToDetect,
                             int occurrence,
                             EventDetector.Action actionAtOccurrence,
                             boolean remove)

Constructor.

Parameters:

eventToDetect - event to detect

occurrence - occurrence of the event to detect

actionAtOccurrence - action at event nth occurrence

remove - true if detector should be removed after detection of nth occurrence

Method Detail

getOccurence

public int getOccurence()

Get the occurrence to detect.

Returns:

occurrence to detect