Package schrodinger :: Package ui :: Package qt :: Module appframework :: Class JobInputParams

Class JobInputParams

object --+
         |
        JobInputParams

A class to store the state of the JobInputFrame, and to control behavior needed to create access to structure files. This class writes input structure files in the CWD.

Instance Methods

[hide private]

__init__(self, input_frame)
Container class for the job parameters of the input frame.

__repr__(self)
Formal string representation of the object.

getFilename(self, parent, jobname, append=False)
Write the input structure file and return the file name.

getFilenames(self, parent, jobname, append=False)
Return a list of filenames representing the input selection.

setupFile(self, parent, jobname)
If "copyfile" is True, copies "fileselection" file to <jobname>.<ext>, where <ext> is the extension of the "fileselection" file.

setupFiles(self, jobname)
For multiple files, it's not clear what should be done for setup based on the jobname, so do nothing but return a copy of the list of selected files.

setupProjectTable(self, parent, jobname, append=False, source='selected_entries')
Do setup for project table structure source.

setupWorkspace(self, parent, jobname, append=False, allow_multiple=False)
Do setup for workspace structure source.

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, input_frame)
(Constructor)

Container class for the job parameters of the input frame.

Overrides: object.__init__

repr(self)
(Representation operator)

Formal string representation of the object.

Overrides: object.__repr__

getFilename(self, parent, jobname, append=False)

Write the input structure file and return the file name. The file name will be derived from the jobname. Set 'append' to True if PT or WS input is to be appended to the input file. The parent widget is needed in order to pop up dialogs under some circumstances. Return None if not successful. This method won't do anything but return the filename if it has been called previously.

getFilenames(self, parent, jobname, append=False)

Return a list of filenames representing the input selection. Uses the base class getFilename() for WORKSPACE, SELECTED_ENTRIES, and INCLUDED_ENTRIES, and INCLUDED_ENTRY input. Unlike the base getFilename(), this method will not copy the FILE source file list to the local directory. This method won't do anything but return the filenames if it has been called previously.

Will return None on error or if the user has cancelled.

setupFile(self, parent, jobname)

If "copyfile" is True, copies "fileselection" file to <jobname>.<ext>, where <ext> is the extension of the "fileselection" file.

If "copyfile" is False (Ev:116034), returns the user-selected file.

Returns None if user cancelled or on error (after displaying error).

setupProjectTable(self, parent, jobname, append=False, source=`'selected_entries'`)

Do setup for project table structure source. Write (append=False) or append (append=True) the selected Project Table entries to the file <jobname>.maegz. Pops up an "OK"/"Cancel" dialog if the file already exists, and overwrites the file if "OK" is chosen. Returns None if there is a problem exporting the structure(s) from Maestro, or if the writing is cancelled.

setupWorkspace(self, parent, jobname, append=False, allow_multiple=False)

Do setup for workspace structure source. Write (append=False) or append (append=True) the Workspace structure to the file <jobname>.maegz. Pops up an "OK"/"Cancel" dialog if the file already exists, and overwrites the file if "OK" is chosen. Returns None if there is no WS structure, or if the writing is cancelled.

Class JobInputParams

__init__(self, input_frame) (Constructor)

__repr__(self) (Representation operator)

getFilename(self, parent, jobname, append=False)

getFilenames(self, parent, jobname, append=False)

setupFile(self, parent, jobname)

setupProjectTable(self, parent, jobname, append=False, source='selected_entries')

setupWorkspace(self, parent, jobname, append=False, allow_multiple=False)

init(self, input_frame)
(Constructor)

repr(self)
(Representation operator)

setupProjectTable(self, parent, jobname, append=False, source=`'selected_entries'`)