HEPREP::HepRepReader Class Reference

#include <HepRepReader.h>

Public Member Functions
virtual	~HepRepReader ()
	Destructor.
virtual std::string	getProperty (std::string key, std::string defaultValue)=0
virtual bool	close ()=0
virtual bool	hasRandomAccess ()=0
virtual HepRep *	read (std::string name)=0
virtual std::string	entryName ()=0
virtual std::vector< std::string >	entryNames ()=0
virtual bool	hasSequentialAccess ()=0
virtual bool	reset ()=0
virtual int	size ()=0
virtual int	skip (int n)=0
virtual bool	hasNext ()=0
virtual HepRep *	next ()=0

Detailed Description

HepRepReader interface.

Author

Mark Donszelmann

Definition at line 24 of file HepRepReader.h.

Constructor & Destructor Documentation

~HepRepReader()

virtual HEPREP::HepRepReader::~HepRepReader ( )

inlinevirtual

Destructor.

Definition at line 28 of file HepRepReader.h.

{ /* nop */; }

Member Function Documentation

close()

virtual bool HEPREP::HepRepReader::close ( )

pure virtual

Closes the reader and its underlying stream.

Returns

false in case of a stream problem.

entryName()

virtual std::string HEPREP::HepRepReader::entryName ( )

pure virtual

Returns the current entry name (random acces only).

Returns

name of the current entry or null if not supported.

entryNames()

virtual std::vector< std::string > HEPREP::HepRepReader::entryNames ( )

pure virtual

Returns a list of names of available entries (random rccess only). Zip files may contain instructions to skip a number of files. These files will not be included in the entries.

Returns

list of entrynames or null if not supported.

getProperty()

virtual std::string HEPREP::HepRepReader::getProperty ( std::string  key, std::string  defaultValue  )

pure virtual

Returns a property (if set in the heprep.properties file).

Parameters

key	property name
defaultValue	value if property not found

hasNext()

virtual bool HEPREP::HepRepReader::hasNext ( )

pure virtual

Is there a next heprep.

Returns

true if the next heprep is available.

hasRandomAccess()

virtual bool HEPREP::HepRepReader::hasRandomAccess ( )

pure virtual

Allows random access.

Returns

true if this reader provides random access

hasSequentialAccess()

virtual bool HEPREP::HepRepReader::hasSequentialAccess ( )

pure virtual

Allows for sequential access.

Returns

true if sequential access is possible.

next()

virtual HepRep * HEPREP::HepRepReader::next ( )

pure virtual

Reads the next HepRep from the Reader.

Returns

heprep.

read()

virtual HepRep * HEPREP::HepRepReader::read ( std::string  name )

pure virtual

Reads a HepRep by name (random access only).

Parameters

name	for the heprep to be read.

Returns

heprep.

reset()

virtual bool HEPREP::HepRepReader::reset ( )

pure virtual

Resets a sequential HepRep reader.

Returns

false in case of a stream problem.

size()

virtual int HEPREP::HepRepReader::size ( )

pure virtual

Returns the (estimated) number of HepReps in the reader. Zip files may contain instructions to skip a number of files. These files will not be included in the estimate.

Returns

number of HepReps, or -1 if cannot be calculated.

skip()

virtual int HEPREP::HepRepReader::skip ( int  n )

pure virtual

Skips a number of HepReps in the reader. Zip files may contain instructions to skip a number of files. These files will not be included in the count to be skipped.

Parameters

n	number of HepReps to be skipped.

Returns

number of HepReps skipped.

---

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

• HepRepReader.h