ThePEG::ClassDescriptionBase Class Reference

ClassDescriptionBase is the base class for all class description classes. More...

#include <ClassDescription.h>

Inheritance diagram for ThePEG::ClassDescriptionBase:

List of all members.

Public Types

typedef vector< const
ClassDescriptionBase * > DescriptionVector

A vector of class descriptions.

Public Member Functions

virtual ~ClassDescriptionBase ()

Empty destructor.

const type_info & info () const

The standart RTTI type_info object for the described class.

int version () const

The version of the described class.

string library () const

The name of a file containing the dynamic library where the class is implemented.

bool check () const

Return true if this object was set up properly.

const DescriptionVector & descriptions () const

Return the descriptions of the base classes of the described class.

virtual void setup ()=0

Set up the base class information for this object.

virtual BPtr create () const =0

Create an object of the described class.

virtual void output (tcBPtr b, PersistentOStream &os) const =0

Output the members of an object of the described class to a persistent stream.

virtual void input (tBPtr b, PersistentIStream &is, int oldVersion) const =0

Read the members of an object of the described class from a persistent stream.

bool isA (const ClassDescriptionBase &base) const

Return true if the class described by the argument is a base class of the class described by this.

bool abstract () const

Return true if the corresponding class is abstract.

Protected Member Functions

ClassDescriptionBase (string newName, const type_info &newInfo, int newVersion, string newLibrary, bool abst)

The constructor used by sub-classes.

void baseClasses (DescriptionVector::iterator first, DescriptionVector::iterator last)

Set the base classes.

Private Attributes

int theVersion

The version of the described class.

string theLibrary

The library file where this class may be found.

const type_info & theInfo

The type_info object for the described class.

DescriptionVector theBaseClasses

The vector of base classes.

bool isAbstract

True if this class is abstract.

bool done

True if this object was set up properly.

Detailed Description

ClassDescriptionBase is the base class for all class description classes.

ClassDescriptionBase is the non-templated base class for the templated ClassDescriptionTBase, ClassDescription, AbstractClassDescription, NoPIOClassDescription and AbstractNoPIOClassDescription classes. An instantiation of one of these classes represents a meta class encapsulating information about the template argument class. This information is obtained from the templated ClassTraits class which can be specialized for any given class should the default information not be satisfactory. Information is also obtained from the templated BaseClassTraits class which must be specialized for each class declaring a typedef for each of its base classes.

The information about a class stored in a ClassDescriptionBase objects is the following:
a platform-independent class name,
a reference to the type_info
an integer version number,
a vector of ClassDescriptionBase* corresponding to the base classes,
methods for reading/writing members of a class from/to a PersistentIStream/PersistentOStream and
a method for creating an object of a class.

The ClassDescriptionBase objects should be created before main() is executed, and shouold therfore be instantiated as static member variables. Only one ClassDescriptionBase object shall be instantiated for each class to be described. The ClassDescriptionBase objects are automatically stored in a purely static DescriptionList class.

AbstractClassDescription and AbstractNoPIOClassDescription should be used for abstract base classes, while NoPIOClassDescription and AbstractNoPIOClassDescription should be used for classes which do not have any members which need to be read and written persistently.

See also:

Definition at line 63 of file ClassDescription.h.

Member Typedef Documentation

typedef vector<const ClassDescriptionBase *> ThePEG::ClassDescriptionBase::DescriptionVector

A vector of class descriptions.

Definition at line 68 of file ClassDescription.h.

Constructor & Destructor Documentation

ThePEG::ClassDescriptionBase::ClassDescriptionBase	(	string	newName,
		const type_info &	newInfo,
		int	newVersion,
		string	newLibrary,
		bool	abst
	)			`[inline, protected]`

The constructor used by sub-classes.

Parameters:

	newName	the platform independent name of the class.
	newInfo	the type_info object corresponding to the class.
	newVersion	the implementation version of the class.
	newLibrary	the name of a file containing the dynamic
	abst	true if the class is abstract. library where the class is implemented.

Definition at line 81 of file ClassDescription.h.

Member Function Documentation

virtual void ThePEG::ClassDescriptionBase::output	(	tcBPtr	b,
		PersistentOStream &	os
	)			const `[pure virtual]`

Output the members of an object of the described class to a persistent stream.

Parameters:

	b	the object to be written.
	os	the persistent stream.

virtual void ThePEG::ClassDescriptionBase::input	(	tBPtr	b,
		PersistentIStream &	is,
		int	oldVersion
	)			const `[pure virtual]`

Read the members of an object of the described class from a persistent stream.

Parameters:

	b	the object to be read.
	is	the persistent stream.
	oldVersion	the version number of the object when it was written.

Referenced by ThePEG::InputDescription::input().

void ThePEG::ClassDescriptionBase::baseClasses	(	DescriptionVector::iterator	first,
		DescriptionVector::iterator	last
	)			`[inline, protected]`

Set the base classes.

Parameters:

	first	an iterator refering to the first base class
	last	an iterator giving the end of the range of base class descriptions.

Definition at line 169 of file ClassDescription.h.

References done, and theBaseClasses.

Referenced by ThePEG::ClassDescriptionTBase< ThePEG::BreitWignerMass >::setup().

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

ClassDescription.h


Public Types
typedef vector< const ClassDescriptionBase * >	DescriptionVector
	A vector of class descriptions.
Public Member Functions
virtual	~ClassDescriptionBase ()
	Empty destructor.
const type_info &	info () const
	The standart RTTI type_info object for the described class.
int	version () const
	The version of the described class.
string	library () const
	The name of a file containing the dynamic library where the class is implemented.
bool	check () const
	Return true if this object was set up properly.
const DescriptionVector &	descriptions () const
	Return the descriptions of the base classes of the described class.
virtual void	setup ()=0
	Set up the base class information for this object.
virtual BPtr	create () const =0
	Create an object of the described class.
virtual void	output (tcBPtr b, PersistentOStream &os) const =0
	Output the members of an object of the described class to a persistent stream.
virtual void	input (tBPtr b, PersistentIStream &is, int oldVersion) const =0
	Read the members of an object of the described class from a persistent stream.
bool	isA (const ClassDescriptionBase &base) const
	Return true if the class described by the argument is a base class of the class described by this.
bool	abstract () const
	Return true if the corresponding class is abstract.
Protected Member Functions
	ClassDescriptionBase (string newName, const type_info &newInfo, int newVersion, string newLibrary, bool abst)
	The constructor used by sub-classes.
void	baseClasses (DescriptionVector::iterator first, DescriptionVector::iterator last)
	Set the base classes.
Private Attributes
int	theVersion
	The version of the described class.
string	theLibrary
	The library file where this class may be found.
const type_info &	theInfo
	The type_info object for the described class.
DescriptionVector	theBaseClasses
	The vector of base classes.
bool	isAbstract
	True if this class is abstract.
bool	done
	True if this object was set up properly.