Contains all information that is the same for all wellbores (sidetracks). More...

#include <Well.h>

Inheritance diagram for witsml2_1::Well:

Public Member Functions
	Well (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	Well (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, bool isActive)

	Well (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, bool isActive, gsoap_eml2_3::eml23__WellStatus statusWell, gsoap_eml2_3::witsml21__WellDirection directionWell)
	Constructor.

	Well (gsoap_eml2_3::witsml21__Well *fromGsoap)

	~Well ()=default

void	setGroundElevation (double value, gsoap_eml2_3::eml23__LengthUom uom) final
	Sets the ground level elevation (land rigs)

double	getGroundElevationValue () const final
	Gets the ground level elevation value.

gsoap_eml2_3::eml23__LengthUom	getGroundElevationUom () const final
	Gets the ground level elevation unit of measure.

void	setTimeZone (bool direction, unsigned short hours, unsigned short minutes) final

bool	getTimeZoneDirection () const final

unsigned short	getTimeZoneHours () const final

unsigned short	getTimeZoneMinutes () const final

double	getLocationProjectedX (unsigned int locationIndex) final

double	getLocationProjectedY (unsigned int locationIndex) final

void	pushBackLocation (double projectedX, double projectedY) final

unsigned int	geLocationCount () const final

std::string	getXmlNamespace () const final

Public Member Functions inherited from WITSML2_NS::Well
	Well (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

virtual std::string	getXmlTag () const final

void	loadTargetRelationships ()

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

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

Detailed Description

Contains all information that is the same for all wellbores (sidetracks).

Constructor & Destructor Documentation

◆ Well() [1/4]

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

◆ Well() [2/4]

witsml2_1::Well::Well	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		bool	isActive )

Creates an instance of this class in a gsoap context.

Parameters

[in,out]	repo	The dataobject repo where the underlying gsoap proxy is going to be created.
	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.

◆ Well() [3/4]

witsml2_1::Well::Well	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		bool	isActive,
		gsoap_eml2_3::eml23__WellStatus	statusWell,
		gsoap_eml2_3::witsml21__WellDirection	directionWell )

Constructor.

Exceptions

std::invalid_argument If repo == nullptr.

Parameters

[in,out]	repo	If non-null, the repo.
	guid	Unique identifier.
	title	The title.
	isActive	True if is active, false if not.
	statusWell	The status well.
	directionWell	The direction well.

◆ Well() [4/4]

witsml2_1::Well::Well ( gsoap_eml2_3::witsml21__Well * fromGsoap )

inline

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

Parameters

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

◆ ~Well()

witsml2_1::Well::~Well ( )

virtualdefault

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

Reimplemented from WITSML2_NS::Well.

Member Function Documentation

◆ geLocationCount()

unsigned int witsml2_1::Well::geLocationCount ( ) const

finalvirtual

Ge location count

Returns: An int.

Implements WITSML2_NS::Well.

◆ getGroundElevationUom()

gsoap_eml2_3::eml23__LengthUom witsml2_1::Well::getGroundElevationUom ( ) const

finalvirtual

Gets the ground level elevation unit of measure.

Exceptions

std::invalid_argument If the ground elevation does not exist.

Returns: The ground level elevation unit of measure.

Implements WITSML2_NS::Well.

◆ getGroundElevationValue()

double witsml2_1::Well::getGroundElevationValue ( ) const

finalvirtual

Gets the ground level elevation value.

Exceptions

std::invalid_argument If the ground elevation does not exist.

Returns: The ground level elevation value.

Implements WITSML2_NS::Well.

◆ getLocationProjectedX()

double witsml2_1::Well::getLocationProjectedX ( unsigned int locationIndex )

finalvirtual

Gets location projected x coordinate

Parameters

locationIndex Zero-based index of the location.

Returns: The location projected x coordinate.

Implements WITSML2_NS::Well.

◆ getLocationProjectedY()

double witsml2_1::Well::getLocationProjectedY ( unsigned int locationIndex )

finalvirtual

Gets location projected y coordinate

Parameters

locationIndex Zero-based index of the location.

Returns: The location projected y coordinate.

Implements WITSML2_NS::Well.

◆ getTimeZoneDirection()

bool witsml2_1::Well::getTimeZoneDirection ( ) const

finalvirtual

Get the time zone direction in which the well is located.

Returns: True means the time zone is a positive offset from UTC, false means the time zone is a negative offset from UTC. If the time zone is Z then an arbitrary '+' is returned.

Implements WITSML2_NS::Well.

◆ getTimeZoneHours()

unsigned short witsml2_1::Well::getTimeZoneHours ( ) const

finalvirtual

Get the time zone hour(s) in which the well is located. Must be used with getTimeZoneDirection and getTimeZoneMinute() to have the complete time zone.

Returns: the deviation hour(s) from UTC.

Implements WITSML2_NS::Well.

◆ getTimeZoneMinutes()

unsigned short witsml2_1::Well::getTimeZoneMinutes ( ) const

finalvirtual

Get the time zone minute(s) in which the well is located. Must be used with getTimeZoneDirection and getTimeZoneHour() to have the complete time zone.

Returns: the deviation minute(s) from UTC.

Implements WITSML2_NS::Well.

◆ getXmlNamespace()

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

inlinefinal

Get the standard XML namespace for serializing this data object.

◆ pushBackLocation()

void witsml2_1::Well::pushBackLocation	(	double	projectedX,
		double	projectedY )

finalvirtual

Pushes a back location

Parameters

projectedX	The projected x coordinate.
projectedY	The projected y coordinate.

Implements WITSML2_NS::Well.

◆ setGroundElevation()

void witsml2_1::Well::setGroundElevation	(	double	value,
		gsoap_eml2_3::eml23__LengthUom	uom )

finalvirtual

Sets the ground level elevation (land rigs)

Exceptions

std::invalid_argument If value is undefined.

Parameters

value	The elevation value.
uom	The elevation unit of measure.

Implements WITSML2_NS::Well.

◆ setTimeZone()

void witsml2_1::Well::setTimeZone	(	bool	direction,
		unsigned short	hours,
		unsigned short	minutes )

finalvirtual

Set the time zone in which the well is located.It is the deviation in hours and minutes from UTC.This should be the normal time zone at the well and not a seasonally-adjusted value, such as daylight savings time

Parameters

direction	True means the time zone is a positive offset from UTC, false means the time zone is a negative offset from UTC.
hours	The deviation hours from UTC.
minutes	The deviation minutes from UTC.

Implements WITSML2_NS::Well.

Member Data Documentation

◆ XML_NS

constexpr char const* witsml2_1::Well::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.9.0.1/src/witsml2_1/Well.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Well() [1/4]

◆ Well() [2/4]

◆ Well() [3/4]

◆ Well() [4/4]

◆ ~Well()

Member Function Documentation

◆ geLocationCount()

◆ getGroundElevationUom()

◆ getGroundElevationValue()

◆ getLocationProjectedX()

◆ getLocationProjectedY()

◆ getTimeZoneDirection()

◆ getTimeZoneHours()

◆ getTimeZoneMinutes()

◆ getXmlNamespace()

◆ pushBackLocation()

◆ setGroundElevation()

◆ setTimeZone()

Member Data Documentation

◆ XML_NS