thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4
ThePEG::Interface Namespace Reference

The Interface namespace declares a number of enums to set options for subclasses of InteracedBase. More...

Enumerations

enum  DepSafe { unsafe = false, safe = true }
 Determine whether an interface is dependency safe or not. More...
 
enum  ReadOnly { readwrite = false, readonly = true }
 Determine whether an interface is read-only or not. More...
 
enum  Limits { nolimits = 0, limited = 1, upperlim = 2, lowerlim = 3 }
 Determine whether a Parameter or ParVector is limited, either upper, lower or both. More...
 
enum  Rebind { norebind = true, rebind = false }
 Determine whether a the objects referred to by a Reference or a RefVector should be automaticlly rebound (i.e. More...
 
enum  Nullable { nonull = false, nullok = true }
 Determine whether a Reference or RefVector object may be null. More...
 
enum  NullDefault { nodefnull = false, defnull = true }
 Determine whether a null reference should be given a default value if suitable object is registered as default in the Strategy object of a run. More...
 

Detailed Description

The Interface namespace declares a number of enums to set options for subclasses of InteracedBase.

Enumeration Type Documentation

◆ DepSafe

Determine whether an interface is dependency safe or not.

Dependency safe means that other objects do not depend on the variable being interfaced.

Enumerator
unsafe 

The interface is not dependency safe.

safe 

The interface is dependency safe.

Definition at line 28 of file Interface.h.

◆ Limits

Determine whether a Parameter or ParVector is limited, either upper, lower or both.

Enumerator
nolimits 

The parameter is not limited.

limited 

The parameter is limited (both up- and downwards.

upperlim 

The parameter has only an upper limit.

lowerlim 

The parameter has only an lower limit.

Definition at line 45 of file Interface.h.

◆ Nullable

Determine whether a Reference or RefVector object may be null.

Enumerator
nonull 

The reference may not be null.

nullok 

The reference may be null.

Definition at line 65 of file Interface.h.

◆ NullDefault

Determine whether a null reference should be given a default value if suitable object is registered as default in the Strategy object of a run.

Enumerator
nodefnull 

The reference will not be set to default if null.

defnull 

The reference will be set to default if null.

Definition at line 75 of file Interface.h.

◆ ReadOnly

Determine whether an interface is read-only or not.

Enumerator
readwrite 

The interface is mutable.

readonly 

The interface is read-only.

Definition at line 36 of file Interface.h.

◆ Rebind

Determine whether a the objects referred to by a Reference or a RefVector should be automaticlly rebound (i.e.

do not need to be explicitly rebound in the rebind() function).

Enumerator
norebind 

The reference is not automatically rebound.

rebind 

The reference is automatically rebound.

Definition at line 57 of file Interface.h.