A well log frame where each entry represents a well marker. More...

#include <WellboreMarkerFrameRepresentation.h>

Inheritance diagram for resqml2::WellboreMarkerFrameRepresentation:

Public Member Functions
virtual	~WellboreMarkerFrameRepresentation ()=default

virtual void	setStratigraphicOccurrenceInterpretation (StratigraphicOccurrenceInterpretation *stratiOccurrenceInterp)=0
	Sets stratigraphic occurrence interpretation associated to this wellbore marker frame representation. More...

virtual void	setIntervalStratigraphicUnits (unsigned int const stratiUnitIndices, unsigned int nullValue, StratigraphicOccurrenceInterpretation stratiOccurrenceInterp, eml2::AbstractHdfProxy *proxy)=0
	Sets the correspondence between the intervals of this wellbore marker frame representation and the units of a stratigraphic column rank interpretation of a stratigraphic occurrence interpretation. More...

virtual common::DataObjectReference	getStratigraphicOccurrenceInterpretationDor () const =0

StratigraphicOccurrenceInterpretation *	getStratigraphicOccurrenceInterpretation () const

virtual std::string	getXmlTag () const final

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

void	setMdValues (double const mdValues, unsigned int mdValueCount, eml2::AbstractHdfProxy proxy=nullptr)

void	setMdValues (double firstMdValue, double incrementMdValue, unsigned int mdValueCount)

bool	areMdValuesRegularlySpaced () const

double	getMdConstantIncrementValue () const

double	getMdFirstValue () const

unsigned int	getMdValuesCount () const

uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const override

void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const override

common::AbstractObject::hdfDatatypeEnum	getMdHdfDatatype () const

void	getMdAsDoubleValues (double *values) const

void	getMdAsFloatValues (float *values) const

common::DataObjectReference	getWellboreTrajectoryDor () const

class WellboreTrajectoryRepresentation *	getWellboreTrajectory () const

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

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

unsigned int	getPatchCount () const final

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

class AbstractLocal3dCrs *	getLocalCrs (unsigned int patchIndex) const

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

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

uint64_t	getXyzPointCountOfAllPatches () const

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. More...

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

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, unsigned int 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

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

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

Additional Inherited Members
Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement { NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 , PILLAR = 4 }

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

A well log frame where each entry represents a well marker.

Constructor & Destructor Documentation

◆ ~WellboreMarkerFrameRepresentation()

virtual resqml2::WellboreMarkerFrameRepresentation::~WellboreMarkerFrameRepresentation ( )

virtualdefault

Cleans the owned markers.

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

Member Function Documentation

◆ getStratigraphicOccurrenceInterpretation()

StratigraphicOccurrenceInterpretation* resqml2::WellboreMarkerFrameRepresentation::getStratigraphicOccurrenceInterpretation ( ) const

Gets the stratigraphic occurrence interpretation associated to this wellbore marker frame representation.

Returns: The associated stratigraphic occurrence interpretation if there is one, else nullptr if not.

◆ getStratigraphicOccurrenceInterpretationDor()

virtual common::DataObjectReference resqml2::WellboreMarkerFrameRepresentation::getStratigraphicOccurrenceInterpretationDor ( ) const

pure virtual

Gets the DOR of the stratigraphic occurrence interpretation associated to this wellbore marker frame representation.

Returns: The DOR of the associated stratigraphic occurrence interpretation if there is one, else empty DOR if not.

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

◆ getXmlTag()

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

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ setIntervalStratigraphicUnits()

virtual void resqml2::WellboreMarkerFrameRepresentation::setIntervalStratigraphicUnits	(	unsigned int const *	stratiUnitIndices,
		unsigned int	nullValue,
		StratigraphicOccurrenceInterpretation *	stratiOccurrenceInterp,
		eml2::AbstractHdfProxy *	proxy
	)

pure virtual

Sets the correspondence between the intervals of this wellbore marker frame representation and the units of a stratigraphic column rank interpretation of a stratigraphic occurrence interpretation.

Exceptions

std::invalid_argument If stratiUnitIndices, stratiOccurenceInterp or proxy is nullptr.

Parameters

[in]	stratiUnitIndices	The index of the stratigraphic unit per interval, of a given stratigraphic column. The count must be equal to the count of wellbore marker intervals (getWellboreMarkerCount() `- 1` ).
	nullValue	The value which is used to tell that there is no correspondence between stratigraphic units and a particular interval (e.g., within salt, use this null value).
[in]	stratiOccurrenceInterp	The stratigraphic occurrence interpretation to associate to this wellbore marker frame representation.
[in,out]	proxy	The HDF proxy where the numerical values (indices) are stored.

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

◆ setStratigraphicOccurrenceInterpretation()

virtual void resqml2::WellboreMarkerFrameRepresentation::setStratigraphicOccurrenceInterpretation ( StratigraphicOccurrenceInterpretation * stratiOccurrenceInterp )

pure virtual

Sets stratigraphic occurrence interpretation associated to this wellbore marker frame representation.

Exceptions

std::invalid_argument If stratiOccurenceInterp is nullptr.

Parameters

[in] stratiOccurrenceInterp The stratigraphic occurrence interpretation to set.

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

Member Data Documentation

◆ XML_TAG

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~WellboreMarkerFrameRepresentation()

Member Function Documentation

◆ getStratigraphicOccurrenceInterpretation()

◆ getStratigraphicOccurrenceInterpretationDor()

◆ getXmlTag()

◆ setIntervalStratigraphicUnits()

◆ setStratigraphicOccurrenceInterpretation()

Member Data Documentation

◆ XML_TAG