fr.cnes.genius.interval

Class GMutableInterval

java.lang.Object

fr.cnes.genius.interval.GMutableInterval

public class GMutableInterval
extends Object

Class defining a mutable interval of values to test values against. The interval is composed of two ranges of values [okMinValue, okMaxValue] and [warnMinValue, warnMaxValue], fully configurable, and the test algorithm is the following: if (okMinValue <= value <= okMaxValue) then OK else if (warnMinValue <= value <= warnMaxValue) then WARN else ERROR end if The interval limits can be, independently, inclusive or exclusive, so the comparisons are "<=" and "=>" or just "<" and ">".

Author:

ffsm

Constructor Summary

Constructors

Constructor and Description
GMutableInterval(GInterval interval) Constructor copy from an immutable GInterval object.
GMutableInterval(GMutableInterval interval) Constructor copy from a mutable GMutableInterval object.

Method Summary

Modifier and Type	Method and Description
GInterval	getGInterval() Getter of an immutable GInterval object.
double	getOkMax() Get the absolute maximum value of the OK zone.
GIntervalAbstract.Rule	getOkMaxRule() Get the rule applying to the absolute maximum of the OK zone.
double	getOkMin() Get the absolute minimum value of the OK zone.
GIntervalAbstract.Rule	getOkMinRule() Get the rule applying to the absolute minimum of the OK zone.
double	getWarnMax() Get the absolute maximum value of the WARN zone.
GIntervalAbstract.Rule	getWarnMaxRule() Get the rule applying to the absolute maximum of the WARN zone.
double	getWarnMin() Get the absolute minimum value of the WARN zone.
GIntervalAbstract.Rule	getWarnMinRule() Get the rule applying to the absolute minimum of the WARN zone.
boolean	isWarnCheckEnabled() Get the flag for the WARN zone.
void	removeWarnCheck() Removes the WARN zone of the interval.
void	setGInterval(GInterval interval) Setter from an immutable GInterval object.
void	setOkMax(double okMax) Set the absolute maximum value of the OK zone.
void	setOkMaxRule(GIntervalAbstract.Rule okMaxRule) Set the rule applying to the absolute maximum of the OK zone.
void	setOkMin(double okMin) Set the absolute minimum value of the OK zone.
void	setOkMinRule(GIntervalAbstract.Rule okMinRule) Set the rule applying to the absolute minimum of the OK zone.
void	setWarnMax(double warnMax) Set the absolute maximum value of the WARN zone.
void	setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule) Set the rule applying to the absolute maximum of the WARN zone.
void	setWarnMin(double warnMin) Set the absolute minimum value of the WARN zone.
void	setWarnMinRule(GIntervalAbstract.Rule warnMinRule) Set the rule applying to the absolute minimum of the WARN zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

GMutableInterval

public GMutableInterval(GInterval interval)

Constructor copy from an immutable GInterval object.

Parameters:

interval - interval to copy.

GMutableInterval

public GMutableInterval(GMutableInterval interval)

Constructor copy from a mutable GMutableInterval object.

Parameters:

interval - interval to copy.

Method Detail

setGInterval

public void setGInterval(GInterval interval)

Setter from an immutable GInterval object.

Parameters:

interval - immutable interval to copy.

getGInterval

public GInterval getGInterval()

Getter of an immutable GInterval object.

Returns:

immutable interval copy.

getOkMin

public double getOkMin()

Get the absolute minimum value of the OK zone.

Returns:

the absolute minimum value of the OK zone.

getOkMax

public double getOkMax()

Get the absolute maximum value of the OK zone.

Returns:

the absolute maximum value of the OK zone.

getOkMinRule

public GIntervalAbstract.Rule getOkMinRule()

Get the rule applying to the absolute minimum of the OK zone.

Returns:

the rule applying to the absolute minimum of the OK zone.

getOkMaxRule

public GIntervalAbstract.Rule getOkMaxRule()

Get the rule applying to the absolute maximum of the OK zone.

Returns:

the rule applying to the absolute maximum of the OK zone.

getWarnMin

public double getWarnMin()

Get the absolute minimum value of the WARN zone.

Returns:

the absolute minimum value of the WARN zone.

getWarnMax

public double getWarnMax()

Get the absolute maximum value of the WARN zone.

Returns:

the absolute maximum value of the WARN zone.

getWarnMinRule

public GIntervalAbstract.Rule getWarnMinRule()

Get the rule applying to the absolute minimum of the WARN zone.

Returns:

the rule applying to the absolute minimum of the WARN zone.

getWarnMaxRule

public GIntervalAbstract.Rule getWarnMaxRule()

Get the rule applying to the absolute maximum of the WARN zone.

Returns:

the rule applying to the absolute maximum of the WARN zone.

isWarnCheckEnabled

public boolean isWarnCheckEnabled()

Get the flag for the WARN zone.

Returns:

the flag to know if the interval has a WARN zone fully defined.

setOkMin

public void setOkMin(double okMin)
              throws GIntervalException

Set the absolute minimum value of the OK zone.

Parameters:

okMin - the absolute minimum value of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setOkMax

public void setOkMax(double okMax)
              throws GIntervalException

Set the absolute maximum value of the OK zone.

Parameters:

okMax - the absolute maximum value of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setOkMinRule

public void setOkMinRule(GIntervalAbstract.Rule okMinRule)
                  throws GIntervalException

Set the rule applying to the absolute minimum of the OK zone.

Parameters:

okMinRule - the rule applying to the absolute minimum of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setOkMaxRule

public void setOkMaxRule(GIntervalAbstract.Rule okMaxRule)
                  throws GIntervalException

Set the rule applying to the absolute maximum of the OK zone.

Parameters:

okMaxRule - the rule applying to the absolute maximum of the OK zone.

Throws:

GIntervalException - if the interval is not valid

setWarnMin

public void setWarnMin(double warnMin)
                throws GIntervalException

Set the absolute minimum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMin - the absolute minimum value of the WARN zone.

Throws:

GIntervalException - if the interval is not valid

setWarnMax

public void setWarnMax(double warnMax)
                throws GIntervalException

Set the absolute maximum value of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMax - the absolute maximum value of the WARN zone.

Throws:

GIntervalException - if the interval is not valid

setWarnMinRule

public void setWarnMinRule(GIntervalAbstract.Rule warnMinRule)
                    throws GIntervalException

Set the rule applying to the absolute minimum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMinRule - the rule applying to the absolute minimum of the WARN zone.

Throws:

GIntervalException - if the interval is not valid

setWarnMaxRule

public void setWarnMaxRule(GIntervalAbstract.Rule warnMaxRule)
                    throws GIntervalException

Set the rule applying to the absolute maximum of the WARN zone. If the WARN zone is undefined, it is previously initialized to the OK zone.

Parameters:

warnMaxRule - the rule applying to the absolute maximum of the WARN zone.

Throws:

GIntervalException - if the interval is not valid

removeWarnCheck

public void removeWarnCheck()
                     throws GIntervalException

Removes the WARN zone of the interval.

Throws:

GIntervalException - if the interval is not valid