pdu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1992-2010 VT MAK
** All rights reserved.
*********************************************************************/
#pragma once




#include <stdlib.h>
#include "packets/pduHeader.h"
#include <vlpi/disEnums.h>
#include <vlutil/vlTimeStampType.h>
#include <vlutil/vlBaseMsg.h>


#define DtSTATUS_OK     0
#define DtSTATUS_NOT_OK 1 

extern DT_DLL_VL int DtProtocolVersionToSend;
extern DT_DLL_VL int DtProtocolVersionToRecvMin;
extern DT_DLL_VL int DtProtocolVersionToRecvMax;

class DT_DLL_VL DtPdu : public DtBaseMsg
{
public:

   virtual ~DtPdu();

   DtPdu(const DtPdu &pdu, 
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtPdu &operator=(const DtPdu &pdu);

   virtual void* packet() const; 
   
   virtual int status() const;

   virtual void setVersion(int vers);
   virtual int protocolVersion() const;
 
   virtual void setExerciseId(int id);
   virtual int exerciseId() const;

   virtual DtPduKind kind() const;

   virtual DtProtocolFamily protocolFamily() const;
   
   virtual void setTimeStamp(DtTime time, 
      DtTimeStampType type = DtTimeStampRelative);
   
   virtual DtTime timeStamp() const;    

   virtual DtTimeStampType timeStampType() const;

   virtual DtTime guessTimeValid(DtTime referenceTime) const;

   virtual DtNetPduHeader* netHeader() const;

   virtual void print() const; 

   virtual void printToStream(std::ostream& stream) const;

   virtual void printHeader() const;

   virtual void printHeaderToStream(std::ostream& stream) const;

   
   virtual void printData() const;
   virtual void printDataToStream(std::ostream& stream) const;
   virtual void printDataToString(DtString& str) const;

protected:

   DtPdu();

   virtual void setStatus(int okStatus);  

   virtual void initPdu(int size, DtBufferPtr buffer);

   virtual void initPdu(const void* initial, DtBufferPtr buffer);

   virtual DtPduKind internalGetPduKind() const = 0;

   virtual DtProtocolFamily kindToFamily(DtPduKind kind) const;

   virtual void sizeChanged(int size);

   virtual void clearData();

   virtual void initHeader(DtPduKind kind, int size);

protected:

   int myOKStatus;
};

#define netPdu packet()

inline DtNetPduHeader* DtPdu::netHeader() const
{
   return (DtNetPduHeader*) netRep();
}
 
inline void* DtPdu::packet() const
{
   return (void*) netRep();
}

inline int DtPdu::protocolVersion() const 
{
   return netHeader()->version;
}

inline int DtPdu::exerciseId() const 
{
   return netHeader()->DtExercise;
}

inline DtPduKind DtPdu::kind() const 
{   return DtPduKind(netHeader()->DtKind);
}

inline DtProtocolFamily DtPdu::protocolFamily() const 
{
   return DtProtocolFamily(netHeader()->family);
}

inline DtTime DtPdu::timeStamp() const
{
   return netHeader()->DtTime.time();
}

inline DtTimeStampType DtPdu::timeStampType() const
{  
   return netHeader()->DtTime.type();
}

inline void DtPdu::setExerciseId(int id)
{
   netHeader()->DtExercise = id;
}

inline void DtPdu::setTimeStamp(DtTime time, DtTimeStampType relOrAbs)
{
   netHeader()->DtTime = DtNetTimeStamp(time, relOrAbs);
}

inline int DtPdu::status() const
{
   return myOKStatus;
}

inline void DtPdu::setStatus(int okStatus)
{
   myOKStatus = okStatus;
}     

inline void DtPdu::setVersion(int vers)
{
   netHeader()->version = (unsigned char) (DtU32) vers;
}