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::WellboreFeature Class Referencefinal

#include <WellboreFeature.h>

Inheritance diagram for resqml2_2::WellboreFeature:
resqml2::WellboreFeature resqml2::AbstractTechnicalFeature resqml2::AbstractFeature common::AbstractObject

Public Member Functions

 WellboreFeature (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 WellboreFeature (common::DataObjectRepository *repo, const std::string &guid, const std::string &title)
 
 WellboreFeature (gsoap_eml2_3::_resqml22__WellboreFeature *fromGsoap)
 
 ~WellboreFeature ()=default
 
common::DataObjectReference getWitsmlWellboreDor () const final
 
void setWitsmlWellbore (WITSML2_NS::Wellbore *wellbore) final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::WellboreFeature
 WellboreFeature (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 WellboreFeature (gsoap_resqml2_0_1::_resqml20__WellboreFeature *fromGsoap)
 
 WellboreFeature (gsoap_eml2_3::_resqml22__WellboreFeature *fromGsoap)
 
WITSML2_NS::WellboregetWitsmlWellbore () const
 
void loadTargetRelationships () final
 
virtual std::string getXmlTag () const final
 
- Public Member Functions inherited from resqml2::AbstractTechnicalFeature
virtual ~AbstractTechnicalFeature ()=default
 
- Public Member Functions inherited from resqml2::AbstractFeature
virtual ~AbstractFeature ()=default
 
std::vector< AbstractFeatureInterpretation * > getInterpretationSet () const
 
uint64_t getInterpretationCount () const noexcept
 
AbstractFeatureInterpretationgetInterpretation (uint64_t 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)
 
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 constexpr char const * XML_NS = "resqml22"
 
- Static Public Attributes inherited from resqml2::WellboreFeature
static constexpr char const * XML_TAG = "WellboreFeature"
 

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

Proxy class for a wellbore feature.

Constructor & Destructor Documentation

◆ WellboreFeature() [1/3]

resqml2_2::WellboreFeature::WellboreFeature ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject)
inline

Only to be used in partial transfer context.

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

◆ WellboreFeature() [2/3]

resqml2_2::WellboreFeature::WellboreFeature ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title )

Creates a wellbore feature.

Exceptions
std::invalid_argumentIf repo si nullptr.
Parameters
[in,out]repoA repository which will manage the memory of this instance.
guidThe guid to set to the wellbore feature. If empty then a new guid will be generated.
titleThe title to set to the wellbore feature. If empty then "unknown" title will be set.

◆ WellboreFeature() [3/3]

resqml2_2::WellboreFeature::WellboreFeature ( gsoap_eml2_3::_resqml22__WellboreFeature * fromGsoap)
inline

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

Parameters
[in]fromGsoapIf non-null, the gSOAP instance.

◆ ~WellboreFeature()

resqml2_2::WellboreFeature::~WellboreFeature ( )
virtualdefault

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

Reimplemented from resqml2::WellboreFeature.

Member Function Documentation

◆ getWitsmlWellboreDor()

common::DataObjectReference resqml2_2::WellboreFeature::getWitsmlWellboreDor ( ) const
finalvirtual

Gets the associated WITSML wellbore data object reference.

Returns
Empty data object reference if no WITSML wellbore is associated to this interpretation. Otherwise return the data objet reference of the associated WITSML wellbore.

Implements resqml2::WellboreFeature.

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setWitsmlWellbore()

void resqml2_2::WellboreFeature::setWitsmlWellbore ( WITSML2_NS::Wellbore * wellbore)
finalvirtual

Sets the WITSML wellbore associated to this instance.

Exceptions
std::invalid_argumentIf the WITSML wellbore to set is NULL.
Parameters
[in]wellboreThe WITSML wellbore to associate to this wellbore. It cannot be null.

Implements resqml2::WellboreFeature.

Member Data Documentation

◆ XML_NS

char const* resqml2_2::WellboreFeature::XML_NS = "resqml22"
staticconstexpr

The standard XML namespace for serializing this data object.


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