simResource.h

Go to the documentation of this file.

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



#pragma once
#include <vrfutil/vrfutilDefines.h>
#include <vrfutil/rwEntityType.h>
#include <vrfutil/rwTemplatedList.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwInt.h>
#include <readerWriter/rwBoolean.h>

#include <readerWriter/noArgumentCallbackList.h>

class DtReaderWriterRegistry;
class DtSimResourceManager;
class DtSimResourceFactory;

class DT_DLL_vrfutil DtSimResource : public DtReaderWriter
{

public:

   class RwMunitionOrEntityType : public DtRwEntityType
   {
   public:
      RwMunitionOrEntityType(const DtString&, DtReaderWriterRegistry*);
      virtual ~RwMunitionOrEntityType() override;

      virtual void getSelf(DtlObjPtr args,
         const DtReaderWriter::SearchPaths& searchPaths = SearchPaths(),
         const DtVariableBindingsList& variableBindings = nullVariableReference()) override;

      DtEntityType& operator=(const DtEntityType& t) { return DtRwEntityType::operator=(t); };

      void setAmmunitionName(const DtString& s) { myAmmunitionName = s; };

   protected:
      DtString myAmmunitionName;
   };

   DtSimResource();

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

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

   DtSimResource(const DtSimResource& orig);

   DtSimResource& operator=(const DtSimResource& orig);

public:

   virtual ~DtSimResource() override;

   virtual const char* readerWriterType() const override;

   static const char* theXmlType();

   virtual const char* xmlType() const override
   {
      return theXmlType();
   }

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

   virtual void deplete(double d = 1);

   virtual bool matches(const std::vector<DtEntityType>&) const;

   virtual void setResourceType(const DtEntityType&);
   const DtEntityType& resourceType() const
   {
      return myResource;
   }

   virtual void setCurrentAmount(double amount);
   void setAmount(double a)
   {
      setCurrentAmount(a);
   }

   double currentAmount() const;

   double amount() const
   {
      return currentAmount();
   }

   virtual void setValueIsInteger(bool);
   bool valueIsInteger() const
   {
      return myValueIsInteger;
   }

   virtual void setFullAmount(double amount);
   double fullAmount() const;

   virtual void setRestore(bool);
   bool shouldRestore() const
   {
      return myRestore;
   }

   virtual void restore();

   virtual int netRepSize() const;
   virtual const char* setFromNet(const char* contentBuffer);

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

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

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

   virtual void callUpdateCallbacks();

   virtual char* setToNet(char* contentBuffer) const;

   virtual double percentageFull() const;

   const DtRwReal& currentAmountVariable() const
   {
      return myCurrentAmount;
   }

   DtRwReal& currentAmountVariable()
   {
      return myCurrentAmount;
   }

   const DtRwReal& fullAmountVariable() const
   {
      return myFullAmount;
   }

   DtRwReal& fullAmountVariable()
   {
      return myFullAmount;
   }

   const DtRwBoolean& restoreVariable() const
   {
      return myRestore;
   }

   DtRwBoolean& restoreVariable()
   {
      return myRestore;
   }

   int bin() const
   {
      return myBin;
   }

   virtual void setBin(int);

   virtual void clearFullAmount();

   virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
      const DtVariableBindingsList& variableBindings) override;

   virtual DtString prettyPrint() const override;

   virtual void setDisplayName(const DtString&);
   const DtString& displayName() const
   {
      return myDisplayName;
   }

protected:
   virtual void postGetSelf() override;

protected:
   RwMunitionOrEntityType myResource;
   DtRwReal myCurrentAmount;
   DtRwReal myFullAmount;
   DtRwBoolean myRestore;
   DtRwInt myBin;

   DtCallbackList<DtSimResource*> myUpdateCallbacks;
   int myValueIsInteger = false;

   DtString myDisplayName;
};

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