GammaLib  1.7.0.dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GCOMOad Class Reference

COMPTEL Orbit Aspect Data class. More...

#include <GCOMOad.hpp>

Inheritance diagram for GCOMOad:
GBase

Public Member Functions

 GCOMOad (void)
 Void constructor. More...
 
 GCOMOad (const GCOMOad &oad)
 Copy constructor. More...
 
virtual ~GCOMOad (void)
 Destructor. More...
 
GCOMOadoperator= (const GCOMOad &oad)
 Assignment operator. More...
 
virtual void clear (void)
 Clear COMPTEL Orbit Aspect Data. More...
 
virtual GCOMOadclone (void) const
 Clone COMPTEL Orbit Aspect Data. More...
 
virtual std::string classname (void) const
 Return class name. More...
 
virtual std::string print (const GChatter &chatter=NORMAL) const
 Print COMPTEL Orbit Aspect Data. More...
 
const GTimetstart (void) const
 Return start time of superpacket. More...
 
void tstart (const GTime &tstart)
 Set start time of superpacket. More...
 
const GTimetstop (void) const
 Return stop time of superpacket. More...
 
void tstop (const GTime &tstop)
 Set stop time of superpacket. More...
 
const int & tjd (void) const
 Return Truncated Julian Days of Orbit Aspect Record. More...
 
void tjd (const int &tjd)
 Set Truncated Julian Days of Orbit Aspect Record. More...
 
const int & tics (void) const
 Return tics of Orbit Aspect Record. More...
 
void tics (const int &tics)
 Set tics of Orbit Aspect Record. More...
 
const float & gcaz (void) const
 Return Geocentre azimuth angle. More...
 
void gcaz (const float &gcaz)
 Set Geocentre azimuth angle. More...
 
const float & gcel (void) const
 Return Geocentre zenith angle. More...
 
void gcel (const float &gcel)
 Set Geocentre zenith angle. More...
 
const float & georad (void) const
 Return apparent radius of Earth. More...
 
void georad (const float &georad)
 Set apparent radius of Earth. More...
 
const GSkyDirzaxis (void) const
 Return telescope Z-axis. More...
 
void zaxis (const GSkyDir &zaxis)
 Set telescope Z-axis. More...
 
const GSkyDirxaxis (void) const
 Return telescope X-axis. More...
 
void xaxis (const GSkyDir &xaxis)
 Set telescope X-axis. More...
 
double theta (const GSkyDir &sky) const
 Return zenith angle of sky direction in COMPTEL coordinates. More...
 
double phi (const GSkyDir &sky) const
 Return azimuth angle of sky direction in COMPTEL coordinates. More...
 
- Public Member Functions inherited from GBase
virtual ~GBase (void)
 Destructor. More...
 

Protected Member Functions

void init_members (void)
 Initialise class members. More...
 
void copy_members (const GCOMOad &oad)
 Copy class members. More...
 
void free_members (void)
 Delete class members. More...
 

Protected Attributes

GTime m_tstart
 Start time of superpacket. More...
 
GTime m_tstop
 Stop time of superpacket. More...
 
GSkyDir m_zaxis
 Telescope z-axis. More...
 
GSkyDir m_xaxis
 Telescope x-axis. More...
 
int m_tjd
 TJD of OAD record. More...
 
int m_tics
 Tics of OAD record. More...
 
float m_gcaz
 Geocentre azimuth angle (deg) More...
 
float m_gcel
 Geocentre zenith angle (deg) More...
 
float m_georad
 Apparent radius of Earth (deg) More...
 
double m_posang
 X-axis position angle in COMPTEL system. More...
 

Detailed Description

COMPTEL Orbit Aspect Data class.

The class holds one record of a COMPTEL Orbit Aspect Data file.

Definition at line 48 of file GCOMOad.hpp.

Constructor & Destructor Documentation

GCOMOad::GCOMOad ( void  )

Void constructor.

Definition at line 53 of file GCOMOad.cpp.

References init_members().

Referenced by clone().

GCOMOad::GCOMOad ( const GCOMOad oad)

Copy constructor.

Parameters
[in]oadCOMPTEL Orbit Aspect Data.

Definition at line 68 of file GCOMOad.cpp.

References copy_members(), and init_members().

GCOMOad::~GCOMOad ( void  )
virtual

Destructor.

Definition at line 84 of file GCOMOad.cpp.

References free_members().

Member Function Documentation

std::string GCOMOad::classname ( void  ) const
inlinevirtual

Return class name.

Returns
String containing the class name ("GCOMOad").

Implements GBase.

Definition at line 115 of file GCOMOad.hpp.

void GCOMOad::clear ( void  )
virtual

Clear COMPTEL Orbit Aspect Data.

Implements GBase.

Definition at line 136 of file GCOMOad.cpp.

References free_members(), and init_members().

GCOMOad * GCOMOad::clone ( void  ) const
virtual

Clone COMPTEL Orbit Aspect Data.

Returns
Pointer to deep copy of COMPTEL Orbit Aspect Data.

Implements GBase.

Definition at line 154 of file GCOMOad.cpp.

References GCOMOad().

void GCOMOad::copy_members ( const GCOMOad oad)
protected

Copy class members.

Parameters
[in]oadCOMPTEL Orbit Aspect Data.

Definition at line 232 of file GCOMOad.cpp.

References m_gcaz, m_gcel, m_georad, m_posang, m_tics, m_tjd, m_tstart, m_tstop, m_xaxis, and m_zaxis.

Referenced by GCOMOad(), and operator=().

void GCOMOad::free_members ( void  )
protected

Delete class members.

Definition at line 254 of file GCOMOad.cpp.

Referenced by clear(), operator=(), and ~GCOMOad().

const float & GCOMOad::gcaz ( void  ) const
inline

Return Geocentre azimuth angle.

Returns
Geocentre azimuth angle (deg).

Returns the Geocentre azimuth angle in degrees.

Definition at line 247 of file GCOMOad.hpp.

References m_gcaz.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), gcaz(), and GCOMOads::read().

void GCOMOad::gcaz ( const float &  gcaz)
inline

Set Geocentre azimuth angle.

Parameters
[in]gcazGeocentre azimuth angle (deg).

Set the Geocentre azimuth angle.

Definition at line 261 of file GCOMOad.hpp.

References gcaz(), and m_gcaz.

const float & GCOMOad::gcel ( void  ) const
inline

Return Geocentre zenith angle.

Returns
Geocentre zenith angle (deg).

Returns the Geocentre zenith angle in degrees.

Definition at line 276 of file GCOMOad.hpp.

References m_gcel.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), gcel(), and GCOMOads::read().

void GCOMOad::gcel ( const float &  gcel)
inline

Set Geocentre zenith angle.

Parameters
[in]gcelGeocentre zenith angle (deg).

Set the Geocentre zenith angle.

Definition at line 290 of file GCOMOad.hpp.

References gcel(), and m_gcel.

const float & GCOMOad::georad ( void  ) const
inline

Return apparent radius of Earth.

Returns
Apparent radius of Earth (deg).

Returns the apparent radius of Earth in degrees.

Definition at line 305 of file GCOMOad.hpp.

References m_georad.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), georad(), and GCOMOads::read().

void GCOMOad::georad ( const float &  georad)
inline

Set apparent radius of Earth.

Parameters
[in]georadApparent radius of Earth (deg).

Set the apparent radius of Earth.

Definition at line 319 of file GCOMOad.hpp.

References georad(), and m_georad.

void GCOMOad::init_members ( void  )
protected

Initialise class members.

Definition at line 208 of file GCOMOad.cpp.

References GSkyDir::clear(), GTime::clear(), m_gcaz, m_gcel, m_georad, m_posang, m_tics, m_tjd, m_tstart, m_tstop, m_xaxis, and m_zaxis.

Referenced by clear(), GCOMOad(), and operator=().

GCOMOad & GCOMOad::operator= ( const GCOMOad oad)

Assignment operator.

Parameters
[in]oadCOMPTEL Orbit Aspect Data.
Returns
COMPTEL Orbit Aspect Data.

Definition at line 106 of file GCOMOad.cpp.

References copy_members(), free_members(), and init_members().

double GCOMOad::phi ( const GSkyDir sky) const
inline

Return azimuth angle of sky direction in COMPTEL coordinates.

Parameters
[in]skySky direction.
Returns
Azimuth angle of sky direction in COMPTEL coordinates (deg).

Returns the azimuth angle of a sky direction in COMPTEL coordinates.

Definition at line 410 of file GCOMOad.hpp.

References m_posang, m_xaxis, m_zaxis, and GSkyDir::posang_deg().

Referenced by GCOMDri::compute_drg().

std::string GCOMOad::print ( const GChatter chatter = NORMAL) const
virtual

Print COMPTEL Orbit Aspect Data.

Parameters
[in]chatterChattiness.
Returns
String containing COMPTEL Orbit Aspect Data information.

Implements GBase.

Definition at line 166 of file GCOMOad.cpp.

References m_tics, m_tjd, m_tstart, m_tstop, GTime::mjd(), gammalib::parformat(), SILENT, gammalib::str(), and GTime::utc().

double GCOMOad::theta ( const GSkyDir sky) const
inline

Return zenith angle of sky direction in COMPTEL coordinates.

Parameters
[in]skySky direction.
Returns
Zenith angle of sky direction in COMPTEL coordinates (deg).

Returns the zenith angle of a sky direction in COMPTEL coordinates.

Definition at line 395 of file GCOMOad.hpp.

References GSkyDir::dist_deg(), and m_zaxis.

Referenced by GCOMDri::compute_drg(), and GCOMDri::compute_drx().

const int & GCOMOad::tics ( void  ) const
inline

Return tics of Orbit Aspect Record.

Returns
Tics of Orbit Aspect Record.

Returns the tics of the Orbit Aspect Record.

Definition at line 218 of file GCOMOad.hpp.

References m_tics.

Referenced by GCOMOads::read(), and tics().

void GCOMOad::tics ( const int &  tics)
inline

Set tics of Orbit Aspect Record.

Parameters
[in]ticsTics of Orbit Aspect Record.

Set the tics of the Orbit Aspect Record.

Definition at line 232 of file GCOMOad.hpp.

References m_tics, and tics().

const int & GCOMOad::tjd ( void  ) const
inline

Return Truncated Julian Days of Orbit Aspect Record.

Returns
Truncated Julian Days of Orbit Aspect Record.

Returns the Truncated Julian Days of the Orbit Aspect Record.

Definition at line 189 of file GCOMOad.hpp.

References m_tjd.

Referenced by GCOMDri::compute_dre(), GCOMDri::compute_drg(), GCOMOads::read(), and tjd().

void GCOMOad::tjd ( const int &  tjd)
inline

Set Truncated Julian Days of Orbit Aspect Record.

Parameters
[in]tjdTruncated Julian Days of Orbit Aspect Record.

Set the Truncated Julian Days of the Orbit Aspect Record.

Definition at line 203 of file GCOMOad.hpp.

References m_tjd, and tjd().

const GTime & GCOMOad::tstart ( void  ) const
inline

Return start time of superpacket.

Returns
Start time of superpacket.

Returns the start time of the superpacket.

Definition at line 129 of file GCOMOad.hpp.

References m_tstart.

Referenced by GCOMDri::compute_dre(), GCOMOads::read(), tstart(), and GCOMDri::use_superpacket().

void GCOMOad::tstart ( const GTime tstart)
inline

Set start time of superpacket.

Parameters
[in]tstartStart time of superpacket.

Set the start time of the superpacket.

Definition at line 143 of file GCOMOad.hpp.

References m_tstart, and tstart().

const GTime & GCOMOad::tstop ( void  ) const
inline

Return stop time of superpacket.

Returns
Stop time of superpacket.

Returns the stop time of the superpacket. The stop time is defined as the start time plus 131071 tics, since the length of one superpacket is 16.384 secs, i.e. 16.384 * 8000 = 131072 ticks.

Definition at line 160 of file GCOMOad.hpp.

References m_tstop.

Referenced by GCOMDri::compute_dre(), GCOMOads::read(), tstop(), and GCOMDri::use_superpacket().

void GCOMOad::tstop ( const GTime tstop)
inline

Set stop time of superpacket.

Parameters
[in]tstopStop time of superpacket.

Set the stop time of the superpacket.

Definition at line 174 of file GCOMOad.hpp.

References m_tstop, and tstop().

const GSkyDir & GCOMOad::xaxis ( void  ) const
inline

Return telescope X-axis.

Returns
Telescope X-axis.

Returns the telescope X-axis.

Definition at line 364 of file GCOMOad.hpp.

References m_xaxis.

Referenced by GCOMOads::read(), and xaxis().

void GCOMOad::xaxis ( const GSkyDir xaxis)
inline

Set telescope X-axis.

Parameters
[in]xaxisTelescope X-axis.

Set the telescope X-axis.

Definition at line 378 of file GCOMOad.hpp.

References m_posang, m_xaxis, and xaxis().

const GSkyDir & GCOMOad::zaxis ( void  ) const
inline

Return telescope Z-axis.

Returns
Telescope Z-axis.

Returns the telescope Z-axis.

Definition at line 334 of file GCOMOad.hpp.

References m_zaxis.

Referenced by GCOMOads::read(), and zaxis().

void GCOMOad::zaxis ( const GSkyDir zaxis)
inline

Set telescope Z-axis.

Parameters
[in]zaxisTelescope Z-axis.

Set the telescope Z-axis.

Definition at line 348 of file GCOMOad.hpp.

References m_posang, m_zaxis, and zaxis().

Member Data Documentation

float GCOMOad::m_gcaz
protected

Geocentre azimuth angle (deg)

Definition at line 100 of file GCOMOad.hpp.

Referenced by copy_members(), gcaz(), and init_members().

float GCOMOad::m_gcel
protected

Geocentre zenith angle (deg)

Definition at line 101 of file GCOMOad.hpp.

Referenced by copy_members(), gcel(), and init_members().

float GCOMOad::m_georad
protected

Apparent radius of Earth (deg)

Definition at line 102 of file GCOMOad.hpp.

Referenced by copy_members(), georad(), and init_members().

double GCOMOad::m_posang
mutableprotected

X-axis position angle in COMPTEL system.

Definition at line 105 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), phi(), xaxis(), and zaxis().

int GCOMOad::m_tics
protected

Tics of OAD record.

Definition at line 99 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), print(), and tics().

int GCOMOad::m_tjd
protected

TJD of OAD record.

Definition at line 98 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), print(), and tjd().

GTime GCOMOad::m_tstart
protected

Start time of superpacket.

Definition at line 94 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), print(), and tstart().

GTime GCOMOad::m_tstop
protected

Stop time of superpacket.

Definition at line 95 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), print(), and tstop().

GSkyDir GCOMOad::m_xaxis
protected

Telescope x-axis.

Definition at line 97 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), phi(), and xaxis().

GSkyDir GCOMOad::m_zaxis
protected

Telescope z-axis.

Definition at line 96 of file GCOMOad.hpp.

Referenced by copy_members(), init_members(), phi(), theta(), and zaxis().


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