org.jlab.coda.emu.support.transport

Class DataTransportImplCmsg

java.lang.Object

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

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

org.jlab.coda.emu.support.transport.DataTransportImplCmsg

All Implemented Interfaces:

CODAStateMachine, StatedObject, DataTransport

public class DataTransportImplCmsg
extends DataTransportAdapter

This class specifies a single cMsg server. Connects to and disconnects from the server.

Author:

timmer Dec 2, 2009

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
DataTransportImplCmsg(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	end() This method implements the END transition of the CODA run control state machine.
org.jlab.coda.cMsg.cMsg	getCmsgConnection() Get the cmsg connection object.
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.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

download, getEndCallback, getPrestartCallback, go, 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

download, getEndCallback, getPrestartCallback, go, registerEndCallback, registerPrestartCallback

Constructor Detail

DataTransportImplCmsg

public DataTransportImplCmsg(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 udl not given or cannot connect to cmsg server

Method Detail

getCmsgConnection

public org.jlab.coda.cMsg.cMsg getCmsgConnection()

Get the cmsg connection object.

Returns:

the cmsg connection object.

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.. Disconnect from cMsg server.

Specified by:

reset in interface CODAStateMachine

Overrides:

reset in class DataTransportAdapter

prestart

public void prestart()
              throws CmdExecException

This method implements the PRESTART transition of the CODA run control state machine.. Connect to cMsg server.

Specified by:

prestart in interface CODAStateMachine

Overrides:

prestart in class CODAStateMachineAdapter

Throws:

CmdExecException - if error during command execution.

pause

public void pause()

This method implements the PAUSE transition of the CODA run control state machine.. Stop sending messages to callbacks.

Specified by:

pause in interface CODAStateMachine

Overrides:

pause in class CODAStateMachineAdapter

end

public void end()

This method implements the END transition of the CODA run control state machine.. Disconnect from cMsg server.

Specified by:

end in interface CODAStateMachine

Overrides:

end in class CODAStateMachineAdapter