thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::RefVector< T, R > Class Template Reference

The RefVector and its base class RefVectorBase defines an interface to a class derived from the InterfacedBase, through which vectors (or any other container) of pointers to other InterfacedBase objects may be manipulated. More...

#include <RefVector.h>

Inheritance diagram for ThePEG::RefVector< T, R >:

Public Types

typedef Ptr< R >::pointer RefPtr
 A pointer to the class of objects referred to. More...
 
typedef Ptr< R >::const_pointer cRefPtr
 A const pointer to the class of objects referred to. More...
 
typedef void(T::* SetFn) (RefPtr, int)
 A pointer to a menberfunction to be used for the 'set' action. More...
 
typedef void(T::* InsFn) (RefPtr, int)
 A pointer to a menberfunction to be used for the 'insert' action. More...
 
typedef void(T::* DelFn) (int)
 A pointer to a menberfunction to be used for the 'erase' action. More...
 
typedef bool(T::* CheckFn) (cRefPtr, int) const
 A pointer to a menberfunction to be used for the 'check' action. More...
 
typedef vector< RefPtr >(T::* GetFn) () const
 A pointer to a menberfunction to be used for the 'get' action. More...
 
typedef vector< RefPtr > T::* Member
 Declaration of a direct pointer to the member variable in case it is a vector.
 

Public Member Functions

 RefVector (string newName, string newDescription, Member newMember, int newSize, bool depSafe=false, bool readonly=false, bool rebind=true, bool nullable=true, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, CheckFn newCheckFn=0)
 Standard constructor. More...
 
 RefVector (string newName, string newDescription, Member newMember, int newSize, bool depSafe, bool readonly, bool rebind, bool nullable, bool defnull, SetFn newSetFn=0, InsFn newInsFn=0, DelFn newDelFn=0, GetFn newGetFn=0, CheckFn newCheckFn=0)
 Standard constructor. More...
 
virtual void set (InterfacedBase &ib, IBPtr ip, int i, bool chk=true) const
 Set the i'th element of a container of pointers of ib to ip.
 
virtual void insert (InterfacedBase &ib, IBPtr ip, int i, bool chk=true) const
 Insert a new pointer before the i'th element of a container of pointers of ib and set it to ip.
 
virtual void erase (InterfacedBase &ib, int i) const
 Remove the i'th element of a container of pointers of ib.
 
virtual void clear (InterfacedBase &ib) const
 Clear the container of pointers of ib.
 
virtual IVector get (const InterfacedBase &ib) const
 Return a vector of pointers corresponding to the container of pointers of ib.
 
virtual bool check (const InterfacedBase &ib, cIBPtr, int i) const
 Check if set(ib, ip, i) will be successfull but do not do anything.
 
void setSetFunction (SetFn sf)
 Give a pointer to a member function to be used by 'set()'.
 
void setInsertFunction (InsFn ifn)
 Give a pointer to a member function to be used by 'insert()'.
 
void setGetFunction (GetFn gf)
 Give a pointer to a member function to be used by 'get()'.
 
void setEraseFunction (DelFn df)
 Give a pointer to a member function to be used by 'erase()'.
 
void setCheckFunction (CheckFn cf)
 Give a pointer to a member function to be used by 'check()'.
 
- Public Member Functions inherited from ThePEG::RefVectorBase
 RefVectorBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, string newRefClassName, const type_info &newRefTypeInfo, int newSize, bool depSafe, bool readonly, bool norebind, bool nullable, bool defnull)
 Standard constructor. More...
 
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 reference vector.
 
virtual string type () const
 Return a code for the type of this reference.
 
virtual string doxygenType () const
 Return a string describing the type of interface to be included in the Doxygen documentation.
 
virtual void rebind (InterfacedBase &ib, const TranslationMap &trans, const IVector &defs) const
 In the object ib, replace all pointers to objects in this interface with the translated ones provided by trans. More...
 
virtual IVector getReferences (const InterfacedBase &ib) const
 Return pointers to other objects in ib.
 
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::RefInterfaceBase
 RefInterfaceBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, string newRefClassName, const type_info &newRefTypeInfo, bool depSafe, bool readonly, bool norebind, bool nullable, bool defnull)
 Standard constructor. More...
 
string refClassName () const
 Return the class name of the class referred to by this interface.
 
const type_info & refTypeInfo () const
 Return the type_info object of the class referred to by this interface.
 
bool noRebind () const
 Get the flag saying whether the interface is responsible for rebinding of the corresponding refenerces.
 
void setNoRebind ()
 Set the flag saying that the interface is not responsible for rebinding refenerces.
 
void setRebind ()
 Set the flag saying that the interface is responsible for rebinding refenerces.
 
bool noNull () const
 Get the flag saying whether the interface is allowed to set the reference to null.
 
void setNullable ()
 Set the flag saying that the interface it is allowed to set the reference to null.
 
void setNotNullable ()
 Set the flag saying that the interface it is not allowed to set the reference to null.
 
bool defaultIfNull () const
 Get the flag saying wether a null pointer should be replaced by a default of suitable class when rebind is called.
 
void setDefaultIfNull ()
 Set the flag saying that a null pointer should be replaced by a default of suitable class when rebind is called.
 
void setNoDefaultIfNull ()
 Set the flag saying that a null pointer should not be replaced by a default of suitable class when rebind is called.
 
- 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.
 
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.
 
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.
 
SetFn theSetFn
 A pointer to a member function to be used by 'set()'.
 
InsFn theInsFn
 Give a pointer to a member function to be used by 'insert()'.
 
DelFn theDelFn
 Give a pointer to a member function to be used by 'erase()'.
 
GetFn theGetFn
 Give a pointer to a member function to be used by 'get()'.
 
CheckFn theCheckFn
 Give a pointer to a member function to be used by 'check()'.
 

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 Namedoperator= (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<class T, class R>
class ThePEG::RefVector< T, R >

The RefVector and its base class RefVectorBase defines an interface to a class derived from the InterfacedBase, through which vectors (or any other container) of pointers to other InterfacedBase objects may be manipulated.

RefVector is templated on the type of the class and the class of the objects pointed to, and is derived from the InterfaceBase class via RefVectorBase and RefInterfaceBase.

For each InterfacedBase class exactly one static RefVector 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
InterfacedBase
InterfaceBase

Definition at line 215 of file RefVector.h.

Member Typedef Documentation

◆ CheckFn

template<class T , class R >
typedef bool(T::* ThePEG::RefVector< T, R >::CheckFn) (cRefPtr, int) const

A pointer to a menberfunction to be used for the 'check' action.

Definition at line 230 of file RefVector.h.

◆ cRefPtr

template<class T , class R >
typedef Ptr<R>::const_pointer ThePEG::RefVector< T, R >::cRefPtr

A const pointer to the class of objects referred to.

Definition at line 222 of file RefVector.h.

◆ DelFn

template<class T , class R >
typedef void(T::* ThePEG::RefVector< T, R >::DelFn) (int)

A pointer to a menberfunction to be used for the 'erase' action.

Definition at line 228 of file RefVector.h.

◆ GetFn

template<class T , class R >
typedef vector<RefPtr>(T::* ThePEG::RefVector< T, R >::GetFn) () const

A pointer to a menberfunction to be used for the 'get' action.

Definition at line 232 of file RefVector.h.

◆ InsFn

template<class T , class R >
typedef void(T::* ThePEG::RefVector< T, R >::InsFn) (RefPtr, int)

A pointer to a menberfunction to be used for the 'insert' action.

Definition at line 226 of file RefVector.h.

◆ RefPtr

template<class T , class R >
typedef Ptr<R>::pointer ThePEG::RefVector< T, R >::RefPtr

A pointer to the class of objects referred to.

Definition at line 220 of file RefVector.h.

◆ SetFn

template<class T , class R >
typedef void(T::* ThePEG::RefVector< T, R >::SetFn) (RefPtr, int)

A pointer to a menberfunction to be used for the 'set' action.

Definition at line 224 of file RefVector.h.

Constructor & Destructor Documentation

◆ RefVector() [1/2]

template<class T , class R >
ThePEG::RefVector< T, R >::RefVector ( string  newName,
string  newDescription,
Member  newMember,
int  newSize,
bool  depSafe = false,
bool  readonly = false,
bool  rebind = true,
bool  nullable = true,
SetFn  newSetFn = 0,
InsFn  newInsFn = 0,
DelFn  newDelFn = 0,
GetFn  newGetFn = 0,
CheckFn  newCheckFn = 0 
)

Standard constructor.

Parameters
newNamethe name of the interface, may only contain letters [a-zA-z0-9_].
newDescriptiona brief description of the interface.
newMembera pointer to a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newSizethe size of the container or -1 if varying.
depSafeset to true if calls to this interface for one object does not influence other objects.
readonlyif 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.
rebindif set to true, this interface is responsible for the rebinding of corresponding objects.
nullableif set to true this corresponding references may be null.
newSetFnoptional pointer to member function for the 'set' action.
newInsFnoptional pointer to member function for the 'insert' action.
newDelFnoptional pointer to member function for the 'erase' action.
newGetFnoptional pointer to member function for the 'get' action.
newCheckFnoptional pointer to member function for the 'check' action.

◆ RefVector() [2/2]

template<class T , class R >
ThePEG::RefVector< T, R >::RefVector ( string  newName,
string  newDescription,
Member  newMember,
int  newSize,
bool  depSafe,
bool  readonly,
bool  rebind,
bool  nullable,
bool  defnull,
SetFn  newSetFn = 0,
InsFn  newInsFn = 0,
DelFn  newDelFn = 0,
GetFn  newGetFn = 0,
CheckFn  newCheckFn = 0 
)

Standard constructor.

Parameters
newNamethe name of the interface, may only contain letters [a-zA-z0-9_].
newDescriptiona brief description of the interface.
newMembera pointer to a Member which is a TypeVector. May be null, in which case the pointers to member functions must be specified.
newSizethe size of the container or -1 if varying.
depSafeset to true if calls to this interface for one object does not influence other objects.
readonlyif 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.
rebindif set to true, this interface is responsible for the rebinding of corresponding objects.
nullableif set to true this corresponding references may be null.
defnullif set to true and a corresponding reference is null it may be given a a default value in the initialization of an EventGenerator.
newSetFnoptional pointer to member function for the 'set' action.
newInsFnoptional pointer to member function for the 'insert' action.
newDelFnoptional pointer to member function for the 'erase' action.
newGetFnoptional pointer to member function for the 'get' action.
newCheckFnoptional pointer to member function for the 'check' action.

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