org.jlab.coda.emu.support.transport

Class DataTransportImplEt

java.lang.Object

org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

org.jlab.coda.emu.support.transport.DataTransportAdapter

org.jlab.coda.emu.support.transport.DataTransportImplEt

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataTransport

public class DataTransportImplEt
extends DataTransportAdapter

This class specifies a single ET system to connect to. The ET system may be created and destroyed by this class.

Author:

timmer Jun 4, 2010

Field Summary

Fields inherited from class org.jlab.coda.emu.support.transport.DataTransportAdapter

attr, connected, errorMsg, isServer, name, transportClass, transportState

Constructor Summary

Constructors

Constructor and Description
DataTransportImplEt(java.lang.String pname, java.util.Map<java.lang.String,java.lang.String> attrib, Emu emu) Constructor.

Method Summary

Modifier and Type	Method and Description
DataChannel	createChannel(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> attributeMap, boolean isInput, Emu emu, EmuModule module, int outputIndex) This method creates a DataChannel object.
void	download() This method implements the DOWNLOAD transition of the CODA run control state machine.
int	getEventsInGroup() Gets the number of events per group in the opened ET system.
org.jlab.coda.et.system.SystemCreate	getLocalEtSystem() Get the locally created ET system object, if any.
org.jlab.coda.et.EtSystemOpenConfig	getOpenConfig() Gets the configuration for opening the ET system.
org.jlab.coda.et.system.SystemConfig	getSystemConfig() Get the configuration for creating the ET system.
void	reset() This method implements the RESET transition of the CODA run control state machine.
boolean	tryToCreateET() Get whether the ET system should be created by the EMU if it does not exist.

Methods inherited from class org.jlab.coda.emu.support.transport.DataTransportAdapter

getAttr, getError, getIntAttr, getTransportClass, isConnected, isServer, name, setAttr, setConnected, setName, state

Methods inherited from class org.jlab.coda.emu.support.codaComponent.CODAStateMachineAdapter

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

Methods inherited from class java.lang.Object

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

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

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

Constructor Detail

DataTransportImplEt

public DataTransportImplEt(java.lang.String pname,
                           java.util.Map<java.lang.String,java.lang.String> attrib,
                           Emu emu)
                    throws DataNotFoundException

Constructor.

Parameters:

pname - name of transport

attrib - transport's attribute map from config file

emu - emu object this transport belongs to

Throws:

DataNotFoundException - when cannot configure an ET system

Method Detail

tryToCreateET

public boolean tryToCreateET()

Get whether the ET system should be created by the EMU if it does not exist.

Returns:

whether the ET system should be created by the EMU if it does not exist

getOpenConfig

public org.jlab.coda.et.EtSystemOpenConfig getOpenConfig()

Gets the configuration for opening the ET system.

Returns:

configuration for opening the ET system

getSystemConfig

public org.jlab.coda.et.system.SystemConfig getSystemConfig()

Get the configuration for creating the ET system.

Returns:

configuration for creating the ET system

getLocalEtSystem

public org.jlab.coda.et.system.SystemCreate getLocalEtSystem()

Get the locally created ET system object, if any.

Returns:

locally created ET system object, if any.

getEventsInGroup

public int getEventsInGroup()

Gets the number of events per group in the opened ET system.

Returns:

number of events per group in the opened ET system.

createChannel

public DataChannel createChannel(java.lang.String name,
                                 java.util.Map<java.lang.String,java.lang.String> attributeMap,
                                 boolean isInput,
                                 Emu emu,
                                 EmuModule module,
                                 int outputIndex)
                          throws DataTransportException

This method creates a DataChannel object.

Parameters:

name - name of DataChannel

attributeMap - hashmap of attributes taken from XML config file

isInput - true if this channel puts data into the Emu, else false

emu - Emu owning this channel

module - module creating this channel

outputIndex - order in which module's events will be sent to this output channel (0 for first output channel, 1 for next, etc.).

Returns:

DataChannel object

Throws:

DataTransportException - if transport problem

reset

public void reset()

This method implements the RESET transition of the CODA run control state machine.. All this method does is remove any created ET system.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class DataTransportAdapter

download

public void download()
              throws CmdExecException

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

Specified by:

download in interface CODAStateMachine

Overrides:

download in class CODAStateMachineAdapter

Throws:

CmdExecException - if error during command execution.