SignalPathMapperControl.idl

#ifndef CARMA_SIGNALPATH_SIGNALPATHMAPPER_IDL
#define CARMA_SIGNALPATH_SIGNALPATHMAPPER_IDL

#include "carma/util/UserException.idl"

// Include for CORBA sequence typedefs
#include "carma/util/SeqTypedefs.idl"

// Include for carma::downconverter::Polarization

#include "carma/downconverter/spectral/BlockDownconverterControl.idl"

// Include for CorrelatorType
#include "carma/util/CorrelatorType.idl"

// Include for SwitchPosition

#include "carma/switchyard/SwitchyardControl.idl"

// Include for polarization state

#include "carma/antenna/common/PolarizationControl.idl"

module carma {
  module signalpath {

    // Names under which this interface will be published

    const string SIGNALPATHMAPPERCONTROL_NAME = "carma.signalpathmapper";

    interface SignalPathMapperControl {

      enum SwitchyardConfiguration {
        LL,
        RR,
        CARMA23,
        FULLSTOKES,
        DUALPOL,
        MAXSENS_DUALPOL,
        MAXSENS_CARMA23_LOWRES,
        MAXSENS_CARMA23_MEDRES,
        MAXSENS_CARMA23_HIGHRES,
        MAXSENS_LL,
        CMTEST,
        LL_INTERIM
      };

      enum PolarizationType {
        POL_NONE,
        POL_LEFT,
        POL_RIGHT
      };

      typedef sequence<PolarizationType> PolarizationSeq;

      enum AntennaType {
        ANT_NONE,
        ANT_SZA,
        ANT_BIMA,
        ANT_OVRO
      };

      struct Antenna {
        unsigned short antNo;      // The antenna number corresponding to this input
        AntennaType type;          // The type of this antenna
        unsigned short walshColNo; // Walsh column number (1-32)
        unsigned short subarrayNo; // The current subarray controlling this antenna
      };

      typedef sequence<Antenna> AntennaSeq;

      struct AntennaIF {
        unsigned short antNo;     // The antenna number corresponding to this input
        PolarizationType polType; // The polarization type of this antenna IF
      };

      struct AstroBand {
        unsigned short astroBandNo; // The astro band number
      };

      typedef sequence<AstroBand> AstroBandSeq;

      struct AstroBandInput {
        AstroBand aBand;        // The astro band corresponding to this input
        unsigned short inputNo; // The astro band input number
      };

      typedef sequence<AstroBandInput> AstroBandInputSeq;

      struct CorrelatorCrate {
        carma::util::CorrelatorType type; // The type of this correlator
        unsigned short crateNo;        // The crate number (e.g., the 1 of SLCOR1)
      };

      typedef sequence<CorrelatorCrate> CorrelatorCrateSeq;

      struct CorrelatorBand {
        CorrelatorCrate crate; // The crate associated with this band
        unsigned short bandNo; // The band number (e.g., the 16 of WBCOR16)
      };

      typedef sequence<CorrelatorBand> CorrelatorBandSeq;

      struct CorrelatorCrateInput {
        CorrelatorCrate crate;   // The crate corresponding to this input
        unsigned short inputNo;  // The input number
        AntennaIF antIF;         // The antenna IF corresponding to this input
      };

      typedef sequence<CorrelatorCrateInput> CorrelatorCrateInputSeq;

      struct CorrelatorBandInput {
        CorrelatorBand band;       // The band corresponding to this input
        unsigned short inputNo;    // The input number
        AntennaIF antIF;           // The antenna IF corresponding to this input
        AstroBandInput aBandInput; // The astroband input associated with this correlator band input
      };

      typedef sequence<CorrelatorBandInput> CorrelatorBandInputSeq;

      struct WalshColumnAssignment {
        unsigned short antNo;      // Antenna number (1-23)
        unsigned short walshColNo; // Walsh column number (1-32)
      };

      typedef sequence<WalshColumnAssignment> WalshColumnAssignmentSeq;

      struct BlockDownconverterSetting {
        unsigned short bdcNo;      //  Block downconverter number (1-15)
        unsigned short bandNo;     //  Block downconverter band number (1-8)
        carma::downconverter::BlockDownconverterControl::Polarization bdcInputType; // Input selector for this band
      };

      typedef sequence<BlockDownconverterSetting> BlockDownconverterSettingSeq;

      void initializeCableMap(in string fileName)
        raises (carma::util::UserException);

      void loadConfiguration(in string fileName, in string confName, in string astroBandConfName)
        raises (carma::util::UserException);

      void addAntenna(in unsigned short antNo, in unsigned short subarrayNo)
        raises (carma::util::UserException);

      void removeAntenna(in unsigned short antNo, in unsigned short subarrayNo)
        raises (carma::util::UserException);

      void addCorrelator(in carma::util::CorrelatorType type, in unsigned short subarrayNo)
        raises (carma::util::UserException);

      void removeCorrelator(in carma::util::CorrelatorType type, in unsigned short subarrayNo)
        raises (carma::util::UserException);


      void configureAstroBand(in unsigned short astroBandNo, 
                              in string confName,
                              in unsigned short subarrayNo, 
                              in carma::util::CorrelatorType type)
        raises (carma::util::UserException);
      void checkConfigurationValidity(in unsigned short astroBandNo, 
                                      in string confName,
                                      in unsigned short subarrayNo, 
                                      in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      boolean configurationIsValid(in unsigned short astroBandNo,
                                      in string confName,
                                      in unsigned short subarrayNo, 
                                      in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      void clearAstroBandConfiguration(in unsigned short bandNo,
                  in unsigned short subarrayNo, in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      void assignWalshColumn(in SignalPathMapperControl::WalshColumnAssignment wca)
        raises (carma::util::UserException);

      void clearWalshColumnAssignment(in unsigned short antNo)
        raises (carma::util::UserException);

      carma::switchyard::SwitchPositionSeq getIFSwitchSettings(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::switchyard::SwitchPositionSeq getDCLOSwitchSettings(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::switchyard::SwitchPositionSeq getLOSwitchSettings(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::switchyard::SwitchPositionSeq getLLSwitchSettings(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      AntennaSeq getAntennas(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      PolarizationSeq getPolarizations(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      BlockDownconverterSettingSeq getBdcSettings(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::util::CorrelatorFpgaModeType getFpgaMode(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      WalshColumnAssignmentSeq getWalshColumnAssignment(in unsigned short antNo)
        raises (carma::util::UserException);

      CorrelatorBandSeq getActiveCorrelatorBands(in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      AstroBandSeq getActiveAstroBands(in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      AstroBandSeq getAstroBandsForConfiguration(in string confName, in unsigned short subarrayNo, in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      CorrelatorBandSeq getCorrelatorBands(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::util::SeqShort getCorrelatorBandNoSeq(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      carma::util::SeqShort getActiveAstroBandNoSeq(in carma::util::CorrelatorType type)
        raises (carma::util::UserException);


      CorrelatorBandInputSeq getCorrelatorBandInputMap(in SignalPathMapperControl::CorrelatorBand band)
        raises (carma::util::UserException);

      CorrelatorCrateSeq getActiveCorrelatorCrates(in carma::util::CorrelatorType type)
        raises (carma::util::UserException);

      CorrelatorCrateInputSeq getCorrelatorCrateInputMap(in SignalPathMapperControl::CorrelatorCrate crate)
        raises (carma::util::UserException);

      boolean canAssertSwitchPosition(in carma::switchyard::SwitchPosition pos)
        raises (carma::util::UserException);

      string queryConfiguration()
        raises (carma::util::UserException);

      void checkConfigurationSuccess(in unsigned short astroBandNo)
        raises (carma::util::UserException);

      string getConfName(in unsigned short astroBandNo )
        raises (carma::util::UserException);

      short getAstroBandForCorrelatorBand(in unsigned short corrBandNo, in carma::util::CorrelatorType type )
        raises (carma::util::UserException);

      carma::util::CorrelatorType getCorrTypeForAstroBand(in unsigned short astroBandNo )
        raises (carma::util::UserException);
      
    }; // interface SignalPathMapperControl
    
  }; // module signalpath

}; // module carma

#endif