The Parameter and its base classes ParameterTBase and ParameterBase defines an interface to a class derived from the InterfacedBase, through which simple member variables can be manuipulated. More...

#include <Parameter.h>

Inheritance diagram for ThePEG::ParameterBase:

[legend]

Public Member Functions
	ParameterBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, bool depSafe, bool readonly, int limits)
	Standard constructor. More...

virtual	~ParameterBase ()
	The destructor.

virtual string	exec (InterfacedBase &ib, string action, string arguments) const
	The general interface method overriding the one in InterfaceBase. More...

virtual string	fullDescription (const InterfacedBase &ib) const
	Return a complete description of this parameter.

virtual void	set (InterfacedBase &ib, string) const =0
	Set the member variable of ib to val.

virtual string	minimum (const InterfacedBase &ib) const =0
	Return the minimum value allowed for the member variable of ib.

virtual string	maximum (const InterfacedBase &ib) const =0
	Return the maximum value allowed for the member variable of ib.

virtual string	get (const InterfacedBase &ib) const =0
	Return the value of the member variable of ib.

virtual string	def (const InterfacedBase &ib) const =0
	Return the default value for the member variable of ib.

virtual void	setDef (InterfacedBase &ib) const =0
	Set the member variable of ib to its default value.

bool	limited () const
	True if there the variable is limited from above and below.

bool	upperLimit () const
	True if there the variable is limited from abovew.

bool	lowerLimit () const
	True if there the variable is limited from below.

void	setLimited ()
	Set flag indicating that there are limits associated with the variable.

void	setUnlimited ()
	Set flag indicating that there are no limits associated with the variable.

Public Member Functions inherited from ThePEG::InterfaceBase
	InterfaceBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, bool depSafe, bool readonly)
	Standard constructor. More...

virtual	~InterfaceBase ()
	The destructor.

string	tag (int pos=-1) const
	Create a tag for this interface using its name and optional poisitional argument.

virtual string	type () const =0
	Return a code for the type of this interface.

virtual bool	notDefault (InterfacedBase &) const
	Returns true if the setting for this interface has been changed from its default value.

map< string, string > &	objectDefaults (InterfacedBase &) const
	Returns the map of objectDefaults of the given object.

virtual void	rebind (InterfacedBase &, const TranslationMap &, const IVector &=IVector()) const
	Rebind all references in ib according to the translation map. More...

virtual IVector	getReferences (const InterfacedBase &) const
	For derived classes interfacing references between Interfaced objects, return the references for this interface.

string	description () const
	Return the description of this interface.

virtual void	doxygenDescription (ostream &stream) const
	Print a description to be included in the Doxygen documentation to the given stream.

virtual string	doxygenType () const =0
	Return a string describing the type of interface to be included in the Doxygen documentation.

string	className () const
	Return the class name for the class this interface is defined for.

bool	dependencySafe () const
	Get the flag saying whether changing an object with this interface may change the state of a dependent object .

void	setDependencySafe ()
	Set the flag saying whether changing an object with this interface may change the state of a dependent object .

void	setDependencySensitive ()
	Set the flag saying whether changing an object with this interface may change the state of a dependent object .

bool	readOnly () const
	Get the flag saying whether this interface is allowed to change an object.

void	setReadOnly ()
	Set the flag saying that this interface is allowed to change an object.

void	setReadWrite ()
	Unset the flag saying that this interface is allowed to change an object.

bool	anonymous () const
	Return true if this interface is anonyous, ie. More...

double	rank () const
	Get the rank for this interface. More...

void	rank (double r)
	Set the rank for this interface. More...

void	setHasDefault (bool b)
	Indicate that this interface has a default value.

Public Member Functions inherited from ThePEG::Named
	Named (const string &newName=string())
	Constructor with name.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Private Attributes
int	limit
	Determines if the values of the parameters are limited from above and/or below. More...

Additional Inherited Members
Static Public Attributes inherited from ThePEG::InterfaceBase
static bool	NoReadOnly
	If set to true, all read-only interfaces can be changed.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Protected Attributes inherited from ThePEG::InterfaceBase
bool	hasDefault
	A flag indicating whether this interface has a default setting.

bool	isDependencySafe
	The flag saying whether changing an object with this interface may change the state of a dependent object .

bool	isReadOnly
	The flag saying whether this interface is allowed to change an object.

Detailed Description

The Parameter and its base classes ParameterTBase and ParameterBase defines an interface to a class derived from the InterfacedBase, through which simple member variables can be manuipulated.

Parameter is templated on the type of the member variable and the type of the InterfacedBase class, and is derived from the InterfaceBase class via ParameterTBase (which is templated only on the type of the member variable) and ParameterBase.

For each InterfacedBase class exactly one static Parameter object should created for each member variable which should be interfaced. This object will automatically register itself with the BaseRepository class.

See also: InterfacedBase; InterfaceBase

Definition at line 88 of file Parameter.h.

Constructor & Destructor Documentation

◆ ParameterBase()

ThePEG::ParameterBase::ParameterBase	(	string	newName,
		string	newDescription,
		string	newClassName,
		const type_info &	newTypeInfo,
		bool	depSafe,
		bool	readonly,
		int	limits
	)

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.
newClassName	the name of the corresponding class.
newTypeInfo	the type_info object of the corresponding class.
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.
limits	determines if the values of the parameters are limited from above and/or below. The possible values are given by Interface::Limits.

Definition at line 116 of file Parameter.h.

References def(), exec(), fullDescription(), maximum(), minimum(), setDef(), and ~ParameterBase().

Member Function Documentation

◆ exec()

virtual string ThePEG::ParameterBase::exec	(	InterfacedBase &	ib,
		string	action,
		string	arguments
	)		const

virtual

The general interface method overriding the one in InterfaceBase.

For this class, action can be any of "set", "get", "min", "max", "def" and "setdef" and argument should be a something which can be read into a variable through a stringstream with the standard '>>' operator.

Implements ThePEG::InterfaceBase.

Referenced by ParameterBase().