gem::Projection_W3W Class Reference

Projection_W3W object. More...

Inheritance diagram for gem::Projection_W3W:

Collaboration diagram for gem::Projection_W3W:

Public Member Functions
	Projection_W3W ()
	Default constructor.
	Projection_W3W (const String &token)
	Constructs a Projection_W3W object user token for What3Words API.
	Projection_W3W (const Projection_W3W &)=default
	Default copy constructor.
	Projection_W3W (Projection_W3W &&obj) noexcept
	Default move constructor.
Projection_W3W &	operator= (const Projection_W3W &)=default
	Default copy assignment.
Projection_W3W &	operator= (Projection_W3W &&obj) noexcept
	Default move assignment.
const StringRef	getWords () const noexcept
	Retrieves the What3Words location in a string format.
Projection_W3W &	setToken (const String &token) noexcept
	Retrieves the What3Words location in a string format.
Projection_W3W &	setWords (const String &whatThreeWords) noexcept
	Sets the What3Words location in a string format.
const StringRef	getToken () const noexcept
	Retrieves the What3Words user token.
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_W3W object.

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

Constructor & Destructor Documentation

Projection_W3W() [1/3]

gem::Projection_W3W::Projection_W3W ( const String & token )

inline

Constructs a Projection_W3W object user token for What3Words API.

A token is mandatory to make use of What3Words API services.

Parameters

token

An user obtained token from What3Words services.

Projection_W3W() [2/3]

gem::Projection_W3W::Projection_W3W ( const Projection_W3W & )

default

Default copy constructor.

Creates a copy of an existing Projection_W3W object.

Projection_W3W() [3/3]

gem::Projection_W3W::Projection_W3W ( Projection_W3W && obj )

inlinenoexcept

Default move constructor.

Moves an existing Projection_W3W object into a new instance.

Parameters

obj	The object to move into this new instance.

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.

getToken()

const StringRef gem::Projection_W3W::getToken ( ) const

inlinenoexcept

Retrieves the What3Words user token.

Returns

A string representing user token of What3Words API

getWords()

const StringRef gem::Projection_W3W::getWords ( ) const

inlinenoexcept

Retrieves the What3Words location in a string format.

Returns

The words corresponding to What3Words location on the globe.

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_W3W & gem::Projection_W3W::operator= ( const Projection_W3W & )

default

Default copy assignment.

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

Returns

A reference to this updated instance.

operator=() [2/2]

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

inlinenoexcept

Default move assignment.

Moves another Projection_W3W 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.

setToken()

Projection_W3W & gem::Projection_W3W::setToken ( const String & token )

inlinenoexcept

Retrieves the What3Words location in a string format.

Parameters

token

An user obtained token from What3Words services.

Returns

The words corresponding to What3Words location on the globe.

setWords()

Projection_W3W & gem::Projection_W3W::setWords ( const String & whatThreeWords )

inlinenoexcept

Sets the What3Words location in a string format.

Parameters

whatThreeWords

point location in a What3Words string format.

Returns

Reference to the current Projection_W3W 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_W3W::type ( )

inlinestaticconstexprnoexcept

Get the type of the projection.

Returns

The type of the projection as a projection type.