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

Encapsulate the pointing model parameters. More...

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

Public Member Functions

void applyCollimation (PointingCorrections *f)
 Correct the collimation of the telescope. More...
 
void applyFlexure (PointingCorrections *f)
 Adjust the elevation to account for telescope flexure. More...
 
sza::antenna::control::AxisTiltAxisTilt (sza::util::Axis::Type axis)
 Return a pointer to the requested collimation container. More...
 
sza::antenna::control::CollimationCollimation (sza::util::PointingMode::Type mode)
 Return a pointer to the requested collimation model. More...
 
sza::antenna::control::CollimationcurrentCollimation ()
 Return a pointer to the current collimation model. More...
 
sza::antenna::control::Flexure * currentFlexure ()
 Return a pointer to the current flexure model. More...
 
sza::antenna::control::EncoderEncoder (sza::util::Axis::Type axis)
 Return a pointer to the requested encoder model. More...
 
sza::antenna::control::Flexure * Flexure (sza::util::PointingMode::Type mode)
 Return a pointer to the requested flexure model. More...
 
bool isCurrent (sza::antenna::control::Collimation *collim)
 Return true if the passed collimation container is the current one. More...
 
bool isCurrent (sza::antenna::control::Flexure *flexure)
 Return true if the passed flexure container is the current one. More...
 
 Model ()
 Constructor. More...
 
void packCollimation (signed *s_elements)
 Pack the current collimation correction. More...
 
void packCollimationMode (unsigned *u_elements)
 Pack which collimation mode is the current one. More...
 
void packEncoderMultipliers (signed *s_elements)
 Pack the multipliers for encoders managed by this object. More...
 
void packEncoderZeros (signed *s_elements)
 Pack the zero points for encoders managed by this object. More...
 
void packFlexure (signed *s_elements)
 Pack the flexure term managed by this object. More...
 
void packTilts (signed *s_elements)
 Pack the tilts managed by this object. More...
 
void reset ()
 Reset internal data members. More...
 
void setCurrentCollimation (sza::util::PointingMode::Type mode)
 Set which pointing mode (optical or radio) is the current collimation mode) More...
 
void setCurrentFlexure (sza::util::PointingMode::Type mode)
 Set which pointing mode (optical or radio) is the current flexure mode) More...
 
void setFlexure (double flexure)
 Set the flexure term. More...
 
void updateMountLimits ()
 Compute and store the new mount limits as angles on the sky. More...
 
 ~Model ()
 Destructor. More...
 

Detailed Description

Encapsulate the pointing model parameters.

Definition at line 27 of file Model.h.

Constructor & Destructor Documentation

sza::antenna::control::Model::Model ( )

Constructor.

sza::antenna::control::Model::~Model ( )

Destructor.

Member Function Documentation

void sza::antenna::control::Model::applyCollimation ( PointingCorrections f)

Correct the collimation of the telescope.

Parameters
fPointingCorrections* The az/el pointing to be corrected.
void sza::antenna::control::Model::applyFlexure ( PointingCorrections f)

Adjust the elevation to account for telescope flexure.

Parameters
fPointingCorrections* The elevation pointing to be corrected.
sza::antenna::control::AxisTilt* sza::antenna::control::Model::AxisTilt ( sza::util::Axis::Type  axis)

Return a pointer to the requested collimation container.

Exceptions
Exception
sza::antenna::control::Collimation* sza::antenna::control::Model::Collimation ( sza::util::PointingMode::Type  mode)

Return a pointer to the requested collimation model.

Exceptions
Exception
sza::antenna::control::Collimation* sza::antenna::control::Model::currentCollimation ( )

Return a pointer to the current collimation model.

sza::antenna::control::Flexure* sza::antenna::control::Model::currentFlexure ( )

Return a pointer to the current flexure model.

sza::antenna::control::Encoder* sza::antenna::control::Model::Encoder ( sza::util::Axis::Type  axis)

Return a pointer to the requested encoder model.

Exceptions
Exception
sza::antenna::control::Flexure* sza::antenna::control::Model::Flexure ( sza::util::PointingMode::Type  mode)

Return a pointer to the requested flexure model.

Exceptions
Exception
bool sza::antenna::control::Model::isCurrent ( sza::antenna::control::Collimation collim)

Return true if the passed collimation container is the current one.

Parameters
collimCollimation* A collimation object
bool sza::antenna::control::Model::isCurrent ( sza::antenna::control::Flexure *  flexure)

Return true if the passed flexure container is the current one.

Parameters
collimFlexure* A flexure object
void sza::antenna::control::Model::packCollimation ( signed *  s_elements)

Pack the current collimation correction.

void sza::antenna::control::Model::packCollimationMode ( unsigned *  u_elements)

Pack which collimation mode is the current one.

void sza::antenna::control::Model::packEncoderMultipliers ( signed *  s_elements)

Pack the multipliers for encoders managed by this object.

void sza::antenna::control::Model::packEncoderZeros ( signed *  s_elements)

Pack the zero points for encoders managed by this object.

void sza::antenna::control::Model::packFlexure ( signed *  s_elements)

Pack the flexure term managed by this object.

void sza::antenna::control::Model::packTilts ( signed *  s_elements)

Pack the tilts managed by this object.

void sza::antenna::control::Model::reset ( )

Reset internal data members.

void sza::antenna::control::Model::setCurrentCollimation ( sza::util::PointingMode::Type  mode)

Set which pointing mode (optical or radio) is the current collimation mode)

void sza::antenna::control::Model::setCurrentFlexure ( sza::util::PointingMode::Type  mode)

Set which pointing mode (optical or radio) is the current flexure mode)

void sza::antenna::control::Model::setFlexure ( double  flexure)

Set the flexure term.

void sza::antenna::control::Model::updateMountLimits ( )

Compute and store the new mount limits as angles on the sky.


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