MapPlotVariables.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 MAPVARIABLES_HPP
#define MAPVARIABLES_HPP
 
#include "sensor_plot_lib_export.h"
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
class UtInput;
 
#include "MapPlotVariable.hpp"
class WsfSensor;
class WsfSensorResult;
class WsfSimulation;

class SENSOR_PLOT_LIB_EXPORT MapPlotVariables : public MapPlotVariable::SharedData
{
public:
   using MapPlotVariableMap = std::map<std::string, std::shared_ptr<MapPlotVariable>>;
 
   MapPlotVariables();
   MapPlotVariables(const MapPlotVariables&) = default;
   MapPlotVariables& operator=(const MapPlotVariables&) = default;
   ~MapPlotVariables()                                  = default;

   bool ProcessInput(UtInput& aInput);

   bool ProcessScriptVariableInput(const std::string& aVarName, double aVarInitValue);

   size_t Count() const { return mVarLabels.size(); }

   void Evaluate(double aSimTime, WsfSensor* aSensorPtr, WsfSensorResult& aResult, std::vector<double>& aVarValues);

   bool Initialize(WsfSimulation& aSimulation);

   void InitializeValues(WsfSimulation&             aSimulation,
                         std::vector<double>&       aVarValues,
                         const std::vector<double>& aUserInitValues);

   void AddVariable(const std::string& aVarLabel);

   const std::string& GetLabel(size_t aIndex) const { return mVarLabels.at(aIndex); }

   size_t GetLabelPosition(const std::string& aLabel) const;

   static bool CheckSucceeded(WsfSensorResult& aResult);

   void RegisterMapPlotVariable(const std::string& aVarName, std::shared_ptr<MapPlotVariable> aVariablePtr);
 
private:
   WsfSimulation*           mSimulationPtr{nullptr};
   std::vector<std::string> mVarLabels;
   MapPlotVariableMap       mVariableMap; 
};
 
#endif