Log I/O
LasParameterRecord Class Reference

Class representing a LAS parameter record. More...

Inherits LasRecord.

Public Member Functions

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

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. More...
 

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 the LAS 3.0 documentation for details.

Author
Petroware AS

Constructor & Destructor Documentation

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

Create a LAS parameter record.

Parameters
nameName of this parameter record. Non-null.
unitUnit of the value of this parameter record. Null if unitless or unknown.
valueValue of this parameter record. Null to indicate absent.
descriptionDescription of this parameter record. Null if not provided.
Exceptions
ArgumentNullExceptionIf name is null.

Member Function Documentation

string GetDescription ( )

Return the description of this parameter record.

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

Return the name of this parameter record.

Returns
Name of this parameter record. Never null.
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.
string GetUnit ( )

Return the unit of this parameter record.

Returns
Unit of this parameter record. Null if unitless or unknown.
string GetValue ( )

Return the value of this parameter record.

Returns
Value of this parameter record. Null if absent.
Type GetValueType ( )

Return data type of values of this parameter record.

Returns
Data type of values of this parameter record. Never null.
void SetDescription ( string  description)

Set description of this parameter record.

Parameters
descriptionDescription to set. May be null indicating absent.
void SetName ( string  name)

Set name of this parameter record.

Parameters
nameName to set. Non-null.
Exceptions
ArgumentNullExceptionIf name is null.
void SetUnit ( string  unit)

Set unit of the value of this parameter record.

Parameters
unitUnit to set. May be null indicating absent or unitless.
void SetValue ( string  value)

Set the value of this parameter record.

Parameters
valueValue of this parameter record. May be null indicating absent.
void SetValue ( double  value)

Set numeric value of this parameter record.

Parameters
valueValue of this parameter record.

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