lsst.afw.geom::AngleUnit Class Reference

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

#include <Angle.h>

Public Member Functions
	AngleUnit (double val)
bool	operator== (AngleUnit const &rhs) const

Private Attributes
double	_val

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

Detailed Description

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

For example:

*    Angle pi = 180*degrees;
* 

is equivalent to

*    Angle pi(180, degrees);
* 

Definition at line 71 of file Angle.h.

Constructor & Destructor Documentation

lsst.afw.geom::AngleUnit::AngleUnit ( double  val )

inlineexplicit

Definition at line 75 of file Angle.h.

: _val(val) {}

Member Function Documentation

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

inline

Definition at line 82 of file Angle.h.

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

Friends And Related Function Documentation

friend class Angle

friend

Definition at line 72 of file Angle.h.

template<typename T >

const Angle operator* ( T  lhs, AngleUnit const  rhs  )

friend

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

Parameters

lhs	the value to convert
rhs	the conversion coefficient

Definition at line 304 of file Angle.h.

                        {
    BOOST_STATIC_ASSERT_MSG(std::numeric_limits<T>::is_specialized,
                            "Only numeric types may be converted to Angles using degrees/radians!");
    return Angle(lhs*rhs._val);
}

Member Data Documentation

double lsst.afw.geom::AngleUnit::_val

private

Definition at line 79 of file Angle.h.

---

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

• /home/lsstsw/stack/Linux64/afw/11.0.rc2+4/include/lsst/afw/geom/Angle.h