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

Objects of the following type contain the collimation components of the pointing model. More...

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

Inheritance diagram for sza::antenna::control::Collimation:
sza::antenna::control::SkyOffset sza::antenna::control::OffsetBase

Public Member Functions

 Collimation ()
 Constructor trivially calls reset() method, below. More...
 
void incrXOffset (sza::util::Angle x)
 Increment the tilt associated with this collimation correction. More...
 
void incrYOffset (sza::util::Angle y)
 Increment the azimuth associated with this collimation correction. More...
 
bool isUsable ()
 
void reset ()
 
void setUsable (bool usable)
 
void setXOffset (sza::util::Angle x)
 Update the tilt associated with this collimation correction. More...
 
void setYOffset (sza::util::Angle y)
 Update the azimuth associated with this collimation correction. More...
 
- Public Member Functions inherited from sza::antenna::control::SkyOffset
void apply (PointingCorrections *f)
 Add in any position-independent sky offsets to the current pointing model. More...
 
void cacheValues ()
 
void incrXInRadians (double x)
 
void incrYInRadians (double y)
 
void pack (signed *s_elements)
 
void reset ()
 Reset the offsets to default values. More...
 
void set (sza::util::OffsetMsg msg)
 Update the values of the sky offset. More...
 
void setXInRadians (double x)
 
void setYInRadians (double y)
 
 SkyOffset ()
 Constructor just initializes the offsets. More...
 
- Public Member Functions inherited from sza::antenna::control::OffsetBase
 OffsetBase ()
 Constructor. More...
 
virtual void set (sza::util::OffsetMsg, unsigned seq)
 Install new offsets received from the control program, with sequence number. More...
 
virtual void setAngle (double angle)
 Set an angle. More...
 
double wrap2pi (double angle)
 Round an angle into the range 0-2.pi. More...
 
double wrapPi (double angle)
 Round an angle into the range -pi..pi. More...
 
virtual ~OffsetBase ()=0
 Pure virtual destructor prevents instantiation of OffsetBase. More...
 

Detailed Description

Objects of the following type contain the collimation components of the pointing model.

Definition at line 25 of file Collimation.h.

Constructor & Destructor Documentation

sza::antenna::control::Collimation::Collimation ( )

Constructor trivially calls reset() method, below.

Member Function Documentation

void sza::antenna::control::Collimation::incrXOffset ( sza::util::Angle  x)

Increment the tilt associated with this collimation correction.

void sza::antenna::control::Collimation::incrYOffset ( sza::util::Angle  y)

Increment the azimuth associated with this collimation correction.

void sza::antenna::control::Collimation::setXOffset ( sza::util::Angle  x)

Update the tilt associated with this collimation correction.

void sza::antenna::control::Collimation::setYOffset ( sza::util::Angle  y)

Update the azimuth associated with this collimation correction.


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