A structural organization interpretation. This class cannot be inherited. More...

#include <StructuralOrganizationInterpretation.h>

Inheritance diagram for resqml2_2::StructuralOrganizationInterpretation:

Public Member Functions
	StructuralOrganizationInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	StructuralOrganizationInterpretation (resqml2::Model *orgFeat, const std::string &guid, const std::string &title, gsoap_resqml2_0_1::resqml20__OrderingCriteria orderingCriteria)
	Creates an instance of this class in a gsoap context. More...

	StructuralOrganizationInterpretation (gsoap_eml2_3::_resqml22__StructuralOrganizationInterpretation *fromGsoap)

	~StructuralOrganizationInterpretation ()=default

void	pushBackFaultInterpretation (resqml2::FaultInterpretation *faultInterpretation) final

unsigned int	getFaultInterpretationCount () const final

common::DataObjectReference	getFaultInterpretationDor (unsigned int index) const final

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

unsigned int	getHorizonInterpretationCount () const final

common::DataObjectReference	getHorizonInterpretationDor (unsigned int index) const final

void	pushBackTopFrontierInterpretation (resqml2::AbstractFeatureInterpretation *topFrontierInterpretation) final

unsigned int	getTopFrontierInterpretationCount () const final

common::DataObjectReference	getTopFrontierInterpretationDor (unsigned int index) const final

void	pushBackBottomFrontierInterpretation (resqml2::AbstractFeatureInterpretation *bottomFrontierInterpretation) final

unsigned int	getBottomFrontierInterpretationCount () const final

common::DataObjectReference	getBottomFrontierInterpretationDor (unsigned int index) const final

void	pushBackSideFrontierInterpretation (resqml2::AbstractFeatureInterpretation *sideFrontierInterpretation) final

unsigned int	getSideFrontierInterpretationCount () const final

common::DataObjectReference	getSideFrontierInterpretationDor (unsigned int index) const final

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::StructuralOrganizationInterpretation
FaultInterpretation *	getFaultInterpretation (unsigned int index) const

HorizonInterpretation *	getHorizonInterpretation (unsigned int index) const

AbstractFeatureInterpretation *	getTopFrontierInterpretation (unsigned int index) const

AbstractFeatureInterpretation *	getBottomFrontierInterpretation (unsigned int index) const

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	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_NS

Static Public Attributes inherited from resqml2::StructuralOrganizationInterpretation
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

A structural organization interpretation. This class cannot be inherited.

Constructor & Destructor Documentation

◆ StructuralOrganizationInterpretation() [1/3]

resqml2_2::StructuralOrganizationInterpretation::StructuralOrganizationInterpretation ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

◆ StructuralOrganizationInterpretation() [2/3]

resqml2_2::StructuralOrganizationInterpretation::StructuralOrganizationInterpretation	(	resqml2::Model *	orgFeat,
		const std::string &	guid,
		const std::string &	title,
		gsoap_resqml2_0_1::resqml20__OrderingCriteria	orderingCriteria
	)

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If orgFeat == nullptr.

Parameters

[in]	orgFeat	The feature the instance interprets. It must be a structural organization feature.
	guid	The guid to set to the interpretation. If empty then a new guid will be generated.
	title	A title for the instance to create.
	orderingCriteria	How the included horizons are ordered.

◆ StructuralOrganizationInterpretation() [3/3]

resqml2_2::StructuralOrganizationInterpretation::StructuralOrganizationInterpretation ( gsoap_eml2_3::_resqml22__StructuralOrganizationInterpretation * fromGsoap )

inline

Creates an instance of this class by wrapping a gsoap instance.

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~StructuralOrganizationInterpretation()

resqml2_2::StructuralOrganizationInterpretation::~StructuralOrganizationInterpretation ( )

virtualdefault

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

Reimplemented from resqml2::StructuralOrganizationInterpretation.

Member Function Documentation

◆ getBottomFrontierInterpretationCount()

unsigned int resqml2_2::StructuralOrganizationInterpretation::getBottomFrontierInterpretationCount ( ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getBottomFrontierInterpretationDor()

common::DataObjectReference resqml2_2::StructuralOrganizationInterpretation::getBottomFrontierInterpretationDor ( unsigned int index ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getFaultInterpretationCount()

unsigned int resqml2_2::StructuralOrganizationInterpretation::getFaultInterpretationCount ( ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getFaultInterpretationDor()

common::DataObjectReference resqml2_2::StructuralOrganizationInterpretation::getFaultInterpretationDor ( unsigned int index ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getHorizonInterpretationCount()

unsigned int resqml2_2::StructuralOrganizationInterpretation::getHorizonInterpretationCount ( ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getHorizonInterpretationDor()

common::DataObjectReference resqml2_2::StructuralOrganizationInterpretation::getHorizonInterpretationDor ( unsigned int index ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getSideFrontierInterpretationCount()

unsigned int resqml2_2::StructuralOrganizationInterpretation::getSideFrontierInterpretationCount ( ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getSideFrontierInterpretationDor()

common::DataObjectReference resqml2_2::StructuralOrganizationInterpretation::getSideFrontierInterpretationDor ( unsigned int index ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getTopFrontierInterpretationCount()

unsigned int resqml2_2::StructuralOrganizationInterpretation::getTopFrontierInterpretationCount ( ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getTopFrontierInterpretationDor()

common::DataObjectReference resqml2_2::StructuralOrganizationInterpretation::getTopFrontierInterpretationDor ( unsigned int index ) const

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ getXmlNamespace()

std::string resqml2_2::StructuralOrganizationInterpretation::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackBottomFrontierInterpretation()

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

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ pushBackFaultInterpretation()

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

finalvirtual

Adds a fault interpretation to this structural organization interpretation.

Exceptions

std::invalid_argument If faultInterpretation == nullptr.

Parameters

[in] faultInterpretation A fault interpretation.

Implements resqml2::StructuralOrganizationInterpretation.

◆ pushBackHorizonInterpretation()

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

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ pushBackSideFrontierInterpretation()

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

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

◆ pushBackTopFrontierInterpretation()

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

finalvirtual

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.

Implements resqml2::StructuralOrganizationInterpretation.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::StructuralOrganizationInterpretation::XML_NS

static

The standard 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_2/StructuralOrganizationInterpretation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StructuralOrganizationInterpretation() [1/3]

◆ StructuralOrganizationInterpretation() [2/3]

◆ StructuralOrganizationInterpretation() [3/3]

◆ ~StructuralOrganizationInterpretation()

Member Function Documentation

◆ getBottomFrontierInterpretationCount()

◆ getBottomFrontierInterpretationDor()

◆ getFaultInterpretationCount()

◆ getFaultInterpretationDor()

◆ getHorizonInterpretationCount()

◆ getHorizonInterpretationDor()

◆ getSideFrontierInterpretationCount()

◆ getSideFrontierInterpretationDor()

◆ getTopFrontierInterpretationCount()

◆ getTopFrontierInterpretationDor()

◆ getXmlNamespace()

◆ pushBackBottomFrontierInterpretation()

◆ pushBackFaultInterpretation()

◆ pushBackHorizonInterpretation()

◆ pushBackSideFrontierInterpretation()

◆ pushBackTopFrontierInterpretation()

Member Data Documentation

◆ XML_NS