org.jlab.coda.et

Class EtStationConfig

java.lang.Object

org.jlab.coda.et.EtStationConfig

All Implemented Interfaces:

java.io.Serializable

public class EtStationConfig
extends java.lang.Object
implements java.io.Serializable

This class specifies a configuration used to create a new station.

Author:

Carl Timmer

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EtStationConfig() Creates a new StationConfig object with default values for everything.
EtStationConfig(EtStationConfig config) Creates a new StationConfig object from an existing one.

Method Summary

Modifier and Type	Method and Description
static boolean	compatibleParallelConfigs(EtStationConfig group, EtStationConfig config) Checks to see if station configurations are compatible when adding a parallel station to an existing group of parallel stations.
int	getBlockMode() Gets the block mode.
int	getCue() Gets the cue size.
int	getFlowMode() Gets the flow mode.
int	getPrescale() Gets the prescale value.
int	getRestoreMode() Gets the restore mode.
int[]	getSelect() Gets a copy of the select integer array.
java.lang.String	getSelectClass() Gets the name of the class containing the user-defined select method.
java.lang.String	getSelectFunction() Gets the user-defined select function name.
java.lang.String	getSelectLibrary() Gets the name of the library containing the user-defined select function.
int	getSelectMode() Gets the select mode.
int	getUserMode() Gets the user mode.
void	setBlockMode(int mode) Sets the station's block mode value.
void	setCue(int q) Sets the station's cue size.
void	setFlowMode(int mode) Sets the station's flow mode value.
void	setPrescale(int pre) Sets the station's prescale value.
void	setRestoreMode(int mode) Sets the station's restore mode value.
void	setSelect(int[] sel) Sets the station's select integer array.
void	setSelectClass(java.lang.String sClass) Sets the class containing the user-defined select method.
void	setSelectFunction(java.lang.String func) Sets the station's user-defined select function.
void	setSelectLibrary(java.lang.String lib) Sets the library containing the user-defined select function.
void	setSelectMode(int mode) Sets the station's select mode value.
void	setUserMode(int mode) Sets the station's user mode value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EtStationConfig

public EtStationConfig()

Creates a new StationConfig object with default values for everything. The default values are: cue = EtConstants.defaultStationCue, prescale = EtConstants.defaultStationPrescale, flowMode = EtConstants.stationSerial, userMode = EtConstants.stationUserMulti, restoreMode = EtConstants.stationRestoreOut, blockMode = EtConstants.stationBlocking, selectMode = EtConstants.stationSelectAll, and select = filled with -1's

EtStationConfig

public EtStationConfig(EtStationConfig config)

Creates a new StationConfig object from an existing one.

Parameters:

config - config to copy

Method Detail

compatibleParallelConfigs

public static boolean compatibleParallelConfigs(EtStationConfig group,
                                                EtStationConfig config)

Checks to see if station configurations are compatible when adding a parallel station to an existing group of parallel stations.

Parameters:

group - station configuration of head of existing group of parallel stations

config - configuration of station seeking to be added to the group

Returns:

false if configs are incompatible, else true.

getCue

public int getCue()

Gets the cue size.

Returns:

cue size

getPrescale

public int getPrescale()

Gets the prescale value.

Returns:

prescale value

getFlowMode

public int getFlowMode()

Gets the flow mode.

Returns:

flow mode

getUserMode

public int getUserMode()

Gets the user mode.

Returns:

user mode

getRestoreMode

public int getRestoreMode()

Gets the restore mode.

Returns:

restore mode

getBlockMode

public int getBlockMode()

Gets the block mode.

Returns:

block mode

getSelectMode

public int getSelectMode()

Gets the select mode.

Returns:

select mode

getSelect

public int[] getSelect()

Gets a copy of the select integer array.

Returns:

copy of select integer array

getSelectFunction

public java.lang.String getSelectFunction()

Gets the user-defined select function name.

Returns:

selection function name

getSelectLibrary

public java.lang.String getSelectLibrary()

Gets the name of the library containing the user-defined select function.

Returns:

library name

getSelectClass

public java.lang.String getSelectClass()

Gets the name of the class containing the user-defined select method.

Returns:

class name

setCue

public void setCue(int q)
            throws org.jlab.coda.et.exception.EtException

Sets the station's cue size.

Parameters:

q - cue size

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad cue size value

setPrescale

public void setPrescale(int pre)
                 throws org.jlab.coda.et.exception.EtException

Sets the station's prescale value.

Parameters:

pre - prescale value

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad prescale value

setFlowMode

public void setFlowMode(int mode)
                 throws org.jlab.coda.et.exception.EtException

Sets the station's flow mode value.

Parameters:

mode - flow mode

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad flow mode value

setUserMode

public void setUserMode(int mode)
                 throws org.jlab.coda.et.exception.EtException

Sets the station's user mode value.

Parameters:

mode - user mode

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad user mode value

setRestoreMode

public void setRestoreMode(int mode)
                    throws org.jlab.coda.et.exception.EtException

Sets the station's restore mode value.

Parameters:

mode - restore mode

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad restore mode value

setBlockMode

public void setBlockMode(int mode)
                  throws org.jlab.coda.et.exception.EtException

Sets the station's block mode value.

Parameters:

mode - block mode

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad block mode value

setSelectMode

public void setSelectMode(int mode)
                   throws org.jlab.coda.et.exception.EtException

Sets the station's select mode value.

Parameters:

mode - select mode

Throws:

org.jlab.coda.et.exception.EtException - if there is a bad select mode value

setSelect

public void setSelect(int[] sel)
               throws org.jlab.coda.et.exception.EtException

Sets the station's select integer array.

Parameters:

sel - select integer array

Throws:

org.jlab.coda.et.exception.EtException - if there are the wrong number of elements in the array

setSelectFunction

public void setSelectFunction(java.lang.String func)
                       throws org.jlab.coda.et.exception.EtException

Sets the station's user-defined select function.

Parameters:

func - name of the user-defined select function

Throws:

org.jlab.coda.et.exception.EtException - if argument is too long

setSelectLibrary

public void setSelectLibrary(java.lang.String lib)
                      throws org.jlab.coda.et.exception.EtException

Sets the library containing the user-defined select function.

Parameters:

lib - name of the library containing the user-defined select function

Throws:

org.jlab.coda.et.exception.EtException - if argument is too long

setSelectClass

public void setSelectClass(java.lang.String sClass)
                    throws org.jlab.coda.et.exception.EtException

Sets the class containing the user-defined select method.

Parameters:

sClass - name of the class containing the user-defined select method

Throws:

org.jlab.coda.et.exception.EtException - if argument is too long