Fesapi 2.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
resqml2_0_1::StratigraphicColumnRankInterpretation Class Referencefinal

#include <StratigraphicColumnRankInterpretation.h>

Inheritance diagram for resqml2_0_1::StratigraphicColumnRankInterpretation:
resqml2::StratigraphicColumnRankInterpretation resqml2::AbstractStratigraphicOrganizationInterpretation resqml2::AbstractOrganizationInterpretation resqml2::AbstractFeatureInterpretation common::AbstractObject

Public Member Functions

 StratigraphicColumnRankInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 StratigraphicColumnRankInterpretation (resqml2::Model *orgFeat, const std::string &guid, const std::string &title, uint64_t rank, gsoap_resqml2_0_1::resqml20__OrderingCriteria orderingCriteria)
 Creates an instance of this class in a gsoap context.
 StratigraphicColumnRankInterpretation (gsoap_resqml2_0_1::_resqml20__StratigraphicColumnRankInterpretation *fromGsoap)
 ~StratigraphicColumnRankInterpretation ()=default
void pushBackStratiUnitInterpretation (resqml2::StratigraphicUnitInterpretation *stratiUnitInterpretation) final
void setHorizonOfLastContact (resqml2::HorizonInterpretation *partOf) final
void pushBackStratigraphicBinaryContact (resqml2::StratigraphicUnitInterpretation *subject, gsoap_eml2_3::resqml22__ContactMode subjectContactMode, resqml2::StratigraphicUnitInterpretation *directObject, gsoap_eml2_3::resqml22__ContactMode directObjectMode, resqml2::HorizonInterpretation *partOf=nullptr) final
bool isAChronoStratiRank () const final
unsigned int getContactCount () const final
gsoap_eml2_3::resqml22__ContactMode getSubjectContactModeOfContact (unsigned int contactIndex) const final
resqml2::StratigraphicUnitInterpretationgetSubjectOfContact (unsigned int contactIndex) const final
gsoap_eml2_3::resqml22__ContactMode getDirectObjectContactModeOfContact (unsigned int contactIndex) const final
resqml2::StratigraphicUnitInterpretationgetDirectObjectOfContact (unsigned int contactIndex) const final
resqml2::HorizonInterpretationgetHorizonInterpretationOfContact (unsigned int contactIndex) const final
unsigned int getStratigraphicUnitInterpretationCount () const final
common::DataObjectReference getStratigraphicUnitInterpretationDor (unsigned int index) const final
unsigned int getHorizonInterpretationCount () const final
common::DataObjectReference getHorizonInterpretationDor (unsigned int index) const final
std::string getXmlNamespace () const final
Public Member Functions inherited from resqml2::StratigraphicColumnRankInterpretation
StratigraphicUnitInterpretationgetStratigraphicUnitInterpretation (unsigned int index) const
std::vector< StratigraphicUnitInterpretation * > getStratigraphicUnitInterpretationSet () const
HorizonInterpretationgetHorizonInterpretation (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
bool isStratigraphic () const final
std::vector< AbstractGridRepresentation * > getGridRepresentations () const
unsigned int getGridRepresentationCount () const
AbstractGridRepresentationgetGridRepresentation (unsigned int index) const
bool isAssociatedToGridRepresentation (AbstractGridRepresentation *gridRep) const
Public Member Functions inherited from resqml2::AbstractOrganizationInterpretation
virtual ~AbstractOrganizationInterpretation ()=default
virtual bool isStructural () const
virtual bool isRockFluid () const
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)
AbstractFeaturegetInterpretedFeature () 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
AbstractRepresentationgetRepresentation (uint64_t index) const
std::vector< GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet () 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)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_3::eml23__DataObjectReference * newEml23Reference () const
gsoap_resqml2_0_1::resqml20__ContactElementReference * newContactElementReference2_0_1 () const
gsoap_eml2_3::resqml22__ContactElement * newContactElementReference2_2 () const
common::DataObjectRepositorygetRepository () 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)
uint64_t getAliasCount () const
std::string getAliasAuthorityAtIndex (uint64_t index) const
std::string getAliasTitleAtIndex (uint64_t index) const
std::vector< eml2::Activity * > getActivitySet () const
uint64_t getActivityCount () const
eml2::ActivitygetActivity (uint64_t 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
uint64_t getExtraMetadataCount () const
std::string getExtraMetadataKeyAtIndex (uint64_t index) const
std::string getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string buildEtp12Uri () const
void setUriSource (const std::string &uriSource)
const std::string & getUriSource () const
std::string getEpcSourceFolder () const
void changeToPartialObject ()

Static Public Attributes

static const char * XML_NS
Static Public Attributes inherited from resqml2::StratigraphicColumnRankInterpretation
static const char * XML_TAG

Additional Inherited Members

Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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 other organizations that are consistent to each others.

Constructor & Destructor Documentation

◆ StratigraphicColumnRankInterpretation() [1/3]

resqml2_0_1::StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context

◆ StratigraphicColumnRankInterpretation() [2/3]

resqml2_0_1::StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( resqml2::Model * orgFeat,
const std::string & guid,
const std::string & title,
uint64_t rank,
gsoap_resqml2_0_1::resqml20__OrderingCriteria orderingCriteria )

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf orgFeat == nullptr or if orgFeat is not a stratigraphic organization.
Parameters
[in]orgFeatThe feature the instance interprets. It must be a stratigraphic organization feature.
guidThe guid to set to the interpretation. If empty then a new guid will be generated.
titleA title for the instance to create.
rankThe rank index of this interpretation within a stratigraphic column.
orderingCriteriaHow the included horizons are ordered.

◆ StratigraphicColumnRankInterpretation() [3/3]

resqml2_0_1::StratigraphicColumnRankInterpretation::StratigraphicColumnRankInterpretation ( gsoap_resqml2_0_1::_resqml20__StratigraphicColumnRankInterpretation * fromGsoap)
inline

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

◆ ~StratigraphicColumnRankInterpretation()

resqml2_0_1::StratigraphicColumnRankInterpretation::~StratigraphicColumnRankInterpretation ( )
virtualdefault

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

Reimplemented from resqml2::StratigraphicColumnRankInterpretation.

Member Function Documentation

◆ getContactCount()

unsigned int resqml2_0_1::StratigraphicColumnRankInterpretation::getContactCount ( ) const
finalvirtual

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

Returns
The contact count.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getDirectObjectContactModeOfContact()

gsoap_eml2_3::resqml22__ContactMode resqml2_0_1::StratigraphicColumnRankInterpretation::getDirectObjectContactModeOfContact ( unsigned int contactIndex) const
finalvirtual

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

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getDirectObjectOfContact()

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

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

Exceptions
std::out_of_rangeIf contactIndex is out of range.
Parameters
contactIndexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getHorizonInterpretationCount()

unsigned int resqml2_0_1::StratigraphicColumnRankInterpretation::getHorizonInterpretationCount ( ) const
finalvirtual

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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getHorizonInterpretationDor()

common::DataObjectReference resqml2_0_1::StratigraphicColumnRankInterpretation::getHorizonInterpretationDor ( unsigned int index) const
finalvirtual

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

Exceptions
std::out_of_rangeIf index is out of range.
Parameters
indexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getHorizonInterpretationOfContact()

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

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

Exceptions
std::out_of_rangeIf contactIndex is out of range.
Parameters
contactIndexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getStratigraphicUnitInterpretationCount()

unsigned int resqml2_0_1::StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationCount ( ) const
finalvirtual

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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getStratigraphicUnitInterpretationDor()

common::DataObjectReference resqml2_0_1::StratigraphicColumnRankInterpretation::getStratigraphicUnitInterpretationDor ( unsigned int index) const
finalvirtual

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

Exceptions
std::out_of_rangeIf index is out of range.
Parameters
indexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getSubjectContactModeOfContact()

gsoap_eml2_3::resqml22__ContactMode resqml2_0_1::StratigraphicColumnRankInterpretation::getSubjectContactModeOfContact ( unsigned int contactIndex) const
finalvirtual

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_rangeIf contactIndex is out of range.
Parameters
contactIndexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getSubjectOfContact()

resqml2::StratigraphicUnitInterpretation * resqml2_0_1::StratigraphicColumnRankInterpretation::getSubjectOfContact ( unsigned int contactIndex) const
finalvirtual

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

Exceptions
std::out_of_rangeIf contactIndex is out of range.
Parameters
contactIndexZero-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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ getXmlNamespace()

std::string resqml2_0_1::StratigraphicColumnRankInterpretation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ isAChronoStratiRank()

bool resqml2_0_1::StratigraphicColumnRankInterpretation::isAChronoStratiRank ( ) const
finalvirtual

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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ pushBackStratigraphicBinaryContact()

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

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

Exceptions
std::invalid_argumentIf subject or directObject is nullptr.
Parameters
[in]subjectThe subject of the sentence that defines how the contact was constructed.
subjectContactModeThe subject contact mode (baselap, erosion, extended or proportional).
[in]directObjectThe direct object of the sentence that defines how the contact was constructed.
directObjectModeThe 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.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ pushBackStratiUnitInterpretation()

void resqml2_0_1::StratigraphicColumnRankInterpretation::pushBackStratiUnitInterpretation ( resqml2::StratigraphicUnitInterpretation * stratiUnitInterpretation)
finalvirtual

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_argumentIf stratiUnitInterpretation is nullptr.
Parameters
[in]stratiUnitInterpretationThe stratigraphic unit interpretation to add.

Implements resqml2::StratigraphicColumnRankInterpretation.

◆ setHorizonOfLastContact()

void resqml2_0_1::StratigraphicColumnRankInterpretation::setHorizonOfLastContact ( resqml2::HorizonInterpretation * partOf)
finalvirtual

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_argumentIf partOf is nullptr.
Parameters
[in]partOfThe horizon interpretation that contains the last contact interpretation.

Implements resqml2::StratigraphicColumnRankInterpretation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::StratigraphicColumnRankInterpretation::XML_NS
static

The standard XML namespace for serializing this data object.


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