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

All Superinterfaces:
DaqCmdParam
All Known Implementing Classes:
DaqCmdParamSimple

public interface DaqCmdParamOption
extends DaqCmdParam

Option parameters which have a flag and a number of values afterwards should implement this class too.

Author:
Jamie Ballin, HEP, Imperial College London

Nested Class Summary
static class DaqCmdParamOption.Type
           
 
Method Summary
 DaqCmdParamOption.Type getOptType()
          Returns one of the bytes in this interface defining what type of option value is expected.
 boolean oneOptOnly()
          Returns true if this parameter may only have one option value, so the length of the array passed to setOptValue may be no longer than one.
 void setOptValues(java.lang.String[] val)
          Set the option values to be appended to the initial parameter flag.
 
Methods inherited from interface uk.ac.imperial.ph.hep.command.DaqCmdParam
getDescription, getExecString, isEnabled, isUnaltered, reset, setEnabled, setOff, setOn
 

Method Detail

setOptValues

void setOptValues(java.lang.String[] val)
                  throws DaqBadParameterException
Set the option values to be appended to the initial parameter flag. Throws a runtime DaqBadParameterException if one of the option values is bad.

Parameters:
val -
Throws:
DaqBadParameterException

getOptType

DaqCmdParamOption.Type getOptType()
Returns one of the bytes in this interface defining what type of option value is expected.

Returns:

oneOptOnly

boolean oneOptOnly()
Returns true if this parameter may only have one option value, so the length of the array passed to setOptValue may be no longer than one.

Returns: