LasParameterRecord Class Reference

Class representing a LAS parameter record. More...

Inherits LasRecord.

Public Member Functions
string	GetDescription ()
	Return the description of this parameter record.
string	GetName ()
	Return the name of this parameter record.
string	GetTimeFormat ()
	Return time format for the values of this parameter record.
string	GetUnit ()
	Return the unit of this parameter record.
string	GetValue ()
	Return the value of this parameter record.
Type	GetValueType ()
	Return data type of values of this parameter record.
	LasParameterRecord (string name, string unit, string value, string description)
	Create a LAS parameter record.
void	SetDescription (string description)
	Set description of this parameter record.
void	SetName (string name)
	Set name of this parameter record.
void	SetUnit (string unit)
	Set unit of the value of this parameter record.
void	SetValue (double value)
	Set numeric value of this parameter record.
void	SetValue (string value)
	Set the value of this parameter record.
override string	ToString ()
Public Member Functions inherited from LasRecord
RecordType	GetRecordType ()
	Return type of this LAS record.

Additional Inherited Members
Public Types inherited from LasRecord
enum	RecordType { SECTION_TITLE , PARAMETER , DATA , COMMENT }
	The different record types. More...
Protected Member Functions inherited from LasRecord
	LasRecord (RecordType recordType)
	Create a new LAS record.

Detailed Description

Class representing a LAS parameter record.

A LAS parameter record has the following structure on file:

    NAME.UNIT  VALUE,... : DESCRIPTION {FORMAT} | ASSOC1,ASSOC2...
  

See LAS 3.0 Specification for details.

Author

Petroware AS

Constructor & Destructor Documentation

LasParameterRecord()

LasParameterRecord	(	string	name,
		string	unit,
		string	value,
		string	description )

Create a LAS parameter record.

Parameters

name	Name of this parameter record. Non-null.
unit	Unit of the value of this parameter record. Null if unitless or unknown.
value	Value of this parameter record. Null to indicate absent.
description	Description of this parameter record. Null if not provided.

Exceptions

ArgumentNullException

If name is null.

Member Function Documentation

GetDescription()

string GetDescription

(

)

Return the description of this parameter record.

Returns

Description of this parameter record. Null if none provided.

GetName()

string GetName

(

)

Return the name of this parameter record.

Returns

Name of this parameter record. Never null.

GetTimeFormat()

string GetTimeFormat

(

)

Return time format for the values of this parameter record.

Returns

Time format for the values of this parameter record, or null if the data is not of date/time type.

GetUnit()

string GetUnit

(

)

Return the unit of this parameter record.

Returns

Unit of this parameter record. Null if unitless or unknown.

GetValue()

string GetValue

(

)

Return the value of this parameter record.

Returns

Value of this parameter record. Null if absent.

GetValueType()

Type GetValueType

(

)

Return data type of values of this parameter record.

Returns

Data type of values of this parameter record. Never null.

SetDescription()

void SetDescription

(

string

description

)

Set description of this parameter record.

Parameters

description

Description to set. May be null indicating absent.

SetName()

void SetName

(

string

name

)

Set name of this parameter record.

Parameters

name	Name to set. Non-null.

Exceptions

ArgumentNullException

If name is null.

SetUnit()

void SetUnit

(

string

unit

)

Set unit of the value of this parameter record.

Parameters

unit	Unit to set. May be null indicating absent or unitless.

SetValue() [1/2]

void SetValue

(

double

value

)

Set numeric value of this parameter record.

Parameters

value

Value of this parameter record.

SetValue() [2/2]

void SetValue

(

string

value

)

Set the value of this parameter record.

Parameters

value

Value of this parameter record. May be null indicating absent.

---

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

• Petroware/LogIo/Las/LasParameterRecord.cs