signalMessageHeader.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2009 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: signalMessageHeader.h,v $ $Revision: 1.2 $ $State: Exp $
*******************************************************************************/



#ifndef DtSignalMessageHeader_H_
#define DtSignalMessageHeader_H_

#include <vlpi/netStructs.h>
#include <vlpi/simulationAddress.h>
#include "vrfmsgs/splitMessageHandle.h"

struct DtNetSignalMessageHeader
{
   DtNetU32 myUsingVrfVersionPrefixA;              
   DtNetU16 myUsingVrfVersionPrefixB;              
   DtNetU32 myVrfMessageVersion;                   
   DtNetFederateId myMessageSimulatorId;           
   DtNetU16 myMessageNumber;                       
   DtNetU32 myFullMessageSize;                     
   DtNetU16 mySequenceId;                          
   DtNetU16 myNumberOfChunks;                      
   DtNetU32 mySizeOfThisChunk;                     
   DtNetU32 padding2;                              
};


#include "vrfmsgs/vrfmsgsDefines.h"
class DT_DLL_vrfmsgs DtSignalMessageHeader
{
public:

   DtSignalMessageHeader();

   DtSignalMessageHeader(const DtSignalMessageHeader & orig);

   virtual ~DtSignalMessageHeader();

   const DtSignalMessageHeader & operator=(DtSignalMessageHeader & orig);

public:

   virtual DtSignalMessageHeader * clone() const;

   virtual unsigned fullMessageSize() const;
   virtual void setFullMessageSize(unsigned nSize);

   virtual unsigned messageIdNumber() const;
   virtual void setMessageIdNumber(unsigned sNum);

   virtual const DtSimulationAddress& messageIdSenderAddress() const;
   virtual void setMessageIdSenderAddress(const DtSimulationAddress& simAddr);

   virtual int netRepSize() const;

   virtual unsigned numberOfChunks() const;
   virtual void setNumberOfChunks(unsigned nNum);

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

   virtual bool setToNet(char* networkBuffer) const; 

   virtual unsigned sequenceId() const;
   virtual void setSequenceId(unsigned sSeqId);

   virtual unsigned sizeOfThisChunk() const;
   virtual void setSizeOfThisChunk(unsigned nSize);

   virtual void printDataToString(DtString& str);

public:

   DtU32 vrfMessageVersion() const;
   void setVrfMessageVersion (DtU32 msgver);

protected:
   unsigned myFullMessageSize;
   unsigned myMessageNumber;
   DtSimulationAddress myMessageSimulatorId;
   unsigned myNumberOfChunks;
   unsigned mySequenceId;
   unsigned mySizeOfThisChunk;

   DtU32 myVrfMessageVersionSupported;
   
};

inline unsigned DtSignalMessageHeader::fullMessageSize() const
{
   return (myFullMessageSize);
}

inline void DtSignalMessageHeader::setFullMessageSize(unsigned nSize)
{
   myFullMessageSize = nSize;
}

inline unsigned DtSignalMessageHeader::messageIdNumber() const
{
   return (myMessageNumber);
}

inline void DtSignalMessageHeader::setMessageIdNumber(unsigned sNum)
{
   myMessageNumber = sNum;
}

inline const DtSimulationAddress& DtSignalMessageHeader::messageIdSenderAddress() const
{
   return (myMessageSimulatorId);
}

inline void DtSignalMessageHeader::setMessageIdSenderAddress(const DtSimulationAddress& simAddr)
{
   myMessageSimulatorId = simAddr;
}

inline unsigned DtSignalMessageHeader::numberOfChunks() const
{
   return (myNumberOfChunks);
}

inline void DtSignalMessageHeader::setNumberOfChunks(unsigned nNum)
{
   myNumberOfChunks = nNum;
}   
   
inline unsigned DtSignalMessageHeader::sequenceId() const
{
   return (mySequenceId);
}

inline void DtSignalMessageHeader::setSequenceId(unsigned sSeqId)
{
   mySequenceId = sSeqId;
}

inline unsigned DtSignalMessageHeader::sizeOfThisChunk() const
{
   return (mySizeOfThisChunk);
}

inline void DtSignalMessageHeader::setSizeOfThisChunk(unsigned nSize)
{
   mySizeOfThisChunk = nSize;
}

inline DtU32 DtSignalMessageHeader::vrfMessageVersion() const
{
   return (myVrfMessageVersionSupported);
}

inline void DtSignalMessageHeader::setVrfMessageVersion(DtU32 msgver)
{
   myVrfMessageVersionSupported = msgver;
}

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

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

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

#endif