Log I/O
Loading...
Searching...
No Matches
BitCurve Class Referencesealed

Model a curve of a BIT log file. More...

Public Member Functions

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 ()
 

Detailed Description

Model a curve of a BIT log file.

A log curve consists of measurement data of a specific type.

Author
Petroware AS

Constructor & Destructor Documentation

◆ BitCurve()

BitCurve ( string name,
string quantity,
string unit,
Type valueType )

Create a new BIT curve instance.

Parameters
nameCurve name. Non-null.
quantityQuantity for the values. Null if N/A or unknown.
unitCurve unit. Null indicating N/A, unknown or unitless.
valueTypeData type of the values of the curve. Non-null.
Exceptions
ArgumentNullExceptionIf name or valueType is null.

Member Function Documentation

◆ AddValue()

void AddValue ( object value)

Add the specified value to the end of this curve.

Parameters
valueValue 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()

string GetName ( )

Return name of this curve.

Returns
Name of this curve. Never null.

◆ GetNValues()

int GetNValues ( )

Return the number of values in this curve.

Returns
Number of values in this curve. [0,>.

◆ GetQuantity()

string GetQuantity ( )

Return quantity of this curve.

Returns
Quantity of this curve. Null if N/A or unknown.

◆ GetRange()

object[] 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()

string 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
indexIndex 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
IndexOutOfRangeExceptionIf index is out of bounds.

◆ GetValueType()

Type 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: