org.jlab.coda.emu.support.codaComponent

Interface CODAComponent

All Superinterfaces:

CommandAcceptor, StatedObject

All Known Implementing Classes:

Emu

public interface CODAComponent
extends CommandAcceptor

This interface describes a component in the CODA run control system. To be a part of run control, a connection to the correct cMsg server is necessary.

Author:

heyes

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Document	configuration() Get the configuration of this CODA component in the form of a parsed XML document object that is loaded from a file when the configure command is executed.
java.lang.String	getCmsgUDL() Get the UDL used to connect to the cMsg server by this CODA component.
CODAClass	getCodaClass() Get the class of this CODA component (e.g.
int	getCodaid() Get the id of this CODA component.
java.lang.String	getExpid() Get the experiment id (expid) of this CODA component.
java.lang.String	getHostName() Get the name of the host this CODA component is running on.
int	getRunNumber() Get the run number of this CODA component.
java.lang.String	getRunType() Get the runType of this CODA component.
int	getRunTypeId() Get the numeric code representing the run type of this CODA component.
java.lang.String	getSession() Get the session of this CODA component.
java.lang.String	name() Get the name of this CODA component.
org.w3c.dom.Document	parameters() Get the configuration of this CODA component in the form of a parsed XML document object that is loaded when the configure command is executed.
void	reset() Reset this CODA component.
void	setCodaid(int codaid) Set the id of this CODA component.
void	setRunNumber(int runNumber) Set the run number of this CODA component.
void	setRunType(java.lang.String runType) Set the runType of this CODA component.
void	setRunTypeId(int runTypeId) Set the numeric code representing the run type of this CODA component.

Methods inherited from interface org.jlab.coda.emu.support.control.CommandAcceptor

postCommand

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

getError, state

Method Detail

configuration

org.w3c.dom.Document configuration()

Get the configuration of this CODA component in the form of a parsed XML document object that is loaded from a file when the configure command is executed. It may change from run to run and tells the Emu which modules to load, which data transports to start and what data channels to open.

Returns:

the CODA component configuration object as a parsed XML document

parameters

org.w3c.dom.Document parameters()

Get the configuration of this CODA component in the form of a parsed XML document object that is loaded when the configure command is executed. It contains all of the status variables that change from run to run.

Returns:

the CODA component configuration object as a parsed XML document that contains all of the status variables that change from run to run

name

java.lang.String name()

Get the name of this CODA component.

Returns:

the name of this CODA component

getCodaid

int getCodaid()

Get the id of this CODA component.

Returns:

the id of this CODA component.

getSession

java.lang.String getSession()

Get the session of this CODA component.

Returns:

the session of this CODA component

getExpid

java.lang.String getExpid()

Get the experiment id (expid) of this CODA component.

Returns:

the experiment id (expid) of this CODA component

getHostName

java.lang.String getHostName()

Get the name of the host this CODA component is running on.

Returns:

the hostName of this CODAComponent object.

getCodaClass

CODAClass getCodaClass()

Get the class of this CODA component (e.g. "EMU", "ROC", "ER").

Returns:

the class of this CODA component (e.g. "EMU", "ROC", "ER")

getRunNumber

int getRunNumber()

Get the run number of this CODA component.

Returns:

the run number of this CODA component

getRunTypeId

int getRunTypeId()

Get the numeric code representing the run type of this CODA component.

Returns:

the numeric code representing the run type of this CODA component.

getRunType

java.lang.String getRunType()

Get the runType of this CODA component.

Returns:

the runType of this CODA component

getCmsgUDL

java.lang.String getCmsgUDL()

Get the UDL used to connect to the cMsg server by this CODA component.

Returns:

the UDL used to connect to the cMsg server by this CODA component

setRunNumber

void setRunNumber(int runNumber)

Set the run number of this CODA component.

Parameters:

runNumber - the run number of this CODA component

setRunTypeId

void setRunTypeId(int runTypeId)

Set the numeric code representing the run type of this CODA component.

Parameters:

runTypeId - the numeric code representing the runType of this CODA component

setRunType

void setRunType(java.lang.String runType)

Set the runType of this CODA component.

Parameters:

runType - the runType of this CODA component

setCodaid

void setCodaid(int codaid)

Set the id of this CODA component.

Parameters:

codaid - the coda id of this CODA component

reset

void reset()

Reset this CODA component.