Fesapi  2.0.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Public Member Functions | Static Public Attributes | List of all members
resqml2_0_1::BlockedWellboreRepresentation Class Referencefinal

#include <BlockedWellboreRepresentation.h>

Inheritance diagram for resqml2_0_1::BlockedWellboreRepresentation:
resqml2::BlockedWellboreRepresentation resqml2::WellboreFrameRepresentation resqml2::AbstractRepresentation common::AbstractObject

Public Member Functions

 BlockedWellboreRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 BlockedWellboreRepresentation (resqml2::WellboreInterpretation *interp, const std::string &guid, const std::string &title, resqml2::WellboreTrajectoryRepresentation *traj)
 Creates an instance of this class in a gsoap context. More...
 
 BlockedWellboreRepresentation (gsoap_resqml2_0_1::_resqml20__BlockedWellboreRepresentation *fromGsoap)
 
 ~BlockedWellboreRepresentation ()=default
 
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) final
 
uint64_t getCellCount () const final
 
int64_t getGridIndices (unsigned int *gridIndices) const final
 
void pushBackSupportingGridRepresentation (resqml2::AbstractGridRepresentation *supportingGridRep) final
 
unsigned int getSupportingGridRepresentationCount () const final
 
common::DataObjectReference getSupportingGridRepresentationDor (unsigned int index) const final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::BlockedWellboreRepresentation
resqml2::AbstractGridRepresentationgetSupportingGridRepresentation (unsigned int index) const
 
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 WellboreTrajectoryRepresentationgetWellboreTrajectory () 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 AbstractLocal3dCrsgetLocalCrs (unsigned int patchIndex) const
 
std::vector< class AbstractProperty * > getPropertySet () const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () 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
 
AbstractRepresentationgetSeismicSupportOfPatch (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::DataObjectRepositorygetRepository () const
 
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::ActivitygetActivity (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_NS
 
- Static Public Attributes inherited from resqml2::BlockedWellboreRepresentation
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.

Constructor & Destructor Documentation

◆ BlockedWellboreRepresentation() [1/3]

resqml2_0_1::BlockedWellboreRepresentation::BlockedWellboreRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

Parameters
[in,out]partialObjectIf non-null, the partial object.

◆ BlockedWellboreRepresentation() [2/3]

resqml2_0_1::BlockedWellboreRepresentation::BlockedWellboreRepresentation ( resqml2::WellboreInterpretation interp,
const std::string &  guid,
const std::string &  title,
resqml2::WellboreTrajectoryRepresentation traj 
)

Creates an instance of this class in a gsoap context.

Exceptions
std::invalid_argumentIf traj == nullptr.
Parameters
[in]interpThe interpretation the instance represents.
guidA guid for the instance to create.
titleA title for the instance to create.
[in]trajThe wellbore trajectory this intance is based on.

◆ BlockedWellboreRepresentation() [3/3]

resqml2_0_1::BlockedWellboreRepresentation::BlockedWellboreRepresentation ( gsoap_resqml2_0_1::_resqml20__BlockedWellboreRepresentation *  fromGsoap)
inline

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

Parameters
[in,out]fromGsoapIf non-null, from gsoap.

◆ ~BlockedWellboreRepresentation()

resqml2_0_1::BlockedWellboreRepresentation::~BlockedWellboreRepresentation ( )
virtualdefault

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

Reimplemented from resqml2::BlockedWellboreRepresentation.

Member Function Documentation

◆ getCellCount()

uint64_t resqml2_0_1::BlockedWellboreRepresentation::getCellCount ( ) const
finalvirtual

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

Returns
The cell count.

Implements resqml2::BlockedWellboreRepresentation.

◆ getGridIndices()

int64_t resqml2_0_1::BlockedWellboreRepresentation::getGridIndices ( unsigned int *  gridIndices) const
finalvirtual

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

Exceptions
std::range_errorIf 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_errorIf the grid indices are neither stored in a HDF5 integer array nor in an integer constant array.
Parameters
[out]gridIndicesAn 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.

Implements resqml2::BlockedWellboreRepresentation.

◆ getSupportingGridRepresentationCount()

unsigned int resqml2_0_1::BlockedWellboreRepresentation::getSupportingGridRepresentationCount ( ) const
finalvirtual

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

Exceptions
std::range_errorIf the count of supporting grid representations is strictly greater than unsigned int max.
Returns
The count of supporting grid representation.

Implements resqml2::BlockedWellboreRepresentation.

◆ getSupportingGridRepresentationDor()

common::DataObjectReference resqml2_0_1::BlockedWellboreRepresentation::getSupportingGridRepresentationDor ( unsigned int  index) const
finalvirtual

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

Exceptions
std::out_of_rangeIf index >= getSupportingGridRepresentationCount().
Parameters
indexZero-based index of the supporting grid representation we look for.
Returns
The DOR of the supporting grid representation at position index.

Implements resqml2::BlockedWellboreRepresentation.

◆ getXmlNamespace()

std::string resqml2_0_1::BlockedWellboreRepresentation::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ pushBackSupportingGridRepresentation()

void resqml2_0_1::BlockedWellboreRepresentation::pushBackSupportingGridRepresentation ( resqml2::AbstractGridRepresentation supportingGridRep)
finalvirtual

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

Exceptions
std::invalid_argumentIf supportingGridRep == nullptr.
Parameters
[in]supportingGridRepThe supporting grid representation to push back.

Implements resqml2::BlockedWellboreRepresentation.

◆ setIntervalGridCells()

void resqml2_0_1::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 
)
finalvirtual

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_argumentIf gridIndices, cellIndices, localFacePairPerCellIndices or hdfProxy is nullptr.
std::invalid_argumentIf cellCount == 0.
std::logic_errorIf MD values of the frame have not been provided before using this method.
Parameters
gridIndicesAn 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.
gridIndicesNullValueThe null value used in gridIndices in order to indicate that an interval does not correspond to any intersected grid.
cellCountThe number of non-null entries in gridIndices.
cellIndicesAn 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.
localFacePairPerCellIndicesAn array containing, for each cell, the entry and exit intersection faces of the trajectory in the cell. The array dimension must equal 2 * cellCount.
localFacePairPerCellIndicesNullValueThe 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]hdfProxyThe 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.

Implements resqml2::BlockedWellboreRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::BlockedWellboreRepresentation::XML_NS
static

The standard XML namespace for serializing this data object.


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