hlcc::ambientdataclient::AmbientData Class Reference

#include <ambientData.hpp>

Public Member Functions
	AmbientData (log4cplus::Logger &logger, rad::cii::OldbAdapter &oldb)
virtual	~AmbientData ()
bool	RefreshTrs (std::string hksrr_uri)
AsmData	ReadAsm ()
void	RefreshAsm ()
void	RefreshAsmAsync ()
double	GetTemperature () const
double	GetPressure () const
double	GetHumidity () const
double	GetObservingWavelength () const
void	SetObservingWavelength (double observing_wavelength)
ptk::Dut1	GetDut1 () const
void	SetDut1 (ptk::Dut1 dut1)
ptk::Arcsecs	GetXp () const
void	SetXp (ptk::Arcsecs xp)
ptk::Arcsecs	GetYp () const
void	SetYp (ptk::Arcsecs yp)

Constructor & Destructor Documentation

AmbientData()

hlcc::ambientdataclient::AmbientData::AmbientData	(	log4cplus::Logger &	logger,
		rad::cii::OldbAdapter &	oldb )

Ctor.

~AmbientData()

hlcc::ambientdataclient::AmbientData::~AmbientData ( )

virtual

Member Function Documentation

GetDut1()

ptk::Dut1 hlcc::ambientdataclient::AmbientData::GetDut1

(

)

const

Gets DUT1 (UT1 − UTC), a measure of Earth's actual rotational velocity.

You must call RefreshTrs before, otherwise a default value is returned. Bad quality of the data does not lead to an exception. It should be monitored separately, e.g. alarm system.

GetHumidity()

double hlcc::ambientdataclient::AmbientData::GetHumidity

(

)

const

Air humidity as a fraction, averaged over ~1 min by the ASM. It gets used for CirsToObserved.

GetObservingWavelength()

double hlcc::ambientdataclient::AmbientData::GetObservingWavelength

(

)

const

Gets the observing wavelength (in m) to be used for refraction in astrometric transformations. If SetObservingWavelength was called, that value will be returned. Otherwise the hardcoded default value of 650 nm is used.

GetPressure()

double hlcc::ambientdataclient::AmbientData::GetPressure

(

)

const

Ambient pressure in Pa, averaged over ~1 min by the ASM. It gets used for CirsToObserved.

GetTemperature()

double hlcc::ambientdataclient::AmbientData::GetTemperature

(

)

const

Ambient temperature in K, averaged over ~1 min by the ASM. It gets used for CirsToObserved.

GetXp()

ptk::Arcsecs hlcc::ambientdataclient::AmbientData::GetXp

(

)

const

Gets Polar motion coefficient (x).

You must call RefreshTrs before, otherwise a default value is returned. Bad quality of the data does not lead to an exception. It should be monitored separately, e.g. alarm system.

GetYp()

ptk::Arcsecs hlcc::ambientdataclient::AmbientData::GetYp

(

)

const

Gets Polar motion coefficient (y).

You must call RefreshTrs before, otherwise a default value is returned. Bad quality of the data does not lead to an exception. It should be monitored separately, e.g. alarm system.

ReadAsm()

AsmData hlcc::ambientdataclient::AmbientData::ReadAsm

(

)

Reads site information published by Astronomical site monitor.

This is the "raw" OLDB read method used by RefreshAsm. It should normally not be called directly by clients, but instead clients should call RefreshAsm or RefreshAsmAsync and then access data using the getting methods such as GetTemperature.

Returns

AsmData struct, containing site data

RefreshAsm()

void hlcc::ambientdataclient::AmbientData::RefreshAsm

(

)

Refresh the ASM data supplied in GetTemperature, GetPressure, GetPressure.

Access to the external ASM (OLDB) is done in the same thread.

RefreshAsmAsync()

void hlcc::ambientdataclient::AmbientData::RefreshAsmAsync

(

)

Calls RefreshAsm in a background thread and returns immediately. For performance-critical tasks, this method should be used.

RefreshTrs()

bool hlcc::ambientdataclient::AmbientData::RefreshTrs

(

std::string

hksrr_uri

)

Refresh the TRS HKS data supplied in GetDut1, GetXp, GetYp.

Access to the remote TRS HKS server is done in the same thread. We currenlty do not offer an async version of this command because TRS data is OK to be updated only once (or a few times) per day, at a time when the delay is not critical.

Parameters

[in]

hksrr_uri

The CII MAL URI for the HKS client application.

Returns

true if the TRS data could be read and is of OK quality, false otherwise.

SetDut1()

void hlcc::ambientdataclient::AmbientData::SetDut1

(

ptk::Dut1

dut1

)

Sets DUT1.

Normally the value should be set internally in the call to method RefreshTrs. But if RefreshTrs fails, then this setter can be used as a fallback solution, to set DUT1 from an alternative source.

SetObservingWavelength()

void hlcc::ambientdataclient::AmbientData::SetObservingWavelength

(

double

observing_wavelength

)

Sets the observing wavelength (in m) to be used for refraction in astrometric transformations.

SetXp()

void hlcc::ambientdataclient::AmbientData::SetXp

(

ptk::Arcsecs

xp

)

Sets polar motion coefficient (x coordinate).

Normally the value should be set internally in the call to method RefreshTrs. But if RefreshTrs fails, then this setter can be used as a fallback solution, to set xp from an alternative source.

SetYp()

void hlcc::ambientdataclient::AmbientData::SetYp

(

ptk::Arcsecs

yp

)

Sets polar motion coefficient (y coordinate).

Normally the value should be set internally in the call to method RefreshTrs. But if RefreshTrs fails, then this setter can be used as a fallback solution, to set yp from an alternative source.

---

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

• /home/abuild/rpmbuild/BUILD/hlcc-v3.0.0/software/common/ambientDataClient/src/include/ambientdataclient/ambientData.hpp
• /home/abuild/rpmbuild/BUILD/hlcc-v3.0.0/software/common/ambientDataClient/src/ambientData.cpp