TransmitterComponent.h

/***************************************************************************
 * \file TransmitterComponent.h
 * \brief Defines the basic transmitter 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_TRANSMITTERCOMPONENT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_TRANSMITTERCOMPONENT_H

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


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

        class TransmitterComponent : public RadioComponent
        {
            public:
                TransmitterComponent(const std::string& name = "TX",
                        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 = 10.0,
                        double attRes = 1.0,
                        int numToneGen = 0,
                        int toneGenIndexBase = 1,
                        double frequency = 900e6,
                        double attenuation = 0.0);
                virtual ~TransmitterComponent();
                TransmitterComponent(const TransmitterComponent& other);
                virtual TransmitterComponent& operator=(const TransmitterComponent& other);
                // RadioComponent interface
                virtual bool enable(bool enabled = true);
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();
                // TransmitterComponent extensions
                virtual double getFrequency() const;
                virtual bool setFrequency(double freq);
                virtual double getAttenuation() const;
                virtual bool setAttenuation(double atten);
                virtual BasicDoubleList getFrequencyRange() const;
                virtual double getFrequencyRes() const;
                virtual double getFrequencyUnit() const;
                virtual BasicDoubleList getAttenuationRange() const;
                virtual double getAttenuationRes() const;
                virtual bool supportsCW() const;
                virtual int getCWNum() const;
                virtual BasicIntList getCWIndexRange() const;
                virtual BasicDoubleList getCWFrequencyRange() const;
                virtual double getCWFrequencyRes() const;
                virtual BasicDoubleList getCWAmplitudeRange() const;
                virtual double getCWAmplitudeRes() const;
                virtual BasicDoubleList getCWPhaseRange() const;
                virtual double getCWPhaseRes() const;
                virtual bool supportsCWSweep() const;
                virtual BasicDoubleList getCWSweepStartRange() const;
                virtual double getCWSweepStartRes() const;
                virtual BasicDoubleList getCWSweepStopRange() const;
                virtual double getCWSweepStopRes() const;
                virtual BasicDoubleList getCWSweepStepRange() const;
                virtual double getCWSweepStepRes() const;
                virtual BasicDoubleList getCWSweepDwellRange() const;
                virtual double getCWSweepDwellRes() const;
                virtual bool enableCW(int index, bool enabled = true);
                virtual bool disableCW(int index);
                virtual ConfigurationDict getCWConfiguration(int index) const;
                virtual bool setCWConfiguration(int index, ConfigurationDict& cfg);
                virtual double getCWFrequency(int index) const;
                virtual bool setCWFrequency(int index, double freq);
                virtual double getCWAmplitude(int index) const;
                virtual bool setCWAmplitude(int index, double amp);
                virtual double getCWPhase(int index) const;
                virtual bool setCWPhase(int index, double phase);
                virtual bool supportsCWSweep(int index) const;
                virtual double getCWSweepStartFrequency(int index) const;
                virtual double getCWSweepStopFrequency(int index) const;
                virtual double getCWSweepFrequencyStep(int index) const;
                virtual double getCWSweepDwellTime(int index) const;
                virtual bool setCWFrequencySweep(int index, double start, double stop,
                        double step, double dwell);

            protected:
                // RadioComponent interface
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();
                // TransmitterComponent extensions
                virtual bool executeEnableQuery(int index, bool& enabled);
                virtual bool executeFreqQuery(int index, double& freq);
                virtual bool executeAttenQuery(int index, double& atten);
                virtual bool executeEnableCommand(int index, bool& enabled);
                virtual bool executeFreqCommand(int index, double& freq);
                virtual bool executeAttenCommand(int index, double& atten);

            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;
                // Number of CW tone generators associated with this transmitter
                int _numToneGen;
                // Number that tone generator indicates start at
                int _toneGenIndexBase;
                // Tuned frequency
                double _frequency;
                // Attenuation
                double _attenuation;
                // Tone generator dictionary
                CWToneGenComponentDict _cwToneGens;

        }; // class TransmitterComponent

        typedef BASIC_DICT_CONTAINER<int, TransmitterComponent*> TransmitterComponentDict;

    } // namespace Driver

} // namespace LibCyberRadio


#endif // INCLUDED_LIBCYBERRADIO_DRIVER_TRANSMITTERCOMPONENT_H