mcMd/analyzers/Analyzer.h

#ifndef MCMD_ANALYZER_H
#define MCMD_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 McMd
{

   using namespace Util;

   class Analyzer : public ParamComposite
   {

   public:

      // Non-static Methods

      Analyzer();

      virtual ~Analyzer();

      virtual void readParameters(std::istream& in);

      virtual void loadParameters(Serializable::IArchive& ar);

      virtual void save(Serializable::OArchive& ar);
  
      template <class Archive>
      void serialize(Archive& ar, const unsigned int version);

      virtual void setup()
      {}

      virtual void sample(long iStep) = 0;

      virtual void output()
      {}

      int interval() const;

      bool isAtInterval(long counter) const;

      // Static members

      static long baseInterval;

      static void initStatic();

   protected:

      void setFileMaster(FileMaster& fileMaster);

      void readInterval(std::istream &in);

      void readOutputFileName(std::istream &in);

      void loadInterval(Serializable::IArchive& ar);

      void loadOutputFileName(Serializable::IArchive& ar);

      FileMaster& fileMaster();

      const std::string& outputFileName() const;

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

      std::string outputFileName_;

      long   interval_;

   private:

      FileMaster* fileMasterPtr_;

   };

   // 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_; }

   // Method template

   /*
   * Serialize to/from an archive. 
   */
   template <class Archive>
   void Analyzer::serialize(Archive& ar, const unsigned int version)
   {
      ar & interval_;
      ar & outputFileName_;
   }

}
#endif