NbddcComponent.h

/***************************************************************************
 * \file NbddcComponent.h
 * \brief Defines the basic NBDDC 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_NBDDCCOMPONENT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_NBDDCCOMPONENT_H

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


namespace LibCyberRadio
{
    namespace Driver
    {
        typedef BASIC_DICT_CONTAINER<int, double> NbddcRateSet;

        class NbddcComponent : public RadioComponent
        {
            public:
                NbddcComponent(const std::string& name = "NBDDC",
                        int index = 1,
                        RadioHandler* parent = NULL,
                        bool debug = false,
                        bool nbddcCommandSetsFreq = false,
                        bool nbddcCommandSetsSource = false,
                        bool selectableDataPort = false,
                        double freqRangeMin = 0.0,
                        double freqRangeMax = 0.0,
                        double freqRes = 1.0,
                        double freqUnits = 1.0,
                        int source = 1,
                        int dataPort = 1,
                        double frequency = 0.0,
                        int rateIndex = 0,
                        int udpDestination = 0,
                        int vitaEnable = 0,
                        unsigned int streamId = 0);
                virtual ~NbddcComponent();
                NbddcComponent(const NbddcComponent& other);
                virtual NbddcComponent& operator=(const NbddcComponent& other);
                virtual bool enable(bool enabled = true);
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();
                // NbddcComponent extensions
                virtual double getFrequency() const;
                virtual bool setFrequency(double freq);
                virtual BasicDoubleList getFrequencyRange() const;
                virtual double getFrequencyRes() const;
                virtual double getFrequencyUnit() const;
                virtual int getSource() const;
                virtual bool setSource(int source);
                virtual int getRateIndex() const;
                virtual bool setRateIndex(int index);
                virtual int getUdpDestination() const;
                virtual bool setUdpDestination(int dest);
                virtual int getVitaEnable() const;
                virtual bool setVitaEnable(int enable);
                virtual unsigned int getStreamId() const;
                virtual bool setStreamId(unsigned int sid);
                virtual int getDataPort() const;
                virtual bool setDataPort(int port);
                virtual NbddcRateSet getRateSet() const;
                virtual bool setRateSet(const NbddcRateSet& set);
                virtual BasicDoubleList getRateList() const;

            protected:
                // RadioComponent interface
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();
                // NbddcComponent extensions
                virtual bool executeNbddcQuery(int index,
                        int& rateIndex,
                        int& udpDestination,
                        bool& enabled,
                        int& vitaEnable,
                        unsigned int& streamId,
                        double& frequency,
                        int& source);
                virtual bool executeNbddcCommand(int index,
                        int& rateIndex,
                        int& udpDestination,
                        bool& enabled,
                        int& vitaEnable,
                        unsigned int& streamId,
                        double& frequency,
                        int& source);
                virtual bool executeFreqQuery(int index, double& freq);
                virtual bool executeFreqCommand(int index, double& freq);
                virtual bool executeSourceQuery(int index, int& source);
                virtual bool executeSourceCommand(int index, int& source);
                virtual bool executeDataPortQuery(int index, int& dataPort);
                virtual bool executeDataPortCommand(int index, int& dataPort);

            protected:
                // Whether or not the NBDDC config command sets its frequency
                bool _nbddcCommandSetsFreq;
                // Whether or not the NBDDC config command sets its source
                bool _nbddcCommandSetsSource;
                // Whether or not radio uses data ports
                bool _selectableDataPort;
                // Minimum tunable frequency (Hz)
                double _freqRangeMin;
                // Maximum tunable frequency (Hz)
                double _freqRangeMax;
                // Frequency resolution (Hz)
                double _freqRes;
                // Frequency units (Hz)
                double _freqUnits;
                // Source
                int _source;
                // Data port
                int _dataPort;
                // Tuned frequency
                double _frequency;
                // Rate index
                int _rateIndex;
                // UDP destination
                int _udpDestination;
                // VITA 49 framing setting
                int _vitaEnable;
                // VITA 49 stream ID
                unsigned int _streamId;
                // Rate set
                NbddcRateSet _rateSet;

        }; // class NbddcComponent

        typedef BASIC_DICT_CONTAINER<int, NbddcComponent*> NbddcComponentDict;

    } // namespace Driver

} // namespace LibCyberRadio


#endif // INCLUDED_LIBCYBERRADIO_DRIVER_NBDDCCOMPONENT_H