LOCA::Parameter::DefaultFunctor< ObjectType, ValueType > Class Template Reference

Default function object for setting a single parameter in a single object using a data member pointer. More...

#include <LOCA_Parameter_Entry.H>

List of all members.

Public Member Functions
	DefaultFunctor (ObjectType &object, ValueType ObjectType::*object_val_ptr)
	Constructor.
virtual	~DefaultFunctor ()
	Destructor.
virtual void	set (const ValueType &value)
	Set parameter using object and data member pointer.
virtual ValueType	get () const
	Get parameter value this object represents.
Protected Attributes
ObjectType &	obj
	Reference to object to set parameter it.
ValueType ObjectType::*	obj_val_ptr
	Pointer to data member in ObjectType of type ValueType.
Private Member Functions
	DefaultFunctor (const DefaultFunctor &)
	Private to prohibit copying.
DefaultFunctor &	operator= (const DefaultFunctor &)
	Private to prohibit copying.

---

Detailed Description

template<class ObjectType, class ValueType>
class LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >

Default function object for setting a single parameter in a single object using a data member pointer.

The constructor takes a reference to an object object of type\ ObjectType and a pointer object_val_ptr to a data member of class of ObjectType of type ValueType. The parameter is set to value via

    object.*object_val_ptr = value

Definition at line 167 of file LOCA_Parameter_Entry.H.

---

Constructor & Destructor Documentation

template<class ObjectType , class ValueType >

LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::DefaultFunctor	(	ObjectType &	object,
		ValueType ObjectType::*	object_val_ptr
	)			[inline]

Constructor.

object is a reference to the object to set the parameter in, and object_val_ptr is a pointer to a data member of type ValueType of that class.

Definition at line 176 of file LOCA_Parameter_Entry.H.

template<class ObjectType , class ValueType >

virtual LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::~DefaultFunctor

(

)

[inline, virtual]

Destructor.

Definition at line 181 of file LOCA_Parameter_Entry.H.

template<class ObjectType , class ValueType >

LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::DefaultFunctor

(

const DefaultFunctor< ObjectType, ValueType > &

)

[private]

Private to prohibit copying.

---

Member Function Documentation

template<class ObjectType , class ValueType >

virtual void LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::set

(

const ValueType &

value

)

[inline, virtual]

Set parameter using object and data member pointer.

Definition at line 184 of file LOCA_Parameter_Entry.H.

References LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj, and LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj_val_ptr.

template<class ObjectType , class ValueType >

virtual ValueType LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::get

(

)

const [inline, virtual]

Get parameter value this object represents.

Definition at line 187 of file LOCA_Parameter_Entry.H.

References LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj, and LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj_val_ptr.

template<class ObjectType , class ValueType >

DefaultFunctor& LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::operator=

(

const DefaultFunctor< ObjectType, ValueType > &

)

[private]

Private to prohibit copying.

---

Member Data Documentation

template<class ObjectType , class ValueType >

ObjectType& LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj [protected]

Reference to object to set parameter it.

Definition at line 200 of file LOCA_Parameter_Entry.H.

Referenced by LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::get(), and LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::set().

template<class ObjectType , class ValueType >

ValueType ObjectType::* LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::obj_val_ptr [protected]

Pointer to data member in ObjectType of type ValueType.

Definition at line 203 of file LOCA_Parameter_Entry.H.

Referenced by LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::get(), and LOCA::Parameter::DefaultFunctor< ObjectType, ValueType >::set().

---

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

• LOCA_Parameter_Entry.H