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 >:

List of all members.

Public Member Functions
	ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, Teuchos::RCP< ParamLib > paramLib)
	Constructor: Registers the parameter with the Parameter Library.
virtual	~ParameterRegistration ()
	Destructor.
virtual void	setRealValue (double value)
	Set real parameter value.
virtual void	setValue (const ScalarT &value)
	Set parameter values using ParameterAccessor.
virtual const ScalarT &	getValue () const
	Get parameter value using ParameterAccessor.
Protected Attributes
ParameterAccessor< EvalType, EvalTypeTraits > *	access
	Pointer to source function.
const std::string	name
Private Types
typedef EvalTypeTraits::template apply < EvalType >::type	ScalarT
	Scalar type.

---

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.

Definition at line 46 of file Sacado_ParameterRegistration.hpp.

---

Member Typedef Documentation

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

typedef EvalTypeTraits::template apply<EvalType>::type Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::ScalarT [private]

Scalar type.

Reimplemented from Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >.

Definition at line 50 of file Sacado_ParameterRegistration.hpp.

---

Constructor & Destructor Documentation

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::ParameterRegistration	(	const std::string &	name_,
		ParameterAccessor< EvalType, EvalTypeTraits > *	access_,
		Teuchos::RCP< ParamLib >	paramLib
	)		[inline]

Constructor: Registers the parameter with the Parameter Library.

Definition at line 56 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::~ParameterRegistration

(

)

[inline, virtual]

Destructor.

Definition at line 70 of file Sacado_ParameterRegistration.hpp.

---

Member Function Documentation

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setRealValue

(

double

value

)

[inline, virtual]

Set real parameter value.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 73 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

virtual void Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::setValue

(

const ScalarT &

value

)

[inline, virtual]

Set parameter values using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >.

Definition at line 77 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

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

(

)

const [inline, virtual]

Get parameter value using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >.

Definition at line 81 of file Sacado_ParameterRegistration.hpp.

---

Member Data Documentation

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

ParameterAccessor<EvalType, EvalTypeTraits>* Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::access [protected]

Pointer to source function.

Definition at line 88 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits = DefaultEvalTypeTraits>

const std::string Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::name [protected]

Definition at line 89 of file Sacado_ParameterRegistration.hpp.

---

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

• Sacado_ParameterRegistration.hpp