Log I/O
Loading...
Searching...
No Matches
DlisFile Class Referencesealed

Class representing the content of one DLIS (sub-) file. More...

Public Member Functions

void AddFrame (DlisFrame frame)
 Add the specified frame to this DLIS file.
 
void AddSet (DlisSet set)
 Add the specified set to this DLIS file.
 
 DlisFile ()
 Create a new empty DLIS file instance with default header.
 
DlisFrame FindFrame (string frameName)
 Find frame with the specified name.
 
DlisSet FindSet (string setType)
 Find set of the specified type.
 
IList< DlisEncryptedRecordGetEncryptedRecords ()
 Return the encrypted records of this DLIS file.
 
string GetFileId ()
 Return the ID of this DLIS file as specified in the ORIGIN set of the file.
 
IList< DlisFrameGetFrames ()
 Return the frames of this DLIS file.
 
DlisFileHeader GetHeader ()
 Return the header of this DLIS file.
 
string GetName ()
 Return the name of this file.
 
IList< DlisSetGetSets ()
 Return the sets of this DLIS file.
 
string GetUnit (string objectName, string attributeName)
 Return unit for the specified meta-data attribute of the specified object.
 
DlisType GetValue (string objectName, string attributeName)
 Return value for the specified attribute of the specified object.
 
DlisComponent GetValueComponent (string objectName, string attributeName)
 Return the value component (i.e. the instance holding the values and specifying the unit etc.) for the given attribute of the specified object.
 
IList< DlisTypeGetValues (string objectName, string attributeName)
 Return values for the specified attribute of the specified object.
 
bool HasCurveData ()
 Return whether the DLIS file instance includes curve data or not, i.e. if only header data was read or created.
 
override string ToString ()
 

Detailed Description

Class representing the content of one DLIS (sub-) file.

A DlisFile consists of the following elements:

  • File header - This is really a property of the disk file, but it is included in each DlisFile instance for simplicity.

  • Meta-data - Data about the logging operation. Organized in sets (DlisSet).

  • Encrypted records - Data that can't really be interpreted, but it is anyway read, and provided as simple byte arrays through the DlisEncryptedRecord class.

  • Curve data - This is organized in frames (DlisFrame) which defines one set of curves sampled against a common reference index.
Author
Petroware AS

Member Function Documentation

◆ AddFrame()

void AddFrame ( DlisFrame frame)

Add the specified frame to this DLIS file.

Note that the associated FRAME set must be added by the client explicitly.

Parameters
frameFrame to add. Non-null.
Exceptions
ArgumentNullExceptionIf frame is null.

◆ AddSet()

void AddSet ( DlisSet set)

Add the specified set to this DLIS file.

Parameters
setSet to add. Non-null.
Exceptions
ArgumentNullExceptionIf set is null.

◆ FindFrame()

DlisFrame FindFrame ( string frameName)

Find frame with the specified name.

Parameters
frameNameName of frame to find. Non-null.
Returns
Requested frame, or null if not found.
Exceptions
ArgumentNullExceptionIf frameName is null.

◆ FindSet()

DlisSet FindSet ( string setType)

Find set of the specified type.

If there are more than one set with the given type, the first one found is returned.

Set types are dictionary controlled. Typical values are "FILE-HEADER", "ORIGIN", "PARAMETER", "CHANNEL", "FRAME" etc. See RP66 V1 Chapter 5.

Parameters
setTypeType of set to find. Non-null.
Returns
The requested set, or null if not found.
Exceptions
ArgumentNullExceptionIf setType is null.

◆ GetEncryptedRecords()

IList< DlisEncryptedRecord > GetEncryptedRecords ( )

Return the encrypted records of this DLIS file.

Returns
The encrypted records of this DLIS file. Never null.

◆ GetFileId()

string GetFileId ( )

Return the ID of this DLIS file as specified in the ORIGIN set of the file.

Returns
File ID of this DLIS file, or an empty string if not found. Never null.

◆ GetFrames()

IList< DlisFrame > GetFrames ( )

Return the frames of this DLIS file.

Returns
The frames of this DLIS file. Never null.

◆ GetHeader()

DlisFileHeader GetHeader ( )

Return the header of this DLIS file.

Note that the file header is a property of the disk file and not the logical DLIS file instance. It is anyway included in each of the sub file instances for convenience.

Returns
Header of this DLIS file. Never null.

◆ GetName()

string GetName ( )

Return the name of this file.

Typically the name of the back-end disk file, or null if not set.

Returns
Name of this file. Null if not originating from a file.

◆ GetSets()

IList< DlisSet > GetSets ( )

Return the sets of this DLIS file.

The sets contains the meta-data for the logging operation.

Returns
The sets of this DLIS file. Never null.

◆ GetUnit()

string GetUnit ( string objectName,
string attributeName )

Return unit for the specified meta-data attribute of the specified object.

This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.

Parameters
objectNameName of object to return unit from.
attributeNameName of attribute of unit to return.
Returns
Requested unit, or null if the object or attribute doesn't exist, or if unit is not specified.
Exceptions
ArgumentNullExceptionIf objectName or attributeName is null.

◆ GetValue()

DlisType GetValue ( string objectName,
string attributeName )

Return value for the specified attribute of the specified object.

Search all sets. If the object has more than one value for the specified attribute, the first one is returned. Convenient if the caller knowns that there is exactly one value.

This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.

Parameters
objectNameName of object to find value of. Non-null.
attributeNameAttribute to find value of. Non-null.
Returns
Requested value, or null if the object, attribute or value doesn't exist.
Exceptions
ArgumentNullExceptionIf objectName or attributeName is null.

◆ GetValueComponent()

DlisComponent GetValueComponent ( string objectName,
string attributeName )

Return the value component (i.e. the instance holding the values and specifying the unit etc.) for the given attribute of the specified object.

Search all sets.

This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.

Parameters
objectNameName of object to find value component of. Non-null.
attributeNameAttribute to find value component of. Non-null.
Returns
Requested value component, or null if the object, attribute or value doesn't exist.
Exceptions
ArgumentNullExceptionIf objectName or attributeName is null.

◆ GetValues()

IList< DlisType > GetValues ( string objectName,
string attributeName )

Return values for the specified attribute of the specified object.

Search all sets.

This is a convenience method for accessing meta-data across sets directly from the DlisFile instance.

Parameters
objectNameName of object to return value from. Non-null.
attributeNameName of attribute to return. Non-null.
Returns
Requested values, or null if not found.
Exceptions
ArgumentNullExceptionIf objectName or attributeName is null.

◆ HasCurveData()

bool HasCurveData ( )

Return whether the DLIS file instance includes curve data or not, i.e. if only header data was read or created.

Returns
True if bulk (curve) data is present, false otherwise.

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