Log I/O
LasCurve Class Reference

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

Public Member Functions

void AddValue (object value)
 Add the specified value to the end of this curve. More...
 
string GetDescription ()
 Return description of this curve. More...
 
string GetName ()
 Return name of this curve. More...
 
int GetNValues ()
 Return the number of values in this curve. More...
 
object[] GetRange ()
 Return range (i.e min and max) of this curve. More...
 
Statistics GetStatistics ()
 Return curve statistics. More...
 
string GetUnit ()
 Return unit of measurement for the values of this curve. More...
 
object GetValue (int index)
 Return curve value of the specified index. More...
 
Type GetValueType ()
 Return data type of the values of this curve. More...
 
 LasCurve (string name, string unit, string description, Type valueType)
 Create a new LAS curve instance. More...
 
override string ToString ()
 

Detailed Description

Model a log curve of a LAS file.

Author
Petroware AS

Constructor & Destructor Documentation

LasCurve ( string  name,
string  unit,
string  description,
Type  valueType 
)

Create a new LAS curve instance.

Parameters
nameCurve name. Non-null.
unitData unit. Null if unitless or unknown.
descriptionCurve description. Null if none provided.
valueTypeData type of the values of the curve. Non-null.
Exceptions
ArgumentNullExceptionIf name or valueType is null.

Member Function Documentation

void AddValue ( object  value)

Add the specified value to the end of this curve.

The value may be a string or any other type, but it will be converted to the value type of this curve internally.

Parameters
valueValue to add. May be null to indicate no-value or absent.
string GetDescription ( )

Return description of this curve.

Returns
Description of this curve. Null if none provided.
string GetName ( )

Return name of this curve.

Returns
Name of this curve. Never null.
int GetNValues ( )

Return the number of values in this curve.

Returns
Number of values in this curve. [0,>.
object [] GetRange ( )

Return range (i.e min and max) 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.
Statistics GetStatistics ( )

Return curve statistics.

Statistics is available even if log data has not been stored.

Returns
Curve statistics. Never null.
string GetUnit ( )

Return unit of measurement for the values of this curve.

Returns
Unit of this curve. Null if unknown or unitless.
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().
Type GetValueType ( )

Return data type of the values of this curve.

Returns
Data type of the value type of this curve. Never null.

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