Package schrodinger :: Package pipeline :: Module pipeio :: Class Grid

Class Grid

PipeIO --+
         |
        Grid

A class to hold a set of grid files (compressed or uncompressed).

Instance Methods

__init__(self, gridfile=None)

check(self)
Check that the grid file exists.

getPath(self)
Return the grid file name.

__str__(self)
Return a string representation of the object.

setData(self, gridfile)
Replace the grid file name.

getFiles(self)
Return a list of grid file names, expanded from the representative file name, after checking for their existence.

isFilled(self)
Check whether the object is used or empty.

Inherited from PipeIO: getCount

Method Details

Parameters:

gridfile (str) - The name of the grid file (for example, <gridjobname>.grd or <gridjobname>.zip). The value can be changed later with setData.

Check that the grid file exists.

Raises:

Replace the grid file name.

Parameters:

Return a list of grid file names, expanded from the representative file name, after checking for their existence.

For compressed grids, the .zip file is the only item returned, but for uncompressed grids, all the standard grid component file names are returned.

Check whether the object is used or empty.

This method must be implemented in subclasses.