LisDataFormatSpecificationRecord.Entry Class Reference

Defines one entry, i.e. More...

Public Types
enum	EntryType {   TERMINATOR , DATA_RECORD_TYPE , DATUM_SPEC_BLOCK_TYPE , DATA_FRAME_SIZE ,   UP_DOWN_FLAG , OPTICAL_LOG_DEPTH_SCALE_UNITS , DATA_REFERENCE_POINT , UNITS_OF_DATA_REFERENCE_POINT ,   FRAME_SPACING , UNITS_OF_FRAME_SPACING , UNDEFINED , MAXIMUM_FRAMES_PER_RECORD ,   ABSENT_VALUE , DEPTH_RECORDING_MODE , UNITS_OF_DEPTH , REPRESENTATION_CODE_FOR_OUTPUT_DEPTH ,   DATUM_SPEC_BLOCK_SUB_TYPE }
	Entry type.

Public Member Functions
	Entry (EntryType entryType, double value)
	Create a new entry with the specified double value.
	Entry (EntryType entryType, int dataSize, int representationCode, List< object > values)
	Create a new entry.
	Entry (EntryType entryType, int value)
	Create a new entry with the specified integer value.
	Entry (EntryType entryType, object value)
	Create a new entry with the specified value.
	Entry (EntryType entryType, string value)
	Create a new entry with the specified string value.
int	GetDataSize ()
	Return size (in bytes) of this entry.
EntryType	GetEntryType ()
	Return entry type.
int	GetRepresentationCode ()
	Return presentation code of this entry.
int	GetSize ()
	Return total size (in bytes) of the datum as it appears on disk.
object	GetValue ()
	Return the first value of this entry.
IList< object >	GetValues ()
	Return the values of this entry.
override string	ToString ()

Static Public Member Functions
static ? EntryType	GetEntryType (int tag)
	Return associated entry type for the specified tag.
static int	GetId (EntryType entryType)
	Return associated ID for the given entry type.

Detailed Description

Defines one entry, i.e.

one specific meta-attribute about the LIS file.

Author

Petroware AS

Constructor & Destructor Documentation

Entry() [1/5]

Entry	(	EntryType	entryType,
		int	dataSize,
		int	representationCode,
		List< object >	values )

Create a new entry.

Parameters

entryType	Entry type.
dataSize	Data size. <0,>.
representationCode	Data type.
values	Entry values. Non-null.

Exceptions

ArgumentException	If dataSize <=0 or representationCode is invalid.
ArgumentNullException	If values is null.

Entry() [2/5]

Entry	(	EntryType	entryType,
		object	value )

Create a new entry with the specified value.

Parameters

entryType	Entry type.
value	Entry value.

Exceptions

ArgumentNullException

If value is null.

Entry() [3/5]

Entry	(	EntryType	entryType,
		double	value )

Create a new entry with the specified double value.

Parameters

entryType	Entry type.
value	Entry value.

Entry() [4/5]

Entry	(	EntryType	entryType,
		int	value )

Create a new entry with the specified integer value.

Parameters

entryType	Entry type.
value	Entry value.

Entry() [5/5]

Entry	(	EntryType	entryType,
		string	value )

Create a new entry with the specified string value.

Parameters

entryType	Entry type.
value	Entry value.

Member Function Documentation

GetDataSize()

int GetDataSize

(

)

Return size (in bytes) of this entry.

Returns

Size (in bytes) of this entry. <0,>.

GetEntryType() [1/2]

EntryType GetEntryType

(

)

Return entry type.

Returns

Entry type.

GetEntryType() [2/2]

static ? EntryType GetEntryType ( int tag )

static

Return associated entry type for the specified tag.

Parameters

tag	Entry type tag.

Returns

Requested entry type or null if tag is invalid.

GetId()

static int GetId ( EntryType entryType )

static

Return associated ID for the given entry type.

Parameters

entryType

Entry type to get ID of. Non-null.

Returns

Requested ID.

GetRepresentationCode()

int GetRepresentationCode

(

)

Return presentation code of this entry.

Returns

Representation code of this entry.

GetSize()

int GetSize

(

)

Return total size (in bytes) of the datum as it appears on disk.

Returns

Total size of entry.

GetValue()

object GetValue

(

)

Return the first value of this entry.

Convenient if the client knows that there are only one value in the entry.

Returns

The first value of this entry. Null if there are no values.

GetValues()

IList< object > GetValues

(

)

Return the values of this entry.

Returns

The values of this entry. Never null.

---

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

• Petroware/LogIo/Lis/LisDataFormatSpecificationRecord.cs