My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::antenna::control::Site Class Reference

#include <Site.h>

Public Member Functions

 Site ()
 
void setFiducial (gcp::util::Angle longitude, gcp::util::Angle latitude, double altitude)
 
void setOffset (double north, double east, double up)
 
void reset ()
 
double convertMjdUtcToLst (double utc, double ut1utc, double eqneqx)
 
void applyParallax (double dist, PointingCorrections *f)
 
void applyDiurnalAberration (PointingCorrections *f)
 
void updateLatitude (PointingCorrections *f)
 
void packFiducial (signed *s_elements)
 
void packActual (signed *s_elements)
 
void packOffset (signed *s_elements)
 
double getLongitude ()
 
double getLatitude ()
 
double getAltitude ()
 
gcp::util::Angle latitude ()
 
gcp::util::Length altitude ()
 

Public Attributes

gcp::control::Site actual_
 

Detailed Description

Class for managing antenna site-specific parameters.

Constructor & Destructor Documentation

Site::Site ( )

Constructor.

Exceptions
Exception....................................................................... Constructor.

Member Function Documentation

void Site::applyDiurnalAberration ( PointingCorrections f)

Correct the azimuth and elevation for diurnal aberration.

Parameters
fPointingCorrections * The az/el pointing to be corrected.

....................................................................... Correct the azimuth and elevation for diurnal aberration.

Input/Output: f PointingCorrections * The az/el pointing to be corrected.

void Site::applyParallax ( double  dist,
PointingCorrections f 
)

Correct the azimuth and elevation for horizontal parallax.

Parameters
distdouble The distance of the source (AU), or 0.0 if the distance can be assumed to be infinite.
fPointingCorrections* The az/el pointing to be corrected.

....................................................................... Correct the azimuth and elevation for horizontal parallax.

Input: dist double The distance of the source (AU), or 0.0 if the distance can be assumed to be infinite. Input/Output: f PointingCorrections * The az/el pointing to be corrected.

double Site::convertMjdUtcToLst ( double  utc,
double  ut1utc,
double  eqneqx 
)

Return the local sidereal time for a given site and UTC.

....................................................................... Return the local sidereal time for a given site and UTC.

This is a public wrapper around mjd_utc_to_lst so we never have to expose actual_ to other classes.

void Site::packActual ( signed *  s_elements)

Pack actual site-specific data for archival in the register database.

....................................................................... Pack fiducial site-specific data for archival in the register database.

void Site::packFiducial ( signed *  s_elements)

Pack fiducial site-specific data for archival in the register database.

....................................................................... Pack fiducial site-specific data for archival in the register database.

void Site::packOffset ( signed *  s_elements)

Pack site-specific data for archival in the register database.

....................................................................... Pack offset site-specific data for archival in the register database.

void Site::reset ( )

Reset site parameters to default values.

....................................................................... Reset site parameters to default values.

void Site::setFiducial ( gcp::util::Angle  longitude,
gcp::util::Angle  latitude,
double  altitude 
)

Set the antenna location fiducial parameters

Exceptions
Exception....................................................................... A public method to set fiducial site parameters
void Site::setOffset ( double  up,
double  east,
double  north 
)

Set the antenna location offset parameters

Exceptions
Exception....................................................................... A public method to set offset site parameters
void Site::updateLatitude ( PointingCorrections f)

Install the latitude in the pointing corrections container.

....................................................................... Install the latitude in the pointing corrections container.


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