resourceMonitorInfo.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2004 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/*******************************************************************************
** $RCSfile: resourceMonitorInfo.h,v $ $Revision: 1.8 $ $State: Exp $
*******************************************************************************/




#ifndef DtResourceMonitorInfo_H_
#define DtResourceMonitorInfo_H_

#include "vrfobjcore/resourceCheckInfo.h"
#include <vlutil/vlString.h>
#include <vl/hostStructs.h>

#include <list>

class DtSimulationAddress;
class DtSimManager;

typedef std::list<DtResourceCheckInfo> DtResourceCheckInfoList;


#include "vrfobjcore/vrfobjcoreDefines.h"
class DT_DLL_vrfobjcore DtResourceMonitorInfo
{
public:
   DtResourceMonitorInfo() {};
   DtResourceMonitorInfo(const DtResourceMonitorInfo& orig);
   virtual ~DtResourceMonitorInfo() {};

   virtual DtResourceMonitorInfo& operator=(const DtResourceMonitorInfo&);

   void setObjectIdentifier(const DtEntityIdentifier& id) { myObjectIdentifier = id; };
   const DtEntityIdentifier& objectIdentifier() const { return myObjectIdentifier; };

   virtual void removeMonitorReference(const DtString& name,
      const DtSimulationAddress& addr);
   virtual void addMonitorReference(const DtString& resourceName,
      int iMonitorBy, const DtFloat64& dMonitorPeriod, const DtSimulationAddress& addr,
      DtSimManager* manager);
   const DtResourceCheckInfoList& monitorResources() const { return myMonitorResources; };

   virtual void removeAllMonitorReferencesTo(const DtSimulationAddress& simAddr);

   virtual std::list<DtString> shouldPublishResources(
      double simTime, const DtString& echelonId, DtSimManager* simManager, bool force = false) const;

   virtual void setNextPublicationPeriod(double simTime, const DtString& echelonId,
      DtSimManager* manager, const std::list<DtString>& publishedResources);

protected:
   DtEntityIdentifier      myObjectIdentifier;
   DtResourceCheckInfoList myMonitorResources;
};

#endif