Representation of a wellbore marker that is located along a wellbore trajectory, one for each MD value in the wellbore frame. More...

#include <WellboreMarker.h>

Inheritance diagram for resqml2::WellboreMarker:

Public Member Functions
virtual	~WellboreMarker ()=default

virtual bool	hasAGeologicBoundaryKind () const =0

virtual gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind	getGeologicBoundaryKind () const =0

WellboreMarkerFrameRepresentation const *	getWellboreMarkerFrameRepresentation () const

BoundaryFeatureInterpretation *	getBoundaryFeatureInterpretation () const

virtual common::DataObjectReference	getBoundaryFeatureInterpretationDor () const =0

virtual void	setBoundaryFeatureInterpretation (BoundaryFeatureInterpretation *interp)=0

witsml2_0::WellboreMarker *	getWitsmlWellboreMarker () const

virtual void	setWitsmlWellboreMarker (witsml2_0::WellboreMarker *wellboreMarker)=0

bool	hasDipAngle () const

double	getDipAngleValue () const

gsoap_eml2_1::eml21__PlaneAngleUom	getDipAngleUom () const

std::string	getDipAngleUomAsString () const

bool	hasDipDirection () const

double	getDipDirectionValue () const

gsoap_eml2_1::eml21__PlaneAngleUom	getDipDirectionUom () const

std::string	getDipDirectionUomAsString () const

virtual std::string	getXmlTag () const final

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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	getXmlNamespace () const =0

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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

std::vector< eml2::Activity * >	getActivitySet () const

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

Static Public Attributes
static const char *	XML_TAG

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 10 }

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

Representation of a wellbore marker that is located along a wellbore trajectory, one for each MD value in the wellbore frame.

BUSINESS RULE: Ordering of the wellbore markers must match the ordering of the nodes in the wellbore marker frame representation.

Constructor & Destructor Documentation

◆ ~WellboreMarker()

virtual resqml2::WellboreMarker::~WellboreMarker ( )

virtualdefault

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

Reimplemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

Member Function Documentation

◆ getBoundaryFeatureInterpretation()

BoundaryFeatureInterpretation* resqml2::WellboreMarker::getBoundaryFeatureInterpretation ( ) const

Gets the boundary feature interpretation linked to this well marker.

Returns: The boundary feature interpretation linked to this well marker, or nullptr if it fails.

◆ getBoundaryFeatureInterpretationDor()

virtual common::DataObjectReference resqml2::WellboreMarker::getBoundaryFeatureInterpretationDor ( ) const

pure virtual

Gets the UUID of the boundary feature interpretation linked to this well marker. Especially useful in partial transfer mode.

Returns: The boundary feature interpretation UUID, or empty string if it fails.

Implemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

◆ getDipAngleUom()

gsoap_eml2_1::eml21__PlaneAngleUom resqml2::WellboreMarker::getDipAngleUom ( ) const

Get the Dip angle uom.

Exceptions

std::logic_error If the marker has not got any dip value.

Returns: the Dip angle uom.

◆ getDipAngleUomAsString()

std::string resqml2::WellboreMarker::getDipAngleUomAsString ( ) const

Get the Dip angle uom as a string.

Exceptions

std::logic_error If the marker has not got any dip value.

Returns: the Dip angle uom as a string.

◆ getDipAngleValue()

double resqml2::WellboreMarker::getDipAngleValue ( ) const

Get the Dip angle value.

Exceptions

std::logic_error If the marker has not got any dip value.

Returns: the Dip angle value.

◆ getDipDirectionUom()

gsoap_eml2_1::eml21__PlaneAngleUom resqml2::WellboreMarker::getDipDirectionUom ( ) const

Get the Dip direction uom.

Exceptions

std::logic_error If the marker has not got any dip direction.

Returns: the Dip direction uom.

◆ getDipDirectionUomAsString()

std::string resqml2::WellboreMarker::getDipDirectionUomAsString ( ) const

Get the Dip direction uom as a string.

Exceptions

std::logic_error If the marker has not got any dip direction.

Returns: the Dip direction uom as a string.

◆ getDipDirectionValue()

double resqml2::WellboreMarker::getDipDirectionValue ( ) const

Get the Dip direction value.

Exceptions

std::logic_error If the marker has not got any dip direction.

Returns: the Dip direction value.

◆ getGeologicBoundaryKind()

virtual gsoap_resqml2_0_1::resqml20__GeologicBoundaryKind resqml2::WellboreMarker::getGeologicBoundaryKind ( ) const

pure virtual

Gets the type of the intersected feature of the marker.

Exceptions

std::invalid_argument If the marker has no geologic boundary kind (see method hasAGeologicBoundaryKind()).

Returns: The geologic boundary kind associated to this marker.

Implemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

◆ getWellboreMarkerFrameRepresentation()

WellboreMarkerFrameRepresentation const* resqml2::WellboreMarker::getWellboreMarkerFrameRepresentation ( ) const

Gets the wellbore marker frame representation which contains this wellbore marker.

Returns: The wellbore marker frame representation which contains this wellbore marker frame, or nullptr if it fails.

◆ getWitsmlWellboreMarker()

witsml2_0::WellboreMarker* resqml2::WellboreMarker::getWitsmlWellboreMarker ( ) const

Gets the WITSML wellbore marker associated to this wellbore marker.

Exceptions

std::logic_error If more than one WITSML wellbore marker is associated to this wellbore feature.

Returns: nullptr if no WITSML wellbore marker is associated to this wellbore marker, else the associated WITSML wellbore marker.

◆ getXmlTag()

virtual std::string resqml2::WellboreMarker::getXmlTag ( ) const

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ hasAGeologicBoundaryKind()

virtual bool resqml2::WellboreMarker::hasAGeologicBoundaryKind ( ) const

pure virtual

Indicates if the marker is associated to a particular geologic boundary kind.

Returns: True if the marker is associated to a particular geologic boundary kind, false if not.

Implemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

◆ hasDipAngle()

bool resqml2::WellboreMarker::hasDipAngle ( ) const

Check wether this marker has got a dip angle or not. FYI, Dip Angle is store in the WITSML WellboreMarker companion if present.

Returns: true if this marker has got a dip angle.

◆ hasDipDirection()

bool resqml2::WellboreMarker::hasDipDirection ( ) const

Check wether this marker has got a dip direction or not. FYI, Dip direction is store in the WITSML WellboreMarker companion if present.

Returns: true if this marker has got a dip direction.

◆ setBoundaryFeatureInterpretation()

virtual void resqml2::WellboreMarker::setBoundaryFeatureInterpretation ( BoundaryFeatureInterpretation * interp )

pure virtual

Sets the boundary feature interpretation linked to this well marker.

Exceptions

std::invalid_argument If interp is nullptr.

Parameters

[in] interp The boundary feature interpretation to link to this well marker. It cannot be null.

Implemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

◆ setWitsmlWellboreMarker()

virtual void resqml2::WellboreMarker::setWitsmlWellboreMarker ( witsml2_0::WellboreMarker * wellboreMarker )

pure virtual

Sets the WITSML wellbore marker associated to this instance.

Exceptions

std::invalid_argument If the WITSML wellbore marker to set is NULL.

Parameters

[in] wellbore The WITSML wellbore marker to associate to this wellbore. It cannot be null.

Implemented in resqml2_2::WellboreMarker, and resqml2_0_1::WellboreMarker.

Member Data Documentation

◆ XML_TAG

const char* resqml2::WellboreMarker::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.0.0.0/src/resqml2/WellboreMarker.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~WellboreMarker()

Member Function Documentation

◆ getBoundaryFeatureInterpretation()

◆ getBoundaryFeatureInterpretationDor()

◆ getDipAngleUom()

◆ getDipAngleUomAsString()

◆ getDipAngleValue()

◆ getDipDirectionUom()

◆ getDipDirectionUomAsString()

◆ getDipDirectionValue()

◆ getGeologicBoundaryKind()

◆ getWellboreMarkerFrameRepresentation()

◆ getWitsmlWellboreMarker()

◆ getXmlTag()

◆ hasAGeologicBoundaryKind()

◆ hasDipAngle()

◆ hasDipDirection()

◆ setBoundaryFeatureInterpretation()

◆ setWitsmlWellboreMarker()

Member Data Documentation

◆ XML_TAG