DriveControl.idl

Go to the documentation of this file.

#ifndef _DRIVEIDL
#define _DRIVEIDL

#include "carma/util/UserException.idl"

module carma {
    module antenna {
        module common {

    const string DRIVE_NAME = "Drive";

    interface DriveControl {

    enum Aperture {
        OPTICAL,    
        RADIO1MM,   
        RADIO3MM,   
        RADIO1CM    
    };

    enum Position {
        ZENITH,     
        SERVICE,    
        SAFE        
    };

    enum AzWrapMode {
        ZERO, 
        ADD,  
        SUB   
    };

    struct RaDecEpoch
    {
        double mjd; 
        double ra;  
        double dec; 
    };

    typedef sequence< RaDecEpoch, 3 > RaDecTriplet;

    void stow( in DriveControl::Position pos, in unsigned long seq )
        raises ( carma::util::UserException );

    void stop()
        raises (carma::util::UserException);

    void trackSnow()
        raises (carma::util::UserException);

    void trackWind()
        raises (carma::util::UserException);

    void setAntLocation(in double longitude, in double latitude,
                in double altitude)
        raises (carma::util::UserException);

    void setAzel( in double az, in double el, in unsigned long seq )
        raises (carma::util::UserException);

    void setAz( in double az, in unsigned long seq )
        raises (carma::util::UserException);

    void setEl( in double el, in unsigned long seq )
        raises (carma::util::UserException);

    void setMaxRate(in float azRate, in float elRate)
        raises (carma::util::UserException);

    void setAzMaxRate(in float azRate)
        raises (carma::util::UserException);

    void setElMaxRate(in float elRate)
        raises (carma::util::UserException);

    void track( in string source,
                in RaDecTriplet positionTriplet,
                in DriveControl::AzWrapMode mode,
                in boolean overTheTop,
                in unsigned long seq)
        raises (carma::util::UserException);

    void updateRaDec( in RaDecEpoch position,
                      in DriveControl::AzWrapMode mode )
        raises ( carma::util::UserException );

    void updateWeather(in float ambientTemp, in float barometricPressure,
             in float relativeHumidity,
             in float dewpointTemp,
             in float windSpeed,
             in float windDirection)
        raises (carma::util::UserException);

    void setMountOffset(in double az, in double el, in unsigned long seq)
        raises (carma::util::UserException);

    void setAzMountOffset(in double az, in unsigned long seq)
        raises (carma::util::UserException);

    void setElMountOffset(in double el, in unsigned long seq)
        raises (carma::util::UserException);

    void setOffset(in double az, in double el, in unsigned long seq)
        raises (carma::util::UserException);

    void setAzOffset(in double az, in unsigned long seq)
        raises (carma::util::UserException);

    void setElOffset(in double el, in unsigned long seq)
        raises (carma::util::UserException);

   void setAperturePointingConstants(
       in DriveControl::Aperture ap,
       in float azOffset, in float elOffset, in float sag)
    raises (carma::util::UserException);

   void setTiltmeterZero(in float aftForward, in float leftRight)
    raises (carma::util::UserException);

   /*
    * Select aperture. Sets pointing constants and refraction.
    * An aperture is a radio receiver beam or optical telescope.
    * @param aperture for which to select pointing constants
    */
   void selectAperture(in DriveControl::Aperture ap)
    raises (carma::util::UserException);

   /*
    * Set Tolerance for target aquisition.  This is specified in
    * [arcsec] for this antenna.  An antenna indicates that it
    * is "CLOSE" to the target once it has entered into the
    * range of its target tolerance, and once it has settled into
    * this range for 1-2 seconds, starts sending back the status
    * of "TRACK".  The control system wrapper for this uses an input
    * value in Half Power Beam Widths (full width half max) since they
    * provide a frequency independent measure of tracking.
    * @param tolerance tracking tolerance in arcsecs!
    */
   void setTolerance( in float toleranceInArcsecs )
    raises (carma::util::UserException);

   void setSafeRange( in float azLow, in float azHigh,
                      in float elLow, in float elHigh )
    raises (carma::util::UserException);

    }; // End DriveControl interface

}; // End module common
}; // End module antenna
}; // End module carma

#endif  // _DRIVEIDL