vrfNameGenerator.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/simObject.h"
#include <tbb/recursive_mutex.h>
#include <tbb/atomic.h>
#include <vlutil/vlString.h>

class DtObjectType;

class DT_DLL_vrfobjcore DtVrfNameGenerator
{
public:
   DtVrfNameGenerator();

   virtual ~DtVrfNameGenerator();

   virtual bool init(DtSimulationServices*);

   virtual void clear();

   virtual DtString nextName(const DtObjectType&);
   virtual DtString nextNameWithPrefix(const DtObjectType & objectType,
      const DtString& potentialPrefix);

   virtual unsigned int maxNameLengthForType(const DtObjectType& objectType) const;

   virtual DtString generateUniqueName(int maxLength, const DtString&
      root = "Object");

   virtual DtString nextNameWithPrefix(int maxLength,
      const DtString& potentialPrefix);

   virtual DtString nextUnorganizedName();

   virtual bool parseName(const DtString& name, DtString& shortName, int& number) const;

protected:
   virtual void processSimObjectDeleted(DtSimObjectReference);
   virtual void processSimObjectAdded(DtSimObjectReference);
   virtual void processSimObjectRenamed(const DtSimObject*, const DtString& oldText, const DtString& newText);

   virtual DtString createPullFrom(const DtString& current, int low, int high) const;

   virtual void giveBack(const DtString& shortName, int number);

   virtual void take(const DtString& shortName, int number, bool affectDuplicateCount = false);

   virtual int getNextNumber(const DtString&);

   typedef std::pair<int, int> Range;
   typedef std::vector<Range> Ranges;

   virtual void takeFromRange(Ranges&, int number) const;

protected:
   DtSimulationServices* mySimulationServices;
   tbb::recursive_mutex myMutex;
   tbb::atomic<int> myNextUnorganizedName;

   struct NameGenerationInfo
   {
      NameGenerationInfo() : nextNumber(1) {};
      NameGenerationInfo(const NameGenerationInfo& orig) : nextNumber(orig.nextNumber), pullFromRanges(orig.pullFromRanges), countsOfNumbers(orig.countsOfNumbers) {};

      int nextNumber;
      std::map<int, int> countsOfNumbers;
      Ranges pullFromRanges;
   };

   typedef std::map<DtString, NameGenerationInfo> NameGenerationMap;
   NameGenerationMap myNameGenerationMap;

   boost::signals2::scoped_connection mySimObjectAddedConnection;
   boost::signals2::scoped_connection mySimObjectDeletedConnection;
   boost::signals2::scoped_connection mySimObjectRenamedConnection;
};