Sacado::ParameterRegistration< EvalType, EvalTypeTraits > Class Template Reference

Parameter class for simple registration of a parameter with a Parameter Library. Requires a parameter name a ParameterAccessor object. More...

#include <Sacado_ParameterRegistration.hpp>

Inheritance diagram for Sacado::ParameterRegistration< EvalType, EvalTypeTraits >:

Collaboration diagram for Sacado::ParameterRegistration< EvalType, EvalTypeTraits >:

Public Types
typedef ScalarParameterLibrary< EvalTypeTraits >	ParamLib
Public Types inherited from Sacado::ScalarParameterEntry< EvalType, DefaultEvalTypeTraits >
typedef EvalTypeTraits::template apply< EvalType >::type	ScalarT

Public Member Functions
	ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, ParamLib &paramLib)
	Constructor: Registers the parameter with the Parameter Library.
	ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, const Teuchos::RCP< ParamLib > &paramLib)
	Constructor: Registers the parameter with the Parameter Library.
virtual	~ParameterRegistration ()
	Destructor.
virtual void	setRealValue (double value)
	Set real parameter value. More...
virtual void	setValue (const ScalarT &value)
	Set parameter values using ParameterAccessor. More...
virtual const ScalarT &	getValue () const
	Get parameter value using ParameterAccessor. More...
Public Member Functions inherited from Sacado::ScalarParameterEntry< EvalType, DefaultEvalTypeTraits >
	ScalarParameterEntry ()
	Default constructor.
virtual	~ScalarParameterEntry ()
	Destructor.
virtual void	setValue (const ScalarT &value)=0
	Set parameter this object represents to value. More...
virtual const ScalarT &	getValue () const=0
	Get parameter value this object represents. More...
virtual double	getRealValue () const
	Get real parameter value. More...
virtual void	print (std::ostream &os) const
	Print entry. More...
Public Member Functions inherited from Sacado::AbstractScalarParameterEntry
	AbstractScalarParameterEntry ()
	Default contructor.
virtual	~AbstractScalarParameterEntry ()
	Destructor.
virtual void	setRealValue (double value)=0
	Set real parameter value. More...
virtual double	getRealValue () const =0
	Get real parameter value. More...
virtual void	print (std::ostream &os) const =0
	Print entry. More...

Protected Attributes
ParameterAccessor< EvalType, EvalTypeTraits > *	access
	Pointer to source function.
const std::string	name

Detailed Description

template<typename EvalType, typename EvalTypeTraits = DefaultEvalTypeTraits>
class Sacado::ParameterRegistration< EvalType, EvalTypeTraits >

Parameter class for simple registration of a parameter with a Parameter Library. Requires a parameter name a ParameterAccessor object.

Member Function Documentation

getValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual const ScalarT & Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::getValue ( ) const

inlinevirtual

Get parameter value using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, DefaultEvalTypeTraits >.

References Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::access.

setRealValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setRealValue ( double  value )

inlinevirtual

Set real parameter value.

Implements Sacado::AbstractScalarParameterEntry.

References Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setValue().

setValue()

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setValue ( const ScalarT &  value )

inlinevirtual

Set parameter values using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, DefaultEvalTypeTraits >.

References Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::access.

Referenced by Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setRealValue().

---

The documentation for this class was generated from the following files:

• Sacado_ParameterAccessor.hpp
• Sacado_ParameterRegistration.hpp