ThePEG is hosted by Hepforge, IPPP Durham
ThePEG  2.1.0
ThePEG::ClassDocumentation< T > Class Template Reference

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

#include <ClassDocumentation.h>

Inheritance diagram for ThePEG::ClassDocumentation< T >:

Public Member Functions

 ClassDocumentation (string newDocumentation, string newModelDescription="", string newModelReferences="")
 The standard constructor. More...
 
- Public Member Functions inherited from ThePEG::ClassDocumentationBase
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.
 

Private Member Functions

 ClassDocumentation ()
 Private and unimplemented default constructor.
 
 ClassDocumentation (const ClassDocumentation &)
 Private and unimplemented copy constructor.
 
ClassDocumentationoperator= (const ClassDocumentation &)
 Private and unimplemented assignment operator.
 

Additional Inherited Members

- Protected Member Functions inherited from ThePEG::ClassDocumentationBase
 ClassDocumentationBase (string newDocumentation, string newModelDescription, string newModelReferences, const type_info &newTypeInfo)
 The standard constructor can only be used from subclasses. More...
 

Detailed Description

template<typename T>
class ThePEG::ClassDocumentation< T >

The ClassDocumentation 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 ClassDocumentation should in the constructor specify three strings with information:

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 160 of file ClassDocumentation.h.

Constructor & Destructor Documentation

◆ ClassDocumentation()

template<typename T >
ThePEG::ClassDocumentation< T >::ClassDocumentation ( string  newDocumentation,
string  newModelDescription = "",
string  newModelReferences = "" 
)
inline

The standard constructor.

All other constructors are private.

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

Definition at line 173 of file ClassDocumentation.h.

References ThePEG::ClassDocumentationBase::operator=().


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