gem::Projection_GK Class Reference

Projection_GK object. More...

Inheritance diagram for gem::Projection_GK:

Collaboration diagram for gem::Projection_GK:

Public Member Functions
	Projection_GK ()
	Default constructor.
	Projection_GK (const Projection_GK &)=default
	Default copy constructor.
	Projection_GK (Projection_GK &&obj) noexcept
	Default move constructor.
Projection_GK &	operator= (const Projection_GK &)=default
	Default copy assignment.
Projection_GK &	operator= (Projection_GK &&obj) noexcept
	Default move assignment.
	Projection_GK (double x, double y, unsigned short zone)
	Constructs a Projection_GK object from easting, northing and zone.
Projection_GK &	set (double x, double y, unsigned short zone) noexcept
	Sets the horizontal axis, vertical axis and zone of the point.
double	getEasting () const noexcept
	Retrieves the easting of the point.
double	getNorthing () const noexcept
	Retrieves the northing of the point.
unsigned short	getZone () const noexcept
	Retrieves the zone number of the point.
EProjectionType	type () const
	Retrieves the specific type of the projection.
bool	equals (Projection const &other) const noexcept
	Compares two Projection objects for equality.
bool	operator== (const Projection &projection) const noexcept
	Compares two Projection objects for equality.
bool	operator!= (const Projection &projection) const noexcept
	Inequality comparison operator for projections.
template<typename TSubclass>
TSubclass	cast () const noexcept
	Attempts to cast the current projection object to a specified subclass.
bool	isDefault () const override
	Determines if the current projection object is in its default state (unaltered since creation).
	operator bool () const noexcept
	Boolean conversion operator indicating if the projection is valid and not in its default state.
bool	isEmpty () const noexcept
	Checks if the projection is empty.
void	reset () noexcept
	Reset the projection object to its default state.

Static Public Member Functions
static constexpr EProjectionType	type () noexcept
	Get the type of the projection.

Detailed Description

Projection_GK object.

Implements share-read / copy-on-write ApiType object over IGKProjection.

Constructor & Destructor Documentation

Projection_GK() [1/3]

gem::Projection_GK::Projection_GK ( const Projection_GK & )

default

Default copy constructor.

Creates a copy of an existing Projection_GK object.

Projection_GK() [2/3]

gem::Projection_GK::Projection_GK ( Projection_GK && obj )

inlinenoexcept

Default move constructor.

Moves an existing Projection_GK object into a new instance.

Parameters

obj	The object to move into this new instance.

Projection_GK() [3/3]

gem::Projection_GK::Projection_GK ( double x, double y, unsigned short zone )

inline

Constructs a Projection_GK object from easting, northing and zone.

Parameters

x	Horizontal axis of the point.
y	Vertical axis of the point.
zone	from Gauss-Kruger projection. Ensures that the x, y and zone form a valid point.

Member Function Documentation

cast()

template<typename TSubclass>

TSubclass gem::Projection::cast ( ) const

inlinenoexceptinherited

Attempts to cast the current projection object to a specified subclass.

This is a template method.

Template Parameters

TSubclass

The subclass type to cast to.

Returns

An object of type TSubclass if the cast is successful; otherwise, a default-constructed object of TSubclass.

equals()

bool gem::Projection::equals ( Projection const & other ) const

inlinenoexceptinherited

Compares two Projection objects for equality.

Parameters

other

Another Projection object to compare against.

Returns

True if both Projection objects represent the same data, false otherwise.

getEasting()

double gem::Projection_GK::getEasting ( ) const

inlinenoexcept

Retrieves the easting of the point.

Returns

easting of the point.

getNorthing()

double gem::Projection_GK::getNorthing ( ) const

inlinenoexcept

Retrieves the northing of the point.

Returns

northing of the point.

getZone()

unsigned short gem::Projection_GK::getZone ( ) const

inlinenoexcept

Retrieves the zone number of the point.

Returns

zone of the point.

isDefault()

bool gem::Projection::isDefault ( ) const

inlineoverrideinherited

Determines if the current projection object is in its default state (unaltered since creation).

Returns

true if the object is default, false otherwise.

isEmpty()

bool gem::Projection::isEmpty ( ) const

inlinenoexceptinherited

Checks if the projection is empty.

Returns

true if the projection is empty, false otherwise.

operator bool()

gem::Projection::operator bool ( ) const

inlineexplicitnoexceptinherited

Boolean conversion operator indicating if the projection is valid and not in its default state.

Returns

true if the object is valid and not default, false otherwise.

operator!=()

bool gem::Projection::operator!= ( const Projection & projection ) const

inlinenoexceptinherited

Inequality comparison operator for projections.

Parameters

projection

Another Projection object to compare against.

Returns

true if the projections are not equal, false otherwise.

operator=() [1/2]

Projection_GK & gem::Projection_GK::operator= ( const Projection_GK & )

default

Default copy assignment.

Replaces the contents of this object with a copy of another Projection_GK object.

Returns

A reference to this updated instance.

operator=() [2/2]

Projection_GK & gem::Projection_GK::operator= ( Projection_GK && obj )

inlinenoexcept

Default move assignment.

Moves another Projection_GK object into this instance.

Parameters

obj	The object to move into this instance.

Returns

A reference to this updated instance.

operator==()

bool gem::Projection::operator== ( const Projection & projection ) const

inlinenoexceptinherited

Compares two Projection objects for equality.

Parameters

projection

Another Projection object to compare against.

Returns

True if both Projection objects represent the same data, false otherwise.

set()

Projection_GK & gem::Projection_GK::set ( double x, double y, unsigned short zone )

inlinenoexcept

Sets the horizontal axis, vertical axis and zone of the point.

Parameters

x	Horizontal axis of the point.
y	Vertical axis of the point.
zone	Related to Gauss-Krüger corresponding zone.

Returns

Reference to the current Projection_GK object.

type() [1/2]

EProjectionType gem::Projection::type ( ) const

inlineinherited

Retrieves the specific type of the projection.

Returns

The type of the projection as an EProjectionType enumeration.

type() [2/2]

constexpr EProjectionType gem::Projection_GK::type ( )

inlinestaticconstexprnoexcept

Get the type of the projection.

Returns

The type of the projection as a projection type.