Log I/O
Loading...
Searching...
No Matches
LisUtil Class Reference

Convenience class for extracting information from LIS files. More...

Static Public Member Functions

static ? double GetBitSize (LisFile lisFile)
 Return bit size of the specified LIS file.
 
static string GetCompany (LisFile lisFile)
 Return company of the specified LIS file.
 
static string GetCountry (LisFile lisFile)
 Return country of the specified LIS file.
 
static ? DateTime GetDate (LisFile lisFile)
 Return date of the specified LIS file.
 
static string GetFieldName (LisFile lisFile)
 Return field name of the specified LIS file.
 
static string GetRigName (LisFile lisFile)
 Return rig name of the specified LIS file.
 
static string GetRunNumber (LisFile lisFile)
 Return run number of the specified LIS file.
 
static ? double GetSampleInterval (LisFile lisFile)
 Return the sample interval for the specified LIS file.
 
static string GetServiceCompany (LisFile lisFile)
 Return service company of the specified LIS file.
 
static string GetWellName (LisFile lisFile)
 Return well name of the specified LIS file.
 
static bool IsTimeIndexed (LisFile lisFile)
 Check if the specified LIS file is time indexed.
 
static string ToString (LisFile lisFile)
 Create a string representation of the entire content of the specified LIS file.
 

Detailed Description

Convenience class for extracting information from LIS files.

Note that most of these utilities are based on LIS meta-data conventions for naming. Based on experience, several common names for each property is being tried (like "WN" and "NAME" for well name etc.).

Unfortunately it is entirely up to the producer of the LIS file to decide the tagging of the information, and there is no guarantee that the methods of this class will work. Experience shows that they often do, however.

Author
Petroware AS

Member Function Documentation

◆ GetBitSize()

static ? double GetBitSize ( LisFile lisFile)
static

Return bit size of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for bit size that is applied here is "BS" or "BS1".

Parameters
lisFileLIS file to get bit size of. Non-null.
Returns
Requested bit size, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetCompany()

static string GetCompany ( LisFile lisFile)
static

Return company of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for company that is applied here is "CN".

Parameters
lisFileLIS file to get company of. Non-null.
Returns
Requested company, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetCountry()

static string GetCountry ( LisFile lisFile)
static

Return country of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for country that is applied here is "NATI" or "CTRY".

Parameters
lisFileLIS file to get country of. Non-null.
Returns
Requested country, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetDate()

static ? DateTime GetDate ( LisFile lisFile)
static

Return date of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for date that is applied here is "DATE".

Parameters
lisFileLIS file to get date of. Non-null.
Returns
Requested date, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetFieldName()

static string GetFieldName ( LisFile lisFile)
static

Return field name of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for field name that is applied here is "FN".

Parameters
lisFileLIS file to get field name of. Non-null.
Returns
Requested field name, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetRigName()

static string GetRigName ( LisFile lisFile)
static

Return rig name of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for rig name that is applied here is "RIG".

Parameters
lisFileLIS file to get rig name of. Non-null.
Returns
Requested rig name, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetRunNumber()

static string GetRunNumber ( LisFile lisFile)
static

Return run number of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for run number that is applied here is "LRUN" or "RUN".

Parameters
lisFileLIS file to get run number of. Non-null.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for bit size that is applied here is "BS" or "BS1".

Returns
Requested run number, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetSampleInterval()

static ? double GetSampleInterval ( LisFile lisFile)
static

Return the sample interval for the specified LIS file.

Parameters
lisFileLIS file to get sample interval of. Non-null.
Returns
Requested sample interval in the unit of the index curve. If the LIS file is time indexed, the value will be returned as milliseconds. If there are no curves or no values or the LIS file is not evenly sampled, null is returned.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetServiceCompany()

static string GetServiceCompany ( LisFile lisFile)
static

Return service company of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for service company that is applied here is "LCON", "LCC" or "SRVC".

Parameters
lisFileLIS file to get service company of. Non-null.
Returns
Requested service company, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ GetWellName()

static string GetWellName ( LisFile lisFile)
static

Return well name of the specified LIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for well name that is applied here is "WN" or "WELL".

Parameters
lisFileLIS file to get well name of. Non-null.
Returns
Requested well name, or null if not found.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ IsTimeIndexed()

static bool IsTimeIndexed ( LisFile lisFile)
static

Check if the specified LIS file is time indexed.

Parameters
lisFileLIS file check. Non-null.
Returns
True if the file is time indexed, false otherwise.
Exceptions
ArgumentNullExceptionIf lisFile is null.

◆ ToString()

static string ToString ( LisFile lisFile)
static

Create a string representation of the entire content of the specified LIS file.

Parameters
lisFileLIS file to get as string. Non-null.
Returns
A string representation of the LIS file. Never null.
Exceptions
ArgumentNullExceptionIf lisFile is null.

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