lsst::geom::AngleUnit Class Reference

A class used to convert scalar POD types such as double to Angle. More...

#include <Angle.h>

Public Member Functions
constexpr	AngleUnit (double val)
	Define a new angle unit.
constexpr bool	operator== (AngleUnit const &rhs) const noexcept
	Test if two units are the same.
std::size_t	hash_value () const noexcept
	Return a hash of this object.

Friends
class	Angle
template<typename T >
constexpr Angle	operator* (T lhs, AngleUnit rhs) noexcept
	Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*degrees.

Detailed Description

A class used to convert scalar POD types such as double to Angle.

For example, given the predefined AngleUnit degrees:

Angle pi = 180*degrees;

is equivalent to

Angle pi(180, degrees);

Definition at line 71 of file Angle.h.

Constructor & Destructor Documentation

AngleUnit()

constexpr lsst::geom::AngleUnit::AngleUnit ( double val )

inlineexplicitconstexpr

Define a new angle unit.

Parameters

val	the number of radians in one unit. See degrees for an example.

Exception Safety

Provides strong exception safety.

Definition at line 86 of file Angle.h.

: _val(val) {}

Member Function Documentation

hash_value()

std::size_t lsst::geom::AngleUnit::hash_value ( ) const

inlinenoexcept

Return a hash of this object.

Definition at line 99 of file Angle.h.

{ return std::hash<double>()(_val); }

operator==()

constexpr bool lsst::geom::AngleUnit::operator== ( AngleUnit const & rhs ) const

inlineconstexprnoexcept

Test if two units are the same.

Parameters

rhs	the unit to compare this to

Returns

true if the two units have the same size, false otherwise.

Exception Safety

Shall not throw exceptions.

Definition at line 105 of file Angle.h.

                                                                               {
    return (_val == rhs._val);
}

Friends And Related Symbol Documentation

Angle

friend class Angle

friend

Definition at line 72 of file Angle.h.

operator*

template<typename T >

constexpr Angle operator* ( T lhs, AngleUnit rhs )

friend

Use AngleUnit to convert a POD (e.g. int, double) to an Angle; e.g. 180*degrees.

Parameters

lhs	the value to convert
rhs	the conversion coefficient

Exception Safety

Shall not throw exceptions.

Definition at line 402 of file Angle.h.

                                                                {
    static_assert(std::is_arithmetic<T>::value,
                  "Only numeric types may be multiplied by an AngleUnit to create an Angle!");
    return Angle(lhs * rhs._val);
}

---

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

• /j/snowflake/release/lsstsw/stack/lsst-scipipe-9.0.0/Linux64/geom/g414038480c+077ccc18e7/include/lsst/geom/Angle.h