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

#include <Wellbore.h>

Inheritance diagram for witsml2_1::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)

Well *	getWell () const
	Gets the well.

	GETTER_DATAOBJECTS (resqml2::WellboreFeature, ResqmlWellboreFeature)

virtual std::string	getXmlTag () const final

void	loadTargetRelationships () final

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	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_NS = "witsml21"

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

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

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] partialObject If 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_argument If witsmlWell == nullptr.

Parameters

[in]	witsmlWell	If non-null, the witsml well.
	guid	The guid to set to this instance. If empty then a new guid will be generated.
	title	The title.
	isActive	True 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_argument If witsmlWell == nullptr.

Parameters

[in]	witsmlWell	If non-null, the witsml well.
	guid	Unique identifier.
	title	The title.
	statusWellbore	The status wellbore.
	isActive	True if is active, false if not.
	achievedTD	True 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] fromGsoap If 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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ setWell()

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

finalvirtual

Sets a well

Parameters

[in,out] witsmlWell If non-null, the witsml well.

Implements WITSML2_NS::Wellbore.

Member Data Documentation

◆ XML_NS

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:

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/witsml2_1/Wellbore.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Wellbore() [1/4]

◆ Wellbore() [2/4]

◆ Wellbore() [3/4]

◆ Wellbore() [4/4]

◆ ~Wellbore()

Member Function Documentation

◆ getWellDor()

◆ getXmlNamespace()

◆ setWell()

Member Data Documentation

◆ XML_NS