#include <WellboreCompletion.h>

Inheritance diagram for witsml2_1::WellboreCompletion:

Public Types
enum class	WellReservoirConnectionType { PERFORATION = 0 , GRAVEL_PACK = 1 , OPEN_HOLE = 2 , SLOTS = 3 }
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 }

Public Member Functions
	WellboreCompletion (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	WellboreCompletion (WITSML2_NS::Wellbore *witsmlWellbore, const std::string &guid, const std::string &title)
	WellboreCompletion (gsoap_eml2_3::witsml21__WellboreCompletion *fromGsoap)
	~WellboreCompletion ()=default
common::DataObjectReference	getWellboreDor () const final
common::DataObjectReference	getWellCompletionDor () const
class WellCompletion *	getWellCompletion () const
void	setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
void	setWellCompletion (class WellCompletion *wellCompletion)
void	pushBackConnection (WellReservoirConnectionType wellReservoirConnection, gsoap_eml2_3::eml23__LengthUom MdUnit, double TopMd, double BaseMd, const std::string &uid)
void	pushBackConnectionExtraMetadata (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &key, const std::string &value)
void	pushBackConnectionHistory (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &historyGuid="")
void	pushBackConnectionHistory (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::witsml21__PhysicalStatus staus, time_t startDate, const std::string &historyGuid="")
uint64_t	getConnectionCount (WellReservoirConnectionType wellReservoirConnection) const
std::string	getConnectionUid (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
std::vector< std::string >	getConnectionExtraMetadata (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &key) const
bool	hasConnectionMdDatum (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
bool	hasConnectionMdInterval (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
gsoap_eml2_3::eml23__LengthUom	getConnectionMdUnit (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
std::string	getConnectionMdUnitAsString (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
double	getConnectionTopMd (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
double	getConnectionBaseMd (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
uint64_t	getConnectionHistoryCount (WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
bool	hasConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
gsoap_eml2_3::witsml21__PhysicalStatus	getConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
std::string	getConnectionHistoryStatusToString (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
void	setConnectionHistoryStatus (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::witsml21__PhysicalStatus connectionStatus)
bool	hasConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
time_t	getConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
void	setConnectionHistoryStartDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t startDate) const
bool	hasConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
time_t	getConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
void	setConnectionHistoryEndDate (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, time_t endDate) const
bool	hasConnectionHistoryMdDatum (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
bool	hasConnectionHistoryMdInterval (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
gsoap_eml2_3::eml23__LengthUom	getConnectionHistoryMdUnit (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
std::string	getConnectionHistoryMdUnitAsString (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
double	getConnectionHistoryTopMd (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
void	setConnectionHistoryMdInterval (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, gsoap_eml2_3::eml23__LengthUom MdUnit, double TopMd, double baseMd)
double	getConnectionHistoryBaseMd (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
bool	hasConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
std::string	getConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex) const
void	setConnectionHistoryComment (uint64_t historyIndex, WellReservoirConnectionType wellReservoirConnection, uint64_t connectionIndex, const std::string &comment)
virtual std::string	getXmlTag () const
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final
Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual	~WellboreObject ()=default
Wellbore *	getWellbore () 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	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
uint64_t	getExtraMetadataCount () const
std::string	getExtraMetadataKeyAtIndex (uint64_t index) const
std::string	getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string	buildEtp12Uri () const
void	setUriSource (const std::string &uriSource)
const std::string &	getUriSource () const
std::string	getEpcSourceFolder () const
void	changeToPartialObject ()
template<>
int8_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int8_t arrayOutput) const
template<>
uint8_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint8_t arrayOutput) const
template<>
int16_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int16_t arrayOutput) const
template<>
uint16_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint16_t arrayOutput) const
template<>
int32_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int32_t arrayOutput) const
template<>
uint32_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint32_t arrayOutput) const
template<>
int64_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, int64_t arrayOutput) const
template<>
uint64_t	readArrayNdOfIntegerValues (gsoap_resqml2_0_1::resqml20__AbstractValueArray const arrayInput, uint64_t arrayOutput) const
template<>
int8_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int8_t arrayOutput) const
template<>
uint8_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint8_t arrayOutput) const
template<>
int16_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int16_t arrayOutput) const
template<>
uint16_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint16_t arrayOutput) const
template<>
int32_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int32_t arrayOutput) const
template<>
uint32_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint32_t arrayOutput) const
template<>
int64_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, int64_t arrayOutput) const
template<>
uint64_t	readArrayNdOfIntegerValues (gsoap_eml2_3::eml23__AbstractValueArray const arrayInput, uint64_t arrayOutput) const

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

Additional Inherited Members
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

The location/interval of the connections between well and reservoir and its history.

Member Enumeration Documentation

◆ WellReservoirConnectionType

enum class witsml2_1::WellboreCompletion::WellReservoirConnectionType

strong

The physical nature of a connection from reservoir to wellbore

Constructor & Destructor Documentation

◆ WellboreCompletion() [1/3]

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

◆ WellboreCompletion() [2/3]

witsml2_1::WellboreCompletion::WellboreCompletion	(	WITSML2_NS::Wellbore *	witsmlWellbore,
		const std::string &	guid,
		const std::string &	title )

Constructor

Parameters

[in,out]	witsmlWellbore	If non-null, the witsml wellbore.
	guid	Unique identifier.
	title	The title.

◆ WellboreCompletion() [3/3]

witsml2_1::WellboreCompletion::WellboreCompletion ( gsoap_eml2_3::witsml21__WellboreCompletion * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~WellboreCompletion()

witsml2_1::WellboreCompletion::~WellboreCompletion ( )

default

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

Member Function Documentation

◆ getConnectionBaseMd()

double witsml2_1::WellboreCompletion::getConnectionBaseMd	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection base md

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection base md.

◆ getConnectionCount()

uint64_t witsml2_1::WellboreCompletion::getConnectionCount ( WellReservoirConnectionType wellReservoirConnection ) const

Gets connection count of a certin type

Parameters

wellReservoirConnection The physical nature of the connections to count

Returns: The connection count of type wellReservoirConnection in this completion.

◆ getConnectionExtraMetadata()

std::vector< std::string > witsml2_1::WellboreCompletion::getConnectionExtraMetadata	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		const std::string &	key ) const

Gets an extra metadata of a particular connection according to its key

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.
key	The key of an extra metadata.

Returns: The vector of all metadata values sharing this key (empty vector if there is no such value) in the connection at index.

◆ getConnectionHistoryBaseMd()

double witsml2_1::WellboreCompletion::getConnectionHistoryBaseMd	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history base md

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history base md.

◆ getConnectionHistoryComment()

std::string witsml2_1::WellboreCompletion::getConnectionHistoryComment	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history comment

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history comment.

◆ getConnectionHistoryCount()

uint64_t witsml2_1::WellboreCompletion::getConnectionHistoryCount	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history count

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection history count.

◆ getConnectionHistoryEndDate()

time_t witsml2_1::WellboreCompletion::getConnectionHistoryEndDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history end date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history end date.

◆ getConnectionHistoryMdUnit()

gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreCompletion::getConnectionHistoryMdUnit	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Returns md base uom if exists, else returns md top uom. Raises an exception if no md is defined.

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history md unit.

◆ getConnectionHistoryMdUnitAsString()

std::string witsml2_1::WellboreCompletion::getConnectionHistoryMdUnitAsString	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Returns md base uom (as string) if exists, else returns md top uom (as string). Raises an exception if no md is defined.

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history md unit as string.

◆ getConnectionHistoryStartDate()

time_t witsml2_1::WellboreCompletion::getConnectionHistoryStartDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history start date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history start date.

◆ getConnectionHistoryStatus()

gsoap_eml2_3::witsml21__PhysicalStatus witsml2_1::WellboreCompletion::getConnectionHistoryStatus	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history status

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection history status.

◆ getConnectionHistoryStatusToString()

std::string witsml2_1::WellboreCompletion::getConnectionHistoryStatusToString	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history status to string

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection history status to string.

◆ getConnectionHistoryTopMd()

double witsml2_1::WellboreCompletion::getConnectionHistoryTopMd	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection history top md

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: The connection history top md.

◆ getConnectionMdUnit()

gsoap_eml2_3::eml23__LengthUom witsml2_1::WellboreCompletion::getConnectionMdUnit	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Returns md base uom if exists, else returns md top uom. Raises an exception if no md is defined.

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection md unit.

◆ getConnectionMdUnitAsString()

std::string witsml2_1::WellboreCompletion::getConnectionMdUnitAsString	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Returns md base uom (as string) if exists, else returns md top uom (as string). Raises an exception if no md is defined.

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection md unit as string.

◆ getConnectionTopMd()

double witsml2_1::WellboreCompletion::getConnectionTopMd	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets connection top md

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection top md.

◆ getConnectionUid()

std::string witsml2_1::WellboreCompletion::getConnectionUid	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Gets the UID of the connection of a particular type at a particular index

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: The connection UIDs of the completion.

◆ getWellboreDor()

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

finalvirtual

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

Implements WITSML2_NS::WellboreObject.

◆ getWellCompletion()

class WellCompletion * witsml2_1::WellboreCompletion::getWellCompletion ( ) const

Get the well completion linked with this data object

◆ getWellCompletionDor()

common::DataObjectReference witsml2_1::WellboreCompletion::getWellCompletionDor ( ) const

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

◆ getXmlNamespace()

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

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

inlinevirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ hasConnectionHistoryComment()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryComment	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history comment

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: True if connection history comment, false if not.

◆ hasConnectionHistoryEndDate()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryEndDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history end date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: True if connection history end date, false if not.

◆ hasConnectionHistoryMdDatum()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryMdDatum	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history md datum

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: True if connection history md datum, false if not.

◆ hasConnectionHistoryMdInterval()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryMdInterval	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history MD interval

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.

Returns: True if connection history has MD interval, false if not.

◆ hasConnectionHistoryStartDate()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryStartDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history start date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: True if connection history start date, false if not.

◆ hasConnectionHistoryStatus()

bool witsml2_1::WellboreCompletion::hasConnectionHistoryStatus	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'historyIndex' has connection history status

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: True if connection history status, false if not.

◆ hasConnectionMdDatum()

bool witsml2_1::WellboreCompletion::hasConnectionMdDatum	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'index' has connection md datum

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: True if connection md datum, false if not.

◆ hasConnectionMdInterval()

bool witsml2_1::WellboreCompletion::hasConnectionMdInterval	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex ) const

Query if 'index' has connection Md interval

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.

Returns: True if connection has Md interval, false if not.

◆ loadTargetRelationships()

void witsml2_1::WellboreCompletion::loadTargetRelationships ( )

finalvirtual

Resolve all relationships of the object in an epc document.

Reimplemented from WITSML2_NS::WellboreObject.

◆ pushBackConnection()

void witsml2_1::WellboreCompletion::pushBackConnection	(	WellReservoirConnectionType	wellReservoirConnection,
		gsoap_eml2_3::eml23__LengthUom	MdUnit,
		double	TopMd,
		double	BaseMd,
		const std::string &	uid )

Pushes back a connection

Parameters

wellReservoirConnection	The physical nature of the connection from reservoir to wellbore to add
MdUnit	The md unit.
TopMd	The top md.
BaseMd	The base md.
guid	Unique identifier of the connection.

◆ pushBackConnectionExtraMetadata()

void witsml2_1::WellboreCompletion::pushBackConnectionExtraMetadata	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		const std::string &	key,
		const std::string &	value )

Pushes back connection extra metadata

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.
key	The key of the metadata.
value	The value of the metadata.

◆ pushBackConnectionHistory() [1/2]

void witsml2_1::WellboreCompletion::pushBackConnectionHistory	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		const std::string &	historyGuid = "" )

Pushes a back perforaconnectiontion history

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.
historyGuid	(Optional) Unique identifier.

◆ pushBackConnectionHistory() [2/2]

void witsml2_1::WellboreCompletion::pushBackConnectionHistory	(	WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		gsoap_eml2_3::witsml21__PhysicalStatus	staus,
		time_t	startDate,
		const std::string &	historyGuid = "" )

Pushes back connection history

Parameters

wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.
status	The connection status.
startDate	The start date.
historyGuid	(Optional) Unique identifier.

◆ setConnectionHistoryComment()

void witsml2_1::WellboreCompletion::setConnectionHistoryComment	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		const std::string &	comment )

Sets connection history comment

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.
comment	The comment.

◆ setConnectionHistoryEndDate()

void witsml2_1::WellboreCompletion::setConnectionHistoryEndDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		time_t	endDate ) const

Sets connection history end date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.
endDate	The end date.

◆ setConnectionHistoryMdInterval()

void witsml2_1::WellboreCompletion::setConnectionHistoryMdInterval	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		gsoap_eml2_3::eml23__LengthUom	MdUnit,
		double	TopMd,
		double	baseMd )

Connection history datum is overwritten if exists. For instance if a base md is already defined.

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.
MdUnit	The md unit.
TopMd	The top md.
BaseMd	The base md.

◆ setConnectionHistoryStartDate()

void witsml2_1::WellboreCompletion::setConnectionHistoryStartDate	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		time_t	startDate ) const

Sets connection history start date

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	Zero-based index of the connection.
startDate	The start date.

◆ setConnectionHistoryStatus()

void witsml2_1::WellboreCompletion::setConnectionHistoryStatus	(	uint64_t	historyIndex,
		WellReservoirConnectionType	wellReservoirConnection,
		uint64_t	connectionIndex,
		gsoap_eml2_3::witsml21__PhysicalStatus	connectionStatus )

Sets connection history status

Parameters

historyIndex	Zero-based index of the history.
wellReservoirConnection	The physical nature of the connection
connectionIndex	The index of the connection in the array of type wellReservoirConnection.
connectionStatus	The connection status.

◆ setWellbore()

void witsml2_1::WellboreCompletion::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.

◆ setWellCompletion()

void witsml2_1::WellboreCompletion::setWellCompletion ( class WellCompletion * wellCompletion )

Set the well completion linked with this data object

Parameters

[in,out] wellCompletion If non-null, the well completion.

Member Data Documentation

◆ XML_NS

char const* witsml2_1::WellboreCompletion::XML_NS = "witsml21"

staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

char const* witsml2_1::WellboreCompletion::XML_TAG = "WellboreCompletion"

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/phili/dev/fesapi/fesapi-2.14.0.0/src/witsml2_1/WellboreCompletion.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ WellReservoirConnectionType

Constructor & Destructor Documentation

◆ WellboreCompletion() [1/3]

◆ WellboreCompletion() [2/3]

◆ WellboreCompletion() [3/3]

◆ ~WellboreCompletion()

Member Function Documentation

◆ getConnectionBaseMd()

◆ getConnectionCount()

◆ getConnectionExtraMetadata()

◆ getConnectionHistoryBaseMd()

◆ getConnectionHistoryComment()

◆ getConnectionHistoryCount()

◆ getConnectionHistoryEndDate()

◆ getConnectionHistoryMdUnit()

◆ getConnectionHistoryMdUnitAsString()

◆ getConnectionHistoryStartDate()

◆ getConnectionHistoryStatus()

◆ getConnectionHistoryStatusToString()

◆ getConnectionHistoryTopMd()

◆ getConnectionMdUnit()

◆ getConnectionMdUnitAsString()

◆ getConnectionTopMd()

◆ getConnectionUid()

◆ getWellboreDor()

◆ getWellCompletion()

◆ getWellCompletionDor()

◆ getXmlNamespace()

◆ getXmlTag()

◆ hasConnectionHistoryComment()

◆ hasConnectionHistoryEndDate()

◆ hasConnectionHistoryMdDatum()

◆ hasConnectionHistoryMdInterval()

◆ hasConnectionHistoryStartDate()

◆ hasConnectionHistoryStatus()

◆ hasConnectionMdDatum()

◆ hasConnectionMdInterval()

◆ loadTargetRelationships()

◆ pushBackConnection()

◆ pushBackConnectionExtraMetadata()

◆ pushBackConnectionHistory() [1/2]

◆ pushBackConnectionHistory() [2/2]

◆ setConnectionHistoryComment()

◆ setConnectionHistoryEndDate()

◆ setConnectionHistoryMdInterval()

◆ setConnectionHistoryStartDate()

◆ setConnectionHistoryStatus()

◆ setWellbore()

◆ setWellCompletion()

Member Data Documentation

◆ XML_NS

◆ XML_TAG