From c98f966dce2c36ff858b0ef03e94308d4cd57606 Mon Sep 17 00:00:00 2001 From: Carl Timmer Date: Wed, 25 Sep 2024 14:15:17 +0000 Subject: [PATCH] Update docs --- doc-6.0/javadoc/index-all.html | 188 ++++++--- ...ompressor.ByteBufferBackedInputStream.html | 9 +- .../javadoc/org/jlab/coda/hipo/DataUtils.html | 42 +-- .../org/jlab/coda/hipo/Evio6Converter.html | 39 +- .../org/jlab/coda/hipo/FileEventIndex.html | 9 +- .../jlab/coda/hipo/Reader.RecordPosition.html | 78 +++- .../javadoc/org/jlab/coda/hipo/Reader.html | 14 +- .../org/jlab/coda/hipo/RecordInputStream.html | 12 +- .../org/jlab/coda/hipo/RecordSupply.html | 4 +- .../coda/hipo/class-use/CompressionType.html | 7 +- .../hipo/class-use/Reader.RecordPosition.html | 12 +- .../org/jlab/coda/hipo/package-summary.html | 4 +- .../org/jlab/coda/jevio/EventWriter.html | 99 +++-- .../jlab/coda/jevio/EventWriterUnsync.html | 356 ++++++++++-------- .../jlab/coda/jevio/EventWriterUnsyncV4.html | 196 +++++----- .../org/jlab/coda/jevio/EventWriterV4.html | 100 ++--- .../jlab/coda/jevio/IEvioCompactReader.html | 18 +- .../org/jlab/coda/jevio/apps/Xml2evio.html | 9 +- .../jlab/coda/jevio/class-use/EvioBank.html | 51 ++- .../coda/jevio/class-use/EvioException.html | 108 ++++-- .../jlab/coda/jevio/class-use/EvioNode.html | 30 +- .../org/jlab/coda/jevio/package-summary.html | 3 +- .../org/jlab/coda/jevio/package-use.html | 3 +- 23 files changed, 872 insertions(+), 519 deletions(-) diff --git a/doc-6.0/javadoc/index-all.html b/doc-6.0/javadoc/index-all.html index 97fc16bc..4116b5f6 100644 --- a/doc-6.0/javadoc/index-all.html +++ b/doc-6.0/javadoc/index-all.html @@ -592,7 +592,9 @@

B

Copies a 1-byte byte value into a 4-byte int while preserving bit pattern.
ByteBufferBackedInputStream(ByteBuffer) - Constructor for class org.jlab.coda.hipo.Compressor.ByteBufferBackedInputStream
-
 
+
+
Get ByteBuffer backing the input stream (containing uncompressed gzip input).
+
byteBufferBinaryString(ByteBuffer) - Static method in class org.jlab.coda.hipo.FileHeader
Print out each word of the given buffer as binary, hex, and decimal.
@@ -671,7 +673,9 @@

C

Clear the entire object.
clear() - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Clear the field of this object to 0.
+
clear() - Method in class org.jlab.coda.jevio.CompositeData.Data
Clear all existing data in this object to prepare for reuse.
@@ -924,9 +928,13 @@

C

Use this class when decompressing GZIP data from a ByteBuffer.
convert(String, String, int) - Static method in class org.jlab.coda.hipo.Evio6Converter
-
 
+
+
Method to convert evio file into hipo file.
+
convert(String, String, int, CompressionType) - Static method in class org.jlab.coda.hipo.Evio6Converter
-
 
+
+
Method to convert evio file into hipo file.
+
copy(FileHeader) - Method in class org.jlab.coda.hipo.FileHeader
Copy the contents of the arg into this object.
@@ -998,8 +1006,6 @@

D

DataUtils - Class in org.jlab.coda.hipo
 
-
DataUtils() - Constructor for class org.jlab.coda.hipo.DataUtils
-
 
DEFAULT_BLOCK_COUNT - Static variable in class org.jlab.coda.jevio.EventWriterUnsyncV4
The default maximum event count for a single block used for writing.
@@ -1198,7 +1204,8 @@

E

EventWriterUnsync(String, String, String, int, long, int, int, ByteOrder, String, boolean, boolean, EvioBank, int, int, int, int, CompressionType, int, int, int) - Constructor for class org.jlab.coda.jevio.EventWriterUnsync
-
Create an object for writing events to a file.
+
+ Create an object for writing events to a file.
EventWriterUnsync(ByteBuffer) - Constructor for class org.jlab.coda.jevio.EventWriterUnsync
@@ -1271,19 +1278,23 @@

E

EventWriterUnsyncV4(String, String, String, int, long, int, int, int, ByteOrder, String, BitSet, boolean, boolean) - Constructor for class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Create an object for writing events to a file.
+
+ Create an object for writing events to a file.
EventWriterUnsyncV4(String, String, String, int, long, int, int, int, ByteOrder, String, BitSet, boolean, boolean, EvioBank) - Constructor for class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Create an object for writing events to a file.
+
+ Create an object for writing events to a file.
EventWriterUnsyncV4(String, String, String, int, long, int, int, int, ByteOrder, String, BitSet, boolean, boolean, EvioBank, int) - Constructor for class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Create an object for writing events to a file.
+
+ Create an object for writing events to a file.
EventWriterUnsyncV4(String, String, String, int, long, int, int, int, ByteOrder, String, BitSet, boolean, boolean, EvioBank, int, int, int, int) - Constructor for class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Create an object for writing events to a file.
+
+ Create an object for writing events to a file.
EventWriterUnsyncV4(ByteBuffer) - Constructor for class org.jlab.coda.jevio.EventWriterUnsyncV4
@@ -1419,7 +1430,9 @@

E

Create an object for writing events to a ByteBuffer.
Evio6Converter - Class in org.jlab.coda.hipo
-
 
+
+
Class used to convert evio files into hipo files.
+
Evio6Converter() - Constructor for class org.jlab.coda.hipo.Evio6Converter
 
EVIO_FILE_UNIQUE_WORD - Static variable in class org.jlab.coda.hipo.FileHeader
@@ -1913,11 +1926,13 @@

F

flush() - Method in class org.jlab.coda.jevio.EventWriter
-
This method flushes any remaining internally buffered data to file.
+
+ This method flushes any remaining internally buffered data to file.
flush() - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
This method flushes any remaining internally buffered data to file.
+
+ This method flushes any remaining internally buffered data to file.
flush() - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
@@ -2453,7 +2468,9 @@

G

Get the type of data compression used.
getCount() - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Get the count or number of entries in this record.
+
getCount() - Method in class org.jlab.coda.jevio.BlockNode
Get the count of events in block.
@@ -3231,7 +3248,9 @@

G

Get the total length of header + index + user header (including padding) in bytes.
getLength() - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Get the length of this record.
+
getLength() - Method in class org.jlab.coda.hipo.RecordHeader
Get the total length of this record in bytes.
@@ -3592,7 +3611,9 @@

G

Get the position of this record in a file.
getPosition() - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Get the position of this record in file/buffer.
+
getPosition() - Method in class org.jlab.coda.hipo.RecordHeader
Get the position of this record in a file.
@@ -4416,7 +4437,8 @@

I

IEvioCompactReader - Interface in org.jlab.coda.jevio
-
This is an interface for a compact reader of evio format files and buffers.
+
+ This is an interface for a compact reader of evio format files and buffers.
IEvioFilter - Interface in org.jlab.coda.jevio
@@ -4820,15 +4842,21 @@

M

Offset to get magic number from start of file for every evio version.
main(String[]) - Static method in class org.jlab.coda.hipo.Evio6Converter
-
 
+
+
Example use of this class.
+
main(String[]) - Static method in class org.jlab.coda.hipo.FileEventIndex
-
 
+
+
Example use of this class.
+
main(String[]) - Static method in class org.jlab.coda.hipo.FileHeader
Run this class as an executable which tests the writing and reading of a record.
main(String[]) - Static method in class org.jlab.coda.hipo.Reader
-
 
+
+
Example program using Reader.
+
main(String[]) - Static method in class org.jlab.coda.hipo.RecordHeader
Run this class as an executable which tests the writing and reading of a record.
@@ -4854,7 +4882,9 @@

M

Example use of this class.
main(String[]) - Static method in class org.jlab.coda.jevio.apps.Xml2evio
-
 
+
+
Example use of this class.
+
main(String[]) - Static method in class org.jlab.coda.jevio.Environment
Main program used for testing only.
@@ -5596,7 +5626,10 @@

S

Constructor.
setAll(long, int, int) - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Set the position of this record in file/buffer, its length, + and the number of entries in it.
+
setAllHeaderLengths() - Method in class org.jlab.coda.jevio.BaseStructure
Compute and set length of all header fields for this structure and all its descendants.
@@ -5662,7 +5695,8 @@

S

setBuffer(ByteBuffer, BitSet, int) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Set the buffer being written into (initially set in constructor).
+
+ Set the buffer being written into (initially set in constructor).
setBuffer(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriterUnsync
@@ -5809,7 +5843,9 @@

S

Convenience method that sets compression type for the file.
setCount(int) - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Set the count or number of entries in this record.
+
setCount(int) - Method in class org.jlab.coda.jevio.BlockNode
Set the number of events in block.
@@ -5920,62 +5956,74 @@

S

setFirstEvent(EvioNode) - Method in class org.jlab.coda.jevio.EventWriter
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriter
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriter
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(EvioNode) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Set an event which will be written to the file as +
+ Set an event which will be written to the file as well as to all split files.
setFirstEvent(EvioNode) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEvent(EvioNode) - Method in class org.jlab.coda.jevio.EventWriterV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriterV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriterV4
-
Set an event which will be written to the file/buffer as +
+ Set an event which will be written to the file/buffer as well as to all split files.
setFirstEventBit(int) - Static method in class org.jlab.coda.jevio.BlockHeaderV4
@@ -6055,7 +6103,9 @@

S

Set the total length in bytes, header + index + user header.
setLength(int) - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Set length of this record.
+
setLength(int) - Method in class org.jlab.coda.hipo.RecordHeader
Set the record length in bytes and words.
@@ -6138,7 +6188,9 @@

S

Set the position of this record in a file.
setPosition(long) - Method in class org.jlab.coda.hipo.Reader.RecordPosition
-
 
+
+
Set position of this record in file/buffer.
+
setPosition(long) - Method in class org.jlab.coda.hipo.RecordHeader
Set the position of this record in a file.
@@ -6290,7 +6342,9 @@

S

Prints the content of the event index array on the screen.
show() - Method in class org.jlab.coda.hipo.Reader
-
 
+
+
Print out all record positions.
+
size() - Method in class org.jlab.coda.jevio.EvioByteArrayOutputStream
Returns the current size of the buffer.
@@ -7213,39 +7267,48 @@

W

writeEvent(EvioNode, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioNode, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioNode, boolean, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(ByteBuffer) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(ByteBuffer, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(ByteBuffer, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioBank) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioBank, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioBank, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record in evio/hipo version 6 format.
+
+ Write an event (bank) into a record in evio/hipo version 6 format.
writeEvent(EvioNode, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
@@ -7273,47 +7336,56 @@

W

writeEventToFile(EvioBank, ByteBuffer, boolean) - Method in class org.jlab.coda.jevio.EventWriter
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioBank, ByteBuffer, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriter
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioNode, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioNode, boolean, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioBank, ByteBuffer, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioBank, ByteBuffer, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsync
-
Write an event (bank) into a record and eventually to a file in evio/hipo +
+ Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
writeEventToFile(EvioNode, boolean, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Write an event (bank) into a record and eventually to a file in evio +
+ Write an event (bank) into a record and eventually to a file in evio version 4 format.
writeEventToFile(EvioBank, ByteBuffer, boolean) - Method in class org.jlab.coda.jevio.EventWriterUnsyncV4
-
Write an event (bank) into a block and eventually to a file in evio +
+ Write an event (bank) into a block and eventually to a file in evio version 4 format.
writeEventToFile(EvioBank, ByteBuffer, boolean) - Method in class org.jlab.coda.jevio.EventWriterV4
-
Write an event (bank) into a block and eventually to a file in evio +
+ Write an event (bank) into a block and eventually to a file in evio version 4 format.
writeHeader(ByteBuffer, int) - Method in class org.jlab.coda.hipo.FileHeader
diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/Compressor.ByteBufferBackedInputStream.html b/doc-6.0/javadoc/org/jlab/coda/hipo/Compressor.ByteBufferBackedInputStream.html index 44905d5a..b9b1ce19 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/Compressor.ByteBufferBackedInputStream.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/Compressor.ByteBufferBackedInputStream.html @@ -146,7 +146,9 @@

Constructor Summary

Constructor and Description -ByteBufferBackedInputStream(java.nio.ByteBuffer backendBuffer)  +ByteBufferBackedInputStream(java.nio.ByteBuffer backendBuffer) +
Get ByteBuffer backing the input stream (containing uncompressed gzip input).
+ @@ -230,6 +232,11 @@

Constructor Detail

  • ByteBufferBackedInputStream

    public ByteBufferBackedInputStream(java.nio.ByteBuffer backendBuffer)
    +
    Get ByteBuffer backing the input stream (containing uncompressed gzip input).
    +
    +
    Parameters:
    +
    backendBuffer - buffer to contain uncompressed gzip data during decompression process.
    +
    • diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/DataUtils.html b/doc-6.0/javadoc/org/jlab/coda/hipo/DataUtils.html index aa02e27f..98507ff2 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/DataUtils.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/DataUtils.html @@ -79,13 +79,13 @@
  • Summary: 
  • Nested | 
  • Field | 
    • -
  • Constr | 
    • +
  • Constr | 
  • Method
    • @@ -124,23 +124,6 @@

    Class DataUtils

    diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/FileEventIndex.html b/doc-6.0/javadoc/org/jlab/coda/hipo/FileEventIndex.html index f42d5d9a..a1fdacca 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/FileEventIndex.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/FileEventIndex.html @@ -218,7 +218,9 @@

    Method Summary

    static void -    main(java.lang.String[] args)  +main(java.lang.String[] args) +
    Example use of this class.
    + void @@ -495,6 +497,11 @@

    toString

  • main

    public static void main(java.lang.String[] args)
    +
    Example use of this class.
    +
    +
    Parameters:
    +
    args - unused.
    +
    • diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.RecordPosition.html b/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.RecordPosition.html index 3766865b..dc7ca706 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.RecordPosition.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.RecordPosition.html @@ -141,37 +141,54 @@

    Method Summary

    void -clear()  +clear() +
    Clear the field of this object to 0.
    + int -getCount()  +getCount() +
    Get the count or number of entries in this record.
    + int -getLength()  +getLength() +
    Get the length of this record.
    + long -getPosition()  +getPosition() +
    Get the position of this record in file/buffer.
    + void setAll(long pos, int len, - int cnt)  + int cnt) +
    Set the position of this record in file/buffer, its length, + and the number of entries in it.
    + Reader.RecordPosition -setCount(int _cnt)  +setCount(int _cnt) +
    Set the count or number of entries in this record.
    + Reader.RecordPosition -setLength(int _len)  +setLength(int _len) +
    Set length of this record.
    + Reader.RecordPosition -setPosition(long _pos)  +setPosition(long _pos) +
    Set position of this record in file/buffer.
    + java.lang.String @@ -206,6 +223,13 @@

    Method Detail

  • setPosition

    public Reader.RecordPosition setPosition(long _pos)
    +
    Set position of this record in file/buffer.
    +
    +
    Parameters:
    +
    _pos - new position of record.
    +
    Returns:
    +
    this object.
    +
    • @@ -215,6 +239,13 @@

    setPosition

  • setLength

    public Reader.RecordPosition setLength(int _len)
    +
    Set length of this record.
    +
    +
    Parameters:
    +
    _len - length of record in bytes.
    +
    Returns:
    +
    this object.
    +
    • @@ -224,6 +255,13 @@

    setLength

  • setCount

    public Reader.RecordPosition setCount(int _cnt)
    +
    Set the count or number of entries in this record.
    +
    +
    Parameters:
    +
    _cnt - count or number of entries in this record.
    +
    Returns:
    +
    the object.
    +
    • @@ -235,6 +273,14 @@

    setAll

    public void setAll(long pos,
                    int len,
                    int cnt)
    +
    Set the position of this record in file/buffer, its length, + and the number of entries in it.
    +
    +
    Parameters:
    +
    pos - new position of record.
    +
    len - length of record in bytes.
    +
    cnt - number of entries in this record.
    +
     @@ -244,6 +290,11 @@

    setAll

  • getPosition

    public long getPosition()
    +
    Get the position of this record in file/buffer.
    +
    +
    Returns:
    +
    position of this record.
    +
    •  @@ -253,6 +304,11 @@

    getPosition

  • getLength

    public int getLength()
    +
    Get the length of this record.
    +
    +
    Returns:
    +
    length of this record in bytes.
    +
    •  @@ -262,6 +318,11 @@

    getLength

  • getCount

    public int getCount()
    +
    Get the count or number of entries in this record.
    +
    +
    Returns:
    +
    number of entries in this record.
    +
    •  @@ -271,6 +332,7 @@

    getCount

  • clear

    public void clear()
    +
    Clear the field of this object to 0.
    •  diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.html b/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.html index 3e04e561..c220b9b2 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/Reader.html @@ -523,7 +523,9 @@

    Method Summary

    static void -    main(java.lang.String[] args)  +main(java.lang.String[] args) +
    Example program using Reader.
    + void @@ -592,7 +594,9 @@

    Method Summary

    void -show()  +show() +
    Print out all record positions.
    + @@ -1635,6 +1640,11 @@

    show

  • main

    public static void main(java.lang.String[] args)
    +
    Example program using Reader.
    +
    +
    Parameters:
    +
    args - unused.
    +
    • diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/RecordInputStream.html b/doc-6.0/javadoc/org/jlab/coda/hipo/RecordInputStream.html index e4558683..8e5efd1f 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/RecordInputStream.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/RecordInputStream.html @@ -474,7 +474,7 @@

    hasUserHeader

    getEvent

    public byte[] getEvent(int index)
    Get the event at the given index and return it in an allocated array. - Not threadsafe as internal buffer's pos & limit may change momentarily, + Not threadsafe as internal buffer's pos and limit may change momentarily, but are unchanged on return. This method allocates memory and thus creates garbage.
    @@ -497,7 +497,7 @@

    getEvent

    int index) throws java.nio.BufferOverflowException
    Get the event at the given index and return it in the given array. - Not threadsafe as internal buffer's pos & limit may change momentarily, + Not threadsafe as internal buffer's pos and limit may change momentarily, but are unchanged on return.
    Parameters:
    @@ -542,8 +542,8 @@

    getEvent

    but the buffer.limit() is ignored and reset. If no buffer is given (arg is null), create a buffer internally and return it. Buffer's byte order is set to that of the internal buffers. - Buffer pos & lim are ready to read on return. - Not threadsafe as internal buffer's pos & limit may change momentarily, + Buffer pos and lim are ready to read on return. + Not threadsafe as internal buffer's pos and limit may change momentarily, but are unchanged on return.
    Parameters:
    @@ -572,8 +572,8 @@

    getEvent

    but the buffer.limit() is ignored and reset. If no buffer is given (arg is null), create a buffer internally and return it. Buffer's byte order is set to that of the internal buffers. - Buffer pos & lim are ready to read on return. - Not threadsafe as internal buffer's pos & limit may change momentarily, + Buffer pos and lim are ready to read on return. + Not threadsafe as internal buffer's pos and limit may change momentarily, but are unchanged on return.
    Parameters:
    diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/RecordSupply.html b/doc-6.0/javadoc/org/jlab/coda/hipo/RecordSupply.html index 30c1faf9..c83cf9de 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/RecordSupply.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/RecordSupply.html @@ -121,7 +121,7 @@

    Class RecordSupply

    fills the record with data, and finally does a     publish(RecordRingItem) to let consumers know the data is ready.

    - This class is setup to handle 2 types of consumers. + This class is set up to handle 2 types of consumers. The first type is a thread which compresses a record's data. The number of such consumers is set in the constructor. Each of these will call getToCompress(int) to get a record @@ -159,7 +159,7 @@

    Class RecordSupply

    || || writeBarrier - ^gt; || + ^ || / _____ Write thread / | \ ---> /1 _|_ 2\ <---- Compression Threads 1-M diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/CompressionType.html b/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/CompressionType.html index 0e7ae5da..a8195208 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/CompressionType.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/CompressionType.html @@ -154,7 +154,9 @@

    Uses of Evio6Converter.convert(java.lang.String inFile, java.lang.String outFile, int nthreads, - CompressionType compressionType)  + CompressionType compressionType) +
    Method to convert evio file into hipo file.
    + static byte[] @@ -414,7 +416,8 @@

    Uses of -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/Reader.RecordPosition.html b/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/Reader.RecordPosition.html index 61613231..eabceb54 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/Reader.RecordPosition.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/class-use/Reader.RecordPosition.html @@ -111,15 +111,21 @@

    Uses of Reader.RecordPosition -Reader.RecordPosition.setCount(int _cnt)  +Reader.RecordPosition.setCount(int _cnt) +
    Set the count or number of entries in this record.
    + Reader.RecordPosition -Reader.RecordPosition.setLength(int _len)  +Reader.RecordPosition.setLength(int _len) +
    Set length of this record.
    + Reader.RecordPosition -Reader.RecordPosition.setPosition(long _pos)  +Reader.RecordPosition.setPosition(long _pos) +
    Set position of this record in file/buffer.
    + diff --git a/doc-6.0/javadoc/org/jlab/coda/hipo/package-summary.html b/doc-6.0/javadoc/org/jlab/coda/hipo/package-summary.html index affcccdb..b357dda2 100644 --- a/doc-6.0/javadoc/org/jlab/coda/hipo/package-summary.html +++ b/doc-6.0/javadoc/org/jlab/coda/hipo/package-summary.html @@ -103,7 +103,9 @@

    Package org.jlab.coda.hipo

    Evio6Converter -  + +
    Class used to convert evio files into hipo files.
    + FileEventIndex diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriter.html b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriter.html index 6a6ce61d..77d3744e 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriter.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriter.html @@ -342,7 +342,8 @@

    Method Summary

    void flush() -
    This method flushes any remaining internally buffered data to file.
    +
    + This method flushes any remaining internally buffered data to file.
    @@ -354,21 +355,24 @@

    Method Summary

    void setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    @@ -377,7 +381,8 @@

    Method Summary

    writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -387,7 +392,8 @@

    Method Summary

    java.nio.ByteBuffer bankBuffer, boolean force, boolean ownRecord) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -841,25 +847,28 @@

    setFirstEvent

    public void setFirstEvent(EvioNode node)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if - writing to a file. The common record data is never compressed.

    + writing to a file. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -894,26 +903,29 @@

    setFirstEvent

    public void setFirstEvent(java.nio.ByteBuffer buffer)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if writing to a file. When writing to a buffer it's stored in the first record's - user-header. The common record data is never compressed.

    + user-header. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -948,26 +960,29 @@

    setFirstEvent

    public void setFirstEvent(EvioBank bank)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if writing to a file. When writing to a buffer it's stored in the first record's - user-header. The common record data is never compressed.

    + user-header. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -999,11 +1014,12 @@

    setFirstEvent

  • flush

    public void flush()
    -
    This method flushes any remaining internally buffered data to file. +

    + This method flushes any remaining internally buffered data to file. Calling EventWriterUnsync.close() automatically does this so it isn't necessary to call before closing. This method should only be used when writing events at such a low rate that it takes an inordinate amount of time - for internally buffered data to be written to the file.

    + for internally buffered data to be written to the file.

    Calling this may easily kill performance. @@ -1051,15 +1067,16 @@

    writeEventToFile

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -1067,32 +1084,33 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance when writing to a file.

    - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Overrides:
    writeEventToFile in class EventWriterUnsync
    Parameters:
    bank - the bank (as an EvioBank object) to write.
    bankBuffer - the bank (as a ByteBuffer object) to write.
    +
    force - if writing to disk, force it to write event to the disk.
    Returns:
    true if event was added to record. If splitting files, false if disk partition too full to write the complete, next split file. @@ -1121,15 +1139,16 @@

    writeEventToFile

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -1137,26 +1156,26 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance when writing to a file.

    - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Overrides:
    writeEventToFile in class EventWriterUnsync
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsync.html b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsync.html index 73fb7638..34791669 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsync.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsync.html @@ -315,7 +315,8 @@

    Constructor Summary

    int compressionThreads, int ringSize, int bufferSize) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -342,7 +343,8 @@

    Method Summary

    void flush() -
    This method flushes any remaining internally buffered data to file.
    +
    + This method flushes any remaining internally buffered data to file.
    @@ -440,7 +442,8 @@

    Method Summary

    setBuffer(java.nio.ByteBuffer buf, java.util.BitSet bitInfo, int recordNumber) -
    Set the buffer being written into (initially set in constructor).
    +
    + Set the buffer being written into (initially set in constructor).
    @@ -452,21 +455,24 @@

    Method Summary

    void setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    @@ -497,14 +503,16 @@

    Method Summary

    boolean writeEvent(java.nio.ByteBuffer bankBuffer) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    boolean writeEvent(java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -512,20 +520,23 @@

    Method Summary

    writeEvent(java.nio.ByteBuffer bankBuffer, boolean force, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    boolean writeEvent(EvioBank bank) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    boolean writeEvent(EvioBank bank, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -533,14 +544,16 @@

    Method Summary

    writeEvent(EvioBank bank, boolean force, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    boolean writeEvent(EvioNode node, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -548,7 +561,8 @@

    Method Summary

    writeEvent(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -557,7 +571,8 @@

    Method Summary

    boolean force, boolean duplicate, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -565,7 +580,8 @@

    Method Summary

    writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -575,7 +591,8 @@

    Method Summary

    java.nio.ByteBuffer bankBuffer, boolean force, boolean ownRecord) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -584,7 +601,8 @@

    Method Summary

    writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -594,7 +612,8 @@

    Method Summary

    boolean force, boolean duplicate, boolean ownRecord) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -782,15 +801,16 @@

    EventWriterUnsync

    int ringSize, int bufferSize) throws EvioException -
    Create an object for writing events to a file. +

    + Create an object for writing events to a file. If the file already exists, its contents will be overwritten unless the "overWriteOK" argument is false in which case an exception will be thrown. Unless ..., the option to append these events to an existing file is true, in which case everything is fine. If the file doesn't exist, it will be created. Byte order defaults to big endian if arg is null. - File can be split while writing.

    - + File can be split while writing.

    +

    The base file name may contain up to 2, C-style integer format specifiers using "d" and "x" (such as %03d, or %x). If more than 2 are found, an exception will be thrown. @@ -805,18 +825,18 @@

    EventWriterUnsync

    If streamCount > 1, the split number is calculated starting with streamId and incremented by streamCount each time. In this manner, all split files will have unique, sequential names even though there are multiple parallel ERs. +

    - The base file name may contain characters of the form $(ENV_VAR) which will be substituted with the value of the associated environmental - variable or a blank string if none is found.

    - + variable or a blank string if none is found.

    +

    The base file name may also contain occurrences of the string "%s" which will be substituted with the value of the runType arg or nothing if - the runType is null.

    - + the runType is null.

    +

    If multiple streams of data, each writing a file, end up with the same file name, - they can be differentiated by a stream id, starting split # and split increment.

    + they can be differentiated by a stream id, starting split # and split increment.

    If there are multiple compression threads, then the maxRecordSize arg is used to determine the max size of each record in the internally created RecordSupply. If a single event, @@ -1029,10 +1049,11 @@

    setBuffer

    java.util.BitSet bitInfo, int recordNumber) throws EvioException -
    Set the buffer being written into (initially set in constructor). +

    + Set the buffer being written into (initially set in constructor). This method allows the user to avoid having to create a new EventWriter each time a bank needs to be written to a different buffer. - This does nothing if writing to a file.

    + This does nothing if writing to a file.

    Do not use this method unless you know what you are doing.
    Parameters:
    @@ -1337,25 +1358,28 @@

    setFirstEvent

    public void setFirstEvent(EvioNode node)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if - writing to a file. The common record data is never compressed.

    + writing to a file. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -1388,26 +1412,29 @@

    setFirstEvent

    public void setFirstEvent(java.nio.ByteBuffer buffer)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if writing to a file. When writing to a buffer it's stored in the first record's - user-header. The common record data is never compressed.

    + user-header. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -1440,26 +1467,29 @@

    setFirstEvent

    public void setFirstEvent(EvioBank bank)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file as +

    + Set an event which will be written to the file as well as to all split files. It's called the "first event" as it will be the first event written to each split file if this method is called early enough or the first event was defined in the constructor. In evio version 6, any dictionary and the first event are written to a common record which is stored in the user-header part of the file header if writing to a file. When writing to a buffer it's stored in the first record's - user-header. The common record data is never compressed.

    + user-header. The common record data is never compressed.

    FILE: +

    Since this method can only be called after the constructor, the common record may have already been written with its dictionary and possibly another firstEvent. If that is the case, the event given here will be written immediately somewhere in the body of the file. Any subsequent splits will have this event as the first event in the file header. On the other hand, if the common record has not yet been - written to the file, this event becomes the first event in the file header.

    + written to the file, this event becomes the first event in the file header.

    BUFFER: +

    By its nature this method is not all that useful for writing to a buffer since - the buffer is never split. For that reason it throws an exception.

    + the buffer is never split. For that reason it throws an exception.

    Do not call this while simultaneously calling @@ -1489,11 +1519,12 @@

    setFirstEvent

  • flush

    public void flush()
    -
    This method flushes any remaining internally buffered data to file. +

    + This method flushes any remaining internally buffered data to file. Calling close() automatically does this so it isn't necessary to call before closing. This method should only be used when writing events at such a low rate that it takes an inordinate amount of time - for internally buffered data to be written to the file.

    + for internally buffered data to be written to the file.

    Calling this may easily kill performance. @@ -1553,32 +1584,34 @@

    writeEvent

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance when writing to a file.

    - +kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -1608,36 +1641,38 @@

    writeEvent

    boolean duplicate) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will kill performance when writing to a file. A true 3rd arg can be used when the backing buffer of the node is accessed by multiple threads simultaneously. This allows that buffer's limit and position to be changed without interfering - with the other threads.

    - + with the other threads.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -1670,36 +1705,38 @@

    writeEvent

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will kill performance when writing to a file. A true 3rd arg can be used when the backing buffer of the node is accessed by multiple threads simultaneously. This allows that buffer's limit and position to be changed without interfering - with the other threads.

    - + with the other threads.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -1733,15 +1770,16 @@

    writeEventToFile

    boolean duplicate) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -1749,27 +1787,27 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will kill performance when writing to a file. A true 3rd arg can be used when the backing buffer of the node is accessed by multiple threads simultaneously. This allows that buffer's limit and position to be changed without interfering - with the other threads.

    - + with the other threads.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -1803,15 +1841,16 @@

    writeEventToFile

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -1819,27 +1858,27 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will kill performance when writing to a file. A true 3rd arg can be used when the backing buffer of the node is accessed by multiple threads simultaneously. This allows that buffer's limit and position to be changed without interfering - with the other threads.

    - + with the other threads.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -1872,29 +1911,31 @@

    writeEvent

    public boolean writeEvent(java.nio.ByteBuffer bankBuffer)
                    throws EvioException,
                           java.io.IOException
    -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bankBuffer - the bank (as a ByteBuffer object) to write.
    @@ -1921,32 +1962,34 @@

    writeEvent

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will - kill performance when writing to a file. - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bankBuffer - the bank (as a ByteBuffer object) to write.
    @@ -1975,32 +2018,34 @@

    writeEvent

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    - + compress the data if desired and then write it to the buffer.

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will - kill performance when writing to a file. - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bankBuffer - the bank (as a ByteBuffer object) to write.
    @@ -2029,26 +2074,28 @@

    writeEvent

    public boolean writeEvent(EvioBank bank)
                    throws EvioException,
                           java.io.IOException
    -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    + compress the data if desired and then write it to the buffer.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bank - the bank to write.
    @@ -2073,26 +2120,28 @@

    writeEvent

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    + compress the data if desired and then write it to the buffer.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Be warned that injudicious use of the 2nd arg, the force flag, will kill performance when writing to a file.
    @@ -2122,26 +2171,28 @@

    writeEvent

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record in evio/hipo version 6 format. +

    + Write an event (bank) into a record in evio/hipo version 6 format. Once the record is full and if writing to a file (for multiple compression threads), the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    +

    If writing to a buffer, once the record is full this method returns false - indicating that the last event was NOT written to the record. To finish the writing process, call close(). This will - compress the data if desired and then write it to the buffer.

    + compress the data if desired and then write it to the buffer.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, writeEventToFile. Automatically taken care of in EventWriter.

    - +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Be warned that injudicious use of the 2nd arg, the force flag, will kill performance when writing to a file.
    @@ -2173,15 +2224,16 @@

    writeEventToFile

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -2189,30 +2241,31 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance when writing to a file.

    - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bank - the bank (as an EvioBank object) to write.
    bankBuffer - the bank (as a ByteBuffer object) to write.
    +
    force - if writing to disk, force it to write event to the disk.
    Returns:
    true if event was added to record. If splitting files, false if disk partition too full to write the complete, next split file. @@ -2241,15 +2294,16 @@

    writeEventToFile

    boolean ownRecord) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio/hipo +

    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format. Once the record is full and if writing with multiple compression threads, the record will be sent to a thread which may compress the data, then it will be sent to a thread to write the record to file. If there is only 1 compression thread, it's all done in the thread which - call this method.

    + call this method.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling @@ -2257,26 +2311,26 @@

    writeEventToFile

    (or the various writeEvent() methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, getByteBuffer, setFirstEvent, or writeEvent. Automatically taken care of in EventWriter.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance when writing to a file.

    - + kill performance when writing to a file.

    +

    This method is not used to write the dictionary or the first event which are both placed in the common record which, in turn, is the - user header part of the file header.

    + user header part of the file header.

    Parameters:
    bank - the bank (as an EvioBank object) to write.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsyncV4.html b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsyncV4.html index 4af84bb2..f0e2f12a 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsyncV4.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterUnsyncV4.html @@ -361,7 +361,8 @@

    Constructor Summary

    java.util.BitSet bitInfo, boolean overWriteOK, boolean append) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -379,7 +380,8 @@

    Constructor Summary

    boolean overWriteOK, boolean append, EvioBank firstEvent) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -398,7 +400,8 @@

    Constructor Summary

    boolean append, EvioBank firstEvent, int streamId) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -420,7 +423,8 @@

    Constructor Summary

    int splitNumber, int splitIncrement, int streamCount) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -545,21 +549,24 @@

    Method Summary

    void setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    @@ -621,7 +628,8 @@

    Method Summary

    writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -630,7 +638,8 @@

    Method Summary

    writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio +
    + Write an event (bank) into a record and eventually to a file in evio version 4 format.
    @@ -1093,15 +1102,16 @@

    EventWriterUnsyncV4

    boolean overWriteOK, boolean append) throws EvioException -
    Create an object for writing events to a file. +

    + Create an object for writing events to a file. If the file already exists, its contents will be overwritten unless the "overWriteOK" argument is false in which case an exception will be thrown. Unless ..., the option to append these events to an existing file is true, in which case everything is fine. If the file doesn't exist, it will be created. Byte order defaults to big endian if arg is null. - File can be split while writing.

    - + File can be split while writing.

    +

    The base file name may contain up to 2, C-style integer format specifiers using "d" and "x" (such as %03d, or %x). If more than 2 are found, an exception will be thrown. @@ -1113,15 +1123,15 @@

    EventWriterUnsyncV4

    If 2 specifiers exist and the file is not being split, no substitutions are made. If no specifier for the splitNumber exists, it is tacked onto the end of the file name after a dot (.). +

    - The base file name may contain characters of the form $(ENV_VAR) which will be substituted with the value of the associated environmental - variable or a blank string if none is found.

    - + variable or a blank string if none is found.

    +

    The base file name may also contain occurrences of the string "%s" which will be substituted with the value of the runType arg or nothing if - the runType is null.

    + the runType is null.

    Parameters:
    baseName - base file name used to generate complete file name (may not be null)
    @@ -1181,15 +1191,16 @@

    EventWriterUnsyncV4

    boolean append, EvioBank firstEvent) throws EvioException -
    Create an object for writing events to a file. +

    + Create an object for writing events to a file. If the file already exists, its contents will be overwritten unless the "overWriteOK" argument is false in which case an exception will be thrown. Unless ..., the option to append these events to an existing file is true, in which case everything is fine. If the file doesn't exist, it will be created. Byte order defaults to big endian if arg is null. - File can be split while writing.

    - + File can be split while writing.

    +

    The base file name may contain up to 2, C-style integer format specifiers using "d" and "x" (such as %03d, or %x). If more than 2 are found, an exception will be thrown. @@ -1201,15 +1212,15 @@

    EventWriterUnsyncV4

    If 2 specifiers exist and the file is not being split, no substitutions are made. If no specifier for the splitNumber exists, it is tacked onto the end of the file name after a dot (.). +

    - The base file name may contain characters of the form $(ENV_VAR) which will be substituted with the value of the associated environmental - variable or a blank string if none is found.

    - + variable or a blank string if none is found.

    +

    The base file name may also contain occurrences of the string "%s" which will be substituted with the value of the runType arg or nothing if - the runType is null.

    + the runType is null.

    Parameters:
    baseName - base file name used to generate complete file name (may not be null)
    @@ -1273,15 +1284,16 @@

    EventWriterUnsyncV4

    EvioBank firstEvent, int streamId) throws EvioException -
    Create an object for writing events to a file. +

    + Create an object for writing events to a file. If the file already exists, its contents will be overwritten unless the "overWriteOK" argument is false in which case an exception will be thrown. Unless ..., the option to append these events to an existing file is true, in which case everything is fine. If the file doesn't exist, it will be created. Byte order defaults to big endian if arg is null. - File can be split while writing.

    - + File can be split while writing.

    +

    The base file name may contain up to 2, C-style integer format specifiers using "d" and "x" (such as %03d, or %x). If more than 2 are found, an exception will be thrown. @@ -1293,21 +1305,21 @@

    EventWriterUnsyncV4

    If 2 specifiers exist and the file is not being split, no substitutions are made. If no specifier for the splitNumber exists, it is tacked onto the end of the file name after a dot (.). +

    - The base file name may contain characters of the form $(ENV_VAR) which will be substituted with the value of the associated environmental - variable or a blank string if none is found.

    - + variable or a blank string if none is found.

    +

    The base file name may also contain occurrences of the string "%s" which will be substituted with the value of the runType arg or nothing if - the runType is null.

    - + the runType is null.

    +

    If multiple streams of data, each writing a file, end up with the same file name, they can be differentiated by a stream id number. If the id is > 0, the string, ".strm" is appended to the very end of the file followed by the id number (e.g. filename.strm1). This is done after the run type, run number, split numbers, and env vars have been inserted - into the file name.

    + into the file name.

    Parameters:
    baseName - base file name used to generate complete file name (may not be null)
    @@ -1375,15 +1387,16 @@

    EventWriterUnsyncV4

    int splitIncrement, int streamCount) throws EvioException -
    Create an object for writing events to a file. +

    + Create an object for writing events to a file. If the file already exists, its contents will be overwritten unless the "overWriteOK" argument is false in which case an exception will be thrown. Unless ..., the option to append these events to an existing file is true, in which case everything is fine. If the file doesn't exist, it will be created. Byte order defaults to big endian if arg is null. - File can be split while writing.

    - + File can be split while writing.

    +

    The base file name may contain up to 2, C-style integer format specifiers using "d" and "x" (such as %03d, or %x). If more than 2 are found, an exception will be thrown. @@ -1398,15 +1411,15 @@

    EventWriterUnsyncV4

    If streamCount > 1, the split number is calculated starting with streamId and incremented by streamCount each time. In this manner, all split files will have unique, sequential names even though there are multiple parallel ERs. +

    - The base file name may contain characters of the form $(ENV_VAR) which will be substituted with the value of the associated environmental - variable or a blank string if none is found.

    - + variable or a blank string if none is found.

    +

    The base file name may also contain occurrences of the string "%s" which will be substituted with the value of the runType arg or nothing if - the runType is null.

    + the runType is null.

    If multiple streams of data, each writing a file, end up with the same file name, they can be differentiated by a stream id, starting split # and split increment.
    @@ -1972,27 +1985,28 @@

    setFirstEvent

    public void setFirstEvent(EvioNode node)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - + it is never split and the event can be written to it as any other.

    +

    Data is transferred byte for byte, so data better be in an endian - compatible with the output of this writer.

    + compatible with the output of this writer.

    Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. @@ -2022,29 +2036,30 @@

    setFirstEvent

    public void setFirstEvent(java.nio.ByteBuffer buffer)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - + it is never split and the event can be written to it as any other.

    +

    Data is transferred byte for byte, so data better be in an endian - compatible with the output of this writer.

    - -

    Do not call this while simultaneously calling + compatible with the output of this writer.

    +

    + Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. Automatically taken care of in EventWriterV4.

    @@ -2072,26 +2087,27 @@

    setFirstEvent

    public void setFirstEvent(EvioBank bank)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - -

    Do not call this while simultaneously calling + it is never split and the event can be written to it as any other.

    +

    + Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. Automatically taken care of in EventWriterV4.

    @@ -2116,13 +2132,13 @@

    setFirstEvent

  • flush

    public void flush()
    -
    This method flushes any remaining internally buffered data to file. +

    This method flushes any remaining internally buffered data to file. Calling close() automatically does this so it isn't necessary to call before closing. This method should only be used when writing events at such a low rate that it takes an inordinate amount of time - for internally buffered data to be written to the file.

    + for internally buffered data to be written to the file.

    - Calling this can kill performance.

    +

    Calling this can kill performance.

    Do not call this while simultaneously calling close, writeEventToFile, setFirstEvent, writeEvent, or getByteBuffer. @@ -2244,32 +2260,33 @@

    writeEventToFile

    boolean duplicate) throws EvioException, java.io.IOException -
    Write an event (bank) into a record and eventually to a file in evio +

    + Write an event (bank) into a record and eventually to a file in evio version 4 format. If the internal buffer is full, it will be flushed to the file. - Otherwise an exception will be thrown.

    + Otherwise an exception will be thrown.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling writeEvent(EvioNode, boolean, boolean) (or the methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - - +

    +

    The buffer must contain only the event's data (event header and event data) - and must not be in complete evio file format. + and must not be in complete evio file format.

    Do not call this while simultaneously calling close, flush, setFirstEvent, writeEvent, or getByteBuffer. Automatically taken care of in EventWriterV4.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will kill performance when writing to a file. A true 3rd arg can be used when the backing buffer of the node is accessed by multiple threads simultaneously. This allows that buffer's limit and position to be changed without interfering - with the other threads.

    + with the other threads.

    Parameters:
    node - object representing the event to write in buffer form
    @@ -2450,30 +2467,31 @@

    writeEventToFile

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a block and eventually to a file in evio +

    + Write an event (bank) into a block and eventually to a file in evio version 4 format. This method will not work with this object setup - to write into a buffer. + to write into a buffer.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling writeEvent(EvioBank, ByteBuffer, boolean) (or the methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, setFirstEvent, writeEvent, or getByteBuffer. Automatically taken care of in EventWriterV4.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance.

    +kill performance.

    This method is not used to write the dictionary or the first event (common block). That is only done with the method writeCommonBlock().
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterV4.html b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterV4.html index 21cc4e28..4ed24052 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterV4.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/EventWriterV4.html @@ -455,21 +455,24 @@

    Method Summary

    void setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    @@ -478,7 +481,8 @@

    Method Summary

    writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -1578,27 +1582,28 @@

    setFirstEvent

    public void setFirstEvent(EvioNode node)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - + it is never split and the event can be written to it as any other.

    +

    Data is transferred byte for byte, so data better be in an endian - compatible with the output of this writer.

    + compatible with the output of this writer.

    Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. @@ -1630,29 +1635,30 @@

    setFirstEvent

    public void setFirstEvent(java.nio.ByteBuffer buffer)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - + it is never split and the event can be written to it as any other.

    +

    Data is transferred byte for byte, so data better be in an endian - compatible with the output of this writer.

    - -

    Do not call this while simultaneously calling + compatible with the output of this writer.

    +

    + Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. Automatically taken care of in EventWriterV4.

    @@ -1682,26 +1688,27 @@

    setFirstEvent

    public void setFirstEvent(EvioBank bank)
                    throws EvioException,
                           java.io.IOException
    -
    Set an event which will be written to the file/buffer as +

    + Set an event which will be written to the file/buffer as well as to all split files. It's called the "first event" as it will be the first event written to each split file (after the dictionary) if this method - is called early enough or the first event was defined in the constructor.

    - + is called early enough or the first event was defined in the constructor.

    +

    Since this method is always called after the constructor, the common block will have already been written with a dictionary and firstEvent if either was defined in the constructor. The event given here will be written immediately somewhere in the body of the file, with the forth-coming split - files having that event in the first block along with any dictionary.

    - + files having that event in the first block along with any dictionary.

    +

    This means that if the firstEvent is given in the constructor, then the caller may end up with 2 copies of it in a single file (if this method is called once). It's also possible to get 2 copies in a file if this - method is called immediately prior to the file splitting.

    - + method is called immediately prior to the file splitting.

    +

    By its nature this method is not useful for writing to a buffer since - it is never split and the event can be written to it as any other.

    - -

    Do not call this while simultaneously calling + it is never split and the event can be written to it as any other.

    +

    + Do not call this while simultaneously calling close, flush, writeEventToFile, setFirstEvent, or writeEvent. Automatically taken care of in EventWriterV4.

    @@ -1728,13 +1735,13 @@

    setFirstEvent

  • flush

    public void flush()
    -
    This method flushes any remaining internally buffered data to file. +

    This method flushes any remaining internally buffered data to file. Calling EventWriterUnsyncV4.close() automatically does this so it isn't necessary to call before closing. This method should only be used when writing events at such a low rate that it takes an inordinate amount of time - for internally buffered data to be written to the file.

    + for internally buffered data to be written to the file.

    - Calling this can kill performance.

    +

    Calling this can kill performance.

    Do not call this while simultaneously calling close, writeEventToFile, setFirstEvent, writeEvent, or getByteBuffer. @@ -1773,30 +1780,31 @@

    writeEventToFile

    boolean force) throws EvioException, java.io.IOException -
    Write an event (bank) into a block and eventually to a file in evio +

    + Write an event (bank) into a block and eventually to a file in evio version 4 format. This method will not work with this object setup - to write into a buffer. + to write into a buffer.

    - +

    If splitting files, this method returns false if disk partition is too full to write the complete, next split file. If force arg is true, write anyway. DO NOT mix calling this method with calling EventWriterUnsyncV4.writeEvent(EvioBank, ByteBuffer, boolean) (or the methods which call it). Results are unpredictable as it messes up the logic used to quit writing to full disk. - +

    The event to be written may be in one of two forms. The first is as an EvioBank object and the second is as a ByteBuffer containing only the event's data (event header and event data) and must not be in complete evio file format. - The first non-null of the bank arguments will be written. + The first non-null of the bank arguments will be written.

    Do not call this while simultaneously calling close, flush, setFirstEvent, writeEvent, or getByteBuffer. Automatically taken care of in EventWriterV4.

    - +

    Be warned that injudicious use of a true 2nd arg, the force flag, will -kill performance.

    +kill performance.

    This method is not used to write the dictionary or the first event (common block). That is only done with the method EventWriterUnsyncV4.writeCommonBlock().
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/IEvioCompactReader.html b/doc-6.0/javadoc/org/jlab/coda/jevio/IEvioCompactReader.html index 6e2a48a3..7db68d8d 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/IEvioCompactReader.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/IEvioCompactReader.html @@ -109,12 +109,26 @@

    Interface IEvioCompactRea 

    public interface IEvioCompactReader
    -
    This is an interface for a compact reader of evio format files and buffers. +

    + This is an interface for a compact reader of evio format files and buffers. The word "compact" refers to using the EvioNode class as a compact or lightweight means to refer to an evio event or structure in a buffer. Compact readers do not use EvioEvent, EvioBank, EvioSegment or EvioTagSegment classes which require a full parsing of each event and the creation of a large - number of objects.

    + number of objects.

    + +

    + Of the classes implementing this interface, + EvioCompactReaderUnsyncV4 and EvioCompactReaderV4 can read both files and buffers. + Whereas EvioCompactReaderUnsyncV6 and EvioCompactReaderV6 can read only buffers.

    + + Note that when reading a file, a memory map is created as an MappedByteBuffer. + This type of buffer is NOT backed by a byte array. + Thus, a call to the array() method of any returned ByteBuffer objects + (such as from getEventBuffer(int) or getStructureBuffer(EvioNode)) + will throw an UnsupportedOperationException, unless the returned buffer is a copy. + Note also that when reading a buffer, returned buffers will have a backing array + if the original buffer has one or the returned buffer is a copy.
    Since:
    11/1/17.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/apps/Xml2evio.html b/doc-6.0/javadoc/org/jlab/coda/jevio/apps/Xml2evio.html index bcb5dac5..117063c5 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/apps/Xml2evio.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/apps/Xml2evio.html @@ -159,7 +159,9 @@

    Method Summary

    static void -main(java.lang.String[] args)  +main(java.lang.String[] args) +
    Example use of this class.
    +
      @@ -207,6 +209,11 @@

      Method Detail

    • main

      public static void main(java.lang.String[] args)
      +
      Example use of this class.
      +
      +
      Parameters:
      +
      args - arguments outlined in usage().
      +

    • diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioBank.html b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioBank.html index 5e82398a..7cd67649 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioBank.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioBank.html @@ -196,28 +196,32 @@

    Uses of void EventWriterUnsyncV4.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriterV4.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriter.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsync.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    @@ -243,7 +247,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioBank bank) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -257,7 +262,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioBank bank, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -265,7 +271,8 @@

    Uses of EventWriterUnsync.writeEvent(EvioBank bank, boolean force, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -273,7 +280,8 @@

    Uses of EventWriterUnsyncV4.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -282,7 +290,8 @@

    Uses of EventWriterV4.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -291,7 +300,8 @@

    Uses of EventWriter.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -300,7 +310,8 @@

    Uses of EventWriterUnsync.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -310,7 +321,8 @@

    Uses of Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -320,7 +332,8 @@

    Uses of Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -377,7 +390,8 @@

    Uses of Create an object for writing events to a file.

    +
    + Create an object for writing events to a file.
    @@ -408,7 +422,8 @@

    Uses of EvioBank firstEvent) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -427,7 +442,8 @@

    Uses of EvioBank firstEvent, int streamId) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -449,7 +465,8 @@

    Uses of Create an object for writing events to a file.

    +
    + Create an object for writing events to a file.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioException.html b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioException.html index 780e9800..253e5060 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioException.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioException.html @@ -1341,7 +1341,8 @@

    Uses of EventWriterUnsync.setBuffer(java.nio.ByteBuffer buf, java.util.BitSet bitInfo, int recordNumber) -
    Set the buffer being written into (initially set in constructor).
    +
    + Set the buffer being written into (initially set in constructor).
    @@ -1436,84 +1437,96 @@

    Uses of void EventWriterUnsyncV4.setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriterV4.setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriter.setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsync.setFirstEvent(java.nio.ByteBuffer buffer) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsyncV4.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriterV4.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriter.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsync.setFirstEvent(EvioBank bank) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsyncV4.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriterV4.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriter.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsync.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    @@ -2275,7 +2288,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(java.nio.ByteBuffer bankBuffer) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2289,7 +2303,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2297,7 +2312,8 @@

    Uses of EventWriterUnsync.writeEvent(java.nio.ByteBuffer bankBuffer, boolean force, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2309,7 +2325,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioBank bank) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2323,7 +2340,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioBank bank, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2331,7 +2349,8 @@

    Uses of EventWriterUnsync.writeEvent(EvioBank bank, boolean force, boolean ownRecord) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2345,7 +2364,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioNode node, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2361,7 +2381,8 @@

    Uses of EventWriterUnsync.writeEvent(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2370,7 +2391,8 @@

    Uses of -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -2378,7 +2400,8 @@

    Uses of EventWriterUnsyncV4.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -2387,7 +2410,8 @@

    Uses of EventWriterV4.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a block and eventually to a file in evio +
    + Write an event (bank) into a block and eventually to a file in evio version 4 format.
    @@ -2396,7 +2420,8 @@

    Uses of EventWriter.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2405,7 +2430,8 @@

    Uses of EventWriterUnsync.writeEventToFile(EvioBank bank, java.nio.ByteBuffer bankBuffer, boolean force) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2415,7 +2441,8 @@

    Uses of -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2425,7 +2452,8 @@

    Uses of -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2434,7 +2462,8 @@

    Uses of EventWriterUnsyncV4.writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio +
    + Write an event (bank) into a record and eventually to a file in evio version 4 format.
    @@ -2443,7 +2472,8 @@

    Uses of EventWriterUnsync.writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2453,7 +2483,8 @@

    Uses of -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -2701,7 +2732,8 @@

    Uses of -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -2895,7 +2927,8 @@

    Uses of -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -2913,7 +2946,8 @@

    Uses of EvioBank firstEvent) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -2932,7 +2966,8 @@

    Uses of EvioBank firstEvent, int streamId) -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    @@ -2954,7 +2989,8 @@

    Uses of -
    Create an object for writing events to a file.
    +
    + Create an object for writing events to a file.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioNode.html b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioNode.html index 9610025b..4ea0074e 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioNode.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/class-use/EvioNode.html @@ -563,28 +563,32 @@

    Uses of void EventWriterUnsyncV4.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriterV4.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file/buffer as +
    + Set an event which will be written to the file/buffer as well as to all split files.
    void EventWriter.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    void EventWriterUnsync.setFirstEvent(EvioNode node) -
    Set an event which will be written to the file as +
    + Set an event which will be written to the file as well as to all split files.
    @@ -606,7 +610,8 @@

    Uses of boolean EventWriterUnsync.writeEvent(EvioNode node, boolean force) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -622,7 +627,8 @@

    Uses of EventWriterUnsync.writeEvent(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record in evio/hipo version 6 format.
    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -631,7 +637,8 @@

    Uses of Write an event (bank) into a record in evio/hipo version 6 format.

    +
    + Write an event (bank) into a record in evio/hipo version 6 format.
    @@ -639,7 +646,8 @@

    Uses of EventWriterUnsyncV4.writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio +
    + Write an event (bank) into a record and eventually to a file in evio version 4 format.
    @@ -648,7 +656,8 @@

    Uses of EventWriterUnsync.writeEventToFile(EvioNode node, boolean force, boolean duplicate) -
    Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    @@ -658,7 +667,8 @@

    Uses of Write an event (bank) into a record and eventually to a file in evio/hipo +
    + Write an event (bank) into a record and eventually to a file in evio/hipo version 6 format.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/package-summary.html b/doc-6.0/javadoc/org/jlab/coda/jevio/package-summary.html index 41483bc9..9e595c60 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/package-summary.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/package-summary.html @@ -101,7 +101,8 @@

    Package org.jlab.coda.jevio

    IEvioCompactReader -
    This is an interface for a compact reader of evio format files and buffers.
    +
    + This is an interface for a compact reader of evio format files and buffers.
    diff --git a/doc-6.0/javadoc/org/jlab/coda/jevio/package-use.html b/doc-6.0/javadoc/org/jlab/coda/jevio/package-use.html index 497ff361..100cfe02 100644 --- a/doc-6.0/javadoc/org/jlab/coda/jevio/package-use.html +++ b/doc-6.0/javadoc/org/jlab/coda/jevio/package-use.html @@ -277,7 +277,8 @@

    Uses of Package
    IEvioCompactReader -
    This is an interface for a compact reader of evio format files and buffers.
    +
    + This is an interface for a compact reader of evio format files and buffers.