ballisticGunControllerDescriptor.h

Go to the documentation of this file.

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


#pragma once

#include "vrfobjparam/componentDescriptor.h"
#include <readerWriter/rwReal.h>
#include <readerWriter/readerWriterFile.h>
#include "vrfobjparam/ammoSelectTable.h"
#include "vrfutil/simClock.h"
#include <readerWriter/rwInt.h>
#include "vrfobjparam/vrfobjparamDefines.h"
#include "vrfobjparam/targetSelectionCriteria.h"
#include "vrfobjparam/targetingControlTable.h"
#include "readerWriter/rwProperties.h"

#include <tbb/spin_mutex.h>


class DT_DLL_vrfobjparam DtBallisticGunControllerDescriptor : public DtComponentDescriptor
{
public:
   DtBallisticGunControllerDescriptor(const DtString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   
   DtBallisticGunControllerDescriptor(const DtSymbolString& name, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   
   DtBallisticGunControllerDescriptor(
      const DtBallisticGunControllerDescriptor& orig, 
      DtReaderWriterRegistry* parentRegistry = NULL);
   
   DtBallisticGunControllerDescriptor& operator=(const 
      DtBallisticGunControllerDescriptor& orig);
   
   virtual ~DtBallisticGunControllerDescriptor() override;

   virtual DtString type() const override;

   virtual DtComponentDescriptor* clone(DtReaderWriterRegistry* parentRegistry = NULL) const override;


   virtual DtTime loadAmmoTime() const;
   virtual void setLoadAmmoTime(DtTime loadTime);


   virtual DtTime unloadAmmoTime() const;
   virtual void setUnloadAmmoTime(DtTime unloadTime);


   virtual int roundsPerTriggerPull() const;
   virtual void setRoundsPerTriggerPull(int value);


   virtual const DtAmmoSelectTable& ammoSelectTable() const;
   virtual void setAmmoSelectTable(const DtAmmoSelectTable& table);


   virtual const DtString& ammoSelectTableFilename();
   virtual void setAmmoSelectTableFilename(const DtString& filename);


   virtual DtTargetSelectionCriteria& targetSelectionCriteria();
   virtual const DtTargetSelectionCriteria& targetSelectionCriteria() const;


   virtual bool disabledBySuppression() const;
   virtual void setDisabledBySuppression(const bool isDisabled);

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

   virtual const DtTargetingControlTable& targetingControlTable() const;
   virtual DtTargetingControlTable& targetingControlTable();

   virtual DtString requiredTokensString() const;
   virtual std::set<DtString> requiredTokens() const;
   virtual void setRequiredTokensString(const DtString& tokens);
   
   virtual int gunPriority() const;
   virtual void setGunPriority(const int p);
   

   virtual const DtRwProperties& weaponProperties() const;
   virtual DtRwProperties& weaponProperties();

   static DtComponentDescriptor* creator();

   virtual void postGetSelf() override;

protected:
   DtBallisticGunControllerDescriptor();

protected:

   DtRwTime            myLoadAmmoTime;

   DtRwTime            myUnloadAmmoTime;

   DtReaderWriterFile  myAmmoSelectTableFile;

   DtAmmoSelectTable   myAmmoSelectTable;

   DtRwInt myRoundsPerTriggerPull;

   DtTargetSelectionCriteria myTargetSelectionCriteria;

   DtRwBoolean myDisabledBySuppression;


   DtRwBoolean myTreatSelectedAsTasked;

   DtRwString myRequiredTokens;

   DtRwInt myGunPriority;

   DtTargetingControlTable myTargetingControlTable;

   DtRwProperties myWeaponProperties;


   mutable std::set<DtString> myRequiredTokenSet;
   mutable tbb::spin_mutex myRequiredTokensMutex;
};