baseWeaponComponentInterface.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjcore/vrfProcessStateRepository.h"
#include <readerWriter/rwString.h>
#include <readerWriter/rwBoolean.h>
#include <readerWriter/rwReal.h>
#include <readerWriter/rwInt.h>
#include "readerWriter/rwVector.h"
#include "vlpi/disEnums.h"

#include "vrfobjcore/vrfobjcoreDefines.h"
#include <list>
#include <set>


class DT_DLL_vrfobjcore DtBaseWeaponComponentInterface : public DtVrfProcessStateRepository
{
public:
   enum DtWeaponStatus
   {
      DT_OK_TO_FIRE                    = 0,
      DT_WEAPON_DISABLED               = 1, 
      DT_NO_AMMUNITION_FOR_TARGET      = 2,
      DT_CANNOT_ACQUIRE_TARGET         = 4, 
      DT_SUPPRESSED                    = 8, 
      DT_OUT_OF_AMMUNITION_FOR_WEAPON  = 16,
      DT_WEAPON_BUSY                   = 32 
   };

private:
   DtBaseWeaponComponentInterface();

public:

   //constructor
   DtBaseWeaponComponentInterface(const DtLocalObject* vrfObject, 
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   //copy constructor
   DtBaseWeaponComponentInterface(const DtBaseWeaponComponentInterface& orig,
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0);

   //assignment operator
   const DtBaseWeaponComponentInterface& operator=( 
      const DtBaseWeaponComponentInterface& orig);

   //destructor
   virtual ~DtBaseWeaponComponentInterface();

   //returns a copy of the PSR
   virtual DtVrfProcessStateRepository* clone(
      const DtString& rwName = DtString::nullString(), 
      DtReaderWriterRegistry*  parentRegistry = 0) const = 0;

   virtual void updateRegionEvaluator() = 0;

   virtual bool locationWithinRegion(const DtVector& localLocation) const = 0;

   virtual void setRoundsFiredUponTarget(const int& roundsFired);
   virtual const int roundsFiredUponTarget() const;

   virtual void setTotalRoundsToFireUponTarget(const int& totalRoundsToFire);
   virtual const int totalRoundsToFireUponTarget() const;


   virtual void setIsExplicitlyTasked(const bool& explicitlyTasked);
   virtual const bool isExplicitlyTasked() const;


   virtual void setAllowExplicitTasking(const bool& includeInDialogs);
   virtual const bool allowExplicitTasking() const;


   virtual void setDisplayName(const DtString& displayName);
   virtual const DtString& displayName() const;


   virtual void setWeaponStatus(const int weaponStatus);
   virtual const int weaponStatus() const;

   virtual DtString weaponStatusString() const;

   virtual void addWeaponStatus(const DtWeaponStatus weaponStatus);

   virtual void removeWeaponStatus(const DtWeaponStatus weaponStatus);


   virtual void setIsInFiringCycle(const bool);
   virtual bool isInFiringCycle()const;


   virtual void setResourceList(const std::list<DtString>& list);
   virtual const std::list<DtString>& resourceList() const;
   virtual std::list<DtString>& resourceList();

   virtual void setPriority(const int priority);
   virtual int priority() const;

   virtual void createMountPartList(const DtArtPartType partType);
   virtual const std::list<DtArtPartType>& mountPartList() const;

   virtual void setSystemTurretNumber(const DtArtPartType num);
   virtual DtArtPartType systemTurretNumber()const;

   virtual std::set<DtString>& requiredTokens();
   virtual void setRequiredTokens(const std::set<DtString>& tokens);

   virtual void setTreatSelectedAsTasked(bool t);
   bool treatSelectedAsTasked()const;

   virtual void setControlExternalTurret(bool c);
   virtual bool controlExternalTurret()const;

protected:
   DtRwInt myRoundsFiredUponTarget;
   
   DtRwInt myTotalRoundsToFireUponTarget;

   DtRwBoolean myIsInFiringCycle;
   
   DtRwBoolean myIsExplicitlyTasked;

   DtRwBoolean myAllowExplicitTasking;

   DtRwString myDisplayName;

   DtRwInt myWeaponStatus;

   std::list<DtString> myResources;

   DtRwInt myPriority;

   std::list<DtArtPartType> myMountPartList;

   DtArtPartType mySystemTurretNumber;

   DtRwBoolean myControlExternalTurret;

   std::set<DtString> myRequiredTokens;

   DtRwBoolean myTreatSelectedAsTasked;
};