include/vrfobjcore/resourceMonitor.h

Go to the documentation of this file.

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




#pragma once

#include "vrfobjcore/resourceMonitorInfo.h"
#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlString.h>

class DtSimManager;
class DtSimMessage;
class DtSimInterfaceMessage;
class DtVrfObject;
class DtIfResourceMonitorResponse;
class DtSimResource;
class DtIfResourceNamesResponse;
class DtSimulationAddress;
class DtSimCondExpr;

#include <list>

typedef std::list<DtResourceMonitorInfo> DtResourceMonitorList;


#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtResourceMonitor
{
public:
   DtResourceMonitor();

   virtual ~DtResourceMonitor();

   DtResourceMonitor(DtSimManager * simManager);

   DtResourceMonitor(const DtResourceMonitor & orig);

   const DtResourceMonitor & operator=(const DtResourceMonitor & orig);

   virtual bool init();

   void setSimManager(DtSimManager * simManager) { mySimManager = simManager; };
   DtSimManager* simManager() const { return mySimManager; };

   virtual bool registerInterfaceCallbacks();

   virtual void tick(double simTime);

   virtual void restart();

   virtual void setEnabled(bool b);
   bool enabled() const { return myEnabled; };

public:
   static void resourceMonitorRequestCallback(DtSimMessage* msg, void* usr);
   virtual void processResourceMonitorRequest(DtSimInterfaceMessage* msg);

   static void currentResourceRequestCallback(DtSimMessage* msg, void* usr);
   virtual void processCurrentResourceRequest(DtSimInterfaceMessage* msg);

   static void resourceNamesRequestCallback(DtSimMessage* msg, void* usr);
   virtual void processResourceNamesRequestCallback(DtSimInterfaceMessage* msg);

   static void vrfObjectDeletedCallback(DtSimMessage * msg, void * usr);
   virtual void processVrfObjectDeletedCallback(DtSimInterfaceMessage* msg);

   void setUpdateOnTick(bool b) { myUpdateOnTick = b; };
   bool updateOnTick() const { return myUpdateOnTick; };

   virtual void resourcesChangedFor(const DtVrfObject*);
   const std::list<DtString>& resourcesChangedList() const;

protected:
   virtual void publishResourcesFor(DtIfResourceMonitorResponse& response,
      DtVrfObject* obj, const std::list<DtString>& resources);

   virtual void publishResourceNamesFor(DtIfResourceNamesResponse& response,
      DtVrfObject* obj);

   virtual void addMonitorResource(const DtEntityIdentifier& id,
      const DtString& resourceName, const DtSimulationAddress& sender,
      int iMonitorBy, const DtFloat64& iMonitorPeriod, bool stopMonitoring);

   virtual DtResourceMonitorList::iterator resourceMonitorInfo(const DtEntityIdentifier& id);

   virtual void removeMonitorReference(const DtEntityIdentifier& id, const DtString& resourceName,
      const DtSimulationAddress& sender);

   virtual void removeMonitorReference(const DtEntityIdentifier& id);

   virtual void removeAllMonitorReferencesTo(const DtSimulationAddress& addr);

   virtual bool shouldAddResource(const DtSimResource* resourceItem);

   virtual bool resourceChanged(const DtString&) const;

protected:
   DtSimManager*  mySimManager;
   DtResourceMonitorList myMonitoringResources;
   bool      myEnabled;
   bool      myUpdateOnTick;

   std::list<DtString>  myResourcesChangedList;
};

inline const std::list<DtString>& DtResourceMonitor::resourcesChangedList() const
{
   return myResourcesChangedList;
}