resqml2::EarthModelInterpretation Class Reference

This class is a container for stratigraphic, structural and rock fluid organization interpretations that are consistent to each others. More...

#include <EarthModelInterpretation.h>

Inheritance diagram for resqml2::EarthModelInterpretation:

Public Member Functions
virtual	~EarthModelInterpretation ()=default
virtual unsigned int	getStructuralOrganizationInterpretationCount () const =0
virtual common::DataObjectReference	getStructuralOrganizationInterpertationDor (unsigned int index) const =0
StructuralOrganizationInterpretation *	getStructuralOrganizationInterpertation (unsigned int index) const
virtual void	pushBackStructuralOrganizationInterpretation (StructuralOrganizationInterpretation *structOrganization)=0
virtual bool	hasStratiColumn () const =0
virtual void	setStratiColumn (StratigraphicColumn *stratiColumn)=0
virtual common::DataObjectReference	getStratiColumnDor () const =0
StratigraphicColumn *	getStratiColumn () const
virtual unsigned int	getStratiOccurrenceCount () const =0
	Gets the count of stratigraphic occurrence interpretations associated to this earth model interpretation.
virtual common::DataObjectReference	getStratiOccurrenceDor (unsigned int index) const =0
StratigraphicOccurrenceInterpretation *	getStratiOccurrence (unsigned int index) const
virtual void	pushBackStratiOccurrence (StratigraphicOccurrenceInterpretation *stratiOccurence)=0
	Pushes back a stratigraphic occurrence interpretation.
virtual unsigned int	getRockFluidOrganizationInterpretationCount () const =0
virtual void	pushBackRockFluidOrganizationInterpretation (RockFluidOrganizationInterpretation *rockFluid)=0
virtual common::DataObjectReference	getRockFluidOrganizationInterpretationDor (unsigned int index) const =0
RockFluidOrganizationInterpretation *	getRockFluidOrganizationInterpretation (unsigned int index) const
virtual std::string	getXmlTag () const override
Public Member Functions inherited from resqml2::AbstractFeatureInterpretation
virtual	~AbstractFeatureInterpretation ()=default
common::DataObjectReference	getInterpretedFeatureDor () const
void	setInterpretedFeature (AbstractFeature *feature)
AbstractFeature *	getInterpretedFeature () const
gsoap_resqml2_0_1::resqml20__Domain	initDomain (gsoap_resqml2_0_1::resqml20__Domain defaultDomain) const
gsoap_resqml2_0_1::resqml20__Domain	getDomain () const
std::vector< AbstractRepresentation * >	getRepresentationSet () const
uint64_t	getRepresentationCount () const noexcept
AbstractRepresentation *	getRepresentation (uint64_t index) const
std::vector< GridConnectionSetRepresentation * >	getGridConnectionSetRepresentationSet () const

Static Public Attributes
static const char *	XML_TAG

Detailed Description

This class is a container for stratigraphic, structural and rock fluid organization interpretations that are consistent to each others.

BUSINESS RULE: An earth model Interpretation interprets only an earth model feature.

Constructor & Destructor Documentation

~EarthModelInterpretation()

virtual resqml2::EarthModelInterpretation::~EarthModelInterpretation ( )

virtualdefault

Destructor does nothing since the memory is managed by the gSOAP context.

Member Function Documentation

getRockFluidOrganizationInterpretation()

RockFluidOrganizationInterpretation * resqml2::EarthModelInterpretation::getRockFluidOrganizationInterpretation

(

unsigned int

index

)

const

Gets a given associated rock fluid organization interpretation.

Exceptions

std::out_of_range

If index >= getRockFluidOrganizationInterpretationCount().

Parameters

index

Zero-based index of the associated rock fluid organization interpretation we look for.

Returns

The rock fluid organization interpretation at position index.

getRockFluidOrganizationInterpretationCount()

virtual unsigned int resqml2::EarthModelInterpretation::getRockFluidOrganizationInterpretationCount ( ) const

pure virtual

Gets the count of rock fluid organization interpretations associated to this earth model interpretation.

Returns

The count of associated rock fluid organization interpretations.

getRockFluidOrganizationInterpretationDor()

virtual common::DataObjectReference resqml2::EarthModelInterpretation::getRockFluidOrganizationInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given associated rock fluid organization interpretation.

Exceptions

std::out_of_range

If index >= getRockFluidOrganizationInterpretationCount().

Parameters

index

Zero-based index of the associated rock fluid organization interpretation we look for the DOR.

Returns

The DOR of the rock fluid organization interpretation at position index.

getStratiColumn()

StratigraphicColumn * resqml2::EarthModelInterpretation::getStratiColumn

(

)

const

Gets the stratigraphic column associated to this earth model interpretation.

Returns

The stratigraphic column associated to this earth model interpretation if it exists, else nullptr.

getStratiColumnDor()

virtual common::DataObjectReference resqml2::EarthModelInterpretation::getStratiColumnDor ( ) const

pure virtual

Gets the DOR of the stratigraphic column associated to this earth model interpretation.

Returns

The DOR of the stratigraphic column associated to this earth model interpretation if it exists, else empty DOR.

getStratiOccurrence()

StratigraphicOccurrenceInterpretation * resqml2::EarthModelInterpretation::getStratiOccurrence

(

unsigned int

index

)

const

Gets a given associated stratigraphic occurrence interpretation.

Exceptions

std::out_of_range

If index >= getStratiOccurrenceCount().

Parameters

index

Zero-based index of the associated stratigraphic occurrence interpretation we look for.

Returns

The stratigraphic occurrence interpretation at position index.

getStratiOccurrenceCount()

virtual unsigned int resqml2::EarthModelInterpretation::getStratiOccurrenceCount ( ) const

pure virtual

Gets the count of stratigraphic occurrence interpretations associated to this earth model interpretation.

Exceptions

std::range_error

If the count of stratigraphic occurrence interpretations is strictly greater than unsigned int max.

Returns

The count of associated stratigraphic occurrence interpretations.

getStratiOccurrenceDor()

virtual common::DataObjectReference resqml2::EarthModelInterpretation::getStratiOccurrenceDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given associated stratigraphic occurrence interpretation.

Exceptions

std::out_of_range

If index >= getStratiOccurrenceCount().

Parameters

index

Zero-based index of the associated stratigraphic occurrence interpretation we look for the DOR.

Returns

The DOR of the stratigraphic occurrence interpretation at position index.

getStructuralOrganizationInterpertation()

StructuralOrganizationInterpretation * resqml2::EarthModelInterpretation::getStructuralOrganizationInterpertation

(

unsigned int

index

)

const

Gets a given associated structural organization interpretation.

Exceptions

std::out_of_range

If index >= getStructuralOrganizationInterpretationCount().

Parameters

index

Zero-based index of the associated structural organization interpretation we look for.

Returns

The structural organization interpretation at position index.

getStructuralOrganizationInterpertationDor()

virtual common::DataObjectReference resqml2::EarthModelInterpretation::getStructuralOrganizationInterpertationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given associated structural organization interpretation.

Exceptions

std::out_of_range

If index >= getStructuralOrganizationInterpretationCount().

Parameters

index

Zero-based index of the associated structural organization interpretation we look for the DOR.

Returns

The DOR of the structural organization interpretation at position index.

getStructuralOrganizationInterpretationCount()

virtual unsigned int resqml2::EarthModelInterpretation::getStructuralOrganizationInterpretationCount ( ) const

pure virtual

Gets the count of structural organization interpretations associated to this earth model interpretation.

Returns

The count of associated structural organization interpretations.

hasStratiColumn()

virtual bool resqml2::EarthModelInterpretation::hasStratiColumn ( ) const

pure virtual

Checks if a strati column is associated to this earth model interpretation

Returns

True if a strati column is associated to this earth model interpretation else false.

pushBackRockFluidOrganizationInterpretation()

virtual void resqml2::EarthModelInterpretation::pushBackRockFluidOrganizationInterpretation ( RockFluidOrganizationInterpretation * rockFluid )

pure virtual

Pushes back a rock fluid organization interpretation.

Exceptions

std::invalid_argument

If rockFluid == nullptr.

Parameters

[in]

rockFluid

The rock fluid organization interpretation to push back.

pushBackStratiOccurrence()

virtual void resqml2::EarthModelInterpretation::pushBackStratiOccurrence ( StratigraphicOccurrenceInterpretation * stratiOccurence )

pure virtual

Pushes back a stratigraphic occurrence interpretation.

Exceptions

std::invalid_argument

If stratiOccurrence == nullptr.

Parameters

[in]

stratiOccurence

The stratigraphic occurrence interpretation to push back.

pushBackStructuralOrganizationInterpretation()

virtual void resqml2::EarthModelInterpretation::pushBackStructuralOrganizationInterpretation ( StructuralOrganizationInterpretation * structOrganization )

pure virtual

Pushes back a structural organization interpretation.

Exceptions

std::invalid_argument

If structOrganization == nullptr.

Parameters

[in]

structOrganization

The structural organization interpretation to push back.

setStratiColumn()

virtual void resqml2::EarthModelInterpretation::setStratiColumn ( StratigraphicColumn * stratiColumn )

pure virtual

Sets the stratigraphic column.

Exceptions

std::invalid_argument

If stratiColumn == nullptr.

Parameters

[in]

stratiColumn

The stratigraphic column to set.

Member Data Documentation

XML_TAG

const char* resqml2::EarthModelInterpretation::XML_TAG

static

The standard XML tag without XML namespace for serializing this data object.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2/EarthModelInterpretation.h