CWToneGenComponent.h

/***************************************************************************
 * \file CWToneGenComponent.h
 * \brief Defines the basic continuous-wave (CW) tone generator 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_CWTONEGENCOMPONENT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_CWTONEGENCOMPONENT_H

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


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

        class CWToneGenComponent : public RadioComponent
        {
            public:
                CWToneGenComponent(const std::string& name = "CWTONE",
                        int index = 0,
                        RadioHandler* parent = NULL,
                        bool debug = false,
                        int txIndex = 0,
                        double freqRangeMin = 0.0,
                        double freqRangeMax = 0.0,
                        double freqRes = 0.0,
                        double freqUnits = 0.0,
                        double ampRangeMin = 0.0,
                        double ampRangeMax = 0.0,
                        double ampRes = 0.0,
                        double phaseRangeMin = 0.0,
                        double phaseRangeMax = 0.0,
                        double phaseRes = 0.0,
                        double sweepStartRangeMin = 0.0,
                        double sweepStartRangeMax = 0.0,
                        double sweepStartRes = 0.0,
                        double sweepStopRangeMin = 0.0,
                        double sweepStopRangeMax = 0.0,
                        double sweepStopRes = 0.0,
                        double sweepStepRangeMin = 0.0,
                        double sweepStepRangeMax = 0.0,
                        double sweepStepRes = 0.0,
                        double dwellTimeRangeMin = 0.0,
                        double dwellTimeRangeMax = 0.0,
                        double dwellTimeRes = 0.0,
                        double frequency = 0.0,
                        double amplitude = 0.0,
                        double phase = 0.0,
                        double sweepStart = 0.0,
                        double sweepStop = 0.0,
                        double sweepStep = 0.0,
                        double dwellTime = 0.0
                );
                virtual ~CWToneGenComponent();
                CWToneGenComponent(const CWToneGenComponent& other);
                virtual CWToneGenComponent& operator=(const CWToneGenComponent& other);
                // RadioComponent interface
                virtual bool enable(bool enabled = true);
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();
                // CWToneGenComponent extensions
                virtual BasicDoubleList getFrequencyRange() const;
                virtual double getFrequencyRes() const;
                virtual BasicDoubleList getAmplitudeRange() const;
                virtual double getAmplitudeRes() const;
                virtual BasicDoubleList getPhaseRange() const;
                virtual double getPhaseRes() const;
                virtual BasicDoubleList getSweepStartRange() const;
                virtual double getSweepStartRes() const;
                virtual BasicDoubleList getSweepStopRange() const;
                virtual double getSweepStopRes() const;
                virtual BasicDoubleList getSweepStepRange() const;
                virtual double getSweepStepRes() const;
                virtual BasicDoubleList getDwellTimeRange() const;
                virtual double getDwellTimeRes() const;
                virtual double getFrequency() const;
                virtual bool setFrequency(double freq);
                virtual double getAmplitude() const;
                virtual bool setAmplitude(double amp);
                virtual double getPhase() const;
                virtual bool setPhase(double phase);
                virtual bool supportsSweep() const;
                virtual double getSweepStartFrequency() const;
                virtual double getSweepStopFrequency() const;
                virtual double getSweepFrequencyStep() const;
                virtual double getSweepDwellTime() const;
                virtual bool setFrequencySweep(double start, double stop, double step, double dwell);

            protected:
                // RadioComponent interface
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();
                // CWToneGenComponent extensions
                virtual bool executeToneQuery(int index,
                        int txIndex,
                        double& freq,
                        double& amp,
                        double& phase);
                virtual bool executeToneCommand(int index,
                        int txIndex,
                        double& freq,
                        double& amp,
                        double& phase);
                virtual bool executeSweepQuery(int index,
                        int txIndex,
                        double& sweepStart,
                        double& sweepStop,
                        double& sweepStep,
                        double& dwellTime);
                virtual bool executeSweepCommand(int index,
                        int txIndex,
                        double& sweepStart,
                        double& sweepStop,
                        double& sweepStep,
                        double& dwellTime);

            protected:
                // Transmitter index
                int _txIndex;
                // Min frequency
                double _freqRangeMin;
                // Max frequency
                double _freqRangeMax;
                // Frequency resolution
                double _freqRes;
                // Frequency units
                double _freqUnits;
                // Min amplitude
                double _ampRangeMin;
                // Max amplitude
                double _ampRangeMax;
                // Amplitude resolution
                double _ampRes;
                // Min phase
                double _phaseRangeMin;
                // Max phase
                double _phaseRangeMax;
                // Phase resolution
                double _phaseRes;
                // Min sweep start
                double _sweepStartRangeMin;
                // Max sweep start
                double _sweepStartRangeMax;
                // Sweep start resolution
                double _sweepStartRes;
                // Min sweep stop
                double _sweepStopRangeMin;
                // Max sweep stop
                double _sweepStopRangeMax;
                // Sweep stop resolution
                double _sweepStopRes;
                // Min sweep step
                double _sweepStepRangeMin;
                // Max sweep step
                double _sweepStepRangeMax;
                // Sweep step resolution
                double _sweepStepRes;
                // Min dwell time
                double _dwellTimeRangeMin;
                // Max dwell time
                double _dwellTimeRangeMax;
                // Dwell time resolution
                double _dwellTimeRes;
                // Constant frequency (Hz)
                double _frequency;
                // Amplitude (scale units)
                double _amplitude;
                // Phase (degrees)
                double _phase;
                // Frequency sweep start (Hz)
                double _sweepStart;
                // Frequency sweep stop (Hz)
                double _sweepStop;
                // Frequency sweep step (Hz)
                double _sweepStep;
                // Dwell time (ADC samples)
                double _dwellTime;

        }; // class CWToneGenComponent

        typedef BASIC_DICT_CONTAINER<int, CWToneGenComponent*> CWToneGenComponentDict;

    } // namespace Driver

} // namespace LibCyberRadio


#endif // INCLUDED_LIBCYBERRADIO_DRIVER_CWTONEGENCOMPONENT_H