witsml2_1::WellboreGeometry Class Reference

#include <WellboreGeometry.h>

Inheritance diagram for witsml2_1::WellboreGeometry:

Public Member Functions
	WellboreGeometry (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	WellboreGeometry (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title, bool isActive)
	Constructor.
	WellboreGeometry (gsoap_eml2_3::witsml21__WellboreGeometry *fromGsoap)
	~WellboreGeometry ()=default
common::DataObjectReference	getWellboreDor () const final
void	setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
double	getWellboreGeometrySectionMdIntervalTop (uint64_t index) const
double	getWellboreGeometrySectionMdIntervalBase (uint64_t index) const
gsoap_eml2_3::eml23__LengthUom	getWellboreGeometrySectionMdIntervalUom (uint64_t index) const
void	setWellboreGeometrySectionTvdInterval (uint64_t index, double top, double base, gsoap_eml2_3::eml23__LengthUom uom)
double	getWellboreGeometrySectionTvdIntervalTop (uint64_t index) const
gsoap_eml2_3::eml23__LengthUom	getWellboreGeometrySectionTvdIntervalUom (uint64_t index) const
double	getWellboreGeometrySectionTvdIntervalBase (uint64_t index) const
bool	hasWellboreGeometrySectionTvdInterval (uint64_t index) const
void	pushBackSection (double top, double base, gsoap_eml2_3::eml23__LengthUom uom, const std::string &uid="")
uint64_t	getSectionCount () const
virtual std::string	getXmlTag () const
std::string	getXmlNamespace () const final
Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual	~WellboreObject ()=default
Wellbore *	getWellbore () const
virtual void	loadTargetRelationships () override

Static Public Attributes
static constexpr char const *	XML_TAG = "WellboreGeometry"
static constexpr char const *	XML_NS = "witsml21"

Detailed Description

Captures information about the configuration of the permanently installed components in a wellbore. It does not define the transient drilling strings (see the Tubular object) or the hanging production components (see the Completion object).

Constructor & Destructor Documentation

WellboreGeometry() [1/3]

witsml2_1::WellboreGeometry::WellboreGeometry ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Constructor for partial transfer

Parameters

[in,out]

partialObject

If non-null, the partial object.

WellboreGeometry() [2/3]

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

Constructor.

Exceptions

std::invalid_argument

If witsmlWellbore == nullptr.

Parameters

[in]	witsmlWellbore	If non-null, the witsml wellbore.
	guid	Unique identifier.
	title	The title.
	isActive	True if is active, false if not.

WellboreGeometry() [3/3]

witsml2_1::WellboreGeometry::WellboreGeometry ( gsoap_eml2_3::witsml21__WellboreGeometry * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~WellboreGeometry()

witsml2_1::WellboreGeometry::~WellboreGeometry ( )

default

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

Member Function Documentation

getSectionCount()

uint64_t witsml2_1::WellboreGeometry::getSectionCount

(

)

const

Get the count of sections in this instance

Returns

the count of sections in this instance.

getWellboreDor()

common::DataObjectReference witsml2_1::WellboreGeometry::getWellboreDor ( ) const

finalvirtual

Get the Data Object Reference of the wellbore linked with this data object.

Implements WITSML2_NS::WellboreObject.

getWellboreGeometrySectionMdIntervalBase()

double witsml2_1::WellboreGeometry::getWellboreGeometrySectionMdIntervalBase

(

uint64_t

index

)

const

Gets wellbore geometry section md interval base

Parameters

index

Zero-based index of the.

Returns

The wellbore geometry section md interval base.

getWellboreGeometrySectionMdIntervalTop()

double witsml2_1::WellboreGeometry::getWellboreGeometrySectionMdIntervalTop

(

uint64_t

index

)

const

Gets wellbore geometry section md interval top

Parameters

index

Zero-based index of the.

Returns

The wellbore geometry section md interval top.

getWellboreGeometrySectionMdIntervalUom()

gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreGeometry::getWellboreGeometrySectionMdIntervalUom

(

uint64_t

index

)

const

Gets wellbore geometry section md interval uom

Parameters

index

Zero-based index of the section.

Returns

The wellbore geometry section md interval uom.

getWellboreGeometrySectionTvdIntervalBase()

double witsml2_1::WellboreGeometry::getWellboreGeometrySectionTvdIntervalBase

(

uint64_t

index

)

const

Gets wellbore geometry section tvd interval base

Parameters

index

Zero-based index of the section.

Returns

The wellbore geometry section tvd interval base.

getWellboreGeometrySectionTvdIntervalTop()

double witsml2_1::WellboreGeometry::getWellboreGeometrySectionTvdIntervalTop

(

uint64_t

index

)

const

Gets wellbore geometry section tvd interval top

Parameters

index

Zero-based index of the section.

Returns

The wellbore geometry section tvd interval top.

getWellboreGeometrySectionTvdIntervalUom()

gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreGeometry::getWellboreGeometrySectionTvdIntervalUom

(

uint64_t

index

)

const

Gets wellbore geometry section tvd interval uom

Parameters

index

Zero-based index of the.

Returns

The wellbore geometry section tvd interval uom.

getXmlNamespace()

std::string witsml2_1::WellboreGeometry::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

getXmlTag()

virtual std::string witsml2_1::WellboreGeometry::getXmlTag ( ) const

inlinevirtual

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

Returns

The XML tag.

hasWellboreGeometrySectionTvdInterval()

bool witsml2_1::WellboreGeometry::hasWellboreGeometrySectionTvdInterval

(

uint64_t

index

)

const

Query if 'index' has wellbore geometry section tvd interval

Parameters

index

Zero-based index of the section.

Returns

True if wellbore geometry section tvd interval, false if not.

pushBackSection()

void witsml2_1::WellboreGeometry::pushBackSection	(	double	top,
		double	base,
		gsoap_eml2_3::eml23__LengthUom	uom,
		const std::string &	uid = "" )

Push back an empty section into the instance.

Parameters

top	The MD top.
base	The MD base.
uom	The MD uom.
uid	(Optional) The UID.

setWellbore()

void witsml2_1::WellboreGeometry::setWellbore ( WITSML2_NS::Wellbore * witsmlWellbore )

finalvirtual

Set the wellbore linked with this data object.

Parameters

[in,out]

witsmlWellbore

If non-null, the witsml wellbore.

Implements WITSML2_NS::WellboreObject.

setWellboreGeometrySectionTvdInterval()

void witsml2_1::WellboreGeometry::setWellboreGeometrySectionTvdInterval	(	uint64_t	index,
		double	top,
		double	base,
		gsoap_eml2_3::eml23__LengthUom	uom )

Sets wellbore geometry section tvd interval

Parameters

index	Zero-based index of the.
top	The top.
base	The base.
datum	The datum.
uom	The uom.

Member Data Documentation

XML_NS

constexpr char const* witsml2_1::WellboreGeometry::XML_NS = "witsml21"

staticconstexpr

The standard XML namespace for serializing this data object.

XML_TAG

constexpr char const* witsml2_1::WellboreGeometry::XML_TAG = "WellboreGeometry"

staticconstexpr

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

Returns

The XML tag.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/witsml2_1/WellboreGeometry.h