CorrelatorHandle.h

Go to the documentation of this file.

#ifndef CARMA_CONTROL_CORRELATOR_HANDLE_H
#define CARMA_CONTROL_CORRELATOR_HANDLE_H

#include <vector>

#include "carma/corba/corba.h"
#include "carma/control/RemoteObjHandleT.h"
#include "carma/control/CorrelatorInfo.h"
#include "carma/control/CorrDefs.h"
#include "carma/control/SubarrayControlImpl.h"
#include "carma/monitor/ControlSubsystem.h"
#include "carma/monitor/NoiseSource.h"
#include "carma/correlator/obsRecord2/CorDataBase.h"
#include "carma/correlator/obsRecord2/obsRecordUtils.h"
#include "carma/util/corrUtils.h"


namespace carma {
namespace control {


typedef RemoteObjHandleT< correlator::obsRecord2::Correlator_I > 
        CorrelatorControlRemoteObjHandle;


class CorrelatorHandle : public CorrelatorControlRemoteObjHandle {
    public:
        CorrelatorHandle(
            unsigned int                               astroBandNo,
            carma::util::CorrelatorType                corrType,
            monitor::MonitorSystem &                   monitorSys,
            monitor::ControlSubsystemBase::Reachable & reachable,
            bool                                       defaultLogIfNotReach );
    
        virtual ~CorrelatorHandle( );

        void setInputDelayTriplets(
            ::std::vector< correlator::obsRecord2::DelayTriplet > triplets );

        bool isOffline() const { return !online_ ; }

        //@param offline True if the band is online, false if offline
        void setOnline( const bool online )  {
            online_ = online;
        }
        
        void setBandwidth( 
            carma::correlator::obsRecord2::BandWidthType bw,
            const int preferredSeqNo,
            const unsigned int astroBandNo = 0 );

        void setBandwidth( 
            ::std::vector<carma::correlator::obsRecord2::BandWidthType> bw,
            ::std::vector<carma::correlator::obsRecord2::FpgaModeType> fm,
            const int preferredSeqNo,
            ::std::vector<unsigned int> astroBandNo );

        void optimizeThresholds( const int preferredSeqNo );

        void flattenPhases( const int preferredSeqNo );
     
        void calibrateSpectra( const bool noiseEnabled,
                               const float intTime,
                               const bool cache,
                               const bool enable,
                               const int preferredSeqNo
                              );

        void setDownconverterSettings( ::std::vector<float> dcFreqGHz );

        
        void enableCorrelation( const bool enable );

        bool isActionComplete( const monitor::MonitorSystem & monsys,
                               int monDataErrorLimit );

        void setAstroBandMode( util::CorrelatorFpgaModeType astroBandMode ) { astroBandMode_ = astroBandMode; }

        util::CorrelatorFpgaModeType getFpgaMode( ) const { return astroBandMode_; }

        unsigned int correlatorBandNo() const {return bandNo_;}
        unsigned int astroBandNo() const {return astroBandNo_ ;}

        void setWalshColumns(
                ::std::vector<int> cols90,
                ::std::vector<int> cols180,
                const int nStates90,
                const int nStates180,
                const bool noiseEnabled);

        carma::util::hardwareType hardwareType() const {return carma::util::hwType(astroBandNo_); }

        bool isSpectral() const { return hardwareType() == carma::util::HARDWARE_TYPE_CARMA; }

        bool isWideband() const { return hardwareType() == carma::util::HARDWARE_TYPE_COBRA; }

        bool isC3g() const { return hardwareType() == carma::util::HARDWARE_TYPE_C3G; }

        // @FIXME NO LONGER NEEDED.
    private:
        
        bool isNoiseSourceEnabled( void );
        bool isNoiseSourceDisabled( void );
        bool isNoiseSource( 
            monitor::NoiseStatusMonitorPointEnum::NOISESTATUS status 
                );
        void setNextSequenceNo( int preferredSequenceNo );

        bool online_;
        int nextSequenceNo_; 
        int consecutiveErrors_;
        int errLimit_;
        monitor::MonitorSystem & monitorSys_;
        unsigned int bandNo_;
        unsigned int astroBandNo_;
        util::CorrelatorFpgaModeType astroBandMode_;
        carma::util::CorrelatorType corrType_;
    
};


}  // namespace carma::control
}  // namespace carma


#endif