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_2::MdDatum Class Referencefinal

#include <MdDatum.h>

Inheritance diagram for resqml2_2::MdDatum:
resqml2::MdDatum common::AbstractObject

Public Member Functions

 MdDatum (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 MdDatum (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, resqml2::AbstractLocal3dCrs *locCrs, gsoap_eml2_3::eml23__WellboreDatumReference originKind, double referenceLocationOrdinal1, double referenceLocationOrdinal2, double referenceLocationOrdinal3)
 
 MdDatum (gsoap_eml2_3::_resqml22__MdDatum *fromGsoap)
 
 ~MdDatum ()=default
 
common::DataObjectReference getLocalCrsDor () const final
 
double getX () const final
 
double getY () const final
 
double getZ () const final
 
gsoap_eml2_3::eml23__WellboreDatumReference getOriginKind () const final
 
void loadTargetRelationships () final
 
std::string getXmlNamespace () const final
 
- Public Member Functions inherited from resqml2::MdDatum
 MdDatum (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
class AbstractLocal3dCrsgetLocalCrs () const
 
double getXInGlobalCrs () const
 
double getYInGlobalCrs () const
 
double getZInGlobalCrs () const
 
virtual std::string getXmlTag () const final
 
- 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::MdDatum
static const char * XML_TAG
 

Additional Inherited Members

- 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 md datum.

Constructor & Destructor Documentation

◆ MdDatum() [1/3]

resqml2_2::MdDatum::MdDatum ( 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.

◆ MdDatum() [2/3]

resqml2_2::MdDatum::MdDatum ( common::DataObjectRepository repo,
const std::string &  guid,
const std::string &  title,
resqml2::AbstractLocal3dCrs locCrs,
gsoap_eml2_3::eml23__WellboreDatumReference  originKind,
double  referenceLocationOrdinal1,
double  referenceLocationOrdinal2,
double  referenceLocationOrdinal3 
)

Creates an instance of this class in a gsoap context.

Parameters
[in,out]repoThe repo where the underlying gsoap proxy is going to be created.
guidThe guid to set to the local 3d crs. If empty then a new guid will be generated.
titleA title for the instance to create.
[in,out]locCrsThe local CRS where the ordinal are given.
originKindIndicates the kind of the MD reference point.
referenceLocationOrdinal1The location of the MD reference point on the first axis of the local 3d CRS.
referenceLocationOrdinal2The location of the MD reference point on the second axis of the local 3d CRS.
referenceLocationOrdinal3The location of the MD reference point on the third axis of the local 3d CRS.

◆ MdDatum() [3/3]

resqml2_2::MdDatum::MdDatum ( gsoap_eml2_3::_resqml22__MdDatum *  fromGsoap)
inline

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

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

◆ ~MdDatum()

resqml2_2::MdDatum::~MdDatum ( )
virtualdefault

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

Reimplemented from resqml2::MdDatum.

Member Function Documentation

◆ getLocalCrsDor()

common::DataObjectReference resqml2_2::MdDatum::getLocalCrsDor ( ) const
finalvirtual

Gets the data object reference of the local 3d CRS where the reference point ordinals are given.

Returns
nullptr if the local 3d CRS is not set, else the data object reference of the local 3d CRS.

Implements resqml2::MdDatum.

◆ getOriginKind()

gsoap_eml2_3::eml23__WellboreDatumReference resqml2_2::MdDatum::getOriginKind ( ) const
finalvirtual

Gets the origin kind of this MD datum.

Returns
The origin kind.

Implements resqml2::MdDatum.

◆ getX()

double resqml2_2::MdDatum::getX ( ) const
finalvirtual

Gets the first ordinal (x) of the location of the MD reference point relative to the local CRS.

Returns
The first ordinal of the reference location relative to the local CRS.

Implements resqml2::MdDatum.

◆ getXmlNamespace()

std::string resqml2_2::MdDatum::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getY()

double resqml2_2::MdDatum::getY ( ) const
finalvirtual

Gets the second ordinal (y) of the location of the MD reference point relative to the local CRS.

Returns
The second ordinal of the reference location relative to the local CRS.

Implements resqml2::MdDatum.

◆ getZ()

double resqml2_2::MdDatum::getZ ( ) const
finalvirtual

Gets the third ordinal (z) of the location of the MD reference point relative to the local CRS.

Returns
The third ordinal of the reference location relative to the local CRS.

Implements resqml2::MdDatum.

◆ loadTargetRelationships()

void resqml2_2::MdDatum::loadTargetRelationships ( )
inlinefinalvirtual

Loads target relationships

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

const char* resqml2_2::MdDatum::XML_NS
static

The standard XML namespace for serializing this data object.


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