ThePEG::DeletedBase Class 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::DeletedBase:

List of all members.

Public Member Functions
	DeletedBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo)
	Standard constructor.
virtual string	exec (InterfacedBase &ib, string action, string arguments) const
	The general interface method overriding the one in InterfaceBase.
virtual string	doxygenType () const
	Return a string describing the type of interface to be included in the Doxygen documentation.
virtual string	type () const
	Return a code for the type of this interface.

---

Detailed Description

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 44 of file Deleted.h.

---

Constructor & Destructor Documentation

ThePEG::DeletedBase::DeletedBase	(	string	newName,
		string	newDescription,
		string	newClassName,
		const type_info &	newTypeInfo
	)			[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.
	newClassName	the name of the corresponding class.
	newTypeInfo	the type_info object of the corresponding class.

Definition at line 62 of file Deleted.h.

References ThePEG::InterfaceBase::rank().

---

Member Function Documentation

virtual string ThePEG::DeletedBase::exec	(	InterfacedBase &	ib,
		string	action,
		string	arguments
	)			const [virtual]

The general interface method overriding the one in InterfaceBase.

For this class, an exception will be thrown with a message given by the description string provided in the constructor.

Implements ThePEG::InterfaceBase.

---

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

• Deleted.h