ThePEG::ParVectorTBase< Type > Class Template Reference
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>
Public Types | |
| typedef vector< Type > | TypeVector |
| A vector of objects of the template argument type. | |
Public Member Functions | |
| ParVectorTBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, Type newUnit, int newSize, bool depSafe, bool readonly, int limits) | |
| Standard constructor. | |
| 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. | |
| virtual void | tset (InterfacedBase &ib, Type val, int i) const =0 |
| Set the i'th element of a container of member variables of ib to val. | |
| 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. | |
| virtual void | tinsert (InterfacedBase &ib, Type val, int i) const =0 |
| Insert a new object before the i'th element of a container of member variables of ib and set it to val. | |
| virtual StringVector | get (const InterfacedBase &ib) const |
| Return the values of a container of member variables of ib in a vector of strings. | |
| virtual TypeVector | tget (const InterfacedBase &ib) const =0 |
| Return the values of a container of member variables of ib in a vector of Type. | |
| 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. | |
| virtual Type | tminimum (const InterfacedBase &ib, int i) const =0 |
| Return the minimum value allowed for the i'th element of a container of member variables of ib. | |
| 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. | |
| virtual Type | tmaximum (const InterfacedBase &ib, int i) const =0 |
| Return the maximum value allowed for the i'th element of a container of member variables of ib. | |
| 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. | |
| virtual Type | tdef (const InterfacedBase &ib, int i) const =0 |
| Return the default value for the i'th element of a container of member variables of ib. | |
| virtual string | def () const |
| Return the general default value for this parameter vector. | |
| virtual Type | tdef () const =0 |
| Return the general default value for this parameter vector. | |
| 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. | |
| 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. | |
Protected Member Functions | |
| void | putUnit (ostream &os, Type val) const |
| Write a numer to a stream with the unit specified with unit(). | |
Private Member Functions | |
| void | setImpl (InterfacedBase &ib, string val, int i, StandardT) const |
| Implementation of set() for standard types. | |
| void | setImpl (InterfacedBase &ib, string val, int i, DimensionT) const |
| Implementation of set() for dimensioned types. | |
| void | insertImpl (InterfacedBase &ib, string val, int i, StandardT) const |
| Implementation of insert() for standard types. | |
| void | insertImpl (InterfacedBase &ib, string val, int i, DimensionT) const |
| Implementation of insert() for dimensioned types. | |
Private Attributes | |
| Type | theUnit |
| The unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double. | |
Detailed Description
template<typename Type>
class ThePEG::ParVectorTBase< 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
Definition at line 276 of file ParVector.h.
Member Typedef Documentation
| typedef vector<Type> ThePEG::ParVectorTBase< Type >::TypeVector |
A vector of objects of the template argument type.
Reimplemented in ThePEG::ParVector< T, Type >.
Definition at line 281 of file ParVector.h.
Constructor & Destructor Documentation
| ThePEG::ParVectorTBase< Type >::ParVectorTBase | ( | string | newName, | |
| string | newDescription, | |||
| string | newClassName, | |||
| const type_info & | newTypeInfo, | |||
| Type | newUnit, | |||
| int | newSize, | |||
| 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. newUnit the unit assumed when a number is read or written to a stream. newSize the size of the container or -1 if varying. 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 314 of file ParVector.h.
Member Function Documentation
| virtual void ThePEG::ParVectorTBase< Type >::set | ( | InterfacedBase & | ib, | |
| string | val, | |||
| int | i | |||
| ) | const [virtual] |
Set the i'th element of a container of member variables of ib to val.
Uses a stringstream to read the val into a Type object and then calls tset(InterfacedBase &, Type, int).
Implements ThePEG::ParVectorBase.
| virtual void ThePEG::ParVectorTBase< Type >::insert | ( | InterfacedBase & | ib, | |
| string | val, | |||
| int | i | |||
| ) | const [virtual] |
Insert a new object before the i'th element of a container of member variables of ib and set it to val.
Uses a stringstream to read the val into a Type object and then calls tinsert(InterfacedBase &, Type, int).
Implements ThePEG::ParVectorBase.
| virtual StringVector ThePEG::ParVectorTBase< 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.
Implements ThePEG::ParVectorBase.
Reimplemented in ThePEG::ParVector< T, Type >.
| virtual string ThePEG::ParVectorTBase< Type >::minimum | ( | const InterfacedBase & | ib, | |
| int | i | |||
| ) | const [virtual] |
Return the minimum value allowed for the i'th element of a container of member variables of ib.
Calls tminimum(const InterfacedBase &, int) and converts the returned value with an ostringstream.
Implements ThePEG::ParVectorBase.
| virtual string ThePEG::ParVectorTBase< Type >::maximum | ( | const InterfacedBase & | ib, | |
| int | i | |||
| ) | const [virtual] |
Return the maximum value allowed for the i'th element of a container of member variables of ib.
Calls tmaximum(const InterfacedBase &, int) and converts the returned value with an ostringstream.
Implements ThePEG::ParVectorBase.
| virtual string ThePEG::ParVectorTBase< Type >::def | ( | const InterfacedBase & | ib, | |
| int | i | |||
| ) | const [virtual] |
Return the default value for the i'th element of a container of member variables of ib.
Calls tdef(const InterfacedBase &, int) and converts the returned value with an ostringstream.
Implements ThePEG::ParVectorBase.
| virtual string ThePEG::ParVectorTBase< Type >::def | ( | ) | const [virtual] |
Return the general default value for this parameter vector.
Calls tdef() and converts the returned value with an ostringstream.
Implements ThePEG::ParVectorBase.
| Type ThePEG::ParVectorTBase< Type >::unit | ( | ) | const [inline] |
Get the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double.
If unit() is zero, the Type object is written/read directly.
Definition at line 480 of file ParVector.h.
References ThePEG::ParVectorTBase< Type >::theUnit.
Referenced by ThePEG::ParVectorTBase< Type >::putUnit().
| void ThePEG::ParVectorTBase< Type >::unit | ( | Type | u | ) | [inline] |
Set the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double.
If unit() is zero, the Type object is written/read directly.
Definition at line 487 of file ParVector.h.
References ThePEG::ParVectorTBase< Type >::theUnit.
Member Data Documentation
Type ThePEG::ParVectorTBase< Type >::theUnit [private] |
The unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double.
If unit() is zero, the Type object is written/read directly.
Definition at line 505 of file ParVector.h.
Referenced by ThePEG::ParVectorTBase< Type >::unit().
The documentation for this class was generated from the following file:
