rwAffectableEngineeringObject.h

Go to the documentation of this file.

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



#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/templatedDecoders.h"
#include "vrfutil/rwTemplatedList.h"
#include <vrfutil/rwEntityType.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwString.h>
#include <readerWriter/rwList.h>

class DT_DLL_vrfutil DtRwAffectableEngineeringObject : public DtReaderWriter
{
public:
   DtRwAffectableEngineeringObject(const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* const parentRegistry = NULL);

   virtual ~DtRwAffectableEngineeringObject() override;

   DtRwAffectableEngineeringObject(const DtRwAffectableEngineeringObject& orig,
      const DtString& name = DtString::nullString(), 
      DtReaderWriterRegistry* parentRegistry = NULL);

   DtRwAffectableEngineeringObject& operator=(const DtRwAffectableEngineeringObject& orig);

   bool operator<(const DtRwAffectableEngineeringObject& rhs)
   {
      return (myObjectType < rhs.myObjectType);
   }

   bool operator<(const DtEntityType& rhs)
   {
      return (myObjectType < rhs);
   }
   
   bool operator==(const DtRwAffectableEngineeringObject& rhs) const
   {
      return (DtReaderWriter::operator==(rhs) && (myObjectType == rhs.myObjectType) &&
         (myTimeToComplete == rhs.myTimeToComplete) &&
         (myTimeToSetup == rhs.myTimeToSetup) &&
         (myRange == rhs.myRange) &&
         (myDestructionResource == rhs.myDestructionResource) &&
         (myDestructionResourceAmount == rhs.myDestructionResourceAmount) &&
         (myCreateScriptId == rhs.myCreateScriptId) &&
         (myImproveScriptId == rhs.myImproveScriptId) &&
         (myDestroyScriptId == rhs.myDestroyScriptId) &&
         (myProhibitedTerrainQueryName == rhs.myProhibitedTerrainQueryName));
   }

   virtual const char* readerWriterType() const override;

   static const char* theXmlType();

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

   virtual const DtEntityType& objectType() const;
   virtual void setObjectType(const DtEntityType&);

   virtual double timeToComplete() const;
   virtual void setTimeToComplete(double);

   virtual double timeToSetup() const;
   virtual void setTimeToSetup(double);

   virtual double range() const;
   virtual void setRange(double);

   virtual const DtString& destructionResource() const;
   virtual void setDestructionResource(const DtString&);

   virtual double destructionResourceAmount() const;
   virtual void setDestructionResourceAmount(double);

   virtual const DtString& createScriptId() const;
   virtual void setCreateScriptId(const DtString&);

   virtual const DtString& improveScriptId() const;
   virtual void setImproveScriptId(const DtString&);

   virtual const DtString& destroyScriptId() const;
   virtual void setDestroyScriptId(const DtString&);

   virtual const DtString& prohibitedTerrainQueryName() const;
   virtual void setProhibitedTerrainQueryName(const DtString&);

protected:
   DtRwEntityType myObjectType;
   DtRwReal myTimeToComplete;
   DtRwReal myTimeToSetup;
   DtRwReal myRange;
   DtRwString myDestructionResource;
   DtRwReal myDestructionResourceAmount;
   DtRwString myCreateScriptId;
   DtRwString myImproveScriptId;
   DtRwString myDestroyScriptId;
   DtRwString myProhibitedTerrainQueryName;
};

typedef DtRwTemplatedListPtr<DtRwAffectableEngineeringObject, true> DtRwAffectableEngineeringObjectList;