CARMA C++
carma::antenna::sza::control::DriveControl Interface Reference

SZA antenna-specific drive control interface. More...

import "carma/antenna/sza/control/szaDriveControl.idl";

Inheritance diagram for carma::antenna::sza::control::DriveControl:
carma::antenna::common::DriveControl

Public Member Functions

void setCollimation (in DriveControl::Aperture ap, in double xCollimation, in double yCollimation) raises (carma::util::UserException)
 Set collimation terms for this antenna. More...
 
void setEncoderCountsPerTurn (in unsigned long azCountsPerTurn, in unsigned long elCountsPerTurn) raises (carma::util::UserException)
 Specify the encoder counts per turn for the encoders. More...
 
void setEncoderLimits (in unsigned long azMinCount, in unsigned long azMaxCount, in unsigned long elMinCount, in unsigned long elMaxCount) raises (carma::util::UserException)
 Specify encoder limits, in encoder counts. More...
 
void setEncoderZeros (in double azEncZeroDeg, in double elEncZeroDeg) raises (carma::util::UserException)
 Set encoder zeros for this antenna. More...
 
void setFlexure (in DriveControl::Aperture ap, in double sinCoeff, in double cosCoeff) raises (carma::util::UserException)
 Set flexure terms for this antenna. More...
 
void setMountPointingConstants (in unsigned long azEncoderCountsPerTurn, in unsigned long elEncoderCountsPerTurn, in unsigned long azMinEncoderCounts, in unsigned long azMaxEncoderCounts, in unsigned long elMinEncoderCounts, in unsigned long elMaxEncoderCounts, in double azEncoderZeroDegrees, in double elEncoderZeroDegrees, in double haTiltDegrees, in double latTiltDegrees, in double elTiltDegrees, in double opticalXCollimationDegrees, in double opticalYCollimationDegrees, in double opticalFlexureSinDegrees, in double opticalFlexureCosDegrees, in double radioXCollimationDegrees, in double radioYCollimationDegrees, in double radioFlexureSinDegrees, in double radioFlexureCosDegrees) raises (carma::util::UserException)
 Sets all mount pointing constants at one go. More...
 
void setTilts (in double haTiltDeg, in double latTiltDeg, in double elTiltDeg) raises (carma::util::UserException)
 Set tilts for this antenna. More...
 
void setWrapMode (in DriveControl::AzWrapMode mode) raises (carma::util::UserException)
 Set the wrap mode (azimuth only – others ignored. More...
 
- Public Member Functions inherited from carma::antenna::common::DriveControl
void selectAperture (in DriveControl::Aperture ap) raises (carma::util::UserException)
 
void setAntLocation (in double longitude, in double latitude, in double altitude) raises (carma::util::UserException)
 Specify the absolute antenna location Used in the computation of az and el for celestial sources. More...
 
void setAperturePointingConstants (in DriveControl::Aperture ap, in float azOffset, in float elOffset, in float sag) raises (carma::util::UserException)
 Sets aperature pointing constants. More...
 
void setAz (in double az, in unsigned long seq) raises (carma::util::UserException)
 Go to requested azimuth. More...
 
void setAzel (in double az, in double el, in unsigned long seq) raises (carma::util::UserException)
 Go to requested az/el, setting the drive to horizon (azel) mode. More...
 
void setAzMaxRate (in float azRate) raises (carma::util::UserException)
 Sets the maximum azimuth drive rate that can be requested. More...
 
void setAzMountOffset (in double az, in unsigned long seq) raises (carma::util::UserException)
 Az mount offsets. More...
 
void setAzOffset (in double az, in unsigned long seq) raises (carma::util::UserException)
 Az transient astronomical offsets. More...
 
void setEl (in double el, in unsigned long seq) raises (carma::util::UserException)
 Go to requested elevation. More...
 
void setElMaxRate (in float elRate) raises (carma::util::UserException)
 Sets the maximum elevation drive rate that can be requested. More...
 
void setElMountOffset (in double el, in unsigned long seq) raises (carma::util::UserException)
 El mount offsets. More...
 
void setElOffset (in double el, in unsigned long seq) raises (carma::util::UserException)
 El transient astronomical offsets. More...
 
void setMaxRate (in float azRate, in float elRate) raises (carma::util::UserException)
 Sets the maximum drive rate that can be requested by the drive system software. More...
 
void setMountOffset (in double az, in double el, in unsigned long seq) raises (carma::util::UserException)
 Az/El mount offsets. More...
 
void setOffset (in double az, in double el, in unsigned long seq) raises (carma::util::UserException)
 Az/El transient astronomical offsets. More...
 
void setSafeRange (in float azLow, in float azHigh, in float elLow, in float elHigh) raises (carma::util::UserException)
 Set the azimuth and elevation ranges within which this antenna is safe from collisions with other antennas. More...
 
void setTiltmeterZero (in float aftForward, in float leftRight) raises (carma::util::UserException)
 Sets the zero point for the tiltmeter. More...
 
void setTolerance (in float toleranceInArcsecs) raises (carma::util::UserException)
 
void stop () raises (carma::util::UserException)
 Stop the antenna immediately. More...
 
void stow (in DriveControl::Position pos, in unsigned long seq) raises ( carma::util::UserException )
 Go to a fixed position, such as vertical, safe or stow. More...
 
void track (in string source, in RaDecTriplet positionTriplet, in DriveControl::AzWrapMode mode, in boolean overTheTop, in unsigned long seq) raises (carma::util::UserException)
 Set a new RA/Dec tracking position. More...
 
void trackSnow () raises (carma::util::UserException)
 Starts tracking to minimize snow accumulation on dish surface. More...
 
void trackWind () raises (carma::util::UserException)
 Starts tracking to minimize impact of heavy wind. More...
 
void updateRaDec (in RaDecEpoch position, in DriveControl::AzWrapMode mode) raises ( carma::util::UserException )
 Update tracking with a new time-tagged Ra/Dec position. More...
 
void updateWeather (in float ambientTemp, in float barometricPressure, in float relativeHumidity, in float dewpointTemp, in float windSpeed, in float windDirection) raises (carma::util::UserException)
 Update weather parameters. More...
 

Additional Inherited Members

- Public Types inherited from carma::antenna::common::DriveControl
enum  Aperture { OPTICAL, RADIO1MM, RADIO3MM, RADIO1CM }
 Enumerate apertures to use for selecting pointing models. More...
 
enum  AzWrapMode { ZERO, ADD, SUB }
 The azimuth drive can operate over more than a full circle, and the wrap logic dictates how the ambiguities are resolved when requesting RA/Dec positions. More...
 
enum  Position { ZENITH, SERVICE, SAFE }
 Enumerate valid fixed positions for Stow. More...
 
typedef sequence< RaDecEpoch, 3 > RaDecTriplet
 

Detailed Description

SZA antenna-specific drive control interface.

Definition at line 18 of file szaDriveControl.idl.

Member Function Documentation

void carma::antenna::sza::control::DriveControl::setCollimation ( in DriveControl::Aperture  ap,
in double  xCollimation,
in double  yCollimation 
)
raises (carma::util::UserException
)

Set collimation terms for this antenna.

Parameters
apertureRADIO(1CM/1MM/3MM) or OPTICAL
xCollimationX great circle offset, degrees
yCollimationY great circle offset, degrees
void carma::antenna::sza::control::DriveControl::setEncoderCountsPerTurn ( in unsigned long  azCountsPerTurn,
in unsigned long  elCountsPerTurn 
)
raises (carma::util::UserException
)

Specify the encoder counts per turn for the encoders.

Parameters
azCountsPerTurnAz encoder counts per turn
elCountsPerTurnEl encoder counts per turn
void carma::antenna::sza::control::DriveControl::setEncoderLimits ( in unsigned long  azMinCount,
in unsigned long  azMaxCount,
in unsigned long  elMinCount,
in unsigned long  elMaxCount 
)
raises (carma::util::UserException
)

Specify encoder limits, in encoder counts.

Parameters
azMinCountMinimum allowed az encoder count
azMaxCountMaximum allowed az encoder count
elMinCountMinimum allowed el encoder count
elMaxCountMaximum allowed el encoder count
void carma::antenna::sza::control::DriveControl::setEncoderZeros ( in double  azEncZeroDeg,
in double  elEncZeroDeg 
)
raises (carma::util::UserException
)

Set encoder zeros for this antenna.

Parameters
azEncZeroDegAzimuth encoder zero, in degrees
elEncZeroDegElevation encoder zero, in degrees
void carma::antenna::sza::control::DriveControl::setFlexure ( in DriveControl::Aperture  ap,
in double  sinCoeff,
in double  cosCoeff 
)
raises (carma::util::UserException
)

Set flexure terms for this antenna.

Parameters
apertureRADIO(1CM/1MM/3MM) or OPTICAL
sinCoeffDeflection per sin(el), degrees
cosCoeffDeflection per cos(el), degrees
void carma::antenna::sza::control::DriveControl::setMountPointingConstants ( in unsigned long  azEncoderCountsPerTurn,
in unsigned long  elEncoderCountsPerTurn,
in unsigned long  azMinEncoderCounts,
in unsigned long  azMaxEncoderCounts,
in unsigned long  elMinEncoderCounts,
in unsigned long  elMaxEncoderCounts,
in double  azEncoderZeroDegrees,
in double  elEncoderZeroDegrees,
in double  haTiltDegrees,
in double  latTiltDegrees,
in double  elTiltDegrees,
in double  opticalXCollimationDegrees,
in double  opticalYCollimationDegrees,
in double  opticalFlexureSinDegrees,
in double  opticalFlexureCosDegrees,
in double  radioXCollimationDegrees,
in double  radioYCollimationDegrees,
in double  radioFlexureSinDegrees,
in double  radioFlexureCosDegrees 
)
raises (carma::util::UserException
)

Sets all mount pointing constants at one go.

Parameters
azEncoderCountsPerTurnAZ encoder calibration (counts per turn)
elEncoderCountsPerTurnAZ encoder calibration (counts per turn)
azMinEncoderCountsMinimum AZ limit (encoder counts)
azMaxEncoderCountsMaximum AZ limit (encoder counts)
elMinEncoderCountsMinimum EL limit (encoder counts)
elMaxEncoderCountsMaximum EL limit (encoder counts)
azEncoderZeroDegreesAZ encoder zero (degrees)
elEncoderZeroDegreesEL encoder zero (degrees)
haTiltDegreesHour-angle tilt (degrees)
latTiltDegreesLatitude tilt (degrees)
elTiltDegreesElevation tilt (degrees)
opticalXCollimationDegreesOptical collimation great-circle (x) angle (degrees)
opticalYCollimationDegreesOptical collimation great-circle (y) angle (degrees)
opticalFlexureSinDegreesOptical flexure sin term (degrees per sin elevation)
opticalFlexureCosDegreesOptical flexure cos term (degrees per sin elevation)
radioXCollimationDegreesRadio collimation great-circle (x) angle (degrees)
radioYCollimationDegreesRadio collimation great-circle (y) angle (degrees)
radioFlexureSinDegreesRadio flexure sin term (degrees per sin elevation)
radioFlexureCosDegreesRadio flexure cos term (degrees per sin elevation)
void carma::antenna::sza::control::DriveControl::setTilts ( in double  haTiltDeg,
in double  latTiltDeg,
in double  elTiltDeg 
)
raises (carma::util::UserException
)

Set tilts for this antenna.

Parameters
haTiltDegHour-angle tilt, in degrees
latTiltDegLatitude tilt, in degrees
elTiltDegElevation tilt, in degrees
void carma::antenna::sza::control::DriveControl::setWrapMode ( in DriveControl::AzWrapMode  mode)
raises (carma::util::UserException
)

Set the wrap mode (azimuth only – others ignored.


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