Fesapi 2.10.1.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::LocalEngineering2dCrs Class Referencefinal

#include <LocalEngineering2dCrs.h>

Inheritance diagram for eml2_3::LocalEngineering2dCrs:
common::AbstractObject

Public Member Functions

 LocalEngineering2dCrs (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
 
 LocalEngineering2dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, uint64_t projectedEpsgCode, double originOrdinal1, double originOrdinal2, gsoap_eml2_3::eml23__LengthUom projectedUom, double azimuth, gsoap_eml2_3::eml23__PlaneAngleUom azimuthUom, gsoap_eml2_3::eml23__NorthReferenceKind azimuthReference, gsoap_eml2_3::eml23__AxisOrder2d axisOrder)
 
 LocalEngineering2dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, std::string unknownReason, double originOrdinal1, double originOrdinal2, gsoap_eml2_3::eml23__LengthUom projectedUom, double azimuth, gsoap_eml2_3::eml23__PlaneAngleUom azimuthUom, gsoap_eml2_3::eml23__NorthReferenceKind azimuthReference, gsoap_eml2_3::eml23__AxisOrder2d axisOrder)
 
 LocalEngineering2dCrs (gsoap_eml2_3::_eml23__LocalEngineering2dCrs *fromGsoap)
 
 ~LocalEngineering2dCrs ()=default
 
double getOriginOrdinal1 () const
 
double getOriginOrdinal2 () const
 
double getAzimuth () const
 
std::string getAzimuthUomAsString () const
 
bool isProjectedCrsDefinedWithEpsg () const
 
bool isProjectedCrsUnknown () const
 
std::string getProjectedCrsUnknownReason () const
 
int64_t getProjectedCrsEpsgCode () const
 
std::string getProjectedCrsUnitAsString () const
 
gsoap_eml2_3::eml23__AxisOrder2d getAxisOrder () const
 
void setAxisOrder (gsoap_eml2_3::eml23__AxisOrder2d axisOrder) 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
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (unsigned int index) const
 
std::string getExtraMetadataStringValueAtIndex (unsigned int 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 = "LocalEngineering2dCrs"
 

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 local engineering 2D crs.

Constructor & Destructor Documentation

◆ LocalEngineering2dCrs() [1/4]

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

◆ LocalEngineering2dCrs() [2/4]

eml2_3::LocalEngineering2dCrs::LocalEngineering2dCrs ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
uint64_t projectedEpsgCode,
double originOrdinal1,
double originOrdinal2,
gsoap_eml2_3::eml23__LengthUom projectedUom,
double azimuth,
gsoap_eml2_3::eml23__PlaneAngleUom azimuthUom,
gsoap_eml2_3::eml23__NorthReferenceKind azimuthReference,
gsoap_eml2_3::eml23__AxisOrder2d axisOrder )

Construct a LocalEngineering2dCrs deriving from an EPSG projected CRS

Parameters
[in,out]repoIf non-null, the repo.
guidUnique identifier.
titleThe title.
projectedEpsgCodeThe EPSG code of the projected CRS
originOrdinal1The first origin ordinal.
originOrdinal2The second origin ordinal.
projectedUomThe projected uom.
azimuthThe areal rotation regarding the north.
azimuthUomThe unit of measure of the azimuth.
azimuthReferenceThe kind of north reference of the azimuth.
axisOrderThe axis order of the projected CRS.

◆ LocalEngineering2dCrs() [3/4]

eml2_3::LocalEngineering2dCrs::LocalEngineering2dCrs ( common::DataObjectRepository * repo,
const std::string & guid,
const std::string & title,
std::string unknownReason,
double originOrdinal1,
double originOrdinal2,
gsoap_eml2_3::eml23__LengthUom projectedUom,
double azimuth,
gsoap_eml2_3::eml23__PlaneAngleUom azimuthUom,
gsoap_eml2_3::eml23__NorthReferenceKind azimuthReference,
gsoap_eml2_3::eml23__AxisOrder2d axisOrder )

Construct a LocalEngineering2dCrs deriving from an unknown projected CRS

Parameters
[in,out]repoIf non-null, the repo.
guidUnique identifier.
titleThe title.
unknownReasonThe reason why this CRS is unknown.
originOrdinal1The first origin ordinal.
originOrdinal2The second origin ordinal.
projectedUomThe projected uom.
azimuthThe areal rotation regarding the north.
azimuthUomThe unit of measure of the azimuth.
azimuthReferenceThe kind of north reference of the azimuth.
axisOrderThe axis order of the projected CRS.

◆ LocalEngineering2dCrs() [4/4]

eml2_3::LocalEngineering2dCrs::LocalEngineering2dCrs ( gsoap_eml2_3::_eml23__LocalEngineering2dCrs * fromGsoap)
inline

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

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

◆ ~LocalEngineering2dCrs()

eml2_3::LocalEngineering2dCrs::~LocalEngineering2dCrs ( )
default

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

Member Function Documentation

◆ getAxisOrder()

gsoap_eml2_3::eml23__AxisOrder2d eml2_3::LocalEngineering2dCrs::getAxisOrder ( ) const

Gets the axis order of the projected CRS.

Returns
The axis order of the projected CRS.

◆ getAzimuth()

double eml2_3::LocalEngineering2dCrs::getAzimuth ( ) const

Get the azimuth of this CRS.

Returns
The azimuth.

◆ getAzimuthUomAsString()

std::string eml2_3::LocalEngineering2dCrs::getAzimuthUomAsString ( ) const

Get the azimuth uom of this CRS as a string.

Returns
The azimuth uom.

◆ getOriginOrdinal1()

double eml2_3::LocalEngineering2dCrs::getOriginOrdinal1 ( ) const

Gets the first origin ordinal of this local CRS. This is the X location of the origin of the local areal axes relative to the projected CRS origin. The unit of measure is defined by the unit of measure for the projected 2d CRS.

Returns
The first origin ordinal of this local CRS.

◆ getOriginOrdinal2()

double eml2_3::LocalEngineering2dCrs::getOriginOrdinal2 ( ) const

Gets the second origin ordinal of this local CRS. This is the Y location of the origin of the local areal axes relative to the projected CRS origin. The unit of measure is defined by the unit of measure for the projected 2d CRS.

Returns
The second origin ordinal of this local CRS.

◆ getProjectedCrsEpsgCode()

int64_t eml2_3::LocalEngineering2dCrs::getProjectedCrsEpsgCode ( ) const

Gets the EPSG code of the projected CRS

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

◆ getProjectedCrsUnitAsString()

std::string eml2_3::LocalEngineering2dCrs::getProjectedCrsUnitAsString ( ) const

Gets the projected CRS unit of measure as a string

Returns
The projected CRS unit of measure as string.

◆ getProjectedCrsUnknownReason()

std::string eml2_3::LocalEngineering2dCrs::getProjectedCrsUnknownReason ( ) const

Gets the reason why the projected CRS is unknown.

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

◆ getXmlNamespace()

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

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

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

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

Returns
The XML tag.

Implements common::AbstractObject.

◆ isProjectedCrsDefinedWithEpsg()

bool eml2_3::LocalEngineering2dCrs::isProjectedCrsDefinedWithEpsg ( ) const

Indicates either the associated projected CRS is identified by means of an EPSG code or not.

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

◆ isProjectedCrsUnknown()

bool eml2_3::LocalEngineering2dCrs::isProjectedCrsUnknown ( ) const

Indicates either the associated projected CRS is unknown or not.

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

◆ loadTargetRelationships()

void eml2_3::LocalEngineering2dCrs::loadTargetRelationships ( )
inlinefinalvirtual

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

Implements common::AbstractObject.

◆ setAxisOrder()

void eml2_3::LocalEngineering2dCrs::setAxisOrder ( gsoap_eml2_3::eml23__AxisOrder2d axisOrder) const

Sets the axis order of the projected CRS. It defines the coordinate system axis order of the global projected CRS when the projected CRS is an unknown CRS, else it must correspond to the axis order of the projected CRS.

Parameters
axisOrderThe axis order to set.

Member Data Documentation

◆ XML_NS

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

The standard XML namespace for serializing this data object.

◆ XML_TAG

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

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


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