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_ParameterAccessor.hpp>

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

Public Types
typedef ScalarParameterLibrary < EvalTypeTraits >	ParamLib
Public Types inherited from Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >
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. More...
	ParameterRegistration (const std::string &name_, ParameterAccessor< EvalType, EvalTypeTraits > *access_, const Teuchos::RCP< ParamLib > &paramLib)
	Constructor: Registers the parameter with the Parameter Library. More...
virtual	~ParameterRegistration ()
	Destructor. More...
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, EvalTypeTraits >
	ScalarParameterEntry ()
	Default constructor. More...
virtual	~ScalarParameterEntry ()
	Destructor. 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. More...
virtual	~AbstractScalarParameterEntry ()
	Destructor. More...

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

Private Types
typedef EvalTypeTraits::template apply < EvalType >::type	ScalarT
	Scalar type. More...

Detailed Description

template<typename EvalType, typename EvalTypeTraits>
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 41 of file Sacado_ParameterAccessor.hpp.

Member Typedef Documentation

template<typename EvalType , typename EvalTypeTraits >

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

private

Scalar type.

Definition at line 50 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

typedef ScalarParameterLibrary<EvalTypeTraits> Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::ParamLib

Definition at line 55 of file Sacado_ParameterRegistration.hpp.

Constructor & Destructor Documentation

template<typename EvalType , typename EvalTypeTraits >

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

inline

Constructor: Registers the parameter with the Parameter Library.

Definition at line 58 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

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

inline

Constructor: Registers the parameter with the Parameter Library.

Definition at line 70 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

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

inlinevirtual

Destructor.

Definition at line 85 of file Sacado_ParameterRegistration.hpp.

Member Function Documentation

template<typename EvalType , typename EvalTypeTraits >

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

inlinevirtual

Set real parameter value.

Implements Sacado::AbstractScalarParameterEntry.

Definition at line 88 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

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

inlinevirtual

Set parameter values using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >.

Definition at line 92 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

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

inlinevirtual

Get parameter value using ParameterAccessor.

Implements Sacado::ScalarParameterEntry< EvalType, EvalTypeTraits >.

Definition at line 97 of file Sacado_ParameterRegistration.hpp.

Member Data Documentation

template<typename EvalType , typename EvalTypeTraits >

ParameterAccessor<EvalType, EvalTypeTraits>* Sacado::ParameterRegistration< EvalType, EvalTypeTraits >::access

protected

Pointer to source function.

Definition at line 104 of file Sacado_ParameterRegistration.hpp.

template<typename EvalType , typename EvalTypeTraits >

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

protected

Definition at line 105 of file Sacado_ParameterRegistration.hpp.

---

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

• Sacado_ParameterAccessor.hpp
• Sacado_ParameterRegistration.hpp