DlisComponent Class Reference

Model one DLIS EFLR component as described in RP66 V1 Section 3.2 . More...

Public Member Functions
DlisType.IDENT	GetComponentType ()
	Return type of this component.
DlisType.IDENT	GetLabel ()
	Return label of this component.
DlisType.IDENT	GetName ()
	Return name of this component.
DlisType.UVARI	GetNValues ()
	Return number of values of this component.
DlisType.OBNAME	GetObjectName ()
	Return object name of this component.
DlisType.UNITS	GetUnit ()
	Return unit of this component.
DlisType	GetValue ()
	Return the first value of this component.
IList< DlisType >	GetValues ()
	Return the values of this component.
override string	ToString ()

Static Public Member Functions
static DlisComponent	NewAttributeComponent (string name, int representationCode, string unit)
	Create a component that will act as a template attribute for a set.
static DlisComponent	NewObjectComponent (int origin, string objectName)
	Create a component that will act as an object within a set.
static DlisComponent	NewValueComponent (IList< object > values, int representationCode, string unit)
	Create a component that will act as a value for a set object.
static DlisComponent	NewValueComponent (object value, int representationCode, string unit)
	Create a component that will act as a value for a set object.

Detailed Description

Model one DLIS EFLR component as described in RP66 V1 Section 3.2 .

A DlisComponent represents one of:

• set
• object
• attribute

Author

Petroware AS

Member Function Documentation

GetComponentType()

DlisType.IDENT GetComponentType

(

)

Return type of this component.

Returns

Type of this component. Null if not explicitly defined.

GetLabel()

DlisType.IDENT GetLabel

(

)

Return label of this component.

Returns

Label of this component. Null if not explicitly defined.

GetName()

DlisType.IDENT GetName

(

)

Return name of this component.

Returns

Name of this component. Null if not explicitly defined.

GetNValues()

DlisType.UVARI GetNValues

(

)

Return number of values of this component.

Returns

Number of values of this component. [0,>.

GetObjectName()

DlisType.OBNAME GetObjectName

(

)

Return object name of this component.

Returns

Object name of this component. Null if not explicitly defined.

GetUnit()

DlisType.UNITS GetUnit

(

)

Return unit of this component.

Returns

Unit of this component. Null if not explicitly defined.

GetValue()

DlisType GetValue

(

)

Return the first value of this component.

Returns

First value of this component, or null if none.

GetValues()

IList< DlisType > GetValues

(

)

Return the values of this component.

Returns

Values of this component, or null if none defined.

NewAttributeComponent()

static DlisComponent NewAttributeComponent ( string name, int representationCode, string unit )

static

Create a component that will act as a template attribute for a set.

Parameters

name	Attribute name. Non-null.
representationCode	Data type of corresponding object values.
unit	Unit of corresponding data values. Null if N/A.

Returns

The created attribute component. Never null.

Exceptions

ArgumentNullException	If name is null.
ArgumentException	If representation code is invalid.

NewObjectComponent()

static DlisComponent NewObjectComponent ( int origin, string objectName )

static

Create a component that will act as an object within a set.

Parameters

origin	The object origin. [0,>.
objectName	Object name. Non-null.

Returns

The created object component. Never null.

Exceptions

ArgumentNullException	If origin is out of bounds.
ArgumentNullException	If objectName is null.

NewValueComponent() [1/2]

static DlisComponent NewValueComponent ( IList< object > values, int representationCode, string unit )

static

Create a component that will act as a value for a set object.

Parameters

values	The actual values. Non-null.
representationCode	Data type for the values.
unit	Unit for the values. Null if N/A.

Returns

The created component. Never null.

Exceptions

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

NewValueComponent() [2/2]

static DlisComponent NewValueComponent ( object value, int representationCode, string unit )

static

Create a component that will act as a value for a set object.

Convenience method when the actual values is one entry only.

Parameters

value	The actual value. Null to indicate absent.
representationCode	Data type for the value.
unit	Unit for the value. Null if N/A.

Returns

The created component. Never null.

Exceptions

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

---

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

• Petroware/LogIo/Dlis/DlisComponent.cs