Fesapi  0.13.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_NS::BlockedWellboreRepresentation Class Reference
Inheritance diagram for RESQML2_0_1_NS::BlockedWellboreRepresentation:
RESQML2_0_1_NS::WellboreFrameRepresentation RESQML2_NS::AbstractRepresentation COMMON_NS::AbstractObject

Public Member Functions

 BlockedWellboreRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 BlockedWellboreRepresentation (class WellboreInterpretation *interp, const std::string &guid, const std::string &title, class WellboreTrajectoryRepresentation *traj)
 
 BlockedWellboreRepresentation (gsoap_resqml2_0_1::_resqml2__BlockedWellboreRepresentation *fromGsoap)
 
 ~BlockedWellboreRepresentation ()
 
std::string getXmlTag () const
 
void setIntevalGridCells (unsigned int *gridIndices, unsigned int gridIndicesNullValue, unsigned int cellCount, ULONG64 *cellIndices, unsigned char *localFacePairPerCellIndices, unsigned char localFacePairPerCellIndicesNullValue, COMMON_NS::AbstractHdfProxy *hdfProxy)
 
ULONG64 getCellCount () const
 
unsigned int getGridIndices (unsigned int *gridIndices) const
 
void pushBackSupportingGridRepresentation (RESQML2_NS::AbstractGridRepresentation *supportingGridRep)
 
unsigned int getSupportingGridRepresentationCount () const
 
RESQML2_NS::AbstractGridRepresentationgetSupportingGridRepresentation (unsigned int index) const
 
gsoap_resqml2_0_1::eml20__DataObjectReference * getSupportingGridRepresentationDor (unsigned int index) const
 
std::string getSupportingGridRepresentationUuid (unsigned int index) const
 
- Public Member Functions inherited from RESQML2_0_1_NS::WellboreFrameRepresentation
 WellboreFrameRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 WellboreFrameRepresentation (class WellboreInterpretation *interp, const std::string &guid, const std::string &title, class WellboreTrajectoryRepresentation *traj)
 
 WellboreFrameRepresentation (gsoap_resqml2_0_1::_resqml2__WellboreFrameRepresentation *fromGsoap)
 
void setMdValues (double *mdValues, const unsigned int &mdValueCount, COMMON_NS::AbstractHdfProxy *proxy)
 
void setMdValues (const double &firstMdValue, const double &incrementMdValue, const unsigned int &mdValueCount)
 
bool areMdValuesRegularlySpaced () const
 
double getMdConstantIncrementValue () const
 
double getMdFirstValue () const
 
unsigned int getMdValuesCount () const
 
ULONG64 getXyzPointCountOfPatch (const unsigned int &patchIndex) const
 
void getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
 
RESQML2_NS::AbstractValuesProperty::hdfDatatypeEnum getMdHdfDatatype () const
 
void getMdAsDoubleValues (double *values)
 
void getMdAsFloatValues (float *values)
 
std::string getWellboreTrajectoryUuid () const
 
class WellboreTrajectoryRepresentationgetWellboreTrajectory ()
 
gsoap_resqml2_0_1::eml20__DataObjectReference * getLocalCrsDor () const
 
std::string getHdfProxyUuid () const
 
unsigned int getPatchCount () const
 
void setWitsmlLog (WITSML1_4_1_1_NS::Log *witsmlLogToSet)
 
WITSML1_4_1_1_NS::LoggetWitsmlLog ()
 
- Public Member Functions inherited from RESQML2_NS::AbstractRepresentation
virtual ~AbstractRepresentation ()
 
class AbstractLocal3dCrsgetLocalCrs () const
 
std::string getLocalCrsUuid () const
 
COMMON_NS::AbstractHdfProxygetHdfProxy () const
 
const std::vector< class AbstractProperty * > & getPropertySet () const
 
std::vector< class AbstractValuesProperty * > getValuesPropertySet () const
 
unsigned int getValuesPropertyCount () const
 
class AbstractValuesPropertygetValuesProperty (const unsigned int &index) const
 
void setInterpretation (class AbstractFeatureInterpretation *interp)
 
class AbstractFeatureInterpretationgetInterpretation () 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
 
SubRepresentationgetSubRepresentation (const unsigned int &index) const
 
std::vector< SubRepresentation * > getFaultSubRepresentationSet () const
 
unsigned int getFaultSubRepresentationCount () const
 
SubRepresentationgetFaultSubRepresentation (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
 
AbstractRepresentationgetSeismicSupportOfPatch (const unsigned int &patchIndex) const
 
std::set< AbstractRepresentation * > getAllSeismicSupport () const
 
void pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet, bool xml=true)
 
ULONG64 getRepresentationSetRepresentationCount () const
 
RepresentationSetRepresentationgetRepresentationSetRepresentation (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::EpcDocumentgetEpcDocument () 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::ActivitygetActivity (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 = "BlockedWellboreRepresentation"
 
- Static Public Attributes inherited from RESQML2_0_1_NS::WellboreFrameRepresentation
static const char * XML_TAG = "WellboreFrameRepresentation"
 
- Static Public Attributes inherited from RESQML2_NS::AbstractRepresentation
static const char * XML_TAG = "AbstractRepresentation"
 

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 }
 
- Protected Member Functions inherited from RESQML2_0_1_NS::WellboreFrameRepresentation
gsoap_resqml2_0_1::resqml2__PointGeometry * getPointGeometry2_0_1 (const unsigned int &patchIndex) const
 
 WellboreFrameRepresentation (RESQML2_NS::AbstractFeatureInterpretation *interp, RESQML2_NS::AbstractLocal3dCrs *crs)
 
- 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 ()
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 
- Protected Attributes inherited from RESQML2_0_1_NS::WellboreFrameRepresentation
class WellboreTrajectoryRepresentationtrajectory
 
WITSML1_4_1_1_NS::LogwitsmlLog
 
- Protected Attributes inherited from RESQML2_NS::AbstractRepresentation
class AbstractFeatureInterpretationinterpretation
 
COMMON_NS::AbstractHdfProxyhdfProxy
 
class AbstractLocal3dCrslocalCrs
 
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::EpcDocumentepcDocument
 
std::vector< RESQML2_NS::Activity * > activitySet
 
bool updateXml
 

Constructor & Destructor Documentation

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

Only to be used in partial transfer context

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

Creates an instance of this class in a gsoap context.

Parameters
interpThe interpretation the instance represents.
guidA guid for the instance to create.
titleA title for the instance to create.
trajThe wellbore trajectory this intance is based on.
RESQML2_0_1_NS::BlockedWellboreRepresentation::BlockedWellboreRepresentation ( gsoap_resqml2_0_1::_resqml2__BlockedWellboreRepresentation *  fromGsoap)
inline

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

RESQML2_0_1_NS::BlockedWellboreRepresentation::~BlockedWellboreRepresentation ( )
inline

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

Member Function Documentation

ULONG64 BlockedWellboreRepresentation::getCellCount ( ) const

The number of non-null entries in the grid indices array.

unsigned int BlockedWellboreRepresentation::getGridIndices ( unsigned int *  gridIndices) const

Size of array = IntervalCount on the wellbore frame rep. The grids (and there indices) are defined using pushBackSupportingGridRepresentation method.

Returns
nullValue
RESQML2_NS::AbstractGridRepresentation * BlockedWellboreRepresentation::getSupportingGridRepresentation ( unsigned int  index) const

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

unsigned int BlockedWellboreRepresentation::getSupportingGridRepresentationCount ( ) const

Get the count of the supporting grid representations of this grid connection representation.

gsoap_resqml2_0_1::eml20__DataObjectReference * BlockedWellboreRepresentation::getSupportingGridRepresentationDor ( unsigned int  index) const

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

std::string BlockedWellboreRepresentation::getSupportingGridRepresentationUuid ( unsigned int  index) const

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

std::string RESQML2_0_1_NS::BlockedWellboreRepresentation::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Reimplemented from RESQML2_0_1_NS::WellboreFrameRepresentation.

void BlockedWellboreRepresentation::pushBackSupportingGridRepresentation ( RESQML2_NS::AbstractGridRepresentation supportingGridRep)

Pushes back a grid representation which is one of the support of this representation. And push back this representation as a grid connection information of the grid representation as well.

void BlockedWellboreRepresentation::setIntevalGridCells ( unsigned int *  gridIndices,
unsigned int  gridIndicesNullValue,
unsigned int  cellCount,
ULONG64 *  cellIndices,
unsigned char *  localFacePairPerCellIndices,
unsigned char  localFacePairPerCellIndicesNullValue,
COMMON_NS::AbstractHdfProxy hdfProxy 
)

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

Parameters
gridIndicesSize of array = IntervalCount on the wellbore frame rep. BUSINESS RULE: The cell count must equal the number of non-null entries in this array. The grids (and there indices) are defined using pushBackSupportingGridRepresentation method.
gridIndicesNullValueThe null value used in gridIndices in order to indicate that an interval deos not correspond to any intersected grid.
cellCountThe number of non-null entries in the grid indices array.
cellIndicesThe intersected cell index for each non null gridIndices. They are ordered according to non null gridIndices. Array length must equal cell count.
localFacePairPerCellIndicesFor each cell, these are the entry and exit intersection faces of the trajectory in the cell. The array dimensions must equal 2 x 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.
hdfProxyThe hdf proxy where the numerical values will be stored.

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