Package schrodinger :: Package pipeline :: Module pipeio :: Class Text
[hide private]
[frames] | no frames]

Class Text

PipeIO --+
         |
        Text

A class to hold the names of one or more text (or log) files.

Instance Methods [hide private]
 
__init__(self, files=[])
 
check(self)
Make sure all files in the list exist.
 
__str__(self)
Return a string representation of the object.
 
setData(self, textfiles)
Replace the list of file names with textfiles.
 
addData(self, filename)
Add a single text file name to the stored list of files.
 
getFiles(self)
Return the list of text file names after checking that all of them exist.
 
getData(self)
 
isFilled(self)
Check whether the object is used or empty.

Inherited from PipeIO: getCount

Method Details [hide private]

__init__(self, files=[])
(Constructor)

 
Parameters:
  • files (list) - A list of text or log file names. The file paths can be later replaced with setData().

check(self)

 

Make sure all files in the list exist.

Raises:
  • RuntimeError - Raised if "." is in the list or if any file can't be found.
Overrides: PipeIO.check

setData(self, textfiles)

 

Replace the list of file names with textfiles.

Raises:
  • RuntimeError - Raised if "." is in the list.

getFiles(self)

 

Return the list of text file names after checking that all of them exist.

Overrides: PipeIO.getFiles

getData(self)

 

Deprecated: Use getFiles instead.

isFilled(self)

 

Check whether the object is used or empty.

This method must be implemented in subclasses.

Overrides: PipeIO.isFilled
(inherited documentation)