aMessenger.h

Go to the documentation of this file.

/*
 *  File:       aMessenger.h
 *  Package:    akCore
 *
 *  Created on: February 06, 2020
 *  Author: Alexander Kuester
 *  Copyright (c) 2022 Alexander Kuester
 *  This file is part of the uiCore component.
 *  This file is subject to the terms and conditions defined in
 *  file 'LICENSE', which is part of this source code package.
 */
 
#pragma once
 
// C++ header
#include <map>                      // Map ids and message types
#include <vector>                   // Notifiers collection in the map
#include <mutex>
 
// AK header
#include <akCore/globalDataTypes.h>     // UID and ID type
#include <akCore/akCore.h>              // eventType
 
namespace ak {
 
    // Forward declaration
    class aNotifier;
    class aUidManager;
 
    class UICORE_API_EXPORT aMessenger {
    public:
 
        aMessenger();
 
        virtual ~aMessenger();
 
        // ####################################################################################################
        // Data exchange
 
        void sendMessage(
            UID                         _senderId,
            eventType                   _event,
            int                         _info1 = 0,
            int                         _info2 = 0
        );
 
        // Data exchange
        // ####################################################################################################
        // Sender/receiver organisation
 
        void registerUidReceiver(
            UID                         _senderId,
            aNotifier *                 _notifier
        );
 
        void registerEventTypeReceiver(
            eventType                   _eventType,
            aNotifier *                 _notifier
        );
 
        void registerNotifierForAllMessages(
            aNotifier *                 _notifier
        );
 
        int uidNotifierCount(
            UID                         _senderUID
        );
 
        int eventNotifierCount(
            eventType                   _event
        );
 
        // ####################################################################################################
 
        void clearAll(void);
 
        void enable(void) { m_isEnabled = true; }
 
        void disable(void) { m_isEnabled = false; }
 
        void setEnabled(
            bool                        _enabled
        ) { m_isEnabled = _enabled; }
 
        bool isEnabled(void) const { return m_isEnabled; }
 
    private:
 
        aUidManager *                                   m_uidManager;                       
 
        bool                                            m_isEnabled;                        
 
        std::map<UID, std::vector<aNotifier *> * >      m_uidReceivers;                 
        std::map<eventType, std::vector<aNotifier *> *> m_eventReceivers;                   
 
        std::vector<aNotifier *>                        m_allMessageReceivers;
 
        // Block copy constructor
        aMessenger(aMessenger & other) = delete;
 
        // Block assignment operator
        aMessenger & operator = (aMessenger & other) = delete;
 
    };
}