diff options
Diffstat (limited to 'lab_control/function_generator.py')
| -rw-r--r-- | lab_control/function_generator.py | 23 |
1 files changed, 12 insertions, 11 deletions
diff --git a/lab_control/function_generator.py b/lab_control/function_generator.py index be522d9..a403784 100644 --- a/lab_control/function_generator.py +++ b/lab_control/function_generator.py @@ -1,23 +1,24 @@ -class FunctionGenerator: - SINE = 0 - SQUARE = 1 - TRIANGULAR = 3 +""" Interface definition for function generator devices. """ +class FunctionGenerator: + """ + This interface specifies the common API for all + supported function generator devices. + """ def __init__(self): - raise Exception("This class should not be instantiated directly, please extend it instead") + pass def setOn(self, channel: int) -> None: - pass + """ Enable channel. """ def setOff(self, channel: int) -> None: - pass + """ Disable channel. """ def setFrequency(self, channel: int, frequency: float) -> None: - pass + """ Set channel output frequency. """ def setAmplitude(self, channel: int, amplitude: float) -> None: - pass + """ Set channel output amplitude. """ def setFunction(self, channel: int, function: int) -> None: - pass - + """ Set channel output waveform. """ |