CARMA C++
sza::antenna::control::Atmosphere Class Reference

Class to encapsulate any atmospheric (refraction) corrections to the antenna pointing model. More...

#include <carma/antenna/sza/antenna/control/Atmosphere.h>

Public Member Functions

double applyRefraction (PointingCorrections *f)
 Apply the refraction correction to the current pointing corrections. More...
 
 Atmosphere ()
 Constructor. More...
 
sza::antenna::control::RefractioncurrentRefraction ()
 Get the current refraction. More...
 
bool isCurrent (sza::antenna::control::Refraction *r)
 Return true if the passed argument is the current refraction model. More...
 
sza::antenna::control::RefractionRefraction (sza::util::PointingMode::Type mode)
 Return a pointer to the requested refraction container. More...
 
void reset ()
 Restore the data members this object is managing to an intialization state. More...
 
void setCurrentRefraction (sza::util::PointingMode::Type mode)
 Set the requested mode (optical | radio) to be the current refraction model. More...
 

Detailed Description

Class to encapsulate any atmospheric (refraction) corrections to the antenna pointing model.

Definition at line 23 of file Atmosphere.h.

Constructor & Destructor Documentation

sza::antenna::control::Atmosphere::Atmosphere ( )

Constructor.

Member Function Documentation

double sza::antenna::control::Atmosphere::applyRefraction ( PointingCorrections f)

Apply the refraction correction to the current pointing corrections.

sza::antenna::control::Refraction* sza::antenna::control::Atmosphere::currentRefraction ( )

Get the current refraction.

bool sza::antenna::control::Atmosphere::isCurrent ( sza::antenna::control::Refraction r)

Return true if the passed argument is the current refraction model.

sza::antenna::control::Refraction* sza::antenna::control::Atmosphere::Refraction ( sza::util::PointingMode::Type  mode)

Return a pointer to the requested refraction container.

Exceptions
Exception
void sza::antenna::control::Atmosphere::reset ( )

Restore the data members this object is managing to an intialization state.

void sza::antenna::control::Atmosphere::setCurrentRefraction ( sza::util::PointingMode::Type  mode)

Set the requested mode (optical | radio) to be the current refraction model.


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