resqml2::WellboreFeature Class Reference

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

Static Public Attributes
static constexpr char const *	XML_TAG = "WellboreFeature"

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.

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.

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.

Member Data Documentation

XML_TAG

constexpr 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.9.0.1/src/resqml2/WellboreFeature.h