Quetzal-CoaTL
The Coalescence Template Library
Loading...
Searching...
No Matches
quetzal::geography::resolution< T > Class Template Reference

#include <quetzal/geography/resolution.hpp>

Detailed Description

template<typename T>
class quetzal::geography::resolution< T >

Resolution of a spatial grid.

Public Types

using value_type = T
 

Public Member Functions

constexpr resolution (value_type lat, value_type lon)
 Constructor.
 
constexpr value_type lat () const noexcept
 Gets latitude resolution.
 
constexpr value_type lon () const noexcept
 Gets longitude resolution.
 
constexpr resolutionlat (value_type value) noexcept
 Sets latitude resolution.
 
constexpr resolutionlon (value_type value) noexcept
 Sets longitude resolution.
 
constexpr bool operator== (const resolution &other) const noexcept
 EqualityComparable.
 
constexpr bool operator!= (const resolution &other) const noexcept
 Unequality comparison operator.
 

Constructor & Destructor Documentation

◆ resolution()

template<typename T >
constexpr quetzal::geography::resolution< T >::resolution ( value_type  lat,
value_type  lon 
)
inlineexplicitconstexpr

Constructor.

Parameters
latthe resolution of the spatial grid latitude
lonthe resolution of the spatial grid longitude

Member Function Documentation

◆ lat() [1/2]

template<typename T >
constexpr value_type quetzal::geography::resolution< T >::lat ( ) const
inlineconstexprnoexcept

Gets latitude resolution.

Note
Negative in decimal degree if the raster is north-up oriented.

◆ lat() [2/2]

template<typename T >
constexpr resolution & quetzal::geography::resolution< T >::lat ( value_type  value)
inlineconstexprnoexcept

Sets latitude resolution.

Parameters
valuethe new value for latitude resolution.
Returns
a reference on the Resolution object.

◆ lon()

template<typename T >
constexpr resolution & quetzal::geography::resolution< T >::lon ( value_type  value)
inlineconstexprnoexcept

Sets longitude resolution.

Parameters
valuethe new value for longitude resolution.
Returns
a reference on the Resolution object.

◆ operator!=()

template<typename T >
constexpr bool quetzal::geography::resolution< T >::operator!= ( const resolution< T > &  other) const
inlineconstexprnoexcept

Unequality comparison operator.

Checks if two resolutions objects are equals

Returns
false if latitude and longitude have same resolution, else returns true.

◆ operator==()

template<typename T >
constexpr bool quetzal::geography::resolution< T >::operator== ( const resolution< T > &  other) const
inlineconstexprnoexcept

EqualityComparable.

Checks if two resolutions objects are equals

Returns
true if latitude and longitude have same resolution, else returns false.

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