LasCurve Class Reference

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

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

Detailed Description

Model a log curve of a LAS file.

Author

Petroware AS

Constructor & Destructor Documentation

LasCurve()

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

Create a new LAS curve instance.

Parameters

name	Curve name. Non-null.
unit	Data unit. Null if unitless or unknown.
description	Curve description. Null if none provided.
valueType	Data type of the values of the curve. Non-null.
nDimensions	Number of dimensions in curve. [1,>.

Exceptions

ArgumentNullException	If name or valueType is null.
ArgumentException	If nDimensions is invalid.

Member Function Documentation

AddValue() [1/2]

void AddValue	(	int	dimension,
		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

dimension	Dimension index. [0,nDimensions>.
value	Value to add. May be null to indicate no-value or absent.

Exceptions

ArgumentException

If dimension is out of bounds.

AddValue() [2/2]

void AddValue

(

object

value

)

Add the specified value to the end of (the first dimension 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.

This is equivalent of calling addValue(0, value).

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

string GetName

(

)

Return name of this curve.

Returns

Name of this curve. Never null.

GetNDimensions()

int GetNDimensions

(

)

Return the number of dimensions of this curve.

Returns

Number of dimensions of this curve. [1,>.

GetNValues()

int GetNValues

(

)

Return the number of values in this curve.

Returns

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

GetRange()

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.

If the curve is multidimensional, the range is reported across all dimensions.

Returns

The range of this curve as an array of two (min/max). Never null. The entries may be null.

GetStatistics()

Statistics GetStatistics

(

)

Return curve statistics.

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

Returns

Curve statistics. Never null.

GetUnit()

string GetUnit

(

)

Return unit of measurement for the values of this curve.

Returns

Unit of this curve. Null if unknown or unitless.

GetValue() [1/2]

object GetValue	(	int	dimension,
		int	index )

Return curve value of the specified index.

Parameters

dimension	Dimension index. [0,nDimensions>.
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().

GetValue() [2/2]

object GetValue

(

int

index

)

Return curve value of the specified index.

Equivalent to getValue(0, 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().

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:

• Petroware/LogIo/Las/LasCurve.cs