org.jlab.coda.emu

Interface EmuModule

All Superinterfaces:

CODAStateMachine, StatedObject

All Known Implementing Classes:

Dummy, EventRecording, FarmController, FastEventBuilder, ModuleAdapter, RocFixedRateSimulation, RocSimulation, TsFixedRateSimulation, TsSimulation

public interface EmuModule
extends StatedObject, CODAStateMachine

Interface EmuModule a simple interface to a modular part of the EMU.

Author:

heyes, timmer Sep 17, 2008

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	addOutputChannels(java.util.ArrayList<DataChannel> output_channels) Add the given output channels to this EmuModule object.
void	adjustStatistics(long eventsAdded, long wordsAdded) Adjust the event count and word count reported by this module to run control by added the given numbers.
void	clearChannels() Remove all channels from this EmuModule object.
java.lang.String	getAttr(java.lang.String name) Get the named attribute from the config file of this module.
int	getEventProducingThreadCount() Get the number of threads which produce events to be placed in output channels.
java.util.ArrayList<DataChannel>	getInputChannels() Get the input channels of this EmuModule object.
int[]	getInputLevels() Get array containing the relative fill level (0-100) of each input channel's ring.
java.lang.String[]	getInputNames() Get the names of the input channels of this EmuModule object.
int	getIntAttr(java.lang.String name) Get the named attribute, as an integer, from the config file of this module.
int	getInternalRingCount() Get the number of items this EmuModule object has in its internal rings.
java.util.ArrayList<DataChannel>	getOutputChannels() Get the output channels of this EmuModule object.
int[]	getOutputLevels() Get array containing the relative fill level (0-100) of each output channel's ring(s).
java.lang.String[]	getOutputNames() Get the names of the output channels of this EmuModule object.
java.nio.ByteOrder	getOutputOrder() Get the byte order of the module's output.
java.lang.Object[]	getStatistics() Get the output statistics of this EmuModule object.
java.lang.String	name() Get the name of the module
boolean	representsEmuStatistics() If an EMU has more than one module, which module's statistics represent the EMU as a whole needs to be determined.

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.StatedObject

getError, state

Methods inherited from interface org.jlab.coda.emu.support.codaComponent.CODAStateMachine

download, end, getEndCallback, getPrestartCallback, go, pause, prestart, registerEndCallback, registerPrestartCallback, reset

Method Detail

name

java.lang.String name()

Get the name of the module

Returns:

module name

getAttr

java.lang.String getAttr(java.lang.String name)
                  throws DataNotFoundException

Get the named attribute from the config file of this module.

Parameters:

name - name of the module's config file attribute.

Returns:

string value of the attribute

Throws:

DataNotFoundException - if attribute not found.

getIntAttr

int getIntAttr(java.lang.String name)
        throws DataNotFoundException,
               java.lang.NumberFormatException

Get the named attribute, as an integer, from the config file of this module.

Parameters:

name - name of the module's config file attribute.

Returns:

integer value of the attribute

Throws:

DataNotFoundException - if attribute not found.

java.lang.NumberFormatException - if attribute cannot be interpreted as an integer

addInputChannels

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

Add the given input channels to this EmuModule object.

Parameters:

input_channels - the input channels to add to this EmuModule object

addOutputChannels

void addOutputChannels(java.util.ArrayList<DataChannel> output_channels)

Add the given output channels to this EmuModule object.

Parameters:

output_channels - the output channels to add to this EmuModule object

getInputChannels

java.util.ArrayList<DataChannel> getInputChannels()

Get the input channels of this EmuModule object.

Returns:

ArrayList containing the input channels of this EmuModule object

getOutputChannels

java.util.ArrayList<DataChannel> getOutputChannels()

Get the output channels of this EmuModule object.

Returns:

ArrayList containing the output channels of this EmuModule object

getInternalRingCount

int getInternalRingCount()

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

Returns:

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

getInputNames

java.lang.String[] getInputNames()

Get the names of the input channels of this EmuModule object. Used in gathering statistics.

Returns:

array containing names of input channels of this EmuModule object

getOutputNames

java.lang.String[] getOutputNames()

Get the names of the output channels of this EmuModule object. Used in gathering statistics.

Returns:

array containing names of output channels of this EmuModule object

getInputLevels

int[] getInputLevels()

Get array containing the relative fill level (0-100) of each input channel's ring. Used in gathering statistics.

Returns:

array containing relative fill level (0-100) of input channels' ring(s).

getOutputLevels

int[] getOutputLevels()

Get array containing the relative fill level (0-100) of each output channel's ring(s). Used in gathering statistics.

Returns:

array containing relative fill level (0-100) of output channels' ring(s).

clearChannels

void clearChannels()

Remove all channels from this EmuModule object.

getStatistics

java.lang.Object[] getStatistics()

Get the output statistics of this EmuModule object. The output statistics consists of an array of 2 Longs, 2 Floats, 4 Integers, and 1 int array:

1. event count (Long)

2. word count (Long)

3. event rate in Hz (Float

4. data rate in kBytes/sec (Float)

5. max event size in bytes (Integer) if module is an EB

6. min event size in bytes (Integer) if module is an EB

7. avg event size in bytes (Integer) if module is an EB

8. suggested value for chunk*EtBufSize (Integer) if have ET output channel

9. if EB and switched on, histogram of time to build 1 event in nanoseconds (int array)

Returns:

array of objects containing in order: 1) event count (Long), 2) word count (Long), 3) event rate(Float), 4) data rate (Float), optionally 5) max event byte size (Integer), 6) min event byte size (Integer), 7) average event byte size (Integer), and 8) suggested value for chunk*EtBufSize (Integer) if have ET output channel, or 9) histogram of time to build 1 event in nanosec (int array), or null if no statistics reported for this module.

adjustStatistics

void adjustStatistics(long eventsAdded,
                      long wordsAdded)

Adjust the event count and word count reported by this module to run control by added the given numbers. This is necessary in the file output channel when the limit of the disk partition is reached and physics events must be thrown away after passing through the module.

Parameters:

eventsAdded - number of events to be added the event count

wordsAdded - number of words to be added the word count

representsEmuStatistics

boolean representsEmuStatistics()

If an EMU has more than one module, which module's statistics represent the EMU as a whole needs to be determined. This method returns true if this module's statistics may represent the EMU as a whole. This may be specified in an EMU's xml configuration file by including the attribute statistics="on" in the module definition.

Returns:

true if this module's statistics represents the EMU, else false.

getEventProducingThreadCount

int getEventProducingThreadCount()

Get the number of threads which produce events to be placed in output channels.

Returns:

number of threads which produce events to be placed in output channels.

getOutputOrder

java.nio.ByteOrder getOutputOrder()

Get the byte order of the module's output. Defaults to big endian.

Returns:

byte order of the module's output.