Fesapi 2.9.0.1
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | List of all members
witsml2_1::Wellbore Class Reference

A wellbore represents the path from surface to a unique bottomhole location. More...

#include <Wellbore.h>

Inheritance diagram for witsml2_1::Wellbore:
WITSML2_NS::Wellbore

Public Member Functions

 Wellbore (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 Wellbore (WITSML2_NS::Well *witsmlWell, const std::string &guid, const std::string &title, bool isActive)
 Creates an instance of this class in a gsoap context.
 
 Wellbore (WITSML2_NS::Well *witsmlWell, const std::string &guid, const std::string &title, gsoap_eml2_3::eml23__WellStatus statusWellbore, bool isActive, bool achievedTD)
 Constructor.
 
 Wellbore (gsoap_eml2_3::witsml21__Wellbore *fromGsoap)
 
 ~Wellbore ()=default
 
common::DataObjectReference getWellDor () const final
 Gets well dor.
 
void setWell (WITSML2_NS::Well *witsmlWell) final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from WITSML2_NS::Wellbore
 Wellbore (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
WellgetWell () const
 Gets the well.
 
 GETTER_DATAOBJECTS (resqml2 ::WellboreFeature, ResqmlWellboreFeature)
 
virtual std::string getXmlTag () const final
 
void loadTargetRelationships () final
 

Static Public Attributes

static constexpr char const * XML_NS = "witsml21"
 
- Static Public Attributes inherited from WITSML2_NS::Wellbore
static constexpr char const * XML_TAG = "Wellbore"
 

Detailed Description

A wellbore represents the path from surface to a unique bottomhole location.

Constructor & Destructor Documentation

◆ Wellbore() [1/4]

witsml2_1::Wellbore::Wellbore ( 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.

◆ Wellbore() [2/4]

witsml2_1::Wellbore::Wellbore ( WITSML2_NS::Well * witsmlWell,
const std::string & guid,
const std::string & title,
bool isActive )

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf witsmlWell == nullptr.
Parameters
[in]witsmlWellIf non-null, the witsml well.
guidThe guid to set to this instance. If empty then a new guid will be generated.
titleThe title.
isActiveTrue if is active, false if not.

◆ Wellbore() [3/4]

witsml2_1::Wellbore::Wellbore ( WITSML2_NS::Well * witsmlWell,
const std::string & guid,
const std::string & title,
gsoap_eml2_3::eml23__WellStatus statusWellbore,
bool isActive,
bool achievedTD )

Constructor.

Exceptions
std::invalid_argumentIf witsmlWell == nullptr.
Parameters
[in]witsmlWellIf non-null, the witsml well.
guidUnique identifier.
titleThe title.
statusWellboreThe status wellbore.
isActiveTrue if is active, false if not.
achievedTDTrue to achieved td.

◆ Wellbore() [4/4]

witsml2_1::Wellbore::Wellbore ( gsoap_eml2_3::witsml21__Wellbore * fromGsoap)
inline

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

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

◆ ~Wellbore()

witsml2_1::Wellbore::~Wellbore ( )
virtualdefault

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

Reimplemented from WITSML2_NS::Wellbore.

Member Function Documentation

◆ getWellDor()

common::DataObjectReference witsml2_1::Wellbore::getWellDor ( ) const
finalvirtual

Gets well dor.

Returns
The well dor.

Implements WITSML2_NS::Wellbore.

◆ getXmlNamespace()

std::string witsml2_1::Wellbore::getXmlNamespace ( ) const
inlinefinal

Get the standard XML namespace for serializing this data object.

◆ setWell()

void witsml2_1::Wellbore::setWell ( WITSML2_NS::Well * witsmlWell)
finalvirtual

Sets a well

Parameters
[in,out]witsmlWellIf non-null, the witsml well.

Implements WITSML2_NS::Wellbore.

Member Data Documentation

◆ XML_NS

constexpr char const* witsml2_1::Wellbore::XML_NS = "witsml21"
staticconstexpr

The standard XML namespace for serializing this data object.


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