WsfCoverageNumberOfAccesses.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 WSFCOVERAGENUMBEROFACCESSES_HPP
#define WSFCOVERAGENUMBEROFACCESSES_HPP
 
#include "wsf_coverage_export.h"
 
#include <map>
#include <vector>
 
#include "UtCalendar.hpp"
#include "WsfCoverageAccessInterval.hpp"
#include "WsfCoverageAsset.hpp"
#include "WsfCoverageMeasure.hpp"
 
namespace wsf
{
namespace coverage
{

class WSF_COVERAGE_EXPORT NumberOfAccesses : public Measure
{
public:
   explicit NumberOfAccesses(const WsfScenario& aScenario)
      : Measure{aScenario}
   {
      SetType(cTYPE);
   }
   NumberOfAccesses(const NumberOfAccesses& aOther) = default;
   ~NumberOfAccesses() override                     = default;
 
   // Measure overrides
   NumberOfAccesses* Clone() const override { return new NumberOfAccesses{*this}; }
   bool              ProcessInput(UtInput& aInput) override;
   double            GetDefaultValue() const override;
   double            GetMeasuredValue(const GridAsset& aGridAsset) const override;
   void              CollectionStarting(Coverage& aCoverage, double aSimTime) override;
   std::string       GetValueHeader() const override;
 
   constexpr static const char* cTYPE{"WSF_NUMBER_OF_ACCESSES_MOE"};

   enum class SubType
   {
      cIN_SPAN,
      cIN_SPAN_PER_TIME,
      cMAX_PER_TIME,
      cMEAN_PER_TIME,
      cMIN_PER_TIME,
      cTOTAL,
      cUNKNOWN
   };

   SubType GetSubType() const { return mSubType; }

   double GetSampleSpan() const { return mSampleSpan; }

   double GetMinParameter() const { return mMinParameter; }

   double GetMaxParameter() const { return mMaxParameter; }
 
private:
   bool InitializeP(Coverage& aCoverage) override;
   void CollectionCompletingP(Coverage& aCoverage, double aSimTime) override;
 
   double ComputeValue(std::vector<AccessInterval>& aIntervals) const;
 
   void ComputePerSampleCount(const std::vector<AccessInterval>& aGaps, std::vector<int>& aSamples) const;
 
   double ComputeInSpan(std::vector<AccessInterval>& aIntervals) const;
   double ComputePerSampleInSpan(std::vector<AccessInterval>& aIntervals) const;
   double ComputePerSampleMax(std::vector<AccessInterval>& aIntervals) const;
   double ComputePerSampleMean(std::vector<AccessInterval>& aIntervals) const;
   double ComputePerSampleMin(std::vector<AccessInterval>& aIntervals) const;
   double ComputeTotal(std::vector<AccessInterval>& aIntervals) const;
 
   void OnAccessIntervalComplete(const GridAsset& aGridAsset, const FreeAsset& aFreeAsset, const AccessInterval& aInterval);
 
   static SubType GetSubtypeFromIdentifier(const std::string& aIdentifier);
   static int     SubtypeHasParameter(SubType aSubType);

   std::map<GridAsset, std::vector<AccessInterval>> mIntervals{};

   std::map<GridAsset, double> mData{};

   AccessInterval mCoverageInterval{};

   UtCalendar mStartEpoch{};

   SubType mSubType{SubType::cUNKNOWN};

   double mSampleSpan{UtCalendar::cSEC_IN_DAY};

   double mMinParameter{-1.0};

   double mMaxParameter{-1.0};
};
 
} // namespace coverage
} // namespace wsf
 
#endif // WSFCOVERAGENUMBER_OF_ACCESSES_HPP