#include <RefVector.h>
Public Member Functions | |
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. | |
virtual string | exec (InterfacedBase &ib, string action, string arguments) const |
The general interface method overriding the one in InterfaceBase. | |
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 | set (InterfacedBase &ib, IBPtr ip, int i, bool chk=true) const =0 |
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 =0 |
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 =0 |
Remove the i'th element of a container of pointers of ib. | |
virtual IVector | get (const InterfacedBase &ib) const =0 |
Return a vector of pointers corresponding to the container of pointers of ib. | |
virtual bool | check (const InterfacedBase &ib, cIBPtr ip, int i) const =0 |
Check if set(ib, ip, i) will be successfull but do not do anything. | |
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. | |
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. | |
void | setSize (int sz) |
Set the size of the container being interfaced. | |
void | setVariableSize () |
Set the size of the container being interfaced to -1, i.e. | |
Private Attributes | |
int | theSize |
The size of the container being interfaced. |
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.
Definition at line 38 of file RefVector.h.
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.
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. | |
newRefClassName | the name of the class pointed to. | |
newRefTypeInfo | the type_info object of the class pointed to. | |
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. | |
norebind | if set to true, this interface is not responsible for the rebinding of corresponding objects. | |
nullable | if set to true this corresponding references may be null. | |
defnull | if set to true and a corresponding reference is null it may be given a a default value in the initialization of an EventGenerator. |
virtual string ThePEG::RefVectorBase::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", "erase" and "insert" and argument should be a something which can be read into an integer while the rest of argument should correspond to the name of an InterfacedBase object in the BaseRepository.
Implements ThePEG::InterfaceBase.
virtual void ThePEG::RefVectorBase::rebind | ( | InterfacedBase & | ib, | |
const TranslationMap & | trans, | |||
const IVector & | defs | |||
) | const [virtual] |
In the object ib, replace all pointers to objects in this interface with the translated ones provided by trans.
If a pointer is null, and defaultIfNull() is true, replace it with the first alowed object found in defs.
Reimplemented from ThePEG::InterfaceBase.
int ThePEG::RefVectorBase::size | ( | ) | const [inline] |
Get the size of the container being interfaced.
If the size() is less than 0, the size is allowed to vary.
Definition at line 166 of file RefVector.h.
References theSize.
void ThePEG::RefVectorBase::setSize | ( | int | sz | ) | [inline] |
Set the size of the container being interfaced.
If the size is less than 0, the size is allowed to vary.
Definition at line 172 of file RefVector.h.
References theSize.
void ThePEG::RefVectorBase::setVariableSize | ( | ) | [inline] |
Set the size of the container being interfaced to -1, i.e.
the size is allowed to vary.
Definition at line 178 of file RefVector.h.
References theSize.