JASTRONOMY::angle_type Struct Reference

Auxiliary data structure for pair of angles. More...

#include <JAstronomy.hh>

Inheritance diagram for JASTRONOMY::angle_type:

Public Member Functions
bool	equals (const angle_type &angle, const double precision=std::numeric_limits< double >::min()) const
	Check equality.

Protected Member Functions
	angle_type ()
	Default constructor.
	angle_type (const double theta, const double phi)
	Constructor.

Protected Attributes
double	_theta_
double	_phi_

Friends
std::istream &	operator>> (std::istream &in, angle_type &object)
	Read pair of angles from input stream.
std::ostream &	operator<< (std::ostream &out, const angle_type &object)
	Write pair of angles to output stream.

Detailed Description

Auxiliary data structure for pair of angles.

Definition at line 184 of file JAstronomy.hh.

Constructor & Destructor Documentation

angle_type() [1/2]

JASTRONOMY::angle_type::angle_type ( )

inlineprotected

Default constructor.

Definition at line 232 of file JAstronomy.hh.

                 :
      _theta_(0.0),
      _phi_  (0.0)
    {}

angle_type() [2/2]

JASTRONOMY::angle_type::angle_type ( const double theta, const double phi )

inlineprotected

Constructor.

Parameters

theta	theta
phi	phi

Definition at line 244 of file JAstronomy.hh.

                                 :
      _theta_(theta),
      _phi_  (phi)
    {}

Member Function Documentation

equals()

bool JASTRONOMY::angle_type::equals ( const angle_type & angle, const double precision = std::numeric_limits<double>::min() ) const

inline

Check equality.

Parameters

angle	pair of angles
precision	precision

Returns

true if angles are equal; else false

Definition at line 194 of file JAstronomy.hh.

    {
      return (fabs(this->_theta_ - angle._theta_) <= precision &&
              fabs(this->_phi_   - angle._phi_)   <= precision);
    }

Friends And Related Symbol Documentation

operator>>

std::istream & operator>> ( std::istream & in, angle_type & object )

friend

Read pair of angles from input stream.

Parameters

in	input stream
object	pair of angles

Returns

input stream

Definition at line 209 of file JAstronomy.hh.

    {
      return in >> object._theta_
                >> object._phi_;
    }

operator<<

std::ostream & operator<< ( std::ostream & out, const angle_type & object )

friend

Write pair of angles to output stream.

Parameters

out	output stream
object	pair of angles

Returns

output stream

Definition at line 222 of file JAstronomy.hh.

    {
      return out << FIXED(12,7) << object._theta_ << ' '
                 << FIXED(12,7) << object._phi_;
    }

Member Data Documentation

_theta_

double JASTRONOMY::angle_type::_theta_

protected

Definition at line 250 of file JAstronomy.hh.

_phi_

double JASTRONOMY::angle_type::_phi_

protected

Definition at line 251 of file JAstronomy.hh.

---

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

• JAstronomy.hh