weaponInfoInterface.h

Go to the documentation of this file.

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrftasks/vrfObjectMessageTypeTemplate.h"
#include "simObjectReference.h"
#include "vlutil/vlString.h"
#include <string>

class DtRwLocationReference;
class DtSimTask;
class DtRwProperties;

class DT_DLL_vrfobjcore DtWeaponInfoInterface
{
public:
   enum TargetApplicability
   {
      TargetApplicability_Unspecified = 0,
      TargetApplicability_NotApplicable = 1,
      TargetApplicability_Overkill = 2,
      TargetApplicability_Applicable = 3,
      TargetApplicability_Ideal = 4
   };

   enum WeaponStatus
   {
      WeaponStatus_Busy = 1,
      WeaponStatus_Disabled = 2,
      WeaponStatus_OutOfAmmo = 4,
      WeaponStatus_Suppressed = 8,
      WeaponStatus_Stowed = 16
   };

   static std::string targetApplicabilityString(TargetApplicability app);

   DtWeaponInfoInterface();

   virtual ~DtWeaponInfoInterface() = 0;

   virtual DtString displayName() const = 0;

   virtual DtU32 status() const = 0;

   virtual DtString statusString() const;

   virtual bool ready() const;

   virtual bool hasStatus(WeaponStatus testStatus) const;

   virtual std::list<DtSimTaskMessageType> fireTaskTypes() const;

   virtual DtSimTask* createFireTask(const DtRwLocationReference& location) const = 0;

   virtual bool withinTargetRegion(const DtVector& localPosition)  const = 0;

   virtual double maximumRange()  const = 0;

   virtual double minimumRange()  const = 0;

   virtual TargetApplicability targetApplicability(const DtEntityType& type) const = 0;

   virtual bool targetAmmunition(const DtEntityType& type) const = 0;

   virtual const std::list<DtEntityType>& desiredAmmunition() const = 0;

   virtual const std::list<DtArtPartType>& mountPartList() const = 0;

   virtual DtArtPartType systemTurretNumber() const = 0;

   virtual bool controlExternalTurret() const = 0;

   virtual const std::set<DtString>& requiredTokens() const = 0;

   virtual bool autonomousFire() const = 0;
   virtual const std::list<DtEntityType>& autonomousTargetTypes() const = 0;

   virtual const DtRwProperties* weaponProperties() const = 0;   

   virtual int priority() const = 0;
};