org.jlab.coda.emu.support.data

Class RingItemAdapter

java.lang.Object

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

All Implemented Interfaces:

java.lang.Cloneable, Attached, RingItem

Direct Known Subclasses:

PayloadBuffer

abstract class RingItemAdapter
extends java.lang.Object
implements RingItem

This class provides the boilerplate methods of the RingItem interface. This class is meant to be extended to handle a specific type of data object to be placed in ring buffers for consumption by emu modules and transport channels.

Author:

timmer Date: Feb 28, 2014

See Also:

PayloadBuffer

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	attachment Associated object used to store things.
protected java.nio.ByteBuffer	buffer ByteBuffer to wrap.
protected ByteBufferItem	byteBufferItem This refers to the wrapper object of buffer in reusable ByteBufferSupply (if any).
protected ByteBufferSupply	byteBufferSupply This refers to a supply of reusable ByteBuffers from which buffer came (if any).
protected ControlType	controlType If this is a control event, what type of control is it (SYNC, GO, END, ...)?
protected org.jlab.coda.jevio.EvioEvent	event Event to wrap.
protected int	eventCount The number of CODA events (triggers) contained in this evio bank.
protected EventType	eventType What type of CODA events are contained in this bank (RocRaw, Physics, Control, User, ...)? Only one type is stored in one RingItem object.
protected long	firstEventNumber The event number of the first CODA event in this evio bank.
protected boolean	hasError Has error? from ROC raw data record 4-bit status.
protected boolean	isFirst Is this USER event also a "first event" to be written in each file split?
protected boolean	isSync Is sync bank? from ROC raw data record 4-bit status.
protected boolean	isUser Is this a USER event type?
protected boolean	matchesId Does sourceId match id of input channel?
protected org.jlab.coda.jevio.EvioNode	node Object containing info about specific evio event in the buffer.
protected boolean	nonFatalBuildingError Was there an non-fatal error generated while trying to build an event?
protected int	recordId If the event type is RocRaw or Physics, this is the record id of this CODA events.
protected boolean	reserved Reserved.
protected int	sourceId If the event type is RocRaw, this is the CODA id of the source.
protected java.lang.String	sourceName The name of the source of these CODA events.
protected boolean	switchRing When reading from multiple rings, is it time to change to next ring?

Constructor Summary

Constructors

Constructor and Description
RingItemAdapter() Constructor.
RingItemAdapter(int nodeArraySize) Constructor.
RingItemAdapter(RingItem ringItem) Copy constructor which copies references and doesn't clone.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone()
void	copy(RingItem ringItem) Copy members of argument into this object (except for "reserved").
java.lang.Object	getAttachment() This method gets an attached object.
java.nio.ByteBuffer	getBuffer() Get the ByteBuffer object (containing evio data) referenced by this ring item if any.
ByteBufferItem	getByteBufferItem() Get the ByteBufferItem object used to wrap the referenced ByteBuffer (if any).
ByteBufferSupply	getByteBufferSupply() Get the ByteBufferSupply object used to create the referenced ByteBuffer (if any).
abstract java.nio.ByteOrder	getByteOrder() Get the byte order of the data contained in this object.
ControlType	getControlType() If this is control event, this method returns the type of control event, otherwise it returns null.
org.jlab.coda.jevio.EvioEvent	getEvent() Get the evio event object contained in this ring item if any.
int	getEventCount() Get the number of ROC events in this object's data.
EventType	getEventType() Get the type of event (ROC raw, physics, user, control , etc) this is.
long	getFirstEventNumber() Get the first event number in this object's data.
org.jlab.coda.jevio.EvioNode	getNode() Get the EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item, if any.
int	getRecordId() The recordId, for a physics or ROC Raw type, starts at zero and increases by one in each successive "evio-file-format" data buffer.
int	getSourceId() If emu input channel is reading ROC raw data, then this method gets the CODA id number of the source.
java.lang.String	getSourceName() Get the name of the data input channel (from xml config file) which read the data into this object.
boolean	getSwitchRing() If merging contents of multiple rings, it's convenient to have a means to tell the caller when to switch reading from one ring to the next.
abstract int	getTotalBytes() Get the length of this structure in bytes, including the header.
boolean	hasError() Did this object already have an error when first received from transport?
boolean	hasNonFatalBuildingError() Did this object generate a non-fatal error while being built (still allows build to continue) ?
boolean	isControlEvent() Is this object a control event?
boolean	isFirstEvent() Is this object a first event?
void	isFirstEvent(boolean isFirst) Set whether this object a first event.
boolean	isSync() Is this object is a sync event? This condition is set by the ROC and it is only read - never set.
boolean	isUser() Is this object a USER event type?
void	isUser(boolean isUser)
boolean	matchesId() Does the source id match that of the input channel?
void	matchesId(boolean matchesId) Set whether the source id matches that of the input channel.
void	releaseByteBuffer() Releases a ByteBuffer (if any) referenced by this object which was obtained from a ByteBufferSupply object.
void	setAll(org.jlab.coda.jevio.EvioEvent ev, java.nio.ByteBuffer buf, org.jlab.coda.jevio.EvioNode nd, EventType eType, ControlType cType, boolean user, boolean first, int chanId, int rId, int sId, int evCount, java.lang.String sName, ByteBufferItem bbItem, ByteBufferSupply bbSupply) For a ringItem producer, when a new item is obtained, it must have all of its values set or reset.
void	setAttachment(java.lang.Object attachment) This method sets an attached object.
void	setBuffer(java.nio.ByteBuffer buffer) Set the ByteBuffer object (containing evio data) referenced by this ring item if any.
void	setControlType(ControlType type) Set the type of control event this is.
void	setError(boolean hasError) Sets whether or not this object has an error.
void	setEvent(org.jlab.coda.jevio.EvioEvent event) Set the evio event object contained in this ring item.
void	setEventCount(int eventCount) Set the number of ROC events in this object's data.
void	setEventType(EventType type) Set the type of event (ROC raw, physics, user, control , etc) this is.
void	setFirstEventNumber(long firstEventNumber) Set the first event number in this object's data.
void	setNode(org.jlab.coda.jevio.EvioNode node) Set the EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item, if any.
void	setNonFatalBuildingError(boolean nonFatalBuildingError) Sets whether or not this object generated a non-fatal error while being built.
void	setRecordId(int recordId) This method sets the record id.
void	setReusableByteBuffer(ByteBufferSupply byteBufferSupply, ByteBufferItem byteBufferItem) Set the objects needed to release (by calling RingItem.releaseByteBuffer()) the referenced ByteBuffer when no longer needed.
void	setSourceId(int sourceId) If emu input channel is reading Roc Raw data, then this method sets the CODA id number of the source.
void	setSourceName(java.lang.String sourceName) Set the name of the data input channel (from xml config file) which read the data into this object.
void	setSwitchRing(boolean switchRing) If merging contents of multiple rings, it's convenient to have a means to tell the caller when to switch reading from one ring to the next.
void	setSync(boolean sync) Sets whether or not this object is a sync event.

Methods inherited from class java.lang.Object

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

Field Detail

event

protected org.jlab.coda.jevio.EvioEvent event

Event to wrap. If defined, buffer and node are null.

buffer

protected java.nio.ByteBuffer buffer

ByteBuffer to wrap. If defined, event is null.

node

protected org.jlab.coda.jevio.EvioNode node

Object containing info about specific evio event in the buffer.

eventType

protected EventType eventType

What type of CODA events are contained in this bank (RocRaw, Physics, Control, User, ...)? Only one type is stored in one RingItem object. Only one control event is stored in one RingItem object.

controlType

protected ControlType controlType

If this is a control event, what type of control is it (SYNC, GO, END, ...)?

isUser

protected boolean isUser

Is this a USER event type?

isFirst

protected boolean isFirst

Is this USER event also a "first event" to be written in each file split?

sourceId

protected int sourceId

If the event type is RocRaw, this is the CODA id of the source.

matchesId

protected boolean matchesId

Does sourceId match id of input channel?

sourceName

protected java.lang.String sourceName

The name of the source of these CODA events.

recordId

protected int recordId

If the event type is RocRaw or Physics, this is the record id of this CODA events. The record id is incremented by one for each ET event. Many CODA events (triggers) may have the same record id.

eventCount

protected int eventCount

The number of CODA events (triggers) contained in this evio bank.

firstEventNumber

protected long firstEventNumber

The event number of the first CODA event in this evio bank.

switchRing

protected boolean switchRing

When reading from multiple rings, is it time to change to next ring?

isSync

protected boolean isSync

Is sync bank? from ROC raw data record 4-bit status.

hasError

protected boolean hasError

Has error? from ROC raw data record 4-bit status.

reserved

protected boolean reserved

Reserved. from ROC raw data record 4-bit status.

nonFatalBuildingError

protected boolean nonFatalBuildingError

Was there an non-fatal error generated while trying to build an event?

attachment

protected java.lang.Object attachment

Associated object used to store things.

byteBufferSupply

protected ByteBufferSupply byteBufferSupply

This refers to a supply of reusable ByteBuffers from which buffer came (if any).

byteBufferItem

protected ByteBufferItem byteBufferItem

This refers to the wrapper object of buffer in reusable ByteBufferSupply (if any).

Constructor Detail

RingItemAdapter

public RingItemAdapter()

Constructor.

RingItemAdapter

public RingItemAdapter(int nodeArraySize)

Constructor.

Parameters:

nodeArraySize - number of EvioNode objects to create in pool.

RingItemAdapter

public RingItemAdapter(RingItem ringItem)

Copy constructor which copies references and doesn't clone.

Parameters:

ringItem - ring item to copy

Method Detail

copy

public void copy(RingItem ringItem)

Copy members of argument into this object (except for "reserved").

Specified by:

copy in interface RingItem

Parameters:

ringItem - ring item to copy.

getByteOrder

public abstract java.nio.ByteOrder getByteOrder()

Get the byte order of the data contained in this object.

Specified by:

getByteOrder in interface RingItem

Returns:

byte order of the data contained in this object.

getTotalBytes

public abstract int getTotalBytes()

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

Specified by:

getTotalBytes in interface RingItem

Returns:

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

setAll

public void setAll(org.jlab.coda.jevio.EvioEvent ev,
                   java.nio.ByteBuffer buf,
                   org.jlab.coda.jevio.EvioNode nd,
                   EventType eType,
                   ControlType cType,
                   boolean user,
                   boolean first,
                   int chanId,
                   int rId,
                   int sId,
                   int evCount,
                   java.lang.String sName,
                   ByteBufferItem bbItem,
                   ByteBufferSupply bbSupply)

For a ringItem producer, when a new item is obtained, it must have all of its values set or reset. This does so in one convenient method. Note that in general, only 1 of ev, buf, or node is specified.

Specified by:

setAll in interface RingItem

Parameters:

ev - EvioEvent object (1st way of specifying evio data)

buf - ByteBuffer object (2nd way of specifying evio data)

nd - EvioNode object (3rd way of specifying evio data)

eType - type of event: roc raw, physics, user, control, etc.

cType - type of control event: prestart, go, end, etc.

user - is this a USER event type

first - is this a "first" or "beginning-of-run" event

chanId - ID of data channel this method is called for

rId - record ID

sId - CODA ID of data source

evCount - number of events in data

sName - name of data source

bbItem - ByteBufferItem object holding the ByteBuffer containing the data

bbSupply - Supply object containing the ByteBufferItem

getEvent

public org.jlab.coda.jevio.EvioEvent getEvent()

Get the evio event object contained in this ring item if any.

Specified by:

getEvent in interface RingItem

Returns:

evio event object contained in this ring item if any (null if none).

setEvent

public void setEvent(org.jlab.coda.jevio.EvioEvent event)

Set the evio event object contained in this ring item.

Specified by:

setEvent in interface RingItem

Parameters:

event - evio event object to be contained in this ring item.

getBuffer

public java.nio.ByteBuffer getBuffer()

Get the ByteBuffer object (containing evio data) referenced by this ring item if any. Used in conjunction with {RingItem.getNode()}.

Specified by:

getBuffer in interface RingItem

Returns:

ByteBuffer object referenced by this ring item if any (null if none).

setBuffer

public void setBuffer(java.nio.ByteBuffer buffer)

Set the ByteBuffer object (containing evio data) referenced by this ring item if any. Used in conjunction with {RingItem.setNode(org.jlab.coda.jevio.EvioNode)}.

Specified by:

setBuffer in interface RingItem

Parameters:

buffer - ByteBuffer object to be referenced by this ring item.

getNode

public org.jlab.coda.jevio.EvioNode getNode()

Get the EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item, if any. Used in conjunction with {RingItem.getBuffer()}.

Specified by:

getNode in interface RingItem

Returns:

EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item, if any (null if none).

setNode

public void setNode(org.jlab.coda.jevio.EvioNode node)

Set the EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item, if any. Used in conjunction with {RingItem.setBuffer(java.nio.ByteBuffer)}.

Specified by:

setNode in interface RingItem

Parameters:

node - EvioNode object which selects a particular event in the ByteBuffer referenced by this ring item.

releaseByteBuffer

public void releaseByteBuffer()

Releases a ByteBuffer (if any) referenced by this object which was obtained from a ByteBufferSupply object. This allows the buffer to be reused.

Specified by:

releaseByteBuffer in interface RingItem

setReusableByteBuffer

public void setReusableByteBuffer(ByteBufferSupply byteBufferSupply,
                                  ByteBufferItem byteBufferItem)

Set the objects needed to release (by calling RingItem.releaseByteBuffer()) the referenced ByteBuffer when no longer needed.

Specified by:

setReusableByteBuffer in interface RingItem

Parameters:

byteBufferSupply - object which supplied the ByteBuffer

byteBufferItem - object wrapping ByteBuffer in the supply

getByteBufferSupply

public ByteBufferSupply getByteBufferSupply()

Get the ByteBufferSupply object used to create the referenced ByteBuffer (if any).

Specified by:

getByteBufferSupply in interface RingItem

Returns:

ByteBufferSupply object used to create the referenced ByteBuffer (if any, else null).

getByteBufferItem

public ByteBufferItem getByteBufferItem()

Get the ByteBufferItem object used to wrap the referenced ByteBuffer (if any).

Specified by:

getByteBufferItem in interface RingItem

Returns:

ByteBufferItem object used to wrap the referenced ByteBuffer (if any, else null).

getAttachment

public java.lang.Object getAttachment()

This method gets an attached object.

Specified by:

getAttachment in interface Attached

Returns:

the attached object.

setAttachment

public void setAttachment(java.lang.Object attachment)

This method sets an attached object.

Specified by:

setAttachment in interface Attached

Parameters:

attachment - the object to attach.

isControlEvent

public boolean isControlEvent()

Is this object a control event?

Specified by:

isControlEvent in interface RingItem

Returns:

true if control event, else false.

getControlType

public ControlType getControlType()

If this is control event, this method returns the type of control event, otherwise it returns null.

Specified by:

getControlType in interface RingItem

Returns:

type of control event, else null.

setControlType

public void setControlType(ControlType type)

Set the type of control event this is.

Specified by:

setControlType in interface RingItem

Parameters:

type - type of control event this is.

isUser

public boolean isUser()

Is this object a USER event type?

Specified by:

isUser in interface RingItem

Returns:

true if USEr event type, else false.

isUser

public void isUser(boolean isUser)

isFirstEvent

public boolean isFirstEvent()

Is this object a first event?

Specified by:

isFirstEvent in interface RingItem

Returns:

true if first event, else false.

isFirstEvent

public void isFirstEvent(boolean isFirst)

Set whether this object a first event.

Specified by:

isFirstEvent in interface RingItem

Parameters:

isFirst - true if first event, else false.

getEventType

public EventType getEventType()

Get the type of event (ROC raw, physics, user, control , etc) this is.

Specified by:

getEventType in interface RingItem

Returns:

type of event this is.

setEventType

public void setEventType(EventType type)

Set the type of event (ROC raw, physics, user, control , etc) this is.

Specified by:

setEventType in interface RingItem

Parameters:

type - type of event this is.

getSourceId

public int getSourceId()

If emu input channel is reading ROC raw data, then this method gets the CODA id number of the source.

Specified by:

getSourceId in interface RingItem

Returns:

CODA id number of input ROC raw data source.

setSourceId

public void setSourceId(int sourceId)

If emu input channel is reading Roc Raw data, then this method sets the CODA id number of the source.

Specified by:

setSourceId in interface RingItem

Parameters:

sourceId - CODA id number of input Roc Raw data source.

matchesId

public boolean matchesId()

Does the source id match that of the input channel?

Specified by:

matchesId in interface RingItem

Returns:

true if source id matches that of the input channel, else false.

matchesId

public void matchesId(boolean matchesId)

Set whether the source id matches that of the input channel.

Specified by:

matchesId in interface RingItem

Parameters:

matchesId - true if source id matches that of the input channel, else false.

getRecordId

public int getRecordId()

The recordId, for a physics or ROC Raw type, starts at zero and increases by one in each successive "evio-file-format" data buffer. It is set to -1 for other data types. This id is copied into each RingItem and many items can have the same id. This method gets the record id.

Specified by:

getRecordId in interface RingItem

Returns:

record id

setRecordId

public void setRecordId(int recordId)

This method sets the record id.

Specified by:

setRecordId in interface RingItem

Parameters:

recordId - the record id

getSourceName

public java.lang.String getSourceName()

Get the name of the data input channel (from xml config file) which read the data into this object.

Specified by:

getSourceName in interface RingItem

Returns:

name of the data input channel from xml config file.

setSourceName

public void setSourceName(java.lang.String sourceName)

Set the name of the data input channel (from xml config file) which read the data into this object.

Specified by:

setSourceName in interface RingItem

Parameters:

sourceName - name of the data input channel from xml config file.

getEventCount

public int getEventCount()

Get the number of ROC events in this object's data.

Specified by:

getEventCount in interface RingItem

Returns:

number of ROC events in this object's data.

setEventCount

public void setEventCount(int eventCount)

Set the number of ROC events in this object's data.

Specified by:

setEventCount in interface RingItem

Parameters:

eventCount - number of ROC events in this object's data.

getFirstEventNumber

public long getFirstEventNumber()

Get the first event number in this object's data.

Specified by:

getFirstEventNumber in interface RingItem

Returns:

first event number in this object's data.

setFirstEventNumber

public void setFirstEventNumber(long firstEventNumber)

Set the first event number in this object's data.

Specified by:

setFirstEventNumber in interface RingItem

Parameters:

firstEventNumber - first event number in this object's data.

getSwitchRing

public boolean getSwitchRing()

If merging contents of multiple rings, it's convenient to have a means to tell the caller when to switch reading from one ring to the next.

Specified by:

getSwitchRing in interface RingItem

Returns:

true if time to switch ring being read, else false.

setSwitchRing

public void setSwitchRing(boolean switchRing)

If merging contents of multiple rings, it's convenient to have a means to tell the caller when to switch reading from one ring to the next.

Specified by:

setSwitchRing in interface RingItem

Parameters:

switchRing - true if time to switch ring being read, else false.

isSync

public boolean isSync()

Is this object is a sync event? This condition is set by the ROC and it is only read - never set.

Specified by:

isSync in interface RingItem

Returns:

true if this object is a sync event, else false.

setSync

public void setSync(boolean sync)

Sets whether or not this object is a sync event. This condition is set by the ROC and so this method is only used to pass on that information.

Specified by:

setSync in interface RingItem

Parameters:

sync - true if this object is a sync event, else false.

hasError

public boolean hasError()

Did this object already have an error when first received from transport?

Specified by:

hasError in interface RingItem

Returns:

true if this object had an error when first received, else false.

setError

public void setError(boolean hasError)

Sets whether or not this object has an error.

Specified by:

setError in interface RingItem

Parameters:

hasError - true if this object has an error, else false.

hasNonFatalBuildingError

public boolean hasNonFatalBuildingError()

Did this object generate a non-fatal error while being built (still allows build to continue) ?

Specified by:

hasNonFatalBuildingError in interface RingItem

Returns:

true if this object generated a non-fatal build error, else false.

setNonFatalBuildingError

public void setNonFatalBuildingError(boolean nonFatalBuildingError)

Sets whether or not this object generated a non-fatal error while being built.

Specified by:

setNonFatalBuildingError in interface RingItem

Parameters:

nonFatalBuildingError - true if this object generate a non-fatal error while being built, else false.

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object