DlisFrame Class Reference

Class representing a DLIS file frame in terms of its ID and the curves defined in that frame. More...

Public Types
enum	IndexType {   ANGULAR_DRIFT , BOREHOLE_DEPTH , NON_STANDARD , RADIAL_DRIFT ,   TIME , VERTICAL_DEPTH , UNKNOWN }
	Possible index types for a DLIS file. More...

Public Member Functions
void	AddCurve (DlisCurve curve)
	Add a curve to this frame.
void	ClearCurves ()
	Clear curve data from all curves of this frame.
	DlisFrame (DlisSet frameSet, DlisComponent frameObject)
	Create a new DLIS frame instance.
DlisCurve	FindCurve (string curveName)
	Find curve of the given name.
IList< DlisCurve >	GetCurves ()
	Return the curves of this frame in the order of which the data is organized in the corresponding DLIS file.
DlisCurve	GetIndexCurve ()
	Return the index curve of this frame.
string	GetIndexCurveName ()
	Return name of the index curve.
DlisType	GetIndexStep ()
	Return the index step.
IndexType	GetIndexType ()
	Return index type of this frame.
string	GetIndexUnit ()
	Return the unit of the index curve.
DlisType	GetMaxIndex ()
	Return the maximum index value.
DlisType	GetMinIndex ()
	Return the minimum index value.
string	GetName ()
	Return the name of this frame.
int	GetNCurves ()
	Return the number of curves in this frame.
int	GetNValues ()
	Return the number of values (per curve) in this frame.
bool	IsTimeIndex ()
	Check if this frame is time indexed.
override string	ToString ()

Detailed Description

Class representing a DLIS file frame in terms of its ID and the curves defined in that frame.

A frame is one set of curves with a common index curve. A DlisFile instance may contain multiple frames.

Author

Petroware AS

Member Enumeration Documentation

IndexType

enum IndexType

Possible index types for a DLIS file.

Enumerator
ANGULAR_DRIFT	Angular drift.
BOREHOLE_DEPTH	Borehole depth.
NON_STANDARD	Non-standard.
RADIAL_DRIFT	Radial drift.
TIME	Time.
VERTICAL_DEPTH	Vertical depth.
UNKNOWN	Unknown.

Constructor & Destructor Documentation

DlisFrame()

DlisFrame	(	DlisSet	frameSet,
		DlisComponent	frameObject )

Create a new DLIS frame instance.

Parameters

frameSet	The frame set. Non-null.
frameObject	The frame object component. Non-null.

Exceptions

ArgumentNullException

If frameSet or frameObject is null.

Member Function Documentation

AddCurve()

void AddCurve

(

DlisCurve

curve

)

Add a curve to this frame.

Parameters

curve

Curve to add. Non-null.

Exceptions

ArgumentNullException

If curve is null.

FindCurve()

DlisCurve FindCurve

(

string

curveName

)

Find curve of the given name.

Parameters

curveName

Name of curve to find. Non-null.

Returns

The requested curve, or null if not found.

Exceptions

ArgumentNullException

If curveName is null.

GetCurves()

IList< DlisCurve > GetCurves

(

)

Return the curves of this frame in the order of which the data is organized in the corresponding DLIS file.

The first curve is always the index curve.

Returns

The curves of this frame. Never null.

GetIndexCurve()

DlisCurve GetIndexCurve

(

)

Return the index curve of this frame.

Returns

The index curve of this frame, or null if the frame doesn't contain any curves.

GetIndexCurveName()

string GetIndexCurveName

(

)

Return name of the index curve.

Returns

Name of the index curve. Null if there are no curves.

GetIndexStep()

DlisType GetIndexStep

(

)

Return the index step.

Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range and compute the step. The index step value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.

Experience shows that the value usually is correct when present, but that it is often missing. There is no convention on what this property should contain if the actual step is varying.

Returns

The index step. Null if not specified.

GetIndexType()

IndexType GetIndexType

(

)

Return index type of this frame.

Returns

Index type of this frame. If index type is not specified in the meta data, IndexType.UNKNOWN is returned. Never null.

GetIndexUnit()

string GetIndexUnit

(

)

Return the unit of the index curve.

Returns

Unit of the index curve. Null if not specified.

GetMaxIndex()

DlisType GetMaxIndex

(

)

Return the maximum index value.

Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range. The index max value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.

Experience shows that the value usually is correct when present, but that it is often missing.

Returns

The maximum index value. Null if not specified.

GetMinIndex()

DlisType GetMinIndex

(

)

Return the minimum index value.

Note that this is an optional (but convenient) property of the frame set. If it is not given, the client must read the data to extract the index range. The index min value from the frame set can anyway not necessarily be trusted, as the producer of the DLIS are free to enter whatever value it wishes.

Experience shows that the value usually is correct when present, but that it is often missing.

Returns

The minimum index value. Null if not specified.

GetName()

string GetName

(

)

Return the name of this frame.

Returns

Name of this frame. Never null.

GetNCurves()

int GetNCurves

(

)

Return the number of curves in this frame.

Returns

Number of curves in this frame. [0,>.

GetNValues()

int GetNValues

(

)

Return the number of values (per curve) in this frame.

Returns

Number of values in this frame. [0,>.

IsTimeIndex()

bool IsTimeIndex

(

)

Check if this frame is time indexed.

Returns

True if this frame is time indexed, false otherwise.

---

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

• Petroware/LogIo/Dlis/DlisFrame.cs