hep.lcio.io

Interface LCWriter

public interface LCWriter

Interface for writing data with LCIO. Uses interfaces from EVENT/hep.lcio.event. Use LCFactory to instantiate a corresponding LCWriter object for the output format at hand (SIO only, so far).

See Also:

LCFactory

Method Summary

Modifier and Type	Method and Description
void	close() Closes the output file/stream.
void	flush() Flushes the output file/stream.
void	open(String filename) Opens a file for writing.
void	open(String filename, int writeMode) Opens a file for writing.
void	setCompressionLevel(int level) Set the compression level - needs to be called before open() otherwise call will have no effect.
void	writeEvent(LCEvent evt) Writes the given event to file.
void	writeRunHeader(LCRunHeader hdr) Writes the given run header to file.

Method Detail

open

void open(String filename)
   throws IOException

Opens a file for writing. If file with given name exists, an exception is thrown. Use append or new mode instead.

Throws:

IOException

open

void open(String filename,
          int writeMode)
   throws IOException

Opens a file for writing. Possible write modes are: LCIO::WRITE_NEW (existing files are replaced) and LCIO::WRITE_APPEND.

Throws:

IOException

setCompressionLevel

void setCompressionLevel(int level)

Set the compression level - needs to be called before open() otherwise call will have no effect. If not called the Writer will use default compression.
Valid compression levels are:

• level < 0 : default compression
• level == 0 : no compression
• level > 0 : compression level (typically 1 (fastest) - 9 (best compression))

Status: (v01-09)
C++: experimental code - don't use for production
Java: not implemented

Parameters:

level - compression level

writeRunHeader

void writeRunHeader(LCRunHeader hdr)
             throws IOException

Writes the given run header to file.

Throws:

IOException

writeEvent

void writeEvent(LCEvent evt)
         throws IOException

Writes the given event to file.

Throws:

IOException

close

void close()
    throws IOException

Closes the output file/stream.

Throws:

IOException

flush

void flush()
    throws IOException

Flushes the output file/stream.

Throws:

IOException