JDETECTOR::JCompass Class Reference

Data structure for comapss in three dimensions. More...

#include <JCompass.hh>

Inheritance diagram for JDETECTOR::JCompass:

Public Member Functions
	JCompass ()
	Default constructor. More...
	JCompass (const double pitch, const double roll, const double yaw)
	Constructor. More...
const JCompass &	getCompass () const
	Get compass. More...
void	setCompass (const JCompass &compass)
	Set compass. More...
JCompass &	negate ()
	Negate compass. More...
JCompass &	add (const JCompass &compass)
	Add compass. More...
JCompass &	sub (const JCompass &compass)
	Subtract compass. More...
JCompass &	mul (const double factor)
	Scale compass. More...
JCompass &	div (const double factor)
	Scale compass. More...
double	getPitch () const
	Get pitch compass. More...
double	getRoll () const
	Get roll compass. More...
double	getYaw () const
	Get yaw compass. More...
JCompass &	mul (const JNullType &object)
	Multiply with object. More...

Protected Attributes
double	__pitch
double	__roll
double	__yaw

Friends
std::istream &	operator>> (std::istream &in, JCompass &compass)
	Read compasss from input. More...
std::ostream &	operator<< (std::ostream &out, const JCompass &compass)
	Write compasss to output. More...
JReader &	operator>> (JReader &in, JCompass &compass)
	Read compasss from input. More...
JWriter &	operator<< (JWriter &out, const JCompass &compass)
	Write compasss to output. More...

Detailed Description

Data structure for comapss in three dimensions.

This class implements the JMATH::JMath interface.

Definition at line 31 of file JCompass.hh.

Constructor & Destructor Documentation

JDETECTOR::JCompass::JCompass ( )

inline

Default constructor.

Definition at line 38 of file JCompass.hh.

               :
      __pitch(0.0),
      __roll (0.0),
      __yaw  (0.0)
    {}

JDETECTOR::JCompass::JCompass ( const double  pitch, const double  roll, const double  yaw  )

inline

Constructor.

Parameters

pitch	pitch angle [rad]
roll	roll angle [rad]
yaw	yaw angle [rad]

Definition at line 52 of file JCompass.hh.

                               :
      __pitch(pitch),
      __roll (roll),
      __yaw  (yaw)
    {}

Member Function Documentation

const JCompass& JDETECTOR::JCompass::getCompass ( ) const

inline

Get compass.

Returns

this compass

Definition at line 66 of file JCompass.hh.

    {
      return static_cast<const JCompass&>(*this);
    }

void JDETECTOR::JCompass::setCompass ( const JCompass &  compass )

inline

Set compass.

Parameters

compass

compass

Definition at line 77 of file JCompass.hh.

    {
      static_cast<JCompass&>(*this) = compass;
    }

JCompass& JDETECTOR::JCompass::negate ( )

inline

Negate compass.

Returns

this compass

Definition at line 88 of file JCompass.hh.

    {
      __pitch = -__pitch;
      __roll  = -__roll;
      __yaw   = -__yaw;

      return *this;
    }

JCompass& JDETECTOR::JCompass::add ( const JCompass &  compass )

inline

Add compass.

Parameters

compass

compass

Returns

this compass

Definition at line 104 of file JCompass.hh.

    {
      __pitch += compass.getPitch();
      __roll  += compass.getRoll();
      __yaw   += compass.getYaw();

      return *this;
    }

JCompass& JDETECTOR::JCompass::sub ( const JCompass &  compass )

inline

Subtract compass.

Parameters

compass

compass

Returns

this compass

Definition at line 120 of file JCompass.hh.

    {
      __pitch -= compass.getPitch();
      __roll  -= compass.getRoll();
      __yaw   -= compass.getYaw();

      return *this;
    }

JCompass& JDETECTOR::JCompass::mul ( const double  factor )

inline

Scale compass.

Parameters

factor

multiplication factor

Returns

this compass

Definition at line 136 of file JCompass.hh.

    {
      __pitch *= factor;
      __roll  *= factor;
      __yaw   *= factor;

      return *this;
    }

JCompass& JDETECTOR::JCompass::div ( const double  factor )

inline

Scale compass.

Parameters

factor

division factor

Returns

this compass

Definition at line 152 of file JCompass.hh.

    {
      __pitch /= factor;
      __roll  /= factor;
      __yaw   /= factor;

      return *this;
    }

double JDETECTOR::JCompass::getPitch ( ) const

inline

Get pitch compass.

Returns

pitch compass

Definition at line 167 of file JCompass.hh.

    { 
      return __pitch;
    }

double JDETECTOR::JCompass::getRoll ( ) const

inline

Get roll compass.

Returns

roll compass

Definition at line 178 of file JCompass.hh.

    { 
      return __roll;
    }

double JDETECTOR::JCompass::getYaw ( ) const

inline

Get yaw compass.

Returns

yaw compass

Definition at line 189 of file JCompass.hh.

    { 
      return __yaw;
    }

JCompass & JMATH::JMath< JCompass , JNullType >::mul ( const JNullType &  object )

inlineinherited

Multiply with object.

Parameters

object

object

Returns

result object

Definition at line 273 of file JMath.hh.

    {
      return static_cast<JFirst_t&>(*this) = JCalculator<JFirst_t>::calculator.mul(static_cast<const JFirst_t&>(*this), object);
    }

Friends And Related Function Documentation

std::istream& operator>> ( std::istream &  in, JCompass &  compass  )

friend

Read compasss from input.

Parameters

in	input stream
compass	compasss

Returns

input stream

Definition at line 202 of file JCompass.hh.

    {
      in >> compass.__pitch  >> compass.__roll  >> compass.__yaw;

      return in;
    }

std::ostream& operator<< ( std::ostream &  out, const JCompass &  compass  )

friend

Write compasss to output.

Parameters

out	output stream
compass	compass

Returns

output stream

Definition at line 217 of file JCompass.hh.

    {
      out << compass.getPitch()  << ' ' << compass.getRoll()  << ' ' << compass.getYaw();

      return out;
    }

JReader& operator>> ( JReader &  in, JCompass &  compass  )

friend

Read compasss from input.

Parameters

in	reader
compass	compasss

Returns

reader

Definition at line 232 of file JCompass.hh.

    {
      in >> compass.__pitch;
      in >> compass.__roll;
      in >> compass.__yaw;

      return in;
    }

JWriter& operator<< ( JWriter &  out, const JCompass &  compass  )

friend

Write compasss to output.

Parameters

out	writer
compass	compasss

Returns

writer

Definition at line 249 of file JCompass.hh.

    {
      out << compass.__pitch;
      out << compass.__roll;
      out << compass.__yaw;

      return out;
    }

Member Data Documentation

double JDETECTOR::JCompass::__pitch

protected

Definition at line 260 of file JCompass.hh.

double JDETECTOR::JCompass::__roll

protected

Definition at line 261 of file JCompass.hh.

double JDETECTOR::JCompass::__yaw

protected

Definition at line 262 of file JCompass.hh.

---

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

• JCompass.hh