federationInfo.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2008 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*******************************************************************************
** $RCSfile: federationInfo.h,v $ $Revision: 1.8 $ $State: Exp $
*******************************************************************************/

#ifndef federationInfo_H_
#define federationInfo_H_


#include <rtiVersion.h>
#include <vlutil/vlString.h>
#include <vlutil/vlInetAddr.h>
#include <rtiMsConfig.h>
#include "federateInfo.h"
#include <map>
#include <set>
#include <list>

// Related typedefs

typedef std::map< int, DtAssistantFederateInfo > DtFederateInfoByHandleMap;

typedef std::pair< std::set< int >, std::set< int > > DtPendingAchievedPair;

typedef std::map< MAKRti::DtString, DtPendingAchievedPair > DtSyncPtToAchievedFederatesMap;

typedef std::map< int, MAKRti::DtString > DtFederationNameByHandleMap;

class DT_DLL_ASSISTANT DtAssistantFederationInfo
{
public:

   DtAssistantFederationInfo(
      const MAKRti::DtString& name = MAKRti::DtString::nullString(),
      int handle = -1,
      const std::list<MAKRti::DtString>& files = std::list<MAKRti::DtString>(),
      bool testEn = true );

   void setFederationName(const MAKRti::DtString& val) { myFederationName = val; }
   const MAKRti::DtString& federationName() const { return myFederationName; }

   void setFederationHandle(int val) { myFederationHandle = val; }
   int federationHandle() const { return myFederationHandle; }

   void addFomModule(const MAKRti::DtString& module) { myFomModuleNames.push_back(module); }
   void setFomModules(const std::list<MAKRti::DtString>& modules) { myFomModuleNames = modules; }
   const std::list<MAKRti::DtString>* fomModules() const { return &myFomModuleNames; }

   void enableTesting(bool enabled) { myTestEnabled = enabled; }
   bool testingEnabled() const { return myTestEnabled; }

   bool updateFederates(const DtFederateInfoByHandleMap& federates);

   bool updateFederate(const DtAssistantFederateInfo& federate);

   void replaceFederateList(const DtFederateInfoByHandleMap& federates);

   bool removeFederate(int handle);

   void clearFederates();

   const DtAssistantFederateInfo* federateInfo(unsigned handle) const;
   DtAssistantFederateInfo* federateInfo(unsigned handle);

   const DtFederateInfoByHandleMap* federates() const { return &myFederates; }
   DtFederateInfoByHandleMap* federates() { return &myFederates; }

   unsigned numFederates() const { return myFederates.size(); }

   unsigned numLocalFederates() const { return myLocalFederatesByHandle.size(); }

   int localFederateCompId(int federateHandle) const;

   int localFederateHandle(int compId) const;

   void updateSyncPoint(const MAKRti::DtString& name, 
      const DtPendingAchievedPair& pendAchv);

   void removeSyncPoint(const MAKRti::DtString& name) { mySyncPts.erase(name); }

   DtPendingAchievedPair *syncPoint(const MAKRti::DtString& name) { return &mySyncPts.find(name)->second; }

   const DtSyncPtToAchievedFederatesMap* syncPoints() const { return &mySyncPts; }

   void setHeartbeated(bool hb) { myHeartbeated = hb; }
   bool heartbeated() const { return myHeartbeated; }

protected:
   MAKRti::DtString myFederationName;
   int      myFederationHandle;
   std::list<MAKRti::DtString> myFomModuleNames;
   bool     myTestEnabled;

   DtFederateInfoByHandleMap myFederates;
   DtSyncPtToAchievedFederatesMap mySyncPts;
   bool myHeartbeated;

   std::map< int, int > myLocalFederatesByHandle;

   std::map< int, int > myLocalFederatesByCompId;
};

typedef std::map< MAKRti::DtString, DtAssistantFederationInfo > DtFederationStateByNameMap;


#endif