A collection of convenience methods to access common meta-data from DLIS files. More...

Static Public Member Functions
static ? double	GetBitSize (DlisFile dlisFile)
	Return bit size of the specified DLIS file.

static string	GetCompany (DlisFile dlisFile)
	Return the company of the specified DLIS file.

static string	GetCountry (DlisFile dlisFile)
	Return country of the well of the specified DLIS file.

static string	GetFieldName (DlisFile dlisFile)
	Return the field name of the specified DLIS file.

static ISet< string >	GetGenericToolNames (DlisFile dlisFile)
	Return list of generic tool names of the specified DLIS file.

static string	GetHeaderIdentifier (DlisFile dlisFile)
	Return the header identifier (parameter "HIDE") from the specified DLIS file.

static string	GetId (DlisFile dlisFile)
	Return the ID of the specified DLIS file, i.e.

static DlisFrame.IndexType	GetIndexType (DlisFile dlisFile)
	Return the index type of the specified DLIS file.

static double[]	GetInterval (DlisFile dlisFile)
	Return the logging interval for the specified DLIS file.

static ? double	GetMd (DlisFile dlisFile)
	Return MD (measured depth) of the specified DLIS file.

static string	GetProducerName (DlisFile dlisFile)
	Return the producer (company) of the specified DLIS file.

static string	GetRunNumber (DlisFile dlisFile)
	Return run number of the specified DLIS file.

static int	GetSequenceNumber (DlisFile dlisFile)
	Return the sequence number (i.e order of sub files within a disk file) of this DLIS file.

static ? DateTime	GetStartDate (DlisFile dlisFile)
	Return start date of operation of the specified DLIS file.

static string	GetWellName (DlisFile dlisFile)
	Return the well name of the specified DLIS file.

static string	ToString (DlisFile dlisFile)
	Create a string representation of the entire content of the specified DLIS file.

Detailed Description

A collection of convenience methods to access common meta-data from DLIS files.

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

Unfortunately it is entirely up to the producer of the DLIS 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 usually do, however.

Author: Petroware AS

Member Function Documentation

◆ GetBitSize()

static ? double GetBitSize ( DlisFile dlisFile )

static

Return bit size of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for bit size that is applied here is "BS" from some set.

Parameters

dlisFile DLIS file to get bit size of. Non-null.

Returns: Bit size of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetCompany()

static string GetCompany ( DlisFile dlisFile )

static

Return the company of the specified DLIS 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 "COMPANY" from the "ORIGIN" set.

Parameters

dlisFile DLIS file to get company of. Non-null.

Returns: Company of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetCountry()

static string GetCountry ( DlisFile dlisFile )

static

Return country of the well of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for company that is applied here is "NATI" or "STAT" from the "ORIGIN" set.

Parameters

dlisFile DLIS file to get country of. Non-null.

Returns: Country of the well of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetFieldName()

static string GetFieldName ( DlisFile dlisFile )

static

Return the field name of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for field name that is applied here is "FIELD-NAME" or "FN" from the "ORIGIN" set.

Parameters

dlisFile DLIS file to get field name of. Non-null.

Returns: Field name of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetGenericToolNames()

static ISet< string > GetGenericToolNames ( DlisFile dlisFile )

static

Return list of generic tool names of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for tool names that is applied here is "GENERIC-NAME" from the "TOOL" set.

Parameters

dlisFile DLIS file to get generic tool names of. Non-null.

Returns: List of tools of the DLIS file. Never null.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetHeaderIdentifier()

static string GetHeaderIdentifier ( DlisFile dlisFile )

static

Return the header identifier (parameter "HIDE") from the specified DLIS file.

It typically contains tool names and may be more convenient to use than objects in the "TOOL" set.

Parameters

dlisFile DLIS file to get header identifier of. Non-null.

Returns: Header identifier of the DLIS file. Empty string if none. Never null.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetId()

static string GetId ( DlisFile dlisFile )

static

Return the ID of the specified DLIS file, i.e.

the "ID" attribute of the FILE-HEADER set.

Parameters

dlisFile DLIS file to find ID of. Non-null.

Returns: ID of the DLIS file. If the entry is not found, null is returned.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetIndexType()

static DlisFrame.IndexType GetIndexType ( DlisFile dlisFile )

static

Return the index type of the specified DLIS file.

Parameters

dlisFile DLIS file to get index type of. Non-null.

Returns: Index type of the DLIS file, or UNKNOWN if none or multiple found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetInterval()

static double[] GetInterval ( DlisFile dlisFile )

static

Return the logging interval for the specified DLIS file.

This is the min and max values across all frames.

Parameters

dlisFile DLIS file to get interval of. Non-null.

Returns: Array of two: min and max value, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetMd()

static ? double GetMd ( DlisFile dlisFile )

static

Return MD (measured depth) of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tags for MD that is applied here is "MTZD" or "DEPTH_CMR_SL" from some set.

Parameters

dlisFile DLIS file to get MD of. Non-null.

Returns: MD of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetProducerName()

static string GetProducerName ( DlisFile dlisFile )

static

Return the producer (company) of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for producer name that is applied here is "PRODUCER-NAME" from the "ORIGIN" set.

Parameters

dlisFile DLIS file to get producer name of. Non-null.

Returns: Producer name of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetRunNumber()

static string GetRunNumber ( DlisFile dlisFile )

static

Return run number of the specified DLIS file.

NOTE: This property is not explicitly defined by the format and is known by convention only. The commonly used tag for run number that is applied here is "RUN" from some set.

Parameters

dlisFile DLIS file to get run number of. Non-null.

Returns: Run number of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetSequenceNumber()

static int GetSequenceNumber ( DlisFile dlisFile )

static

Return the sequence number (i.e order of sub files within a disk file) of this DLIS file.

Parameters

dlisFile DLIS file to find sequence number of. Non-null.

Returns: Sequence number of the DLIS file. If the entry is not found, 1 is returned.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetStartDate()

static ? DateTime GetStartDate ( DlisFile dlisFile )

static

Return start date of operation of the specified DLIS file.

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

Parameters

dlisFile DLIS file to get start date of. Non-null.

Returns: Start date of operation of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ GetWellName()

static string GetWellName ( DlisFile dlisFile )

static

Return the well name of the specified DLIS 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 "WELL-NAME" or "WN" from the "ORIGIN" set.

Parameters

dlisFile DLIS file to get well name of. Non-null.

Returns: Well name of the DLIS file, or null if not found.

Exceptions

ArgumentNullException If dlisFile is null.

◆ ToString()

static string ToString ( DlisFile dlisFile )

static

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

Parameters

dlisFile DLIS file to get as string. Non-null.

Returns: A string representation of the DLIS file. Never null.

Exceptions

ArgumentNullException If dlisFile is null.

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

Petroware/LogIo/Dlis/DlisUtil.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ GetBitSize()

◆ GetCompany()

◆ GetCountry()

◆ GetFieldName()

◆ GetGenericToolNames()

◆ GetHeaderIdentifier()

◆ GetId()

◆ GetIndexType()

◆ GetInterval()

◆ GetMd()

◆ GetProducerName()

◆ GetRunNumber()

◆ GetSequenceNumber()

◆ GetStartDate()

◆ GetWellName()

◆ ToString()