commModel.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2019 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/



#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfutil/rwUUID.h"
#include <vlpi/entityIdentifier.h>
#include "tdbutil/stringKeyFactory.h"
#include <map>
#include <tbb/spin_rw_mutex.h>

class DtSimulationServices;
class DtCommModel;
class DtCommModelDescriptor;
class DtVrfRadio;
class DtVrfObjectMessage;

struct DtCommModelCreationParams
{
   DtSimulationServices* simulationServices;
   const DtCommModelDescriptor* commModelDescriptor;
};

typedef DtStringKeyFactoryWithParam<DtCommModel, DtCommModelCreationParams&> DtCommModelFactory;

typedef DtCommModelFactory::DtCreatorFcn DtCommModelCreatorFcn;

const int DtRadioIdAny = -1;

class DT_DLL_vrfobjcore DtCommModel
{
private:

   DtCommModel();
   DtCommModel(const DtCommModel& orig);
   DtCommModel& operator=(const DtCommModel& orig);

protected:
   DtCommModel(DtCommModelCreationParams& params);
   virtual bool init();

public:
   static DtCommModel* create(DtCommModelCreationParams& params);

   virtual ~DtCommModel();

   virtual DtString type() const;

   virtual void registerRadio(DtVrfRadio* radio);
   virtual void unregisterRadio(DtVrfRadio* radio);

   virtual void sendMessage(DtVrfObjectMessage* message, DtVrfRadio* sendingRadio);

   virtual void tick();

   static void setFactory(DtCommModelFactory* factory);
   static DtCommModel* createCommModel(const DtString& typeString, 
      DtSimulationServices* simManager, const DtCommModelDescriptor* descriptor);
   
   virtual bool publishTransmitters() const;

   virtual bool sendReceivedCommMessageOnBroadcast() const;

   virtual void clearPendingRadioMessages();

protected:
   virtual DtVrfRadio* findRadio(const DtUUID& object, int radioId) const;

   virtual DtVrfRadio* findRadio(const DtEntityIdentifier& entityId, int radioId) const;

   virtual void deliverMessageToRecipients(const DtVrfObjectMessage* message);

protected:
   static DtCommModelFactory* theFactory;

   DtSimulationServices* mySimulationServices;
   const DtCommModelDescriptor* myDescriptor;

   typedef std::multimap<DtUUID, DtVrfRadio*> DtRadioMap;
   DtRadioMap myRadios;
   mutable tbb::spin_rw_mutex myMutex;
};