nce.base

Class Range

java.lang.Object

nce.base.Range

All Implemented Interfaces:

java.io.Serializable

public class Range
extends java.lang.Object
implements java.io.Serializable

Defines a collection of intervals called 'ranges', of the type [Xmin, Xmax] where X a certain variable of which the numerical value shall be kept with the interval for the calculation to maintain a physical meaning or to respect the validity range of a computational model. Very often X may be temperature or pressure.

Version:

20151118

Author:

Carlo Tegano

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Range.Format

Constructor Summary

Constructors

Constructor and Description
Range()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRange(java.lang.String varName, double val1, double val2) Adds a new range or modifies an existent one
void	deleteRange(java.lang.String varName) Removes a range
double	getLimitHigh(java.lang.String varName) Returns upper range limit
double	getLimitLow(java.lang.String varName) Returns lower range limit
boolean	isAcceptable(java.lang.String varName) Returns the previously checked acceptability status of variable
boolean	isAcceptable(java.lang.String[] varNames, double... values) Checks if all variables are within range.
boolean	isAcceptable(java.lang.String varName, double value) Checks if value is acceptable for varName.
java.lang.String	toString() Returns something similar to a Json string
java.lang.String	toString(Range.Format format)
java.lang.String	toString(java.lang.String varName) Composes a single line report string about if range of variable varName was violated or not

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Range

public Range()

Method Detail

addRange

public void addRange(java.lang.String varName,
            double val1,
            double val2)

Adds a new range or modifies an existent one

Parameters:

varName -

val1 -

val2 -

deleteRange

public void deleteRange(java.lang.String varName)

Removes a range

Parameters:

varName -

getLimitLow

public double getLimitLow(java.lang.String varName)

Returns lower range limit

Parameters:

varName -

Returns:

Lower interval limit

getLimitHigh

public double getLimitHigh(java.lang.String varName)

Returns upper range limit

Parameters:

varName -

Returns:

Upper interval limit

isAcceptable

public boolean isAcceptable(java.lang.String varName,
                   double value)

Checks if value is acceptable for varName. This function shall be called BEFORE a report is required for input ranges.

Parameters:

varName -

value -

Returns:

True if value of varName is within the range

isAcceptable

public boolean isAcceptable(java.lang.String varName)

Returns the previously checked acceptability status of variable

Parameters:

varName -

Returns:

acceptability status previously evaluated

isAcceptable

public boolean isAcceptable(java.lang.String[] varNames,
                   double... values)

Checks if all variables are within range. This function may be called BEFORE a report is required for all input ranges, instead of calling isAcceptable on every variable.

Parameters:

varNames -

values -

Returns:

false if at least one variable is out of range

toString

public java.lang.String toString(java.lang.String varName)

Composes a single line report string about if range of variable varName was violated or not

Parameters:

varName -

Returns:

A single line report string

toString

public java.lang.String toString(Range.Format format)

toString

public java.lang.String toString()

Returns something similar to a Json string

Overrides:

toString in class java.lang.Object

Returns:

Json-like representation of the object