baseWeaponController.h

Go to the documentation of this file.

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


 
#pragma once

#include "vrfmodel/mountingController.h"
#include "vrfobjcore/singleTaskControllerComponent.h"
#include "vrfobjcore/platformLocalObjectFacade.h"
#include "vrfutil/simClock.h"
#include "vrfutil/simMunition.h"
#include <vlpi/disEnums.h>
#include "vrfmodel/vrfmodelDefines.h"

class DtAmmunitionOutputPort;
class DtBooleanOutputPort;
class DtInputPortGroup;
class DtIntegerInputPort;

class DtBaseWeaponControllerDescriptor;
class DtVrfWeaponPSR;

class DT_DLL_vrfmodel DtBaseWeaponController : public DtSingleTaskControllerComponent
{

public:

   DtBaseWeaponController(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = nullptr,
      DtReaderWriterRegistry* parentRegistry = nullptr);

   virtual ~DtBaseWeaponController() override;

   virtual bool init() override;

   virtual bool postAddComponentsInit() override;

   virtual bool createMountingController();

   virtual const char* type() const override;

   virtual void fire();

   virtual bool waitingForFire();
   
   virtual void setWaitingForFire(bool waiting);
   
   virtual bool createWeaponOutputPortGroup();

   virtual DtOutputPortGroup* weaponOutputPortGroup();
   
   virtual bool createWeaponInputPortGroup();

   virtual DtInputPortGroup* weaponInputPortGroup();
   
   virtual bool createTriggerPort();
   virtual DtBooleanOutputPort * triggerPort() const;

   virtual bool createLoadAmmunitionPort();
   virtual DtAmmunitionOutputPort * loadAmmunitionPort() const;

   virtual bool createLoadedPort();
   virtual DtBooleanOutputPort * loadedPort() const;

   virtual bool createArtPartTypePort();
   virtual DtIntegerInputPort * artPartTypePort() const;

   virtual void setPreloadWeapon(bool doPreload);
   virtual bool preloadWeapon() const;

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

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

   virtual void setMaxVehicleSpeedToFire(DtReal maxVehicleSpeedToFire);
   virtual DtReal maxVehicleSpeedToFire() const;

   virtual bool weaponCorrectlyOriented() const;

   virtual void setMaxAzimuthAngleOffBoresight(DtReal maxAngle);
   virtual DtReal maxAzimuthAngleOffBoresight() const;
   virtual void setMaxElevationAngleOffBoresight(DtReal maxAngle);
   virtual DtReal maxElevationAngleOffBoresight() const;


   virtual void initProcessSR();
   
   virtual DtBaseMountingController * mountingController();

   virtual void setCurrentMunitionType(const DtEntityType & currentMunitionName);
   virtual const DtEntityType & currentMunitionType() const;

   virtual DtVrfWeaponPSR* weaponProcessState();
   virtual const DtVrfWeaponPSR* weaponProcessState() const;
 
   virtual void tick() override;
   
   static DtSimComponent * creator(const DtString& name, 
      DtLocalObject* owner,
      DtSimulationServices* simManager, 
      DtComponentDescriptor* desc = nullptr,
      DtReaderWriterRegistry* parentRegistry = nullptr);

protected:
   
   virtual bool createPortGroups() override;

   virtual bool createPorts() override;

   virtual void lookupAndCacheProcessSR();

   virtual void preFirstTickInit() override;

   virtual DtString weaponId() const;

   virtual bool weaponStowable();

   virtual bool weaponStowed();

   virtual bool weaponInTransition();

   virtual void setWeaponStowed(bool v);

   static void setStowWeaponCallback(DtSimMessage* msg, void* usrData);
   virtual void processSetStowWeapon(DtSimMessage* msg);

protected:
   
   DtBaseWeaponController();

   DtBaseWeaponController(const DtBaseWeaponController & orig);

   const DtBaseWeaponController & operator=(const DtBaseWeaponController & 
      orig);


protected:

   
   DtOutputPortGroup* myWeaponOutputPortGroup;
   
   DtAmmunitionOutputPort* myLoadAmmunitionPort;
   
   DtBooleanOutputPort* myTriggerPort;
   
   DtBooleanOutputPort* myLoadedPort;

   DtInputPortGroup* myWeaponInputPortGroup;
   
   DtIntegerInputPort* myArtPartTypePort;

   DtIntegerInputPort*  myStowedStateInputPort;

   DtBooleanOutputPort* myStowCommandOutputPort;
   

   bool          myDoWeaponPreload;

   bool myWaitingForFire;

   DtReal             myFireMaxVehicleSpeed;

   DtReal             myMaxAzimuthAngleOffBoresight;
   DtReal             myMaxElevationAngleOffBoresight;

   const DtBaseWeaponControllerDescriptor* myBaseWeaponCtlrDesc;
   DtBaseMountingController*         myBaseMountingController;

   DtVrfWeaponPSR*                   myWeaponProcessState;

   DtPlatformLocalObjectFacade myPlatformLocalObjectFacade;
};