COSI pointing class. More...

#include <GCOSPointing.hpp>

Inheritance diagram for GCOSPointing:

Public Member Functions
	GCOSPointing (void)
	Void constructor.

	GCOSPointing (const GCOSPointing &pointing)
	Copy constructor.

virtual	~GCOSPointing (void)
	Destructor.

GCOSPointing &	operator= (const GCOSPointing &pointing)
	Assignment operator.

void	clear (void)
	Clear pointing.

GCOSPointing *	clone (void) const
	Clone COSI pointing.

std::string	classname (void) const
	Return class name.

const GTime &	time (void) const
	Return time stamp.

const GSkyDir &	sc_x (void) const
	Return space craft X-axis.

const GSkyDir &	sc_z (void) const
	Return space craft Z-axis.

const double &	altitude (void) const
	Return space craft altitude in km.

const GSkyDir &	earth_zenith (void) const
	Return direction of Earth's zenith at space craft location.

const GSkyDir &	earth_nadir (void) const
	Return direction of Earth's nadir at space craft location.

const double &	livetime (void) const
	Return livetime.

void	time (const GTime &time)
	Set time stamp.

void	sc_x (const GSkyDir &sc_x)
	Set space craft X-axis.

void	sc_z (const GSkyDir &sc_z)
	Set space craft Z-axis.

void	altitude (const double &altitude)
	Set space craft altitude (km)

void	earth_zenith (const GSkyDir &earth_zenith)
	Set direction Earth's zenith at space craft location.

void	earth_nadir (const GSkyDir &earth_nadir)
	Set direction Earth's nadir at space craft location.

void	livetime (const double &livetime)
	Set livetime.

std::string	print (const GChatter &chatter=NORMAL) const
	Print pointing information.

Public Member Functions inherited from GBase
virtual	~GBase (void)
	Destructor.

Protected Member Functions
void	init_members (void)
	Initialise class members.

void	copy_members (const GCOSPointing &pointing)
	Copy class members.

void	free_members (void)
	Delete class members.

Protected Attributes
GTime	m_time
	Time stamp in UNIX seconds.

GSkyDir	m_sc_x
	Space craft x-axis.

GSkyDir	m_sc_z
	Space craft z-axis.

double	m_altitude
	Altitude above from Earth's ellipsoid (km)

GSkyDir	m_earth_zenith
	Direction of Earth's zenith at SC location.

GSkyDir	m_earth_nadir
	Direction of Earth's nadir at SC location.

double	m_livetime
	Lifetime (sec)

Detailed Description

COSI pointing class.

The COSI pointing class provides spacecraft attitude information for a given time tag.

Definition at line 49 of file GCOSPointing.hpp.

Constructor & Destructor Documentation

◆ GCOSPointing() [1/2]

GCOSPointing::GCOSPointing ( void )

Void constructor.

Definition at line 52 of file GCOSPointing.cpp.

References init_members().

Referenced by clone().

◆ GCOSPointing() [2/2]

GCOSPointing::GCOSPointing ( const GCOSPointing & pointing )

Copy constructor.

Parameters

[in] pointing COSI pointing.

Definition at line 67 of file GCOSPointing.cpp.

References copy_members(), and init_members().

◆ ~GCOSPointing()

GCOSPointing::~GCOSPointing ( void )

virtual

Destructor.

Definition at line 83 of file GCOSPointing.cpp.

References free_members().

Member Function Documentation

◆ altitude() [1/2]

void GCOSPointing::altitude ( const double & altitude )

inline

Set space craft altitude (km)

Parameters

[in] altitude Space craft altitude (km).

Definition at line 238 of file GCOSPointing.hpp.

References altitude(), and m_altitude.

◆ altitude() [2/2]

const double & GCOSPointing::altitude ( void ) const

inline

Return space craft altitude in km.

Returns: Space craft altitude (km).

Definition at line 151 of file GCOSPointing.hpp.

References m_altitude.

Referenced by altitude(), GCOSSpaceCraft::livetime(), GCOSSpaceCraft::livetime(), and GCOSSpaceCraft::load_ori().

◆ classname()

std::string GCOSPointing::classname ( void ) const

inlinevirtual

Return class name.

Returns: String containing the class name ("GCOSPointing").

Implements GBase.

Definition at line 103 of file GCOSPointing.hpp.

◆ clear()

void GCOSPointing::clear ( void )

virtual

Clear pointing.

Implements GBase.

Definition at line 135 of file GCOSPointing.cpp.

References free_members(), and init_members().

◆ clone()

GCOSPointing * GCOSPointing::clone ( void ) const

virtual

Clone COSI pointing.

Returns: Pointer to deep copy of COSI pointing.

Implements GBase.

Definition at line 153 of file GCOSPointing.cpp.

References GCOSPointing().

◆ copy_members()

void GCOSPointing::copy_members ( const GCOSPointing & pointing )

protected

Copy class members.

Parameters

[in] pointing COSI pointing.

Definition at line 225 of file GCOSPointing.cpp.

References m_altitude, m_earth_nadir, m_earth_zenith, m_livetime, m_sc_x, m_sc_z, and m_time.

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

◆ earth_nadir() [1/2]

void GCOSPointing::earth_nadir ( const GSkyDir & earth_nadir )

inline

Set direction Earth's nadir at space craft location.

Parameters

[in] earth_nadir Earth's nadir direction.

Definition at line 264 of file GCOSPointing.hpp.

References earth_nadir(), and m_earth_nadir.

◆ earth_nadir() [2/2]

const GSkyDir & GCOSPointing::earth_nadir ( void ) const

inline

Return direction of Earth's nadir at space craft location.

Returns: Earth's nadir direction.

Definition at line 175 of file GCOSPointing.hpp.

References m_earth_nadir.

Referenced by earth_nadir(), GCOSSpaceCraft::livetime(), GCOSSpaceCraft::livetime(), and GCOSSpaceCraft::load_ori().

◆ earth_zenith() [1/2]

void GCOSPointing::earth_zenith ( const GSkyDir & earth_zenith )

inline

Set direction Earth's zenith at space craft location.

Parameters

[in] earth_zenith Earth's zenith direction.

Definition at line 251 of file GCOSPointing.hpp.

References earth_zenith(), and m_earth_zenith.

◆ earth_zenith() [2/2]

const GSkyDir & GCOSPointing::earth_zenith ( void ) const

inline

Return direction of Earth's zenith at space craft location.

Returns: Earth's zenith direction.

Definition at line 163 of file GCOSPointing.hpp.

References m_earth_zenith.

Referenced by earth_zenith(), and GCOSSpaceCraft::load_ori().

◆ free_members()

void GCOSPointing::free_members ( void )

protected

Delete class members.

Definition at line 244 of file GCOSPointing.cpp.

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

◆ init_members()

void GCOSPointing::init_members ( void )

protected

Initialise class members.

Definition at line 204 of file GCOSPointing.cpp.

References GSkyDir::clear(), GTime::clear(), m_altitude, m_earth_nadir, m_earth_zenith, m_livetime, m_sc_x, m_sc_z, and m_time.

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

◆ livetime() [1/2]

void GCOSPointing::livetime ( const double & livetime )

inline

Set livetime.

Parameters

[in] livetime Livetime (sec).

Definition at line 277 of file GCOSPointing.hpp.

References livetime(), and m_livetime.

◆ livetime() [2/2]

const double & GCOSPointing::livetime ( void ) const

inline

Return livetime.

Returns: Livetime (sec).

Definition at line 187 of file GCOSPointing.hpp.

References m_livetime.

Referenced by livetime(), GCOSSpaceCraft::livetime(), GCOSSpaceCraft::livetime(), and GCOSSpaceCraft::load_ori().

◆ operator=()

GCOSPointing & GCOSPointing::operator= ( const GCOSPointing & pointing )

Assignment operator.

Parameters

[in] pointing COSI pointing.

Returns: COSI pointing.

Definition at line 105 of file GCOSPointing.cpp.

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

◆ print()

std::string GCOSPointing::print ( const GChatter & chatter = NORMAL ) const

virtual

Print pointing information.

Parameters

[in] chatter Chattiness.

Returns: String containing pointing information.

Implements GBase.

Definition at line 165 of file GCOSPointing.cpp.

References m_altitude, m_earth_zenith, m_sc_x, m_sc_z, m_time, gammalib::parformat(), GSkyDir::print(), GTime::print(), gammalib::reduce(), SILENT, and gammalib::str().

◆ sc_x() [1/2]

void GCOSPointing::sc_x ( const GSkyDir & sc_x )

inline

Set space craft X-axis.

Parameters

[in] sc_x Space craft X-axis.

Definition at line 212 of file GCOSPointing.hpp.

References m_sc_x, and sc_x().

◆ sc_x() [2/2]

const GSkyDir & GCOSPointing::sc_x ( void ) const

inline

Return space craft X-axis.

Returns: Space craft X-axis.

Definition at line 127 of file GCOSPointing.hpp.

References m_sc_x.

Referenced by GCOSSpaceCraft::load_ori(), and sc_x().

◆ sc_z() [1/2]

void GCOSPointing::sc_z ( const GSkyDir & sc_z )

inline

Set space craft Z-axis.

Parameters

[in] sc_z Space craft Z-axis.

Definition at line 225 of file GCOSPointing.hpp.

References m_sc_z, and sc_z().

◆ sc_z() [2/2]

const GSkyDir & GCOSPointing::sc_z ( void ) const

inline

Return space craft Z-axis.

Returns: Space craft Z-axis.

Definition at line 139 of file GCOSPointing.hpp.

References m_sc_z.

Referenced by GCOSSpaceCraft::load_ori(), and sc_z().

◆ time() [1/2]

void GCOSPointing::time ( const GTime & time )

inline

Set time stamp.

Parameters

[in] time Time stamp.

Definition at line 199 of file GCOSPointing.hpp.

References m_time, and time().

◆ time() [2/2]

const GTime & GCOSPointing::time ( void ) const

inline

Return time stamp.

Returns: Time stamp.

Definition at line 115 of file GCOSPointing.hpp.

References m_time.

Referenced by GCOSSpaceCraft::load_ori(), and time().

Member Data Documentation

◆ m_altitude

double GCOSPointing::m_altitude

protected

Altitude above from Earth's ellipsoid (km)

Definition at line 90 of file GCOSPointing.hpp.

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

◆ m_earth_nadir

GSkyDir GCOSPointing::m_earth_nadir

protected

Direction of Earth's nadir at SC location.

Definition at line 92 of file GCOSPointing.hpp.

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

◆ m_earth_zenith

GSkyDir GCOSPointing::m_earth_zenith

protected

Direction of Earth's zenith at SC location.

Definition at line 91 of file GCOSPointing.hpp.

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

◆ m_livetime

double GCOSPointing::m_livetime

protected

Lifetime (sec)

Definition at line 93 of file GCOSPointing.hpp.

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

◆ m_sc_x

GSkyDir GCOSPointing::m_sc_x

protected

Space craft x-axis.

Definition at line 88 of file GCOSPointing.hpp.

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

◆ m_sc_z

GSkyDir GCOSPointing::m_sc_z

protected

Space craft z-axis.

Definition at line 89 of file GCOSPointing.hpp.

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

◆ m_time

GTime GCOSPointing::m_time

protected

Time stamp in UNIX seconds.

Definition at line 87 of file GCOSPointing.hpp.

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

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

inst/cos/include/GCOSPointing.hpp
inst/cos/src/GCOSPointing.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GCOSPointing() [1/2]

◆ GCOSPointing() [2/2]

◆ ~GCOSPointing()

Member Function Documentation

◆ altitude() [1/2]

◆ altitude() [2/2]

◆ classname()

◆ clear()

◆ clone()

◆ copy_members()

◆ earth_nadir() [1/2]

◆ earth_nadir() [2/2]

◆ earth_zenith() [1/2]

◆ earth_zenith() [2/2]

◆ free_members()

◆ init_members()

◆ livetime() [1/2]

◆ livetime() [2/2]

◆ operator=()

◆ print()

◆ sc_x() [1/2]

◆ sc_x() [2/2]

◆ sc_z() [1/2]

◆ sc_z() [2/2]

◆ time() [1/2]

◆ time() [2/2]

Member Data Documentation

◆ m_altitude

◆ m_earth_nadir

◆ m_earth_zenith

◆ m_livetime

◆ m_sc_x

◆ m_sc_z

◆ m_time