parametrized.h

来自「利用C」· C头文件 代码 · 共 73 行

// Copyright (C) 2005-2007 Anders Logg.
// Licensed under the GNU LGPL Version 2.1.
//
// First added:  2005-12-19
// Last changed: 2007-04-13

#ifndef __PARAMETRIZED_H
#define __PARAMETRIZED_H

#include "Parameter.h"
#include "ParameterList.h"

namespace dolfin
{

  /// This is a base class for parametrized classes. Each object
  /// of a parametrized class holds a local database of parameters
  /// that override the global database of parameters.
  ///
  /// Hierarchies of parametrized objects may be created with the
  /// property that each object inherits the parameters of its parent
  /// and all parameters inherited by the parent. A parameter takes
  /// the value of the first value specified in the hierarchy,
  /// starting at the current object and following the parents back to
  /// the global database.
  ///
  /// Thus, a parameter that has not been specified, using the set()
  /// function, in any given object, takes the value specified for the
  /// parent, whereas any parameter value that has been specified
  /// locally overrides the value specified for the parent.
  
  class Parametrized
  {
  public:

    /// Constructor
    Parametrized();

    /// Destructor
    virtual ~Parametrized();

    /// Add local parameter
    void add(std::string key, Parameter value);
    
    /// Set value of local parameter
    void set(std::string key, Parameter value);

    /// Set parent from which to inherit parameters (key must be "parent")
    void set(std::string key, const Parametrized& parent);

    /// Get value of parameter with given key (local or nonlocal)
    Parameter get(std::string key) const;

    /// Check if parameter with given key has been defined locally
    bool has(std::string key) const;

    /// Callback for changes in parameter values
    virtual void readParameters();

  private:

    // Local database of parameters
    ParameterList parameters;

    // Pointer to parent
    const Parametrized* parent;

  };

}

#endif