ThePEG  1.8.0
Public Types | Public Member Functions | Private Attributes | List of all members
ThePEG::InputDescription Class Reference

InputDescription objects are used by the PersistentIStream class to keep track of all classes it has read from a stream. More...

#include <InputDescription.h>

Inheritance diagram for ThePEG::InputDescription:
Inheritance graph
[legend]

Public Types

typedef vector< const InputDescription * > DescriptionVector
 A vector of pointers to InputDescription objects. More...
 
typedef ThePEG::Ptr< PersistentBase >::pointer BPtr
 Alias for a reference counted pointer to PersistentBase . More...
 
typedef ThePEG::Ptr< PersistentBase >::const_pointer cBPtr
 Alias for a reference counted pointer to a const PersistentBase . More...
 
typedef ThePEG::Ptr< PersistentBase >::transient_pointer tBPtr
 Alias for a transient pointer to PersistentBase . More...
 
typedef ThePEG::Ptr< PersistentBase >::transient_const_pointer tcBPtr
 Alias for a transient pointer to a const PersistentBase . More...
 

Public Member Functions

 InputDescription (string newName, int newVersion)
 The standard constructor. More...
 
void setDescription (const ClassDescriptionBase *cd)
 Set the ClassDescriptionBase object of the class being read.
 
void addBaseClass (const InputDescription *newBase)
 Add a base class description.
 
const DescriptionVector & descriptions () const
 Return the list of base class descriptions.
 
BPtr create () const
 Create an object of the corresponding class.
 
void input (tBPtr b, PersistentIStream &is) const
 Read an object part of the corresponding class from a stream. More...
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Private Attributes

DescriptionVector theBaseClasses
 The list of base class descriptions.
 
const ClassDescriptionBase * theDescription
 The description of the corresponding class in the current program.
 
int theVersion
 The version of the class to be read.
 

Additional Inherited Members

- Protected Member Functions inherited from ThePEG::Named
const Named & operator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Detailed Description

InputDescription objects are used by the PersistentIStream class to keep track of all classes it has read from a stream.

It keeps a pointer to the corresponding ClassDescription in case the class read in was actually present in the current program, a version number of the read class which may be different from the class present in the current program and a list of base class InputDescriptions.

See also
PersistentIStream
Named
ClassDescription

Definition at line 31 of file InputDescription.h.

Member Typedef Documentation

◆ BPtr

Alias for a reference counted pointer to PersistentBase .

Definition at line 38 of file InputDescription.h.

◆ cBPtr

Alias for a reference counted pointer to a const PersistentBase .

Definition at line 38 of file InputDescription.h.

◆ DescriptionVector

A vector of pointers to InputDescription objects.

Definition at line 36 of file InputDescription.h.

◆ tBPtr

Alias for a transient pointer to PersistentBase .

Definition at line 38 of file InputDescription.h.

◆ tcBPtr

typedef ThePEG::Ptr< PersistentBase >::transient_const_pointer ThePEG::InputDescription::tcBPtr

Alias for a transient pointer to a const PersistentBase .

Definition at line 38 of file InputDescription.h.

Constructor & Destructor Documentation

◆ InputDescription()

ThePEG::InputDescription::InputDescription ( string  newName,
int  newVersion 
)
inline

The standard constructor.

Parameters
newNamethe name of the class being read.
newVersionthe version number of the class when written.

Definition at line 47 of file InputDescription.h.

Member Function Documentation

◆ input()

void ThePEG::InputDescription::input ( tBPtr  b,
PersistentIStream &  is 
) const
inline

Read an object part of the corresponding class from a stream.

Will only read the part of the object corresponding to the members of the class represented by this object.

Definition at line 89 of file InputDescription.h.

References ThePEG::ClassDescriptionBase::input(), theDescription, and theVersion.


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