The base_experiment module

Abstract base class for experiment frames.

Classes

ExperimentFrame

class src.gui.main.base_experiment.ExperimentFrame(parent, experiment=None, title='Untitled Experiment', icon=None, premade=True, experimentPath=None, globalStatus='none-running', **kwargs)

A frame meant to be overridden by frames for developing experiments.

Parameters :

parent : Transport

The main Transport program frame (or anything which implements the same interface).

experiment : Experiment

The Experiment object which this frame edits.

title : str

The default name for the experiment.

icon : code

Bitmap data in the form of Python code to use as the icon for this frame.

premade : bool

Whether this ExperimentFrame represents a premade experiment frame. Some features—like saving and manually editing the instruments—are only available to custom experiments, so they are disabled in frames for premade experiments. The default is True.

experimentPath : str

The path to the experiment, if it was opened from a file. The default is None.

globalStatus : str

The status of the software, indicating whether any experiments are running.

Methods

appendControl(newControl)

Append a control to the list to be disabled when run begins.

Parameters :

newControl : wxWindow

The control to add to the list.

getEnded()

Return whether the experiment has finished running.

initializeMenus()

Create the menu bar.

initializeToolbar()

Create the toolbar.

notifyStatus(status=None)

Update this frame to reflect the status of the software.

Update the execution button status and the editability of panels to reflect changes in the software status (e.g., whether the experiment for this frame is running, whether the experiment for another frame is running, or whether nothing is running).

Parameters :

status : str

The status of the software. Valid options are the following:

• self-running
• self-paused
• other-running
• none-running

onAbout(event)

Open the About screen.

onClose(event)

Close the experiment.

onExit(event)

Exit the software (this is mostly handled by the parent).

onHelp(event)

Open the help system.

onHome(event)

Show the home screen, assuming it is the parent.

onNew(event)

Create a new experiment.

onOpen(event)

Open an experiment.

onPause(event)

Pause the experiment.

onPremade(event)

Open a premade experiment.

onRun(event=None)

Run the experiment.

Returns :

bool :

Whether the experiment aws successfully initiated. The method returns False if an unrecoverable error was detected or if the user cancels in response to a recoverable error.

onSave(event)

Save the experiment.

onSaveAs(event)

Save the experiment, prompting for a file name.

onStop(event)

Stop the experiment.