ThePEG::ThePEG::Parameter< T, string > Class Template Reference

This is a partial specialization of Parameter for the string case. More...

#include <Parameter.h>

Inheritance diagram for ThePEG::ThePEG::Parameter< T, string >:

List of all members.

Public Types
typedef void(T::*	SetFn )(string)
	The declaration of member functions which can be used by this Switch interface for the 'set' action.
typedef string(T::*	GetFn )() const
	The declaration of member functions which can be used by this Switch interface for the 'get', 'def', 'min' and 'max' actions.
typedef string T::*	Member
	Declaration of a direct pointer to the member variable.
Public Member Functions
	Parameter (string newName, string newDescription, Member newMember, string newDef, bool depSafe=false, bool readonly=false, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newDefFn=0)
	Standard constructor.
virtual	~Parameter ()
	Default dtor.
virtual void	tset (InterfacedBase &ib, string val) const
	Set the member variable of ib to val.
virtual string	tget (const InterfacedBase &ib) const
	Return the value of the member variable of ib.
virtual string	tdef (const InterfacedBase &ib) const
	Return the default value for the member variable of ib.
void	setSetFunction (SetFn sf)
	Give a pointer to a member function to be used by tset().
void	setGetFunction (GetFn gf)
	Give a pointer to a member function to be used by tget().
void	setDefaultFunction (GetFn df)
	Give a pointer to a member function to be used by tdef().
virtual void	doxygenDescription (ostream &stream) const
	Print a description to be included in the Doxygen documentation to the given stream.
Private Attributes
Member	theMember
	The pointer to the member variable.
string	theDef
	Default, minimum and maximum values to be used if no corresponding member function pointers are given.
SetFn	theSetFn
	A pointer to a member function to be used by tset().
GetFn	theGetFn
	Pointer to member function to be used by tget().
GetFn	theDefFn
	Pointer to member function to be used by tdef().

---

Detailed Description

template<typename T>
class ThePEG::ThePEG::Parameter< T, string >

This is a partial specialization of Parameter for the string case.

See also:

Parameter

Definition at line 961 of file Parameter.h.

---

Member Function Documentation

template<typename T>

ThePEG::ThePEG::Parameter< T, string >::Parameter	(	string	newName,
		string	newDescription,
		Member	newMember,
		string	newDef,
		bool	depSafe = false,
		bool	readonly = false,
		SetFn	newSetFn = 0,
		GetFn	newGetFn = 0,
		GetFn	newDefFn = 0
	)			[inline]

Standard constructor.

Parameters:

	newName	the name of the interface, may only contain letters [a-zA-z0-9_].
	newDescription	a brief description of the interface.
	newMember	a pointer to the member variable. May be null if corresponding set/get functions are provided.
	newDef	the default value for the member variable.
	depSafe	set to true if calls to this interface for one object does not influence other objects.
	readonly	if this is set true the interface will not be able to manipulate objects of the corresponding class, but will still be able to access information.
	newSetFn	optional pointer to the member function for the 'set' action.
	newGetFn	optional pointer to the member function for the 'get' action.
	newDefFn	optional pointer to the member function for the 'def' action.

Definition at line 1012 of file Parameter.h.

---

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

• Parameter.h