aggregateRollUpManager.h

Go to the documentation of this file.

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



#pragma once

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/aggregateState.h>
#include <vrvCore/DtUniqueID.h>
#include <vrvCore/DtDe.h>
#include <vrfutil/rwProperties.h>
#include <vrvCore/DtStateView.h>
#include <vrvCore/DtEntityState.h>
#include <vrvCore/DtSimEntryUpdater.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrfutil/trueAggregateRollUpHelper.h>

typedef boost::function<bool (const DtReaderWriter* source, DtReaderWriter* destination,
   const DtMergePath& path, const std::map<std::string, std::string>& attributes)> DtRollUpFunction;

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtAggregateRollUpManager : public makVrv::DtVirtualBaseClass
   {
   public:
      enum UpdateFlags
      {
         StructureChanged = 0x00000001,
         DataChanged = 0x00000002
      };

      typedef std::set<const makVrv::DtStateView<DtVrlinkSimulatedAggregateState>*> Leafs;
      typedef std::map<std::string, DtRollUpFunction> RollUpRules;

      DtAggregateRollUpManager(makVrv::DtDe&);
      virtual ~DtAggregateRollUpManager();

      static DtAggregateRollUpManager& instance(makVrv::DtDe& de);
      static void registerInstance(makVrv::DtDe&, DtAggregateRollUpManager*);

      virtual bool hasStateProperties(makVrv::DtUniqueID) const;

      virtual bool hasStateProperty(makVrv::DtUniqueID, const std::string& statePropName) const;

      virtual void parameterData(makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*, DtRwProperties&) const;
      virtual void parameterData(const std::vector<makVrv::DtSimEntry*>&, DtRwProperties&) const;
      virtual void parameterData(const std::vector<makVrv::DtUniqueID>&, DtRwProperties&) const;
      virtual void parameterData(makVrv::DtUniqueID, DtRwProperties&) const;

      virtual void leafNodes(const makVrv::DtStateView<DtVrlinkSimulatedAggregateState>*, Leafs&,
         bool includePseudoAggregates = false) const;
      virtual void leafNodes(makVrv::DtUniqueID, Leafs&, bool includePseudoAggregates = false) const;
      
      virtual void statePropertiesFor(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*, DtRwProperties&) const;
      virtual void statePropertiesFor(const std::vector<makVrv::DtSimEntry*>&, DtRwProperties&) const;
      virtual void statePropertiesFor(const std::vector<makVrv::DtUniqueID>&, DtRwProperties&) const;
      virtual void statePropertiesFor(makVrv::DtUniqueID, DtRwProperties&) const;

      virtual void statePropertiesFor(const Leafs& states, DtRwProperties&) const;

      virtual bool isMonitorable(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>*) const;
      virtual bool isMonitorable(makVrv::DtUniqueID) const;

      virtual void monitor(makVrv::DtUniqueID, bool);
      virtual void startMonitoring(makVrv::DtUniqueID);
      virtual void stopMonitoring(makVrv::DtUniqueID);

      virtual void installCustomRules();

      virtual void setUpdateRate(makVrv::DtSimEntryUpdater::UpdateRate newRate);

      virtual makVrv::DtSimEntryUpdater::UpdateRate updateRate() const;

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

      boost::signal<void (makVrv::DtUniqueID, int)> signal_aggregateUpdated;

   protected:
      virtual bool hasStateProperties(const std::vector<std::string>&) const;

      virtual bool hasStateProperty(const std::vector<std::string>& str, const std::string& statePropName) const;

      virtual void leafNodes(const std::vector<std::string>&, Leafs&, bool includePseudoAggregates = false) const;

      virtual void slot_aggregateStateUpdated(makVrv::DtStateView<DtVrlinkSimulatedAggregateState>*);
      virtual void slot_aggregateRootStateUpdated(makVrv::DtStateView<DtVrlinkSimulatedAggregateState>*);
      virtual void slot_onStateViewAboutToBeRemoved(const makVrv::DtStateView<makVrv::DtVrlinkSimulatedBaseState>&);
      virtual void startMonitoring(const makVrv::DtStateView<DtVrlinkSimulatedAggregateState>*, makVrv::DtUniqueID parent);

   protected:
      makVrv::DtDe& myDe;

      struct MonitorStruct
      {
         MonitorStruct() : refCount(0), updated(false), myStateProperties("") {};
         MonitorStruct(const MonitorStruct& orig) :
         refCount(orig.refCount), parents(orig.parents), leafNodes(orig.leafNodes), connections(orig.connections), updated(orig.updated),
         myStateProperties(orig.myStateProperties) {}
         virtual ~MonitorStruct() {};

         Leafs leafNodes;
         std::vector<makVrv::DtUniqueID> parents;
         int refCount;
         makVrv::DtSignalConnectionManager* connections;
         bool updated;
         DtRwProperties myStateProperties;
      };

      typedef std::map<makVrv::DtUniqueID, MonitorStruct> Monitoring;
      Monitoring myMonitoring;

      makVrv::DtSignalConnectionManager myConnections;

      DtTrueAggregateRollUpHelper myTrueAggregateRollUpHelper;
      makVrv::DtSimEntryUpdater::UpdateRate myUpdateRate;
   };
}