RadioComponent.h

/***************************************************************************
 * \file RadioComponent.h
 * \brief Defines the basic component 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_RADIOCOMPONENT_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_RADIOCOMPONENT_H

#include "LibCyberRadio/Driver/Configurable.h"
#include <string>


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

        class RadioComponent : public Configurable
        {
            public:
                RadioComponent(const std::string& name = "<unknown>",
                        int index = 0,
                        RadioHandler* parent = NULL,
                        bool debug = false);
                virtual ~RadioComponent();
                RadioComponent(const RadioComponent& other);
                virtual RadioComponent& operator=(const RadioComponent& other);
                virtual int getIndex() const;
                virtual void setIndex(int index);
                virtual RadioHandler* getParent() const;
                virtual void setParent(RadioHandler* parent);
                virtual bool disable();
                virtual bool enable(bool enabled = true);
                virtual bool isEnabled() const;
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();

            protected:
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();

            protected:
                // Index number of the component
                int _index;
                // Parent radio handler object
                RadioHandler* _parent;
                // Whether or not the component is enabled
                bool _enabled;

        }; // class RadioComponent

    } // namespace Driver

} // namespace LibCyberRadio


#endif // INCLUDED_LIBCYBERRADIO_DRIVER_RADIOCOMPONENT_H