org.interpss.numeric.datatype

Class LimitType

java.lang.Object

org.interpss.numeric.datatype.LimitType

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

LimitExpression

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

Limits class for (max, min) limits

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected double	_max
protected double	_min

Constructor Summary

Constructors

Constructor and Description
LimitType() Default constructor.
LimitType(double max, double min) Constructor.
LimitType(LimitType lim) Copy constructor.
LimitType(java.lang.String str) Constructor.

Method Summary

Modifier and Type	Method and Description
double	getMax() Get the max limit.
double	getMiddle() Get the middle value.
double	getMin() Get the min limit.
boolean	isError() Check if the Limit data is in error status.
boolean	isViolated(double x) Check if there is a limit violation, max > x > min.
boolean	isViolated(double x, double tolerance) Check if there is a limit violation, max > x > min with the tolerance.
boolean	isZero() check if the limit is zero
double	limit(double x) Perform limit action.
double	limitDiscrete(double x, double stepSize) Perform discrete limit action.
double	mismatch(double x) calculate limit mismatch if (x > getMax()) { return x - getMax(); } else if (x < getMin()) { return x - getMin(); } else { return 0; }
java.lang.String	toString() Convert the obj to a string.
java.lang.String	toString(double actual) Convert the obj to a string with an actual number as an input

Methods inherited from class java.lang.Object

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

Field Detail

_max

protected double _max

_min

protected double _min

Constructor Detail

LimitType

public LimitType()

Default constructor.

LimitType

public LimitType(double max,
                 double min)

Constructor.

Parameters:

max - unper limit

min - lower limit

LimitType

public LimitType(java.lang.String str)
          throws IpssNumericException

Constructor.

Parameters:

max - unper limit

min - lower limit

Throws:

IpssNumericException

LimitType

public LimitType(LimitType lim)

Copy constructor.

Parameters:

lim - limit obj to be copied

Method Detail

isError

public boolean isError()

Check if the Limit data is in error status.

isZero

public boolean isZero()

check if the limit is zero

Returns:

getMiddle

public double getMiddle()

Get the middle value.

Returns:

the middle value

getMax

public double getMax()

Get the max limit.

Returns:

the max limit

getMin

public double getMin()

Get the min limit.

Returns:

the min limit

isViolated

public boolean isViolated(double x)

Check if there is a limit violation, max > x > min.

Parameters:

x - a double number to be checked

Returns:

true or false

isViolated

public boolean isViolated(double x,
                          double tolerance)

Check if there is a limit violation, max > x > min with the tolerance.

Parameters:

x - a double number to be checked

tolerance -

Returns:

true or false

limit

public double limit(double x)

Perform limit action. if max >= x >= min return x, if max < x return max, if x < min return min.

Returns:

the resulting number

mismatch

public double mismatch(double x)

calculate limit mismatch if (x > getMax()) { return x - getMax(); } else if (x < getMin()) { return x - getMin(); } else { return 0; }

Returns:

the resulting number

limitDiscrete

public double limitDiscrete(double x,
                            double stepSize)
                     throws IpssNumericException

Perform discrete limit action. if max >= x >= min return the closest discrete point, if max < x return max, if x < min return min.

Returns:

the resulting number

Throws:

IpssNumericException

toString

public java.lang.String toString()

Convert the obj to a string.

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the obj

toString

public java.lang.String toString(double actual)

Convert the obj to a string with an actual number as an input

Returns:

the string representation of the obj