vrfRadio.h

Go to the documentation of this file.

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



#pragma once

#include "tdbutil/stringKeyFactory.h"
#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfmsgs/vrfObjectMessageExecutive.h"
#include "vrfmsgs/vrfObjectMessage.h"
#include <deque>

class DtLocalObject;
class DtVrfRadio;
class DtVrfRadioDescriptor;
class DtVrfObjectMessageExecutive;
class DtCommModel;
class DtVrfRadioTransmitter;
class DtSettingsObject;

struct DtRadioCreationParams
{
   DtLocalObject* vrfObject;
   const DtVrfRadioDescriptor* radioDescriptor;
};

typedef DtStringKeyFactoryWithParam<DtVrfRadio, DtRadioCreationParams&> DtVrfRadioFactory;

class DT_DLL_vrfobjcore DtVrfRadio
{
private:

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

public:
   DtVrfRadio(DtRadioCreationParams& params);
   virtual ~DtVrfRadio();

   virtual bool init();

   virtual DtString type() const;

   virtual bool sendMessage(DtVrfObjectMessage* message);


   virtual void addMessageCallback(DtVrfObjectMessageCallbackFcn fcn, void* usr);
   virtual void removeMessageCallback(DtVrfObjectMessageCallbackFcn fcn, void* usr);

   template<typename messageType>
   void addMessageCallback(const messageType& type, DtVrfObjectMessageCallbackFcn fcn, void* usr)
   {
      myMessageExecutive.addMessageCallback(type, fcn, usr);
   }

   template<typename messageType>
   void removeMessageCallback(const messageType& type, DtVrfObjectMessageCallbackFcn fcn, void* usr)
   {
      myMessageExecutive.addMessageCallback(type, fcn, usr);
   }

   virtual bool readyToSend() const;

   virtual void tick();

   virtual void receiveMessage(const DtVrfObjectMessage* message);

   virtual void setReadyToSend(bool val);

   virtual DtLocalObject* vrfObject();

   virtual double sampleRate() const;


   virtual const DtVrfRadioTransmitter* radioTransmitter() const;
   virtual DtVrfRadioTransmitter* radioTransmitter();

   static DtVrfRadio* create(DtRadioCreationParams& params);

   static void setFactory(DtVrfRadioFactory* factory);
   static DtVrfRadio* createRadio(const DtString& typeString, DtLocalObject* vrfObject,
      const DtVrfRadioDescriptor* descriptor);

   static void readCommModelSettingsCallback(
      const DtSettingsObject* settings, void* usr);
   virtual void processReadCommModelSettings(const DtSettingsObject* settings);

   virtual int radioId() const;

protected:
   static DtVrfRadioFactory* theFactory;

   DtLocalObject* myVrfObject;
   const DtVrfRadioDescriptor& myRadioDescriptor;
   DtVrfObjectMessageExecutive myMessageExecutive;
   DtCommModel* myCommModel;
   DtVrfRadioTransmitter* myRadioTransmitter;
   bool myReadyToSend;
   typedef std::deque<DtVrfObjectMessagePtr> DtMessageQueue;
   DtMessageQueue myMessageQueuedToSend;
};