org.jlab.coda.et

Class EtAttachment

java.lang.Object

org.jlab.coda.et.EtAttachment

public class EtAttachment
extends java.lang.Object

This class defines an ET system user's attachment to a station. Attachments can only be created by an ET system's EtSystem.attach(EtStation) method. Attachments are means of designating the ownership of events and keeping track of events.

Author:

Carl Timmer

Constructor Summary

Constructors

Constructor and Description
EtAttachment(EtStation station, int id, EtSystem sys) Constructor for creating an attachment to a specific ET system and station.

Method Summary

Modifier and Type	Method and Description
long	getEventsDump() Gets the number of events dumped (recycled by returning to GRAND_CENTRAL station) through this attachment.
long	getEventsGet() Gets the number of events gotten from the ET system by this attachment.
long	getEventsMake() Gets the number of new events gotten from the ET system by this attachment.
long	getEventsPut() Gets the number of events put into the ET system by this attachment.
int	getId() Gets the id number of this attachment.
EtStation	getStation() Gets the object of the station attached to.
EtSystem	getSys() Sets the EtSystemUse object for using the ET system.
boolean	isUsable() Tells if this attachment object is usable.
(package private) void	setUsable(boolean usable) Sets whether this attachment object is usable or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtAttachment

EtAttachment(EtStation station,
             int id,
             EtSystem sys)

Constructor for creating an attachment to a specific ET system and station. Attachments can only be created by an ET system's EtSystem.attach(EtStation) method.

Parameters:

station - station object

id - unique attachment id number

sys - ET system object

Method Detail

getStation

public EtStation getStation()

Gets the object of the station attached to.

Returns:

object of station attached to

getId

public int getId()

Gets the id number of this attachment.

Returns:

id number of this attachment

isUsable

public boolean isUsable()

Tells if this attachment object is usable.

Returns:

true if attachment object is usable and false otherwise

setUsable

void setUsable(boolean usable)

Sets whether this attachment object is usable or not.

Parameters:

usable - true if this attachment object is usable and false otherwise

getSys

public EtSystem getSys()

Sets the EtSystemUse object for using the ET system.

Returns:

the EtSystemUse object for using the ET system

getEventsPut

public long getEventsPut()
                  throws java.io.IOException,
                         org.jlab.coda.et.exception.EtException

Gets the number of events put into the ET system by this attachment.

Returns:

number of events put into the ET system by this attachment

Throws:

java.io.IOException - if there are network communication problems

org.jlab.coda.et.exception.EtException - if the station no longer exists

getEventsGet

public long getEventsGet()
                  throws java.io.IOException,
                         org.jlab.coda.et.exception.EtException

Gets the number of events gotten from the ET system by this attachment.

Returns:

number of events gotten from the ET system by this attachment

Throws:

java.io.IOException - if there are network communication problems

org.jlab.coda.et.exception.EtException - if the station no longer exists

getEventsDump

public long getEventsDump()
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtException

Gets the number of events dumped (recycled by returning to GRAND_CENTRAL station) through this attachment.

Returns:

number of events dumped into the ET system by this attachment

Throws:

java.io.IOException - if there are network communication problems

org.jlab.coda.et.exception.EtException - if the station no longer exists

getEventsMake

public long getEventsMake()
                   throws java.io.IOException,
                          org.jlab.coda.et.exception.EtException

Gets the number of new events gotten from the ET system by this attachment.

Returns:

number of new events gotten from the ET system by this attachment

Throws:

java.io.IOException - if there are network communication problems

org.jlab.coda.et.exception.EtException - if the station no longer exists