WsfSensorBeam.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing 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 WSFSENSORBEAM_HPP
#define WSFSENSORBEAM_HPP
 
#include "wsf_export.h"
 
#include <cstddef> // for size_t
 
class UtInput;
class WsfEM_Clutter;
class WsfEM_Rcvr;
class WsfEM_Xmtr;
class WsfSensor;
class WsfSensorMode;
#include "WsfSensorSignalProcessor.hpp"
 

class WSF_EXPORT WsfSensorBeam
{
   friend class WsfSensor;
   friend class WsfSensorMode;
   friend class WsfSensorModeList;
 
public:
   WsfSensorBeam();
   WsfSensorBeam(const WsfSensorBeam& aSrc) = default;
   WsfSensorBeam& operator                  =(const WsfSensorBeam& aRhs);
   virtual ~WsfSensorBeam()                 = default;


   virtual WsfEM_Rcvr* GetEM_Rcvr() { return nullptr; }
   virtual WsfEM_Xmtr* GetEM_Xmtr() { return nullptr; }
 
   virtual bool ProcessInput(UtInput& aInput);
   virtual bool Initialize(double aSimTime);

   void SetBeamOwner(WsfSensorMode* aSensorModePtr) { mSensorModePtr = aSensorModePtr; }

   void SetBeamIndex(size_t aBeamIndex) { mBeamIndex = aBeamIndex; }
 
   // NOTE: Do not add a GetSensor method as it would require sensor modes that derive
   //       from both WsfSensorMode and WsfSensorBeam to have a 'using' directive to
   //       resolve the ambiguity.
 
   WsfSensorMode* GetSensorMode() const { return mSensorModePtr; }
   size_t         GetBeamIndex() const { return mBeamIndex; }
 
   WsfSensorSignalProcessor::List& GetSignalProcessors() { return mSignalProcessors; }


   virtual int            GetNumberOfPulsesIntegrated() const;
   virtual double         GetIntegrationGain() const;
   virtual void           SetIntegrationGain(double aIntegrationGain);
   virtual WsfEM_Clutter* GetClutter() const { return nullptr; };
 
private:
   WsfSensorMode* mSensorModePtr;
   size_t         mBeamIndex;

   WsfSensorSignalProcessor::List mSignalProcessors;
};
 
#endif