EnlightenPlugin.EnlightenPluginRequest Class Reference

This is a "request" object sent by the ENLIGHTEN GUI to the plug-in, containing a fresh measurement to be processed. More...

Collaboration diagram for EnlightenPlugin.EnlightenPluginRequest:

Static Public Attributes
datetime	creation_time = datetime.datetime.now()
list	fields = field(default_factory=list)
ProcessedReading	processed_reading = field(default_factory=ProcessedReading)
int	request_id = -1
SpectrometerSettings	settings = field(default_factory=SpectrometerSettings)
Spectrometer	spec = field(default_factory=Spectrometer)

Detailed Description

This is a "request" object sent by the ENLIGHTEN GUI to the plug-in, containing a fresh measurement to be processed.

Each Request will have a unique request_id, which should be included in the associated EnlightenPluginResponse.

This class is being defined here so users can understand exactly what a request looks like (also, to encapsulate all exchanged message types together). However, ENLIGHTEN plug-ins will not themselves be expected to create Requests; instead, they should instantiate and return EnlightenPluginResponse.

Note that enlighten.ProcessedReading objects the original wasatch.Reading, as well as processed, dark, reference, and raw arrays.

Parameters

request_id	an integral auto-incrementing id
settings	a copy of wasatch.SpectrometerSettings
processed_reading	a copy of enlighten.ProcessedReading
fields	a key-value dictionary corresponding to the EnlightenPluginFields (EPF) declared by the EnlightenPluginConfiguration. Note these aren't the EPF objects themselves; just the string names, and current scalar values.

Member Data Documentation

creation_time

datetime EnlightenPlugin.EnlightenPluginRequest.creation_time = datetime.datetime.now()

static

fields

list EnlightenPlugin.EnlightenPluginRequest.fields = field(default_factory=list)

static

processed_reading

ProcessedReading EnlightenPlugin.EnlightenPluginRequest.processed_reading = field(default_factory=ProcessedReading)

static

request_id

int EnlightenPlugin.EnlightenPluginRequest.request_id = -1

static

settings

SpectrometerSettings EnlightenPlugin.EnlightenPluginRequest.settings = field(default_factory=SpectrometerSettings)

static

spec

Spectrometer EnlightenPlugin.EnlightenPluginRequest.spec = field(default_factory=Spectrometer)

static

---

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

• plugins/EnlightenPlugin.py