ThePEG is hosted by Hepforge, IPPP Durham
ThePEG  2.1.0
ThePEG::PersistentIStream Class Reference

PersistentIStream is used to read persistent objects from a stream where they were previously written using PersistentOStream. More...

#include <PersistentIStream.h>

Public Types

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...
 
typedef vector< BPtrObjectVector
 A vector of pointers to persistent objects.
 
typedef InputDescription::DescriptionVector DescriptionVector
 A vector of bare pointers to InputDescription objects. More...
 

Public Member Functions

 PersistentIStream (istream &is)
 Constuctor giving an input stream to be used as an underlying istream.
 
 PersistentIStream (string)
 Constuctor giving a file name to read from. More...
 
 ~PersistentIStream ()
 The destructor.
 
template<typename T >
PersistentIStreamoperator>> (RCPtr< T > &ptr)
 Operator for extracting persistent objects from the stream. More...
 
template<typename T >
PersistentIStreamoperator>> (ConstRCPtr< T > &ptr)
 Operator for extracting persistent objects from the stream. More...
 
template<typename T >
PersistentIStreamoperator>> (TransientRCPtr< T > &ptr)
 Operator for extracting persistent objects from the stream. More...
 
template<typename T >
PersistentIStreamoperator>> (TransientConstRCPtr< T > &ptr)
 Operator for extracting persistent objects from the stream. More...
 
template<typename Container >
void getContainer (Container &c)
 Intput of containers streamable objects. More...
 
BPtr getObject ()
 Read in an object. More...
 
void getObjectPart (tBPtr obj, const InputDescription *pid)
 For a given object, read the member variables corresponding to a given InputDescription object. More...
 
const InputDescriptiongetClass ()
 Read a class description from the underlying stream and return a corresponding InputDescription object.
 
PersistentIStreamsetPedantic ()
 Set pedantic mode. More...
 
PersistentIStreamsetTolerant ()
 Set tolerant mode. More...
 
bool good () const
 Check the state of the stream.
 
bool operator! () const
 Check the state of the stream.
 
 operator bool () const
 Check the state of the stream.
 
bool pedantic () const
 Check the tolerance. More...
 
const vector< string > & globalLibraries () const
 The global libraries loaded on initialization.
 
Operators for extracting built-in types from the stream.
PersistentIStreamoperator>> (string &)
 Read a character string.
 
PersistentIStreamoperator>> (char &)
 Read a character.
 
PersistentIStreamoperator>> (signed char &)
 Read a signed character.
 
PersistentIStreamoperator>> (unsigned char &)
 Read an unsigned character.
 
PersistentIStreamoperator>> (int &i)
 Read an integer.
 
PersistentIStreamoperator>> (unsigned int &i)
 Read an unsigned integer.
 
PersistentIStreamoperator>> (long &i)
 Read a long integer.
 
PersistentIStreamoperator>> (unsigned long &i)
 Read an unsigned long integer.
 
PersistentIStreamoperator>> (short &i)
 Read a short integer.
 
PersistentIStreamoperator>> (unsigned short &i)
 Read an unsigned short integer.
 
PersistentIStreamoperator>> (double &d)
 Read a double.
 
PersistentIStreamoperator>> (float &f)
 Read a float.
 
PersistentIStreamoperator>> (bool &)
 Read a bool.
 
PersistentIStreamoperator>> (Complex &)
 Read a Complex.
 

Private Member Functions

void init ()
 Internal initialization.
 
char get ()
 Get the next character from the associated istream.
 
char escaped ()
 Get the next character from the associated istream and decode it if it is escaped.
 
void setBadState ()
 Set the stream in a bad state.
 
void getSep ()
 Read a field separator from the stream.
 
void skipField ()
 Scan the stream for the next field separator.
 
bool beginObject ()
 Check if the next char to be read is a tBegin marker.
 
void endObject ()
 Scan the stream to the end of the current object. More...
 
void endBase (string classname)
 Scan stream for "end base class" marker. More...
 
istream & is ()
 Return a reference to the associated stream.
 
const istream & is () const
 Return a const reference to the associated stream.
 
 PersistentIStream ()
 Standard ctors and assignment are private and not implemented.
 
 PersistentIStream (const PersistentIStream &)
 Standard ctors and assignment are private and not implemented.
 
PersistentIStreamoperator= (const PersistentIStream &)
 Standard ctors and assignment are private and not implemented.
 

Private Attributes

ObjectVector readObjects
 Lists of objects that have been read.
 
DescriptionVector readClasses
 Lists of classes and corresponding version strings that have been read.
 
istream * theIStream
 A pointer to the associated istream.
 
bool isPedantic
 Pedantic or tolerant. More...
 
bool allocStream
 True if the associated istream should be deleted when the PersistentIStream is destroyed.
 
bool badState
 False if no errors has occurred.
 
int version
 Version number of the PersistentOStream which has written the file being read. More...
 
int subVersion
 Subversion number of the PersistentOStream which has written the file being read. More...
 
vector< string > theGlobalLibraries
 Global libraries loaded in the initialization.
 

Static Private Attributes

Special marker characters
static const char tBegin = '{'
 The special marker character indicating the beginning of an object.
 
static const char tEnd = '}'
 The special marker character indicating the end of an object.
 
static const char tNext = '|'
 The marker character indicating the beginning of the next base class in case of multiple inheritance.
 
static const char tNull = '\\'
 The special marker character indicating an escaped marker character.
 
static const char tSep = '\n'
 The special marker character indicating the end of a value.
 
static const char tNoSep = 'n'
 The special marker character used to avoid confusion with escaped tSep markers.
 
static const char tYes = 'y'
 The special marker character indicating a true boolean value.
 
static const char tNo = 'n'
 The special marker character indicating a false boolean value.
 

Detailed Description

PersistentIStream is used to read persistent objects from a stream where they were previously written using PersistentOStream.

Basic types and pointers to objects derived from PersistentBase should be read in the same order they were written out. If pedantic() is true the same classes that were written out must be present in the current program. If pedantic() is false and if an object is read for which only a base class is present in the current program, only the parts corresponding to the base class will be read, and the rest will be gracefully skipped.

Each base class of a given object will be asked to read its members from the stream starting from the least derived class going to the most derived one. Members may be pointers to other persistent objects or basic types or containers of these. The output for each object part should be implemented by specializing the ClassTraits<T>::input method, which otherwise will call the non-virtual persistentInput function of the class. Note that for diamond-shaped multiple inheritance structures, the virtual base classes will be written out several times for the same object.

See also
PersistentOStream
ClassTraits

Definition at line 48 of file PersistentIStream.h.

Member Typedef Documentation

◆ BPtr

Alias for a reference counted pointer to PersistentBase .

Definition at line 52 of file PersistentIStream.h.

◆ cBPtr

Alias for a reference counted pointer to a const PersistentBase .

Definition at line 52 of file PersistentIStream.h.

◆ DescriptionVector

A vector of bare pointers to InputDescription objects.

Definition at line 58 of file PersistentIStream.h.

◆ tBPtr

Alias for a transient pointer to PersistentBase .

Definition at line 52 of file PersistentIStream.h.

◆ tcBPtr

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

Alias for a transient pointer to a const PersistentBase .

Definition at line 52 of file PersistentIStream.h.

Constructor & Destructor Documentation

◆ PersistentIStream()

ThePEG::PersistentIStream::PersistentIStream ( string  )

Constuctor giving a file name to read from.

If the first character in the string is a '|', the corresponding program is run and its standard output is used instead. If the filename ends in ".gz" the file is uncompressed with gzip.

Member Function Documentation

◆ endBase()

void ThePEG::PersistentIStream::endBase ( string  classname)
private

Scan stream for "end base class" marker.

The classname is the name of the class currently being read and is only used for documenting exceptions.

Referenced by beginObject().

◆ endObject()

void ThePEG::PersistentIStream::endObject ( )
private

Scan the stream to the end of the current object.

If any new object are found these are read prom the stream to ensure that the pointer structure is preserved.

Referenced by beginObject().

◆ getContainer()

template<typename Container >
void ThePEG::PersistentIStream::getContainer ( Container &  c)
inline

Intput of containers streamable objects.

Parameters
cthe container into which objects are added.

Definition at line 250 of file PersistentIStream.h.

References getClass(), getObject(), getObjectPart(), and good().

Referenced by ThePEG::operator>>().

◆ getObject()

BPtr ThePEG::PersistentIStream::getObject ( )

Read in an object.

Create an object and read its data from the stream.

Returns
a pointer to the read object.

Referenced by getContainer(), and operator>>().

◆ getObjectPart()

void ThePEG::PersistentIStream::getObjectPart ( tBPtr  obj,
const InputDescription pid 
)

For a given object, read the member variables corresponding to a given InputDescription object.

Parameters
objthe object to be read into.
pida pointer to an InputDescription describing the (sub)class to be read.

Referenced by getContainer().

◆ operator>>() [1/4]

template<typename T >
PersistentIStream& ThePEG::PersistentIStream::operator>> ( RCPtr< T > &  ptr)
inline

Operator for extracting persistent objects from the stream.

Parameters
ptrthis pointer will refer to the extracted object.
Returns
a reference to the stream.

Definition at line 94 of file PersistentIStream.h.

References ThePEG::Pointer::dynamic_ptr_cast(), getObject(), and setBadState().

Referenced by operator>>().

◆ operator>>() [2/4]

template<typename T >
PersistentIStream& ThePEG::PersistentIStream::operator>> ( ConstRCPtr< T > &  ptr)
inline

Operator for extracting persistent objects from the stream.

Parameters
ptrthis pointer will refer to the extracted object.
Returns
a reference to the stream.

Definition at line 107 of file PersistentIStream.h.

References ThePEG::Pointer::dynamic_ptr_cast(), getObject(), and setBadState().

◆ operator>>() [3/4]

template<typename T >
PersistentIStream& ThePEG::PersistentIStream::operator>> ( TransientRCPtr< T > &  ptr)
inline

Operator for extracting persistent objects from the stream.

Parameters
ptrthis pointer will refer to the extracted object.
Returns
a reference to the stream.

Definition at line 120 of file PersistentIStream.h.

References ThePEG::Pointer::dynamic_ptr_cast(), getObject(), and setBadState().

◆ operator>>() [4/4]

template<typename T >
PersistentIStream& ThePEG::PersistentIStream::operator>> ( TransientConstRCPtr< T > &  ptr)
inline

Operator for extracting persistent objects from the stream.

Parameters
ptrthis pointer will refer to the extracted object.
Returns
a reference to the stream.

Definition at line 133 of file PersistentIStream.h.

References ThePEG::Pointer::dynamic_ptr_cast(), getObject(), operator>>(), and setBadState().

◆ pedantic()

bool ThePEG::PersistentIStream::pedantic ( ) const
inline

Check the tolerance.

Returns true if setPedantic() has been called or if not setTolerant() has been called.

Definition at line 328 of file PersistentIStream.h.

References isPedantic.

Referenced by getSep().

◆ setPedantic()

PersistentIStream& ThePEG::PersistentIStream::setPedantic ( )
inline

Set pedantic mode.

If the stream is set to be tolerant it is allowed to read an object from the stream even if the corresponding class is not known to the running executable, under the condition that a public base class of the unknown class is known. If the stream is set to be pedantic this is not allowed. By default, the stream is pedantic.

Definition at line 291 of file PersistentIStream.h.

References isPedantic.

Referenced by ThePEG::pedantic().

◆ setTolerant()

PersistentIStream& ThePEG::PersistentIStream::setTolerant ( )
inline

Set tolerant mode.

If the stream is set to be tolerant it is allowed to read an object from the stream even if the corresponding class is not known to the running executable, under the condition that a public base class of the unknown class is known. If the stream is set to be pedantic this is not allowed. By default, the stream is pedantic.

Definition at line 304 of file PersistentIStream.h.

References isPedantic.

Referenced by ThePEG::tolerant().

Member Data Documentation

◆ isPedantic

bool ThePEG::PersistentIStream::isPedantic
private

Pedantic or tolerant.

See description of the setPedantic() and setTolerant() methods.

Definition at line 445 of file PersistentIStream.h.

Referenced by pedantic(), setPedantic(), and setTolerant().

◆ subVersion

int ThePEG::PersistentIStream::subVersion
private

Subversion number of the PersistentOStream which has written the file being read.

Definition at line 464 of file PersistentIStream.h.

◆ version

int ThePEG::PersistentIStream::version
private

Version number of the PersistentOStream which has written the file being read.

Definition at line 460 of file PersistentIStream.h.


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