org.jlab.coda.emu

Class EmuDataPath

java.lang.Object

org.jlab.coda.emu.EmuDataPath

public class EmuDataPath
extends java.lang.Object

This class represents data flow through connected EMU modules. It's constructed in 2 stages. First, the EMU config file is parsed and a linked list of Modules from module names is made. Later when EmuModule objects are constructed by the Emu, they are placed in the existing list so proper distribution of run control commands can be made.

Author:

timmer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	EmuDataPath.Module Class to store module-related data.

Constructor Summary

Constructors

Constructor and Description
EmuDataPath(java.lang.String name, java.lang.String inputFifo, java.lang.String outputFifo) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	addModuleName(java.lang.String name, java.lang.String inputFifo, java.lang.String outputFifo) Add a module to the data path.
boolean	associateModule(EmuModule module) Associate an EmuModule object with a module of the same name in the path.
void	clear() Clear all existing modules from data path.
boolean	containsModule(EmuModule module) Does this path contain the given EmuModule object?
boolean	containsModuleName(java.lang.String name) Does this path contain a module of the given name?
java.util.LinkedList<EmuModule>	getEmuModules() Get the linked list of the EmuModules in this path.
java.util.LinkedList<EmuDataPath.Module>	getModules() Get the linked list of the Modules in this path.
java.lang.String	toString() Create a string representation of this object.

Methods inherited from class java.lang.Object

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

Constructor Detail

EmuDataPath

public EmuDataPath(java.lang.String name,
                   java.lang.String inputFifo,
                   java.lang.String outputFifo)

Constructor.

Parameters:

name - name of module to create

inputFifo - name of any input fifo, else null

outputFifo - name of any output fifo, else null

Method Detail

addModuleName

public boolean addModuleName(java.lang.String name,
                             java.lang.String inputFifo,
                             java.lang.String outputFifo)

Add a module to the data path. This method does not add an EmuModule object, but only the module name and any input and output fifo names. Any associated EmuModule is attached later with a call to associateModule(EmuModule).

Parameters:

name - name of module to create and add

inputFifo - name of any input fifo, else null

outputFifo - name of any output fifo, else null

Returns:

true if module added, else false

clear

public void clear()

Clear all existing modules from data path.

associateModule

public boolean associateModule(EmuModule module)

Associate an EmuModule object with a module of the same name in the path.

Parameters:

module - EmuModule to associate with a module

Returns:

true if module associated, else false

getModules

public java.util.LinkedList<EmuDataPath.Module> getModules()

Get the linked list of the Modules in this path.

Returns:

linked list of the Modules in this path.

getEmuModules

public java.util.LinkedList<EmuModule> getEmuModules()

Get the linked list of the EmuModules in this path.

Returns:

linked list of the EmuModules in this path.

containsModuleName

public boolean containsModuleName(java.lang.String name)

Does this path contain a module of the given name?

Parameters:

name - name of module

Returns:

true if module in path, else false

containsModule

public boolean containsModule(EmuModule module)

Does this path contain the given EmuModule object?

Parameters:

module - EmuModule object

Returns:

true if module in path, else false

toString

public java.lang.String toString()

Create a string representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this object.