joinMsg.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 1998 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: joinMsg.h,v $ $Revision: 1.37 $ $State: Exp $
*********************************************************************/


#ifndef DtJoinMsg_H_
#define DtJoinMsg_H_

#include "rtiMsg.h"
#include "netRtiMsgHdr.h"
#include "netJoinMsg.h"
#include "rtiVersion.h"
#include <vlutil/vlString.h>
#include <vlutil/vlUtil.h>
#include <vlutil/vlInetAddr.h>

class DtConnectionMgr;
class DtJoinMsg;
typedef void (*DtJoinCb)(const DtJoinMsg& inter, void* usr);

class DT_DLL_LRC DtJoinMsg : public DtRtiMsg
{
public:


   DtJoinMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtJoinMsg(unsigned long sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const & fedTypeValue,
      MAKRti::DtString const & fedExNameValue, MAKRti::DtString const & fedNameValue,
      MAKRti::DtString const& federateHostNameValue, const std::wstring& credentialsType, char const* credentialsData,
      int credentialsDataSize, const std::vector<MAKRti::DtString>& moduleNames, DtHlaVersionId hlaVersion, int astntCompId,
      unsigned long flagsValue, unsigned int needPartnerValue, const std::vector<unsigned int>& joinModulesCrcs,
      DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtJoinMsg(const DtNetJoinMsg* netRepMsg, DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtJoinMsg();

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

   virtual void set(unsigned long sourceIDValue, unsigned short requestIDValue, MAKRti::DtString const & fedTypeValue,
      MAKRti::DtString const & fedExNameValue, MAKRti::DtString const & fedNameValue,
      MAKRti::DtString const& federateHostNameValue, const std::wstring& credentialsType, char const* credentialsData,
      int credentialsDataSize, const std::vector<MAKRti::DtString>& moduleNames, DtHlaVersionId hlaVersion, int astntCompId, unsigned long flagsValue,
      unsigned int needPartnerValue, const std::vector<unsigned int>& joinModulesCrcs, bool adjustBufferSize = true);


   virtual unsigned long sourceID() const;
   virtual void setSourceID(unsigned long sourceIDValue);

   virtual unsigned short requestID() const;
   virtual void setRequestID(unsigned short requestIDValue);

   virtual void setFederateType(MAKRti::DtString const & type, bool adjustBufferSize = true);
   virtual MAKRti::DtString federateType() const;

   virtual void setFullFedExName(MAKRti::DtString const & name, bool adjustBufferSize = true);
   virtual MAKRti::DtString fullFedExName() const;

   virtual void setFederateName(MAKRti::DtString const & name, bool adjustBufferSize = true);
   virtual MAKRti::DtString federateName() const;

   virtual void setFederateHostName(MAKRti::DtString const& name, bool adjustBufferSize = true);
   virtual MAKRti::DtString federateHostName() const;

   virtual void setCredentialsType(const std::wstring& type, bool adjustBufferSize = true);
   virtual std::wstring credentialsType() const;
   virtual std::wstring& getCredentialsType(std::wstring& type) const;

   virtual void setCredentialsData(void const* data, unsigned short size, bool adjustBufferSize = true);
   virtual void setCredentialsData(const std::vector<char>& data, bool adjustBufferSize = true);
   virtual std::vector<char>& getCredentialsData(std::vector<char>& data) const;
   virtual void const* credentialsData() const;
   virtual unsigned short credentialsDataSize() const;

   virtual void setFomModuleNames( const std::vector<MAKRti::DtString> & moduleNames, bool adjustBufferSize = true);
   virtual void getFomModuleNames(std::vector<MAKRti::DtString>& modules) const;

   virtual void setIpAddress( const MAKRti::DtInetAddr& ip );
   virtual MAKRti::DtInetAddr ipAddress() const;

   virtual void setHlaVersion(DtHlaVersionId version);
   virtual DtHlaVersionId hlaVersion() const;

   virtual void setAssistantCompId(int id);
   virtual int assistantCompId() const;

   virtual void setFlags( unsigned long value );
   virtual unsigned long flags() const;

   virtual void setNeedPartner( unsigned int value );
   virtual unsigned int needPartner() const;

   unsigned int numOfCrcs() const;
   void setNumOfCrcs(unsigned int value);

   virtual void setCrcsOfFedFiles(const std::vector<unsigned int> & moduleCrcs, bool adjustBufferSize = true);
   virtual void getCRCsOfFedFiles(std::vector<unsigned int>& crcOfFedFiles) const;

   virtual void printData(DtLogicalTimeFactory* logicalTimeFactory) const;

public:

   static DtRtiMsg* create(const DtNetMsgHeader* initial, DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   static DtRtiMsg* create(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);


   static void addCallback(DtConnectionMgr* conn, DtJoinCb cb, void* usr);
   static void removeCallback(DtConnectionMgr* conn, DtJoinCb cb, void* usr);

protected:


   virtual DtNetJoinMsg* netJoinMsg();
   virtual const DtNetJoinMsg* netJoinMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual int minSize( MAKRti::DtString const & federateType, MAKRti::DtString const & fedExName,
      MAKRti::DtString const & federateName, MAKRti::DtString const& federateHostName, const std::wstring& credentialsType,
      int credentialsDataSize, const std::vector<MAKRti::DtString>& fomModuleNamesVal,
      const std::vector<unsigned int>& joinModulesCrcs);


   virtual void setFederateTypeSize( unsigned long size );
   virtual unsigned long federateTypeSize() const;

   virtual void setFedExNameSize( unsigned long size );
   virtual unsigned long fedExNameSize() const;

   virtual void setFederateNameSize( unsigned long size );
   virtual unsigned long federateNameSize() const;

   virtual void setFederateHostNameSize( unsigned long size );
   virtual unsigned long federateHostNameSize() const;

   virtual void setFomModuleNameSize( unsigned long size );
   virtual unsigned long fomModuleNameSize() const;

   virtual void setNumberFomModules(unsigned int count);
   virtual unsigned int numberFomModules() const;

   virtual void setCredentialsTypeSize(unsigned short size);
   virtual unsigned short credentialsTypeSize() const;

   virtual void setCredentialsDataSize(unsigned short size);



   virtual const char* federateNamePtr() const;
   virtual char* federateNamePtr();

   virtual const char* fedExNamePtr() const;
   virtual char* fedExNamePtr();

   virtual const char* federateTypePtr() const;
   virtual char* federateTypePtr();

   virtual const char* fomModuleNamesPtr() const;
   virtual char* fomModuleNamesPtr();

   virtual const char* federateHostNamePtr() const;
   virtual char* federateHostNamePtr();

   virtual const DtNetU32* crcsOfFomModulesPtr() const;
   virtual DtNetU32* crcsOfFomModulesPtr();

   virtual const DtNetU16* credentialsTypePtr() const;
   virtual DtNetU16* credentialsTypePtr();

   virtual const char* credentialsDataPtr() const;
   virtual char* credentialsDataPtr();

   virtual DtJoinMsg* self() const;
};


inline DtJoinMsg* DtJoinMsg::self() const
{
   return const_cast<DtJoinMsg*>( this );
}

#endif