fr.cnes.sirius.patrius.events.postprocessing

Class OrCriterion

java.lang.Object

fr.cnes.sirius.patrius.events.postprocessing.OrCriterion

All Implemented Interfaces:

PostProcessing

public final class OrCriterion
extends Object
implements PostProcessing

Since:

1.1

Version:

$Id$

Author:

Thomas Trapier

See Also:

PostProcessing

Description :

This criterion adds to the phenomena list of a TimeLine object the phenomena corresponding to each time intervals when phenomena of particular types A OR B occur. The events defining the beginning and the end of those new phenomena are directly the ones of the original A and B phenomena.

Use sample :

PostProcessing filter = new OrCriterion("codeA", "codeB"); filter.applyTo(aTimeline);

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
OrCriterion(String codeA, String codeB, String newCode, String newComment) Constructor

Method Summary

Modifier and Type	Method and Description
void	applyTo(Timeline list) Adds to the phenomena list of a TimeLine object the phenomena corresponding to each time intervals when phenomena of particular types A OR B occur.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrCriterion

public OrCriterion(String codeA,
                   String codeB,
                   String newCode,
                   String newComment)

Constructor

Parameters:

codeA - code of the A phenomenon

codeB - code of the B phenomenon

newCode - code of the new phenomena added to the list

newComment - comment of the new phenomena added to the list

Method Detail

applyTo

public void applyTo(Timeline list)

Adds to the phenomena list of a TimeLine object the phenomena corresponding to each time intervals when phenomena of particular types A OR B occur. The events defining the beginning and the end of those new phenomena are directly the ones of the original A and B phenomena.

Specified by:

applyTo in interface PostProcessing

Parameters:

list - the list of events and phenomenon to be modified