fomModuleManager.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************/


#pragma once

#include "rtiMsConfig.h"

#include <vlutil/vlFedTarget.h>
#include <vlutil/vlFilename.h>
#include <vlutil/vlList.h>
#include <vlutil/vlMutex.h>

#include <map>



class DtFomModuleManager;
class DtRIDParameters;
class DtFomClassMgr;
class DtSynchronousFileDistributor;
class DtFileInformation;
class DtSpaceInfo;

namespace MAKRti
{
   class DtString;
   class DtFedReader;
   class DtFomSorter;
}

typedef DtFomModuleManager* (*DtFomModuleManagerCreator)(DtRIDParameters* p);

class DT_DLL_LRC DtFomModuleManager
{
protected:

   DtFomModuleManager(DtRIDParameters* params);


   DtFomModuleManager(const DtFomModuleManager& orig);
   DtFomModuleManager& operator=(const DtFomModuleManager& orig);

public:

   virtual ~DtFomModuleManager();

   virtual DtRIDParameters* params();
   virtual DtRIDParameters* params() const;


   virtual void setJoinDistributor(DtSynchronousFileDistributor* distributor);
   virtual DtSynchronousFileDistributor* joinDistributor();
   virtual DtSynchronousFileDistributor* joinDistributor() const;


   virtual DtFomClassMgr* currentFom();
   virtual DtFomClassMgr* currentFom() const;

   virtual const MAKRti::DtString& currentFedFileName() const;
   virtual void setCurrentFedFileName(const MAKRti::DtString& fedFileName);

   virtual const MAKRti::DtString& mimName() const;
   virtual void setMimName(const MAKRti::DtString&);

   virtual MAKRti::DtString timeImplName(const MAKRti::DtString& execName);

   virtual MAKRti::DtString fedFileName(const MAKRti::DtString& execName);

   virtual DtFomClassMgr* parsedFom(const MAKRti::DtString& fomFileName);

   virtual void testReadFedFile(const MAKRti::DtString& fileName, const MAKRti::DtString& executionName);

   virtual DtFomClassMgr* testReadFomModule(MAKRti::DtString const&, MAKRti::DtString const& executionName, bool isMim);

   virtual void testReadAndSortFomModules(std::vector<MAKRti::DtString> const&, MAKRti::DtString const& executionName, bool isMim = false);

   virtual void clearFomSorting();

   virtual MAKRti::DtFedReader* readFedFile(const MAKRti::DtString& fileName, const MAKRti::DtString& executionName);

   virtual MAKRti::DtFedReader* currentFedReader();

   virtual void addFomModule(const MAKRti::DtString& name, char* buffer);

   virtual bool findFedFileNameFromMapping(const MAKRti::DtString execName, const std::vector<MAKRti::DtString>& orig,
      std::vector<MAKRti::DtString>& namesToUse) const;

   virtual void appendFomModule(std::vector<MAKRti::DtString>& target, MAKRti::DtString const& source);

   virtual void appendFomModules(std::vector<MAKRti::DtString>& target, std::vector<MAKRti::DtString> const& source);

   virtual void addFedExNameMapping(const MAKRti::DtString& execName,
      const MAKRti::DtString& timeImplName, const MAKRti::DtString& fed);

   virtual void mergeFomModules(const std::vector<MAKRti::DtString>* fomModules);

   virtual void addJoinFomModuleNames(const std::vector<MAKRti::DtString>& moduleNames);
   virtual const std::vector<std::wstring>& joinFomModuleNames() const;

   virtual void addFomModuleNameMapping(const MAKRti::DtString& executionName, const MAKRti::DtString& module);

   virtual void addFomModuleNameMapping(const MAKRti::DtString& executionName, const std::vector<MAKRti::DtString>& modules);

   virtual const std::vector<std::wstring>& fomModuleNames() const;

   virtual const char* joinFomModuleData(MAKRti::DtU32 moduleIndicator) const;

   virtual const char* fomModuleData(MAKRti::DtU32 moduleIndicator) const;

   virtual const char* mimData() const;

   virtual bool isFomAvailable(const MAKRti::DtString& fomName);
   virtual void populateWithUnknownFoms(std::vector<MAKRti::DtString> & mods, std::vector<MAKRti::DtString> & requestedMods);
   virtual void getCrcsOfFoms(std::vector<unsigned int> & moduleCrcs, const std::vector<MAKRti::DtString> & creationFomModuleNames);

   virtual void resignFederation();

   virtual void getSortedFomFileNames(std::vector<MAKRti::DtString>& creationFomModuleNames);

public:

   static DtFomModuleManager* create(DtRIDParameters* p);

   static void setCreatorFunction(DtFomModuleManagerCreator fn);

protected:

   virtual void init();

   virtual void addFomFileName(const MAKRti::DtString& name);

   virtual const std::vector<MAKRti::DtString>& fomFileNames() const;

   virtual MAKRti::DtFilename fedFileNameToUse(const MAKRti::DtString& fileName, const MAKRti::DtString& executionName);

   virtual void readFedFilePtr(const FILE* fp, const MAKRti::DtString& fileName, const MAKRti::DtString& executionName);

   virtual MAKRti::DtFedReader* getReader(MAKRti::DtFomType theFomType, DtFomClassMgr* target);

   virtual MAKRti::DtFedReader* getReader(MAKRti::DtFomType theFomType);

   virtual void addToParsedFomMap(MAKRti::DtFedReader * myFedReader, const MAKRti::DtString & fileNameToUse,
      DtFomClassMgr* fedTarget, unsigned long theCrc = 0);

   virtual void popupAndThrowCouldNotOpenFOM(const MAKRti::DtString& fileName, bool isMim=false) const;

   virtual void popupAndThrowErrorReadingFOM(const MAKRti::DtString& errorMessage, bool isMim = false) const;

   virtual void checkSpaceInfo(const DtSpaceInfo* spaceInfo) const;

protected:

   typedef std::map< MAKRti::DtString, DtFomClassMgr* > DtParsedFomsMap;
   typedef std::map< MAKRti::DtString, MAKRti::DtString > DtFomNameToFileNameMap;
   typedef std::map< MAKRti::DtString, MAKRti::DtString > DtFileNameToFomNameMap;
   typedef std::map< MAKRti::DtString, std::pair< char*, int > > DtFileNameToDataMap;
   typedef std::pair<MAKRti::DtString, MAKRti::DtString> DtFileFomPair; // Not in MTL

   DtRIDParameters* myParams;

   DtSynchronousFileDistributor* myDistributor;

   MAKRti::DtFedReader* myFedReader;
   MAKRti::DtFedReader* myFedReader13;
   MAKRti::DtFedReader* myFedReader1516;
   MAKRti::DtFedReader* myFedReader1516e;
   MAKRti::DtFedReader* myFedReader1516_2025;

   MAKRti::DtList myMappingList;

   std::map<MAKRti::DtString, std::set<MAKRti::DtString> > myFedFileNames;

   MAKRti::DtFomSorter* myFomSorter;

   mutable MAKRti::DtMutex myMutex;

   DtFomClassMgr* myCurrentFom;

   MAKRti::DtString myCurrentFedFileName;

   MAKRti::DtString myMimName;

   std::map<MAKRti::DtString, DtFileInformation*> myTakenFiles;

   std::vector<std::wstring> myFomModulesNames;
   std::vector<std::wstring> myJoinFomModulesNames;
   std::vector<char*> myFomModuleData;
   unsigned myMimIndex;

   MAKRti::DtResignAction myResignAction;

   DtParsedFomsMap myParsedFoms;

   DtFileNameToDataMap myParsedFomModuleData;

   DtFomNameToFileNameMap myFomToFileMap;
   DtFileNameToFomNameMap myFileToFomMap;

   // This is all FOM files merged in this target.  It includes the MIM and is in merge order.
   std::vector<MAKRti::DtString> myFomFileNames;

protected:

   static DtFomModuleManagerCreator theCreator;

};