RESQML2_0_1_NS::WellboreTrajectoryRepresentation Class Reference

Inheritance diagram for RESQML2_0_1_NS::WellboreTrajectoryRepresentation:

Public Member Functions
	WellboreTrajectoryRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	WellboreTrajectoryRepresentation (class WellboreInterpretation *interp, const std::string &guid, const std::string &title, RESQML2_NS::MdDatum *mdInfo)
	WellboreTrajectoryRepresentation (class WellboreInterpretation *interp, const std::string &guid, const std::string &title, DeviationSurveyRepresentation *deviationSurvey)
	WellboreTrajectoryRepresentation (gsoap_resqml2_0_1::_resqml2__WellboreTrajectoryRepresentation *fromGsoap)
virtual std::string	getXmlTag () const
void	setGeometry (double *controlPoints, const double &startMd, const double &endMd, const unsigned int &controlPointCount, const int &lineKind, COMMON_NS::AbstractHdfProxy *proxy)
void	setGeometry (double *controlPoints, double *controlPointParameters, const unsigned int &controlPointCount, COMMON_NS::AbstractHdfProxy *proxy)
void	setGeometry (double *controlPoints, double *tangentVectors, double *controlPointParameters, const unsigned int &controlPointCount, COMMON_NS::AbstractHdfProxy *proxy)
int	getGeometryKind () const
void	setMdDatum (RESQML2_NS::MdDatum *mdDatum)
RESQML2_NS::MdDatum *	getMdDatum () const
std::string	getMdDatumUuid () const
ULONG64	getXyzPointCountOfPatch (const unsigned int &patchIndex) const
void	getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
bool	hasMdValues () const
gsoap_resqml2_0_1::eml20__LengthUom	getMdUom () const
void	getMdValues (double *values)
double	getStartMd () const
double	getFinishMd () const
bool	hasTangentVectors () const
void	getTangentVectors (double *tangentVectors)
void	addParentTrajectory (const double &kickoffMd, const double &parentMd, WellboreTrajectoryRepresentation *parentTrajRep)
WellboreTrajectoryRepresentation *	getParentTrajectory () const
const double &	getParentTrajectoryMd () const
const std::vector< WellboreTrajectoryRepresentation * > &	getChildrenTrajectorySet () const
void	addWellboreFrameRepresentation (class WellboreFrameRepresentation *WellboreFrameRepresentation)
const std::vector< class WellboreFrameRepresentation * > &	getWellboreFrameRepresentationSet () const
unsigned int	getWellboreFrameRepresentationCount () const
class WellboreFrameRepresentation *	getWellboreFrameRepresentation (const unsigned int &index) const
void	setDeviationSurvey (class DeviationSurveyRepresentation *deviationSurvey)
class DeviationSurveyRepresentation *	getDeviationSurvey () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	getLocalCrsDor () const
std::string	getHdfProxyUuid () const
unsigned int	getPatchCount () const
bool	hasGeometry () const
void	setWitsmlTrajectory (WITSML1_4_1_1_NS::Trajectory *witsmlTraj)
WITSML1_4_1_1_NS::Trajectory *	getWitsmlTrajectory ()
Public Member Functions inherited from RESQML2_NS::AbstractRepresentation
virtual	~AbstractRepresentation ()
class AbstractLocal3dCrs *	getLocalCrs () const
std::string	getLocalCrsUuid () const
COMMON_NS::AbstractHdfProxy *	getHdfProxy () const
const std::vector< class AbstractProperty * > &	getPropertySet () const
std::vector< class AbstractValuesProperty * >	getValuesPropertySet () const
unsigned int	getValuesPropertyCount () const
class AbstractValuesProperty *	getValuesProperty (const unsigned int &index) const
void	setInterpretation (class AbstractFeatureInterpretation *interp)
class AbstractFeatureInterpretation *	getInterpretation () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	getInterpretationDor () const
std::string	getInterpretationUuid () const
std::string	getInterpretationContentType () const
void	pushBackSubRepresentation (class SubRepresentation *subRep)
std::vector< SubRepresentation * >	getSubRepresentationSet () const
unsigned int	getSubRepresentationCount () const
SubRepresentation *	getSubRepresentation (const unsigned int &index) const
std::vector< SubRepresentation * >	getFaultSubRepresentationSet () const
unsigned int	getFaultSubRepresentationCount () const
SubRepresentation *	getFaultSubRepresentation (const unsigned int &index) const
ULONG64	getXyzPointCountOfAllPatches () const
void	getXyzPointsOfPatchInGlobalCrs (const unsigned int &patchIndex, double *xyzPoints) const
void	getXyzPointsOfAllPatches (double *xyzPoints) const
void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const
AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const
std::set< AbstractRepresentation * >	getAllSeismicSupport () const
void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet, bool xml=true)
ULONG64	getRepresentationSetRepresentationCount () const
RepresentationSetRepresentation *	getRepresentationSetRepresentation (const ULONG64 &index) const
void	setHdfProxy (COMMON_NS::AbstractHdfProxy *proxy)
void	addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, double *inlines, double *crosslines, const unsigned int &pointCount, RESQML2_NS::AbstractRepresentation *seismicSupport, COMMON_NS::AbstractHdfProxy *proxy)
void	addSeismic3dCoordinatesToPatch (const unsigned int patchIndex, const double &startInline, const double &incrInline, const unsigned int &countInline, const double &startCrossline, const double &incrCrossline, const unsigned int &countCrossline, RESQML2_NS::AbstractRepresentation *seismicSupport)
void	addSeismic2dCoordinatesToPatch (const unsigned int patchIndex, double *lineAbscissa, RESQML2_NS::AbstractRepresentation *seismicSupport, COMMON_NS::AbstractHdfProxy *proxy)
void	getSeismicLineAbscissaOfPointsOfPatch (const unsigned int &patchIndex, double *values)
void	getInlinesOfPointsOfPatch (const unsigned int &patchIndex, double *values)
void	getCrosslinesOfPointsOfPatch (const unsigned int &patchIndex, double *values)
Public Member Functions inherited from COMMON_NS::AbstractObject
bool	isPartial () 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	getVersionString () const
void	setTitle (const std::string &title)
void	setEditor (const std::string &editor)
void	setCreation (const time_t &creation)
void	setCreation (const tm &creation)
void	setOriginator (const std::string &originator)
void	setDescription (const std::string &description)
void	setLastUpdate (const time_t &lastUpdate)
void	setLastUpdate (const tm &lastUpdate)
void	setFormat (const std::string &format)
void	setDescriptiveKeywords (const std::string &descriptiveKeywords)
void	setVersionString (const std::string &versionString)
void	setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
void	serializeIntoStream (std::ostream *stream)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getGsoapProxy () const
soap *	getGsoapContext () const
int	getGsoapType () const
gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const
gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const
gsoap_resqml2_0_1::resqml2__ContactElementReference *	newResqmlContactElementReference () const
COMMON_NS::EpcDocument *	getEpcDocument () const
virtual std::string	getXmlNamespace () const
virtual std::string	getResqmlVersion () const
virtual std::string	getContentType () const
virtual std::string	getPartNameInEpcDocument () const
std::string	serializeIntoString ()
void	addAlias (const std::string &authority, const std::string &title)
unsigned int	getAliasCount () const
std::string	getAliasAuthorityAtIndex (const unsigned int &index) const
std::string	getAliasTitleAtIndex (const unsigned int &index) const
const std::vector< RESQML2_NS::Activity * > &	getActivitySet () const
unsigned int	getActivityCount () const
RESQML2_NS::Activity *	getActivity (const unsigned int &index) const
void	pushBackExtraMetadata (const std::string &key, const std::string &value)
std::tr1::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 (const unsigned int &index) const
std::string	getExtraMetadataStringValueAtIndex (const unsigned int &index) const

Static Public Attributes
static const char *	XML_TAG = "WellboreTrajectoryRepresentation"
Static Public Attributes inherited from RESQML2_NS::AbstractRepresentation
static const char *	XML_TAG = "AbstractRepresentation"

Protected Member Functions
std::vector< epc::Relationship >	getAllEpcRelationships () const
void	importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
Protected Member Functions inherited from RESQML2_NS::AbstractRepresentation
	AbstractRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	AbstractRepresentation (class AbstractFeatureInterpretation *interp, class AbstractLocal3dCrs *crs)
	AbstractRepresentation (gsoap_resqml2_0_1::resqml2__AbstractRepresentation *fromGsoap)
void	pushBackSeismicSupport (AbstractRepresentation *seismicSupport)
void	setXmlInterpretation (class AbstractFeatureInterpretation *interp)
gsoap_resqml2_0_1::resqml2__PointGeometry *	createPointGeometryPatch2_0_1 (const unsigned int &patchIndex, double *points, unsigned long long *numPoints, const unsigned int &numDimensionsInArray, COMMON_NS::AbstractHdfProxy *proxy)
std::string	getHdfProxyUuidFromPointGeometryPatch (gsoap_resqml2_0_1::resqml2__PointGeometry *patch) const
gsoap_resqml2_0_1::resqml2__Seismic2dCoordinates *	getSeismic2dCoordinates (const unsigned int &patchIndex) const
gsoap_resqml2_0_1::resqml2__Seismic3dCoordinates *	getSeismic3dCoordinates (const unsigned int &patchIndex) const
Protected Member Functions inherited from COMMON_NS::AbstractObject
	AbstractObject ()
	Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.
	AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)
	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)
void	initMandatoryMetadata ()
void	setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)
void	cannotBePartial () const
void	changeToPartialObject ()

Protected Attributes
WITSML1_4_1_1_NS::Trajectory *	witsmlTrajectory
std::vector< WellboreTrajectoryRepresentation * >	childrenTrajSet
std::vector< class WellboreFrameRepresentation * >	wellboreFrameRepresentationSet
Protected Attributes inherited from RESQML2_NS::AbstractRepresentation
class AbstractFeatureInterpretation *	interpretation
COMMON_NS::AbstractHdfProxy *	hdfProxy
class AbstractLocal3dCrs *	localCrs
std::vector< SubRepresentation * >	subRepresentationSet
std::vector< AbstractProperty * >	propertySet
std::vector< AbstractRepresentation * >	seismicSupportedRepSet
std::vector< class RepresentationSetRepresentation * >	representationSetRepresentationSet
Protected Attributes inherited from COMMON_NS::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1
gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1
COMMON_NS::EpcDocument *	epcDocument
std::vector< RESQML2_NS::Activity * >	activitySet
bool	updateXml

Additional Inherited Members
Public Types inherited from RESQML2_NS::AbstractRepresentation
enum	indexableElement {   NODE = 0, EDGE = 1, FACE = 2, VOLUME = 3,   PILLAR = 4 }
Protected Types inherited from COMMON_NS::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }
Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void	addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)

Constructor & Destructor Documentation

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

inline

Only to be used in partial transfer context

RESQML2_0_1_NS::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation	(	class WellboreInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		RESQML2_NS::MdDatum *	mdInfo
	)

Creates an instance of this class in a gsoap context.

Parameters

interp	The WellboreFeature interpretation the instance represents.
guid	The guid to set to the new instance. If empty then a new guid will be generated.
title	A title for the instance to create.
mdInfo	The MD information of the trajectory, mainly the well reference point.

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

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

RESQML2_0_1_NS::WellboreTrajectoryRepresentation::WellboreTrajectoryRepresentation ( gsoap_resqml2_0_1::_resqml2__WellboreTrajectoryRepresentation *  fromGsoap )

inline

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

Member Function Documentation

void WellboreTrajectoryRepresentation::addParentTrajectory	(	const double &	kickoffMd,
		const double &	parentMd,
		WellboreTrajectoryRepresentation *	parentTrajRep
	)

Add a trajectory parent to this trajectory in case of trajectory branching. Does add the inverse relationship i.e. from the parent trajectory to this trajecotry

void RESQML2_0_1_NS::WellboreTrajectoryRepresentation::addWellboreFrameRepresentation ( class WellboreFrameRepresentation *  WellboreFrameRepresentation )

inline

Add a Wellbore frame representation to this trajectory. Does not add the inverse relationship i.e. from the WellboreFeature frame to this trajectory

vector< Relationship > WellboreTrajectoryRepresentation::getAllEpcRelationships ( ) const

protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Reimplemented from RESQML2_NS::AbstractRepresentation.

const std::vector< WellboreTrajectoryRepresentation * > & WellboreTrajectoryRepresentation::getChildrenTrajectorySet

(

)

const

Get a set of all children trajectories of this trajectory

DeviationSurveyRepresentation * WellboreTrajectoryRepresentation::getDeviationSurvey

(

)

const

Get the deviation survey which is the source of this trajectory. It can return a null pointer.

double WellboreTrajectoryRepresentation::getFinishMd

(

)

const

Get the ending depth for the start of the wellbore trajectory. Range may often be from kickoff to TD, but this is not necessary.

int WellboreTrajectoryRepresentation::getGeometryKind

(

)

const

0 for vertical, 1 for linear spline, 2 for natural cubic spline, 3 for cubic spline, 4 for z linear cubic spline, 5 for minimum-curvature spline, (-1) for null: no line

gsoap_resqml2_0_1::eml20__DataObjectReference * WellboreTrajectoryRepresentation::getLocalCrsDor ( ) const

virtual

Get the information to resolve the associated local CRS.

Reimplemented from RESQML2_NS::AbstractRepresentation.

RESQML2_NS::MdDatum * WellboreTrajectoryRepresentation::getMdDatum

(

)

const

Getter of the md information associated to this WellboreFeature trajectory representation.

std::string WellboreTrajectoryRepresentation::getMdDatumUuid

(

)

const

Getter of the md information uuid associated to this WellboreFeature trajectory representation.

gsoap_resqml2_0_1::eml20__LengthUom WellboreTrajectoryRepresentation::getMdUom

(

)

const

Units of measure of the measured depths along this trajectory.

void WellboreTrajectoryRepresentation::getMdValues

(

double *

values

)

Getter of the md double values associated to each trajectory station of this WellboreFeature trajectory representation.

WellboreTrajectoryRepresentation * WellboreTrajectoryRepresentation::getParentTrajectory

(

)

const

Get the parent trajectory of this trajectory

Returns

nullptr if the trajectory has no parent trajectory.

const double & WellboreTrajectoryRepresentation::getParentTrajectoryMd

(

)

const

Get the MD on the parent wellbore trajectory where this trajectory is starting.

double WellboreTrajectoryRepresentation::getStartMd

(

)

const

Get the measured depth for the start of the wellbore trajectory. Range may often be from kickoff to TD, but this is not necessary.

void WellboreTrajectoryRepresentation::getTangentVectors

(

double *

tangentVectors

)

Getter of the tangent vectors associated to each trajectory station of this WellboreFeature trajectory representation.

class WellboreFrameRepresentation* RESQML2_0_1_NS::WellboreTrajectoryRepresentation::getWellboreFrameRepresentation ( const unsigned int &  index ) const

inline

Get a particular wellbore frame representation of this wellbore trajectory representation according to its position in the EPC document. Necessary for now in SWIG context because I mm not sure if I can always wrap a vector of polymorphic class yet. Throw an out of bound exception if the index is superior or equal to the count of wellbore frame representation.

unsigned int RESQML2_0_1_NS::WellboreTrajectoryRepresentation::getWellboreFrameRepresentationCount ( ) const

inline

Get the count of wellbore frame representation which are associated with this wellbore trajectory. Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet.

const std::vector<class WellboreFrameRepresentation*>& RESQML2_0_1_NS::WellboreTrajectoryRepresentation::getWellboreFrameRepresentationSet ( ) const

inline

Getter (in read only mode) of all the associated Wellbore frame representations

virtual std::string RESQML2_0_1_NS::WellboreTrajectoryRepresentation::getXmlTag ( ) const

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

ULONG64 WellboreTrajectoryRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex ) const

virtual

Get the xyz point count in a given patch.

Implements RESQML2_NS::AbstractRepresentation.

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

virtual

Get all the XYZ points of a particular patch of this representation. XYZ points are given in the local CRS.

Parameters

xyzPoints

A linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be pre allocated.

Implements RESQML2_NS::AbstractRepresentation.

bool WellboreTrajectoryRepresentation::hasMdValues

(

)

const

Indicates if the wellbore trajectory has got md values attached to each trajectory station.

bool WellboreTrajectoryRepresentation::hasTangentVectors

(

)

const

Indicates if the wellbore trajectory has got tangent vectors attached to each trajectory station.

void WellboreTrajectoryRepresentation::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument *  epcDoc )

protectedvirtual

Resolve all relationships of the object in an epc document

Reimplemented from RESQML2_NS::AbstractRepresentation.

void WellboreTrajectoryRepresentation::setDeviationSurvey

(

class DeviationSurveyRepresentation *

deviationSurvey

)

Set the deviation survey which is the source of this trajectory.

void WellboreTrajectoryRepresentation::setMdDatum

(

RESQML2_NS::MdDatum *

mdDatum

)

Set the Md datum of this trajectory

---

The documentation for this class was generated from the following files:

• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/WellboreTrajectoryRepresentation.h
• C:/Users/Philippe/dev/fesapiEnv/fesapi/src/resqml2_0_1/WellboreTrajectoryRepresentation.cpp