Class BilinearMap
Represents a Bilinear map.
Inherited Members
Namespace: MESL.SqlRace.Domain
Assembly: MESL.SqlRace.Domain.dll
Syntax
public class BilinearMap : MapBaseRemarks
The bilinear map can be used to apply a bilinear operator against an x and y value to yield a return value that is linear to each of it's arguments.
A conversion can be applied to the x, y and return value. Return values are interpolated.
Constructors
BilinearMap(String, String, String, String, String, String, String, Double[], Double[], Double[])
Initialises a new instance of the BilinearMap class.
Declaration
public BilinearMap(string name, string description, string units, string format, string conversionXFunctionName, string conversionYFunctionName, string conversionValueFunctionName, double[] breakXPoints, double[] breakYPoints, double[] values)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The name of the map. |
| System.String | description | The description of the map. |
| System.String | units | The units the map uses. |
| System.String | format | The format of the map. |
| System.String | conversionXFunctionName | The conversion X function. |
| System.String | conversionYFunctionName | The conversion Y function. |
| System.String | conversionValueFunctionName | The conversion value function. |
| System.Double[] | breakXPoints | The break X points. |
| System.Double[] | breakYPoints | The break Y points. |
| System.Double[] | values | The values in the map. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentException | Thrown if the number of elements in the values array is no equal to the product of the elements in the breakXPoints and breakYPoints array. |
| System.ArgumentNullException | Thrown if conversionXFunctionName is null. |
| System.ArgumentNullException | Thrown if conversionYFunctionName is null. |
| System.ArgumentNullException | Thrown if conversionValueFunctionName is null. |
Properties
BreakYPoints
Gets an array of doubles for the BreakYPoints.
Declaration
public double[] BreakYPoints { get; }Property Value
| Type | Description |
|---|---|
| System.Double[] | The BreakYPoints. |
ConversionYFunctionName
Gets the name of the ConversionYFunction.
Declaration
public string ConversionYFunctionName { get; }Property Value
| Type | Description |
|---|---|
| System.String | The name of the conversion Y function. |
Methods
Lookup(Double, Double)
Returns the data value for a given X, Y value after applying the conversion function.
Declaration
public double Lookup(double xvalue, double yvalue)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | xvalue | The X value. |
| System.Double | yvalue | The Y value. |
Returns
| Type | Description |
|---|---|
| System.Double | Looked up value |