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 | Friends | List of all members
RESQML2_0_1_NS::DeviationSurveyRepresentation Class Reference
Inheritance diagram for RESQML2_0_1_NS::DeviationSurveyRepresentation:
RESQML2_NS::AbstractRepresentation COMMON_NS::AbstractObject

Public Member Functions

 DeviationSurveyRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 DeviationSurveyRepresentation (class WellboreInterpretation *interp, const std::string &guid, const std::string &title, const bool &isFinal, RESQML2_NS::MdDatum *mdInfo)
 
 DeviationSurveyRepresentation (gsoap_resqml2_0_1::_resqml2__DeviationSurveyRepresentation *fromGsoap)
 
virtual std::string getXmlTag () const
 
void setGeometry (double *firstStationLocation, const ULONG64 &stationCount, const gsoap_resqml2_0_1::eml20__LengthUom &mdUom, double *mds, const gsoap_resqml2_0_1::eml20__PlaneAngleUom &angleUom, double *azimuths, double *inclinations, COMMON_NS::AbstractHdfProxy *proxy)
 
void setMdDatum (RESQML2_NS::MdDatum *mdDatum)
 
gsoap_resqml2_0_1::eml20__DataObjectReference * getMdDatumDor () const
 
RESQML2_NS::MdDatumgetMdDatum () const
 
std::string getMdDatumUuid () const
 
bool isFinal () const
 
ULONG64 getXyzPointCountOfPatch (const unsigned int &patchIndex) const
 
void getXyzPointsOfPatch (const unsigned int &patchIndex, double *xyzPoints) const
 
gsoap_resqml2_0_1::eml20__LengthUom getMdUom () const
 
gsoap_resqml2_0_1::eml20__PlaneAngleUom getAngleUom () const
 
void getMdValues (double *values)
 
void getInclinations (double *values)
 
void getAzimuths (double *values)
 
std::vector< class WellboreFrameRepresentation * > getWellboreFrameRepresentationSet () const
 
unsigned int getWellboreFrameRepresentationCount () const
 
class WellboreFrameRepresentationgetWellboreFrameRepresentation (unsigned int index) const
 
const std::vector< class WellboreTrajectoryRepresentation * > & getWellboreTrajectoryRepresentationSet () const
 
unsigned int getWellboreTrajectoryRepresentationCount () const
 
class WellboreTrajectoryRepresentationgetWellboreTrajectoryRepresentation (const unsigned int &index) const
 
std::string getHdfProxyUuid () const
 
unsigned int getPatchCount () const
 
- Public Member Functions inherited from RESQML2_NS::AbstractRepresentation
virtual ~AbstractRepresentation ()
 
class AbstractLocal3dCrsgetLocalCrs () const
 
virtual gsoap_resqml2_0_1::eml20__DataObjectReference * getLocalCrsDor () 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 = "DeviationSurveyRepresentation"
 
- Static Public Attributes inherited from RESQML2_NS::AbstractRepresentation
static const char * XML_TAG = "AbstractRepresentation"
 

Protected Member Functions

void addTrajectory (class WellboreTrajectoryRepresentation *trajectory)
 
std::vector< epc::RelationshipgetAllEpcRelationships () const
 
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)
 
virtual gsoap_resqml2_0_1::resqml2__PointGeometry * getPointGeometry2_0_1 (const unsigned int &patchIndex) const
 
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

std::vector< class WellboreTrajectoryRepresentation * > wbTrajectoryRepSet
 
- 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
 

Friends

void WellboreTrajectoryRepresentation::setDeviationSurvey (DeviationSurveyRepresentation *deviationSurvey)
 

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::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference *  partialObject)
inline

Only to be used in partial transfer context

RESQML2_0_1_NS::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( class WellboreInterpretation interp,
const std::string &  guid,
const std::string &  title,
const bool &  isFinal,
RESQML2_NS::MdDatum mdInfo 
)

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.
isFinalUsed to indicate that this is a final version of the deviation survey, as distinct from the interim interpretations.
mdInfoThe MD information of the survey, mainly the well reference point.
RESQML2_0_1_NS::DeviationSurveyRepresentation::DeviationSurveyRepresentation ( gsoap_resqml2_0_1::_resqml2__DeviationSurveyRepresentation *  fromGsoap)
inline

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

Member Function Documentation

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

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

Reimplemented from RESQML2_NS::AbstractRepresentation.

gsoap_resqml2_0_1::eml20__PlaneAngleUom DeviationSurveyRepresentation::getAngleUom ( ) const

Defines the units of measure for the azimuth and inclination

void DeviationSurveyRepresentation::getAzimuths ( double *  values)

Getter of the azimuth double values associated to each trajectory station of this WellboreFeature trajectory representation. The rotation is relative to the projected CRS north with a positive value indicating a clockwise rotation as seen from above. Uom is given by getAngleUom().

Parameters
valuesIt must preallocated with a count of getXyzPointCountOfPatch(0)
void DeviationSurveyRepresentation::getInclinations ( double *  values)

Getter of the inclination double values associated to each trajectory station of this WellboreFeature trajectory representation. Uom is given by getAngleUom().

Parameters
valuesIt must preallocated with a count of getXyzPointCountOfPatch(0)
RESQML2_NS::MdDatum * DeviationSurveyRepresentation::getMdDatum ( ) const

Getter of the md information associated to this WellboreFeature trajectory representation.

gsoap_resqml2_0_1::eml20__DataObjectReference* RESQML2_0_1_NS::DeviationSurveyRepresentation::getMdDatumDor ( ) const
Returns
null pointer if no md datum is associated to this representation. Otherwise return the data object reference of the associated md datum.
std::string DeviationSurveyRepresentation::getMdDatumUuid ( ) const

Getter of the md information uuid associated to this WellboreFeature trajectory representation.

gsoap_resqml2_0_1::eml20__LengthUom DeviationSurveyRepresentation::getMdUom ( ) const

Units of measure of the measured depths along this deviation survey.

void DeviationSurveyRepresentation::getMdValues ( double *  values)

Getter of the md double values associated to each trajectory station of this WellboreFeature trajectory representation. Uom is given by getMdUom().

Parameters
valuesIt must preallocated with a count of getXyzPointCountOfPatch(0)
WellboreFrameRepresentation * DeviationSurveyRepresentation::getWellboreFrameRepresentation ( unsigned int  index) const

Get a particular wellbore frame representation according to its position. Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet. Throw an out of bound exception if the index is superior or equal to the count of wellbore frame representation.

unsigned int DeviationSurveyRepresentation::getWellboreFrameRepresentationCount ( ) const

Get the count of all the wellbore frame representations of associated wellbore trajectory which share the same md datum and md uom. Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet.

vector< WellboreFrameRepresentation * > DeviationSurveyRepresentation::getWellboreFrameRepresentationSet ( ) const

Getter of all the wellbore frame representations of associated wellbore trajectory which share the same md datum and md uom.

WellboreTrajectoryRepresentation * DeviationSurveyRepresentation::getWellboreTrajectoryRepresentation ( const unsigned int &  index) const

Get a particular wellbore trajectory according to its position. Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet. Throw an out of bound exception if the index is superior or equal to the count of wellbore frame representation.

unsigned int DeviationSurveyRepresentation::getWellboreTrajectoryRepresentationCount ( ) const

Get the count of all the wellbore trajectories which are associated to this deviation survey. Necessary for now in SWIG context because I am not sure if I can always wrap a vector of polymorphic class yet.

const std::vector< class WellboreTrajectoryRepresentation * > & DeviationSurveyRepresentation::getWellboreTrajectoryRepresentationSet ( ) const

Getter (in read only mode) of all the wellbore trajectories which are associated to this deviation survey.

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

Get the XML tag for the XML serialization of this instance

Implements COMMON_NS::AbstractObject.

ULONG64 DeviationSurveyRepresentation::getXyzPointCountOfPatch ( const unsigned int &  patchIndex) const
virtual

Get the xyz point count in a given patch.

Implements RESQML2_NS::AbstractRepresentation.

void DeviationSurveyRepresentation::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 DeviationSurveyRepresentation::importRelationshipSetFromEpc ( COMMON_NS::EpcDocument epcDoc)
protectedvirtual

Resolve all relationships of the object in an epc document

Reimplemented from RESQML2_NS::AbstractRepresentation.

bool DeviationSurveyRepresentation::isFinal ( ) const

Used to indicate that this is a final version of the deviation survey, as distinct from the interim interpretations.

void DeviationSurveyRepresentation::setMdDatum ( RESQML2_NS::MdDatum mdDatum)

Set the Md datum of this trajectory


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