Package com.powsybl.iidm.criteria.duration

Class EqualityTemporaryDurationCriterion

java.lang.Object

com.powsybl.iidm.criteria.duration.AbstractTemporaryDurationCriterion

com.powsybl.iidm.criteria.duration.EqualityTemporaryDurationCriterion

All Implemented Interfaces:

LimitDurationCriterion

public final class EqualityTemporaryDurationCriterion
extends AbstractTemporaryDurationCriterion

Criterion used to filter temporary limits which acceptable durations are equal to a given value (in seconds).

Author:

Sophie Frasnedo <sophie.frasnedo at rte-france.com>

Nested Class Summary

Nested classes/interfaces inherited from class com.powsybl.iidm.criteria.duration.AbstractTemporaryDurationCriterion

AbstractTemporaryDurationCriterion.TemporaryDurationCriterionType

Nested classes/interfaces inherited from interface com.powsybl.iidm.criteria.duration.LimitDurationCriterion

LimitDurationCriterion.LimitDurationType

Field Summary

Fields inherited from interface com.powsybl.iidm.criteria.duration.LimitDurationCriterion

VERSION

Constructor Summary

Constructors

Constructor	Description
EqualityTemporaryDurationCriterion(int durationEqualityValue)	Create a new EqualityTemporaryDurationCriterion to filter temporary limits which acceptable durations are equal to a given value in seconds.

Method Summary

Modifier and Type	Method	Description
boolean	filter(int acceptableDuration)	Does the given acceptable duration respect the current duration criterion?
AbstractTemporaryDurationCriterion.TemporaryDurationCriterionType	getComparisonType()
int	getDurationEqualityValue()	Value of acceptable duration for temporary limits matching this criterion.

Methods inherited from class com.powsybl.iidm.criteria.duration.AbstractTemporaryDurationCriterion

getType

Methods inherited from class java.lang.Object

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

Constructor Details

EqualityTemporaryDurationCriterion

public EqualityTemporaryDurationCriterion(int durationEqualityValue)

Create a new EqualityTemporaryDurationCriterion to filter temporary limits which acceptable durations are equal to a given value in seconds.

Parameters:

durationEqualityValue - duration in seconds

Method Details

getComparisonType

public AbstractTemporaryDurationCriterion.TemporaryDurationCriterionType getComparisonType()

Specified by:

getComparisonType in class AbstractTemporaryDurationCriterion

getDurationEqualityValue

public int getDurationEqualityValue()

Value of acceptable duration for temporary limits matching this criterion.

Returns:

Value of acceptable duration for temporary limits matching this criterion.

filter

public boolean filter(int acceptableDuration)

Description copied from class: AbstractTemporaryDurationCriterion

Does the given acceptable duration respect the current duration criterion?

Specified by:

filter in class AbstractTemporaryDurationCriterion

Parameters:

acceptableDuration - the duration to check

Returns:

true if the given acceptable duration respects the current criterion, false otherwise.