ENLIGHTEN
Cross-platform desktop GUI for Wasatch Photonics spectrometers
Loading...
Searching...
No Matches
wasatch.CommandSettings.CommandSettings Class Reference

This class encapsulates information about the "ControlObject" settings supported by WasatchDevice hardware classes (FID and SP). More...

Public Member Functions

 convert_type (self, setting, value)
 
 get_datatype (self, setting)
 
 get_settings (self)
 
 valid (self, setting)
 

Detailed Description

This class encapsulates information about the "ControlObject" settings supported by WasatchDevice hardware classes (FID and SP).

These are traditionally called "settings" when passing ControlObjects from ENLIGHTEN down into Wasatch.PY via "settings queues", but are very different from SpectrometerSettings (actual settings of the spectrometer, vs commands being passed between processes).

We're not actually using this at the moment, but it would be a way to provide some automated data validation and type-checking on callers like wasatch-shell.py

Member Function Documentation

◆ convert_type()

wasatch.CommandSettings.CommandSettings.convert_type ( self,
setting,
value )

◆ get_datatype()

wasatch.CommandSettings.CommandSettings.get_datatype ( self,
setting )

◆ get_settings()

wasatch.CommandSettings.CommandSettings.get_settings ( self)

◆ valid()

wasatch.CommandSettings.CommandSettings.valid ( self,
setting )

The documentation for this class was generated from the following file: