SignalPathMapperHandle.h

Go to the documentation of this file.

#ifndef CARMA_CONTROL_SIGNALPATHMAPPERHANDLE_H
#define CARMA_CONTROL_SIGNALPATHMAPPERHANDLE_H

#include "carma/control/CorrDefs.h"
#include "carma/control/RemoteObjHandleT.h"
#include "carma/control/CorrelatorInfo.h"
#include "carma/monitor/ControlSubsystem.h"

#include "carma/signalpath/SignalPathMapperControl.h"
#include "carma/switchyard/SwitchyardControl.h"
#include "carma/util/SeqTypedefs.h"
#include "carma/util/corrUtils.h"

#include <string>
#include <vector>

namespace carma {

namespace monitor {
    class MonitorSystem;
} // namespace monitor

namespace control {

typedef 
RemoteObjHandleT< carma::signalpath::SignalPathMapperControl> 
                  SignalPathMapperRemoteObjHandle;

// It is a thin handle that calls through to the DO and contains
// no local state.
class SignalPathMapperHandle: public SignalPathMapperRemoteObjHandle {
public:
    
    SignalPathMapperHandle( 
        carma::monitor::MonitorSystem & monitorSystem,
        carma::monitor::ControlSubsystemBase::Reachable & reachable );

    virtual ~SignalPathMapperHandle( );

    void initializeCableMap( const ::std::string & fileName );

    void loadConfiguration( const ::std::string & fileName, 
                            const ::std::string & confName, 
                            const ::std::string & astroBandConfName );

    void configureAstroBand(unsigned short bandNo, 
                            const ::std::string & confName, 
                            unsigned short subarrayNo,
                            ControlCorrelatorDesignation type);

    void checkConfigurationValidity(unsigned short bandNo, 
                                    const ::std::string & confName, 
                                    unsigned short subarrayNo,
                                    ControlCorrelatorDesignation type);

   void checkConfigurationSuccess(unsigned short bandNo);

   std::vector<carma::signalpath::SignalPathMapperControl::Antenna>
     getAntennas(unsigned short astroBandNo);
     
   std::vector<carma::signalpath::SignalPathMapperControl::BlockDownconverterSetting>
     getBdcSettings(unsigned short astroBandNo);
     
   ::std::vector<carma::signalpath::SignalPathMapperControl::CorrelatorBandInput> 
       getCorrelatorBandInputMap( const carma::signalpath::SignalPathMapperControl::CorrelatorBand & band );

   ::std::vector<carma::signalpath::SignalPathMapperControl::AstroBand> 
       getActiveAstroBands( ControlCorrelatorDesignation type );

   ::std::vector<carma::signalpath::SignalPathMapperControl::AstroBand> 
       getAstroBandsForConfiguration( const ::std::string & confName, 
                                      unsigned short subarrayNo,
                                      ControlCorrelatorDesignation type);
   
   ::std::vector<carma::signalpath::SignalPathMapperControl::CorrelatorBand> 
       getActiveCorrelatorBands( ControlCorrelatorDesignation type );

   ::std::vector<carma::signalpath::SignalPathMapperControl::CorrelatorBand> 
       getCorrelatorBands(unsigned astroBandNo);

   carma::util::SeqShort * getCorrelatorBandNoSeq(unsigned astroBandNo);

   carma::util::SeqShort * getActiveAstroBandNoSeq( ControlCorrelatorDesignation type );

   ::std::vector<short>    getActiveAstroBandNoVec( ControlCorrelatorDesignation type );

   carma::util::CorrelatorFpgaModeType getFpgaMode(unsigned astroBandNo);

   std::vector<carma::switchyard::SwitchPosition>
     getIFSwitchSettings(unsigned short astroBandNo);

   std::vector<carma::switchyard::SwitchPosition>
     getDCLOSwitchSettings(unsigned short astroBandNo);

   std::vector<carma::switchyard::SwitchPosition>
     getLOSwitchSettings(unsigned short astroBandNo);

   std::vector<carma::switchyard::SwitchPosition>
     getLLSwitchSettings(unsigned short astroBandNo);

   unsigned int getNumActiveCorrelatorBands( ControlCorrelatorDesignation type );

   unsigned int getNumActiveAstroBands( ControlCorrelatorDesignation type );

   void clearAstroBandConfiguration(unsigned short bandNo, 
                                    unsigned short subarrayNo,
                                    ControlCorrelatorDesignation type);
                
   void assignWalshColumn(carma::signalpath::SignalPathMapperControl::WalshColumnAssignment wca);

   void clearWalshColumnAssignment(unsigned short antNo);

   ::std::vector<carma::signalpath::SignalPathMapperControl::WalshColumnAssignment> 
          getWalshColumnAssignment(unsigned short antNo);

   ::std::string queryConfiguration();

   void addAntenna(unsigned short antNo, unsigned short subarrayNo);
   void removeAntenna(unsigned short antNo, unsigned short subarrayNo);

   void addCorrelator(ControlCorrelatorDesignation type, unsigned short subarrayNo);

   void removeCorrelator(ControlCorrelatorDesignation type, unsigned short subarrayNo);

   bool isValidAstroBand( unsigned astroBandNo, ControlCorrelatorDesignation type);

   ::std::string getConfname( unsigned short astroBandNo );

   int getAstroBandForCorrelatorBand( unsigned short corrBandNo,
                                            ControlCorrelatorDesignation type );

   ControlCorrelatorDesignation getCorrTypeForAstroBand( unsigned short astroBandNo );
};

// Optimally, this should be implemented in 
// signalpath/SignalPathMapperControlImpl.cc
// so that less data are transmitted across the wire.
// But for now, this suffices.
inline unsigned int
  carma::control::SignalPathMapperHandle::getNumActiveCorrelatorBands(ControlCorrelatorDesignation type) 
{
    if ( type == carma::util::CORR_NONE ) return 0;

    return getActiveCorrelatorBands( type ).size();
}


}} // namespace carma::control
#endif