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. More...

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. More...

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

unsigned int	getRepresentationCount () const

std::vector< GridConnectionSetRepresentation * >	getGridConnectionSetRepresentationSet () const

AbstractRepresentation *	getRepresentation (unsigned int index) const

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

void	setMetadata (const std::string &title, const std::string &editor, time_t creation, const std::string &originator, const std::string &description, time_t lastUpdate, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () const =0

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Static Public Attributes
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

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.

Reimplemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_0_1::EarthModelInterpretation, and resqml2_2::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ getXmlTag()

virtual std::string resqml2::EarthModelInterpretation::getXmlTag ( ) const

inlineoverridevirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

◆ 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.

Implemented in resqml2_2::EarthModelInterpretation, and resqml2_0_1::EarthModelInterpretation.

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.0.0.0/src/resqml2/EarthModelInterpretation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~EarthModelInterpretation()

Member Function Documentation

◆ getRockFluidOrganizationInterpretation()

◆ getRockFluidOrganizationInterpretationCount()

◆ getRockFluidOrganizationInterpretationDor()

◆ getStratiColumn()

◆ getStratiColumnDor()

◆ getStratiOccurrence()

◆ getStratiOccurrenceCount()

◆ getStratiOccurrenceDor()

◆ getStructuralOrganizationInterpertation()

◆ getStructuralOrganizationInterpertationDor()

◆ getStructuralOrganizationInterpretationCount()

◆ getXmlTag()

◆ hasStratiColumn()

◆ pushBackRockFluidOrganizationInterpretation()

◆ pushBackStratiOccurrence()

◆ pushBackStructuralOrganizationInterpretation()

◆ setStratiColumn()

Member Data Documentation

◆ XML_TAG