Package schrodinger :: Package ui :: Module appframework :: Class JobInputParams
[hide private]
[frames] | no frames]

Class JobInputParams

object --+
         |
        JobInputParams
Known Subclasses:

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, state, fileselection='')
Set the state (i.e., the input source -- file, PT, WS) and, if file input, the name of the source file.
 
getFilename(self, parent, jobname, append=False)
Write the input structure file and return the file name.
 
setupFile(self, jobname)
Do setup for the File structure source.
 
setupProjectTable(self, parent, jobname, append=False)
Do setup for project table structure source.
 
setupWorkspace(self, parent, jobname, append=False)
Do setup for workspace structure source.
 
__repr__(self)
Formal string representation of the object.

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, state, fileselection='')
(Constructor)

 

Set the state (i.e., the input source -- file, PT, WS) and, if file input, the name of the source file.

Overrides: object.__init__

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.

setupFile(self, jobname)

 

Do setup for the File structure source. Return "" if no 'fileselection' has been specified for the JobInputParams object. Otherwise, copy the 'fileselection' file to <jobname>.<ext>, where <ext> is the extension of the 'fileselection' file. Raises an IOError if the file can't be copied.

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

 

Do setup for project table structure source. Write (append=False) or append (append=True) the selected Project Table entries to the file <jobname>.mae. 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)

 

Do setup for workspace structure source. Write (append=False) or append (append=True) the Workspace structure to the file <jobname>.mae. 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.

__repr__(self)
(Representation operator)

 

Formal string representation of the object.

Overrides: object.__repr__