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

Go to the documentation of this file.
00001 /**************************************************************************
00002 ** Copyright (c) 2006 MAK Technologies, Inc.
00003 ** All rights reserved.
00004 ***************************************************************************/
00005 /**************************************************************************
00006 ** $RCSfile: assistantRidParamsMsg.h,v $ $Revision: 1.1 $ $State: Exp $
00007 ***************************************************************************/
00008 
00011 
00012 #ifndef DtAssistantRidParamsMsg_H_
00013 #define DtAssistantRidParamsMsg_H_
00014 
00015 #include <vlutil/vlString.h>
00016 #include <vlutil/vlFilename.h>
00017 
00018 #include "rtiMsConfig.h"
00019 #include "assistantMsg.h"
00020 #include "netAssistantRidParamsMsg.h"
00021 
00022 class DtRtiAssistantPeer;
00023 class DtRtiAssistantServer;
00024 class DtRtiAssistantClient;
00025 class DtAssistantRidParamsMsg;
00026 
00027 typedef void (*DtAssistantRidParamsCb)(const DtAssistantRidParamsMsg& inter, void* usr);
00028 
00033 class DT_DLL_ASSISTANT DtAssistantRidParamsMsg : public DtAssistantMsg
00034 {
00035 public:
00036 
00038    DtAssistantRidParamsMsg( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00039 
00041    DtAssistantRidParamsMsg( const DtNetAssistantRidParamsMsg* netRepMsg,
00042       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00043 
00045    virtual ~DtAssistantRidParamsMsg();
00046 
00048    virtual DtAssistantMsg* clone(bool copy = true) const; 
00049 
00050    virtual int minSize() const;
00051 
00053    virtual void setIsRequest( bool isReq );
00054 
00056    virtual bool isRequest() const;
00057 
00059    virtual void setRidFilename(const MAKRti::DtFilename& filename);
00060 
00062    virtual MAKRti::DtFilename ridFilename() const;
00063 
00065    virtual void setRidParams( const MAKRti::DtString& ridParams );
00066 
00068    virtual void getRidParams( MAKRti::DtString& ridParams ) const;
00069 
00071    virtual void printData() const;
00072 
00073 public:
00074 
00076    static DtAssistantMsg* create( const DtNetAssistantMsgHeader* initial,
00077       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00078 
00080    static DtAssistantMsg* create( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00081 
00083 
00084    static void addCallback(DtRtiAssistantClient* conn,
00085       DtAssistantRidParamsCb cb, void* usr);
00086    static void removeCallback(DtRtiAssistantClient* conn,
00087       DtAssistantRidParamsCb cb, void* usr);
00088 
00089    static void addCallback(DtRtiAssistantServer* conn,
00090       DtAssistantRidParamsCb cb, void* usr);
00091    static void removeCallback(DtRtiAssistantServer* conn,
00092       DtAssistantRidParamsCb cb, void* usr);
00093 
00094    static void addCallback(DtRtiAssistantPeer* conn,
00095       DtAssistantRidParamsCb cb, void* usr);
00096    static void removeCallback(DtRtiAssistantPeer* conn,
00097       DtAssistantRidParamsCb cb, void* usr);
00099 
00100 protected:
00101 
00103    virtual DtNetAssistantRidParamsMsg* netAssistantRidParamsMsg();
00104    virtual const DtNetAssistantRidParamsMsg* netAssistantRidParamsMsg() const;
00105 
00107    virtual DtAssistantMsgKind internalMsgKind();
00108 
00110    virtual void setRidFilenameSize( unsigned long size );
00111    virtual unsigned long ridFilenameSize() const;
00112 
00114    virtual const char* ridFilenamePtr() const;
00115    virtual char* ridFilenamePtr();
00116 
00118    virtual void setRidParametersSize( unsigned long size );
00119    virtual unsigned long ridParametersSize() const;
00120 
00122    virtual const char* ridParametersPtr() const;
00123    virtual char* ridParametersPtr();
00124 
00125 };
00126 
00127 #endif  //! DtAssistantRidParamsMsg_H_
00128