simObjectReferenceList.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/simObjectReference.h"
#include "readerWriter/readerWriter.h"
#include "vrfutil/rwTemplatedList.h"
#include <boost/signals2.hpp>
#include <tbb/spin_rw_mutex.h>
#include <tbb/spin_mutex.h>

class DT_DLL_vrfobjcore DtSimObjectReferenceList
{
public:
   typedef std::list<DtSimObjectReference> SimObjectReferenceList;
   typedef std::list<DtSimObjectReference>::iterator iterator;
   typedef std::list<DtSimObjectReference>::const_iterator const_iterator;
   typedef std::list<DtSimObjectReference>::reverse_iterator reverse_iterator;
   typedef std::list<DtSimObjectReference>::const_reverse_iterator const_reverse_iterator;

   DtSimObjectReferenceList(const DtSimulationServices* mgr = 0);
   DtSimObjectReferenceList(const DtSimObjectReferenceList& orig);

   virtual ~DtSimObjectReferenceList();

   void addUUID(const DtUUID&, int index = -1);
   void add(DtSimObjectReference, int index = -1);

   DtSimObjectReferenceList& operator=(const DtSimObjectReferenceList& orig);

   bool removeUUID(const DtUUID&);
   bool remove(DtSimObjectReference);

   void clear();

   int size() const;

   virtual void disconnect();
   virtual void connect();

   virtual void copyWithoutConnect(const DtSimObjectReferenceList&);

   DtSimObjectReference simObject(const DtUUID&) const;

   bool hasUUID(const DtUUID&) const;

   mutable boost::signals2::signal<void (const DtUUID&)> signal_simObjectRemoved;

   const DtSimulationServices* simulationServices() const
   {
      return mySimulationServices;
   }

public:
   const SimObjectReferenceList& simObjectReferenceList() const;

   iterator begin();
   iterator end();

   const_iterator begin() const;
   const_iterator end() const;

   reverse_iterator rbegin();
   reverse_iterator rend();

   const_reverse_iterator rbegin() const;
   const_reverse_iterator rend() const;

   iterator insert(iterator, DtSimObjectReference);
   void erase(iterator);

protected:
   void simObjectRemoved(const DtSimObject*);

protected:
   struct ObjectInformation
   {
      std::list<DtSimObjectReference>::iterator lookup;
   };

   typedef std::map<DtString, ObjectInformation> QuickLookupMap;
   QuickLookupMap myQuickLookupMap;
   const DtSimulationServices* mySimulationServices;

   bool myConnectedForRemoval;

   SimObjectReferenceList mySimObjectReferenceList;
   tbb::spin_rw_mutex myQuickLookupMapMutex;
   tbb::spin_mutex mySimObjectReferenceListMutex;
};


class DT_DLL_vrfobjcore DtRwSimObjectReferenceList : public DtRwTemplatedListPtr<DtRwUUID, true>
{
public:
   DtRwSimObjectReferenceList(const DtSimulationServices*);

   DtRwSimObjectReferenceList(const DtSimulationServices*, const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwSimObjectReferenceList(const DtString& name,  const DtRwSimObjectReferenceList& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);

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

   virtual ~DtRwSimObjectReferenceList();

   DtRwSimObjectReferenceList& operator=(const DtRwSimObjectReferenceList&);
   DtRwSimObjectReferenceList& operator=(const DtSimObjectReferenceList&);

   operator const DtSimObjectReferenceList() const { return mySimObjectReferenceList; };
   operator DtSimObjectReferenceList() { return mySimObjectReferenceList; };
   const DtSimObjectReferenceList& simObjectReferenceList() const { return mySimObjectReferenceList; };
   DtSimObjectReferenceList& simObjectReferenceList() { return mySimObjectReferenceList; };

   virtual void removeAll();
   virtual void removeAndDeleteAll();

   virtual DtSimObjectReference findUUID(const DtUUID&) const;

   virtual void copyWithoutConnect(const DtRwSimObjectReferenceList&);

   virtual void addUUID(const DtUUID&, int index = -1);

   virtual bool removeUUID(const DtUUID&);

   bool hasUUID(const DtUUID&) const;

   virtual std::vector<DtRwUUID> uuidsAsVector() const;

   virtual std::list<DtRwUUID> uuidsAsList() const;

   virtual DtSimObjectReference first() const;
   virtual DtSimObjectReference last() const;

   DtSimObjectReference simObject(const DtUUID& u) const { return mySimObjectReferenceList.simObject(u); };

   virtual void disconnect();
   virtual void connect();

   int size() const
   {
      return mySimObjectReferenceList.size();
   }

   DtSimObjectReferenceList::iterator begin() { return mySimObjectReferenceList.begin(); };
   DtSimObjectReferenceList::iterator end() { return mySimObjectReferenceList.end(); };

   DtSimObjectReferenceList::const_iterator begin() const { return mySimObjectReferenceList.begin(); };
   DtSimObjectReferenceList::const_iterator end() const { return mySimObjectReferenceList.end(); };

protected:
   virtual void slot_uuidUpgradedTo(const DtUUID& oldUUID, const DtUUID& newUUID);

   virtual void postGetSelf() override;

protected:
   bool myConnectedForRemoval;
   DtSimObjectReferenceList mySimObjectReferenceList;
   boost::signals2::scoped_connection myUUIDUpgradedToConnection;
};