ThePEG::Deleted< T > Class Template Reference

The DeletedBase and its templated Deleted sub-class defines an interface to a class derived from the InterfacedBase. More...

#include <Deleted.h>

Inheritance diagram for ThePEG::Deleted< T >:

ThePEG::DeletedBase ThePEG::InterfaceBase ThePEG::Named

List of all members.

Public Member Functions

 Deleted (string newName, string newDescription)
 Standard constructor.


Detailed Description

template<class T>
class ThePEG::Deleted< T >

The DeletedBase and its templated Deleted sub-class defines an interface to a class derived from the InterfacedBase.

It should be used when an interface is removed to provide a user-friendly message indicating why it was removed and possibly which interface should be used instead.

For each deleted interface to be defined for a class T, exactly one static object of the Deleted<T> must be created and initialized as follows:

Deleted<T> delint(name, description);

Where name is an identifier std::string which should only contain letters [a-zA-z0-9_] and description is an arbitrary std::string

The Deleted class, as all other InterfaceBase classes are mainly used in the BaseRepository class.

See also:
InterfacedBase

InterfaceBase

BaseRepository

Definition at line 119 of file Deleted.h.


Constructor & Destructor Documentation

template<class T>
ThePEG::Deleted< T >::Deleted ( string  newName,
string  newDescription 
) [inline]

Standard constructor.

Parameters:
newName the name of the interface, may only contain letters [a-zA-z0-9_].
newDescription a brief description of the interface.

Definition at line 132 of file Deleted.h.


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

Generated on Thu Apr 29 12:43:06 2010 for ThePEG by  doxygen 1.5.5