hep.lcio.io

Interface LCReader

public interface LCReader

Interface for reading data from LCIO. Use LCFactory to instantiate a corresponding LCWriter object for the output format at hand (SIO only, so far).

See Also:

LCFactory

Field Summary

Fields

Modifier and Type	Field and Description
static int	directAccess Configuration flags for the LCReader instance - to be used with LCFactory::createLCReader().

Method Summary

Modifier and Type	Method and Description
void	close() Closes the output file/stream etc.
void	open(String filename) Opens a file for reading (read-only).
void	open(String[] filenames) Opens a list of files for reading (read-only).
LCEvent	readEvent(int runNumber, int evtNumber) Reads the specified event from file.
LCEvent	readEvent(int runNumber, int evtNumber, int accessMode) Same as LCEvent* readEvent(int runNumber, int evtNumber) allowing to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.
LCEvent	readNextEvent() Reads the next event from the file.
LCEvent	readNextEvent(int accessMode) Same as readNextEvent() but allows to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.
LCRunHeader	readNextRunHeader() Reads the next run header from the file.
LCRunHeader	readNextRunHeader(int accessMode) Same as readNextRunHeader() but allows to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.
LCRunHeader	readRunHeader(int runNumber) Reads the specified runHeader from file.
LCRunHeader	readRunHeader(int runNumber, int accessMode) Same as LCEvent* readRunHeader(int runNumber) allowing to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.
void	readStream() Reads the input stream and notifies registered listeners according to the object type found in the stream.
void	readStream(int maxRecord) Reads maxRecord from the input stream and notifies registered listeners according to the object type found in the stream.
void	registerLCEventListener(LCEventListener ls) Registers a listener for reading LCEvents from a stream.
void	registerLCRunListener(LCRunListener ls) Registers a listener for reading LCEventsLCRunHeaders from a stream.
void	removeLCEventListener(LCEventListener ls) Remove a listener for reading LCEvents from a stream.
void	removeLCRunListener(LCRunListener ls) Remove a listener for reading LCRunHeaders from a stream.
void	skipNEvents(int n) Skips the next n events from the current position.

Field Detail

directAccess

static final int directAccess

Configuration flags for the LCReader instance - to be used with LCFactory::createLCReader().

See Also:

Constant Field Values

Method Detail

open

void open(String filename)
   throws IOException

Opens a file for reading (read-only).

Throws:

IOException

open

void open(String[] filenames)
   throws IOException

Opens a list of files for reading (read-only). All subsequent read operations will operate on the list, i.e. if an EOF is encountered the next file in the list will be opened and read transparently to the user.

Throws:

IOException

readNextRunHeader

LCRunHeader readNextRunHeader()
                       throws IOException

Reads the next run header from the file. Returns NULL if 'EOF' read.

Throws:

IOException

readNextRunHeader

LCRunHeader readNextRunHeader(int accessMode)
                       throws IOException

Same as readNextRunHeader() but allows to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.

Throws:

IOException

readNextEvent

LCEvent readNextEvent()
               throws IOException

Reads the next event from the file. Returns NULL if 'EOF' read.

Throws:

IOException

readNextEvent

LCEvent readNextEvent(int accessMode)
               throws IOException

Same as readNextEvent() but allows to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.

Throws:

IOException

skipNEvents

void skipNEvents(int n)
          throws IOException

Skips the next n events from the current position.

Throws:

IOException

readRunHeader

LCRunHeader readRunHeader(int runNumber)
                   throws IOException

Reads the specified runHeader from file. Returns NULL if the specified runHeader hasn't been found in the file.

Throws:

IOException

readRunHeader

LCRunHeader readRunHeader(int runNumber,
                          int accessMode)
                   throws IOException

Same as LCEvent* readRunHeader(int runNumber) allowing to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.

Throws:

IOException

readEvent

LCEvent readEvent(int runNumber,
                  int evtNumber)
           throws IOException

Reads the specified event from file. Returns NULL if the specified event hasn't been found in the file.

Throws:

IOException

readEvent

LCEvent readEvent(int runNumber,
                  int evtNumber,
                  int accessMode)
           throws IOException

Same as LCEvent* readEvent(int runNumber, int evtNumber) allowing to set the access mode LCIO::READ_ONLY (default) or LCIO::Update.

Throws:

IOException

close

void close()
    throws IOException

Closes the output file/stream etc.

Throws:

IOException

registerLCEventListener

void registerLCEventListener(LCEventListener ls)

Registers a listener for reading LCEvents from a stream.

removeLCEventListener

void removeLCEventListener(LCEventListener ls)

Remove a listener for reading LCEvents from a stream.

registerLCRunListener

void registerLCRunListener(LCRunListener ls)

Registers a listener for reading LCEventsLCRunHeaders from a stream.

removeLCRunListener

void removeLCRunListener(LCRunListener ls)

Remove a listener for reading LCRunHeaders from a stream.

readStream

void readStream()
         throws IOException

Reads the input stream and notifies registered listeners according to the object type found in the stream.

Throws:

IOException

readStream

void readStream(int maxRecord)
         throws IOException

Reads maxRecord from the input stream and notifies registered listeners according to the object type found in the stream. An exception is thrown if less than maxRecord where read from the file.

Throws:

IOException