A deviation survey representation. It Specifies the station data from a deviation survey. More...

#include <DeviationSurveyRepresentation.h>

Inheritance diagram for resqml2::DeviationSurveyRepresentation:

Public Member Functions
virtual	~DeviationSurveyRepresentation ()=default

virtual void	setGeometry (double const firstStationLocation, uint64_t stationCount, gsoap_resqml2_0_1::eml20__LengthUom mdUom, double const mds, gsoap_resqml2_0_1::eml20__PlaneAngleUom angleUom, double const azimuths, double const inclinations, eml2 ::AbstractHdfProxy *proxy)=0

virtual void	setMdDatum (resqml2 ::MdDatum *mdDatum)=0

virtual common::DataObjectReference	getMdDatumDor () const =0

class MdDatum *	getMdDatum () const

virtual bool	isFinal () const =0

virtual gsoap_resqml2_0_1::eml20__LengthUom	getMdUom () const =0

virtual gsoap_resqml2_0_1::eml20__PlaneAngleUom	getAngleUom () const =0

virtual void	getMdValues (double *values) const =0

virtual void	getInclinations (double *values) const =0

virtual void	getAzimuths (double *values) const =0

std::vector< class resqml2 ::WellboreFrameRepresentation * >	getWellboreFrameRepresentationSet () const

unsigned int	getWellboreFrameRepresentationCount () const

class resqml2 ::WellboreFrameRepresentation *	getWellboreFrameRepresentation (unsigned int index) const

std::vector< class WellboreTrajectoryRepresentation * >	getWellboreTrajectoryRepresentationSet () const

unsigned int	getWellboreTrajectoryRepresentationCount () const

class WellboreTrajectoryRepresentation *	getWellboreTrajectoryRepresentation (unsigned int index) const

uint64_t	getPatchCount () const final

virtual std::string	getXmlTag () const final

Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()=default

class AbstractLocal3dCrs *	getLocalCrs (unsigned int patchIndex) const

virtual common::DataObjectReference	getLocalCrsDor (unsigned int patchIndex) const

virtual common::DataObjectReference	getHdfProxyDor () const =0
	Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

void	setTimeIndex (uint64_t timeIndex, eml2 ::TimeSeries *timeSeries)

uint64_t	getTimeIndex () const
	Gets the time index of this representation in the associated TimeSeries. Be sure to first check that a TimeSeries is associated this representation by calling getTimeSeriesDor or getTimeSeries;.

eml2::TimeSeries *	getTimeSeries () const

common::DataObjectReference	getTimeSeriesDor () const
	Gets the data object reference of the TimeSeries containing the time of this representation at a particular index. For now, this method only look for a TimeSeries at the first patch containing a point geometry.

std::vector< class AbstractProperty * >	getPropertySet () const

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

virtual uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const =0

uint64_t	getXyzPointCountOfAllPatches () const

virtual void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const =0
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

void	getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS.

void	getXyzPointsOfAllPatches (double *xyzPoints) const
	Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS.

bool	isInSingleLocalCrs () const

bool	isInSingleGlobalCrs () const

void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const

AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const

std::set< AbstractRepresentation * >	getAllSeismicSupport () const

void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double inlines, double crosslines, uint64_t pointCount, resqml2 ::AbstractRepresentation seismicSupport, eml2 ::AbstractHdfProxy proxy)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2 ::AbstractRepresentation *seismicSupport)

void	addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double lineAbscissa, resqml2 ::AbstractRepresentation seismicSupport, eml2 ::AbstractHdfProxy *proxy)

void	getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

Static Public Attributes
static const char *	XML_TAG

Static Public Attributes inherited from resqml2::AbstractRepresentation
static constexpr char const *	XML_TAG = "AbstractRepresentation"

Detailed Description

A deviation survey representation. It Specifies the station data from a deviation survey.

The deviation survey does not provide a complete specification of the geometry of a wellbore trajectory. Although a minimum-curvature algorithm is used in most cases, the implementation varies sufficiently that no single algorithmic specification is available as a data transfer standard.

Instead, the geometry of a RESQML wellbore trajectory is represented by a parametric line, parameterized by the MD.

CRS and units of measure do not need to be consistent with the CRS and units of measure for wellbore trajectory representation.

Constructor & Destructor Documentation

◆ ~DeviationSurveyRepresentation()

virtual resqml2::DeviationSurveyRepresentation::~DeviationSurveyRepresentation ( )

virtualdefault

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

Member Function Documentation

◆ getAngleUom()

virtual gsoap_resqml2_0_1::eml20__PlaneAngleUom resqml2::DeviationSurveyRepresentation::getAngleUom ( ) const

pure virtual

Gets the unit of measure of the azimuth and inclination angle values of this deviation survey.

Returns: The unit of measure of the azimuth and inclination angle values.

◆ getAzimuths()

virtual void resqml2::DeviationSurveyRepresentation::getAzimuths ( double * values ) const

pure virtual

Gets the azimuth double values associated to each trajectory station of this deviation survey representation. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. The uom is given by getAngleUom().

Exceptions

logic_error If the data structure used to store the azimuth values cannot be read for now by fesapi.

Parameters

[out] values An array to receive the azimuth double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

◆ getInclinations()

virtual void resqml2::DeviationSurveyRepresentation::getInclinations ( double * values ) const

pure virtual

Gets the inclination double values associated to each trajectory station of this deviation survey representation. The uom is given by getAngleUom().

Exceptions

logic_error If the data structure used to store the inclination values cannot be read for now by fesapi.

Parameters

[out] values An array to receive the inclination double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

◆ getMdDatum()

class MdDatum * resqml2::DeviationSurveyRepresentation::getMdDatum ( ) const

Gets the MD datum of this deviation survey representation.

Returns: The MD datum of this deviation survey representation.

◆ getMdDatumDor()

virtual common::DataObjectReference resqml2::DeviationSurveyRepresentation::getMdDatumDor ( ) const

pure virtual

Gets the DOR of the MD datum of this deviation survey representation.

Returns: The DOR of the MD datum of this deviation survey representation.

◆ getMdUom()

virtual gsoap_resqml2_0_1::eml20__LengthUom resqml2::DeviationSurveyRepresentation::getMdUom ( ) const

pure virtual

Gets the unit of measure of the MDs along this deviation survey.

Returns: The unit of measure of the MDs.

◆ getMdValues()

virtual void resqml2::DeviationSurveyRepresentation::getMdValues ( double * values ) const

pure virtual

Gets the MD double values associated to each trajectory station of this deviation survey representation. The uom is given by getMdUom().

Exceptions

logic_error If the data structure used to store the MD values cannot be read for now by fesapi.

Parameters

[out] values An array to receive the MD double values. It must preallocated with a count of getXyzPointCountOfPatch(0).

◆ getPatchCount()

uint64_t resqml2::DeviationSurveyRepresentation::getPatchCount ( ) const

inlinefinalvirtual

Gets the patch count.

Returns: The patch count.

Implements resqml2::AbstractRepresentation.

◆ getWellboreFrameRepresentation()

class resqml2 ::WellboreFrameRepresentation * resqml2::DeviationSurveyRepresentation::getWellboreFrameRepresentation ( unsigned int index ) const

Gets a particular wellbore frame representation according to its position in the set of all the wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

Exceptions

std::invalid_argument If index >= getWellboreFrameRepresentationCount().

Parameters

index Zero-based index of the wellbore frame representation we look for.

Returns: The wellbore frame representation at position index in the set of all the wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

◆ getWellboreFrameRepresentationCount()

unsigned int resqml2::DeviationSurveyRepresentation::getWellboreFrameRepresentationCount ( ) const

Gets the count of wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

Returns: The the count of wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

◆ getWellboreFrameRepresentationSet()

std::vector< class resqml2 ::WellboreFrameRepresentation * > resqml2::DeviationSurveyRepresentation::getWellboreFrameRepresentationSet ( ) const

Gets all the wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

Returns: The vector of all the wellbore frame representations of the associated wellbore trajectory which share the same MD datum and MD uom than this deviation survey representation.

◆ getWellboreTrajectoryRepresentation()

class WellboreTrajectoryRepresentation * resqml2::DeviationSurveyRepresentation::getWellboreTrajectoryRepresentation ( unsigned int index ) const

Gets the associated wellbore trajectory at a particular position.

Exceptions

std::out_of_range If index >= getWellboreTrajectoryRepresentationCount().

Parameters

index Zero-based index of the wellbore trajectory we look for.

Returns: The associated wellbore trajectory at position index.

◆ getWellboreTrajectoryRepresentationCount()

unsigned int resqml2::DeviationSurveyRepresentation::getWellboreTrajectoryRepresentationCount ( ) const

Get the count of wellbore trajectories which are associated to this deviation survey.

Exceptions

std::range_error If the count of wellbore trajectories is strictly greater than unsigned int max.

Returns: The count of associated wellbore trajectories.

◆ getWellboreTrajectoryRepresentationSet()

std::vector< class WellboreTrajectoryRepresentation * > resqml2::DeviationSurveyRepresentation::getWellboreTrajectoryRepresentationSet ( ) const

Gets all the wellbore trajectories which are associated to this deviation survey representation.

Returns: The vector of all the associated wellbore trajectories.

◆ isFinal()

virtual bool resqml2::DeviationSurveyRepresentation::isFinal ( ) const

pure virtual

Checks whether this is a final version of the deviation survey, as distinct from the interim interpretations.

Returns: True if it is a final version, false if not.

◆ setGeometry()

virtual void resqml2::DeviationSurveyRepresentation::setGeometry	(	double const *	firstStationLocation,
		uint64_t	stationCount,
		gsoap_resqml2_0_1::eml20__LengthUom	mdUom,
		double const *	mds,
		gsoap_resqml2_0_1::eml20__PlaneAngleUom	angleUom,
		double const *	azimuths,
		double const *	inclinations,
		eml2 ::AbstractHdfProxy *	proxy )

pure virtual

Sets the geometry of this deviation survey representation.

Exceptions

std::invalid_argument	If `firstStationLocation`, `mds`, `azimuths` or `inclinations` is @ nullptr.
std::invalid_argument	If `proxy == nullptr` and no default HDF proxy is defined in the repository.

Parameters

	firstStationLocation	An array of size 3 containing the coordinates x, y and z of the first station of this deviation survey in the local CRS.
	stationCount	The number of stations (including the first station).
	mdUom	The units of measure of the measured depths along this deviation survey.
	mds	An array containing the MD values of the stations. The array length equals `stationCount`.
	angleUom	The unit of measure of both `azimuth` and `inclination` values.
	azimuths	An array of azimuth angles, one for each survey station. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. Array length equals `stationCount`.
	inclinations	Inclination (or dip) angle for each station. Array length equals `stationCount`.
[in,out]	proxy	The HDF proxy where the numerical values will be stored. It must be already opened for writing and won't be closed. If `nullptr`, then the default HDF proxy of the repository will be used.

◆ setMdDatum()

virtual void resqml2::DeviationSurveyRepresentation::setMdDatum ( resqml2 ::MdDatum * mdDatum )

pure virtual

Sets the MD datum of this deviation survey representation.

Exceptions

std::invalid_argument If mdDatum == nullptr.

Parameters

[in] mdDatum The MD datum to set.

Member Data Documentation

◆ XML_TAG

const char* resqml2::DeviationSurveyRepresentation::XML_TAG

static

The standard XML tag without 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/DeviationSurveyRepresentation.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ~DeviationSurveyRepresentation()

Member Function Documentation

◆ getAngleUom()

◆ getAzimuths()

◆ getInclinations()

◆ getMdDatum()

◆ getMdDatumDor()

◆ getMdUom()

◆ getMdValues()

◆ getPatchCount()

◆ getWellboreFrameRepresentation()

◆ getWellboreFrameRepresentationCount()

◆ getWellboreFrameRepresentationSet()

◆ getWellboreTrajectoryRepresentation()

◆ getWellboreTrajectoryRepresentationCount()

◆ getWellboreTrajectoryRepresentationSet()

◆ isFinal()

◆ setGeometry()

◆ setMdDatum()

Member Data Documentation

◆ XML_TAG