joinRespMsg.h

Go to the documentation of this file.

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


#ifndef DtJoinResponseMsg_H_
#define DtJoinResponseMsg_H_

#include "rtiMsg.h"
#include "netRtiMsgHdr.h"
#include "netJoRespMsg.h"

#include <vlutil/vlString.h>

class DtConnectionMgr;
class DtJoinResponseMsg;
class DtFederateHandleSet;
typedef void (*DtJoinResponseCb)(const DtJoinResponseMsg& inter, void* usr);

typedef std::map< MAKRti::DtString, DtFederateHandle > DtFederateNameAndHdlMap;

class DT_DLL_LRC DtJoinResponseMsg : public DtRtiMsg
{
public:
   enum errorCodes {
      DT_NO_ERROR = 0,
      DT_FEDEX_DOES_NOT_EXIST,
      DT_SAVE_IN_PROGRESS,
      DT_RESTORE_IN_PROGRESS,
      DT_FED_FILE_NOT_READY,
      DT_MAX_FEDERATES_JOINED,
      DT_FED_FILE_MERGE_PROBLEM,
      DT_FAILED_TO_GET_LICENSE,
      DT_RTIEXEC_LICENSING_PARAM_MISMATCH,
      DT_PARTNER_TAKEN,
      DT_TYPE_CONFLICT,
      DT_NAME_IN_USE,
      DT_UNKNOWN_ERROR,
      DT_WAITING,  
      DT_CRC_FAILURE,
      DT_FEDEX_STILL_CREATING,
      DT_UNAUTHORIZED
   };
      
public:


   DtJoinResponseMsg(DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtJoinResponseMsg(unsigned long destinationIDValue, unsigned short requestIDValue, DtFederateHandle federateHandleValue,
      MAKRti::DtString federateNameValue, unsigned short fedExHandleValue, MAKRti::DtString const & fedExNameValue,
      MAKRti::DtString const & timeImplNameValue, unsigned int crcOfFedFileValue, const MAKRti::DtString& momModule,
      const std::vector<MAKRti::DtString >& moduleNames, unsigned long flagsValue, bool allowNetworkTestValue,
      bool enableNetworkTestValue, const DtFederateNameAndHdlMap* namesAndHdls, errorCodes errorValue = DT_NO_ERROR,
      const DtString& errorString = DtString::nullString(), DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   DtJoinResponseMsg(const DtNetJoinResponseMsg* netRepMsg, DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER);

   virtual ~DtJoinResponseMsg();

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

   virtual void set(unsigned long destinationIDValue, unsigned short requestIDValue, DtFederateHandle federateHandleValue,
      MAKRti::DtString federateNameValue, unsigned short fedExHandleValue, MAKRti::DtString const & fedExNameValue,
      MAKRti::DtString const & timeImplNameValue, unsigned int crcOfFedFileValue, const MAKRti::DtString& momModule,
      const std::vector<MAKRti::DtString>& moduleNames, unsigned long flagsValue, bool allowNetworkTestValue,
      bool enableNetworkTestValue, const DtFederateNameAndHdlMap* namesAndHdls, errorCodes errorValue = DT_NO_ERROR,
      const DtString& errorString = DtString::nullString(), bool adjustBufferSize = true);



   virtual unsigned long destinationID() const;
   virtual void setDestinationID(unsigned long destinationIDValue);

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

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

   virtual unsigned short fedexHandleToUse() const;
   virtual void setFedexHandleToUse(unsigned short handle);

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

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

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

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

   virtual DtFederateHandle federateHandleToUse() const;
   virtual void setFederateHandleToUse(DtFederateHandle handle);

   virtual unsigned int crcOfFedFile() const;
   virtual void setCrcOfFedFile(unsigned int crc );

   virtual void setErrorValue( errorCodes value );
   virtual errorCodes errorValue() const;

   virtual void setErrorString(MAKRti::DtString const & errorStr, bool adjustBufferSize = true);
   virtual MAKRti::DtString errorString() const;

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

   virtual void setAllowNetworkTest( bool value );
   virtual bool allowNetworkTest() const;

   virtual void setNetworkTestEnabled( bool value );
   virtual bool networkTestEnabled() const;

   virtual void setFederateNamesAndHandles(const std::map< MAKRti::DtString, DtFederateHandle >& namesAndHandles, bool adjustBufferSize = true);
   virtual void getFederateNamesAndHandles(std::map< MAKRti::DtString, DtFederateHandle >& namesAndHdls) const;

   virtual void setFederateNamesSize( unsigned long size );
   virtual unsigned long federateNamesSize() const;

   virtual unsigned numFederates() const;
   virtual void setNumFederates(unsigned num);

   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, DtJoinResponseCb cb, void* usr, bool isMomCallback=false);
   static void removeCallback(DtConnectionMgr* conn, DtJoinResponseCb cb, void* usr, bool isMomCallback=false);

protected:


   virtual DtNetJoinResponseMsg* netJoinResponseMsg();
   virtual const DtNetJoinResponseMsg* netJoinResponseMsg() const;

   virtual DtRtiMsgKind internalDtRtiMsgKind();

   virtual int minSize() const;

   virtual int minSize(const MAKRti::DtString& fedExNameVal, const MAKRti::DtString& federateNameVal,
      const MAKRti::DtString& timeImplNameVal, const std::vector<MAKRti::DtString>& fomModuleNamesVal,
      const MAKRti::DtString& momModuleNameVal, const DtFederateNameAndHdlMap* namesAndHdls, const MAKRti::DtString& errorString);


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

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

   virtual void setErrorStringSize( unsigned long size );
   virtual unsigned long errorStringSize() const;

   virtual void setTimeImplNameSize( unsigned long size );
   virtual unsigned long timeImplNameSize() const;

   virtual void setMomModuleNameSize( unsigned long size );
   virtual unsigned long momModuleNameSize() const;

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


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

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

   virtual char* timeImplNamePtr();
   virtual const char* timeImplNamePtr() const;

   virtual char* momModuleNamePtr();
   virtual const char* momModuleNamePtr() const;

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

   virtual char* federateNamesPtr();
   virtual const char* federateNamesPtr() const;

   virtual char* errorStringPtr();
   virtual const char* errorStringPtr() const;

   virtual DtNetU32* federateHandlesPtr();
   virtual const DtNetU32* federateHandlesPtr() const;

   virtual DtJoinResponseMsg* self() const;

   protected:

   DtFederateHandleSet* mySet;
};


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

#endif