|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.imperial.ph.hep.command.DaqCmdParamOnOff
public class DaqCmdParamOnOff
This class represents a DaqCmdParameter which is either on or off. The off behaviour is taken to be the default. getExecString() will return the default flag. Check using isUnaltered() whether the command is set to its default value or not.
Constructor Summary | |
---|---|
DaqCmdParamOnOff(java.lang.String def,
java.lang.String on)
Initialise a CmdParam which only takes on/off values. |
|
DaqCmdParamOnOff(java.lang.String def,
java.lang.String on,
java.lang.String description)
|
Method Summary | |
---|---|
java.lang.String |
getDescription()
|
java.lang.String |
getExecString()
|
boolean |
isEnabled()
Returns true if this parameter is enabled. |
boolean |
isUnaltered()
Returns true if the execString equals the offString. |
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public DaqCmdParamOnOff(java.lang.String def, java.lang.String on)
def
- -
the value by default, i.e. when NOT explicitly specified.on
- -
the value when specified.public DaqCmdParamOnOff(java.lang.String def, java.lang.String on, java.lang.String description)
Method Detail |
---|
public void setOff()
DaqCmdParam
setOff
in interface DaqCmdParam
public void setOn()
DaqCmdParam
setOn
in interface DaqCmdParam
public java.lang.String getExecString()
getExecString
in interface DaqCmdParam
public boolean isUnaltered()
isUnaltered
in interface DaqCmdParam
public void reset()
DaqCmdParam
reset
in interface DaqCmdParam
public boolean isEnabled()
DaqCmdParam
isEnabled
in interface DaqCmdParam
public void setEnabled(boolean enabled)
DaqCmdParam
setEnabled
in interface DaqCmdParam
public java.lang.String getDescription()
getDescription
in interface DaqCmdParam
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |