A stratigraphic column rank interpretation is a global hierarchy containing an ordered list of stratigraphic unit interpretations. More...

#include <StratigraphicColumnRankInterpretation.h>

Inheritance diagram for resqml2::StratigraphicColumnRankInterpretation:

Public Member Functions
virtual	~StratigraphicColumnRankInterpretation ()=default

virtual void	pushBackStratiUnitInterpretation (StratigraphicUnitInterpretation *stratiUnitInterpretation)=0

virtual void	setHorizonOfLastContact (HorizonInterpretation *partOf)=0

virtual void	pushBackStratigraphicBinaryContact (StratigraphicUnitInterpretation subject, gsoap_eml2_3::resqml22__ContactMode subjectContactMode, StratigraphicUnitInterpretation directObject, gsoap_eml2_3::resqml22__ContactMode directObjectMode, HorizonInterpretation *partOf=nullptr)=0

virtual bool	isAChronoStratiRank () const =0

virtual unsigned int	getContactCount () const =0

virtual gsoap_eml2_3::resqml22__ContactMode	getSubjectContactModeOfContact (unsigned int contactIndex) const =0

virtual class StratigraphicUnitInterpretation *	getSubjectOfContact (unsigned int contactIndex) const =0

virtual gsoap_eml2_3::resqml22__ContactMode	getDirectObjectContactModeOfContact (unsigned int contactIndex) const =0

virtual StratigraphicUnitInterpretation *	getDirectObjectOfContact (unsigned int contactIndex) const =0

virtual HorizonInterpretation *	getHorizonInterpretationOfContact (unsigned int contactIndex) const =0

virtual unsigned int	getStratigraphicUnitInterpretationCount () const =0

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

std::vector< StratigraphicUnitInterpretation * >	getStratigraphicUnitInterpretationSet () const

virtual unsigned int	getHorizonInterpretationCount () const =0

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

HorizonInterpretation *	getHorizonInterpretation (unsigned int index) const

std::vector< HorizonInterpretation * >	getHorizonInterpretationSet () const

virtual std::string	getXmlTag () const final

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

std::vector< AbstractGridRepresentation * >	getGridRepresentations () const

unsigned int	getGridRepresentationCount () const

AbstractGridRepresentation *	getGridRepresentation (unsigned int index) const

bool	isAssociatedToGridRepresentation (AbstractGridRepresentation *gridRep) const

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

A stratigraphic column rank interpretation is a global hierarchy containing an ordered list of stratigraphic unit interpretations.

Constructor & Destructor Documentation

◆ ~StratigraphicColumnRankInterpretation()

virtual resqml2::StratigraphicColumnRankInterpretation::~StratigraphicColumnRankInterpretation ( )

virtualdefault

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

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

Member Function Documentation

◆ getContactCount()

virtual unsigned int resqml2::StratigraphicColumnRankInterpretation::getContactCount ( ) const

pure virtual

Gets the count of contacts in this stratigraphic column rank interpretation.

Returns: The contact count.

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

◆ getDirectObjectContactModeOfContact()

virtual gsoap_eml2_3::resqml22__ContactMode resqml2::StratigraphicColumnRankInterpretation::getDirectObjectContactModeOfContact ( unsigned int contactIndex ) const

pure virtual

Gets the contact mode of the direct object stratigraphic unit of a contact located at a particular index. Most of time the direct object stratigraphic unit is the stratigraphic unit below the contact.

Parameters

contactIndex Zero-based index of the contact for which we look for the contact mode of the direct object stratigraphic unit.

Returns: Proportional contact mode by default (if no contact mode is associated to the direct object stratigraphic unit) or the contact mode of the direct object stratigraphic unit.

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

◆ getDirectObjectOfContact()

virtual StratigraphicUnitInterpretation* resqml2::StratigraphicColumnRankInterpretation::getDirectObjectOfContact ( unsigned int contactIndex ) const

pure virtual

Gets the stratigraphic unit interpretation which is the direct object of a particular contact.

Exceptions

std::out_of_range If contactIndex is out of range.

Parameters

contactIndex Zero-based index of the contact for which we look for the direct object stratigraphic unit interpretation.

Returns: The direct object stratigraphic unit interpretation of the contact at position contactIndex if it exists, else nullptr.

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

◆ getHorizonInterpretation()

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

Gets the contact horizon interpretation at a particular index.

Exceptions

std::out_of_range If index is out of range.

Parameters

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

Returns: The contact horizon interpretation at position index.

◆ getHorizonInterpretationCount()

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

pure virtual

Gets the count of all the contact horizon interpretations which are contained in this stratigraphic column rank.

Returns: The count of all the contact horizon interpretations which are contained in this stratigraphic column rank.

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

◆ getHorizonInterpretationDor()

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

pure virtual

Gets the data object reference of a contact horizon interpretation at a particular index.

Exceptions

std::out_of_range If index is out of range.

Parameters

index Zero-based index of the contact horizon interpretation we look for the data object reference.

Returns: The data object reference of the contact horizon interpretation at position index.

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

◆ getHorizonInterpretationOfContact()

virtual HorizonInterpretation* resqml2::StratigraphicColumnRankInterpretation::getHorizonInterpretationOfContact ( unsigned int contactIndex ) const

pure virtual

Gets the horizon interpretation which is the contact between two stratigraphic units.

Exceptions

std::out_of_range If contactIndex is out of range.

Parameters

contactIndex Zero-based index of the contact for which we want to get the corresponding horizon interpretation.

Returns: nullptr if the horizon corresponding to the contact at position contactIndex is unknown, else the corresponding horizon interpretation.

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

◆ getHorizonInterpretationSet()

std::vector<HorizonInterpretation *> resqml2::StratigraphicColumnRankInterpretation::getHorizonInterpretationSet ( ) const

Gets all the horizon interpretations contained in this stratigraphic column rank interpretation.

Returns: A vector of pointers to all the horizon interpretations contained in this stratigraphic column rank interpretation.

◆ getStratigraphicUnitInterpretationCount()

virtual unsigned int resqml2::StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationCount ( ) const

pure virtual

Gets the count of all the stratigraphic unit interpretations which are contained in this stratigraphic column rank.

Returns: The count of all the stratigraphic unit interpretations which are contained in this stratigraphic column rank.

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

◆ getStratigraphicUnitInterpretationDor()

virtual common::DataObjectReference resqml2::StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationDor ( unsigned int index ) const

pure virtual

Gets the data object reference of the stratigraphic unit interpretations at a particular index.

Exceptions

std::out_of_range If index is out of range.

Parameters

index Zero-based index of the stratigraphic unit interpretation we look for the data object reference.

Returns: The data object reference of the stratigraphic unit interpretation at position index.

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

◆ getStratigraphicUnitInterpretationSet()

std::vector<StratigraphicUnitInterpretation *> resqml2::StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationSet ( ) const

Gets all the stratigraphic unit interpretations contained in this stratigraphic column rank interpretation.

Returns: A vector of pointers to all the stratigraphic unit interpretations contained in this stratigraphic column rank interpretation.

◆ getSubjectContactModeOfContact()

virtual gsoap_eml2_3::resqml22__ContactMode resqml2::StratigraphicColumnRankInterpretation::getSubjectContactModeOfContact ( unsigned int contactIndex ) const

pure virtual

Gets the contact mode of the subject stratigraphic unit of a contact located at a particular index. Most of time the subject stratigraphic unit is the stratigraphic unit on top of the contact.

Exceptions

std::out_of_range If contactIndex is out of range.

Parameters

contactIndex Zero-based index of the contact for which we look for the contact mode of the subject stratigraphic unit.

Returns: Proportional contact mode by default (if no contact mode is associated to the subject stratigraphic unit) or the contact mode of the subject stratigraphic unit.

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

◆ getSubjectOfContact()

virtual class StratigraphicUnitInterpretation* resqml2::StratigraphicColumnRankInterpretation::getSubjectOfContact ( unsigned int contactIndex ) const

pure virtual

Gets the stratigraphic unit interpretation which is the subject of a particular contact.

Exceptions

std::out_of_range If contactIndex is out of range.

Parameters

contactIndex Zero-based index of the contact for which we look for the subject stratigraphic unit interpretation.

Returns: The subject stratigraphic unit interpretation of the contact at position contactIndex if it exists, else nullptr.

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

◆ getXmlTag()

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

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ isAChronoStratiRank()

virtual bool resqml2::StratigraphicColumnRankInterpretation::isAChronoStratiRank ( ) const

pure virtual

Indicates whether this stratigraphic column rank interpretation is a chrono one (it is ordered by ages) or not. One of the consequence is that in a chrono stratigraphic column rank interpretation, each stratigraphic unit interpretation have only one top and only one bottom.

Returns: True if is a chrono stratigraphic column rank, false if it is not.

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

◆ pushBackStratigraphicBinaryContact()

virtual void resqml2::StratigraphicColumnRankInterpretation::pushBackStratigraphicBinaryContact	(	StratigraphicUnitInterpretation *	subject,
		gsoap_eml2_3::resqml22__ContactMode	subjectContactMode,
		StratigraphicUnitInterpretation *	directObject,
		gsoap_eml2_3::resqml22__ContactMode	directObjectMode,
		HorizonInterpretation *	partOf = `nullptr`
	)

pure virtual

Adds a stratigraphic binary "stops" contact to this stratigraphic column rank interpretation.

Exceptions

std::invalid_argument If subject or directObject is nullptr.

Parameters

[in]	subject	The subject of the sentence that defines how the contact was constructed.
	subjectContactMode	The subject contact mode (baselap, erosion, extended or proportional).
[in]	directObject	The direct object of the sentence that defines how the contact was constructed.
	directObjectMode	The direct object contact mode (baselap, erosion, extended or proportional).
[in]	partOf	(Optional) If non-null, the horizon interpretation that contains this new binary contact. Default value is `nullptr`.

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

◆ pushBackStratiUnitInterpretation()

virtual void resqml2::StratigraphicColumnRankInterpretation::pushBackStratiUnitInterpretation ( StratigraphicUnitInterpretation * stratiUnitInterpretation )

pure virtual

Adds a stratigraphic unit interpretation to this stratigraphic column rank interpretation. Does add the inverse relationship i.e. from the included stratigraphic unit interpretation to this stratigraphic column rank interpretation.

Exceptions

std::invalid_argument If stratiUnitInterpretation is nullptr.

Parameters

[in] stratiUnitInterpretation The stratigraphic unit interpretation to add.

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

◆ setHorizonOfLastContact()

virtual void resqml2::StratigraphicColumnRankInterpretation::setHorizonOfLastContact ( HorizonInterpretation * partOf )

pure virtual

Sets the horizon interpretation that contains the last (the one with the greater index) contact interpretation within the list of contact interpretation associated to this stratigraphic column rank interpretation.

Exceptions

std::invalid_argument If partOf is nullptr.

Parameters

[in] partOf The horizon interpretation that contains the last contact interpretation.

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

Member Data Documentation

◆ XML_TAG

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~StratigraphicColumnRankInterpretation()

Member Function Documentation

◆ getContactCount()

◆ getDirectObjectContactModeOfContact()

◆ getDirectObjectOfContact()

◆ getHorizonInterpretation()

◆ getHorizonInterpretationCount()

◆ getHorizonInterpretationDor()

◆ getHorizonInterpretationOfContact()

◆ getHorizonInterpretationSet()

◆ getStratigraphicUnitInterpretationCount()

◆ getStratigraphicUnitInterpretationDor()

◆ getStratigraphicUnitInterpretationSet()

◆ getSubjectContactModeOfContact()

◆ getSubjectOfContact()

◆ getXmlTag()

◆ isAChronoStratiRank()

◆ pushBackStratigraphicBinaryContact()

◆ pushBackStratiUnitInterpretation()

◆ setHorizonOfLastContact()

Member Data Documentation

◆ XML_TAG