Package schrodinger :: Package pipeline :: Module pipeio :: Class PhaseDB

Class PhaseDB

PipeIO --+
         |
        PhaseDB

A class to hold the absolute pathname of a Phase database.

Instance Methods

[hide private]

__init__(self, path=None, remote=False)

check(self)
Make sure all files in the list exist.

getPath(self)
Returns the path (abolute base name).

getData(self)

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

setData(self, path)
Replace the stored database path.

addData(self, path)
Set the DB path, but only if it hadn't already been set.

getFiles(self)
Return the list of files.

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

Inherited from PipeIO: getCount

Method Details

[hide private]

init(self, path=None, remote=False)
(Constructor)

Parameters:

path (str) - The path to the Phase database. (This must end with *.phdb.)
remote (bool) - A value to control whether the database should be checked for existence only on the remote host, since the localhost may not have access to that directory.

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

getPath(self)

Returns the path (abolute base name).

For the old format, does NOT include "_phasedb", for new format DOES include the ".phdb".

getData(self)

Deprecated: Use getFiles instead.

addData(self, path)

Set the DB path, but only if it hadn't already been set.

Raises:

RuntimeError - Raised if the DB path is already set.

getFiles(self)

Return the list of files.

Overrides: PipeIO.getFiles

isFilled(self)

Check whether the object is used or empty.

This method must be implemented in subclasses.

Overrides: PipeIO.isFilled: (inherited documentation)

Class PhaseDB

__init__(self, path=None, remote=False) (Constructor)

check(self)

getPath(self)

getData(self)

addData(self, path)

getFiles(self)

isFilled(self)

init(self, path=None, remote=False)
(Constructor)