vrfSimulatedSimObjectFacade.h

Go to the documentation of this file.

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

#pragma once

#include "vrfobjcore/vrfobjcoreDefines.h"
#include "vrfobjcore/simObjectFacadeBase.h"
#include <vrfutil/echelonId.h>
#include <map>

class DtRwProperties;

#define CHECK_IS_VALID(Method) if (!isUsable()) throw DtUnimplementedMethod("The " #Method " is not applicable for the given object.");

class DT_DLL_vrfobjcore DtVrfSimulatedSimObjectFacadeInterface
{
public:
   DtVrfSimulatedSimObjectFacadeInterface();
   virtual ~DtVrfSimulatedSimObjectFacadeInterface();

   bool isUsable() const;

   int sessionId() const;

   bool activated() const;

   bool assumeUnknownIsHostile() const;

   bool independentlyTasked() const;

   bool underFire() const;

   bool isTasked() const;

   const DtString& extendedData(const DtString&) const;
   
   std::map<DtString, DtString> extendedDataMap() const;

   DtString extendedLabel(int index) const;

   std::map<int, DtString> extendedLabels() const;

   DtString label() const;

   bool invulnerable() const;

   bool invisible() const;

   DtEchelonId echelonId() const;

   bool sensorsKilled() const;

   bool occupantsHidden() const;

   bool hasPlan() const;

   bool executingPlan() const;

   const DtRwProperties& stateProperties() const;

   const DtRwProperties& parameterProperties() const;

   bool undetectable() const;

   DtString activity() const;

   DtString engagementRules() const;

   bool invisibleSetByUser() const;

   bool isVrfSimulated() const;

   DtString overlay() const;

   bool fuelLevelsFrozen() const;

   bool munitionLevelsFrozen() const;

   bool isSubordinateOfForceLevel() const;

   bool hasTarget() const;

   bool blockParachute() const;

   bool onTerrainSurface() const;

protected:
   virtual DtSimObjectReference simObject() const = 0;
   virtual void setupDecorator();
};

using DtVrfSimulatedSimObjectFacade = DtSimObjectFacade<DtVrfSimulatedSimObjectFacadeInterface>;