Model a curve of a BIT log file.
More...
|
void | AddValue (object value) |
| Add the specified value to the end of this curve.
|
|
| BitCurve (string name, string quantity, string unit, Type valueType) |
| Create a new BIT curve instance.
|
|
string | GetDescription () |
| Return description of this curve.
|
|
string | GetName () |
| Return name of this curve.
|
|
int | GetNValues () |
| Return the number of values in this curve.
|
|
string | GetQuantity () |
| Return quantity of this curve.
|
|
object[] | GetRange () |
| Return the range (i.e. min and max value) of this curve.
|
|
string | GetUnit () |
| Return unit of measurement for the values of this curve.
|
|
object | GetValue (int index) |
| Return curve value of the specified index.
|
|
Type | GetValueType () |
| Return type of the values of this curve.
|
|
override string | ToString () |
|
Model a curve of a BIT log file.
A log curve consists of measurement data of a specific type.
- Author
- Petroware AS
◆ BitCurve()
BitCurve |
( |
string | name, |
|
|
string | quantity, |
|
|
string | unit, |
|
|
Type | valueType ) |
Create a new BIT curve instance.
- Parameters
-
name | Curve name. Non-null. |
quantity | Quantity for the values. Null if N/A or unknown. |
unit | Curve unit. Null indicating N/A, unknown or unitless. |
valueType | Data type of the values of the curve. Non-null. |
- Exceptions
-
ArgumentNullException | If name or valueType is null. |
◆ AddValue()
void AddValue |
( |
object | value | ) |
|
Add the specified value to the end of this curve.
- Parameters
-
value | Value to add. May be null to indicate no-value or absent. |
◆ GetDescription()
string GetDescription |
( |
| ) |
|
Return description of this curve.
- Returns
- Description of this curve. Null if none provided.
◆ GetName()
Return name of this curve.
- Returns
- Name of this curve. Never null.
◆ GetNValues()
Return the number of values in this curve.
- Returns
- Number of values in this curve. [0,>.
◆ GetQuantity()
Return quantity of this curve.
- Returns
- Quantity of this curve. Null if N/A or unknown.
◆ GetRange()
Return the range (i.e. min and max value) of this curve.
The returned array is never null. The two entries may be null if min/max does not exist.
- Returns
- The range of this curve as an array of two (min/max). Never null. The entries may be null.
◆ GetUnit()
Return unit of measurement for the values of this curve.
- Returns
- Unit of this curve. Null if N/A, unknown or unitless.
◆ GetValue()
object GetValue |
( |
int | index | ) |
|
Return curve value of the specified index.
- Parameters
-
index | Index to return value from. [0,nValues>. |
- Returns
- The requested value. Null indicating absent. The returned value will be of the type obtained from GetValueType().
- Exceptions
-
IndexOutOfRangeException | If index is out of bounds. |
◆ GetValueType()
Return type of the values of this curve.
- Returns
- Value type of this curve. Never null.
The documentation for this class was generated from the following file:
- Petroware/LogIo/Bit/BitCurve.cs