mtlParameterDb.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjparam/vrfParameterDb.h"
#include "vrfutil/remoteConfigurationList.h"
#include <readerWriter/readerWriterFile.h>
#include <readerWriter/readerWriterRegistry.h>
#include <readerWriter/rwVariableBindings.h>

#include <vlutil/vlFilename.h>
#include <tbb/queuing_mutex.h>

#include <map>
#include <string>

class DtMtlParameterDbReader;
class DtMtlParameterDbWriter;
class DtMtlParameterDbEntry;

typedef enum
{
   PARAMETER_DB_100_VERSION = 100,
   PARAMETER_DB_101_VERSION = 101
} DtParameterDatabaseFileVersionNumber;

static const DtParameterDatabaseFileVersionNumber 
CURRENT_PARAMETER_DB_FILE_FORMAT_VERSION = PARAMETER_DB_101_VERSION;

#include "vrfobjparam/vrfobjparamDefines.h"
class DT_DLL_vrfobjparam DtMtlParameterDb : public DtVrfParameterDb
{
public:

   DtMtlParameterDb();

   virtual ~DtMtlParameterDb() override;

   virtual bool init() override;

   virtual DtMtlParameterDbEntry* add(const DtEntityType& objectType,
      const DtFilename& filename, bool typeIsMatchType, DtVrfObjectParameters * newParameters = NULL);

   virtual void createRemoteConfigurationList();
   virtual DtVrfObjectParameters * lookup(
      const DtEntityType& objectType, DtEntityType* matchingType, DtString* source = NULL) const override;

   virtual bool load(const DtFilename& filename, bool preloadParameters = false) override;
   
   virtual bool loadAll(const DtFilename& filename);
   DtRemoteConfigurationList* remoteConfigurationList();
   const DtRemoteConfigurationList* remoteConfigurationList() const;
   DtRemoteConfigurationList::CreatorFcn remoteConfigurationListCreatorFcn();
   void setRemoteConfigurationListCreatorFcn(DtRemoteConfigurationList::CreatorFcn fcn);

   virtual bool save(const DtFilename& filename) override;

   virtual void removeAll() override;

   virtual void setVersionNumber(int versionNumber);
   virtual int versionNumber() const;

   virtual void addDependentParameterFileToCopyPair(
      const DtFilename& fromFilename, const DtFilename& toFilename);
   virtual void clearDependentParameterFileToCopyPairs();
   virtual std::map<std::string, std::string> dependentParameterFileToCopyPairs() const;

   virtual void updateReaderWriterFilePaths(DtVrfObjectParameters& parameters);

   DtMtlParameterDbReader* dbReader();
   DtMtlParameterDbWriter* dbWriter();

   virtual DtFilename stripExtension(const DtFilename& filename, 
      const DtString& extension);

   //const DtFilename& filename() const;


   virtual void addVariableBindings(DtVariableBindingsSharedPtr bindings);
   virtual std::list<DtVariableBindingsSharedPtr>& variableBindings();

public:

   static DtVrfParameterDb* create();

   static const DtString& opdFilenameExtension();

   static const DtString& opeFilenameExtension();

   virtual void setReader(DtMtlParameterDbReader*);

   virtual void setWriter(DtMtlParameterDbWriter*);


   virtual DtReaderWriter::SearchPaths searchPaths() const;
   virtual void setSearchPaths(const DtReaderWriter::SearchPaths& searchPaths);

   virtual DtVrfObjectParameters* getParameters(
      DtMtlParameterDbEntry* entry) const;

protected:

   virtual DtMtlParameterDbReader* createParamDbReader();

   virtual DtMtlParameterDbWriter* createMtlParamDbWriter();

   virtual bool copyDependentParameterDirectories(const DtFilename& oldPath,
      const DtFilename& newPath);

   virtual DtFilename getPath(const DtFilename& filename);

   virtual DtVrfParameterDbEntry* createParameterEntry() const override;

   static const std::map<DtString, DtFilename>& extensionToPathMap();

private:
   DtMtlParameterDb(const DtMtlParameterDb& orig);

   DtMtlParameterDb& operator=(const DtMtlParameterDb& orig);

protected:

   DtMtlParameterDbReader* myParameterDbReader;
   DtMtlParameterDbWriter* myParameterDbWriter;

   static DtString theOpdFilenameExtension;
   static DtString theOpeFilenameExtension;
   static DtFilename theOldParameterDbDirectory;

   int myVersionNumber;

   DtVariableBindingsList myVariableBindings;
   //DtFilename myFilename;
   std::map<std::string, std::string> myDependentParameterFileToCopyPairs;

   std::list<DtVariableBindingsSharedPtr> myVariableBindingsList;

   DtRemoteConfigurationList  *pMyRemoteConfigurationList;
   DtRemoteConfigurationList::CreatorFcn myRemoteConfigListCreatorFcn;

   DtReaderWriter::SearchPaths mySearchPaths;

   mutable tbb::queuing_mutex myMutex;

protected:

   static std::map<DtString, DtFilename>* theExtensionToPathMap;
};

inline DtMtlParameterDbReader* DtMtlParameterDb::dbReader()
{
   return myParameterDbReader;
}

inline DtMtlParameterDbWriter* DtMtlParameterDb::dbWriter()
{
   return myParameterDbWriter;
}

/*
inline const DtFilename& DtMtlParameterDb::filename() const
{
   return myFilename;
}
*/

inline DtRemoteConfigurationList* DtMtlParameterDb::remoteConfigurationList() {return (pMyRemoteConfigurationList);}
inline const DtRemoteConfigurationList* DtMtlParameterDb::remoteConfigurationList() const {return (pMyRemoteConfigurationList);}
inline DtRemoteConfigurationList::CreatorFcn DtMtlParameterDb::remoteConfigurationListCreatorFcn(){return (myRemoteConfigListCreatorFcn);}
inline void DtMtlParameterDb::setRemoteConfigurationListCreatorFcn(DtRemoteConfigurationList::CreatorFcn fcn){myRemoteConfigListCreatorFcn = fcn;}