Fesapi 2.13.0.0
This project provides C++ classes which allow an easy access in import and export to the Energistics standards.
Loading...
Searching...
No Matches
eml2_3::VerticalCrs Class Referencefinal

#include <VerticalCrs.h>

Inheritance diagram for eml2_3::VerticalCrs:
common::AbstractObject

Public Member Functions

 VerticalCrs (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 VerticalCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, uint64_t verticalEpsgCode, gsoap_eml2_3::eml23__LengthUom verticalUom, bool isUpOriented)
 VerticalCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, std::string verticalDefinition, gsoap_eml2_3::eml23__LengthUom verticalUom, bool isUpOriented)
 VerticalCrs (gsoap_eml2_3::_eml23__VerticalCrs *fromGsoap)
 ~VerticalCrs ()=default
bool isVerticalCrsDefinedWithEpsg () const
bool isVerticalCrsDefinedWithWkt () const
bool isVerticalCrsUnknown () const
std::string getVerticalCrsUnknownReason () const
std::string getVerticalCrsWkt () const
int64_t getVerticalCrsEpsgCode () const
std::string getXmlNamespace () const final
virtual std::string getXmlTag () const final
void loadTargetRelationships () 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)
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject * getEml20GsoapProxy () const
void setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *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_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)
uint64_t getAliasCount () const
std::string getAliasAuthorityAtIndex (uint64_t index) const
std::string getAliasTitleAtIndex (uint64_t index) const
std::vector< eml2::Activity * > getActivitySet () const
uint64_t getActivityCount () const
eml2::ActivitygetActivity (uint64_t 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
uint64_t getExtraMetadataCount () const
std::string getExtraMetadataKeyAtIndex (uint64_t index) const
std::string getExtraMetadataStringValueAtIndex (uint64_t index) const
std::string buildEtp12Uri () const
void setUriSource (const std::string &uriSource)
const std::string & getUriSource () const
std::string getEpcSourceFolder () const
void changeToPartialObject ()

Static Public Attributes

static constexpr char const * XML_NS = "eml23"
static constexpr char const * XML_TAG = "VerticalCrs"

Additional Inherited Members

Public Types inherited from common::AbstractObject
enum class  numericalDatatypeEnum {
  UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 ,
  UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 ,
  UINT16 = 8 , INT8 = 9 , UINT8 = 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 vertical crs.

Constructor & Destructor Documentation

◆ VerticalCrs() [1/4]

eml2_3::VerticalCrs::VerticalCrs ( 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.

◆ VerticalCrs() [2/4]

eml2_3::VerticalCrs::VerticalCrs ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
uint64_t verticalEpsgCode,
gsoap_eml2_3::eml23__LengthUom verticalUom,
bool isUpOriented )

Construct a VerticalCrs deriving from an EPSG vertical CRS

Parameters
[in,out]repoIf non-null, the repo.
guidUnique identifier.
titleThe title.
verticalEpsgCodeThe EPSG code of the vertical CRS
verticalUomThe vertical axis uom.
isUpOrientedDefines if the vertical CRS axis is up oreinted or not.

◆ VerticalCrs() [3/4]

eml2_3::VerticalCrs::VerticalCrs ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
std::string verticalDefinition,
gsoap_eml2_3::eml23__LengthUom verticalUom,
bool isUpOriented )

Construct a VerticalCrs deriving from an unknown vertical CRS

Parameters
[in,out]repoIf non-null, the repo.
guidUnique identifier.
titleThe title.
verticalDefinitionIf starting with "VERT" then it gives the WKT definition of the vertical CRS. Otherwise, it defines why this vertical CRS should be considered as unknown.
verticalUomThe projected uom.
isUpOrientedDefines if the vertical CRS axis is up oreinted or not.

◆ VerticalCrs() [4/4]

eml2_3::VerticalCrs::VerticalCrs ( gsoap_eml2_3::_eml23__VerticalCrs * fromGsoap)
inline

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

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

◆ ~VerticalCrs()

eml2_3::VerticalCrs::~VerticalCrs ( )
default

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

Member Function Documentation

◆ getVerticalCrsEpsgCode()

int64_t eml2_3::VerticalCrs::getVerticalCrsEpsgCode ( ) const

Gets the EPSG code of the vertical CRS

Exceptions
std::invalid_argumentIf the associated projected CRS is not an EPSG one.
Returns
The vertical CRS EPSG code.

◆ getVerticalCrsUnknownReason()

std::string eml2_3::VerticalCrs::getVerticalCrsUnknownReason ( ) const

Gets the reason why the vertical CRS is unknown.

Exceptions
std::invalid_argumentIf the associated vertical CRS is not unknown.
Returns
The vertical CRS unknown reason.

◆ getVerticalCrsWkt()

std::string eml2_3::VerticalCrs::getVerticalCrsWkt ( ) const

Gets the WKT of the vertical CRS

Exceptions
std::invalid_argumentIf the associated projected CRS is not a WKT one.
Returns
The vertical CRS WKT.

◆ getXmlNamespace()

std::string eml2_3::VerticalCrs::getXmlNamespace ( ) const
inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

virtual std::string eml2_3::VerticalCrs::getXmlTag ( ) const
inlinefinalvirtual

Gets the standard XML tag without XML namespace for serializing this data object.

Returns
The XML tag.

Implements common::AbstractObject.

◆ isVerticalCrsDefinedWithEpsg()

bool eml2_3::VerticalCrs::isVerticalCrsDefinedWithEpsg ( ) const

Indicates either the associated vertical CRS is identified by means of EPSG or not.

Returns
True if the vertical CRS is defined with an EPSG code, false if not.

◆ isVerticalCrsDefinedWithWkt()

bool eml2_3::VerticalCrs::isVerticalCrsDefinedWithWkt ( ) const

Indicates either the associated vertical CRS is given in a WKT format or not.

Returns
True if the vertical CRS is given in a WKT format, false if not.

◆ isVerticalCrsUnknown()

bool eml2_3::VerticalCrs::isVerticalCrsUnknown ( ) const

Indicates either the associated vertical CRS is unknown or not.

Returns
True if vertical CRS is unknown, false if not.

◆ loadTargetRelationships()

void eml2_3::VerticalCrs::loadTargetRelationships ( )
inlinefinalvirtual

Reads the forward relationships of this data object and update the .rels of the associated data repository.

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

char const* eml2_3::VerticalCrs::XML_NS = "eml23"
staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

char const* eml2_3::VerticalCrs::XML_TAG = "VerticalCrs"
staticconstexpr

The standard XML tag without XML namespace for serializing this data object.


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