CorrelatorSet.h

Go to the documentation of this file.

// $Id: CorrelatorSet.h,v 1.6 2014/06/04 17:09:52 mpound Exp $

#ifndef CARMA_UTIL_CORRELATORSET_H
#define CARMA_UTIL_CORRELATORSET_H

#include <string>
#include <sstream>
#include <vector>
#include "carma/util/CorrelatorType.h"

namespace carma {
  namespace util {

    class CorrelatorSet {
    public:

      CorrelatorSet();

      CorrelatorSet(carma::util::CorrelatorType corr);

      virtual ~CorrelatorSet();


      void initialize(carma::util::CorrelatorType corr);

      void addCorrelator(carma::util::CorrelatorType corr);

      void removeCorrelator(carma::util::CorrelatorType corr);


      std::string corrTypeString() const;

      CorrelatorType corrType() const;

      std::string mpString() const;
      
      bool isSingleCorrelator() const;
      
      bool isEmpty() const;

      bool isAll() const;

      // Return true if this set represents any of the following
      // single correlators

      bool isSpectral() const;

      bool isWideband() const;

      bool isC3gMax8() const;      

      bool isC3gMax23() const;

      bool isC3g() const; 

      // Return true if this set includes any of the following single
      // correlators

      bool includesSpectral() const;

      bool includesWideband() const;

      bool includesC3gMax8() const;      

      bool includesC3gMax23() const;

      void addSpectral();

      void addWideband();

      void addC3gMax8();

      void addC3gMax23();

      bool includes(const carma::util::CorrelatorType corr) const;

      bool includes(const CorrelatorSet& set) const;


      bool firstCorrelatorIs(carma::util::CorrelatorType corr) const;

      
      unsigned nCorrelator() const;

      
      std::vector<carma::util::CorrelatorType> getControlCorrelatorDesignations() const;

      carma::util::CorrelatorType getControlCorrelatorDesignation() const;

      carma::util::CorrelatorType getFirstControlCorrelatorDesignation() const;

      void operator=(carma::util::CorrelatorType corr);

      bool operator==(carma::util::CorrelatorType corr);

      bool operator==(const CorrelatorSet & set) const; // Strict equality

      // Print operators

      friend std::ostream& operator<<(std::ostream& os, const CorrelatorSet& set);




    private:

      carma::util::CorrelatorType corrSet_;

    }; // End class CorrelatorSet

    std::ostream& operator<<(std::ostream& os, const CorrelatorSet& set);

  } // End namespace util
} // End namespace carma



#endif // End #ifndef CARMA_UTIL_CORRELATORSET_H