org.jlab.coda.emu.modules

Class RocFixedRateSimulation

java.lang.Object

org.jlab.coda.emu.modules.ModuleAdapter

org.jlab.coda.emu.modules.RocFixedRateSimulation

All Implemented Interfaces:

EmuModule, CODAStateMachine, StatedObject

public class RocFixedRateSimulation
extends ModuleAdapter

This class simulates a Roc. It is a module which can use multiple threads to create events and send them to a single output channel.

This ROC works with TsFixedRateSimulation class to establish a fixed data rate for all simulated ROCs together. Total rate is set in TsFixedRateSimulation.

Author:

timmer (2011)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	RocFixedRateSimulation.EventGeneratingThread This thread generates events with junk data in it (all zeros except first word which is the event number).

Nested classes/interfaces inherited from class org.jlab.coda.emu.modules.ModuleAdapter

ModuleAdapter.RateCalculatorThread

Field Summary

Fields inherited from class org.jlab.coda.emu.modules.ModuleAdapter

attributeMap, avgEventSize, emu, endCallback, epThreadsSetInConfig, errorMsg, eventCountTotal, eventProducingThreads, eventRate, goodChunk_X_EtBufSize, id, inputChanLevels, inputChanNames, inputChannelCount, inputChannels, logger, maxEventSize, minEventSize, moduleState, name, outputChanLevels, outputChanNames, outputChannelCount, outputChannels, outputOrder, paused, prestartCallback, RateCalculator, representStatistics, statGatheringPeriod, statistics, timeStatsOn, timeToBuild, wordCountTotal, wordRate

Constructor Summary

Constructors

Constructor and Description
RocFixedRateSimulation(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributeMap, Emu emu) Constructor RocSimulation creates a simulated ROC instance.

Method Summary

Modifier and Type	Method and Description
void	addInputChannels(java.util.ArrayList<DataChannel> input_channels) Add the given input channels to this EmuModule object.
void	clearChannels() Remove all channels from this EmuModule object.
void	end() This method implements the END transition of the CODA run control state machine.
(package private) void	eventToOutputRing(int ringNum, java.nio.ByteBuffer buf, ByteBufferItem item, ByteBufferSupply bbSupply) This method is called by a running EventGeneratingThread.
java.util.ArrayList<DataChannel>	getInputChannels() Get the input channels of this EmuModule object.
int	getInternalRingCount() Get the number of items this EmuModule object has in its internal rings.
void	go() This method implements the GO transition of the CODA run control state machine.
void	prestart() This method implements the PRESTART transition of the CODA run control state machine.
void	reset() This method implements the RESET transition of the CODA run control state machine.
(package private) void	writeEventBuffer(java.nio.ByteBuffer buf, java.nio.ByteBuffer templateBuf, long eventNumber, long timestamp, boolean copy)

Methods inherited from class org.jlab.coda.emu.modules.ModuleAdapter

addOutputChannels, adjustStatistics, download, eventToOutputChannel, eventToOutputChannel, getAttr, getEndCallback, getError, getEventProducingThreadCount, getInputLevels, getInputNames, getIntAttr, getOutputChannels, getOutputLevels, getOutputNames, getOutputOrder, getPrestartCallback, getStatistics, name, pause, registerEndCallback, registerPrestartCallback, representsEmuStatistics, state

Methods inherited from class java.lang.Object

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

Constructor Detail

RocFixedRateSimulation

public RocFixedRateSimulation(java.lang.String name,
                              java.util.Map<java.lang.String,java.lang.String> attributeMap,
                              Emu emu)

Constructor RocSimulation creates a simulated ROC instance.

Parameters:

name - name of module

attributeMap - map containing attributes of module

emu - Emu this module belongs to.

Method Detail

addInputChannels

public void addInputChannels(java.util.ArrayList<DataChannel> input_channels)

Add the given input channels to this EmuModule object.

Specified by:

addInputChannels in interface EmuModule

Overrides:

addInputChannels in class ModuleAdapter

Parameters:

input_channels - the input channels to add to this EmuModule object

getInputChannels

public java.util.ArrayList<DataChannel> getInputChannels()

Get the input channels of this EmuModule object.

Specified by:

getInputChannels in interface EmuModule

Overrides:

getInputChannels in class ModuleAdapter

Returns:

ArrayList containing the input channels of this EmuModule object

clearChannels

public void clearChannels()

Remove all channels from this EmuModule object.

Specified by:

clearChannels in interface EmuModule

Overrides:

clearChannels in class ModuleAdapter

getInternalRingCount

public int getInternalRingCount()

Get the number of items this EmuModule object has in its internal rings.

Specified by:

getInternalRingCount in interface EmuModule

Overrides:

getInternalRingCount in class ModuleAdapter

Returns:

number of items this EmuModule object has in its internal rings.

eventToOutputRing

void eventToOutputRing(int ringNum,
                       java.nio.ByteBuffer buf,
                       ByteBufferItem item,
                       ByteBufferSupply bbSupply)

This method is called by a running EventGeneratingThread. It generates many ROC Raw events in it with simulated data, and places them onto the ring buffer of an output channel.

Parameters:

ringNum - the id number of the output channel ring buffer

buf - the event to place on output channel ring buffer

item - item corresponding to the buffer allowing buffer to be reused

bbSupply - supply of ByteBuffers.

writeEventBuffer

void writeEventBuffer(java.nio.ByteBuffer buf,
                      java.nio.ByteBuffer templateBuf,
                      long eventNumber,
                      long timestamp,
                      boolean copy)

reset

public void reset()

This method implements the RESET transition of the CODA run control state machine.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class ModuleAdapter

end

public void end()
         throws CmdExecException

This method implements the END transition of the CODA run control state machine.

Specified by:

end in interface CODAStateMachine

Overrides:

end in class ModuleAdapter

Throws:

CmdExecException - if error during command execution.

prestart

public void prestart()

This method implements the PRESTART transition of the CODA run control state machine.

Specified by:

prestart in interface CODAStateMachine

Overrides:

prestart in class ModuleAdapter

go

public void go()

This method implements the GO transition of the CODA run control state machine.

Specified by:

go in interface CODAStateMachine

Overrides:

go in class ModuleAdapter