vrfGuiOrbatManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrvUtil/signalslib.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/orbatState.h>
#include <vrfutil/rwUUID.h>
#include <vlpi/entityType.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtElementData.h>
#include <vrvCore/DtEntityState.h>
#include <vrvCore/DtElementChanges.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vlutil/vlFilename.h>
#include <vrfutil/rwOrbatData.h>
#include <vrfGuiCore/vrfExtendedElementAttributes.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <boost/unordered_map.hpp>
#include <boost/smart_ptr/shared_ptr.hpp>

#include <map>

class DtIfOrbatOperation;
class DtScenario;

namespace makVrv
{
   class DtDe;
   class DtSimObjectEntry;
}

class DtSimMessage;
class DtRwOrbatData;

namespace makVrv
{
   AddTypeId(makVrv::DtUniqueID,        20);
}

#define DtOrbatNodeIdentifier "DtOrbatNodeIdentifier"

namespace makVrf
{
   class DtVrfMsdlOrbatImporterExporter;

   class DT_DLL_VRFGUICORE DtVrfGuiOrbatManager : public makVrv::DtVirtualBaseClass
   {
   public:
      struct OrbatWithStateView;

      typedef std::map<DtUUID, OrbatWithStateView> OrbatTreeWithStateView;

      struct OrbatWithStateView
      {
         const makVrv::DtStateView<DtOrbatState>* root;
         OrbatTreeWithStateView children;
      };

      struct OrbatWithRwOrbatData;

      typedef std::map<DtUUID, OrbatWithRwOrbatData> OrbatTreeWithRwOrbatData;

      struct OrbatWithRwOrbatData
      {
         DtRwOrbatData root;
         OrbatTreeWithRwOrbatData children;
      };

   public:
      virtual ~DtVrfGuiOrbatManager();

      static DtVrfGuiOrbatManager& instance(makVrv::DtDe& de);

      static void registerInstance(makVrv::DtDe& de, DtVrfGuiOrbatManager* object);

      virtual void removeObjectFromOrbat(makVrv::DtUniqueID);

      virtual void removeObjectsFromOrbat(const std::vector<makVrv::DtUniqueID>&);

      virtual void removeObjectFromOrbat(const DtUUID&);

      virtual void removeObjectsFromOrbat(const std::vector<DtUUID>&);

      virtual DtUUID orbatUUID(makVrv::DtUniqueID) const;

      virtual void addObjectToOrbat(const DtString& name, const DtUUID& uuid, const DtEntityType& entityType, int force,
         const DtUUID& parent = DtUUID::nullUUID(), bool createSubordinates = true);

      virtual void addObjectsToOrbat(const std::vector<DtRwOrbatData>&, bool createSubordinates = true);

      virtual void requestOrbatList();

      virtual bool inOrbatViewOnly(makVrv::DtUniqueID) const;
      virtual bool inOrbatViewOnly(const DtUUID&) const;

      virtual bool inOrbatView(makVrv::DtUniqueID) const;
      virtual bool inOrbatView(const DtUUID&) const;

      virtual bool isOrbatNode(makVrv::DtUniqueID) const;

      virtual const makVrv::DtStateView<DtOrbatState>* orbatData(makVrv::DtUniqueID) const;
      virtual const makVrv::DtStateView<DtOrbatState>* orbatData(const DtUUID&) const;
      virtual const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* orbatStateData(makVrv::DtUniqueID) const;
      virtual const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>* orbatStateData(const DtUUID&) const;

      virtual void makePartOfOrbat(makVrv::DtUniqueID);

      virtual void makePartOfOrbat(const std::vector<makVrv::DtUniqueID>&);

      virtual void makePartOfOrbat(const DtUUID&);

      virtual void makePartOfOrbat(const std::vector<DtUUID>&);

      virtual void makeAllSimulationObjectsPartOfOrbat();

      virtual void removeAllSimulationObjectsFromOrbat();

      virtual void modifyOrbatEntry(makVrv::DtUniqueID, const DtRwOrbatData&);
      virtual void modifyOrbatEntry(const DtUUID&, const DtRwOrbatData&);

      virtual void setOrbatOrder(makVrv::DtUniqueID, int);
      virtual void setOrbatOrder(const DtUUID&, int);

      virtual void reparentOrbatEntry(makVrv::DtUniqueID, makVrv::DtUniqueID parentID, int orbatOrder = -1);
      virtual void reparentOrbatEntries(const std::vector<makVrv::DtUniqueID>&, makVrv::DtUniqueID parentID, int orbatOrder = -1);

      virtual void reparentOrbatEntry(const DtUUID&, makVrv::DtUniqueID parentID, int orbatOrder = -1);
      virtual void reparentOrbatEntries(const std::vector<DtUUID>&, makVrv::DtUniqueID parentID, int orbatOrder = -1);

      virtual void reparentToForce(makVrv::DtUniqueID, int force, int orbatOrder = -1);
      virtual void reparentToForce(const std::vector<makVrv::DtUniqueID>&, int force, int orbatOrder = -1);

      virtual void reparentToForce(const DtUUID&, int force, int orbatOrder = -1);
      virtual void reparentToForce(const std::vector<DtUUID>&, int force, int orbatOrder = -1);

      virtual DtUUID parentUUIDOfOrbatNode(makVrv::DtUniqueID id) const;

      virtual makVrv::DtUniqueID orbatId(makVrv::DtUniqueID) const;
      virtual makVrv::DtUniqueID orbatId(const DtUUID&) const;

      virtual bool isCreated(makVrv::DtUniqueID) const;

      virtual makVrv::DtUniqueID createdId(makVrv::DtUniqueID) const;

      virtual void clearOrbatList();

      virtual int orbatOrder(makVrv::DtUniqueID) const;
      virtual int orbatOrder(const DtUUID&) const;

      virtual void exportOrbat(const DtFilename&, const std::set<std::string>& smsFilenames = std::set<std::string>());

      virtual OrbatTreeWithStateView orbat() const;

      virtual bool importOrbat(const DtFilename&, std::vector<DtRwOrbatData>&);

      virtual DtVrfGuiOrbatManager::OrbatTreeWithRwOrbatData orbatFromFile(const DtFilename&, DtScenario& scenario);

      virtual void createOrbatObject(const DtUUID&, const DtVector& location);

   public:
      boost::signal<void (makVrv::DtUniqueID, bool)> signal_orbatStateChanged;

      boost::signal<void (makVrv::DtUniqueID)> signal_orbatObjectAdded;

      boost::signal<void (makVrv::DtUniqueID)> signal_orbatObjectRemoved;

   protected:
      DtVrfGuiOrbatManager(makVrv::DtDe&);

      virtual void initialize();

      virtual void hierarchyItemsModified(const makVrv::DtElementData::EntryAttributesList& l);

      virtual void slot_stateAdded(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);
      virtual void slot_stateRemoved(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*);

   protected:
      makVrv::DtDe& myDe;
      makVrv::DtSignalConnectionManager myConnections;

      typedef std::map<DtUUID, makVrv::DtUniqueID> OrbatStateViews;
      OrbatStateViews myOrbatStateViews;

      std::set<makVrv::DtUniqueID> myMarkingTextResolvers;
   };
}