uk.ac.imperial.ph.hep.command
Interface DaqCmdParam

All Known Subinterfaces:

DaqCmdParamOption

All Known Implementing Classes:

DaqCmdParamOnOff, DaqCmdParamSimple

public interface DaqCmdParam

Daq Commands consist of a command name and a number of parameters. When the execute method is called on the command object, each DaqCmdParam owned by the DaqCmd has its getExecString() method called, which should return a string to be appended to the executed command.

Author:

Jamie Ballin, HEP, Imperial College London

Method Summary

java.lang.String	getDescription()
java.lang.String	getExecString()
boolean	isEnabled() Returns true if this parameter is enabled.
boolean	isUnaltered()
void	reset() Reinitialise the paramter, and reenable it.
void	setEnabled(boolean enabled) Call this passing in false if you want the parameter to be ignored.
void	setOff() Sets this parameter to be its default value.
void	setOn() Sets this parameter to be its non-default value.

Method Detail

getExecString

java.lang.String getExecString()

Returns:

the string the parameter would append.

isUnaltered

boolean isUnaltered()

Returns:

true if the parameter has not altered from its original default state.

reset

void reset()

Reinitialise the paramter, and reenable it.

setOn

void setOn()

Sets this parameter to be its non-default value.

setOff

void setOff()

Sets this parameter to be its default value.

isEnabled

boolean isEnabled()

Returns true if this parameter is enabled.

Returns:

setEnabled

void setEnabled(boolean enabled)

Call this passing in false if you want the parameter to be ignored.

Parameters:

enabled -

getDescription

java.lang.String getDescription()

Returns:

a short one-line description of what this parameter does.