Fesapi 2.10.1.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
resqml2::RockFluidOrganizationInterpretation Class Referenceabstract

This class describes the organization of geological reservoir, i.e., of an interconnected network of porous and permeable rock units, containing an accumulation of economic fluids, such as oil and gas. A reservoir is normally enveloped by rock and fluid barriers and contains a single natural pressure system. More...

#include <RockFluidOrganizationInterpretation.h>

Inheritance diagram for resqml2::RockFluidOrganizationInterpretation:
resqml2::AbstractOrganizationInterpretation resqml2::AbstractFeatureInterpretation common::AbstractObject resqml2_0_1::RockFluidOrganizationInterpretation resqml2_2::RockFluidOrganizationInterpretation

Public Member Functions

virtual ~RockFluidOrganizationInterpretation ()=default
 
bool isRockFluid () const final
 
std::vector< AbstractGridRepresentation * > getGridRepresentationSet () const
 
uint64_t getGridRepresentationCount () const
 
AbstractGridRepresentationgetGridRepresentation (uint64_t index) const
 
bool isAssociatedToGridRepresentation (AbstractGridRepresentation *gridRep) const
 
virtual void pushBackRockFluidUnitInterpretation (class RockFluidUnitInterpretation *rockFluidUnitInterpretation)=0
 
virtual uint64_t getRockFluidUnitInterpCount () const =0
 
virtual common::DataObjectReference getRockFluidUnitInterpretationDor (uint64_t index) const =0
 
class RockFluidUnitInterpretationgetRockFluidUnitInterpretation (uint64_t index) const
 
- Public Member Functions inherited from resqml2::AbstractOrganizationInterpretation
virtual ~AbstractOrganizationInterpretation ()=default
 
virtual bool isStructural () const
 
virtual bool isStratigraphic () 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 getXmlNamespace () const =0
 
virtual std::string getXmlTag () 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)
 
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
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (unsigned int index) const
 
std::string getExtraMetadataStringValueAtIndex (unsigned int index) const
 
std::string buildEtp12Uri () const
 
void setUriSource (const std::string &uriSource)
 
const std::string & getUriSource () const
 
std::string getEpcSourceFolder () const
 
void changeToPartialObject ()
 

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 describes the organization of geological reservoir, i.e., of an interconnected network of porous and permeable rock units, containing an accumulation of economic fluids, such as oil and gas. A reservoir is normally enveloped by rock and fluid barriers and contains a single natural pressure system.

Constructor & Destructor Documentation

◆ ~RockFluidOrganizationInterpretation()

virtual resqml2::RockFluidOrganizationInterpretation::~RockFluidOrganizationInterpretation ( )
virtualdefault

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

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

Member Function Documentation

◆ getGridRepresentation()

AbstractGridRepresentation * resqml2::RockFluidOrganizationInterpretation::getGridRepresentation ( uint64_t index) const

Gets a grid representation associated to this rock fluid organization by means of its index.

Exceptions
std::out_of_rangeIf index >= getGridRepresentationCount().
Parameters
indexZero-based index of the grid representation to get in the array of grid representations of this rock fluid organization.
Returns
The associated grid representation at position index.

◆ getGridRepresentationCount()

uint64_t resqml2::RockFluidOrganizationInterpretation::getGridRepresentationCount ( ) const

Gets the count of grid representations associated to this rock fluid organization.

Exceptions
std::range_errorIf the count of associated grid representations is strictly greater than unsigned int max.
Returns
The count of grid representations associated to this rock fluid organization.

◆ getGridRepresentationSet()

std::vector< AbstractGridRepresentation * > resqml2::RockFluidOrganizationInterpretation::getGridRepresentationSet ( ) const

Gets the set of grid representations associated to this rock fluid organization.

Returns
A vector of pointers to the grid representations associated to this rock fluid organization.

◆ getRockFluidUnitInterpCount()

virtual uint64_t resqml2::RockFluidOrganizationInterpretation::getRockFluidUnitInterpCount ( ) const
pure virtual

Gets the count of rock fluid unit interpretations of this rock fluid organization.

Returns
The count of rock fluid unit interpretations of this rock fluid organization.

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

◆ getRockFluidUnitInterpretation()

class RockFluidUnitInterpretation * resqml2::RockFluidOrganizationInterpretation::getRockFluidUnitInterpretation ( uint64_t index) const

Gets a rock fluid unit interpretation of this rock fluid organization by means of its index.

Exceptions
std::out_of_rangeIf index >= getRockFluidUnitInterpCount().
Parameters
indexZero-based index of the rock fluid unit interpretation we look for.
Returns
The rock fluid unit interpretation at position index.

◆ getRockFluidUnitInterpretationDor()

virtual common::DataObjectReference resqml2::RockFluidOrganizationInterpretation::getRockFluidUnitInterpretationDor ( uint64_t index) const
pure virtual

Gets the DOR of a rock fluid unit interpretation of this rock fluid organization by means of its index.

Exceptions
std::out_of_rangeIf index >= getRockFluidUnitInterpCount().
Parameters
indexZero-based index of the rock fluid unit interpretation for which we look for the DOR.
Returns
The DOR of the rock fluid unit interpretation at position index.

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

◆ isAssociatedToGridRepresentation()

bool resqml2::RockFluidOrganizationInterpretation::isAssociatedToGridRepresentation ( AbstractGridRepresentation * gridRep) const

Checks whether a given grid representation is associated to this rock fluid organization.

Parameters
[in]gridRepThe grid representation for which we want to know if it is associated to this rock fluid organization.
Returns
True if gridRep is associated to this rock fluid organization, false if not.

◆ isRockFluid()

bool resqml2::RockFluidOrganizationInterpretation::isRockFluid ( ) const
inlinefinalvirtual

Indicates if this instance is a structural one. Needed by SWIG wrappers.

Reimplemented from resqml2::AbstractOrganizationInterpretation.

◆ pushBackRockFluidUnitInterpretation()

virtual void resqml2::RockFluidOrganizationInterpretation::pushBackRockFluidUnitInterpretation ( class RockFluidUnitInterpretation * rockFluidUnitInterpretation)
pure virtual

Pushes back a rock fluid unit interpretation in this rock fluid organization.

Exceptions
std::invalid_argumentIf rockFluidUnitInterpretation == nullptr.
Parameters
[in]rockFluidUnitInterpretationThe rock fluid unit interpretation to push back.

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


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