tools/analyzers/Analyzer.h

#ifndef TOOLS_ANALYZER_H
#define TOOLS_ANALYZER_H

/*
* Simpatico - Simulation Package for Polymeric and Molecular Liquids
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/

#include <util/param/ParamComposite.h>  // base class
#include <util/misc/FileMaster.h>       // member variable

#include <string>
#include <iostream>
#include <fstream>

namespace Util { class FileMaster; }

namespace Tools
{

   using namespace Util;
   class Configuration;
   class Processor;

   class Analyzer : public ParamComposite
   {

   public:

      // Non-static Methods

      Analyzer(Configuration& configuration);

      Analyzer(Processor& processor);

      Analyzer(Configuration& configuration, FileMaster& fileMaster);

      virtual ~Analyzer();

      virtual void setup()
      {}

      virtual void clear()
      {}

      virtual void sample(long iStep) = 0;

      virtual void output()
      {}
  
      int interval() const;

      bool isAtInterval(long counter) const;

      // Static members

   protected:

      void readInterval(std::istream &in);

      void readOutputFileName(std::istream &in);

      Configuration& configuration();

      FileMaster& fileMaster();

      const std::string& outputFileName() const;

      std::string outputFileName(const std::string& suffix) const;

   private:

      std::string outputFileName_;

      Configuration* configurationPtr_;

      FileMaster* fileMasterPtr_;

      long interval_;

      bool ownsFileMaster_;

   };

   // Inline methods

   /*
   * Return interval value.
   */
   inline int Analyzer::interval() const
   {  return interval_; }

   /*
   * Return true iff the counter parameter is a multiple of the interval.
   */
   inline bool Analyzer::isAtInterval(long counter) const
   {  return (counter%interval_ == 0); }

   /*
   * Get the outputFileName string.
   */
   inline const std::string& Analyzer::outputFileName() const
   {  return outputFileName_; }

   /*
   * Get the parent Configuration by reference.
   */
   inline Configuration& Analyzer::configuration()
   {  return *configurationPtr_; }

}
#endif