thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.5
ThePEG::ReferenceBase Class Referenceabstract

The Reference class and its base class ReferenceBase defines an interface to a class derived from the InterfacedBase, through which pointers to other InterfacedBase objects may be manipulated. More...

#include <Reference.h>

Inheritance diagram for ThePEG::ReferenceBase:

Public Member Functions

 ReferenceBase (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...
 
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.
 
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, bool chk=true) const =0
 Set the pointer of ib to ip.
 
virtual IBPtr get (const InterfacedBase &ib) const =0
 Return the pointer of ib.
 
virtual bool check (const InterfacedBase &ib, cIBPtr ip) const =0
 Check if set(ib, ip) 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 the pointer in this interface with one of the translated ones provided by trans. More...
 
virtual IVector getReferences (const InterfacedBase &ib) const
 Return the pointer to another object in ib (in a vector).
 
- 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.
 

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

The Reference class and its base class ReferenceBase defines an interface to a class derived from the InterfacedBase, through which pointers to other InterfacedBase objects may be manipulated.

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

For each InterfacedBase class exactly one static Reference 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 37 of file Reference.h.

Constructor & Destructor Documentation

◆ ReferenceBase()

ThePEG::ReferenceBase::ReferenceBase ( 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.

Parameters
newNamethe name of the interface, may only contain letters [a-zA-z0-9_].
newDescriptiona brief description of the interface.
newClassNamethe name of the corresponding class.
newTypeInfothe type_info object of the corresponding class.
newRefClassNamethe name of the class pointed to.
newRefTypeInfothe type_info object of the class pointed to.
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.
norebindif set to true, this interface is not 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.

Member Function Documentation

◆ exec()

virtual string ThePEG::ReferenceBase::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" and "get" and argument should correspond to the name of an InterfacedBase object in the BaseRepository.

Implements ThePEG::InterfaceBase.

◆ rebind()

virtual void ThePEG::ReferenceBase::rebind ( InterfacedBase ib,
const TranslationMap trans,
const IVector defs 
) const
virtual

In the object ib, replace the pointer in this interface with one of the translated ones provided by trans.

If the pointer is null, and defaultIfNull() is true, replace it with the first allowed object found in defs.

Reimplemented from ThePEG::InterfaceBase.


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