LisFile Class Reference

Class representing the content of a LIS (sub-) file. More...

Public Member Functions
void	AddRecord (LisRecord record)
	Add the specified record to this LIS file.
void	ClearCurves ()
	Clear curve data from all curves of this LIS file.
LisRecord	FindRecord (int recordType)
	Find a record of the specified type.
IList< LisRecord >	FindRecords (int recordType)
	Find all records of the specified type.
IList< LisCurve >	GetCurves ()
	Return the curves of this LIS file instance.
LisCurve	GetIndexCurve ()
	Return the index curve of this LIS file.
string	GetName ()
	Return name of this LIS file.
int	GetNCurves ()
	Return number of curves in this LIS file.
IList< LisRecord >	GetRecords ()
	Return the (non-data) records of this LIS file.
int	GetSubSample ()
	Find the smallest possible sub sample number for the curves of this LIS file.
bool	HasCurveData ()
	Check if this LIS file instance contains bulk data.
	LisFile ()
	Create an empty LIS file instance.
override string	ToString ()

Detailed Description

Class representing the content of a LIS (sub-) file.

Author

Petroware AS

Member Function Documentation

AddRecord()

void AddRecord

(

LisRecord

record

)

Add the specified record to this LIS file.

Called by the reader, or by a client program that builds a LIS file instance that later should be written to disk.

Parameters

record

Record to add. Non-null.

Exceptions

ArgumentNullException

If record is null.

FindRecord()

LisRecord FindRecord

(

int

recordType

)

Find a record of the specified type.

Parameters

recordType

Type of record to find.

Returns

The (first) requested record. Null if none.

FindRecords()

IList< LisRecord > FindRecords

(

int

recordType

)

Find all records of the specified type.

Parameters

recordType

Type of records to find.

Returns

The requested records. Never null.

GetCurves()

IList< LisCurve > GetCurves

(

)

Return the curves of this LIS file instance.

The first curve is by convention always the index curve.

Returns

The curves of this LIS file instance. Never null.

GetIndexCurve()

LisCurve GetIndexCurve

(

)

Return the index curve of this LIS file.

Returns

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

GetName()

string GetName

(

)

Return name of this LIS file.

Returns

Name of this LIS file. Never null.

GetNCurves()

int GetNCurves

(

)

Return number of curves in this LIS file.

Returns

Number of curves in this LIS file. [0,>.

GetRecords()

IList< LisRecord > GetRecords

(

)

Return the (non-data) records of this LIS file.

Returns

The (non-data) records of this LIS file. Never null.

GetSubSample()

int GetSubSample

(

)

Find the smallest possible sub sample number for the curves of this LIS file.

Returns

Smallest sub sample number. [1,>.

HasCurveData()

bool HasCurveData

(

)

Check if this LIS file instance contains bulk data.

Returns

True if the instance contains curve data. False otherwise.

---

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

• Petroware/LogIo/Lis/LisFile.cs