ParamList.hpp

#ifndef OPALS_PARAM_LIST_HPP_INCLUDED
#define OPALS_PARAM_LIST_HPP_INCLUDED

#include <opals/fwd.hpp>
#include <opals/List.hpp>
#include <opals/String.hpp>

namespace opals {

  /**
  \struct  Parameter

  \brief Parameter stores a single parameter for file I/O in parameter files.

  \author wk
  \date   27.02.2011
  */
  struct OPALS_API Parameter
  {
    class Impl;
    Impl *pimpl_;
  public:
    Parameter();
    Parameter( const Parameter &ref );
    ~Parameter();
    Parameter &operator=( const Parameter &ref );

    bool operator==( const Parameter &ref ) const;
    bool operator<( const Parameter &ref ) const;

    const String &path() const;
    void path( const String& );

    const String &type() const;
    void type( const String& );

    const String &source() const;
    void source( const String& );

    const List<String> &values() const;
    void values( const List<String>& );

  };

  /// \class ParamList
  /// \brief Contains several parameters in their string representation.
  class OPALS_API ParamList : public List< Parameter >
  {};
}

#endif