ParamComponent.h

#ifndef UTIL_PARAM_COMPONENT_H
#define UTIL_PARAM_COMPONENT_H
 
/*
* Util Package - C++ Utilities for Scientific Computation
*
* Copyright 2010 - 2017, The Regents of the University of Minnesota
* Distributed under the terms of the GNU General Public License.
*/
 
#include <util/mpi/MpiFileIo.h>          // base class
#include <util/archives/Serializable.h>  // base class (typedef)
#include <util/global.h>
 
#include <iostream>
#include <sstream>
#include <string>
 
namespace Util
{

   class ParamComponent : public Serializable, public MpiFileIo
   {
 
   public:

      virtual ~ParamComponent();

      virtual void readParam(std::istream& in) = 0;

      virtual void writeParam(std::ostream& out) const = 0;
 
      virtual void load(Serializable::IArchive &ar)
      {}
 
      virtual void save(Serializable::OArchive &ar)
      {}

      virtual void resetParam()
      {}

      void setIndent(const ParamComponent& parent, bool next = true);

      std::string indent() const;

      template <class Archive>
      void serialize(Archive& ar, const unsigned int version);
 
      // Public static methods

      static void initStatic();

      static void setEcho(bool echo = true);

      static bool echo();
 
   protected:

      ParamComponent();

      ParamComponent(const ParamComponent& other);
 
   private:

      std::string indent_;

      static bool echo_;
 
   // friend:
 
      #ifdef UTIL_MPI
      template <class T> friend class Factory;
 
      /*
      * Note: This friend declaration allows the Factory::readObject() 
      * method to set the Factory ioCommunicator to be that of the 
      * parent ParamComposite. 
      */
      #endif
 
   };
 
   /*
   * Serialize a ParamComponent as a string.
   */
   template <class Archive>
   void ParamComponent::serialize(Archive& ar, const unsigned int version)
   {
      std::string str;
      if (Archive::is_saving()) {
         std::ostringstream buffer;
         writeParam(buffer);
         str = buffer.str();
      } 
      ar & str;
      if (Archive::is_loading()) {
         std::istringstream buffer(str);
         readParam(buffer);
      } 
   }
 
} 
#endif