MAK RTIspy API Documentation for HLA 1.3: assistantNotifyMsg.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: assistantNotifyMsg.h,v $ $Revision: 1.4 $ $State: Exp $
00007 *********************************************************************/
00008 
00009 #ifndef assistantNotifyMsg_H_
00010 #define assistantNotifyMsg_H_
00011 
00015 
00016 #include <vlutil/vlPrint.h>
00017 
00018 #include "assistantMsg.h"
00019 #include "netAssistantNotifyMsg.h"
00020 
00021 class DtAssistantNotifyMsg;
00022 class DtRtiAssistantServer;
00023 class DtRtiAssistantPeer;
00024 
00025 typedef void (*DtAssistantNotifyCb)(const DtAssistantNotifyMsg& inter, void* usr);
00026 
00027 
00032 class DT_DLL_ASSISTANT DtAssistantNotifyMsg : public DtAssistantMsg
00033 {
00034 
00035 public:
00036    
00038    DtAssistantNotifyMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00039 
00040    DtAssistantNotifyMsg(const DtNetAssistantNotifyMsg* netRep,
00041       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00042 
00043    DtAssistantNotifyMsg( const MAKRti::DtString& text,
00044       DtNotifyLevelType notifyLevel,
00045       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER );
00046 
00048    virtual ~DtAssistantNotifyMsg();
00049 
00051    virtual DtAssistantMsg* clone(bool copy = true) const; 
00052 
00054    virtual void setNotifyLevel( DtNotifyLevelType level );
00055 
00057    virtual DtNotifyLevelType notifyLevel() const;
00058 
00060    virtual void setText(const MAKRti::DtString& name);
00061 
00063    virtual MAKRti::DtString text() const;
00064 
00066    virtual void setSourceName(const MAKRti::DtString& name);
00067 
00069    virtual MAKRti::DtString sourceName() const;
00070 
00072    virtual void printData() const;
00073 
00074 public:
00075 
00077    static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
00078       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00079 
00080    static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00081 
00084    static void addCallback(DtRtiAssistantServer* conn, DtAssistantNotifyCb cb, void* usr);
00085    static void removeCallback(DtRtiAssistantServer* conn, DtAssistantNotifyCb cb, void* usr);
00086 
00089    static void addCallback(DtRtiAssistantPeer* conn, DtAssistantNotifyCb cb, void* usr);
00090    static void removeCallback(DtRtiAssistantPeer* conn, DtAssistantNotifyCb cb, void* usr);
00091 
00092 protected:
00093 
00095    virtual DtNetAssistantNotifyMsg* netAssistantNotifyMsg();
00096    virtual const DtNetAssistantNotifyMsg* netAssistantNotifyMsg() const;
00097 
00099    virtual DtAssistantMsgKind internalMsgKind();
00100 
00102    virtual int minSize() const;
00103 
00107    virtual int setMinSize( const MAKRti::DtString& text );
00108 
00110    virtual void setTextSize( unsigned long size );
00111    virtual unsigned long textSize() const;
00112 
00114    virtual const char* textPtr() const;
00115    virtual char* textPtr();
00116 
00118    virtual void setSourceNameSize( unsigned long size );
00119    virtual unsigned long sourceNameSize() const;
00120 
00122    virtual const char* sourceNamePtr() const;
00123    virtual char* sourceNamePtr();
00124 
00125 };
00126 
00127 #endif