ThePEG is hosted by Hepforge, IPPP Durham
ThePEG  2.1.0
ThePEG::ClassDocumentationBase Class Reference

The ClassDocumentationBase class is used to communicate documetation about an Interfaced class to the Repository. More...

#include <ClassDocumentation.h>

Inheritance diagram for ThePEG::ClassDocumentationBase:

Public Member Functions

virtual ~ClassDocumentationBase ()
 The destructor.
 
string documentation () const
 Return the brief documentation of the corresponding class.
 
string modelDescription () const
 Return the model description of the corresponding class.
 
string modelReferences () const
 Return the model references of the corresponding class.
 

Protected Member Functions

 ClassDocumentationBase (string newDocumentation, string newModelDescription, string newModelReferences, const type_info &newTypeInfo)
 The standard constructor can only be used from subclasses. More...
 

Private Member Functions

 ClassDocumentationBase ()
 Private and unimplemented default constructor.
 
 ClassDocumentationBase (const ClassDocumentationBase &)
 Private and unimplemented copy constructor.
 
ClassDocumentationBaseoperator= (const ClassDocumentationBase &)
 Private and unimplemented assignment operator.
 

Private Attributes

string theDocumentation
 The brief documentation of the corresponding class.
 
string theModelDescription
 The model description of the corresponding class.
 
string theModelReferences
 The model references of the corresponding class.
 

Detailed Description

The ClassDocumentationBase class is used to communicate documetation about an Interfaced class to the Repository.

Similarly to classes inheriting from InterfaceBase, only one static object of the templated ClassDocumentation, which inherits from ClassDocumentationBase, should be created for each Interfaced class. This object will then automatically register itself with the static Repository.

The ClassDocumentationBase contains three strings with information which are all specified in the constructor:

The documentation contains a brief description of the corresponding class which can be displayed by the Repository (or user interfaces derived from it).

The model description contains a very brief description of the model of the process implemented in the step handler, given in the form of a LaTeX \item. This is written to a file after a run by an EventGenerator.

The model references contains possible LaTeX \bibitems corresponding to \cite commands in the model description. This is also written to a file after a run by an EventGenerator.

See also
Interfaced
Repository

Definition at line 48 of file ClassDocumentation.h.

Constructor & Destructor Documentation

◆ ClassDocumentationBase()

ThePEG::ClassDocumentationBase::ClassDocumentationBase ( string  newDocumentation,
string  newModelDescription,
string  newModelReferences,
const type_info &  newTypeInfo 
)
protected

The standard constructor can only be used from subclasses.

Parameters
newDocumentationthe documentation for the corresponding class.
newModelDescriptionthe model description for the corresponding class.
newModelReferencesthe model references of the corresponding class..
newTypeInfothe type_info object of the corresponding class.

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