Inheritance diagram for gem::CircleGeographicArea:

[legend]

Collaboration diagram for gem::CircleGeographicArea:

[legend]

Public Member Functions
	CircleGeographicArea ()
	Default constructor.
	CircleGeographicArea (Coordinates const &center, int radius)
	Construct from center and radius in meters.
	CircleGeographicArea (const CircleGeographicArea &)=default
	Default copy constructor.
	CircleGeographicArea (CircleGeographicArea &&obj) noexcept
	Default move constructor noexcept is deduced.
CircleGeographicArea &	operator= (const CircleGeographicArea &obj)=default
	Default copy assignment.
CircleGeographicArea &	operator= (CircleGeographicArea &&obj) noexcept
	Default move assignment noexcept is deduced.
CircleGeographicArea &	setCenterPoint (Coordinates const &center) noexcept
	Set the center of the circular geographic area.
int	getRadius () const noexcept
	Get the radius of the circular geographic area in meters.
CircleGeographicArea &	setRadius (int radius) noexcept
	Set the radius of the circular geographic area in meters.
CircleGeographicArea &	set (Coordinates const &center, int radius) noexcept
	Set the center & radius.
EGeographicAreaType	type () const
	Retrieves the specific type of the geographic area.
bool	containsCoordinates (Coordinates const &point) const
	Checks if the specified point is contained within the geographic area.
RectangleGeographicArea	getBoundingBox () const noexcept
	Get the bounding box.
Coordinates	getCenterPoint () const noexcept
	Retrieves the center point of the geographic area.
bool	equals (GeographicArea const &other) const noexcept
	Checks if two geographic areas are considered equal.
bool	operator== (const GeographicArea &area) const noexcept
	Equality comparison operator for geographic areas.
bool	operator!= (const GeographicArea &area) const noexcept
	Inequality comparison operator for geographic areas.
template<typename TSubclass>
TSubclass	cast () const noexcept
	Attempts to cast the current geographic area object to a specified subclass.
bool	isDefault () const override
	Determines if the current geographic area object is in its default state (unaltered since creation).
	operator bool () const noexcept
	Boolean conversion operator indicating if the geographic area is valid and not in its default state.
bool	isEmpty () const noexcept
	Checks if the geographic area is empty.
void	reset () noexcept
	Resets the geographic area object to its default state.
int	convert (GeographicArea &area) const noexcept
	Converts the geographic area to another type, if possible.

Static Public Member Functions
static constexpr EGeographicAreaType	type () noexcept
	Get the type of the geographic area.

Detailed Description

CircleGeographicArea object.

Implements share-read / copy-on-write Api object over ICircleGeographicArea.

Constructor & Destructor Documentation

◆ CircleGeographicArea() [1/2]

gem::CircleGeographicArea::CircleGeographicArea	(	Coordinates const &	center,
		int	radius )

inline

Construct from center and radius in meters.

Parameters

center	Coordinates of the circle.
radius	Radius in meters.

◆ CircleGeographicArea() [2/2]

gem::CircleGeographicArea::CircleGeographicArea ( CircleGeographicArea && obj )

inlinenoexcept

Default move constructor noexcept is deduced.

Parameters

obj	The object to move into this new instance.

Member Function Documentation

◆ cast()

template<typename TSubclass>

TSubclass gem::GeographicArea::cast ( ) const

inlinenoexceptinherited

Attempts to cast the current geographic area 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.

◆ containsCoordinates()

bool gem::GeographicArea::containsCoordinates ( Coordinates const & point ) const

inlineinherited

Checks if the specified point is contained within the geographic area.

Parameters

point A Coordinates object representing the point to check.

Returns: True if the point is within the geographic area, false otherwise.

◆ convert()

int gem::GeographicArea::convert ( GeographicArea & area ) const

inlinenoexceptinherited

Converts the geographic area to another type, if possible.

Parameters

area	A GeographicArea object to convert to.

Returns: An integer indicating the success or failure of the conversion.

◆ equals()

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

inlinenoexceptinherited

Checks if two geographic areas are considered equal.

Parameters

other Another GeographicArea object for comparison.

Returns: true if the areas are equal, false otherwise.

◆ getBoundingBox()

RectangleGeographicArea gem::GeographicArea::getBoundingBox ( ) const

inlinenoexceptinherited

Get the bounding box.

This is the smallest rectangle that can be drawn around the area such that it surrounds this geographic area completely.

If the area is bigger than what is allowed in the WGS 84 coordinate system, the rectangle is truncated to valid WGS 84 coordinate values. The RectangleGeographicArea is always aligned with parallels and meridians.

Returns: A RectangleGeographicArea object representing the bounding box.

◆ getCenterPoint()

Coordinates gem::GeographicArea::getCenterPoint ( ) const

inlinenoexceptinherited

Retrieves the center point of the geographic area.

Calculates and returns the geographic center of the area.

Returns: Coordinates object representing the center point of the area.

◆ getRadius()

int gem::CircleGeographicArea::getRadius ( ) const

inlinenoexcept

Get the radius of the circular geographic area in meters.

Returns: The radius of the circle.

◆ isDefault()

bool gem::GeographicArea::isDefault ( ) const

inlineoverrideinherited

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

Returns: true if the object is default, false otherwise.

◆ isEmpty()

bool gem::GeographicArea::isEmpty ( ) const

inlinenoexceptinherited

Checks if the geographic area is empty.

Returns: true if the area is empty, false otherwise.

◆ operator bool()

gem::GeographicArea::operator bool ( ) const

inlineexplicitnoexceptinherited

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

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

◆ operator!=()

bool gem::GeographicArea::operator!= ( const GeographicArea & area ) const

inlinenoexceptinherited

Inequality comparison operator for geographic areas.

Parameters

area	Another GeographicArea object to compare against.

Returns: true if the areas are not equal, false otherwise.

◆ operator=() [1/2]

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

inlinenoexcept

Default move assignment noexcept is deduced.

Parameters

obj	The object to move into this instance.

Returns: A reference to this updated instance.

◆ operator=() [2/2]

CircleGeographicArea & gem::CircleGeographicArea::operator= ( const CircleGeographicArea & obj )

default

Default copy assignment.

Parameters

obj	The object to copy.

Returns: A reference to this updated instance.

◆ operator==()

bool gem::GeographicArea::operator== ( const GeographicArea & area ) const

inlinenoexceptinherited

Equality comparison operator for geographic areas.

Parameters

area	Another GeographicArea object to compare against.

Returns: true if the areas are equal, false otherwise.

◆ set()

CircleGeographicArea & gem::CircleGeographicArea::set	(	Coordinates const &	center,
		int	radius )

inlinenoexcept

Set the center & radius.

Parameters

center	Coordinates of the circle.
radius	Radius in meters.

Returns: Reference to the current CircleGeographicArea object.

◆ setCenterPoint()

CircleGeographicArea & gem::CircleGeographicArea::setCenterPoint ( Coordinates const & center )

inlinenoexcept

Set the center of the circular geographic area.

Parameters

center Coordinates of the circle.

Returns: Reference to the current CircleGeographicArea object.

◆ setRadius()

CircleGeographicArea & gem::CircleGeographicArea::setRadius ( int radius )

inlinenoexcept

Set the radius of the circular geographic area in meters.

Parameters

radius Radius in meters.

Returns: Reference to the current CircleGeographicArea object.

◆ type() [1/2]

constexpr EGeographicAreaType gem::CircleGeographicArea::type ( )

inlinestaticconstexprnoexcept

Get the type of the geographic area.

Returns: The type of the geographic area as a circle.

◆ type() [2/2]

EGeographicAreaType gem::GeographicArea::type ( ) const

inlineinherited

Retrieves the specific type of the geographic area.

Returns: The type of the geographic area as an EGeographicAreaType enumeration.

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CircleGeographicArea() [1/2]

◆ CircleGeographicArea() [2/2]

Member Function Documentation

◆ cast()

◆ containsCoordinates()

◆ convert()

◆ equals()

◆ getBoundingBox()

◆ getCenterPoint()

◆ getRadius()

◆ isDefault()

◆ isEmpty()

◆ operator bool()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ set()

◆ setCenterPoint()

◆ setRadius()

◆ type() [1/2]

◆ type() [2/2]