SORTIE Java Interface  1
Static Public Member Functions | List of all members
sortie.data.funcgroups.ValidationHelpers Class Reference

Static Public Member Functions

static void makeSureAllAreBounded (ModelVector oData, boolean[] p_bAppliesTo, float fLowerBound, float fUpperBound) throws ModelException
 Makes sure that all the values in a vector fall between two bounds.
 
static void makeSureAllPositive (Float[] p_fData, String sName, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of a float array are positive numbers (greater than zero).
 
static void makeSureAllPositive (Float[] p_fData, String sName) throws ModelException
 Makes sure the elements of a float array are positive numbers (greater than zero).
 
static void makeSureAllNonNegative (Float[] p_fData, String sName, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).
 
static void makeSureAllNonNegative (Float[] p_fData, String sName) throws ModelException
 Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).
 
static void makeSureAllPositive (Integer[] p_iData, String sName, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of an integer array are positive numbers (greater than zero).
 
static void makeSureAllPositive (Integer[] p_iData, String sName) throws ModelException
 Makes sure the elements of an integer array are positive numbers (greater than zero).
 
static void makeSureAllNonNegative (Integer[] p_iData, String sName, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).
 
static void makeSureAllNonNegative (Integer[] p_iData, String sName) throws ModelException
 Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).
 
static void makeSureGreaterThan (ModelFloat oValue, float fLowerBound) throws ModelException
 Makes sure a value is greater than a certain value.
 
static void makeSureGreaterThanEqualTo (ModelFloat oValue, float fLowerBound) throws ModelException
 Makes sure a value is greater than or equal to a certain value.
 
static void makeSureGreaterThan (ModelInt oValue, float fLowerBound) throws ModelException
 Makes sure a value is greater than a certain value.
 
static void makeSureGreaterThanEqualTo (ModelInt oValue, float fLowerBound) throws ModelException
 Makes sure a value is greater than or equal to a certain value.
 
static void makeSureLessThan (ModelFloat oValue, float fUpperBound) throws ModelException
 Makes sure a value is less than a certain value.
 
static void makeSureLessThan (ModelInt oValue, float fUpperBound) throws ModelException
 Makes sure a value is less than a certain value.
 
static void makeSureLessThanEqualTo (ModelFloat oValue, float fUpperBound) throws ModelException
 Makes sure a value is less than or equal to a certain value.
 
static void makeSureLessThanEqualTo (ModelInt oValue, float fUpperBound) throws ModelException
 Makes sure a value is less than or equal to a certain value.
 
static void makeSureNotEqualTo (ModelFloat oValue, float fForbidden) throws ModelException
 Makes sure a value is not equal to another value.
 
static void makeSureNotEqualTo (ModelInt oValue, float fForbidden) throws ModelException
 Makes sure a value is not equal to another value.
 
static void makeSureIsBounded (ModelFloat oValue, float fLowerBound, float fUpperBound) throws ModelException
 Makes sure a value falls in an acceptable range.
 
static void makeSureIsBounded (ModelInt oValue, float fLowerBound, float fUpperBound) throws ModelException
 Makes sure a value falls in an acceptable range.
 
static void makeSureIsProportion (ModelFloat fValue) throws ModelException
 Makes sure a value is a proportion between 0 and 1 (inclusive).
 
static void makeSureAllAreProportions (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the data in a vector are proportions between 0 and 1 (inclusive).
 
static void makeSureAllAreProportions (ModelVector oData) throws ModelException
 Makes sure all the data in a vector are proportions between 0 and 1 (inclusive).
 
static void makeSureRightSize (ModelVector oData, int iLength) throws ModelException
 Makes sure that a vector is of a certain size.
 
static void makeSureAllNonNegative (ModelVector oData) throws ModelException
 Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).
 
static void makeSureAllNonZero (ModelVector oData) throws ModelException
 Makes sure the elements of a vector are non-zero.
 
static void makeSureAllNonZero (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of a vector are non-zero numbers.
 
static void makeSureAllPositive (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of a vector are positive numbers (greater than zero).
 
static void makeSureAllPositive (ModelVector oData) throws ModelException
 Makes sure the elements of a vector are positive numbers (greater than zero).
 
static void makeSureAllNonNegative (ModelVector oData, boolean[] p_bAppliesTo) throws ModelException
 Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).
 

Member Function Documentation

static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreBounded ( ModelVector  oData,
boolean[]  p_bAppliesTo,
float  fLowerBound,
float  fUpperBound 
) throws ModelException
static

Makes sure that all the values in a vector fall between two bounds.

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
oDataModelVector Vector to check.
p_bAppliesToboolean[] Set of flags for which values to check.
fLowerBoundFloat Minimum acceptable value.
fUpperBoundFloat Maximum acceptable value.
Exceptions
ModelExceptionIf any value falls outside of the range.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreProportions ( ModelVector  oData,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the data in a vector are proportions between 0 and 1 (inclusive).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
oDataVector to check
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif any value in the vector is not a valid proportion.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllAreProportions ( ModelVector  oData) throws ModelException
static

Makes sure all the data in a vector are proportions between 0 and 1 (inclusive).

Parameters
oDataVector to check
Exceptions
ModelExceptionif any value in the vector is not a valid proportion.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( Float[]  p_fData,
String  sName,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
p_fDataThe array to check.
sNameThe name of the vector, to put in the error message.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( Float[]  p_fData,
String  sName 
) throws ModelException
static

Makes sure the elements of a float array are non-negative numbers (greater than or equal to zero).

Parameters
p_fDataThe array to check.
sNameThe name of the vector, to put in the error message.
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( Integer[]  p_iData,
String  sName,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
p_iDataThe array to check.
sNameThe name of the vector, to put in the error message.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( Integer[]  p_iData,
String  sName 
) throws ModelException
static

Makes sure the elements of an integer array are non-negative numbers (greater than or equal to zero).

Parameters
p_iDataThe array to check.
sNameThe name of the vector, to put in the error message.
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( ModelVector  oData) throws ModelException
static

Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).

Parameters
oDataThe vector to check.
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonNegative ( ModelVector  oData,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of a vector are non-negative numbers (greater than or equal to zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
oDataThe vector to check.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonZero ( ModelVector  oData) throws ModelException
static

Makes sure the elements of a vector are non-zero.

Parameters
oDataThe vector to check.
Exceptions
ModelExceptionif there are any 0 values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllNonZero ( ModelVector  oData,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of a vector are non-zero numbers.

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
oDataThe vector to check.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any negative number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( Float[]  p_fData,
String  sName,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of a float array are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
p_fDataThe array to check.
sNameThe name of the vector, to put in the error message.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( Float[]  p_fData,
String  sName 
) throws ModelException
static

Makes sure the elements of a float array are positive numbers (greater than zero).

Parameters
p_fDataThe array to check.
sNameThe name of the vector, to put in the error message.
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( Integer[]  p_iData,
String  sName,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of an integer array are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
p_iDataThe array to check.
sNameThe name of the vector, to put in the error message.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( Integer[]  p_iData,
String  sName 
) throws ModelException
static

Makes sure the elements of an integer array are positive numbers (greater than zero).

Parameters
p_iDataThe array to check.
sNameThe name of the vector, to put in the error message.
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( ModelVector  oData,
boolean[]  p_bAppliesTo 
) throws ModelException
static

Makes sure the elements of a vector are positive numbers (greater than zero).

Only those indexes for which p_bAppliesTo = true at the same index are checked.

Parameters
oDataThe vector to check.
p_bAppliesToSet of flags for which values to check
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureAllPositive ( ModelVector  oData) throws ModelException
static

Makes sure the elements of a vector are positive numbers (greater than zero).

Parameters
oDataThe vector to check.
Exceptions
ModelExceptionif there are any non-positive number values in the vector.
static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThan ( ModelFloat  oValue,
float  fLowerBound 
) throws ModelException
static

Makes sure a value is greater than a certain value.

Parameters
oValueThe value to check.
fLowerBoundThe value the test value must be greater than.
Exceptions
ModelExceptionif the value is not greater than fLowerBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThan ( ModelInt  oValue,
float  fLowerBound 
) throws ModelException
static

Makes sure a value is greater than a certain value.

Parameters
oValueThe value to check.
fLowerBoundThe value the test value must be greater than.
Exceptions
ModelExceptionif the value is not greater than fLowerBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThanEqualTo ( ModelFloat  oValue,
float  fLowerBound 
) throws ModelException
static

Makes sure a value is greater than or equal to a certain value.

Parameters
oValueThe value to check.
fLowerBoundThe value the test value must be greater than or equal to.
Exceptions
ModelExceptionif the value is not greater than fLowerBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureGreaterThanEqualTo ( ModelInt  oValue,
float  fLowerBound 
) throws ModelException
static

Makes sure a value is greater than or equal to a certain value.

Parameters
oValueThe value to check.
fLowerBoundThe value the test value must be greater than or equal to.
Exceptions
ModelExceptionif the value is not greater than fLowerBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureIsBounded ( ModelFloat  oValue,
float  fLowerBound,
float  fUpperBound 
) throws ModelException
static

Makes sure a value falls in an acceptable range.

Parameters
oValueThe value to check.
fLowerBoundfloat Minimum acceptable value.
fUpperBoundfloat Maximum acceptable value.
Exceptions
ModelExceptionIf any value falls outside of the range.
static void sortie.data.funcgroups.ValidationHelpers.makeSureIsBounded ( ModelInt  oValue,
float  fLowerBound,
float  fUpperBound 
) throws ModelException
static

Makes sure a value falls in an acceptable range.

Parameters
oValueThe value to check.
fLowerBoundfloat Minimum acceptable value.
fUpperBoundfloat Maximum acceptable value.
Exceptions
ModelExceptionIf any value falls outside of the range.
static void sortie.data.funcgroups.ValidationHelpers.makeSureIsProportion ( ModelFloat  fValue) throws ModelException
static

Makes sure a value is a proportion between 0 and 1 (inclusive).

Parameters
fValueValue to check.
Exceptions
ModelExceptionif the value is not a valid proportion.
static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThan ( ModelFloat  oValue,
float  fUpperBound 
) throws ModelException
static

Makes sure a value is less than a certain value.

Parameters
oValueThe value to check.
fUpperBoundThe value the test value must be less than.
Exceptions
ModelExceptionif the value is not less than fUpperBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThan ( ModelInt  oValue,
float  fUpperBound 
) throws ModelException
static

Makes sure a value is less than a certain value.

Parameters
oValueThe value to check.
fUpperBoundThe value the test value must be less than.
Exceptions
ModelExceptionif the value is not less than fUpperBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThanEqualTo ( ModelFloat  oValue,
float  fUpperBound 
) throws ModelException
static

Makes sure a value is less than or equal to a certain value.

Parameters
oValueThe value to check.
fUpperBoundThe value the test value must be less than or equal to.
Exceptions
ModelExceptionif the value is not greater than fUpperBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureLessThanEqualTo ( ModelInt  oValue,
float  fUpperBound 
) throws ModelException
static

Makes sure a value is less than or equal to a certain value.

Parameters
oValueThe value to check.
fUpperBoundThe value the test value must be less than or equal to.
Exceptions
ModelExceptionif the value is not greater than fUpperBound.
static void sortie.data.funcgroups.ValidationHelpers.makeSureNotEqualTo ( ModelFloat  oValue,
float  fForbidden 
) throws ModelException
static

Makes sure a value is not equal to another value.

Parameters
oValueThe value to check.
fForbiddenThe value the test value cannot equal.
Exceptions
ModelExceptionif the value is equal to the specified value, within a very small number.
static void sortie.data.funcgroups.ValidationHelpers.makeSureNotEqualTo ( ModelInt  oValue,
float  fForbidden 
) throws ModelException
static

Makes sure a value is not equal to another value.

Parameters
oValueThe value to check.
fForbiddenThe value the test value cannot equal.
Exceptions
ModelExceptionif the value is equal to the specified value, within a very small number.
static void sortie.data.funcgroups.ValidationHelpers.makeSureRightSize ( ModelVector  oData,
int  iLength 
) throws ModelException
static

Makes sure that a vector is of a certain size.

Parameters
oDataVector to validate.
iLengthExpected length.
Exceptions
ModelExceptionif the vector is not of the correct length.

The documentation for this class was generated from the following file: