org.jlab.coda.et
Class StationData

java.lang.Object
  org.jlab.coda.et.StationData

public class StationData

extends java.lang.Object

This class holds all information about an station. It parses the information from a stream of data sent by an ET system.

Field Summary

(package private) int	attachments Number of attachments to this station.
(package private) int[]	attIds Array of attachment id numbers.
(package private) int	blockMode Station configuration's blocking mode.
(package private) int	cue Station configuration's input cue size.
(package private) int	flowMode Station configuration's flow mode.
(package private) int	inListCount Number of events in the input list.
(package private) long	inListIn Number of events that were put into the input list.
(package private) int	inListMutex Input list mutex status.
(package private) long	inListTry Number of events that were attempted to be put into the input list.
(package private) int	mutex Transfer mutex status.
(package private) java.lang.String	name Name of station.
(package private) int	num Station's id number.
(package private) int	outListCount Number of events in the output list.
(package private) int	outListMutex Output list mutex status.
(package private) long	outListOut Number of events that were taken out of the output list.
(package private) int	prescale Station configuration's prescale value.
(package private) int	restoreMode Station configuration's restore mode.
(package private) int[]	select Station configuration's select array.
(package private) java.lang.String	selectClass Name of Java class containing user select method in Java version ET system.
(package private) java.lang.String	selectFunction Name of user select function in C version ET library.
(package private) java.lang.String	selectLibrary Name of C library containing user select function in C version ET system.
(package private) int	selectMode Station configuration's select mode.
(package private) int	status Station's status.
(package private) int	userMode Station configuration's user mode.

Constructor Summary

StationData()

Method Summary

int[]	getAttachmentIds() Get the array of attachment id numbers.
int	getAttachments() Get the number of attachments to this station.
int	getBlockMode() Get the station configuration's blocking mode.
int	getCue() Get the station configuration's input cue size.
int	getFlowMode() Get the station configuration's flow mode.
int	getId() Get the station's id number.
int	getInListCount() Get the number of events in the input list.
long	getInListIn() Get the number of events that were put into the input list.
int	getInListMutex() Get the input list mutex status.
long	getInListTry() Get the number of events that were attempted to be put into the input list.
int	getMutex() Get the transfer mutex status.
java.lang.String	getName() Get the name of the station.
int	getOutListCount() Get the number of events in the output list.
int	getOutListMutex() Get the output list mutex status.
long	getOutListOut() Get the number of events that were taken out of the output list.
int	getPrescale() Get the station configuration's prescale value.
int	getRestoreMode() Get the station configuration's restore mode.
int[]	getSelect() Get the station configuration's select array.
java.lang.String	getSelectClass() Get the name of the Java class containing the user select method in the Java version ET system.
java.lang.String	getSelectFunction() Get the name of the user select function in the C version ET library.
java.lang.String	getSelectLibrary() Get the name of the C library containing the user select function in the C version ET system.
int	getSelectMode() Get the station configuration's select mode.
int	getStatus() Get the station's status.
int	getUserMode() Get the station configuration's user mode.
(package private) void	read(java.io.DataInputStream dis) Reads the station information from a data stream which is sent out by an ET system over the network.

Methods inherited from class java.lang.Object

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

Field Detail

num

int num

Station's id number.

See Also:

Station.id, StationLocal.id

status

int status

Station's status. It may have the values Constants.stationUnused, Constants.stationIdle, or Constants.stationActive.

See Also:

StationLocal.status

mutex

int mutex

Transfer mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems, since in Java, mutexes cannot be tested without possibility of blocking. This is not boolean for C ET system compatibility.

See Also:

StationLocal#stopTransfer

attachments

int attachments

Number of attachments to this station.

See Also:

StationLocal.attachments

attIds

int[] attIds

Array of attachment id numbers. Only the first "attachments" number of elements are meaningful.

See Also:

StationLocal.attachments

inListMutex

int inListMutex

Input list mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems, since in Java, mutexes cannot be tested without the chance of blocking. This is not boolean for C ET system compatibility.

inListCount

int inListCount

Number of events in the input list.

See Also:

EventList.events

inListTry

long inListTry

Number of events that were attempted to be put into the input list. This is relevant only when there is prescaling.

See Also:

EventList.eventsTry

inListIn

long inListIn

Number of events that were put into the input list.

See Also:

EventList.eventsIn

outListMutex

int outListMutex

Output list mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems, since in Java, mutexes cannot be tested without the chance of blocking. This is not boolean for C ET system compatibility.

outListCount

int outListCount

Number of events in the output list.

See Also:

EventList.events

outListOut

long outListOut

Number of events that were taken out of the output list.

See Also:

EventList.eventsOut

flowMode

int flowMode

Station configuration's flow mode.

See Also:

StationConfig.userMode

userMode

int userMode

Station configuration's user mode.

See Also:

StationConfig.userMode

restoreMode

int restoreMode

Station configuration's restore mode.

See Also:

StationConfig.restoreMode

blockMode

int blockMode

Station configuration's blocking mode.

See Also:

StationConfig.blockMode

prescale

int prescale

Station configuration's prescale value.

See Also:

StationConfig.prescale

cue

int cue

Station configuration's input cue size.

See Also:

StationConfig.cue

selectMode

int selectMode

Station configuration's select mode.

See Also:

StationConfig.selectMode

select

int[] select

Station configuration's select array.

See Also:

StationConfig.select

selectFunction

java.lang.String selectFunction

Name of user select function in C version ET library.

See Also:

StationConfig.selectFunction

selectLibrary

java.lang.String selectLibrary

Name of C library containing user select function in C version ET system.

See Also:

StationConfig.selectLibrary

selectClass

java.lang.String selectClass

Name of Java class containing user select method in Java version ET system.

See Also:

StationConfig.selectClass

name

java.lang.String name

Name of station.

See Also:

Station.name, StationLocal.name

Constructor Detail

StationData

public StationData()

Method Detail

getId

public int getId()

Get the station's id number.

See Also:

Station.id, StationLocal.id

getStatus

public int getStatus()

Get the station's status. It may have the values Constants.stationUnused, Constants.stationIdle, or Constants.stationActive.

See Also:

StationLocal.status

getMutex

public int getMutex()

Get the transfer mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems.

getAttachments

public int getAttachments()

Get the number of attachments to this station.

See Also:

StationLocal.attachments

getAttachmentIds

public int[] getAttachmentIds()

Get the array of attachment id numbers.

See Also:

StationLocal.attachments

getInListMutex

public int getInListMutex()

Get the input list mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems.

getInListCount

public int getInListCount()

Get the number of events in the input list.

See Also:

EventList.events

getInListTry

public long getInListTry()

Get the number of events that were attempted to be put into the input list. This is relevant only when there is prescaling.

See Also:

EventList.eventsTry

getInListIn

public long getInListIn()

Get the number of events that were put into the input list.

See Also:

EventList.eventsIn

getOutListMutex

public int getOutListMutex()

Get the output list mutex status. It has the value Constants.mutexLocked if locked and Constants.mutexUnlocked otherwise. This is only relevant in C ET systems.

getOutListCount

public int getOutListCount()

Get the number of events in the output list.

See Also:

EventList.events

getOutListOut

public long getOutListOut()

Get the number of events that were taken out of the output list.

See Also:

EventList.eventsOut

getFlowMode

public int getFlowMode()

Get the station configuration's flow mode.

See Also:

StationConfig.flowMode

getUserMode

public int getUserMode()

Get the station configuration's user mode.

See Also:

StationConfig.userMode

getRestoreMode

public int getRestoreMode()

Get the station configuration's restore mode.

See Also:

StationConfig.restoreMode

getBlockMode

public int getBlockMode()

Get the station configuration's blocking mode.

See Also:

StationConfig.blockMode

getPrescale

public int getPrescale()

Get the station configuration's prescale value.

See Also:

StationConfig.prescale

getCue

public int getCue()

Get the station configuration's input cue size.

See Also:

StationConfig.cue

getSelectMode

public int getSelectMode()

Get the station configuration's select mode.

See Also:

StationConfig.selectMode

getSelect

public int[] getSelect()

Get the station configuration's select array.

See Also:

StationConfig.select

getSelectFunction

public java.lang.String getSelectFunction()

Get the name of the user select function in the C version ET library.

See Also:

StationConfig.selectFunction

getSelectLibrary

public java.lang.String getSelectLibrary()

Get the name of the C library containing the user select function in the C version ET system.

See Also:

StationConfig.selectLibrary

getSelectClass

public java.lang.String getSelectClass()

Get the name of the Java class containing the user select method in the Java version ET system.

See Also:

StationConfig.selectClass

getName

public java.lang.String getName()

Get the name of the station.

See Also:

Station.name, StationLocal.name

read

void read(java.io.DataInputStream dis)
    throws java.io.IOException

Reads the station information from a data stream which is sent out by an ET system over the network.

Parameters:

dis - data input stream

Throws:

java.io.IOException - if data stream read error