vrfObjectMessage.h

Go to the documentation of this file.

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



#pragma once

#include "vrfmsgs/simMessage.h"
#include "vrfmsgs/vrfObjectMessageFactory.h"
#include <vlutil/vlNetTypes.h>
#include "vrfmsgs/vrfmsgsDefines.h"
#include <vlutil/vlSmartPointers.h>
#include <vrfutil/rwUUID.h>

const char DtVrfObjectMessageSendToAll[] = "DtBroadcast";
const char DtVrfObjectMessageFrontEndAddress[] = "DtVrfFrontEnd";

class DT_DLL_vrfmsgs DtVrfObjectMessage : public DtSimMessage
{

public:

   DtVrfObjectMessage();

   DtVrfObjectMessage(const DtVrfObjectMessage& orig);

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

   virtual ~DtVrfObjectMessage();

   virtual int messageType() const;

   virtual int contentCategoryType() const = 0;

   virtual int radioMessageType() const;

   //virtual DtString contentType() const = 0;


   virtual void setReceiver(const DtUUID& receiver);
   virtual const DtUUID& receiver() const; 

   virtual void setRecipient(const DtUUID& receiver) { setReceiver(receiver); };
   virtual const DtUUID& recipient() const { return receiver(); };


   virtual void setTransmitter(const DtUUID& transmitter);
   virtual const DtUUID& transmitter() const; 

   virtual void setSender(const DtUUID& transmitter) { setTransmitter(transmitter); };
   virtual const DtUUID& sender() const { return transmitter(); };

   virtual char* netRep();

   virtual int netRepSize() const;

   virtual bool setFromNet(const char* networkBuffer, 
      unsigned contentSize);


   virtual bool setToNet(); 

   virtual void printDataToString(DtString& str);

   static DtVrfObjectMessage* createVrfObjectMessage(int type);
   static DtVrfObjectMessage* createRadioMessage(int type);

   static void addVrfObjectMessageCreatorFcn(int type, 
      DtVrfObjectMessageCreatorFcn fcn);
   static void addRadioMessageCreatorFcn(int type, 
      DtVrfObjectMessageCreatorFcn fcn);

   static void setFactory(DtVrfObjectMessageFactory* factory);

   static DtVrfObjectMessageFactory* factory();

   virtual int scenarioRunId() const;
   virtual void setScenarioRunId(int);

protected:
   virtual char* createNetworkBuffer();

protected:
   DtUUID myTransmitter;
   DtUUID myReceiver;
   char*    myNetRep;
   int myScenarioRunId;

   static DtVrfObjectMessageFactory*  myFactory;

};

namespace DtBufferSerialize
{
   DT_DLL_vrfmsgs int getSize(const DtVrfObjectMessage* const&  messagePtr);

   DT_DLL_vrfmsgs char *encode(const DtVrfObjectMessage* const& messagePtr, char *buffer);

   DT_DLL_vrfmsgs const char *decode(DtVrfObjectMessage*& messagePtr, const char *buffer);
}

typedef DtBoost::shared_ptr<const DtVrfObjectMessage> DtVrfObjectMessageConstPtr;
typedef DtBoost::shared_ptr<DtVrfObjectMessage> DtVrfObjectMessagePtr;