summaryrefslogtreecommitdiffstats
path: root/lab_control/oscilloscope.py
diff options
context:
space:
mode:
Diffstat (limited to 'lab_control/oscilloscope.py')
-rw-r--r--lab_control/oscilloscope.py18
1 files changed, 11 insertions, 7 deletions
diff --git a/lab_control/oscilloscope.py b/lab_control/oscilloscope.py
index 9f2d02c..e4b5a89 100644
--- a/lab_control/oscilloscope.py
+++ b/lab_control/oscilloscope.py
@@ -1,17 +1,21 @@
+""" Interface definition for oscilloscope devices. """
+
class Oscilloscope:
+ """
+ This interface specifies the common API for all
+ supported oscilloscope devices.
+ """
def __init__(self):
- raise Exception("This class should not be instantiated directly, please extend it instead")
+ pass
def measureAmplitude(self, channel: int) -> float:
- pass
+ """ Return amplitude measurement on specific channel. """
def measurePeakToPeak(self, channel: int) -> float:
- pass
+ """ Return peak-to-peak measurement on specific channel. """
def measureRMS(self, channel: int) -> float:
- pass
+ """ Return RMS measurement on specific channel. """
def measureFrequency(self, channel: int) -> float:
- pass
-
-
+ """ Return frequency measurement on specific channel. """