assistantChangeLatencyTestModeMsg.h

Go to the documentation of this file.

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

#ifndef DtAssistantChangeLatencyTestModeMsg_H_
#define DtAssistantChangeLatencyTestModeMsg_H_


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

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

#include "assistantMsg.h"
#include "netAssistantChangeLatencyTestModeMsg.h"

class DtRtiAssistantClient;
class DtRtiAssistantPeer;
class DtAssistantChangeLatencyTestModeMsg;

typedef void (*DtAssistantChangeLatencyTestModeCb)(const DtAssistantChangeLatencyTestModeMsg& inter, void* usr);

class DT_DLL_ASSISTANT DtAssistantChangeLatencyTestModeMsg : public DtAssistantMsg
{
public:

   DtAssistantChangeLatencyTestModeMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtAssistantChangeLatencyTestModeMsg(const DtNetAssistantChangeLatencyTestModeMsg* netRepMsg,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

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

   virtual ~DtAssistantChangeLatencyTestModeMsg();

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

   virtual void printData() const;

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

   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 );

   virtual unsigned long federationHandle() const;
   virtual void setFederationHandle( unsigned long handle );

   virtual unsigned long initFedHandle() const;
   virtual void setInitFedHandle( unsigned long handle );

public:

   static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static void addCallback(DtRtiAssistantClient* conn,
      DtAssistantChangeLatencyTestModeCb cb, void* usr);
   static void removeCallback(DtRtiAssistantClient* conn,
      DtAssistantChangeLatencyTestModeCb cb, void* usr);

   static void addCallback(DtRtiAssistantPeer* conn,
      DtAssistantChangeLatencyTestModeCb cb, void* usr);
   static void removeCallback(DtRtiAssistantPeer* conn,
      DtAssistantChangeLatencyTestModeCb cb, void* usr);
      
protected:

   virtual DtNetAssistantChangeLatencyTestModeMsg* netAssistantChangeLatencyTestModeMsg();
   virtual const DtNetAssistantChangeLatencyTestModeMsg* netAssistantChangeLatencyTestModeMsg() const;

   virtual DtAssistantMsgKind internalMsgKind();

   virtual int minSize() const;

};

#endif