NbddcGroupComponent.h

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

#ifndef INCLUDED_LIBCYBERRADIO_DRIVER_NBDDCCOMPONENTGROUP_H
#define INCLUDED_LIBCYBERRADIO_DRIVER_NBDDCCOMPONENTGROUP_H

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


namespace LibCyberRadio
{
    namespace Driver
    {

        class NbddcGroupComponent : public RadioComponent
        {
            public:
                NbddcGroupComponent(const std::string& name = "NBG",
                                    int index = 1,
                                    RadioHandler* parent = NULL,
                                    bool debug = false,
                                    int numGroupMembers = 0,
                                    int groupMemberIndexBase = 1);
                virtual ~NbddcGroupComponent();
                NbddcGroupComponent(const NbddcGroupComponent& other);
                virtual NbddcGroupComponent& operator=(const NbddcGroupComponent& other);
                // RadioComponent interface
                virtual bool enable(bool enabled = true);
                virtual bool setConfiguration(ConfigurationDict& cfg);
                virtual void queryConfiguration();
                // NbddcGroupComponent extensions
                virtual BasicIntList getMembers() const;
                virtual bool setMembers(const BasicIntList& groupMembers);
                virtual bool addMember(int member);
                virtual bool removeMember(int member);


            protected:
                // RadioComponent interface
                virtual void initConfigurationDict();
                virtual void updateConfigurationDict();
                // NbddcGroupComponent extensions
                virtual std::string getMembersString();
                virtual bool executeNbddcGroupEnableQuery(int index,
                                                          bool& enabled);
                virtual bool executeNbddcGroupEnableCommand(int index,
                                                            bool& enabled);
                virtual bool executeNbddcGroupQuery(int index,
                                                    BasicIntList& groupMembers);
                virtual bool executeNbddcGroupCommand(int index,
                                                      BasicIntList& groupMembers);
                virtual bool executeNbddcGroupMemberQuery(int index, int groupMember,
                                                          bool& isMember);
                virtual bool executeNbddcGroupMemberCommand(int index, int groupMember,
                                                            bool& isMember);

            protected:
                // Number of potential members in this group
                int _numGroupMembers;
                // Index that group members start with
                int _groupMemberIndexBase;
                // Group members
                BasicIntList _groupMembers;

        }; // class NbddcGroupComponent

        typedef BASIC_DICT_CONTAINER<int, NbddcGroupComponent*> NbddcGroupComponentDict;

    } // namespace Driver

} // namespace LibCyberRadio

#endif /* INCLUDED_LIBCYBERRADIO_DRIVER_NBDDCCOMPONENTGROUP_H */