latencyTest.h

Go to the documentation of this file.

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


#ifndef DtLatencyTest_H_
#define DtLatencyTest_H_


#include "rtiMsConfig.h"
#include <metadata.h>
#include "RIDparams.h"
#include "rtiApiTypes.h"

#if !defined(DtIFSPEC13)
#include "RTI/RTIambassador.h"
#endif

#include <vlutil/vlString.h>
#include <vlutil/vlTime.h>
#include <vlutil/vlFedTarget.h>

class DtTestManager;

class DT_DLL_LRC DtLatencyTest
{

public:

   struct DtLatencyTestReportStruct
   {
      DtLatencyTestReportStruct() :
         testID(0),
         recipientAsyncMode(DtRIDParameters::DtSynchronousMode),
         initiatorAsyncMode(DtRIDParameters::DtSynchronousMode),
         averageInitiatorTickPeriod(0.0f),
         averageRecipientTickPeriod(0.0f),
         sizeOfPayload(0),
         numbersAreReliable(false),
         initiatorSendInteraction(0.0f),
         initiatorNetSend(0.0f), 
         recipientNetRead(0.0f),
         recipientQueueMsg(0.0f),
         recipReceiveInteraction(0.0f),
         recipientSendInteraction(0.0f), 
         recipientNetSend(0.0f),
         initiatorNetRead(0.0f), 
         initiatorQueueMsg(0.0f),
         initiatorReceiveInteraction(0.0f),
         recipientName(0.0f)
         { }

      unsigned int testID;
      DtRIDParameters::DtAsynchronousIOModeEnum recipientAsyncMode;
      DtRIDParameters::DtAsynchronousIOModeEnum initiatorAsyncMode;
      float averageInitiatorTickPeriod;
      float averageRecipientTickPeriod;
      unsigned int sizeOfPayload;

      bool numbersAreReliable;

      MAKRti::DtTime initiatorSendInteraction;
      MAKRti::DtTime initiatorNetSend; 
      MAKRti::DtTime recipientNetRead;
      MAKRti::DtTime recipientQueueMsg;
      MAKRti::DtTime recipReceiveInteraction;
      MAKRti::DtTime recipientSendInteraction; 
      MAKRti::DtTime recipientNetSend;
      MAKRti::DtTime initiatorNetRead; 
      MAKRti::DtTime initiatorQueueMsg;
      MAKRti::DtTime initiatorReceiveInteraction;
      MAKRti::DtString recipientName;
   };

   DtLatencyTest(DtTestManager* parent);

   DtLatencyTest();
   
   virtual ~DtLatencyTest();

   virtual bool tick();

   virtual void postJoinInit();

   virtual void resign();

   

   virtual void addSendInteractionTimeStamp( unsigned int testID ) = 0;

   virtual void addNetSendTimeStamp( unsigned int testID, DtRtiMsg& msg ) = 0;

   virtual void addNetReceiveTimeStamp( unsigned int testID, const DtRtiMsg& msg ) = 0;

   virtual void addReceiveInteractionTimeStamp( unsigned int testID, MAKRti::DtTime timeToUse ) = 0;

   virtual void addAsyncQueueMsgTimeStamp( unsigned int testID, const DtRtiMsg& msg ) = 0;   

   virtual void addTransportTypeForTestID(unsigned int testID, MAKRti::DtTransportType type );

   virtual MAKRti::DtTransportType transportTypeForTestID( unsigned int testID ) const;

   virtual void removeKnowledgeOfTestId( unsigned int testID );
  
   // Return the time as reported by the parent test Manager.
   MAKRti::DtTime time() const;

protected:

   
private:
   DtLatencyTest(DtLatencyTest const& orig);

   DtLatencyTest& operator= (DtLatencyTest const& orig);

protected:

   DtTestManager* myTestManager;   

   typedef std::multimap<DtMetadataType, MAKRti::DtTime> DtTimeStampMap;
   typedef std::map<unsigned int, DtTimeStampMap > DtTestToTimeStampMap;   
   typedef std::multimap<DtFederateHandle, unsigned int> DtFedHandleToTestMap;

   DtTestToTimeStampMap myTestsInProgressTimeStamps;

   std::map<unsigned int, MAKRti::DtTransportType> myTransportByTestID;

};

#endif