MAK RTIspy API Documentation for HLA Evolved
assistantLrcCompInfoMsg.h
Go to the documentation of this file.
00001 /*********************************************************************
00002 ** Copyright (c) 2008 MaK Technologies, Inc.
00003 ** All rights reserved.
00004 *********************************************************************/
00005 /*********************************************************************
00006 ** $RCSfile: assistantLrcCompInfoMsg.h,v $ $Revision: 1.10 $ $State: Exp $
00007 *********************************************************************/
00008 
00009 #ifndef assistantLrcCompInfoMsg_H_
00010 #define assistantLrcCompInfoMsg_H_
00011 
00015 
00016 #include <vlutil/vlFilename.h>
00017 #include <vlutil/vlPrint.h>
00018 #include "assistantConnectionInfo.h"
00019 
00020 #include "rtiVersion.h"
00021 #include "assistantMsg.h"
00022 #include "assistantConnMsg.h"
00023 #include "netAssistantLrcCompInfoMsg.h"
00024 
00025 class DtAssistantLrcCompInfoMsg;
00026 class DtRtiAssistantServer;
00027 class MAKRti::DtInetAddr;
00028 
00029 typedef void (*DtAssistantLrcCompInfoCb)(const DtAssistantLrcCompInfoMsg& inter, void* usr);
00030 
00031 
00036 class DT_DLL_ASSISTANT DtAssistantLrcCompInfoMsg : public DtAssistantMsg
00037 {
00038 
00039 public:
00040 
00042    DtAssistantLrcCompInfoMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00043 
00044    DtAssistantLrcCompInfoMsg(const DtNetAssistantLrcCompInfoMsg* netRep,
00045       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00046 
00048    virtual ~DtAssistantLrcCompInfoMsg();
00049 
00051    virtual DtAssistantMsg* clone(bool copy = true) const;
00052 
00054    virtual void setIpAddress(const MAKRti::DtInetAddr& ipOrHost);
00055 
00057    virtual MAKRti::DtInetAddr ipAddress() const;
00058 
00060    virtual void setBestEffortIpAddress(const MAKRti::DtInetAddr& ipAddr);
00061 
00063    virtual MAKRti::DtInetAddr bestEffortIpAddress() const;
00064 
00066    virtual void setNetworkInterfaceAddress(const MAKRti::DtInetAddr& addr);
00067 
00069    virtual MAKRti::DtInetAddr networkInterfaceAddress() const;
00070 
00072    virtual void setUdpPort(int port);
00073 
00075    virtual int udpPort() const;
00076 
00078    virtual void setTcpPort(int port);
00079 
00081    virtual int tcpPort() const;
00082 
00084    virtual void setUseRtiexec(bool val);
00085 
00087    virtual bool useRtiexec() const;
00088 
00090    virtual void setFullCompliance(bool val);
00091 
00093    virtual bool fullCompliance() const;
00094 
00096    virtual void setHlaVersion(DtHlaVersionId val);
00097 
00099    virtual DtHlaVersionId hlaVersion() const;
00100 
00102    virtual void setWebSpyIpAddress(const MAKRti::DtInetAddr& ipAddr);
00103 
00105    virtual MAKRti::DtInetAddr webSpyIpAddress() const;
00106 
00108    virtual void setWebSpyPort(int port);
00109 
00111    virtual int webSpyPort() const;
00112 
00114    virtual void setWebSpyId(int id);
00115 
00117    virtual int webSpyId() const;
00118 
00120    virtual void setLogFilename(const MAKRti::DtFilename& filename);
00121 
00123    virtual MAKRti::DtFilename logFilename() const;
00124 
00126    virtual void setNotifyLevel( DtNotifyLevelType level );
00127 
00129    virtual DtNotifyLevelType notifyLevel() const;
00130 
00132    virtual void setName(const MAKRti::DtString& name);
00133 
00135    virtual void setFederateName( const MAKRti::DtString& fedName );
00136 
00138    virtual void setProcessName( const MAKRti::DtString& processName );
00139 
00141    virtual void setProcessId( unsigned long processId );
00142 
00144    virtual void setCommandArgs( const MAKRti::DtString& commandArgs );
00145 
00147    virtual MAKRti::DtString name() const;
00148 
00150    virtual MAKRti::DtString federateName() const;
00151 
00153    virtual MAKRti::DtString processName() const;
00154 
00156    virtual unsigned long processId() const;
00157 
00159    virtual MAKRti::DtString commandArgs() const;
00160 
00162    virtual void setFederateHandle(unsigned long handle);
00163 
00165    virtual unsigned long federateHandle() const;
00166 
00168    virtual void setFederationHandle(unsigned long handle);
00169 
00171    virtual unsigned long federationHandle() const;
00172 
00174    virtual void setFederationName(const MAKRti::DtString& name);
00175 
00177    virtual MAKRti::DtString federationName() const;
00178 
00180    virtual void setLicServer(const MAKRti::DtString& server);
00181 
00183    virtual MAKRti::DtString licServer() const;
00184 
00186    virtual void setForwarderPort(int port);
00187 
00189    virtual int forwarderPort() const;
00190 
00192    virtual void printData() const;
00193 
00194 public:
00195 
00197    static DtAssistantMsg* create(const DtNetAssistantMsgHeader* initial,
00198       DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00199 
00200    static DtAssistantMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);
00201 
00204    static void addCallback(DtRtiAssistantServer* conn, DtAssistantLrcCompInfoCb cb, void* usr);
00205    static void removeCallback(DtRtiAssistantServer* conn, DtAssistantLrcCompInfoCb cb, void* usr);
00206 
00207 protected:
00208 
00210    virtual void setAddressFamily(MAKRti::DtInetUtils::DtInetAddrFamily fam);
00211 
00213    virtual MAKRti::DtInetUtils::DtInetAddrFamily addressFamily() const;
00214 
00216    virtual DtNetAssistantLrcCompInfoMsg* netAssistantLrcCompInfoMsg();
00217    virtual const DtNetAssistantLrcCompInfoMsg* netAssistantLrcCompInfoMsg() const;
00218 
00220    virtual DtAssistantMsgKind internalMsgKind();
00221 
00223    virtual int minSize() const;
00224 
00226    virtual void setLogFilenameSize( unsigned long size );
00227    virtual unsigned long logFilenameSize() const;
00228 
00230    virtual const char* logFilenamePtr() const;
00231    virtual char* logFilenamePtr();
00232 
00234    virtual void setNameSize( unsigned long size );
00235    virtual unsigned long nameSize() const;
00236 
00238    virtual const char* namePtr() const;
00239    virtual char* namePtr();
00240 
00242    virtual void setFederateNameSize( unsigned long size );
00243    virtual unsigned long federateNameSize() const;
00244 
00246    virtual const char* federateNamePtr() const;
00247    virtual char* federateNamePtr();
00248 
00250    virtual void setProcessNameSize( unsigned long size );
00251    virtual unsigned long processNameSize() const;
00252 
00254    virtual const char* processNamePtr() const;
00255    virtual char* processNamePtr();
00256 
00258    virtual void setCommandArgsSize( unsigned long size );
00259    virtual unsigned long commandArgsSize() const;
00260 
00262    virtual const char* commandArgsPtr() const;
00263    virtual char* commandArgsPtr();
00264 
00266    virtual void setLicServerSize( unsigned long size );
00267    virtual unsigned long licServerSize() const;
00268 
00270    virtual const char* licServerPtr() const;
00271    virtual char* licServerPtr();
00272 
00274    virtual void setFederationNameSize( unsigned long size );
00275    virtual unsigned long federationNameSize() const;
00276 
00278    virtual const char* federationNamePtr() const;
00279    virtual char* federationNamePtr();
00280 
00281 };
00282 
00283 #endif

Document ID: Generated on Thu Jun 14 14:15:04 EDT 2012 from SVN revision 116116
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)