Defines a local depth coordinate system. The geometrical origin and location are defined by the elements of the base class AbstractLocal3dCrs. This CRS uses the units of measure of its projected and vertical CRS. More...

#include <LocalDepth3dCrs.h>

Inheritance diagram for resqml2_0_1::LocalDepth3dCrs:

Public Member Functions
	LocalDepth3dCrs (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	LocalDepth3dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, double originOrdinal1, double originOrdinal2, double originOrdinal3, double arealRotation, gsoap_resqml2_0_1::eml20__LengthUom projectedUom, uint64_t projectedEpsgCode, gsoap_resqml2_0_1::eml20__LengthUom verticalUom, unsigned int verticalEpsgCode, bool isUpOriented)

	LocalDepth3dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, double originOrdinal1, double originOrdinal2, double originOrdinal3, double arealRotation, gsoap_resqml2_0_1::eml20__LengthUom projectedUom, const std::string &projectedUnknownReason, gsoap_resqml2_0_1::eml20__LengthUom verticalUom, const std::string &verticalUnknownReason, bool isUpOriented)

	LocalDepth3dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, double originOrdinal1, double originOrdinal2, double originOrdinal3, double arealRotation, gsoap_resqml2_0_1::eml20__LengthUom projectedUom, uint64_t projectedEpsgCode, gsoap_resqml2_0_1::eml20__LengthUom verticalUom, const std::string &verticalUnknownReason, bool isUpOriented)
	Creates a local depth 3d CRS which is identified by an EPSG code for its projected part and which is unkown for its vertical part. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

	LocalDepth3dCrs (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, double originOrdinal1, double originOrdinal2, double originOrdinal3, double arealRotation, gsoap_resqml2_0_1::eml20__LengthUom projectedUom, const std::string &projectedUnknownReason, gsoap_resqml2_0_1::eml20__LengthUom verticalUom, unsigned int verticalEpsgCode, bool isUpOriented)
	Creates a local depth 3d CRS which unkown for its projected part and which is identified by an EPSG code for its vertical part. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

	LocalDepth3dCrs (gsoap_resqml2_0_1::_resqml20__LocalDepth3dCrs *fromGsoap)

	~LocalDepth3dCrs ()=default

bool	isATimeCrs () const final

gsoap_resqml2_0_1::eml20__TimeUom	getTimeUom () const final

std::string	getXmlNamespace () const final

virtual std::string	getXmlTag () const final

void	loadTargetRelationships () final

Public Member Functions inherited from eml2::AbstractLocal3dCrs
virtual	~AbstractLocal3dCrs ()=default

double	getOriginOrdinal1 () const

double	getOriginOrdinal2 () const

double	getOriginDepthOrElevation () const

double	getArealRotation () const

bool	isDepthOriented () const

bool	isProjectedCrsDefinedWithEpsg () const

virtual bool	isProjectedCrsUnknown () const

std::string	getProjectedCrsUnknownReason () const

uint64_t	getProjectedCrsEpsgCode () const

bool	isVerticalCrsDefinedWithEpsg () const

bool	isVerticalCrsUnknown () const

std::string	getVerticalCrsUnknownReason () const

uint64_t	getVerticalCrsEpsgCode () const

gsoap_resqml2_0_1::eml20__PlaneAngleUom	getArealRotationUom () const

gsoap_resqml2_0_1::eml20__LengthUom	getProjectedCrsUnit () const

std::string	getProjectedCrsUnitAsString () const

gsoap_resqml2_0_1::eml20__LengthUom	getVerticalCrsUnit () const

std::string	getVerticalCrsUnitAsString () const

std::string	getTimeUomAsString () const

gsoap_eml2_3::eml23__AxisOrder2d	getAxisOrder () const

void	setAxisOrder (gsoap_eml2_3::eml23__AxisOrder2d axisOrder) const

void	convertXyzPointsToGlobalCrs (double *xyzPoints, uint64_t xyzPointCount, bool withoutTranslation=false) const

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::DataObjectRepository *	getRepository () 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::Activity *	getActivity (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 = "resqml20"

static constexpr char const *	XML_TAG = "LocalDepth3dCrs"

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

Defines a local depth coordinate system. The geometrical origin and location are defined by the elements of the base class AbstractLocal3dCrs. This CRS uses the units of measure of its projected and vertical CRS.

Constructor & Destructor Documentation

◆ LocalDepth3dCrs() [1/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ LocalDepth3dCrs() [2/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		double	originOrdinal1,
		double	originOrdinal2,
		double	originOrdinal3,
		double	arealRotation,
		gsoap_resqml2_0_1::eml20__LengthUom	projectedUom,
		uint64_t	projectedEpsgCode,
		gsoap_resqml2_0_1::eml20__LengthUom	verticalUom,
		unsigned int	verticalEpsgCode,
		bool	isUpOriented )

Creates a local depth 3d CRS which is fully identified by means of EPSG code. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

Parameters

[in,out]	repo	The repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the local 3d crs. If empty then a new guid will be generated.
	title	A title for the instance to create.
	originOrdinal1	The local CRS origin coordinate on the first axis of the projected CRS.
	originOrdinal2	The local CRS origin coordinate on the second axis of the projected CRS.
	originOrdinal3	The local CRS origin coordinate on the axis of the vertical CRS.
	arealRotation	The areal rotation in radians regarding the projected crs.
	projectedUom	The unit of measure of the projected axis of this instance.
	projectedEpsgCode	The EPSG code of the associated projected CRS.
	verticalUom	The unit of measure of the vertical axis of this instance.
	verticalEpsgCode	The EPSG code of the associated vertical CRS.
	isUpOriented	If true, indicates that this local depth CRS is actually a local elevation CRS and that the associated vertical CRS is an elevation one as well.

◆ LocalDepth3dCrs() [3/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		double	originOrdinal1,
		double	originOrdinal2,
		double	originOrdinal3,
		double	arealRotation,
		gsoap_resqml2_0_1::eml20__LengthUom	projectedUom,
		const std::string &	projectedUnknownReason,
		gsoap_resqml2_0_1::eml20__LengthUom	verticalUom,
		const std::string &	verticalUnknownReason,
		bool	isUpOriented )

Creates a local depth 3d CRS which is fully unknown. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

Parameters

[in,out]	repo	The repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the local 3d crs. If empty then a new guid will be generated.
	title	A title for the instance to create.
	originOrdinal1	The offset of the global 2d crs on its first axis.
	originOrdinal2	The offset of the global 2d crs on its second axis.
	originOrdinal1	The local CRS origin coordinate on the first axis of the projected CRS.
	originOrdinal2	The local CRS origin coordinate on the second axis of the projected CRS.
	originOrdinal3	The local CRS origin coordinate on the axis of the vertical CRS.
	arealRotation	The areal rotation in radians regarding the projected crs.
	projectedUom	The unit of measure of the projected axis of this instance.
	projectedUnknownReason	Indicates why the projected CRS cannot be provided using EPSG or GML.
	verticalUom	The unit of measure of the vertical axis of this instance.
	verticalUnknownReason	Indicates why the vertical CRS cannot be provided using EPSG or GML.
	isUpOriented	If true, indicates that this local depth CRS is actually a local elevation CRS and that the associated vertical CRS is an elevation one as well.

◆ LocalDepth3dCrs() [4/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		double	originOrdinal1,
		double	originOrdinal2,
		double	originOrdinal3,
		double	arealRotation,
		gsoap_resqml2_0_1::eml20__LengthUom	projectedUom,
		uint64_t	projectedEpsgCode,
		gsoap_resqml2_0_1::eml20__LengthUom	verticalUom,
		const std::string &	verticalUnknownReason,
		bool	isUpOriented )

Creates a local depth 3d CRS which is identified by an EPSG code for its projected part and which is unkown for its vertical part. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

Exceptions

std::invalid_argument If projectedEpsgCode == 0.

Parameters

[in,out]	repo	The repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the local 3d crs. If empty then a new guid will be generated.
	title	A title for the instance to create.
	originOrdinal1	The local CRS origin coordinate on the first axis of the projected CRS.
	originOrdinal2	The local CRS origin coordinate on the second axis of the projected CRS.
	originOrdinal3	The local CRS origin coordinate on the axis of the vertical CRS.
	arealRotation	The areal rotation in radians regarding the projected crs.
	projectedUom	The unit of measure of the projected axis of this instance.
	projectedEpsgCode	The EPSG code of the associated projected CRS.
	verticalUom	The unit of measure of the vertical axis of this instance.
	verticalUnknownReason	Indicates why the vertical CRS cannot be provided using EPSG or GML.
	isUpOriented	If true, indicates that this local depth CRS is actually a local elevation CRS and that the associated vertical CRS is an elevation one as well.

◆ LocalDepth3dCrs() [5/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		double	originOrdinal1,
		double	originOrdinal2,
		double	originOrdinal3,
		double	arealRotation,
		gsoap_resqml2_0_1::eml20__LengthUom	projectedUom,
		const std::string &	projectedUnknownReason,
		gsoap_resqml2_0_1::eml20__LengthUom	verticalUom,
		unsigned int	verticalEpsgCode,
		bool	isUpOriented )

Creates a local depth 3d CRS which unkown for its projected part and which is identified by an EPSG code for its vertical part. Projected CRS (and consequently local CRS) is supposed to be an easting northing one for now.

Exceptions

std::invalid_argument If verticalEpsgCode == 0.

Parameters

[in]	repo	The repo where the underlying gsoap proxy is going to be created.
	guid	The guid to set to the local 3d crs. If empty then a new guid will be generated.
	title	A title for the instance to create.
	originOrdinal1	The local CRS origin coordinate on the first axis of the projected CRS.
	originOrdinal2	The local CRS origin coordinate on the second axis of the projected CRS.
	originOrdinal3	The local CRS origin coordinate on the axis of the vertical CRS.
	arealRotation	The areal rotation in radians regarding the projected crs.
	projectedUom	The unit of measure of the projected axis of this instance.
	projectedUnknownReason	Indicates why the projected CRS cannot be provided using EPSG or GML.
	verticalUom	The unit of measure of the vertical axis of this instance.
	verticalEpsgCode	The EPSG code of the associated vertical CRS.
	isUpOriented	If true, indicates that this local depth CRS is actually a local elevation CRS and that the associated vertical CRS is an elevation one as well.

◆ LocalDepth3dCrs() [6/6]

resqml2_0_1::LocalDepth3dCrs::LocalDepth3dCrs ( gsoap_resqml2_0_1::_resqml20__LocalDepth3dCrs * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~LocalDepth3dCrs()

resqml2_0_1::LocalDepth3dCrs::~LocalDepth3dCrs ( )

default

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

Member Function Documentation

◆ getTimeUom()

gsoap_resqml2_0_1::eml20__TimeUom resqml2_0_1::LocalDepth3dCrs::getTimeUom ( ) const

inlinefinalvirtual

Gets the unit of measure of the third axis of this local CRS if it is a time CRS. Otherwise throw an exception (if isATimeCrs() returns false)

Returns: The time unit of measure of the third axis.

Implements eml2::AbstractLocal3dCrs.

◆ getXmlNamespace()

std::string resqml2_0_1::LocalDepth3dCrs::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXmlTag()

virtual std::string resqml2_0_1::LocalDepth3dCrs::getXmlTag ( ) const

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ isATimeCrs()

bool resqml2_0_1::LocalDepth3dCrs::isATimeCrs ( ) const

inlinefinalvirtual

Check if the third axis of this local 3d CRS is in timeor not.

Returns: True if this local 3d CRS is a time one. False if it is a depth/elevation one.

Implements eml2::AbstractLocal3dCrs.

◆ loadTargetRelationships()

void resqml2_0_1::LocalDepth3dCrs::loadTargetRelationships ( )

inlinefinalvirtual

Loads target relationships

Implements common::AbstractObject.

Member Data Documentation

◆ XML_NS

char const* resqml2_0_1::LocalDepth3dCrs::XML_NS = "resqml20"

staticconstexpr

The standard XML namespace for serializing this data object.

◆ XML_TAG

char const* resqml2_0_1::LocalDepth3dCrs::XML_TAG = "LocalDepth3dCrs"

staticconstexpr

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

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2_0_1/LocalDepth3dCrs.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LocalDepth3dCrs() [1/6]

◆ LocalDepth3dCrs() [2/6]

◆ LocalDepth3dCrs() [3/6]

◆ LocalDepth3dCrs() [4/6]

◆ LocalDepth3dCrs() [5/6]

◆ LocalDepth3dCrs() [6/6]

◆ ~LocalDepth3dCrs()

Member Function Documentation

◆ getTimeUom()

◆ getXmlNamespace()

◆ getXmlTag()

◆ isATimeCrs()

◆ loadTargetRelationships()

Member Data Documentation

◆ XML_NS

◆ XML_TAG