org.jlab.coda.emu.support.transport

Interface DataTransport

All Superinterfaces:

CODAStateMachine, StatedObject

All Known Implementing Classes:

DataTransportAdapter, DataTransportImplCmsg, DataTransportImplEmu, DataTransportImplEt, DataTransportImplFifo, DataTransportImplFile

public interface DataTransport
extends CODAStateMachine, StatedObject

This interface defines how data is transported and does not refer to a particular data connection.

Author:

heyes, timmer Sep 17, 2008

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.
java.lang.String	getAttr(java.lang.String name) This method gets an attribute as a String object.
int	getIntAttr(java.lang.String pname) This method gets an attribute as an int.
java.lang.String	getTransportClass() This method gets the name of the transport class implementing this interface.
boolean	isConnected() This method tells if this DataTransport object is connected.
boolean	isServer() This method returns true if this DataTransport object is a server (sends data) or false if it is a client (receives data).
java.lang.String	name() This method gets the name of this DataTransport object.
void	setAttr(java.lang.String name, java.lang.String value) This method sets an attribute.
void	setName(java.lang.String name) This method sets the name of this DataTransport object.

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

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

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

getError, state

Method Detail

name

java.lang.String name()

This method gets the name of this DataTransport object.

Returns:

the name of this DataTransport object.

setName

void setName(java.lang.String name)

This method sets the name of this DataTransport object.

Parameters:

name - the name of this DataTransport object.

setAttr

void setAttr(java.lang.String name,
             java.lang.String value)

This method sets an attribute.

Parameters:

name - name of attribute (key)

value - value of attribute (val)

getAttr

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

This method gets an attribute as a String object.

Parameters:

name - name of attribute

Returns:

value of attribute

Throws:

DataNotFoundException - if cannot find named attribute

getIntAttr

int getIntAttr(java.lang.String pname)
        throws DataNotFoundException

This method gets an attribute as an int.

Parameters:

pname - name of attribute

Returns:

value of attribute

Throws:

DataNotFoundException - if couldn't find named attribute

createChannel

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

isConnected

boolean isConnected()

This method tells if this DataTransport object is connected.

Returns:

true if this object is connected, else false

isServer

boolean isServer()

This method returns true if this DataTransport object is a server (sends data) or false if it is a client (receives data).

Returns:

true if this DataTransport object sends data, else false

getTransportClass

java.lang.String getTransportClass()

This method gets the name of the transport class implementing this interface.

Returns:

the name of the transport class implementing this interface