LisDataFormatSpecificationRecord.Datum Class Reference

Identify a datum, i.e. the definition of one specific curve within the LIS file. More...

Public Member Functions
	Datum (string mnemonic, string serviceId, string serviceOrderNo, string unit, int apiCodes, int fileNumber, int dataSize, int nSamples, int representationCode, int[] processIndicators)
	Create a type 1 datum.
	Datum (string mnemonic, string serviceId, string serviceOrderNo, string unit, int apiLogType, int apiCurveType, int apiCurveClass, int apiModifier, int fileNumber, int dataSize, int processLevel, int nSamples, int representationCode)
	Create a type 0 datum.
	Datum (string mnemonic, string unit, int nDimensions, int representationCode)
	Create a type 1 datum with default settings for N/A properties.
	Datum (string mnemonic, string unit, int nDimensions, int representationCode, int size)
	Create a type 1 datum with default settings for N/A properties.
int	GetApiCodes ()
	Return API codes of this datum.
int	GetApiCurveClass ()
	Return API curve class of this datum.
int	GetApiCurveType ()
	Return API curve type of this datum.
int	GetApiLogType ()
	Return API log type of this datum.
int	GetApiModifier ()
	Return API modifier of this datum.
int	GetDataSize ()
	Return size set a side for values of this curve per frame.
int	GetDatumType ()
	Return type of this datum.
int	GetFileNumber ()
	Return file number of this datum.
string	GetMnemonic ()
	Return mnemonic (i.e.
int	GetNSamples ()
	Return number of samples per depth of this datum.
int[]	GetProcessIndicators ()
	Get process indicators of this datum.
int	GetProcessLevel ()
	Return process level of this datum.
int	GetRepresentationCode ()
	Return data type for the values of this datum.
string	GetServiceId ()
	Return service ID of this datum.
string	GetServiceOrderNo ()
	Return service order number of this datum.
string	GetUnit ()
	Return unit of this datum.
override string	ToString ()

Detailed Description

Identify a datum, i.e. the definition of one specific curve within the LIS file.

Author

Petroware AS

Constructor & Destructor Documentation

Datum() [1/4]

Datum	(	string	mnemonic,
		string	serviceId,
		string	serviceOrderNo,
		string	unit,
		int	apiLogType,
		int	apiCurveType,
		int	apiCurveClass,
		int	apiModifier,
		int	fileNumber,
		int	dataSize,
		int	processLevel,
		int	nSamples,
		int	representationCode )

Create a type 0 datum.

Parameters

mnemonic	Curve mnemonic. Non-null.
serviceId	Service ID. Null if N/A.
serviceOrderNo	Service order no. Null if N/A.
unit	Curve unit. Null if N/A.
apiLogType	API log type. -1 if N/A.
apiCurveType	API curve type. -1 if N/A.
apiCurveClass	API curve class. -1 if N/A.
apiModifier	API modifier. -1 if N/A.
fileNumber	File number. -1 if N/A.
dataSize	Data size in bytes per depth. <0,>.
processLevel	Process level. -1 if N/A.
nSamples	Number of samples per depth. [1,>.
representationCode	Data type specification.

Exceptions

ArgumentNullException	If mnemonic is null.
ArgumentException	If type is invalid.
ArgumentException	If dataSize <= 0.
ArgumentException	If nSamples <= 0.
ArgumentException	If representationCode is invalid.

Datum() [2/4]

Datum	(	string	mnemonic,
		string	serviceId,
		string	serviceOrderNo,
		string	unit,
		int	apiCodes,
		int	fileNumber,
		int	dataSize,
		int	nSamples,
		int	representationCode,
		int[]	processIndicators )

Create a type 1 datum.

Parameters

mnemonic	Curve mnemonic. Non-null.
serviceId	Service ID. Null if N/A.
serviceOrderNo	Service order no. Null if N/A.
unit	Curve unit. Null if N/A.
apiCodes	API codes. -1 if N/A.
fileNumber	File number. -1 if N/A.
dataSize	Data size in bytes per depth. <0,>.
nSamples	Number of samples per depth. [1,>.
representationCode	Data type specification.
processIndicators	Array of five. Null if N/A.

Exceptions

ArgumentNullException	If mnemonic is null.
ArgumentException	If type is invalid.
ArgumentException	If dataSize <= 0.
ArgumentException	If nSamples <= 0.
ArgumentException	If representationCode is invalid.

Datum() [3/4]

Datum	(	string	mnemonic,
		string	unit,
		int	nDimensions,
		int	representationCode )

Create a type 1 datum with default settings for N/A properties.

Parameters

mnemonic	Curve mnemonic. Non-null.
unit	Curve unit. Null if N/A.
nDimensions	Number of dimensions in curve. [1,>.
representationCode	Data type specification.

Exceptions

ArgumentNullException	If mnemonic is null.
ArgumentException	If representationCode is invalid.

Datum() [4/4]

Datum	(	string	mnemonic,
		string	unit,
		int	nDimensions,
		int	representationCode,
		int	size )

Create a type 1 datum with default settings for N/A properties.

Have explicit setting for size needed if the datum represents ASCII text. In this case the size arguments specifies the longest possible text string of the curve.Create a datum.

Parameters

mnemonic	Curve mnemonic. Non-null.
unit	Curve unit. Null if N/A.
nDimensions	Number of dimensions in curve. [1,>.
representationCode	Data type specification.
size	Data size. <0,>.

Exceptions

ArgumentNullException	If mnemonic is null.
ArgumentException	if nDimensions <= 0.
ArgumentException	If dataSize <= 0.
ArgumentException	If representationCode is invalid.

Member Function Documentation

GetApiCodes()

int GetApiCodes

(

)

Return API codes of this datum.

Returns

API codes of this datum. -1 if N/A.

GetApiCurveClass()

int GetApiCurveClass

(

)

Return API curve class of this datum.

Returns

API curve class of this datum. -1 if N/A.

GetApiCurveType()

int GetApiCurveType

(

)

Return API curve type of this datum.

Returns

API curve type of this datum. -1 if N/A.

GetApiLogType()

int GetApiLogType

(

)

Return API log type of this datum.

Returns

API log type of this datum. -1 if N/A.

GetApiModifier()

int GetApiModifier

(

)

Return API modifier of this datum.

Returns

API modifier of this datum. -1 if N/A.

GetDataSize()

int GetDataSize

(

)

Return size set a side for values of this curve per frame.

Returns

Data size. [0,>.

GetDatumType()

int GetDatumType

(

)

Return type of this datum.

Returns

Type of this datum. 0 or 1.

GetFileNumber()

int GetFileNumber

(

)

Return file number of this datum.

Returns

File number of this datum. -1 if N/A.

GetMnemonic()

string GetMnemonic

(

)

Return mnemonic (i.e.

curve name) of this datum.

Returns

Mnemonic of this datum. Never null.

GetNSamples()

int GetNSamples

(

)

Return number of samples per depth of this datum.

Returns

Number of samples per depth. [1,>.

GetProcessIndicators()

int[] GetProcessIndicators

(

)

Get process indicators of this datum.

Returns

Process indicators of this datum. Array of five, or null if N/A.

GetProcessLevel()

int GetProcessLevel

(

)

Return process level of this datum.

Returns

Process level of this datum. -1 if N/A.

GetRepresentationCode()

int GetRepresentationCode

(

)

Return data type for the values of this datum.

Returns

Data type for the values of this datum.

GetServiceId()

string GetServiceId

(

)

Return service ID of this datum.

Returns

Service ID of this datum. Null if N/A.

GetServiceOrderNo()

string GetServiceOrderNo

(

)

Return service order number of this datum.

Returns

Service order number of this datum. Null if N/A.

GetUnit()

string GetUnit

(

)

Return unit of this datum.

Returns

Unit of this datum. Null if unitless or unknown.

---

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

• Petroware/LogIo/Lis/LisDataFormatSpecificationRecord.cs