WsfCoverageTextOutputWriter.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 WSFCOVERAGETEXTOUTPUTWRITER_HPP
#define WSFCOVERAGETEXTOUTPUTWRITER_HPP
 
#include "wsf_coverage_export.h"
 
#include <fstream>
#include <iomanip>
#include <memory>
#include <sstream>
#include <string>
 
namespace wsf
{
namespace coverage
{

class WSF_COVERAGE_EXPORT TextOutputWriter
{
public:
   TextOutputWriter() = default;
   TextOutputWriter(const TextOutputWriter& aOther);
   virtual ~TextOutputWriter() = default;
 
   virtual TextOutputWriter* Clone() const { return new TextOutputWriter{*this}; }
   virtual bool              OpenStream(const std::string& aFileName);
   virtual void              CloseStream();

   virtual std::ostream& GetStream() { return mStream; }
 
   virtual bool CreateContainingFolder(const std::string& aPath) const;

   bool OpenFile(const std::string& aOutputDir, const std::string& aFileName);

   int GetPrecision() const { return mPrecision; }

   int GetWidth() const { return mWidth; }

   bool IsRightJustified() const { return mRightJustify; }

   bool IsFixedFormat() const { return mFixedFormat; }

   void SetPrecision(int aPrecision) { mPrecision = aPrecision; }

   void SetWidth(int aWidth) { mWidth = aWidth; }

   void SetRightJustified(bool aRightJustify) { mRightJustify = aRightJustify; }

   void SetFixedFormat(bool aFixedFormat) { mFixedFormat = aFixedFormat; }

   template<typename T>
   void WriteFieldWidth(const T& aValue, int aWidth, bool aEndLine = false)
   {
      std::stringstream field{};
      field << (mFixedFormat ? std::fixed : std::scientific);
      field << aValue;
      if (!aEndLine)
      {
         field << ",";
      }
      GetStream() << std::setw(aWidth) << field.str();
      GetStream() << (aEndLine ? "\n" : " ");
   }

   template<typename T>
   void WriteField(const T& aValue, bool aEndLine = false)
   {
      WriteFieldWidth(aValue, mWidth, aEndLine);
   }
 
   void SetStreamJustify();
   void SetStreamFormat();
 
   static constexpr int cMIN_PRECISION{6};
   static constexpr int cDEFAULT_PRECISION{6};
   static constexpr int cMAX_PRECISION{20};
   static constexpr int cMIN_WIDTH{9};
   static constexpr int cDEFAULT_WIDTH{15};
   static constexpr int cMAX_WIDTH{23};
 
private:
   int           mPrecision{cDEFAULT_PRECISION};
   int           mWidth{cDEFAULT_WIDTH};
   bool          mRightJustify{true};
   bool          mFixedFormat{true};
   std::ofstream mStream{};
};
 
} // namespace coverage
} // namespace wsf
 
#endif // WSFCOVERAGETEXTOUTPUTWRITER_HPP