Blackboard.h

// -*- mode:c++ -*-
// Copyright (C) 2005 Andras Varga
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
//


#ifndef BLACKBOARD_H
#define BLACKBOARD_H

#ifdef _MSC_VER
#pragma warning(disable : 4786)
#endif

#include <omnetpp.h>
#include <vector>
#include <string>
#include "ModuleAccess.h"

class ImNotifiable;
class BBItem;


class Blackboard : public cSimpleModule
{
  protected:
    bool coreDebug;

    class Subscriber 
    {
    public:
        ImNotifiable *client;
        int scopeModuleId;
    public:
        Subscriber(ImNotifiable *c=0, int b=-1) :
            client(c), scopeModuleId(b) {};
    };
    

    typedef std::vector<Subscriber> SubscriberVector;
    typedef std::vector<SubscriberVector> ClientVector;
    
    typedef std::vector<const char* > CategoryDescriptions;

    typedef std::vector<int> ParentVector;
    
    typedef ClientVector::iterator ClientVectorIter;
    typedef CategoryDescriptions::iterator DescriptionsIter;
    typedef ParentVector::iterator ParentVectorIter;
    
    ClientVector clientVector;
    CategoryDescriptions categoryDescriptions;
    ParentVector parentVector;
    
    int nextCategory;
    
    friend std::ostream& operator<<(std::ostream&, const SubscriberVector&);

 protected:
    const char* categoryName(int category);
    int findAndCreateDescription(bool *isNewEntry, const BBItem *category);

    void fillParentVector(const BBItem *category, int cat);
    
 public:
    Module_Class_Members(Blackboard, cSimpleModule, 0);
    virtual ~Blackboard();

    virtual void initialize();

    virtual void handleMessage(cMessage *msg);

    int subscribe(ImNotifiable *client, const BBItem *category, int scopeModuleId=-1);
    int subscribe(ImNotifiable *client, int category, int scopeModuleId=-1);
    void unsubscribe(ImNotifiable *client, int category);

    void publishBBItem(int category, const BBItem* details, int scopeModuleId);

    int  getCategory(const BBItem* details);
};

class  ImNotifiable
{
  public:
    virtual void receiveBBItem(int category, const BBItem *details, int scopeModuleId) = 0;

    virtual ~ImNotifiable() { }
};

class  BlackboardAccess : public ModuleAccess<Blackboard>
{
    public:
        BlackboardAccess() : ModuleAccess<Blackboard>("blackboard") {}
};

class  BBItem : public cPolymorphic
{
 public:
    virtual BBItem *parentObject() const {
        return new BBItem();
    }
};

#define BBITEM_METAINFO(BASECLASS) \
    public: \
      virtual BBItem* parentObject() const { \
      return new BASECLASS(); } 
      
#endif

---