changeLatencyTestModeMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: changeLatencyTestModeMsg.h,v $ $Revision: 1.3 $ $State: Exp $
*********************************************************************/

#ifndef DtChangeLatencyTestModeMsg_H_
#define DtChangeLatencyTestModeMsg_H_


// PLEASE NOTE: This class is duplicated as DtAssistantChangeLatencyTestModeMsg 
// in assistantChangeLatencyTestModeMsg.h. Any changes made to this class 
// should also be made there.

#include <vlutil/vlString.h>
#include <vlutil/vlUtil.h>

#include "rtiMsg.h"
#include "netChangeLatencyTestModeMsg.h"

class DtConnectionMgr;
class DtChangeLatencyTestModeMsg;

typedef void (*DtChangeLatencyTestModeCb)(const DtChangeLatencyTestModeMsg& inter, void* usr);

class DT_DLL_LRC DtChangeLatencyTestModeMsg : public DtRtiMsg
{
public:

   DtChangeLatencyTestModeMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtChangeLatencyTestModeMsg(const DtNetChangeLatencyTestModeMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtChangeLatencyTestModeMsg( bool continuous,
                               bool shouldHalt,
                               DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );

   virtual ~DtChangeLatencyTestModeMsg();

   virtual DtRtiMsg* clone(bool copy = true) const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

   virtual bool runTest() const;
   virtual void setRunTest( bool yesNo );

   virtual DtFederateHandle initiator() const;
   virtual void setInitiator( DtFederateHandle handle );

   virtual bool continuousUpdate() const;
   virtual void setContinuousUpdate(bool yesNo);

   virtual bool shouldHaltContinuous() const;
   virtual void setShouldHaltContinuous( bool yesNo );

   virtual bool observingResults() const;
   virtual void setObservingResults( bool yesNo );

   virtual unsigned int interactionPeriod() const;
   virtual void setInteractionPeriod( unsigned int period );

   virtual unsigned int numInteractions() const;
   virtual void setNumInteractions( unsigned int num );

   virtual unsigned int payloadBytes() const;
   virtual void setPayloadBytes( unsigned int bytes );


public:

   static DtRtiMsg* create(const DtNetMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtConnectionMgr* conn,
      DtChangeLatencyTestModeCb cb, void* usr);
   static void removeCallback(DtConnectionMgr* conn,
      DtChangeLatencyTestModeCb cb, void* usr);
      
protected:

   virtual DtNetChangeLatencyTestModeMsg* netChangeLatencyTestModeMsg();
   virtual const DtNetChangeLatencyTestModeMsg* netChangeLatencyTestModeMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

};

#endif