The ParVector and its base classes ParVectorTBase and ParVectorBase defines an interface to a class derived from the InterfacedBase, through which vectors (or any other container) of simple member variables can be manuipulated. More...

#include <ParVector.h>

Inheritance diagram for ThePEG::ParVector< T, Type >:

[legend]

Public Types
typedef void(T::*	SetFn) (Type, int)
	The declaration of member functions which can be used by this ParVector interface for 'set' actions.

typedef void(T::*	InsFn) (Type, int)
	The declaration of member functions which can be used by this ParVector interface for 'insert' actions.

typedef void(T::*	DelFn) (int)
	The declaration of member functions which can be used by this ParVector interface for 'erase' actions.

typedef vector< Type >	TypeVector
	A vector of objects of the template parameter Type.

typedef TypeVector(T::*	GetFn) () const
	The declaration of member functions which can be used by this ParVector interface for 'get' actions.

typedef vector< string >	StringVector
	A vector of strings.

typedef StringVector(T::*	StringGetFn) () const
	The declaration of member functions which can be used by this ParVector interface for 'get' actions.

typedef Type(T::*	DefFn) (int) const
	The declaration of member functions which can be used by this ParVector interface for 'erase' actions.

typedef TypeVector T::*	Member
	Declaration of a direct pointer to the member variable in case it is a vector.

Public Types inherited from ThePEG::ParVectorTBase< Type >
typedef vector< Type >	TypeVector
	A vector of objects of the template argument type. More...

Public Types inherited from ThePEG::ParVectorBase
typedef vector< string >	StringVector
	A vector of strings. More...

Public Member Functions
	ParVector (string newName, string newDescription, Member newMember, int newSize, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, bool limits=true, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, DefFn newDefFn=0, DefFn newMinFn=0, DefFn newMaxFn=0, StringGetFn newStringGetFn=0)
	Standard constructor. More...

	ParVector (string newName, string newDescription, Member newMember, Type newUnit, int newSize, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, bool limits=true, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, DefFn newDefFn=0, DefFn newMinFn=0, DefFn newMaxFn=0, StringGetFn newStringGetFn=0)
	Standard constructor. More...

	ParVector (string newName, string newDescription, Member newMember, int newSize, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, int limits=Interface::limited, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, DefFn newDefFn=0, DefFn newMinFn=0, DefFn newMaxFn=0, StringGetFn newStringGetFn=0)
	Standard constructor. More...

	ParVector (string newName, string newDescription, Member newMember, Type newUnit, int newSize, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, int limits=Interface::limited, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, DefFn newDefFn=0, DefFn newMinFn=0, DefFn newMaxFn=0, StringGetFn newStringGetFn=0)
	Standard constructor. More...

virtual void	tset (InterfacedBase &ib, Type val, int i) const
	Set the i'th element of a container of member variables of ib to val.

virtual void	tinsert (InterfacedBase &ib, Type val, int i) const
	Insert a new object before the i'th element of a container of member variables of ib and set it to val.

virtual void	erase (InterfacedBase &ib, int i) const
	Remove the i'th element of a container of member variables of ib.

virtual void	clear (InterfacedBase &ib) const
	Clear the container of pointers of ib.

virtual StringVector	get (const InterfacedBase &ib) const
	Return the values of a container of member variables of ib in a vector of strings. More...

virtual TypeVector	tget (const InterfacedBase &ib) const
	Return the values of a container of member variables of ib in a vector of Type.

virtual Type	tminimum (const InterfacedBase &ib, int i) const
	Return the minimum value allowed for the i'th element of a container of member variables of ib.

virtual Type	tmaximum (const InterfacedBase &ib, int i) const
	Return the maximum value allowed for the i'th element of a container of member variables of ib.

virtual Type	tdef (const InterfacedBase &, int) const
	Return the default value for the i'th element of a container of member variables of ib.

virtual Type	tdef () const
	Return the general default value for this parameter vector.

void	setSetFunction (SetFn sf)
	Give a pointer to a member function to be used by tset().

void	setInsertFunction (InsFn ifn)
	Give a pointer to a member function to be used by tinsert().

void	setGetFunction (GetFn gf)
	Give a pointer to a member function to be used by tget().

void	setEraseFunction (DelFn df)
	Give a pointer to a member function to be used by terase().

void	setDefaultFunction (GetFn df)
	Give a pointer to a member function to be used by tdef().

void	setMinFunction (GetFn mf)
	Give a pointer to a member function to be used by tminimum().

void	setMaxFunction (GetFn mf)
	Give a pointer to a member function to be used by tmaximum().

void	setStringGetFunction (StringGetFn gf)
	Give a pointer to a member function to be used by get().

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

Public Member Functions inherited from ThePEG::ParVectorTBase< Type >
	ParVectorTBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, Type newUnit, int newSize, bool depSafe, bool readonly, int limits)
	Standard constructor. More...

virtual	~ParVectorTBase ()
	Destructor.

virtual string	type () const
	Return a code for the type of this parameter.

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

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

virtual void	set (InterfacedBase &ib, string val, int i) const
	Set the i'th element of a container of member variables of ib to val. More...

virtual void	insert (InterfacedBase &ib, string val, int i) const
	Insert a new object before the i'th element of a container of member variables of ib and set it to val. More...

virtual string	minimum (const InterfacedBase &ib, int i) const
	Return the minimum value allowed for the i'th element of a container of member variables of ib. More...

virtual string	maximum (const InterfacedBase &ib, int i) const
	Return the maximum value allowed for the i'th element of a container of member variables of ib. More...

virtual string	def (const InterfacedBase &ib, int i) const
	Return the default value for the i'th element of a container of member variables of ib. More...

virtual string	def () const
	Return the general default value for this parameter vector. More...

virtual void	setDef (InterfacedBase &ib, int i) const
	set the i'th element of a container of member variables of ib to its default value.

Type	unit () const
	Get the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double. More...

void	unit (Type u)
	Set the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double. More...

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

virtual	~ParVectorBase ()
	Destructor.

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

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 a flag indicating that there are limits associated with the variables.

void	setUnlimited ()
	Set a flag indicating if there are no limits associated with the variables.

int	size () const
	Get the size of the container being interfaced. More...

void	setSize (int sz)
	Set the size of the container being interfaced. More...

void	setVariableSize ()
	Set the size of the container being interfaced to -1, i.e. More...

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

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
Member	theMember
	The pointer to the member variable.

Type	theDef
	Default value to be used if no corresponding member function pointer is given.

Type	theMin
	Minimum value to be used if no corresponding member function pointer is given.

Type	theMax
	Maximum value to be used if no corresponding member function pointer is given.

SetFn	theSetFn
	A pointer to a member function to be used by tset().

InsFn	theInsFn
	A pointer to a member function to be used by tinsert().

DelFn	theDelFn
	A pointer to a member function to be used by terase().

GetFn	theGetFn
	A pointer to a member function to be used by tget().

DefFn	theDefFn
	Pointer to member function to be used by tdef().

DefFn	theMinFn
	Pointer to member function to be used by tminimum().

DefFn	theMaxFn
	Pointer to member function to be used by tmaximum().

StringGetFn	theStringGetFn
	A pointer to a member function to be used by set().

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::ParVectorTBase< Type >
void	putUnit (ostream &os, Type val) const
	Write a numer to a stream with the unit specified with unit().

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

template<typename T, typename Type>
class ThePEG::ParVector< T, Type >

The ParVector and its base classes ParVectorTBase and ParVectorBase defines an interface to a class derived from the InterfacedBase, through which vectors (or any other container) of simple member variables can be manuipulated.

ParVector is templated on the type of the member variable and the type of the InterfacedBase class, and is derived from the InterfaceBase class via ParVectorTBase (which is templated only on the class of the member variable) and ParVectorBase.

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

See also: Parameter; InterfacedBase; InterfaceBase

Definition at line 538 of file ParVector.h.

Constructor & Destructor Documentation

◆ ParVector() [1/4]

template<typename T , typename Type >

ThePEG::ParVector< T, Type >::ParVector	(	string	newName,
		string	newDescription,
		Member	newMember,
		int	newSize,
		Type	newDef,
		Type	newMin,
		Type	newMax,
		bool	depSafe = `false`,
		bool	readonly = `false`,
		bool	limits = `true`,
		SetFn	newSetFn = `0`,
		InsFn	newInsFn = `0`,
		DelFn	newDelFn = `0`,
		GetFn	newGetFn = `0`,
		DefFn	newDefFn = `0`,
		DefFn	newMinFn = `0`,
		DefFn	newMaxFn = `0`,
		StringGetFn	newStringGetFn = `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 a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newSize	the size of the container or -1 if varying.
newDef	the default value of the corresponding parameters.
newMin	the minimum value of the corresponding parameters.
newMax	the maximum value of the corresponding parameters.
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 below.
newSetFn	optional pointer to member function for the 'set' action.
newInsFn	optional pointer to member function for the 'insert' action.
newDelFn	optional pointer to member function for the 'erase' action.
newDefFn	optional pointer to member function for the 'default' action.
newGetFn	optional pointer to member function for the 'get' action.
newMinFn	optional pointer to member function for the 'minimum' action.
newMaxFn	optional pointer to member function for the 'maximum' action.
newStringGetFn	optional pointer to member function for the 'get' action.

Definition at line 650 of file ParVector.h.

◆ ParVector() [2/4]

template<typename T , typename Type >

ThePEG::ParVector< T, Type >::ParVector	(	string	newName,
		string	newDescription,
		Member	newMember,
		Type	newUnit,
		int	newSize,
		Type	newDef,
		Type	newMin,
		Type	newMax,
		bool	depSafe = `false`,
		bool	readonly = `false`,
		bool	limits = `true`,
		SetFn	newSetFn = `0`,
		InsFn	newInsFn = `0`,
		DelFn	newDelFn = `0`,
		GetFn	newGetFn = `0`,
		DefFn	newDefFn = `0`,
		DefFn	newMinFn = `0`,
		DefFn	newMaxFn = `0`,
		StringGetFn	newStringGetFn = `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 a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newUnit	the unit assumed when a number is read or written to a stream.
newSize	the size of the container or -1 if varying.
newDef	the default value of the corresponding parameters.
newGetFn	optional pointer to member function for the 'get' action.
newMin	the minimum value of the corresponding parameters.
newMax	the maximum value of the corresponding parameters.
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 below.
newSetFn	optional pointer to member function for the 'set' action.
newInsFn	optional pointer to member function for the 'insert' action.
newDelFn	optional pointer to member function for the 'erase' action.
newDefFn	optional pointer to member function for the 'default' action.
newMinFn	optional pointer to member function for the 'minimum' action.
newMaxFn	optional pointer to member function for the 'maximum' action.
newStringGetFn	optional pointer to member function for the 'get' action.

Definition at line 723 of file ParVector.h.

◆ ParVector() [3/4]

template<typename T , typename Type >

ThePEG::ParVector< T, Type >::ParVector	(	string	newName,
		string	newDescription,
		Member	newMember,
		int	newSize,
		Type	newDef,
		Type	newMin,
		Type	newMax,
		bool	depSafe = `false`,
		bool	readonly = `false`,
		int	limits = `Interface::limited`,
		SetFn	newSetFn = `0`,
		InsFn	newInsFn = `0`,
		DelFn	newDelFn = `0`,
		GetFn	newGetFn = `0`,
		DefFn	newDefFn = `0`,
		DefFn	newMinFn = `0`,
		DefFn	newMaxFn = `0`,
		StringGetFn	newStringGetFn = `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 a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newSize	the size of the container or -1 if varying.
newDef	the default value of the corresponding parameters.
newMin	the minimum value of the corresponding parameters.
newMax	the maximum value of the corresponding parameters.
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.
newSetFn	optional pointer to member function for the 'set' action.
newInsFn	optional pointer to member function for the 'insert' action.
newDelFn	optional pointer to member function for the 'erase' action.
newDefFn	optional pointer to member function for the 'default' action.
newGetFn	optional pointer to member function for the 'get' action.
newMinFn	optional pointer to member function for the 'minimum' action.
newMaxFn	optional pointer to member function for the 'maximum' action.
newStringGetFn	optional pointer to member function for the 'get' action.

Definition at line 793 of file ParVector.h.

◆ ParVector() [4/4]

template<typename T , typename Type >

ThePEG::ParVector< T, Type >::ParVector	(	string	newName,
		string	newDescription,
		Member	newMember,
		Type	newUnit,
		int	newSize,
		Type	newDef,
		Type	newMin,
		Type	newMax,
		bool	depSafe = `false`,
		bool	readonly = `false`,
		int	limits = `Interface::limited`,
		SetFn	newSetFn = `0`,
		InsFn	newInsFn = `0`,
		DelFn	newDelFn = `0`,
		GetFn	newGetFn = `0`,
		DefFn	newDefFn = `0`,
		DefFn	newMinFn = `0`,
		DefFn	newMaxFn = `0`,
		StringGetFn	newStringGetFn = `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 a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newUnit	the unit assumed when a number is read or written to a stream.
newSize	the size of the container or -1 if varying.
newDef	the default value of the corresponding parameters.
newGetFn	optional pointer to member function for the 'get' action.
newMin	the minimum value of the corresponding parameters.
newMax	the maximum value of the corresponding parameters.
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.
newSetFn	optional pointer to member function for the 'set' action.
newInsFn	optional pointer to member function for the 'insert' action.
newDelFn	optional pointer to member function for the 'erase' action.
newDefFn	optional pointer to member function for the 'default' action.
newMinFn	optional pointer to member function for the 'minimum' action.
newMaxFn	optional pointer to member function for the 'maximum' action.
newStringGetFn	optional pointer to member function for the 'get' action.

Definition at line 866 of file ParVector.h.

References ThePEG::ParVectorBase::clear(), and ThePEG::ParVectorBase::erase().

Member Function Documentation

◆ get()

template<typename T , typename Type >

virtual StringVector ThePEG::ParVector< T, Type >::get ( const InterfacedBase & ib ) const

virtual

Return the values of a container of member variables of ib in a vector of strings.

Calls the The tget(const InterfacedBase &) and returns a vector of strings converted with ostringstreams.

Reimplemented from ThePEG::ParVectorTBase< Type >.

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

ParVector.h

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename T, typename Type> class ThePEG::ParVector< T, Type >

Constructor & Destructor Documentation

◆ ParVector() [1/4]

◆ ParVector() [2/4]

◆ ParVector() [3/4]

◆ ParVector() [4/4]

Member Function Documentation

◆ get()

template<typename T, typename Type>
class ThePEG::ParVector< T, Type >