simResource.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1999 MAK Technologies, Inc.
** All rights reserved.
*******************************************************************************/
/******************************************************************************
** $RCSfile: simRsrc.h,v $ $Revision: 1.18 $ $State: Exp $
*******************************************************************************/



#ifndef simResource_H_
#define simResource_H_

#include <vlutil/vlMachineTypes.h>
#include <readerWriter/readerWriter.h>
#include <readerWriter/noArgumentCallbackList.h>

#include "vrfutil/simResourceFactory.h"
#include "vrfutil/simResourceList.h"

class DtReaderWriterRegistry;
class DtSimResourceManager;
class DtSimResourceFactory;

#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtSimResource : public DtReaderWriter
{

protected:

   DtSimResource();

   DtSimResource(const DtString& resourceName, DtReaderWriterRegistry*  
      parentRegistry = NULL);

   DtSimResource(const DtSymbolString& resourceName, DtReaderWriterRegistry*  
      parentRegistry = NULL);

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

   DtSimResource& operator=(const DtSimResource& orig);

public:

   virtual ~DtSimResource();

   virtual bool init();

   virtual void putData(std::string& fp, int indentLevel = 0);

   virtual void addChildResource(DtSimResource * resource);

   virtual bool removeChildResource(DtSimResource * resource);

   virtual void copyResource(const DtSimResource& orig);

   virtual void updateAmountFromChildren() = 0;

   virtual void updateFullAmountFromChildren() = 0;

   virtual void distributeAmountToChildren() = 0;

   virtual void distributeFullAmountToChildren() = 0;
  
   virtual DtReal percentageFull() const = 0;

   virtual void setPercentageFull(DtReal percent) = 0;

   virtual DtString type() const = 0;

   virtual DtSimResource* clone(DtReaderWriterRegistry* parentRegistry = 0) const = 0;

   virtual void setResourceManager(DtSimResourceManager* resourceManager);
   virtual DtSimResourceManager* resourceManager();
   virtual const DtSimResourceManager* resourceManager() const;

   virtual DtSimResourceList* subresources();
   virtual const DtSimResourceList* subresources() const;

   virtual void setParent(DtSimResource* parent);
   virtual DtSimResource* parent();
   virtual const DtSimResource* parent() const;

   typedef void (*UpdateCallback)(DtSimResource*, void*);

   virtual void addUpdateCallback(UpdateCallback fcn, void* usrData);

   virtual void removeUpdateCallback(UpdateCallback fcn, void* usrData);

   virtual void callUpdateCallbacks();

   static DtSimResource* createResource(DtlObjPtr mtlStream, 
      const DtVariableBindingsList& variableBindings);

   static void addResourceCreatorFcn(const DtString& type, DtSimResourceCreatorFcn fcn);
   static void addResourceCreatorFcn(const DtSymbolString& type, DtSimResourceCreatorFcn fcn);

   static void setFactory(DtSimResourceFactory* factory);
   static DtSimResourceFactory* factory();

   virtual const char* readerWriterType() const;

   virtual bool isEqual(const DtSimResource& res) const;

   bool operator!= (const DtSimResource& orig) const;
   bool operator== (const DtSimResource& orig) const;

   virtual void merge(const DtSimResource*);

protected:

   DtSimResourceManager*         myResourceManager;
   DtSimResourceList             mySubresources;
   DtSimResource*                myParent;

   DtCallbackList<DtSimResource*> myUpdateCallbacks;
    
   static DtSimResourceFactory*  myFactory;
};

inline bool DtSimResource::operator!=(const DtSimResource& orig) const
{
   return !(*this == orig);
}

#endif