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_2::GeobodyInterpretation Class Referencefinal

#include <GeobodyInterpretation.h>

Inheritance diagram for resqml2_2::GeobodyInterpretation:
resqml2::GeobodyInterpretation resqml2::AbstractFeatureInterpretation common::AbstractObject

Public Member Functions

 GeobodyInterpretation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 GeobodyInterpretation (resqml2::RockVolumeFeature *feature, const std::string &guid, const std::string &title)
 Creates an instance of this class in a gsoap context.
 
 GeobodyInterpretation (gsoap_eml2_3::_resqml22__GeobodyInterpretation *fromGsoap)
 
 ~GeobodyInterpretation ()=default
 
void set3dShape (gsoap_eml2_3::resqml22__Shape3d geobody3dShape) final
 
bool has3dShape () const final
 
gsoap_eml2_3::resqml22__Shape3d get3dShape () const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::GeobodyInterpretation
virtual std::string getXmlTag () const final
 
- 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
 
virtual void loadTargetRelationships () override
 
- 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
 
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 ()
 

Static Public Attributes

static const char * XML_NS
 
- Static Public Attributes inherited from resqml2::GeobodyInterpretation
static constexpr char const * XML_TAG = "GeobodyInterpretation"
 

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

A geobody interpretation.

Constructor & Destructor Documentation

◆ GeobodyInterpretation() [1/3]

resqml2_2::GeobodyInterpretation::GeobodyInterpretation ( 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.

◆ GeobodyInterpretation() [2/3]

resqml2_2::GeobodyInterpretation::GeobodyInterpretation ( resqml2::RockVolumeFeature * feature,
const std::string & guid,
const std::string & title )

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf feature == nullptr.
Parameters
[in]featureThe 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.

◆ GeobodyInterpretation() [3/3]

resqml2_2::GeobodyInterpretation::GeobodyInterpretation ( gsoap_eml2_3::_resqml22__GeobodyInterpretation * fromGsoap)
inline

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

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

◆ ~GeobodyInterpretation()

resqml2_2::GeobodyInterpretation::~GeobodyInterpretation ( )
virtualdefault

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

Reimplemented from resqml2::GeobodyInterpretation.

Member Function Documentation

◆ get3dShape()

gsoap_eml2_3::resqml22__Shape3d resqml2_2::GeobodyInterpretation::get3dShape ( ) const
finalvirtual

Gets the 3d shape of this geobody.

Exceptions
std::invalid_argumentIf the 3d shape of this geobody is unknown. Please use has3dShape().
Returns
The 3D shape of this geobody.

Implements resqml2::GeobodyInterpretation.

◆ getXmlNamespace()

std::string resqml2_2::GeobodyInterpretation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ has3dShape()

bool resqml2_2::GeobodyInterpretation::has3dShape ( ) const
finalvirtual

Checks if the 3d shape of this geobody is known.

Returns
True if the 3d shape is known, false if not.

Implements resqml2::GeobodyInterpretation.

◆ set3dShape()

void resqml2_2::GeobodyInterpretation::set3dShape ( gsoap_eml2_3::resqml22__Shape3d geobody3dShape)
finalvirtual

Sets the geobody 3d shape.

Parameters
geobody3dShapeThe geobody 3d shape to push.

Implements resqml2::GeobodyInterpretation.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::GeobodyInterpretation::XML_NS
static

The standard XML namespace for serializing this data object.


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