May refer to one of these: wellbore, borehole or sidetrack. More...

#include <WellboreFeature.h>

Inheritance diagram for resqml2::WellboreFeature:

Public Member Functions
	WellboreFeature (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	WellboreFeature (gsoap_resqml2_0_1::_resqml20__WellboreFeature *fromGsoap)

	WellboreFeature (gsoap_eml2_3::_resqml22__WellboreFeature *fromGsoap)

virtual	~WellboreFeature ()=default

virtual common::DataObjectReference	getWitsmlWellboreDor () const =0

WITSML2_NS::Wellbore *	getWitsmlWellbore () const

virtual void	setWitsmlWellbore (WITSML2_NS::Wellbore *wellbore)=0

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

AbstractFeatureInterpretation *	getInterpretation (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::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespace () 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::Activity *	getActivity (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_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

May refer to one of these: wellbore, borehole or sidetrack.

        Wellbore: a unique, oriented path from the bottom of a drilled borehole to the
        surface of the earth. The path must not overlap or cross itself.

        Borehole: a hole excavated in the earth as a result of drilling or boring operations.
        The borehole may represent the hole of an entire wellbore (when no sidetracks are
        present), or a sidetrack extension. A borehole extends from an originating point (the
        surface location for the initial borehole or kickoff point for sidetracks) to a
        terminating (bottomhole) point.

        Sidetrack: a borehole that originates in another borehole as opposed to originating
        at the surface.

Constructor & Destructor Documentation

◆ WellboreFeature() [1/3]

resqml2::WellboreFeature::WellboreFeature ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context.

Parameters

[in] partialObject If non-nullptr, the partial object.

◆ WellboreFeature() [2/3]

resqml2::WellboreFeature::WellboreFeature ( gsoap_resqml2_0_1::_resqml20__WellboreFeature * fromGsoap )

inline

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

Parameters

[in] fromGsoap If non-null, the gSOAP instance.

◆ WellboreFeature() [3/3]

resqml2::WellboreFeature::WellboreFeature ( gsoap_eml2_3::_resqml22__WellboreFeature * fromGsoap )

inline

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

Parameters

[in] fromGsoap If non-null, the gSOAP instance.

◆ ~WellboreFeature()

virtual resqml2::WellboreFeature::~WellboreFeature ( )

virtualdefault

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

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

Member Function Documentation

◆ getWitsmlWellbore()

WITSML2_NS::Wellbore * resqml2::WellboreFeature::getWitsmlWellbore ( ) const

Gets the WITSML wellbore associated to this wellbore feature.

Exceptions

std::logic_error If more than one WITSML wellbore is associated to this wellbore feature.

Returns: nullptr if no WITSML wellbore is associated to this wellbore feature, else the associated WITSML wellbore.

◆ getWitsmlWellboreDor()

virtual common::DataObjectReference resqml2::WellboreFeature::getWitsmlWellboreDor ( ) const

pure virtual

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.

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

◆ getXmlTag()

virtual std::string resqml2::WellboreFeature::getXmlTag ( ) const

inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns: The XML tag.

Implements common::AbstractObject.

◆ loadTargetRelationships()

void resqml2::WellboreFeature::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Reimplemented from resqml2::AbstractFeature.

◆ setWitsmlWellbore()

virtual void resqml2::WellboreFeature::setWitsmlWellbore ( WITSML2_NS::Wellbore * wellbore )

pure virtual

Sets the WITSML wellbore associated to this instance.

Exceptions

std::invalid_argument If the WITSML wellbore to set is NULL.

Parameters

[in] wellbore The WITSML wellbore to associate to this wellbore. It cannot be null.

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

Member Data Documentation

◆ XML_TAG

char const* resqml2::WellboreFeature::XML_TAG = "WellboreFeature"

staticconstexpr

The standard XML tag without XML namespace for serializing this data object.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2/WellboreFeature.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WellboreFeature() [1/3]

◆ WellboreFeature() [2/3]

◆ WellboreFeature() [3/3]

◆ ~WellboreFeature()

Member Function Documentation

◆ getWitsmlWellbore()

◆ getWitsmlWellboreDor()

◆ getXmlTag()

◆ loadTargetRelationships()

◆ setWitsmlWellbore()

Member Data Documentation

◆ XML_TAG