signalEvent.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2016 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
#pragma once

#include "vrfMsgTransport/vrfMsgTransportDefines.h"
#include "vrfMsgTransport/event.h"
#include "vlpi/entityIdentifier.h"
#include <vlpi/disEnums.h>
#include <vlpi/simulationAddress.h>
#include <vrfutil/rwUUID.h>

const DtUserProtocol DtVrForcesSignalUserProtocol = (DtUserProtocol) 11050;

namespace makVrfEvents
{
   class DT_DLL_vrfMsgTransport DtSignalEvent : public DtEvent
   {
   public:
      DtSignalEvent();
      DtSignalEvent(int length, char* buffer);
      DtSignalEvent(const DtSignalEvent&);
      DtSignalEvent& operator=(const DtSignalEvent&);

      virtual ~DtSignalEvent();

      void setSimulationAddress(const DtSimulationAddress&);
      const DtSimulationAddress& simulationAddress() const;

      void setEncodingClass(int);
      int encodingClass() const;

      void setEncodingType(int);
      int encodingType() const;

      void setNumSamples(int);
      int numSamples() const;

      void setProtocolId(int);
      int protocolId() const;

      void setRadioIndex(unsigned long long);
      unsigned long long radioIndex() const;

      void setEntityId(const DtUUID&);
      const DtUUID& entityId() const;

      void setSampleRate(double);
      double sampleRate() const;

      void setCommModelName(const DtString&);
      const DtString& commModelName() const;
      
      void setMessageVersion(int);
      int messageVersion() const;

      void setStreamTag(unsigned long long tag);
      void setStreamTag(unsigned int, unsigned int);
      void getStreamTag(unsigned int&, unsigned int&) const;
      unsigned long long streamTag() const;

      void setData(int len, const char* data);
      int dataLength() const;
      const char* data() const;

      void setUserData(int len, const char* data);
      char* allocateUserData(int len);
      int userDataLength() const;
      const char* userData() const;

      char* detach();

      void allocateMemory(int size);
      void setDataAtPosition(int pos, int sizeOfData, const char* data);

      void printData() const;

      virtual DtEvent* clone() const { return new DtSignalEvent(*this); };

   protected:
      int myEncodingClass;
      DtUUID myEntityId;
      DtString myCommModelName;
      double mySampleRate;
      int myProtocolId;
      unsigned long long myRadioIndex;
      int myMessageVersion;
      DtSimulationAddress mySimulationAddress;

      int myDataLen;
      char* myData;
      unsigned int myStreamTagUpper;
      unsigned int myStreamTagLower;
      int myNumSamples;
      int myEncodingType;

      int myUserDataLen;
      char* myUserData;
   };
}