Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::EarthModelInterpretation Class Referencefinal

#include <EarthModelInterpretation.h>

Inheritance diagram for resqml2_0_1::EarthModelInterpretation:
resqml2::EarthModelInterpretation resqml2::AbstractFeatureInterpretation common::AbstractObject

Public Member Functions

 EarthModelInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 EarthModelInterpretation (resqml2::Model *orgFeat, const std::string &guid, const std::string &title)
 Creates an instance of this class in a gsoap context. More...
 
 EarthModelInterpretation (gsoap_resqml2_0_1::_resqml20__EarthModelInterpretation *fromGsoap)
 
 ~EarthModelInterpretation ()=default
 
unsigned int getStructuralOrganizationInterpretationCount () const final
 
common::DataObjectReference getStructuralOrganizationInterpertationDor (unsigned int index) const final
 
void pushBackStructuralOrganizationInterpretation (resqml2::StructuralOrganizationInterpretation *structOrganization) final
 
bool hasStratiColumn () const final
 
void setStratiColumn (resqml2::StratigraphicColumn *stratiColumn) final
 
common::DataObjectReference getStratiColumnDor () const final
 
unsigned int getStratiOccurrenceCount () const final
 Gets the count of stratigraphic occurrence interpretations associated to this earth model interpretation. More...
 
common::DataObjectReference getStratiOccurrenceDor (unsigned int index) const final
 
void pushBackStratiOccurrence (resqml2::StratigraphicOccurrenceInterpretation *stratiOccurrence) final
 Pushes back a stratigraphic occurrence interpretation. More...
 
unsigned int getRockFluidOrganizationInterpretationCount () const final
 
void pushBackRockFluidOrganizationInterpretation (resqml2::RockFluidOrganizationInterpretation *rockFluid) final
 
std::string getXmlNamespace () const final
 
common::DataObjectReference getRockFluidOrganizationInterpretationDor (unsigned int index) const final
 
- Public Member Functions inherited from resqml2::EarthModelInterpretation
StructuralOrganizationInterpretationgetStructuralOrganizationInterpertation (unsigned int index) const
 
StratigraphicColumngetStratiColumn () const
 
StratigraphicOccurrenceInterpretationgetStratiOccurrence (unsigned int index) const
 
RockFluidOrganizationInterpretationgetRockFluidOrganizationInterpretation (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)
 
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
 
unsigned int getRepresentationCount () const
 
std::vector< GridConnectionSetRepresentation * > getGridConnectionSetRepresentationSet () const
 
AbstractRepresentationgetRepresentation (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::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)
 
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::ActivitygetActivity (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::EarthModelInterpretation
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 other organizations that are consistent to each others.

Constructor & Destructor Documentation

◆ EarthModelInterpretation() [1/3]

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

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ EarthModelInterpretation() [2/3]

resqml2_0_1::EarthModelInterpretation::EarthModelInterpretation ( resqml2::Model orgFeat,
const std::string &  guid,
const std::string &  title 
)

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf orgFeat == nullptr.
Parameters
[in]orgFeatThe feature the instance interprets.
guidThe guid to set to the interpretation. If empty then a new guid will be generated.
titleA title for the instance to create.

◆ EarthModelInterpretation() [3/3]

resqml2_0_1::EarthModelInterpretation::EarthModelInterpretation ( gsoap_resqml2_0_1::_resqml20__EarthModelInterpretation *  fromGsoap)
inline

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

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~EarthModelInterpretation()

resqml2_0_1::EarthModelInterpretation::~EarthModelInterpretation ( )
virtualdefault

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

Reimplemented from resqml2::EarthModelInterpretation.

Member Function Documentation

◆ getRockFluidOrganizationInterpretationCount()

unsigned int resqml2_0_1::EarthModelInterpretation::getRockFluidOrganizationInterpretationCount ( ) const
finalvirtual

Gets the count of rock fluid organization interpretations associated to this earth model interpretation.

Returns
The count of associated rock fluid organization interpretations.

Implements resqml2::EarthModelInterpretation.

◆ getRockFluidOrganizationInterpretationDor()

common::DataObjectReference resqml2_0_1::EarthModelInterpretation::getRockFluidOrganizationInterpretationDor ( unsigned int  index) const
finalvirtual

Gets the DOR of a given associated rock fluid organization interpretation.

Exceptions
std::out_of_rangeIf index >= getRockFluidOrganizationInterpretationCount().
Parameters
indexZero-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.

Implements resqml2::EarthModelInterpretation.

◆ getStratiColumnDor()

common::DataObjectReference resqml2_0_1::EarthModelInterpretation::getStratiColumnDor ( ) const
finalvirtual

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.

Implements resqml2::EarthModelInterpretation.

◆ getStratiOccurrenceCount()

unsigned int resqml2_0_1::EarthModelInterpretation::getStratiOccurrenceCount ( ) const
finalvirtual

Gets the count of stratigraphic occurrence interpretations associated to this earth model interpretation.

Exceptions
std::range_errorIf the count of stratigraphic occurrence interpretations is strictly greater than unsigned int max.
Returns
The count of associated stratigraphic occurrence interpretations.

Implements resqml2::EarthModelInterpretation.

◆ getStratiOccurrenceDor()

common::DataObjectReference resqml2_0_1::EarthModelInterpretation::getStratiOccurrenceDor ( unsigned int  index) const
finalvirtual

Gets the DOR of a given associated stratigraphic occurrence interpretation.

Exceptions
std::out_of_rangeIf index >= getStratiOccurrenceCount().
Parameters
indexZero-based index of the associated stratigraphic occurrence interpretation we look for the DOR.
Returns
The DOR of the stratigraphic occurrence interpretation at position index.

Implements resqml2::EarthModelInterpretation.

◆ getStructuralOrganizationInterpertationDor()

common::DataObjectReference resqml2_0_1::EarthModelInterpretation::getStructuralOrganizationInterpertationDor ( unsigned int  index) const
finalvirtual

Gets the DOR of a given associated structural organization interpretation.

Exceptions
std::out_of_rangeIf index >= getStructuralOrganizationInterpretationCount().
Parameters
indexZero-based index of the associated structural organization interpretation we look for the DOR.
Returns
The DOR of the structural organization interpretation at position index.

Implements resqml2::EarthModelInterpretation.

◆ getStructuralOrganizationInterpretationCount()

unsigned int resqml2_0_1::EarthModelInterpretation::getStructuralOrganizationInterpretationCount ( ) const
finalvirtual

Gets the count of structural organization interpretations associated to this earth model interpretation.

Returns
The count of associated structural organization interpretations.

Implements resqml2::EarthModelInterpretation.

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ hasStratiColumn()

bool resqml2_0_1::EarthModelInterpretation::hasStratiColumn ( ) const
finalvirtual

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.

Implements resqml2::EarthModelInterpretation.

◆ pushBackRockFluidOrganizationInterpretation()

void resqml2_0_1::EarthModelInterpretation::pushBackRockFluidOrganizationInterpretation ( resqml2::RockFluidOrganizationInterpretation rockFluid)
finalvirtual

Pushes back a rock fluid organization interpretation.

Exceptions
std::invalid_argumentIf rockFluid == nullptr.
Parameters
[in]rockFluidThe rock fluid organization interpretation to push back.

Implements resqml2::EarthModelInterpretation.

◆ pushBackStratiOccurrence()

void resqml2_0_1::EarthModelInterpretation::pushBackStratiOccurrence ( resqml2::StratigraphicOccurrenceInterpretation stratiOccurence)
finalvirtual

Pushes back a stratigraphic occurrence interpretation.

Exceptions
std::invalid_argumentIf stratiOccurrence == nullptr.
Parameters
[in]stratiOccurenceThe stratigraphic occurrence interpretation to push back.

Implements resqml2::EarthModelInterpretation.

◆ pushBackStructuralOrganizationInterpretation()

void resqml2_0_1::EarthModelInterpretation::pushBackStructuralOrganizationInterpretation ( resqml2::StructuralOrganizationInterpretation structOrganization)
finalvirtual

Pushes back a structural organization interpretation.

Exceptions
std::invalid_argumentIf structOrganization == nullptr.
Parameters
[in]structOrganizationThe structural organization interpretation to push back.

Implements resqml2::EarthModelInterpretation.

◆ setStratiColumn()

void resqml2_0_1::EarthModelInterpretation::setStratiColumn ( resqml2::StratigraphicColumn stratiColumn)
finalvirtual

Sets the stratigraphic column.

Exceptions
std::invalid_argumentIf stratiColumn == nullptr.
Parameters
[in]stratiColumnThe stratigraphic column to set.

Implements resqml2::EarthModelInterpretation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::EarthModelInterpretation::XML_NS
static

The standard XML namespace for serializing this data object.


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