A blocked wellbore representation. This is the information that allows you to locate, on one or several grids (existing or planned), the intersection of volume (cells) and surface (faces) elements with a wellbore trajectory (existing or planned). More...

#include <BlockedWellboreRepresentation.h>

Inheritance diagram for resqml2::BlockedWellboreRepresentation:

Public Member Functions
virtual	~BlockedWellboreRepresentation ()=default

virtual void	setIntervalGridCells (unsigned int const gridIndices, unsigned int gridIndicesNullValue, unsigned int cellCount, uint64_t const cellIndices, unsigned char const localFacePairPerCellIndices, unsigned char localFacePairPerCellIndicesNullValue, eml2::AbstractHdfProxy hdfProxy)=0

virtual uint64_t	getCellCount () const =0

virtual int64_t	getGridIndices (unsigned int *gridIndices) const =0

virtual void	pushBackSupportingGridRepresentation (resqml2::AbstractGridRepresentation *supportingGridRep)=0

virtual unsigned int	getSupportingGridRepresentationCount () const =0

resqml2::AbstractGridRepresentation *	getSupportingGridRepresentation (unsigned int index) const

virtual common::DataObjectReference	getSupportingGridRepresentationDor (unsigned int index) const =0

virtual std::string	getXmlTag () const override

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 blocked wellbore representation. This is the information that allows you to locate, on one or several grids (existing or planned), the intersection of volume (cells) and surface (faces) elements with a wellbore trajectory (existing or planned).

Constructor & Destructor Documentation

◆ ~BlockedWellboreRepresentation()

virtual resqml2::BlockedWellboreRepresentation::~BlockedWellboreRepresentation ( )

virtualdefault

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

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

Member Function Documentation

◆ getCellCount()

virtual uint64_t resqml2::BlockedWellboreRepresentation::getCellCount ( ) const

pure virtual

Gets the cell count, that is to say the number of non-null entries in the grid indices array.

Returns: The cell count.

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

◆ getGridIndices()

virtual int64_t resqml2::BlockedWellboreRepresentation::getGridIndices ( unsigned int * gridIndices ) const

pure virtual

For each interval of the wellbore frame, gets the index of the grid it is associated to.

Exceptions

std::range_error	If the grid indices are stored in an integer constant array and if the the constant value is strictly superior than unsigned int maximum value.
std::logic_error	If the grid indices are neither stored in a HDF5 integer array nor in an integer constant array.

Parameters

[out] gridIndices An array for receiving the grids indices. The size of this array is the interval count of the wellbore frame representation. The associated grids (and there indices) are defined using pushBackSupportingGridRepresentation() method.

Returns: The null value used in gridIndices in order to indicate that an interval does not correspond to any intersected grid.

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

◆ getSupportingGridRepresentation()

resqml2::AbstractGridRepresentation* resqml2::BlockedWellboreRepresentation::getSupportingGridRepresentation ( unsigned int index ) const

Gets the supporting grid representation located at a specific index of this blocked wellbore representation.

Exceptions

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

Parameters

index Zero-based index of the supporting grid representation we look for.

Returns: The supporting grid representation at position index.

◆ getSupportingGridRepresentationCount()

virtual unsigned int resqml2::BlockedWellboreRepresentation::getSupportingGridRepresentationCount ( ) const

pure virtual

Gets the count of supporting grid representations of this blocked wellbore representation.

Exceptions

std::range_error If the count of supporting grid representations is strictly greater than unsigned int max.

Returns: The count of supporting grid representation.

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

◆ getSupportingGridRepresentationDor()

virtual common::DataObjectReference resqml2::BlockedWellboreRepresentation::getSupportingGridRepresentationDor ( unsigned int index ) const

pure virtual

Get the DOR of the supporting grid representation located at a specific index of this blocked wellbore representation.

Exceptions

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

Parameters

index Zero-based index of the supporting grid representation we look for.

Returns: The DOR of the supporting grid representation at position index.

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

◆ getXmlTag()

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

inlineoverridevirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ pushBackSupportingGridRepresentation()

virtual void resqml2::BlockedWellboreRepresentation::pushBackSupportingGridRepresentation ( resqml2::AbstractGridRepresentation * supportingGridRep )

pure virtual

Pushes back a grid representation which is one of the support of this representation.

Exceptions

std::invalid_argument If supportingGridRep == nullptr.

Parameters

[in] supportingGridRep The supporting grid representation to push back.

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

◆ setIntervalGridCells()

virtual void resqml2::BlockedWellboreRepresentation::setIntervalGridCells	(	unsigned int const *	gridIndices,
		unsigned int	gridIndicesNullValue,
		unsigned int	cellCount,
		uint64_t const *	cellIndices,
		unsigned char const *	localFacePairPerCellIndices,
		unsigned char	localFacePairPerCellIndicesNullValue,
		eml2::AbstractHdfProxy *	hdfProxy
	)

pure virtual

Sets all information about the intersected grid cells. You must first provide MD values of the frame before to use this method.

Exceptions

std::invalid_argument	If `gridIndices`, `cellIndices`, `localFacePairPerCellIndices` or `hdfProxy` is `nullptr`.
std::invalid_argument	If `cellCount == 0`.
std::logic_error	If MD values of the frame have not been provided before using this method.

Parameters

	gridIndices	An array containing for each interval of the wellbore frame, the index of the grid it is associated to. The size of this array is the interval count of the wellbore frame representation. `cellCount` must equal the number of non- null entries in this array. The associated grids (and there indices) are defined using pushBackSupportingGridRepresentation() method.
	gridIndicesNullValue	The null value used in `gridIndices` in order to indicate that an interval does not correspond to any intersected grid.
	cellCount	The number of non-null entries in `gridIndices`.
	cellIndices	An array containing the intersected cell index for each non-null entry in `gridIndices`. They are ordered according to non-null entries of `gridIndices`. The array length must equal `cellCount`.
	localFacePairPerCellIndices	An array containing, for each cell, the entry and exit intersection faces of the trajectory in the cell. The array dimension must equal `2 * cellCount`.
	localFacePairPerCellIndicesNullValue	The null value used in `localFacePerCellIndices` in order to indicate that it corresponds to a missing intersection, e.g., when a trajectory originates or terminates within a cell.
[in,out]	hdfProxy	The HDF proxy where the numerical values will be stored. It must be already opened for writing and won't be closed.It cannot be `nullptr`.

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

Member Data Documentation

◆ XML_TAG

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

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BlockedWellboreRepresentation()

Member Function Documentation

◆ getCellCount()

◆ getGridIndices()

◆ getSupportingGridRepresentation()

◆ getSupportingGridRepresentationCount()

◆ getSupportingGridRepresentationDor()

◆ getXmlTag()

◆ pushBackSupportingGridRepresentation()

◆ setIntervalGridCells()

Member Data Documentation

◆ XML_TAG