BitGeneralHeadingRecord Class Reference

Model the general heading record of a logical BIT file. More...

Public Member Functions
	BitGeneralHeadingRecord (double referenceNumber, string companyName, string wellName, DateTime time, IList< string > curveNames, double startDepth, double endDepth, double step, string serviceNumber, string fileNumber)
	Create a BIT general heading record.
string	GetAcousticUnit ()
	Return unit for acoustic measurements.
string	GetCaliperUnit ()
	Return unit for caliper measurements.
string	GetCompanyName ()
	Return name of the company for which the log was run.
string	GetDepthUnit ()
	Return unit for depth measurements.
double	GetEndDepth ()
	Return the ending depth of the last sample in the file.
string	GetFileNumber ()
	Return file number of the file.
int	GetNCurves ()
	Return number of curves in the associated BIT file.
string	GetPressureUnit ()
	Return unit for pressure measurements.
double	GetReferenceNumber ()
	Return the well reference number.
string	GetServiceNumber ()
	Return service number of the logging operation.
int	GetSetNumber ()
	Return set number of the log.
double	GetStartDepth ()
	Return the starting depth of the first data sample.
double	GetStep ()
	Return spacing between sample points in the file.
string	GetTemperatureUnit ()
	Return unit for temperature measurements.
string	GetTensionUnit ()
	Return unit for tension measurements.
DateTime	GetTime ()
	Return the time that the recording began.
string	GetVolumeUnit ()
	Return unit for volume measurements.
string	GetWellName ()
	Return well name and number (as per customer).
bool	IsAcoustilogSignature ()
	Check if acoustilog signature has been used.
bool	IsBoreholeTeleviewerUsed ()
	Check if borehole televiewer has been used.
bool	IsCarbonOxygenSpectrum ()
	Check if carbon/oxygen spectrum has been used.
bool	IsCementBondLogSignature ()
	Check if cement bond log signature has been used.
bool	IsDnllOrPdk100 ()
	Check if this is a DNLL or PDK-100 well.
bool	IsFlowingWell ()
	Check if this is a flowing well.
bool	IsInjectionWell ()
	Check if this is an injection well.
bool	IsPressureSurvey ()
	Check if this is a pressure survey.
bool	IsProductionWell ()
	Check if this is a production well.
bool	IsShutInWell ()
	Check if this is a shut-in well.
bool	IsSonanSpectrum ()
	Check if sonan spectrum has been used.
bool	IsSpectralogSpectrum ()
	Check if spectral spectrum has been used.
bool	IsZDensitySpectrum ()
	Check if Z-density spectrum has been used.
void	SetDepthUnit (string depthUnit)
	Specify the depth unit of the BIT file.
override string	ToString ()

Detailed Description

Model the general heading record of a logical BIT file.

This class is thread-safe.

Author

Petroware AS

Constructor & Destructor Documentation

BitGeneralHeadingRecord()

BitGeneralHeadingRecord	(	double	referenceNumber,
		string	companyName,
		string	wellName,
		DateTime	time,
		IList< string >	curveNames,
		double	startDepth,
		double	endDepth,
		double	step,
		string	serviceNumber,
		string	fileNumber )

Create a BIT general heading record.

Parameters

referenceNumber	File reference number.
companyName	Company name. Non-null.
wellName	Well name. Non-null.
time	Logging start time. Non-null.
curveNames	Curve names. Not including index curve. Non-null.
startDepth	Start depth.
endDepth	End depth.
step	Step between samples.
serviceNumber	Service number. Non-null.
fileNumber	File number. Non-null.

Exceptions

ArgumentNullException

If companyName, wellName, time, curveNames, serviceNumber or fileNumber is null.

Member Function Documentation

GetAcousticUnit()

string GetAcousticUnit

(

)

Return unit for acoustic measurements.

Energistics unit notation is being used.

Returns

Unit for acoustic measurements. Never null.

GetCaliperUnit()

string GetCaliperUnit

(

)

Return unit for caliper measurements.

Energistics unit notation is being used.

Returns

Unit for caliper measurements. Never null.

GetCompanyName()

string GetCompanyName

(

)

Return name of the company for which the log was run.

Returns

Name of the company for which the log was run. Never null.

GetDepthUnit()

string GetDepthUnit

(

)

Return unit for depth measurements.

Energistics unit notation is being used.

Returns

Unit for depth measurements. Never null.

GetEndDepth()

double GetEndDepth

(

)

Return the ending depth of the last sample in the file.

0 or 99999 if unknown.

Returns

The ending depth of the last sample in the file.

GetFileNumber()

string GetFileNumber

(

)

Return file number of the file.

The file number is simply a name used to identify the file. The file number does not necessarily correspond to the physical position of the file on tape.

In general this field will contain a string representation of an integer number. However, several special values may be placed here to identify the file as being a special information file, rather than a well log data file. These special values will have the character H as the first character like H1, H2 or H3.

Returns

File number of the file.

GetNCurves()

int GetNCurves

(

)

Return number of curves in the associated BIT file.

The number does not include the implicit index curve.

Returns

Number of curves in the BIT file. [0,>.

GetPressureUnit()

string GetPressureUnit

(

)

Return unit for pressure measurements.

Energistics unit notation is being used.

Returns

Unit for pressure measurements. Never null.

GetReferenceNumber()

double GetReferenceNumber

(

)

Return the well reference number.

Returns

Well reference number.

GetServiceNumber()

string GetServiceNumber

(

)

Return service number of the logging operation.

The service number is six characters long. Going from left to right, the first two characters represent an area code, the next three characters define the service under consideration, and the last character indicates the local log presentation or instrument string for which the service table was designed.

Returns

Service number of the logging operation. Never null.

GetSetNumber()

int GetSetNumber

(

)

Return set number of the log.

This field is used as a file identifier by the FSYSFT field system (Formation Multitester) as the variable SETNO; [1,200].

Returns

Set number of the log.

GetStartDepth()

double GetStartDepth

(

)

Return the starting depth of the first data sample.

Returns

The starting depth of the first data sample.

GetStep()

double GetStep

(

)

Return spacing between sample points in the file.

Returns

Spacing between sample points in the file.

GetTemperatureUnit()

string GetTemperatureUnit

(

)

Return unit for temperature measurements.

Energistics unit notation is being used.

Returns

Unit for temperature measurements. Never null.

GetTensionUnit()

string GetTensionUnit

(

)

Return unit for tension measurements.

Energistics unit notation is being used.

Returns

Unit for tension measurements. Never null.

GetTime()

DateTime GetTime

(

)

Return the time that the recording began.

Returns

The time recording began. Never null.

GetVolumeUnit()

string GetVolumeUnit

(

)

Return unit for volume measurements.

Energistics unit notation is being used.

Returns

Unit for volume measurements. Never null.

GetWellName()

string GetWellName

(

)

Return well name and number (as per customer).

Returns

Well name of log. Never null.

IsAcoustilogSignature()

bool IsAcoustilogSignature

(

)

Check if acoustilog signature has been used.

Returns

True if acoustilog signature has been used. False otherwise or if N/A or unknown.

IsBoreholeTeleviewerUsed()

bool IsBoreholeTeleviewerUsed

(

)

Check if borehole televiewer has been used.

Returns

True if borehole televiewer has been used. False otherwise or if N/A or unknown.

IsCarbonOxygenSpectrum()

bool IsCarbonOxygenSpectrum

(

)

Check if carbon/oxygen spectrum has been used.

Returns

True if spectral carbon/oxygen has been used. False otherwise or if N/A or unknown.

IsCementBondLogSignature()

bool IsCementBondLogSignature

(

)

Check if cement bond log signature has been used.

Returns

True if cement bond log signature has been used. False otherwise or if N/A or unknown.

IsDnllOrPdk100()

bool IsDnllOrPdk100

(

)

Check if this is a DNLL or PDK-100 well.

Returns

True if this is a DNLL or PDK-100 well. False otherwise or if N/A or unknown.

IsFlowingWell()

bool IsFlowingWell

(

)

Check if this is a flowing well.

Returns

True if this is a flowing well. False otherwise or if N/A or unknown.

IsInjectionWell()

bool IsInjectionWell

(

)

Check if this is an injection well.

Returns

True if this is an injection well. False otherwise or if N/A or unknown.

IsPressureSurvey()

bool IsPressureSurvey

(

)

Check if this is a pressure survey.

Returns

True if this is a pressure survey. False otherwise or if N/A or unknown.

IsProductionWell()

bool IsProductionWell

(

)

Check if this is a production well.

Returns

True if this is a production well. False otherwise or if N/A or unknown.

IsShutInWell()

bool IsShutInWell

(

)

Check if this is a shut-in well.

Returns

True if this is a shut-in well. False otherwise or if N/A or unknown.

IsSonanSpectrum()

bool IsSonanSpectrum

(

)

Check if sonan spectrum has been used.

Returns

True if sonan spectrum has been used. False otherwise or if N/A or unknown.

IsSpectralogSpectrum()

bool IsSpectralogSpectrum

(

)

Check if spectral spectrum has been used.

Returns

True if spectral spectrum has been used. False otherwise or if N/A or unknown.

IsZDensitySpectrum()

bool IsZDensitySpectrum

(

)

Check if Z-density spectrum has been used.

Returns

True if Z-density spectrum has been used. False otherwise or if N/A or unknown.

SetDepthUnit()

void SetDepthUnit

(

string

depthUnit

)

Specify the depth unit of the BIT file.

Parameters

depthUnit

Depth unit to specify. Only "dm", "m" and "ft" are recognized. Specifying other units will set the depth unit to default ("m"). May be null to indicate default.

---

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

• Petroware/LogIo/Bit/BitGeneralHeadingRecord.cs