parameter_pointer.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2019 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
 
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
 
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
 
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
 
#ifndef LIBMESH_PARAMETER_POINTER_H
#define LIBMESH_PARAMETER_POINTER_H
 
 
// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/parameter_accessor.h"
#include "libmesh/auto_ptr.h" // libmesh_make_unique
 
namespace libMesh
{
 
template <typename T=Number>
class ParameterPointer : public ParameterAccessor<T>
{
public:
  ParameterPointer(T * param_ptr) : _ptr(param_ptr) {}
  virtual void set (const T & new_value) override
  { libmesh_assert(_ptr); *_ptr = new_value; }
 
  virtual const T & get () const override
  { libmesh_assert(_ptr); return *_ptr; }
 
#ifdef LIBMESH_ENABLE_DEPRECATED
  virtual ParameterAccessor<T> &
  operator= (T * new_ptr) override
  {
    libmesh_deprecated();
    _ptr = new_ptr;
    return *this;
  }
#endif
 
  virtual std::unique_ptr<ParameterAccessor<T>> clone() const override
  {
    return libmesh_make_unique<ParameterPointer<T>>(_ptr);
  }
 
private:
  T * _ptr;
};
 
} // namespace libMesh
 
#endif // LIBMESH_PARAMETER_POINTER_H