modelSet.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2022 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/


#pragma once


#include <readerWriter/rwList.h>
#include <readerWriter/rwInt.h>
#include <vlutil/vlString.h>
#include "vrfobjparam/vrfobjparamDefines.h"
#include <boost/unordered_map.hpp>
#include <vlpi/entityType.h>
#include <tbb/spin_rw_mutex.h>

class DtModelSetEntry;
class DtFilename;
class DtEntityType;
class DtSimulationObjectGroupModelSetEntry;

#define LATEST_MODEL_SET_VERSION 1

class DtModelSet;
typedef DtModelSet* (*DtModelSetCreatorFcn)(const DtString&, DtReaderWriterRegistry* parentRegistry);

class DT_DLL_vrfobjparam DtModelSet : public DtRwList
{
public:

   DtModelSet();

   DtModelSet(const DtString& name, DtReaderWriterRegistry*  
      parentRegistry = nullptr);

   virtual ~DtModelSet() override;

   DtModelSet(const DtModelSet& orig, 
      DtReaderWriterRegistry*  parentRegistry = NULL);

   virtual DtModelSet& operator=(const DtModelSet& orig);

   virtual DtModelSet* clone(DtReaderWriterRegistry* parentRegistry = nullptr);

   static DtModelSetCreatorFcn SetModelSetCreatorFcn(DtModelSetCreatorFcn);
   static DtModelSetCreatorFcn ModelSetCreatorFcn();
   static DtModelSet* Create(const DtString& name = "model-set", DtReaderWriterRegistry* parentRegistry = nullptr);

   virtual bool load(const DtFilename&, std::set<DtString>* iconLists = 0);
   virtual bool save(const DtFilename&);

   virtual DtModelSetEntry* find(const DtEntityType&) const;
   virtual DtModelSetEntry* findMatchingPattern(const DtEntityType&) const;
   virtual DtModelSetEntry* findByUniqueID(const DtString&) const;
   virtual DtModelSetEntry* findByLabel(const DtString&) const;

   virtual void add(DtModelSetEntry*);

   virtual void setComment(const DtString&);
   virtual const DtString comment() const;

   static DtModelSet* create(const DtString&, DtReaderWriterRegistry* const parentRegistry = NULL);

   DtEntityType objectTypeFor(const DtString& label) const;

   virtual DtModelSetEntry* addModel(DtModelSetEntry*, bool clone = true);

   virtual void emptyList();

   virtual void entitiesForObjectType(const DtEntityType& o, std::list<DtString>& list) const;


   int version() const;

   virtual DtString createUniqueID(const DtModelSetEntry*) const;
   virtual DtString createUniqueID(const DtString&) const;

   virtual DtModelSetEntry* removeModel(const DtEntityType&);
   virtual DtModelSetEntry* removeModel(const DtModelSetEntry* e);

   virtual void loadFromDataFiles(const std::string& directory, const SearchPaths& paths, std::set<DtString>* iconLists = 0, bool parallelLoad = false);

   virtual const std::set<DtString>& categories() const;

   virtual void loadEntityFiles(const std::string&, const SearchPaths& paths, std::set<DtString>* iconLists = 0, bool parallelLoad = false);

   virtual void loadSimulationObjectGroupFiles(const std::string&, std::set<DtString>* iconLists = 0);

   virtual const DtEntityType& nextAvailableSimulationObjectGroupObjectType() const;

   virtual const DtEntityType& nextAvailableRandomizedObjectObjectType() const;

   virtual DtSimulationObjectGroupModelSetEntry findSimulationObjectGroup(const DtString& sogName) const;
   virtual void createEntriesFromFile(const DtFilename& entityFile, const SearchPaths& paths, std::set<DtString>* iconLists);

protected:
   virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

   void copyList(const DtModelSet& orig);
   void clear();

   virtual void writeSelf(std::string& fp, int i, bool writeUnspecified, const DtFilename& path) override;

   virtual void addCategoriesFrom(DtModelSetEntry*);

   virtual void updateNextSimulationObjectGroupObjectType(DtSimulationObjectGroupModelSetEntry*);
   virtual void updateNextRandomizedObjectObjectType(DtModelSetEntry*);

   virtual void addIconListsToIconList(const DtModelSetEntry*, std::set<DtString>& iconLists) const;

   virtual void* remove(DtReaderWriter*, DtListItem*) override;

protected:
   DtString                   myFilename;
   DtString                   myComment;
   DtRwInt                    myVersion;
   std::set<DtString>         myCategories;
   typedef boost::unordered_map<DtString, DtModelSetEntry*> FastMap;
   FastMap myFastMap;
   DtEntityType myNextSimulationObjectGroupObjectType;
   DtEntityType myNextRandomizedObjectObjectType;
   static DtModelSetCreatorFcn theModelSetCreatorFcn;

   typedef std::map<std::string, DtModelSetEntry*> EntriesByFile;
   EntriesByFile myEntriesByFile;
   mutable tbb::spin_rw_mutex myLoadMutex;
   mutable tbb::spin_rw_mutex myAddRemoveMutex;
};


inline int DtModelSet::version() const
{
   return myVersion;
}