Maps SDK for C++ 1.0.0
Loading...
Searching...
No Matches
gem::Projection_LAM Class Reference

Projection_LAM object. More...

Inheritance diagram for gem::Projection_LAM:
Collaboration diagram for gem::Projection_LAM:

Public Member Functions

 Projection_LAM ()
 Default constructor.
 Projection_LAM (double x, double y)
 Constructs a Projection_LAM object with x and y coordinates.
 Projection_LAM (const Projection_LAM &)=default
 Default copy constructor.
 Projection_LAM (Projection_LAM &&obj) noexcept
 Default move constructor.
Projection_LAMoperator= (const Projection_LAM &)=default
 Default copy assignment.
Projection_LAMoperator= (Projection_LAM &&obj) noexcept
 Default move assignment.
Projection_LAMset (double x, double y) noexcept
 Sets the horizontal and vertical axis of the point.
double getX () const noexcept
 Retrieves the horizontal axis of the point.
double getY () const noexcept
 Retrieves the vertical axis 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_LAM object.

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

Constructor & Destructor Documentation

◆ Projection_LAM() [1/3]

gem::Projection_LAM::Projection_LAM ( double x,
double y )
inline

Constructs a Projection_LAM object with x and y coordinates.

Parameters
xHorizontal axis of the point.
yVertical axis of the point. Ensures that the coordinates form a valid point.

◆ Projection_LAM() [2/3]

gem::Projection_LAM::Projection_LAM ( const Projection_LAM & )
default

Default copy constructor.

Creates a copy of an existing Projection_LAM object.

◆ Projection_LAM() [3/3]

gem::Projection_LAM::Projection_LAM ( Projection_LAM && obj)
inlinenoexcept

Default move constructor.

Moves an existing Projection_LAM object into a new instance.

Parameters
objThe 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
TSubclassThe 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
otherAnother Projection object to compare against.
Returns
True if both Projection objects represent the same data, false otherwise.

◆ getX()

double gem::Projection_LAM::getX ( ) const
inlinenoexcept

Retrieves the horizontal axis of the point.

Returns
x representing the horizontal axis of the point.

◆ getY()

double gem::Projection_LAM::getY ( ) const
inlinenoexcept

Retrieves the vertical axis of the point.

Returns
y representing the vertical axis 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
projectionAnother Projection object to compare against.
Returns
true if the projections are not equal, false otherwise.

◆ operator=() [1/2]

Projection_LAM & gem::Projection_LAM::operator= ( const Projection_LAM & )
default

Default copy assignment.

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

Returns
A reference to this updated instance.

◆ operator=() [2/2]

Projection_LAM & gem::Projection_LAM::operator= ( Projection_LAM && obj)
inlinenoexcept

Default move assignment.

Moves another Projection_LAM object into this instance.

Parameters
objThe 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
projectionAnother Projection object to compare against.
Returns
True if both Projection objects represent the same data, false otherwise.

◆ set()

Projection_LAM & gem::Projection_LAM::set ( double x,
double y )
inlinenoexcept

Sets the horizontal and vertical axis of the point.

Parameters
xHorizontal axis of the point.
yVertical axis of the point.
Returns
Reference to the current Projection_LAM 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_LAM::type ( )
inlinestaticconstexprnoexcept

Get the type of the projection.

Returns
The type of the projection as a projection type.