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 | Protected Member Functions | Protected Attributes | List of all members
RESQML2_0_1_NS::WellboreFrameRepresentation Class Reference
Inheritance diagram for RESQML2_0_1_NS::WellboreFrameRepresentation:
RESQML2_NS::AbstractRepresentation COMMON_NS::AbstractObject RESQML2_0_1_NS::BlockedWellboreRepresentation RESQML2_0_1_NS::WellboreMarkerFrameRepresentation

Public Member Functions

 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 ()
 
virtual std::string getXmlTag () const
 
- 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 = "WellboreFrameRepresentation"
 
- Static Public Attributes inherited from RESQML2_NS::AbstractRepresentation
static const char * XML_TAG = "AbstractRepresentation"
 

Protected Member Functions

gsoap_resqml2_0_1::resqml2__PointGeometry * getPointGeometry2_0_1 (const unsigned int &patchIndex) const
 
 WellboreFrameRepresentation (RESQML2_NS::AbstractFeatureInterpretation *interp, RESQML2_NS::AbstractLocal3dCrs *crs)
 
virtual std::vector< epc::RelationshipgetAllEpcRelationships () const
 
virtual void importRelationshipSetFromEpc (COMMON_NS::EpcDocument *epcDoc)
 
- 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 ()
 

Protected Attributes

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
 

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 }
 
- Static Protected Member Functions inherited from COMMON_NS::AbstractObject
static void addActivityToResqmlObject (RESQML2_NS::Activity *activity, AbstractObject *resqmlObject)
 

Constructor & Destructor Documentation

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

Only to be used in partial transfer context

RESQML2_0_1_NS::WellboreFrameRepresentation::WellboreFrameRepresentation ( 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 WellboreFeature interpretation the instance represents.
guidThe guid to set to the new instance. If empty then a new guid will be generated.
titleA title for the instance to create.
trajThe trajectory this WellboreFeature frame is based on.
RESQML2_0_1_NS::WellboreFrameRepresentation::WellboreFrameRepresentation ( gsoap_resqml2_0_1::_resqml2__WellboreFrameRepresentation *  fromGsoap)
inline

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

Member Function Documentation

bool WellboreFrameRepresentation::areMdValuesRegularlySpaced ( ) const

Indicates either the MDs are regularly spaced or not (useful for optimization) Does not verify if the writer has used a generic array to store regular mds.

vector< Relationship > WellboreFrameRepresentation::getAllEpcRelationships ( ) const
protectedvirtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Reimplemented from RESQML2_NS::AbstractRepresentation.

Reimplemented in RESQML2_0_1_NS::WellboreMarkerFrameRepresentation.

gsoap_resqml2_0_1::eml20__DataObjectReference * WellboreFrameRepresentation::getLocalCrsDor ( ) const
virtual

Get the Local 3d CRS dor where the reference point ordinals are given

Reimplemented from RESQML2_NS::AbstractRepresentation.

void WellboreFrameRepresentation::getMdAsDoubleValues ( double *  values)

Get all the md values of the instance which are supposed to be double ones.

void WellboreFrameRepresentation::getMdAsFloatValues ( float *  values)

Get all the md values of the instance which are supposed to be float ones.

double WellboreFrameRepresentation::getMdConstantIncrementValue ( ) const

Indicates the incremetn value between two MDs only if the MDs are regualrly spaced. Please use areMdValuesRegularlySpaced before using this method.

double WellboreFrameRepresentation::getMdFirstValue ( ) const

Returns the first MD value of this WellboreFrameRepresentation

RESQML2_NS::AbstractValuesProperty::hdfDatatypeEnum WellboreFrameRepresentation::getMdHdfDatatype ( ) const

Get the Measured Depth datatype in the HDF dataset

unsigned int WellboreFrameRepresentation::getMdValuesCount ( ) const

Get the number of Md values in this WellboreFeature frame.

gsoap_resqml2_0_1::resqml2__PointGeometry* RESQML2_0_1_NS::WellboreFrameRepresentation::getPointGeometry2_0_1 ( const unsigned int &  patchIndex) const
inlineprotectedvirtual

Get the point geometry of a specific patch of the representation.

Returns
nullptr if there is no point geometry for this particular patch otherwise the found point geometry.

Reimplemented from RESQML2_NS::AbstractRepresentation.

class WellboreTrajectoryRepresentation* RESQML2_0_1_NS::WellboreFrameRepresentation::getWellboreTrajectory ( )
inline

Get the associated resqml wellbore trajector

std::string WellboreFrameRepresentation::getWellboreTrajectoryUuid ( ) const

Get the associated resqml wellbore trajectory uuid

virtual std::string RESQML2_0_1_NS::WellboreFrameRepresentation::getXmlTag ( ) const
inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

Reimplemented in RESQML2_0_1_NS::WellboreMarkerFrameRepresentation, and RESQML2_0_1_NS::BlockedWellboreRepresentation.

ULONG64 RESQML2_0_1_NS::WellboreFrameRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex) const
inlinevirtual

Get the xyz point count in a given patch.

Implements RESQML2_NS::AbstractRepresentation.

void WellboreFrameRepresentation::getXyzPointsOfPatch ( const unsigned int &  patchIndex,
double *  xyzPoints 
) const
virtual

Get all the XYZ points of a particular patch of this representation. XYZ points are given in the local CRS.

Parameters
xyzPointsA linearized 2d array where the first (quickest) dimension is coordinate dimension (XYZ) and second dimension is vertex dimension. It must be pre allocated.

Implements RESQML2_NS::AbstractRepresentation.

void WellboreFrameRepresentation::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument epcDoc)
protectedvirtual

Resolve all relationships of the object in an epc document

Reimplemented from RESQML2_NS::AbstractRepresentation.

Reimplemented in RESQML2_0_1_NS::WellboreMarkerFrameRepresentation.

void WellboreFrameRepresentation::setMdValues ( double *  mdValues,
const unsigned int &  mdValueCount,
COMMON_NS::AbstractHdfProxy proxy 
)

Set the MD values of this WellboreFrameRepresentation frame to an array 1d of explicit values.

Parameters
mdValuesAll the MD values to set from top of the well trajectory to bottom.
mdValueCountThe MD values count.
proxyThe HDF proxy where to write the MD values. It must be already opened for writing and won't be closed in this method.
void WellboreFrameRepresentation::setMdValues ( const double &  firstMdValue,
const double &  incrementMdValue,
const unsigned int &  mdValueCount 
)

Set the MD values of this WellboreFrameRepresentation frame as a regular discretization along the wellbore trajectory.

Parameters
firstMdValueThe first MD value.
incrementMdValueThe increment value between two Measured depth.
mdValueCountThe count of md values in this WellboreFrameRepresentation.

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