Begin.h

#ifndef UTIL_BEGIN_H
#define UTIL_BEGIN_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/param/ParamComponent.h>
#include <util/param/Label.h>

#include <string>

namespace Util
{

   class Begin : public ParamComponent
   {

   public:

      Begin(const char* label, bool isRequired = true);

      // Default destructor.

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

      virtual void writeParam(std::ostream &out);

      bool isRequired() const;

      bool isActive() const;

      virtual void resetParam();

   private:

      Label label_;

      bool isActive_;

   };

   /*
   * Is this the beginning line for a required element?
   */
   inline bool Begin::isRequired() const
   {  return label_.isRequired(); }

   /*
   * Is this element active (has it been read from file)?
   */
   inline bool Begin::isActive() const
   {  return isActive_; }

} 
#endif