resqml2::AbstractLocal3dCrs Class Reference

Proxy class for an abstract local 3D coordinate reference system (CRS). More...

#include <AbstractLocal3dCrs.h>

Inheritance diagram for resqml2::AbstractLocal3dCrs:

Public Member Functions
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
const std::string &	getProjectedCrsUnknownReason () const
uint64_t	getProjectedCrsEpsgCode () const
bool	isVerticalCrsDefinedWithEpsg () const
bool	isVerticalCrsUnknown () const
const std::string &	getVerticalCrsUnknownReason () const
uint64_t	getVerticalCrsEpsgCode () const
std::string	getVerticalCrsUnitAsString () 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
gsoap_resqml2_0_1::eml20__AxisOrder2d	getAxisOrder () const
void	setAxisOrder (gsoap_resqml2_0_1::eml20__AxisOrder2d axisOrder) const
void	convertXyzPointsToGlobalCrs (double *xyzPoints, uint64_t xyzPointCount, bool withoutTranslation=false) const

Detailed Description

Proxy class for an abstract local 3D coordinate reference system (CRS).

Constructor & Destructor Documentation

~AbstractLocal3dCrs()

virtual resqml2::AbstractLocal3dCrs::~AbstractLocal3dCrs ( )

virtualdefault

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

Member Function Documentation

convertXyzPointsToGlobalCrs()

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

Convert some xyz points from local to global CRS.

Parameters

[in,out]	xyzPoints	An array of xyz points. The i-th point is defined by (x, y, z) = (xyzPoints[i], xyzPoints[i+1], xyzPoints[i+2]).
	xyzPointCount	The number of xyz points. Must be equal to the size of xyzPoints divided by 3.
	withoutTranslation	(Optional) True to only compute the rotation (no translation is computed). Default value if false.

getArealRotation()

double resqml2::AbstractLocal3dCrs::getArealRotation

(

)

const

Get the rotation in radians of the local Y axis relative to the global projected Y axis which is 90 degrees counter-clockwise from the other global axis. A positive value indicates a clockwise rotation from the global axis. A negative value indicates a counterclockwise rotation form the global axis.

Returns

The areal rotation.

getArealRotationUom()

gsoap_resqml2_0_1::eml20__PlaneAngleUom resqml2::AbstractLocal3dCrs::getArealRotationUom

(

)

const

Gets the areal rotation unit of measure.

Returns

The areal rotation unit of measure.

getAxisOrder()

gsoap_resqml2_0_1::eml20__AxisOrder2d resqml2::AbstractLocal3dCrs::getAxisOrder

(

)

const

Gets the axis order of the projected CRS.

Returns

The axis order of the projected CRS.

getOriginDepthOrElevation()

double resqml2::AbstractLocal3dCrs::getOriginDepthOrElevation

(

)

const

Get the depth or elevation origin of this local CRS. This is Z offset of the origin of the local vertical axis relative to the vertical CRS origin. According to CRS type (depth or time) it corresponds to the depth or time datum. If this local CRS is a time CRS, this value defines the seismic reference datum. The unit of measure is defined by the unit of measure for the vertical CRS

Returns

The origin depth or elevation.

getOriginOrdinal1()

double resqml2::AbstractLocal3dCrs::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 resqml2::AbstractLocal3dCrs::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()

uint64_t resqml2::AbstractLocal3dCrs::getProjectedCrsEpsgCode

(

)

const

Gets the EPSG code of the projected CRS

Exceptions

std::invalid_argument

If the associated projected CRS is not an EPSG one.

Returns

The projected CRS EPSG code.

getProjectedCrsUnit()

gsoap_resqml2_0_1::eml20__LengthUom resqml2::AbstractLocal3dCrs::getProjectedCrsUnit

(

)

const

Gets the projected CRS unit of measure.

Returns

The projected CRS unit unit of measure.

getProjectedCrsUnitAsString()

std::string resqml2::AbstractLocal3dCrs::getProjectedCrsUnitAsString

(

)

const

Gets the projected CRS unit of measure as a string

Returns

The projected CRS unit of measure as string.

getProjectedCrsUnknownReason()

const std::string & resqml2::AbstractLocal3dCrs::getProjectedCrsUnknownReason

(

)

const

Gets the reason why the projected CRS is unknown.

Exceptions

std::invalid_argument

If the associated projected CRS is not unknown.

Returns

The projected CRS unknown reason.

getVerticalCrsEpsgCode()

uint64_t resqml2::AbstractLocal3dCrs::getVerticalCrsEpsgCode

(

)

const

Gets the EPSG code of the vertical CRS

Exceptions

std::invalid_argument

If the associated projected CRS is not an EPSG one.

Returns

The vertical CRS EPSG code.

getVerticalCrsUnit()

gsoap_resqml2_0_1::eml20__LengthUom resqml2::AbstractLocal3dCrs::getVerticalCrsUnit

(

)

const

Gets the vertical CRS unit of measure.

Returns

The vertical CRS unit of measure.

getVerticalCrsUnitAsString()

std::string resqml2::AbstractLocal3dCrs::getVerticalCrsUnitAsString

(

)

const

Gets the vertical CRS unit of measure as a string

Returns

The vertical CRS unit of measure as string.

getVerticalCrsUnknownReason()

const std::string & resqml2::AbstractLocal3dCrs::getVerticalCrsUnknownReason

(

)

const

Gets the reason why the vertical CRS is unknown.

Exceptions

std::invalid_argument

If the associated vertical CRS is not unknown.

Returns

The vertical CRS unknown reason.

isDepthOriented()

bool resqml2::AbstractLocal3dCrs::isDepthOriented

(

)

const

Indicates that Z values correspond to depth values and are increasing downward, as opposite to elevation values increasing upward. When the vertical CRS is known, it must correspond to the axis orientation of the vertical CRS.

Returns

True if Z values are depth oriented, false if not.

isProjectedCrsDefinedWithEpsg()

bool resqml2::AbstractLocal3dCrs::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()

virtual bool resqml2::AbstractLocal3dCrs::isProjectedCrsUnknown ( ) const

virtual

Indicates either the associated projected CRS is unknown or not.

Returns

True if projected CRS is unknown, false if not.

isVerticalCrsDefinedWithEpsg()

bool resqml2::AbstractLocal3dCrs::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.

isVerticalCrsUnknown()

bool resqml2::AbstractLocal3dCrs::isVerticalCrsUnknown

(

)

const

Indicates either the associated vertical CRS is unknown or not.

Returns

True if vertical CRS is unknown, false if not.

setAxisOrder()

void resqml2::AbstractLocal3dCrs::setAxisOrder

(

gsoap_resqml2_0_1::eml20__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

axisOrder

The axis order to set.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/resqml2/AbstractLocal3dCrs.h