TunerComponent.h

/***************************************************************************
 * \file TunerComponent.h
 * \brief Defines the basic tuner interface for an NDR-class radio.
 * \author DA
 * \author NH
 * \author MN
 * \copyright (c) 2017 CyberRadio Solutions, Inc.  All rights reserved.
 *
 ***************************************************************************/

#ifndef INCLUDED_LIBCYBERRADIO_DRIVER_TUNERCOMPONENT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_TUNERCOMPONENT_H

#include "LibCyberRadio/Driver/RadioComponent.h"
#include "LibCyberRadio/Common/BasicList.h"
#include <string>


namespace LibCyberRadio
{
    namespace Driver
    {
        // Forward declaration for RadioHandler
        class RadioHandler;

        class TunerComponent : public RadioComponent
        {
            public:
                TunerComponent(const std::string& name = "TUNER",
                        int index = 1,
                        RadioHandler* parent = NULL,
                        bool debug = false,
                        double freqRangeMin = 20e6,
                        double freqRangeMax = 6000e6,
                        double freqRes = 1e6,
                        double freqUnits = 1e6,
                        double attRangeMin = 0.0,
                        double attRangeMax = 30.0,
                        double attRes = 1.0,
                        bool agc = false,
                        double frequency = 800e6,
                        double attenuation = 0.0,
                        int filter = 0);
                virtual ~TunerComponent();
                TunerComponent(const TunerComponent& other);
                virtual TunerComponent& operator=(const TunerComponent& other);
                // RadioComponent interface
                virtual bool enable(bool enabled = true);
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();
                // TunerComponent extensions
                virtual double getFrequency() const;
                virtual bool setFrequency(double freq);
                virtual double getAttenuation() const;
                virtual bool setAttenuation(double atten);
                virtual int getFilter() const;
                virtual bool setFilter(int filter);
                virtual int getTimingAdjustment() const;
                virtual bool setTimingAdjustment(int timingAdj);
                virtual BasicDoubleList getFrequencyRange() const;
                virtual double getFrequencyRes() const;
                virtual double getFrequencyUnit() const;
                virtual BasicDoubleList getAttenuationRange() const;
                virtual double getAttenuationRes() const;
                virtual bool isAgcSupported() const;
                virtual bool setFrequencyRangeMax(double freq);

            protected:
                // RadioComponent interface
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();
                // TunerComponent extensions
                virtual bool executeEnableQuery(int index, bool& enabled);
                virtual bool executeFreqQuery(int index, double& freq);
                virtual bool executeAttenQuery(int index, double& atten);
                virtual bool executeFilterQuery(int index, int& filter);
                virtual bool executeTimingAdjustmentQuery(int index, int& timingAdj);
                virtual bool executeEnableCommand(int index, bool& enabled);
                virtual bool executeFreqCommand(int index, double& freq);
                virtual bool executeAttenCommand(int index, double& atten);
                virtual bool executeFilterCommand(int index, int& filter);
                virtual bool executeTimingAdjustmentCommand(int index, int& timingAdj);

            protected:
                // Minimum tunable frequency (Hz)
                double _freqRangeMin;
                // Maximum tunable frequency (Hz)
                double _freqRangeMax;
                // Frequency resolution (Hz)
                double _freqRes;
                // Frequency units (Hz)
                double _freqUnits;
                // Minimum attenuation (dB)
                double _attRangeMin;
                // Maximum attenuation (dB)
                double _attRangeMax;
                // Attenuation resolution
                double _attRes;
                // Whether or not WBDDC supports AGC
                bool _agc;
                // Tuned frequency
                double _frequency;
                // Attenuation
                double _attenuation;
                // Filter setting
                int _filter;
                // Timing adjustment
                int _timingAdj;

        }; // class TunerComponent

        typedef BASIC_DICT_CONTAINER<int, TunerComponent*> TunerComponentDict;

    } // namespace Driver

} // namespace LibCyberRadio


#endif // INCLUDED_LIBCYBERRADIO_DRIVER_TUNERCOMPONENT_H