Class JobInputFrame

See class docstring. Raises an Exception if no input source is allowed.

Overrides: object.__init__

Add a callback for a method - quietly do nothing if such callback already exists. Example: self.addCallback(maestro.workspace_changed_function_add, self.wsChanged)

This method tracks callbacks that are added for easy removal later. This tracking is done because Maestro prints an uncatchable WARNING to the terminal if we try to remove a callback that has not been added.

Parameters:

• callback_adder (callable) - A callable function that adds a callback, such as maestro.workspace_changed_function_add
• method (callable) - The method to use as the callback function.

Callback method of the file browse button. Pops up a askopenfilename file selector and places the selected file name into the file text field

Return the contents of the filename entry field. Returns "" if this is called while file input is not allowed.

Return the list of file names from the file entry field. This is a true list, not a comma-separated list.

If the current GUI state isn't valid, pop up an error message and return None. Otherwise, return a JobInputParams object with the input source type and filename (if FILE source).

Track the selected entries and emit input_changed if the set of selected entries changes. Also emit only_inclusion_changed if the set of selected entries remains the same but the inclusion state of some of the selected entries changes.

Deregister callbacks when the panel hides itself so that we are not monitoring changes when the panel is inactive.

Parameters:

• event (QHideEvent) - The QEvent object generated by this event

Returns:

The return value of the QFrame hideEvent method

Overrides: PyQt4.QtGui.QWidget.hideEvent

Remove any previously added callbacks. We need to track callbacks in this manner because Maestro prints a WARNING message to the terminal if a non-registered callback is attempted to be removed.

Remove a callback that may have been registered previously - silently do nothing if the callback isn't registered. We need to track callbacks in this manner because Maestro prints a WARNING message to the terminal if a non-registered callback is attempted to be removed.

Parameters:

• callback_adder (callable) - A callable function that adds a callback, such as maestro.workspace_changed_function_add. This adder and its remover must be entered into the callback_removers dictionary.
• method (callable) - The method to use as the callback function.

Select the specified filename in the input selector. To specify multiple files, separate them using commas. "File" or "Files" will be selected as the input source as appropriate.

Parameters:

• filename (str) - The name of the file or files to select

Raises:

• RuntimeError - If the file entry input state is not avaiable.
• ValueError - If multiple files were provided, but the multiple files input state is not available.

Set the input type.

Parameters:

• input_state (str) - The input state to change to. It must one of FILE, SELECTED_ENTRIES, INCLUDED_ENTRIES, INCLUDED_ENTRY, or WORKSPACE.

Raises:

• ValueError - If the specified input type is not present

This method serializes the input structure(s) to disk and stores the
name of the file in the jobparam instance.  Returns False (i.e.,
aborts the setup cascade) if no input structure file is written.
Otherwise, returns True.

Job parameters set by this method are...

    inputstrucsource -   The input source type that was used (FILE,
                         SELECTED_ENTRIES, INCLUDED_ENTIRES,
                         INCLUDED_ENTRY, or WORKSPACE).

    If "writefile" is True (default):
      If "multiplefiles" is True:
        inputstrucfiles -    The names of the created structure files when
                             multiplefiles is False. If source is FILE, then
                             it's the original paths specified by the user.
      If "multiplefiles" is False:
        inputstrucfile -     The name of the created structure file
                             ( <jobname>.<ext> ) when multiple files is False
        inputstrucorigfile - For FILE source, the path to the original
                             structure file selected.
        NOTE: if "copyfile" is set to False, the "inputstrucfile" is set to
        the same value as the "inputstrucorigfile"

    If "writefile" is False:
        inputstruc -         Structure object if source is WORKSPACE or
                             INCLUDED_ENTRY.
        inputstrucfile -     Path to specified structures if source is
                             FILE and multiplefiles is False.
        inputstrucfiles -    List of paths to specified structure files,
                             if source is FILE and multiplefiles is True.

Unused parameters are set to None.

Make sure the proper signals are emitted and proper callbacks are registered when the panel shows itself

Parameters:

• event (QShowEvent) - The QEvent object generated by this event

Returns:

The return value of the QFrame showEvent method

Overrides: PyQt4.QtGui.QWidget.showEvent

A generator that returns the user-specified input structures one at a time.

API Example:

   # appframework1
   for struct in self._if.structures():
       do something
   # appframework2
   for struct in self.input_selector.structures():
       do something

Parameters:

• validate (bool) - Validate that the JobInputFrame is in a consistent and complete state (rows are actually selected or file is specified, etc.) Pops up a warning dialog and returns if the input is empty or invalid. Default is True. Useful to turn off if being called while the user might still be interacting with the panel.

Callback method of the input option menu. Disables the file selector and entry field if that is not the source chosen.

If tracking is on, this also checks to see if the set of structures selected for input has changed and sets up callbacks to continue tracking this information.

Parameters:

• result (int) - The current index of the input combobox - unused

Validate that the JobInputFrame is in a consistent and complete state. Pops up a warning dialog and returns ERROR if the input is empty or invalid.

Returns: int

class constant ERROR if no structures are specified (i.e. the source is set to FILE but there is no specified file name, source is selected entries and no entries are selected, etc.) or otherwise invalid. Otherwise it returns class constant OK.

Emit input_changed if the Workspace change merits is

Parameters:

• what_changed (maestro module constant (str)) - Description of what changed

Write selected Project Table entries to 'filename'.

append - If True, the structures will be appended to an existing file;
        otherwise, the existing file is overwritten.

warn - Obsolete. Warning is no longer issued when the file exists

Raises a RuntimeError on error.
Returns False if the user cancelled.
Returns True on success.

For backwards-compatability. Use the writePTEntries() method instead.

INCLUDED_STATES

Value:

set(['Workspace (included entries)', 'Workspace (included entry)'])