org.jlab.coda.emu.support.data

Class PayloadBuffer

java.lang.Object

org.jlab.coda.emu.support.data.RingItemAdapter

org.jlab.coda.emu.support.data.PayloadBuffer

All Implemented Interfaces:

java.lang.Cloneable, Attached, RingItem

public class PayloadBuffer
extends RingItemAdapter

Wrapper for a ByteBuffer object that has external, associated data.

Author:

timmer (5/16/13)

Field Summary

Fields inherited from class org.jlab.coda.emu.support.data.RingItemAdapter

attachment, buffer, byteBufferItem, byteBufferSupply, controlType, event, eventCount, eventType, firstEventNumber, hasError, isFirst, isSync, isUser, matchesId, node, nonFatalBuildingError, recordId, reserved, sourceId, sourceName, switchRing

Constructor Summary

Constructors

Constructor and Description
PayloadBuffer() Zero-arg constructor.
PayloadBuffer(java.nio.ByteBuffer buffer) Constructor that sets attachment to null.
PayloadBuffer(java.nio.ByteBuffer buffer, EventType eventType, ControlType controlType, int recordId, int sourceId, java.lang.String sourceName, org.jlab.coda.jevio.EvioNode node) Constructor that sets attachment to null.
PayloadBuffer(java.nio.ByteBuffer buffer, java.lang.Object attachment, org.jlab.coda.jevio.EvioNode node) Constructor.
PayloadBuffer(PayloadBuffer buf) Copy constructor.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clones this object setting the attachment to null.
java.nio.ByteOrder	getByteOrder() What is the byte order of this data?
int	getTotalBytes() Get the length of this structure in bytes, including the header.

Methods inherited from class org.jlab.coda.emu.support.data.RingItemAdapter

copy, getAttachment, getBuffer, getByteBufferItem, getByteBufferSupply, getControlType, getEvent, getEventCount, getEventType, getFirstEventNumber, getNode, getRecordId, getSourceId, getSourceName, getSwitchRing, hasError, hasNonFatalBuildingError, isControlEvent, isFirstEvent, isFirstEvent, isSync, isUser, isUser, matchesId, matchesId, releaseByteBuffer, setAll, setAttachment, setBuffer, setControlType, setError, setEvent, setEventCount, setEventType, setFirstEventNumber, setNode, setNonFatalBuildingError, setRecordId, setReusableByteBuffer, setSourceId, setSourceName, setSwitchRing, setSync

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PayloadBuffer

public PayloadBuffer()

Zero-arg constructor.

PayloadBuffer

public PayloadBuffer(java.nio.ByteBuffer buffer)

Constructor that sets attachment to null.

Parameters:

buffer - ByteBuffer to wrap.

PayloadBuffer

public PayloadBuffer(java.nio.ByteBuffer buffer,
                     java.lang.Object attachment,
                     org.jlab.coda.jevio.EvioNode node)

Constructor.

Parameters:

buffer - ByteBuffer to wrap.

attachment - object to associate with the ByteBuffer.

node - object holding details about the buffer.

PayloadBuffer

public PayloadBuffer(java.nio.ByteBuffer buffer,
                     EventType eventType,
                     ControlType controlType,
                     int recordId,
                     int sourceId,
                     java.lang.String sourceName,
                     org.jlab.coda.jevio.EvioNode node)

Constructor that sets attachment to null.

Parameters:

buffer - ByteBuffer to wrap.

eventType - type of CODA events contained.

controlType - if Control eventType, the type of control.

recordId - if Physics or RocRaw, the record id of CODA events.

sourceId - If RocRaw, the CODA id of the source.

sourceName - The name of the source of these CODA events.

node - object holding details about the buffer.

PayloadBuffer

public PayloadBuffer(PayloadBuffer buf)

Copy constructor.

Parameters:

buf - ByteBuffer to wrap.

Method Detail

getTotalBytes

public int getTotalBytes()

Get the length of this structure in bytes, including the header.

Specified by:

getTotalBytes in interface RingItem

Specified by:

getTotalBytes in class RingItemAdapter

Returns:

the length of this structure in bytes, including the header.

getByteOrder

public java.nio.ByteOrder getByteOrder()

What is the byte order of this data?

Specified by:

getByteOrder in interface RingItem

Specified by:

getByteOrder in class RingItemAdapter

Returns:

ByteOrder.BIG_ENDIAN, ByteOrder.LITTLE_ENDIAN, or null

clone

public java.lang.Object clone()

Clones this object setting the attachment to null.

Overrides:

clone in class RingItemAdapter