CorrDataRemapperControlImpl.h

Go to the documentation of this file.

// $Id: CorrDataRemapperControlImpl.h,v 1.4 2014/06/20 15:56:19 mpound Exp $

#ifndef CARMA_CORRELATOR_CORRDATAREMAPPERCONTROLIMPL_H
#define CARMA_CORRELATOR_CORRDATAREMAPPERCONTROLIMPL_H

#include <vector>
#include <map>
#include <boost/shared_ptr.hpp>

#include "carma/correlator/lib/CorrelatorData.h"

#include "carma/correlator/obsRecord2/CorbaCorrProducer.h"

#include "carma/correlator/transport/CorrDataRemapperControl.h"
#include "carma/correlator/transport/CorrDataRemapper.h"

#include "carma/monitor/SlRemapperSubsystem.h"
#include "carma/monitor/WbRemapperSubsystem.h"
#include "carma/monitor/C3gRemapperSubsystem.h"

#include "carma/szautil/Mutex.h"

#include "carma/util/Orb.h"

// memory managed pointers, no need to delete them in class destructor
typedef boost::shared_ptr<carma::monitor::SlRemapperSubsystem> slmon_ptr;
typedef boost::shared_ptr<carma::monitor::WbRemapperSubsystem> wbmon_ptr;
typedef boost::shared_ptr<carma::monitor::C3gRemapperSubsystem> c3gmon_ptr;

namespace carma {
  namespace correlator {

    namespace lib {
      class CorrelatorData;
    }

    class CorrDataRemapper;

    class CorrDataRemapperControlImpl {
    public:

      enum Sideband {
        SB_AUTO,
        SB_LSB,
        SB_USB
      };

      //------------------------------------------------------------
      // A struct for handling debug information
      //------------------------------------------------------------

      struct Debugger {

        // If true, print debugging output

        bool debug_;

        // Band number ro print

        unsigned astroBandNo_;

        // Sideband to print

        Sideband sideband_;

        // First and second input number to print

        unsigned inputNo1_;
        unsigned inputNo2_;

        Debugger();
        void printDebugInfo(carma::correlator::lib::CorrelatorData* cd);
        void printSideband(const carma::correlator::lib::CorrelatorSideband& sb);
      };
      
      //=======================================================================
      // Define a class for producing data via notification
      //=======================================================================
      
      class Producer : public carma::correlator::obsRecord2::CorbaCorrProducer {
      public:
      
      Producer(std::string notificationChannelName, carma::util::Orb & orb );
      ~Producer();
      
      std::string ncName_;

      void sendCorrelatorData(carma::correlator::lib::CorrelatorData* data);

    };

      CorrDataRemapperControlImpl(bool produce, std::string imrSrc, std::string imrDest, bool noPCS);

      virtual ~CorrDataRemapperControlImpl();

      //------------------------------------------------------------
      // IDL interface
      //------------------------------------------------------------

      void clearAstroBandInputMap(CORBA::UShort& astroBandNo);

      void updateAstroBandInputMap(CORBA::UShort& astroBandNo,
                   const CorrDataRemapperControl::AstroBandInputSeq& astroBandInputs);

      //------------------------------------------------------------
      // Non-IDL methods
      //------------------------------------------------------------

      // Initialize data connections

      void createProducers();

      // Create correlator-data listener resources

      void createCorrBandListeners();
      void createAstroBandListeners();

      // Spawn correlator-data listeners 

      void spawnListeners();
      void spawnProducers();

      void addListener(std::string objectName, const unsigned bandNo);

      bool publishData(carma::correlator::lib::CorrelatorData* cd, unsigned astroBandNo);

      Debugger& getDebugger();

      void setAstroBandInputMapsToDefaults();

      // Methods to set the underlying monitor point values via callback
      // from an instantiated CorrDataRemapper listener.  
      // First parameter is the notification channel name which is used to
      // look up the associated monitor subsystem from the std::map.
      // Second parameter is the monitor point value to set.

      void setOnlineMP( const std::string & ncName, const bool online );

      void setNumValidBaselinesMP( const std::string & ncName, const unsigned num );

       // There is no way for the remapper to know the number of invalid baselines
       // because the correlator data receieved already has the invalid baselines
       // removed.
      void setAstrobandNoMP( const std::string & ncName, const unsigned abNo );

      void setNumConjugatedMP( const std::string & ncName, const unsigned num);

      void setPublishedObjectMP( const std::string & ncName, const std::string & objName );

      void setDefaultPublishedObjectMP( const std::string & ncName, const unsigned astroBandNo);

      void setReceivedTimeMP( const std::string & ncName, const double mjd);

      void setPublishedTimeMP( const std::string & ncName, const double mjd);

    private:

      // IMR from which we are getting our data

      std::string imrSrc_;

      // IMR on which we are publishing our data

      std::string imrDest_;

      // Debugger object for printing out information on visibility data

      Debugger debugger_;

      // If true, we will connect to the actual data stream and produce data
      // If false, we will connect to the astroband data stream and print it

      bool produce_;

      // True if we are NOT using Program's corba::Server as the orb.
      // In this case no monitor system can be written.
      bool noPCS_;

      // A vector of listeners for collecting data from correlator
      // band servers

      // @todo consider using shared_ptr here.
      std::vector<CorrDataRemapper*> listeners_;

      // A vector of producers for publishing data on notification
      // channels

      // @todo consider using shared_ptr here.
      std::vector<Producer*> producers_;
      // names of published remapped objects indexed by astroband number
      std::map<unsigned, std::string> producerNames_;

      carma::util::Orb orb_; 

      // A cleverer person would do this with a single map
      // and a template.
      std::map<std::string, slmon_ptr > slMonsys_;
      std::map<std::string, wbmon_ptr > wbMonsys_;
      std::map<std::string, c3gmon_ptr > c3gMonsys_;


    }; // End class CorrDataRemapperControlImpl

  } // End namespace correlator
} // End namespace carma



#endif // End #ifndef CARMA_CORRELATOR_CORRDATAREMAPPERCONTROLIMPL_H