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

A base class for managing tilts. More...

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

Inheritance diagram for sza::antenna::control::AxisTilt:
sza::antenna::control::AzTilt sza::antenna::control::ElTilt

Public Member Functions

virtual void apply (PointingCorrections *f)
 Apply the tilts managed by this class to the pointing corrections. More...
 
virtual void packHaTilt (signed *s_elements)
 Pack an HA tilt for archival in the register database. More...
 
virtual void packLatTilt (signed *s_elements)
 Pack a latitude tilt for archival in the register database. More...
 
virtual void packTilt (signed *s_elements)
 Pack a tilt for archival in the register database. More...
 
virtual void reset ()
 Reset private members of this class. More...
 
virtual void setHaTilt (double ha_tilt)
 Set the tilt in HA. More...
 
virtual void setLatTilt (double lat_tilt)
 Set the latitude tilt. More...
 
virtual void setTilt (double tilt)
 Generic method to set a tilt for classes which only manage one tilt. More...
 
virtual ~AxisTilt ()
 Virtual destructor ensures that the correct destructor will be called for classes that inherit from AxisTilt. More...
 

Detailed Description

A base class for managing tilts.

We don't make this a pure virtual class, since I want to be able to pass a handle to either az or el tilts which inherit from this class as a pointer to a single type, without having to explictly define methods in one that have no relevance (for instance, setHaTilt() for an elevation tilt).

Definition at line 26 of file AxisTilt.h.

Constructor & Destructor Documentation

virtual sza::antenna::control::AxisTilt::~AxisTilt ( )
virtual

Virtual destructor ensures that the correct destructor will be called for classes that inherit from AxisTilt.

Definition at line 34 of file AxisTilt.h.

Member Function Documentation

virtual void sza::antenna::control::AxisTilt::apply ( PointingCorrections f)
virtual

Apply the tilts managed by this class to the pointing corrections.

Reimplemented in sza::antenna::control::AzTilt, and sza::antenna::control::ElTilt.

Definition at line 63 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::packHaTilt ( signed *  s_elements)
virtual

Pack an HA tilt for archival in the register database.

Reimplemented in sza::antenna::control::AzTilt.

Definition at line 68 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::packLatTilt ( signed *  s_elements)
virtual

Pack a latitude tilt for archival in the register database.

Reimplemented in sza::antenna::control::AzTilt.

Definition at line 73 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::packTilt ( signed *  s_elements)
virtual

Pack a tilt for archival in the register database.

Reimplemented in sza::antenna::control::ElTilt.

Definition at line 78 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::reset ( )
virtual

Reset private members of this class.

Reimplemented in sza::antenna::control::AzTilt, and sza::antenna::control::ElTilt.

Definition at line 42 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::setHaTilt ( double  ha_tilt)
virtual

Set the tilt in HA.

Reimplemented in sza::antenna::control::AzTilt.

Definition at line 47 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::setLatTilt ( double  lat_tilt)
virtual

Set the latitude tilt.

Reimplemented in sza::antenna::control::AzTilt.

Definition at line 52 of file AxisTilt.h.

virtual void sza::antenna::control::AxisTilt::setTilt ( double  tilt)
virtual

Generic method to set a tilt for classes which only manage one tilt.

Reimplemented in sza::antenna::control::ElTilt.

Definition at line 58 of file AxisTilt.h.


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