org.jlab.coda.emu.modules

Class Dummy

java.lang.Object

org.jlab.coda.emu.modules.ModuleAdapter

org.jlab.coda.emu.modules.Dummy

All Implemented Interfaces:

EmuModule, CODAStateMachine, StatedObject

public class Dummy
extends ModuleAdapter

This class is a (not so) bare bones module used for testing and as a template. It handles multiple input and output channels. It will consume events through input channels and pass each input item to each of the output channels.

Author:

timmer 4/26/2013

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[]	buildBarrierIn For each input channel, all event-moving threads share one barrier.
com.lmax.disruptor.Sequence[][]	buildSequenceIn For each input channel, 1 sequence per event-moving thread.

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
Dummy(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributeMap, Emu emu) Constructor.

Method Summary

Modifier and Type	Method and Description
void	end() This method implements the END transition of the CODA run control state machine.
void	go() This method implements the GO transition of the CODA run control state machine.
void	pause() This method implements the PAUSE 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

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

Methods inherited from class java.lang.Object

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

Field Detail

buildSequenceIn

public com.lmax.disruptor.Sequence[][] buildSequenceIn

For each input channel, 1 sequence per event-moving thread.

buildBarrierIn

public com.lmax.disruptor.SequenceBarrier[] buildBarrierIn

For each input channel, all event-moving threads share one barrier.

Constructor Detail

Dummy

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

Constructor.

Parameters:

name - name of module

attributeMap - map containing attributes of module

emu - emu that contains this module

Method Detail

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()
              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.

pause

public void pause()

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

Specified by:

pause in interface CODAStateMachine

Overrides:

pause in class ModuleAdapter

go

public void go()
        throws CmdExecException

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

Specified by:

go in interface CODAStateMachine

Overrides:

go in class ModuleAdapter

Throws:

CmdExecException - if error during command execution.