averagedLatencyTestReport.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2008 VT MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: averagedLatencyTestReport.h,v $ $Revision: 1.6 $ $State: Exp $
*******************************************************************************/


#ifndef DtAveragedLatencyTestReport_H_
#define DtAveragedLatencyTestReport_H_

#include "rtiMsConfig.h"
#include <vlutil/vlString.h>
#include <queue>
#include "RIDparams.h"

typedef int encodedTimeType;


enum DtAssistantReportTimeStampType 
{
   DtAverageBestEffortInitiatorSendInteractionTime = 0,
   DtAverageBestEffortRecipientQueueMsgTime,
   DtAverageBestEffortRecipientReceiveInteractionTime,
   DtAverageBestEffortRecipientEncodeDecodeTime,
   DtAverageBestEffortRecipientSendInteractionTime,
   DtAverageBestEffortInitiatorQueueMsgTime,
   DtAverageBestEffortInitiatorReceiveInteractionTime,
   DtAverageReliableInitiatorSendInteractionTime,
   DtAverageReliableRecipientQueueMsgTime,
   DtAverageReliableRecipientReceiveInteractionTime,
   DtAverageReliableRecipientEncodeDecodeTime,
   DtAverageReliableRecipientSendInteractionTime,
   DtAverageReliableInitiatorQueueMsgTime,
   DtAverageReliableInitiatorReceiveInteractionTime,

   DtPaddingType
};

class DT_DLL_RTIUTIL DtAveragedLatencyTestReport 
{
public:

   DtAveragedLatencyTestReport();

   ~DtAveragedLatencyTestReport();

   virtual void decodeFromMsg( const unsigned char* data, unsigned int size );

   virtual void encodeToMsg( unsigned char* destPtr ) const;

   virtual unsigned int sizeRequiredToDecode() const;

   void getProcessingModel( DtRIDParameters::DtAsynchronousIOModeEnum& initiator,
                            DtRIDParameters::DtAsynchronousIOModeEnum& recip  ) const;

   virtual void setInitiatorProcessingModel( DtRIDParameters::DtAsynchronousIOModeEnum initModel );

   virtual void setRecipientProcessingModel( DtRIDParameters::DtAsynchronousIOModeEnum recipModel );

   virtual unsigned int federationHandle() const;
   virtual void setFederationHandle( unsigned int num );
   
   virtual unsigned int initiatorFedHandle() const;
   virtual void setInitiatorFedHandle( unsigned int num );

   virtual unsigned int recipientFedHandle() const;
   virtual void setRecipientFedHandle( unsigned int num );

   virtual void initiatorFedName( MAKRti::DtString& name ) const;
   virtual void setInitiatorFedName( const MAKRti::DtString& name );

   virtual void recipientFedName( MAKRti::DtString& name ) const;
   virtual void setRecipientFedName( const MAKRti::DtString& name );

   virtual unsigned int numCompletedBestEffortInteractions() const;
   virtual void setNumCompletedBestEffortInteractions( unsigned int num );

   virtual unsigned int numCompletedReliableInteractions() const;
   virtual void setNumCompletedReliableInteractions( unsigned int num );

   virtual unsigned int numDroppedBestEffortInteractions() const;
   virtual void setNumDroppedBestEffortInteractions( unsigned int num );

   virtual unsigned int numDroppedReliableInteractions() const;
   virtual void setNumDroppedReliableInteractions( unsigned int num );

   virtual unsigned int averageInitiatorTickTimeUsecs() const;
   virtual void setAverageInitiatorTickTimeUsecs(unsigned int time );

   virtual unsigned int averageRecipientTickTimeUsecs() const;
   virtual void setAverageRecipientTickTimeUsecs(unsigned int time);

   virtual unsigned int averageBestEffortRoundTripTime() const;
   virtual void setAverageBestEffortRoundTripTime( unsigned int num );

   virtual unsigned int averageReliableRoundTripTime() const;
   virtual void setAverageReliableRoundTripTime( unsigned int num );

   virtual void setAverageBestEffortInitiatorSendInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortInitiatorSendInteractionUSecs() const;

   virtual void setAverageReliableInitiatorSendInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableInitiatorSendInteractionUSecs() const;

   virtual void setAverageBestEffortRecipientMsgQueuedUsecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortRecipientMsgQueuedUsecs() const;

   virtual void setAverageReliableRecipientMsgQueuedUsecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableRecipientMsgQueuedUsecs() const;

   virtual void setAverageBestEffortRecipientReceiveInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortRecipientReceiveInteractionUSecs() const;

   virtual void setAverageReliableRecipientReceiveInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableRecipientReceiveInteractionUSecs() const;

   virtual void setAverageBestEffortRecipientEncodeDecodeInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortRecipientEncodeDecodeInteractionUSecs() const;

   virtual void setAverageReliableRecipientEncodeDecodeInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableRecipientEncodeDecodeInteractionUSecs() const;

   virtual void setAverageBestEffortRecipientSendInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortRecipientSendInteractionUSecs() const;

   virtual void setAverageReliableRecipientSendInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableRecipientSendInteractionUSecs() const;

   virtual void setAverageBestEffortInitiatorMsgQueuedUsecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortInitiatorMsgQueuedUsecs() const;

   virtual void setAverageReliableInitiatorMsgQueuedUsecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableInitiatorMsgQueuedUsecs() const;

   virtual void setAverageBestEffortInitiatorReceiveInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageBestEffortInitiatorReceiveInteractionUSecs() const;

   virtual void setAverageReliableInitiatorReceiveInteractionUSecs( encodedTimeType microSeconds );
   virtual encodedTimeType averageReliableInitiatorReceiveInteractionUSecs() const;

   static bool requiresQueueMsgStamp( DtRIDParameters::DtAsynchronousIOModeEnum model );

protected:

   virtual void setSingleTimeByType( DtAssistantReportTimeStampType,
                                     encodedTimeType num );

   virtual encodedTimeType getSingleTimeByType( DtAssistantReportTimeStampType) const;

  

   static void setSingleTimeToPtr( DtAssistantReportTimeStampType type,
                       encodedTimeType time,
                       unsigned char** dataPtrPtr );

   static void getSingleTimeFromPtr( DtAssistantReportTimeStampType& type,
                       encodedTimeType& time,
                       const unsigned char** dataPtrPtr );

   static void writeUintAndAdvancePtr( unsigned int num,
                                       unsigned char** dataPtrPtr );

   static void readUintAndAdvancePtr( unsigned int& num, 
                                      unsigned char** dataPtrPtr );

   static void writeFloatAndAdvancePtr( const float& num,
                                        unsigned char** dataPtrPtr );

   static void readFloatAndAdvancePtr( float& num,
                                       unsigned char** dataPtrPtr );


   static void writeSizeAndStringAndAdvancePtr( const MAKRti::DtString& name,
                                                unsigned char** dataPtrPtr );

   static void readSizeAndStringAndAdvancePtr( MAKRti::DtString& name,
                                               unsigned char** dataPtrPtr,
                                               unsigned int& encodedSize );

   static unsigned int determineSizeOfPaddedSting( const MAKRti::DtString& string );



protected:


   
   encodedTimeType myAverageBestEffortInitiatorSendInteractionTime;
   encodedTimeType myAverageBestEffortRecipientReceiveInteractionTime;      
   encodedTimeType myAverageBestEffortRecipientEncodeDecodeTime;
   encodedTimeType myAverageBestEffortRecipientSendInteractionTime;
   encodedTimeType myAverageBestEffortInitiatorReceiveInteractionTime;

   encodedTimeType myAverageBestEffortRecipientQueueMsgTime;
   encodedTimeType myAverageBestEffortInitiatorQueueMsgTime;


   encodedTimeType myAverageReliableInitiatorSendInteractionTime;
   encodedTimeType myAverageReliableRecipientReceiveInteractionTime;      
   encodedTimeType myAverageReliableRecipientEncodeDecodeTime;
   encodedTimeType myAverageReliableRecipientSendInteractionTime;
   encodedTimeType myAverageReliableInitiatorReceiveInteractionTime;

   encodedTimeType myAverageReliableRecipientQueueMsgTime;
   encodedTimeType myAverageReliableInitiatorQueueMsgTime;
   
   DtRIDParameters::DtAsynchronousIOModeEnum myRecipModel;
   DtRIDParameters::DtAsynchronousIOModeEnum myInitModel;

   // TODO: identify the forwarders?
   //std::queue<std::pair<unsigned int, encodedTimeType> > myForwarderTimes;


   MAKRti::DtString myInitiatorFederateName;
   MAKRti::DtString myRecipientFederateName;

   unsigned int myFederation;
   unsigned int myInitiatorFed;
   unsigned int myRecipientFed;
   unsigned int myNumBestEffortInteractions;
   unsigned int myNumReliableInteractions;
   unsigned int myNumDroppedBestEffort;
   unsigned int myNumDroppedReliable;
   unsigned int myBestEffortRoundTripTime;
   unsigned int myReliableRoundTripTime;

   unsigned int myAverageRecipientTickTime;
   unsigned int myAverageInitiatorTickTime;


   static const encodedTimeType theInvalidEncodedTime;

};


#endif