[python source code]

analysis_object_mixins

All mixin classes providing common methods and attributes for analysis objects.

Examples include MATH, SEARCH, BUS, PLOT,…etc.

BusMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.BusMixin[BusMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.BusMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.BusMixin"

A mixin class which adds methods and properties for handling bus objetcs.

add_bus abstractmethod 

add_bus(bus_num: int) -> None

Add a new bus.

Parameters:
  • bus_num (int) –

    The number of the bus to add.

add_new_bus abstractmethod 

add_new_bus(bus_name: str, bus_type: str) -> None

Add a new bus with the given name, and type.

Parameters:
  • bus_name (str) –

    The name of the new bus.

  • bus_type (str) –

    The type of the new bus.

delete_bus abstractmethod 

delete_bus(bus_num: int) -> None

Delete a bus.

Parameters:
  • bus_num (int) –

    The number of the bus to delete.

HistogramMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.HistogramMixin[HistogramMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.HistogramMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.HistogramMixin"

A mixin class which adds methods and properties for handling histrogram objects.

add_histogram abstractmethod 

add_histogram(hist_num: int) -> None

Add a new histogram.

Parameters:
  • hist_num (int) –

    The number of the histogram to add.

delete_histogram abstractmethod 

delete_histogram(hist_num: int) -> None

Delete a histogram.

Parameters:
  • hist_num (int) –

    The number of the histogram to delete.

MathMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MathMixin[MathMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MathMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MathMixin"

A mixin class which adds methods and properties for handling math objects.

add_math abstractmethod 

add_math(math_num: int) -> None

Add a new math.

Parameters:
  • math_num (int) –

    The number of the math to add.

add_new_math abstractmethod 

add_new_math(math_name: str, math_expression: str) -> None

Add a new math with the given expression.

Parameters:
  • math_name (str) –

    The name of the math.

  • math_expression (str) –

    The math expression.

delete_math abstractmethod 

delete_math(math_num: int) -> None

Delete a math.

Parameters:
  • math_num (int) –

    The number of the math to delete.

MeasurementsMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MeasurementsMixin[MeasurementsMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MeasurementsMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.MeasurementsMixin"

A mixin class which adds methods and properties for handling measurement objects.

add_measurement abstractmethod 

add_measurement(measurement_num: int) -> None

Add a new measurement.

Parameters:
  • measurement_num (int) –

    The number of the measurement to add.

add_measurement_table abstractmethod 

add_measurement_table(meas_table_num: int) -> None

Add a new measurement table.

Parameters:
  • meas_table_num (int) –

    The number of the measurement table to add.

add_new_measurement abstractmethod 

add_new_measurement(meas_name: str, meas_type: str, meas_source: str | None = None) -> None

Add a new measurement with the given name, type, and source.

Parameters:
  • meas_name (str) –

    The name of the new measurement.

  • meas_type (str) –

    The type of the new measurement.

  • meas_source (str | None, default: None ) –

    The source of the new measurement. If None, the currently selected waveform (or first available valid source) will be used as the source.

delete_measurement abstractmethod 

delete_measurement(measurement_num: int) -> None

Delete a measurement.

Parameters:
  • measurement_num (int) –

    The number of the measurement to delete.

delete_measurement_table abstractmethod 

delete_measurement_table(measurement_table_num: int) -> None

Delete a measurement table.

Parameters:
  • measurement_table_num (int) –

    The number of the measurement table to delete.

PlotMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PlotMixin[PlotMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PlotMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PlotMixin"

A mixin class which adds methods and properties for handling plot objects.

add_new_plot abstractmethod 

add_new_plot(plot_name: str, plot_type: str) -> None

Add a new plot with the given name, and type.

Parameters:
  • plot_name (str) –

    The name of the new plot.

  • plot_type (str) –

    The type of the new plot.

add_plot abstractmethod 

add_plot(plot_num: int) -> None

Add a new plot.

Parameters:
  • plot_num (int) –

    The number of the plot to add.

delete_plot abstractmethod 

delete_plot(plot_num: int) -> None

Delete a plot.

Parameters:
  • plot_num (int) –

    The number of the plot to delete.

PowerMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PowerMixin[PowerMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PowerMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.PowerMixin"

A mixin class which adds methods and properties for handling power objects.

add_power abstractmethod 

add_power(power_meas_num: int) -> None

Add a new power measurement.

Parameters:
  • power_meas_num (int) –

    The number of the power measurement to add.

delete_power abstractmethod 

delete_power(power_num: int) -> None

Delete a power.

Parameters:
  • power_num (int) –

    The number of the power to delete.

ReferenceMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.ReferenceMixin[ReferenceMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.ReferenceMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.ReferenceMixin"

A mixin class which adds methods and properties for handling reference objects.

add_ref abstractmethod 

add_ref(ref_num: int) -> None

Add a new ref.

Parameters:
  • ref_num (int) –

    The number of the ref to add.

delete_ref abstractmethod 

delete_ref(ref_num: int) -> None

Delete a ref.

Parameters:
  • ref_num (int) –

    The number of the ref to delete.

recall_reference abstractmethod 

recall_reference(reference_path: str, ref_number: int | str) -> None

Recall a reference waveform file.

Parameters:
  • reference_path (str) –

    The path to the reference waveform file.

  • ref_number (int | str) –

    The REF number to recall the waveform to.

save_waveform_to_reference abstractmethod 

save_waveform_to_reference(waveform: str, reference: str) -> None

Save the specified waveform to a reference.

Parameters:
  • waveform (str) –

    The name of the waveform to save, e.g. CH1, MATH1, etc.

  • reference (str) –

    The name of the target reference, e.g. REF1.

SearchMixin

Bases: ABC

flowchart LR tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.SearchMixin[SearchMixin] click tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.SearchMixin href "" "tm_devices.driver_mixins.abstract_device_functionality.analysis_object_mixins.SearchMixin"

A mixin class which adds methods and properties for handling search objects.

add_search(search_num: int) -> None

Add a new search.

Parameters:
  • search_num (int) –

    The number of the search to add.

 
delete_search(search_num: int) -> None

Delete a search.

Parameters:
  • search_num (int) –

    The number of the search to delete.