com.isti.util.bilinearinterp
Class BilinearInterp.ResultBlock

java.lang.Object
  extended by com.isti.util.bilinearinterp.BilinearInterp.ResultBlock
Enclosing class:
BilinearInterp

public class BilinearInterp.ResultBlock
extends java.lang.Object

Class ResultBlock holds result of a bilinear interpolation operation.


Field Summary
 boolean errorFlag
          Flag set true if an error prevents a result from being returned.
 java.lang.String errorMessage
          String holding an error message, or null if no error.
 boolean outOfRangeFlag
          Flag set true if the given values were outside the range of the data set.
 double p1x1Val
          'x1', 'x2' and 'y' values for first of four surrounding points.
 double p1x2Val
          'x1', 'x2' and 'y' values for first of four surrounding points.
 double p1yVal
          'x1', 'x2' and 'y' values for first of four surrounding points.
 double p2x1Val
          'x1', 'x2' and 'y' values for second of four surrounding points.
 double p2x2Val
          'x1', 'x2' and 'y' values for second of four surrounding points.
 double p2yVal
          'x1', 'x2' and 'y' values for second of four surrounding points.
 double p3x1Val
          'x1', 'x2' and 'y' values for third of four surrounding points.
 double p3x2Val
          'x1', 'x2' and 'y' values for third of four surrounding points.
 double p3yVal
          'x1', 'x2' and 'y' values for third of four surrounding points.
 double p4x1Val
          'x1', 'x2' and 'y' values for fourth of four surrounding points.
 double p4x2Val
          'x1', 'x2' and 'y' values for fourth of four surrounding points.
 double p4yVal
          'x1', 'x2' and 'y' values for fourth of four surrounding points.
 double result
          The result value of the bilinear interpolation operation.
 double x1Val
          The 'x1' and 'x2' values used to generate the result.
 double x2Val
          The 'x1' and 'x2' values used to generate the result.
 
Constructor Summary
BilinearInterp.ResultBlock(double x1Val, double x2Val)
          Constructs a result block indicating that the given values were out of range of the data set.
BilinearInterp.ResultBlock(double val, double x1Val, double x2Val, double p1x1Val, double p1x2Val, double p1yVal, double p2x1Val, double p2x2Val, double p2yVal, double p3x1Val, double p3x2Val, double p3yVal, double p4x1Val, double p4x2Val, double p4yVal)
          Constructs a result block holding the given result value, the 'x1' and 'x2' values used to generate the result, and values for the four points in the data grid surrounding the given point.
BilinearInterp.ResultBlock(double x1Val, double x2Val, java.lang.String errMsgStr)
          Constructs a result block indicating an error described by the given error message text.
BilinearInterp.ResultBlock(java.lang.String errMsgStr)
          Constructs a result block indicating an error described by the given error message text.
 
Method Summary
 java.lang.String getDisplayString()
          Returns a display string of the contents of this block.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

result

public final double result
The result value of the bilinear interpolation operation.


outOfRangeFlag

public final boolean outOfRangeFlag
Flag set true if the given values were outside the range of the data set.


errorFlag

public final boolean errorFlag
Flag set true if an error prevents a result from being returned. See the error message in 'errorMessage'.


errorMessage

public final java.lang.String errorMessage
String holding an error message, or null if no error.


x1Val

public final double x1Val
The 'x1' and 'x2' values used to generate the result.


x2Val

public final double x2Val
The 'x1' and 'x2' values used to generate the result.


p1x1Val

public final double p1x1Val
'x1', 'x2' and 'y' values for first of four surrounding points.


p1x2Val

public final double p1x2Val
'x1', 'x2' and 'y' values for first of four surrounding points.


p1yVal

public final double p1yVal
'x1', 'x2' and 'y' values for first of four surrounding points.


p2x1Val

public final double p2x1Val
'x1', 'x2' and 'y' values for second of four surrounding points.


p2x2Val

public final double p2x2Val
'x1', 'x2' and 'y' values for second of four surrounding points.


p2yVal

public final double p2yVal
'x1', 'x2' and 'y' values for second of four surrounding points.


p3x1Val

public final double p3x1Val
'x1', 'x2' and 'y' values for third of four surrounding points.


p3x2Val

public final double p3x2Val
'x1', 'x2' and 'y' values for third of four surrounding points.


p3yVal

public final double p3yVal
'x1', 'x2' and 'y' values for third of four surrounding points.


p4x1Val

public final double p4x1Val
'x1', 'x2' and 'y' values for fourth of four surrounding points.


p4x2Val

public final double p4x2Val
'x1', 'x2' and 'y' values for fourth of four surrounding points.


p4yVal

public final double p4yVal
'x1', 'x2' and 'y' values for fourth of four surrounding points.

Constructor Detail

BilinearInterp.ResultBlock

public BilinearInterp.ResultBlock(double val,
                                  double x1Val,
                                  double x2Val,
                                  double p1x1Val,
                                  double p1x2Val,
                                  double p1yVal,
                                  double p2x1Val,
                                  double p2x2Val,
                                  double p2yVal,
                                  double p3x1Val,
                                  double p3x2Val,
                                  double p3yVal,
                                  double p4x1Val,
                                  double p4x2Val,
                                  double p4yVal)
Constructs a result block holding the given result value, the 'x1' and 'x2' values used to generate the result, and values for the four points in the data grid surrounding the given point.


BilinearInterp.ResultBlock

public BilinearInterp.ResultBlock(double x1Val,
                                  double x2Val)
Constructs a result block indicating that the given values were out of range of the data set.


BilinearInterp.ResultBlock

public BilinearInterp.ResultBlock(double x1Val,
                                  double x2Val,
                                  java.lang.String errMsgStr)
Constructs a result block indicating an error described by the given error message text.


BilinearInterp.ResultBlock

public BilinearInterp.ResultBlock(java.lang.String errMsgStr)
Constructs a result block indicating an error described by the given error message text.

Method Detail

getDisplayString

public java.lang.String getDisplayString()
Returns a display string of the contents of this block.