WsfCyberAttackParameters.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2020 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef WSFCYBERATTACKPARAMETERS_HPP
#define WSFCYBERATTACKPARAMETERS_HPP
 
#include "wsf_cyber_export.h"
 
#include <unordered_map>
#include <vector>
 
#include "UtScriptAccessible.hpp"
#include "UtScriptClass.hpp"
#include "WsfAuxDataEnabled.hpp"
#include "script/WsfScriptAuxDataUtil.hpp"
 
namespace wsf
{
namespace cyber
{

class WSF_CYBER_EXPORT AttackParameterObject : public UtScriptAccessible, public WsfAuxDataEnabled
{
public:
   AttackParameterObject() = default;
   explicit AttackParameterObject(bool aScriptUsage)
      : mScriptParameter(aScriptUsage)
   {
   }
   ~AttackParameterObject() override = default;
 
   virtual AttackParameterObject* Clone() const { return new AttackParameterObject(*this); }
   const char*                    GetScriptClassName() const override { return "WsfCyberAttackParameterObject"; }

   template<class T>
   void GetParameter(const std::string& aEffectName, T*& aParameter) const
   {
      if (mScriptParameter)
      {
         // Data was provided via usage in the script context. Unpack as UtScriptData.
         UtScriptData data;
         GetAuxDataConst().Get(aEffectName, data);
         aParameter = data.GetPointer()->GetAppObject<T>();
      }
      else
      {
         // Data was provided programmatically, and can be unpacked directly.
         GetAuxDataConst().Get(aEffectName, aParameter);
      }
   }
 
private:
   // The origin of the parameter is important, as data provided in the script context
   // will have another level of indirection as a UtScriptData object. This value is
   // set to true when this parameter is constructed in the script context, and subsequent
   // usages at retrieving the data stored will require unpacking the UtScriptData object.
   // This is unfortunately required since UtAttribute get methods throw exceptions upon
   // failure to cast to a particular type instead of simply returning a nullptr.
   bool mScriptParameter{false};
};
 
class WSF_CYBER_EXPORT ScriptAttackParameterObjectClass : public UtScriptClass
{
public:
   ScriptAttackParameterObjectClass(const std::string& aClassName, UtScriptTypes* aTypesPtr);
   ~ScriptAttackParameterObjectClass() override = default;
 
   void* Create(const UtScriptContext& aInstance) override;
   void* Clone(void* aObjectPtr) override;
   void  Destroy(void* aObjectPtr) override;
 
   UT_DECLARE_AUX_DATA_SCRIPT_METHODS()
};

class WSF_CYBER_EXPORT AttackParameters : public UtScriptAccessible
{
public:
   using ParameterMap = std::unordered_map<std::string, std::vector<AttackParameterObject>>;
 
   AttackParameters()           = default;
   ~AttackParameters() override = default;
 
   virtual AttackParameters* Clone() const { return new AttackParameters(*this); }
   const char*               GetScriptClassName() const override { return "WsfCyberAttackParameters"; }
 
   std::vector<std::string>                  GetEffectNames() const;
   const std::vector<AttackParameterObject>* GetEffectEntries(const std::string& aEffectName) const;
   size_t                                    GetEffectEntryCount(const std::string& aEffectName) const;
   AttackParameterObject*                    GetEffectEntryByIndex(const std::string& aEffectName, size_t aIndex);

   void AddParameter(const AttackParameterObject& aParameter);
 
private:
   ParameterMap mMap{};
};
 
class WSF_CYBER_EXPORT ScriptAttackParametersClass : public UtScriptClass
{
public:
   ScriptAttackParametersClass(const std::string& aClassName, UtScriptTypes* aTypesPtr);
   ~ScriptAttackParametersClass() override = default;
 
   void* Create(const UtScriptContext& aInstance) override;
   void* Clone(void* aObjectPtr) override;
   void  Destroy(void* aObjectPtr) override;
 
   UT_DECLARE_SCRIPT_METHOD(GetEffectNames);
   UT_DECLARE_SCRIPT_METHOD(GetEffectEntryCount);
   UT_DECLARE_SCRIPT_METHOD(GetEffectEntryByIndex);
   UT_DECLARE_SCRIPT_METHOD(AddParameter);
};
 
} // namespace cyber
} // namespace wsf
 
#endif