WsfCoverageMeasure.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 WSFCOVERAGEMEASURE_HPP
#define WSFCOVERAGEMEASURE_HPP
 
#include <string>
 
#include "UtCallbackHolder.hpp"
#include "UtCloneablePtr.hpp"
#include "WsfObject.hpp"
class UtInput;
 
#include "wsf_coverage_export.h"
 
#include "WsfCoverageMeasureOutput.hpp"
#include "WsfScenario.hpp"
 
namespace wsf
{
namespace coverage
{
 
class Coverage;
class GridAsset;

class WSF_COVERAGE_EXPORT Measure : public WsfObject
{
public:
   explicit Measure(const WsfScenario& aScenario)
      : mScenario(aScenario)
   {
   }
   Measure(const Measure& aOther) = default;
   ~Measure() override            = default;
 
   // WsfObject overrides
   Measure* Clone() const override = 0;
   bool     ProcessInput(UtInput& aInput) override;

   virtual double GetMeasuredValue(const GridAsset& aGridAsset) const = 0;

   virtual std::string GetValueHeader() const = 0;

   virtual double GetDefaultValue() const = 0;
 
   bool Initialize(Coverage& aCoverage);

   virtual void CollectionStarting(Coverage& aCoverage, double aSimTime) {}
 
   void CollectionCompleting(Coverage& aCoverage, double aSimTime);
 
protected:
   std::size_t GetNumOutput() const { return mOutputs.size(); }

   const MeasureOutput* GetOutput(std::size_t aIndex) const { return mOutputs[aIndex].get(); }

   UtCallbackHolder mCallbacks{};
 
private:
   virtual bool InitializeP(Coverage& aCoverage) { return true; }

   virtual void CollectionCompletingP(Coverage& aCoverage, double aSimTime) {}
 
   const WsfScenario&                           mScenario;  
   std::vector<ut::CloneablePtr<MeasureOutput>> mOutputs{}; 
};
 
} // namespace coverage
} // namespace wsf
 
#endif // WSFCOVERAGEMEASURE_HPP