resqml2_0_1::WellboreTrajectoryRepresentation Class Reference

#include <WellboreTrajectoryRepresentation.h>

Inheritance diagram for resqml2_0_1::WellboreTrajectoryRepresentation:

Public Member Functions
	WellboreTrajectoryRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	WellboreTrajectoryRepresentation (resqml2 ::WellboreInterpretation *interp, const std::string &guid, const std::string &title, resqml2 ::MdDatum *mdInfo)
	WellboreTrajectoryRepresentation (resqml2 ::WellboreInterpretation *interp, const std::string &guid, const std::string &title, resqml2 ::DeviationSurveyRepresentation *deviationSurvey)
	WellboreTrajectoryRepresentation (gsoap_resqml2_0_1::_resqml20__WellboreTrajectoryRepresentation *fromGsoap)
	~WellboreTrajectoryRepresentation ()=default
void	setMinimalGeometry (double startMd, double endMd) final
void	setGeometry (double const *controlPoints, double startMd, double endMd, uint64_t controlPointCount, int lineKind, eml2 ::AbstractHdfProxy *proxy=nullptr, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
void	setGeometry (double const *controlPoints, double const *controlPointParameters, uint64_t controlPointCount, int lineKind, eml2 ::AbstractHdfProxy *proxy=nullptr, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
void	setGeometry (double const *controlPoints, double const *tangentVectors, double const *controlPointParameters, uint64_t controlPointCount, int lineKind, eml2 ::AbstractHdfProxy *proxy=nullptr, resqml2 ::AbstractLocal3dCrs *localCrs=nullptr) final
int	getGeometryKind () const final
void	setMdDatum (resqml2 ::MdDatum *mdDatum) final
common::DataObjectReference	getMdDatumDor () const final
uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const final
void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.
bool	hasMdValues () const final
gsoap_resqml2_0_1::eml20__LengthUom	getMdUom () const final
void	getMdValues (double *values) const final
double	getStartMd () const final
double	getFinishMd () const final
bool	hasTangentVectors () const final
void	getTangentVectors (double *tangentVectors) final
void	addParentTrajectory (double kickoffMd, double parentMd, resqml2 ::WellboreTrajectoryRepresentation *parentTrajRep) final
common::DataObjectReference	getParentTrajectoryDor () const final
double	getParentTrajectoryMd () const final
void	setDeviationSurvey (resqml2 ::DeviationSurveyRepresentation *deviationSurvey) final
common::DataObjectReference	getDeviationSurveyDor () const final
common::DataObjectReference	getLocalCrsDor (unsigned int patchIndex) const final
common::DataObjectReference	getHdfProxyDor () const final
bool	hasGeometry () const final
std::string	getXmlNamespace () const final

Static Public Attributes
static const char *	XML_NS

Detailed Description

A wellbore trajectory representation.

Constructor & Destructor Documentation

WellboreTrajectoryRepresentation() [1/4]

resqml2_0_1::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context.

Parameters

[in]

partialObject

If non-nullptr, the partial object.

WellboreTrajectoryRepresentation() [2/4]

resqml2_0_1::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation	(	resqml2 ::WellboreInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		resqml2 ::MdDatum *	mdInfo )

Creates a wellbore trajectory representation.

Exceptions

std::invalid_argument

If interp or mdInfo is nullptr.

Parameters

[in]	interp	The represented wellbore interpretation. It cannot be null.
	guid	The guid to set to the wellbore trajectory representation. If empty then a new guid will be generated.
	title	The title to set to the wellbore trajectory representation. If empty then "unknown" title will be set.
[in]	mdInfo	The MD information of the trajectory, mainly the well reference point. The unit of measure used for the mdInfo coordinates must also be used for the start and end MD of the trajectory. It cannot be null.

WellboreTrajectoryRepresentation() [3/4]

resqml2_0_1::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation	(	resqml2 ::WellboreInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		resqml2 ::DeviationSurveyRepresentation *	deviationSurvey )

Creates an instance with an existing deviation survey as its origin.

Exceptions

std::invalid_argument

If interp or deviationSurvey is nullptr.

Parameters

[in]	interp	The represented interpretation. It cannot be null.
	guid	The guid to set to the wellbore trajectory representation. If empty then a new guid will be generated.
	title	The title to set to the wellbore trajectory representation. If empty then "unknown" title will be set.
[in]	deviationSurvey	The deviation survey on which this wellbore trajectory relies on. MD data will be retrieve from it. It cannot be null.

WellboreTrajectoryRepresentation() [4/4]

resqml2_0_1::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation ( gsoap_resqml2_0_1::_resqml20__WellboreTrajectoryRepresentation * fromGsoap )

inline

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

Parameters

[in]

fromGsoap

If non-null, the gSOAP instance.

~WellboreTrajectoryRepresentation()

resqml2_0_1::WellboreTrajectoryRepresentation::~WellboreTrajectoryRepresentation ( )

default

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

Member Function Documentation

getXmlNamespace()

std::string resqml2_0_1::WellboreTrajectoryRepresentation::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

getXyzPointsOfPatch()

void resqml2_0_1::WellboreTrajectoryRepresentation::getXyzPointsOfPatch ( unsigned int patchIndex, double * xyzPoints ) const

final

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions

std::invalid_argument	If the HDF proxy is missing.
std::logic_error	If this trajectory has no geometry.
std::out_of_range	If patchIndex is out of range.
std::logic_error	If this representation is partial.

Parameters

	patchIndex	Zero-based index of the patch from which we look for the xyz points.
[out]	xyzPoints	A linearized 2d array where the first (quickest) dimension is the coordinate dimension (x, y or z) and second dimension is vertex dimension. It must be preallocated with a size of 3 * getXyzPointCountOfPatch(patchIndex).

Member Data Documentation

XML_NS

const char* resqml2_0_1::WellboreTrajectoryRepresentation::XML_NS

static

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/resqml2_0_1/WellboreTrajectoryRepresentation.h