org.jlab.coda.emu.modules

Class ToFile

java.lang.Object

org.jlab.coda.emu.modules.ModuleAdapter

org.jlab.coda.emu.modules.ToFile

All Implemented Interfaces:

EmuModule, CODAStateMachine, StatedObject

public class ToFile
extends ModuleAdapter

This class is a simplified event recording module. It has only a single thread which writes incoming data into a file. No output channels are used.

Used this module to test the ordering of events coming from the EB. The output channels were modified to place user events, arriving prior to the prestart event, after the prestart instead. This module simply wrote things directly to file so this behavior could be tested.

Author:

timmer (2016)

Nested Class Summary

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

ModuleAdapter.RateCalculatorThread

Field Summary

Fields

Modifier and Type	Field and Description
com.lmax.disruptor.SequenceBarrier	barrierIn All recording threads share one barrier.
com.lmax.disruptor.Sequence	sequence One sequence per recording thread.
(package private) org.jlab.coda.emu.modules.ToFile.RecordingThread	thread Main thread of this module.

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
ToFile(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributeMap, Emu emu) Constructor creates a new EventRecording 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.
DataChannel	getInputChannel() Get the one input channel in use.
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.

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

addOutputChannels, adjustStatistics, download, eventToOutputChannel, eventToOutputChannel, getAttr, getEndCallback, getError, getEventProducingThreadCount, getInputChannels, getInputLevels, getInputNames, getIntAttr, getInternalRingCount, 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

Field Detail

thread

org.jlab.coda.emu.modules.ToFile.RecordingThread thread

Main thread of this module.

sequence

public com.lmax.disruptor.Sequence sequence

One sequence per recording thread.

barrierIn

public com.lmax.disruptor.SequenceBarrier barrierIn

All recording threads share one barrier.

Constructor Detail

ToFile

public ToFile(java.lang.String name,
              java.util.Map<java.lang.String,java.lang.String> attributeMap,
              Emu emu)
       throws org.jlab.coda.jevio.EvioException

Constructor creates a new EventRecording instance.

Parameters:

name - name of module

attributeMap - map containing attributes of module

emu - Emu containing this module.

Throws:

org.jlab.coda.jevio.EvioException - if cannot write file

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

getInputChannel

public DataChannel getInputChannel()

Get the one input channel in use.

Returns:

the one input channel in use.

clearChannels

public void clearChannels()

Remove all channels from this EmuModule object.

Specified by:

clearChannels in interface EmuModule

Overrides:

clearChannels in class ModuleAdapter

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

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

end

public void end()

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

Specified by:

end in interface CODAStateMachine

Overrides:

end in class ModuleAdapter

prestart

public void prestart()
              throws CmdExecException

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

Specified by:

prestart in interface CODAStateMachine

Overrides:

prestart in class ModuleAdapter

Throws:

CmdExecException - if error during command execution.