HLCC Documentation 2.2.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
pfs::gpctr::PointingCorrection Class Reference

#include <pointingCorrection.hpp>

Public Member Functions

 PointingCorrection (const taiclock::TaiClock::time_point timestamp, const double correction_ra, const double correction_dec, const bool is_valid)
 
PointingCorrectionoperator= (const PointingCorrection &corr)
 Assignement operator.
 
 PointingCorrection ()
 
 PointingCorrection (const PointingCorrection &corr)
 Copy constructor.
 
taiclock::TaiClock::time_point GetTimestamp () const
 getter
 
double GetRa () const
 Getter.
 
double GetDec () const
 Getter.
 
bool IsValid () const
 Getter.
 

Detailed Description

The pointing corrections.

Pointing correction are sent by TREx (MUDPI) and applied by the GuideProbe controller.

Constructor & Destructor Documentation

◆ PointingCorrection() [1/3]

pfs::gpctr::PointingCorrection::PointingCorrection ( const taiclock::TaiClock::time_point timestamp,
const double correction_ra,
const double correction_dec,
const bool is_valid )
inline

Constructor

Parameters
timestampThe timestamp
correction_raThe pointing correction in RA
correction_decThe pointing correction in DEC
is_validThe validity flag

◆ PointingCorrection() [2/3]

pfs::gpctr::PointingCorrection::PointingCorrection ( )
inline

Empty constructor: builds an invalid PointingCorrection with the actual timestamp

◆ PointingCorrection() [3/3]

pfs::gpctr::PointingCorrection::PointingCorrection ( const PointingCorrection & corr)
inline

Copy constructor.

Parameters
corrThe pointing correction to copy

Member Function Documentation

◆ GetDec()

double pfs::gpctr::PointingCorrection::GetDec ( ) const
inline

Getter.

Returns
The DEC component of the pointing correction

◆ GetRa()

double pfs::gpctr::PointingCorrection::GetRa ( ) const
inline

Getter.

Returns
The RA component of the pointing correction

◆ GetTimestamp()

taiclock::TaiClock::time_point pfs::gpctr::PointingCorrection::GetTimestamp ( ) const
inline

getter

Returns
The timestamp

◆ IsValid()

bool pfs::gpctr::PointingCorrection::IsValid ( ) const
inline

Getter.

Returns
True if the correction is valid, false otherwise

◆ operator=()

PointingCorrection & pfs::gpctr::PointingCorrection::operator= ( const PointingCorrection & corr)
inline

Assignement operator.


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