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

The Switch class and its base class SwitchBase defines an interface to a class derived from the InterfacedBase, through which simple integer member variables can be manuipulated and set to a pre-defined set of values (options). More...

#include <Switch.h>

Inheritance diagram for ThePEG::Switch< T, Int >:

Public Types

typedef void(T::* SetFn) (Int)
 The declaration of member functions which can be used by this Switch interface for the 'set' action.
 
typedef Int(T::* GetFn) () const
 The declaration of member functions which can be used by this Switch interface for the 'get' action.
 
typedef Int T::* Member
 Declaration of a direct pointer to the member variable.
 
- Public Types inherited from ThePEG::SwitchBase
typedef map< long, SwitchOptionOptionMap
 A map with SwitchOptions indexed by their values. More...
 
typedef map< string, SwitchOptionStringMap
 A map with SwitchOptions indexed by their names. More...
 

Public Member Functions

 Switch (string newName, string newDescription, Member newMember, Int newDef, bool depSafe=false, bool readonly=false, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newDefFn=0)
 Standard constructor. More...
 
virtual void set (InterfacedBase &ib, long val) const
 Set the member variable of ib to val.
 
virtual long get (const InterfacedBase &ib) const
 Return the value of the member variable of ib.
 
virtual long def (const InterfacedBase &ib) const
 Return the default value for the member variable of ib.
 
void setSetFunction (SetFn sf)
 Give a pointer to a member function to be used by 'set()'.
 
void setGetFunction (GetFn gf)
 Give a pointer to a member function to be used by 'get()'.
 
void setDefaultFunction (GetFn df)
 Give a pointer to a member function to be used by 'def()'.
 
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::SwitchBase
 SwitchBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, bool depSafe, bool readonly)
 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 switch.
 
virtual string type () const
 Return a code for the type of this switch.
 
void setDef (InterfacedBase &i) const
 Set the member variable of ib to its default value.
 
bool check (long newValue) const
 Check if val is among the listed options.
 
const OptionMapoptions () const
 Return the map relating options to their values.
 
virtual string doxygenType () const
 Return a string describing the type of interface to be included in the Doxygen documentation.
 
string opttag (long opt) const
 Return a string with the option index and its associated tag.
 
- 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.
 
Int theDef
 Default value to be used if no corresponding member function pointers are given.
 
SetFn theSetFn
 A pointer to a member function to be used by 'set()'.
 
GetFn theGetFn
 Pointer to member function to be used by get().
 
GetFn theDefFn
 Pointer to member function to be used by def().
 

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::SwitchBase
void registerOption (const SwitchOption &o)
 Register a new option.
 
- 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<typename T, typename Int>
class ThePEG::Switch< T, Int >

The Switch class and its base class SwitchBase defines an interface to a class derived from the InterfacedBase, through which simple integer member variables can be manuipulated and set to a pre-defined set of values (options).

Switch is templated on the type of the integer member variable (also enums and bool are allowed) and the type of the class, and is derived from the InterfaceBase class via SwitchBase.

The Switch class has a set of Named SwitchOptions, which limits the values possible to set.

For each InterfacedBase class exactly one static Switch object should created for each member variable which should be interfaced. This object will automatically register itself with the BaseRepository class. Also for each Switch object exactly one static SwitchOption object should be created for each valid integer option.

See also
InterfacedBase
InterfacedBase
Named

Definition at line 273 of file Switch.h.

Constructor & Destructor Documentation

◆ Switch()

template<typename T, typename Int>
ThePEG::Switch< T, Int >::Switch ( string  newName,
string  newDescription,
Member  newMember,
Int  newDef,
bool  depSafe = false,
bool  readonly = false,
SetFn  newSetFn = 0,
GetFn  newGetFn = 0,
GetFn  newDefFn = 0 
)
inline

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 the member variable. May be null if corresponding set/get functions are provided.
newDefthe default value for the member variable.
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.
newSetFnoptional pointer to the member function for the 'set' action.
newGetFnoptional pointer to the member function for the 'get' action.
newDefFnoptional pointer to the member function for the 'def' action.

Definition at line 324 of file Switch.h.


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