One of the main types of RESQML organizations, this class gathers boundary interpretations (e.g., horizons and faults) plus frontier features and their relationships (contacts interpretations), which when taken together define the structure of a part of the earth. More...

#include <StructuralOrganizationInterpretation.h>

Inheritance diagram for resqml2::StructuralOrganizationInterpretation:

Public Member Functions
virtual	~StructuralOrganizationInterpretation ()=default

virtual void	pushBackFaultInterpretation (FaultInterpretation *faultInterpretation)=0

virtual unsigned int	getFaultInterpretationCount () const =0

virtual common::DataObjectReference	getFaultInterpretationDor (unsigned int index) const =0

FaultInterpretation *	getFaultInterpretation (unsigned int index) const

virtual void	pushBackHorizonInterpretation (HorizonInterpretation *horizonInterpretation, int stratigraphicRank)=0

virtual unsigned int	getHorizonInterpretationCount () const =0

virtual common::DataObjectReference	getHorizonInterpretationDor (unsigned int index) const =0

HorizonInterpretation *	getHorizonInterpretation (unsigned int index) const

virtual void	pushBackTopFrontierInterpretation (AbstractFeatureInterpretation *topFrontierInterpretation)=0

virtual unsigned int	getTopFrontierInterpretationCount () const =0

virtual common::DataObjectReference	getTopFrontierInterpretationDor (unsigned int index) const =0

AbstractFeatureInterpretation *	getTopFrontierInterpretation (unsigned int index) const

virtual void	pushBackBottomFrontierInterpretation (AbstractFeatureInterpretation *bottomFrontierInterpretation)=0

virtual unsigned int	getBottomFrontierInterpretationCount () const =0

virtual common::DataObjectReference	getBottomFrontierInterpretationDor (unsigned int index) const =0

AbstractFeatureInterpretation *	getBottomFrontierInterpretation (unsigned int index) const

virtual void	pushBackSideFrontierInterpretation (AbstractFeatureInterpretation *sideFrontierInterpretation)=0

virtual unsigned int	getSideFrontierInterpretationCount () const =0

virtual common::DataObjectReference	getSideFrontierInterpretationDor (unsigned int index) const =0

AbstractFeatureInterpretation *	getSideFrontierInterpretation (unsigned int index) const

virtual std::string	getXmlTag () const final

Public Member Functions inherited from resqml2::AbstractOrganizationInterpretation
virtual	~AbstractOrganizationInterpretation ()=default

void	pushBackBinaryContact (AbstractFeatureInterpretation subject, gsoap_eml2_3::resqml22__ContactVerb verb, AbstractFeatureInterpretation directObject)

void	pushBackBinaryContact (AbstractFeatureInterpretation subject, gsoap_eml2_3::resqml22__ContactVerb verb, AbstractFeatureInterpretation directObject, AbstractFeatureInterpretation *partOf)

void	pushBackBinaryContact (AbstractFeatureInterpretation subject, gsoap_eml2_3::resqml22__ContactVerb verb, AbstractFeatureInterpretation directObject, gsoap_resqml2_0_1::resqml20__ContactSide directObjectQualifier)

void	pushBackBinaryContact (AbstractFeatureInterpretation subject, gsoap_resqml2_0_1::resqml20__ContactSide subjectQualifier, gsoap_eml2_3::resqml22__ContactVerb verb, AbstractFeatureInterpretation directObject, gsoap_resqml2_0_1::resqml20__ContactSide directObjectQualifier)

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

One of the main types of RESQML organizations, this class gathers boundary interpretations (e.g., horizons and faults) plus frontier features and their relationships (contacts interpretations), which when taken together define the structure of a part of the earth.

Constructor & Destructor Documentation

◆ ~StructuralOrganizationInterpretation()

virtual resqml2::StructuralOrganizationInterpretation::~StructuralOrganizationInterpretation ( )

virtualdefault

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

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

Member Function Documentation

◆ getBottomFrontierInterpretation()

AbstractFeatureInterpretation* resqml2::StructuralOrganizationInterpretation::getBottomFrontierInterpretation ( unsigned int index ) const

Gets a given bottom frontier interpretation.

Exceptions

std::out_of_range If index >= getBottomFrontierInterpretationCount().

Parameters

index Zero-based index of the bottom frontier interpretation we look for.

Returns: The bottom frontier interpretation at position index.

◆ getBottomFrontierInterpretationCount()

virtual unsigned int resqml2::StructuralOrganizationInterpretation::getBottomFrontierInterpretationCount ( ) const

pure virtual

Gets the bottom frontier interpretations count.

Exceptions

std::range_error If the bottom frontier interpretation count is strictly greater than unsigned int max.

Returns: The bottom frontier interpretations count.

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

◆ getBottomFrontierInterpretationDor()

virtual common::DataObjectReference resqml2::StructuralOrganizationInterpretation::getBottomFrontierInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given bottom frontier interpretation.

Exceptions

std::out_of_range If index >= getBottomFrontierInterpretationCount().

Parameters

index Zero-based index of the bottom frontier interpretation for which we look for the DOR.

Returns: The DOR of the bottom frontier interpretation at position index.

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

◆ getFaultInterpretation()

FaultInterpretation* resqml2::StructuralOrganizationInterpretation::getFaultInterpretation ( unsigned int index ) const

Gets a given fault interpretation.

Exceptions

std::out_of_range If index >= getFaultInterpretationCount().

Parameters

index Zero-based index of the fault interpretation we look for.

Returns: The fault interpretation at position index.

◆ getFaultInterpretationCount()

virtual unsigned int resqml2::StructuralOrganizationInterpretation::getFaultInterpretationCount ( ) const

pure virtual

Gets the fault interpretations count.

Exceptions

std::range_error If the fault interpretation count is strictly greater than unsigned int max.

Returns: The fault interpretations count.

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

◆ getFaultInterpretationDor()

virtual common::DataObjectReference resqml2::StructuralOrganizationInterpretation::getFaultInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given fault interpretation.

Exceptions

std::out_of_range If index >= getFaultInterpretationCount().

Parameters

index Zero-based index of the fault interpretation for which we look for the DOR.

Returns: The DOR of the fault interpretation at position index.

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

◆ getHorizonInterpretation()

HorizonInterpretation* resqml2::StructuralOrganizationInterpretation::getHorizonInterpretation ( unsigned int index ) const

Gets a given horizon interpretation.

Exceptions

std::out_of_range If index >= getHorizonInterpretationCount().

Parameters

index Zero-based index of the horizon interpretation we look for.

Returns: The horizon interpretation at position index.

◆ getHorizonInterpretationCount()

virtual unsigned int resqml2::StructuralOrganizationInterpretation::getHorizonInterpretationCount ( ) const

pure virtual

Gets the horizon interpretations count.

Exceptions

std::range_error If the horizon interpretation count is strictly greater than unsigned int max.

Returns: The horizon interpretations count.

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

◆ getHorizonInterpretationDor()

virtual common::DataObjectReference resqml2::StructuralOrganizationInterpretation::getHorizonInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given horizon interpretation.

Exceptions

std::out_of_range If index >= getHorizonInterpretationCount().

Parameters

index Zero-based index of the horizon interpretation for which we look for the DOR.

Returns: The DOR of the horizon interpretation at position index.

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

◆ getSideFrontierInterpretation()

AbstractFeatureInterpretation* resqml2::StructuralOrganizationInterpretation::getSideFrontierInterpretation ( unsigned int index ) const

Gets a given side frontier interpretation.

Exceptions

std::out_of_range If index >= getSideFrontierInterpretationCount().

Parameters

index Zero-based index of the side frontier interpretation we look for.

Returns: The side frontier interpretation at position index.

◆ getSideFrontierInterpretationCount()

virtual unsigned int resqml2::StructuralOrganizationInterpretation::getSideFrontierInterpretationCount ( ) const

pure virtual

Gets the side frontier interpretations count.

Exceptions

std::range_error If the side frontier interpretation count is strictly greater than unsigned int max.

Returns: The side frontier interpretations count.

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

◆ getSideFrontierInterpretationDor()

virtual common::DataObjectReference resqml2::StructuralOrganizationInterpretation::getSideFrontierInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given side frontier interpretation.

Exceptions

std::out_of_range If index >= getSideFrontierInterpretationCount().

Parameters

index Zero-based index of the side frontier interpretation for which we look for the DOR.

Returns: The DOR of the side frontier interpretation at position index.

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

◆ getTopFrontierInterpretation()

AbstractFeatureInterpretation* resqml2::StructuralOrganizationInterpretation::getTopFrontierInterpretation ( unsigned int index ) const

Gets a given top frontier interpretation.

Exceptions

std::out_of_range If index >= getTopFrontierInterpretationCount().

Parameters

index Zero-based index of the top frontier interpretation we look for.

Returns: The top frontier interpretation at position index.

◆ getTopFrontierInterpretationCount()

virtual unsigned int resqml2::StructuralOrganizationInterpretation::getTopFrontierInterpretationCount ( ) const

pure virtual

Gets the top frontier interpretations count.

Exceptions

std::range_error If the top frontier interpretation count is strictly greater than unsigned int max.

Returns: The top frontier interpretations count.

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

◆ getTopFrontierInterpretationDor()

virtual common::DataObjectReference resqml2::StructuralOrganizationInterpretation::getTopFrontierInterpretationDor ( unsigned int index ) const

pure virtual

Gets the DOR of a given top frontier interpretation.

Exceptions

std::out_of_range If index >= getTopFrontierInterpretationCount().

Parameters

index Zero-based index of the top frontier interpretation for which we look for the DOR.

Returns: The DOR of the top frontier interpretation at position index.

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

◆ getXmlTag()

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

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ pushBackBottomFrontierInterpretation()

virtual void resqml2::StructuralOrganizationInterpretation::pushBackBottomFrontierInterpretation ( AbstractFeatureInterpretation * bottomFrontierInterpretation )

pure virtual

Adds a frontier interpretation to this structural organization interpretation as a bottom.

Exceptions

std::invalid_argument If bottomFrontierInterpretation == nullptr.

Parameters

[in] bottomFrontierInterpretation A bottom frontier interpretation.

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

◆ pushBackFaultInterpretation()

virtual void resqml2::StructuralOrganizationInterpretation::pushBackFaultInterpretation ( FaultInterpretation * faultInterpretation )

pure virtual

Adds a fault interpretation to this structural organization interpretation.

Exceptions

std::invalid_argument If faultInterpretation == nullptr.

Parameters

[in] faultInterpretation A fault interpretation.

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

◆ pushBackHorizonInterpretation()

virtual void resqml2::StructuralOrganizationInterpretation::pushBackHorizonInterpretation	(	HorizonInterpretation *	horizonInterpretation,
		int	stratigraphicRank
	)

pure virtual

Adds a horizon interpretation at a given rank of this structural organization interpretation.

Exceptions

std::invalid_argument If horizonInterpretation == nullptr.

Parameters

[in]	horizonInterpretation	A horizon interpretation.
	stratigraphicRank	The rank of the horizon interpretation within this structural organization.

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

◆ pushBackSideFrontierInterpretation()

virtual void resqml2::StructuralOrganizationInterpretation::pushBackSideFrontierInterpretation ( AbstractFeatureInterpretation * sideFrontierInterpretation )

pure virtual

Adds a frontier interpretation to this structural organization interpretation as a side.

Exceptions

std::invalid_argument If sideFrontierInterpretation == nullptr.

Parameters

[in] sideFrontierInterpretation A side frontier interpretation.

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

◆ pushBackTopFrontierInterpretation()

virtual void resqml2::StructuralOrganizationInterpretation::pushBackTopFrontierInterpretation ( AbstractFeatureInterpretation * topFrontierInterpretation )

pure virtual

Adds a frontier interpretation to this structural organization interpretation as a top.

Exceptions

std::invalid_argument If topFrontierInterpretation == nullptr.

Parameters

[in] topFrontierInterpretation A top frontier interpretation.

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

Member Data Documentation

◆ XML_TAG

const char* resqml2::StructuralOrganizationInterpretation::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/StructuralOrganizationInterpretation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~StructuralOrganizationInterpretation()

Member Function Documentation

◆ getBottomFrontierInterpretation()

◆ getBottomFrontierInterpretationCount()

◆ getBottomFrontierInterpretationDor()

◆ getFaultInterpretation()

◆ getFaultInterpretationCount()

◆ getFaultInterpretationDor()

◆ getHorizonInterpretation()

◆ getHorizonInterpretationCount()

◆ getHorizonInterpretationDor()

◆ getSideFrontierInterpretation()

◆ getSideFrontierInterpretationCount()

◆ getSideFrontierInterpretationDor()

◆ getTopFrontierInterpretation()

◆ getTopFrontierInterpretationCount()

◆ getTopFrontierInterpretationDor()

◆ getXmlTag()

◆ pushBackBottomFrontierInterpretation()

◆ pushBackFaultInterpretation()

◆ pushBackHorizonInterpretation()

◆ pushBackSideFrontierInterpretation()

◆ pushBackTopFrontierInterpretation()

Member Data Documentation

◆ XML_TAG