The base_premade module
Base class for premade experiments.
Classes
BasePremadeFrame
-
class src.gui.main.base_premade.BasePremadeFrame(parent, title, graphData, measurementType=None)[source]
A class providing common functionality to premade experiment frames.
| Parameters : | parent : wxFrame
The frame which owns this frame (if any).
title : str
The title of this premade experiment (it will go in the title bar).
graphData : list of tuple of str
A list of tuples, where each tuple represents a single graph and
contains three strings: the x-axis label, the y-axis label, and the
title of the graph. Note that the first two must be the same as the
names of the columns from which the data come.
measurementType : str
A short indication of the measurement type for going into the default
filenames.
|
|---|
Methods
-
addConfigurationPanel(panel)[source]
Add a panel to the configuration area.
| Parameters : | panel : wxPanel
A panel or a panel subclass to add to the configuration area.
|
|---|
-
edited[source]
Return that the experiment has not been edited.
| Returns : | bool :
Whether the experiment has been edited. Always False for premade
experiments.
|
|---|
-
showConfig(show)[source]
Show or hide the configuration panel.
| Parameters : | show : bool
Whether to show the configuration panel.
|
|---|
GraphPanel
-
class src.gui.main.base_premade.GraphPanel(parent, graphData)[source]
A panel for storing individual graphing panels.
| Parameters : | parent : wxWindow
The frame or panel into which this panel will be inserted.
graphData : list of tuple of str
A list of tuples, where each tuple represents a single graph and
contains three strings: the x-axis label, the y-axis label, and the
title of the graph. Note that the first two must be the same as the
names of the columns from which the data come.
|
|---|
Methods
-
getGraphManager()[source]
Get the graph manager to deal with data.
| Returns : | EmbeddableGraphManager :
The graph manager with this panel as its parent and the
graph panels this panel has created as its contents.
|
|---|
ConfigPanel
-
class src.gui.main.base_premade.ConfigPanel(parent)[source]
The panel for configuring the instruments before use.
| Parameters : | parent : wxWindow
The panel or frame which should be the parent of this panel.
|
|---|
Methods
-
add(panel)[source]
Add an item to the panel.
| Parameters : | panel : wxPanel
The sub-panel to add to this panel.
|
|---|
-
show(show)[source]
Show or hide this panel.
| Parameters : | show : bool
Whether to show the panel.
|
|---|
FilenamePanel
-
class src.gui.main.base_premade.FilenamePanel(parent, fileData)[source]
A panel for displaying a filename and parameter comments.
Methods
FileData
-
class src.gui.main.base_premade.FileData(system, measurementType, extension, fieldNames, fieldCodes, rootDirectory, sampleName, cooldownDate, fieldConfiguration, dimensions, options, directoryComment, fileComment, prependNumber, groupDrive, manualFile)[source]
A container for the standard path components for a data file.
Methods
-
static fromFile(system, measurementType, extension)[source]
Construct an object from a configuration file.
-
getPath()[source]
Return the actual intended path for the data file.
-
save()[source]
Save the file data to the configuration file.
-
update(rootDirectory, sampleName, cooldownDate, fieldConfiguration, dimensions, options, directoryComment, fileComment, prependNumber, groupDrive, manualFile)[source]
Update the information associated with the data file.