MAK RTIspy API Documentation for HLA 1.3: changeLatencyTestModeMsg.h Source File

Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2008 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: changeLatencyTestModeMsg.h,v $ $Revision: 1.3 $ $State: Exp $
00007 *********************************************************************/
00008 
00009 #ifndef DtChangeLatencyTestModeMsg_H_
00010 #define DtChangeLatencyTestModeMsg_H_
00011 
00015 
00016 // PLEASE NOTE: This class is duplicated as DtAssistantChangeLatencyTestModeMsg 
00017 // in assistantChangeLatencyTestModeMsg.h. Any changes made to this class 
00018 // should also be made there.
00019 
00020 #include <vlutil/vlString.h>
00021 #include <vlutil/vlUtil.h>
00022 
00023 #include "rtiMsg.h"
00024 #include "netChangeLatencyTestModeMsg.h"
00025 
00026 class DtConnectionMgr;
00027 class DtChangeLatencyTestModeMsg;
00028 
00029 typedef void (*DtChangeLatencyTestModeCb)(const DtChangeLatencyTestModeMsg& inter, void* usr);
00030 
00035 class DT_DLL_LRC DtChangeLatencyTestModeMsg : public DtRtiMsg
00036 {
00037 public:
00038 
00040    DtChangeLatencyTestModeMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00041 
00042    DtChangeLatencyTestModeMsg(const DtNetChangeLatencyTestModeMsg* netRepMsg,
00043       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00044 
00046    DtChangeLatencyTestModeMsg( bool continuous,
00047                                bool shouldHalt,
00048                                DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00049 
00051    virtual ~DtChangeLatencyTestModeMsg();
00052 
00054    virtual DtRtiMsg* clone(bool copy = true) const;
00055 
00057    virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;
00058 
00060    virtual bool runTest() const;
00061    virtual void setRunTest( bool yesNo );
00062 
00064    virtual DtFederateHandle initiator() const;
00065    virtual void setInitiator( DtFederateHandle handle );
00066 
00068    virtual bool continuousUpdate() const;
00069    virtual void setContinuousUpdate(bool yesNo);
00070 
00073    virtual bool shouldHaltContinuous() const;
00074    virtual void setShouldHaltContinuous( bool yesNo );
00075 
00077    virtual bool observingResults() const;
00078    virtual void setObservingResults( bool yesNo );
00079 
00081    virtual unsigned int interactionPeriod() const;
00082    virtual void setInteractionPeriod( unsigned int period );
00083 
00085    virtual unsigned int numInteractions() const;
00086    virtual void setNumInteractions( unsigned int num );
00087 
00089    virtual unsigned int payloadBytes() const;
00090    virtual void setPayloadBytes( unsigned int bytes );
00091 
00092 
00093 public:
00094 
00096    static DtRtiMsg* create(const DtNetMsgHeader* initial,
00097       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00098 
00099    static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00100 
00103    static void addCallback(DtConnectionMgr* conn,
00104       DtChangeLatencyTestModeCb cb, void* usr);
00105    static void removeCallback(DtConnectionMgr* conn,
00106       DtChangeLatencyTestModeCb cb, void* usr);
00107       
00108 protected:
00109 
00111    virtual DtNetChangeLatencyTestModeMsg* netChangeLatencyTestModeMsg();
00112    virtual const DtNetChangeLatencyTestModeMsg* netChangeLatencyTestModeMsg() const;
00113 
00115    virtual DtRtiMsgKind internalDtRtiMsgKind();
00116 
00118    virtual int minSize() const;
00119 
00120 };
00121 
00122 #endif