Class GamessReader
java.lang.Object
org.openscience.cdk.io.ChemObjectIO
org.openscience.cdk.io.DefaultChemObjectReader
org.openscience.cdk.io.GamessReader
- All Implemented Interfaces:
Closeable, AutoCloseable, IChemObjectIO, IChemObjectReader, ISimpleChemObjectReader
A reader for GAMESS log file.
Expected behaviour:
The "GamessReader" object is able to read GAMESS output log file format.
Limitations:
This reader was developed from a small set of
example log files, and therefore, is not guaranteed to properly read all
GAMESS output. If you have problems, please contact the author of this code,
not the developers of GAMESS.
Implementation
Available feature(s):
- Molecular coordinates: Each set of coordinates is added to the ChemFile in the order they are found.
- Energies: They are associated with the previously read set of coordinates.
- Normal coordinates of vibrations: They are associated with the previously read set of coordinates.
References:
GAMESS is a
quantum chemistry program by Gordon research group atIowa State University.
- Author:
- Bradley A. Smith
- Keywords:
- Gamess, file format, output, log file
-
Nested Class Summary
Nested classes/interfaces inherited from interface IChemObjectReader
IChemObjectReader.Mode -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanBoolean constant used to specify that the coordinates are given in Ångstrom units.static final doubleDouble constant that contains the conversion factor from Bohr unit to Ångstrom unit.static final booleanBoolean constant used to specify that the coordinates are given in Bohr units.static final StringFields inherited from class DefaultChemObjectReader
errorHandler, modeModifier and TypeFieldDescriptionprotected IChemObjectReaderErrorHandlerprotected IChemObjectReader.Mode -
Constructor Summary
ConstructorsConstructorDescriptionGamessReader(InputStream input) GamessReader(Reader inputReader) Constructs a new "GamessReader" object given a "Reader" object as input. -
Method Summary
Modifier and TypeMethodDescriptionbooleanaccepts(Class<? extends IChemObject> classObject) Returns whether the givenIChemObjectcan be read or written.voidclose()Closes this IChemObjectIO's resources.Returns theIResourceFormatclass for this IO class.<T extends IChemObject>
Tread(T object) Reads an IChemObject of type "object" from input.voidsetReader(InputStream input) Sets the InputStream from which this ChemObjectReader should read the contents.voidSets the Reader from which this ChemObjectReader should read the contents.Methods inherited from class DefaultChemObjectReader
fireFrameRead, handleError, handleError, handleError, handleError, setErrorHandler, setReaderModeModifier and TypeMethodDescriptionprotected voidSends a frame read event to the registered ReaderListeners.voidhandleError(String message) Redirects an error message to theIChemObjectReaderErrorHandler.voidhandleError(String message, int row, int colStart, int colEnd) Redirects an error message to theIChemObjectReaderErrorHandler.voidhandleError(String message, int row, int colStart, int colEnd, Exception exception) Redirects an error message to theIChemObjectReaderErrorHandler.voidhandleError(String message, Exception exception) Redirects an error message to theIChemObjectReaderErrorHandler.voidSets an error handler that is sent events when file format issues occur.voidSets the reader mode.Methods inherited from class ChemObjectIO
addChemObjectIOListener, addSetting, addSettings, fireIOSettingQuestion, getIOSettings, getListeners, getSetting, getSetting, getSettings, hasSetting, removeChemObjectIOListenerModifier and TypeMethodDescriptionvoidaddChemObjectIOListener(IChemObjectIOListener listener) Adds aIChemObjectIOListenerto this IChemObjectIO.<S extends IOSetting>
SaddSetting(IOSetting setting) Add an IOSetting to the reader/writer.voidaddSettings(Collection<IOSetting> settings) Adds a collection ofIOSettings to the reader/writer.protected voidfireIOSettingQuestion(IOSetting setting) FiresIChemObjectIOListener.processIOSettingQuestion(org.openscience.cdk.io.setting.IOSetting)for all managed listeners.Returns an array ofIOSettings defined by this IChemObjectIO class.Access all the listeners for this ChemObject Reader or Writer.<S extends IOSetting>
SgetSetting(String name) Access a named setting managed by this reader/writer.<S extends IOSetting>
SgetSetting(String name, Class<S> c) Access a named setting managed by this reader/writer.Access a collection ofIOSettings for this reader/writer.booleanhasSetting(String name) Determine whether this reader/writer has a setting of the provided name.voidRemoves aIChemObjectIOListenerfrom this IChemObjectIO.
-
Field Details
-
BOHR_UNIT
public static final boolean BOHR_UNITBoolean constant used to specify that the coordinates are given in Bohr units.- See Also:
-
BOHR_TO_ANGSTROM
public static final double BOHR_TO_ANGSTROMDouble constant that contains the conversion factor from Bohr unit to Ångstrom unit.- See Also:
-
ANGSTROM_UNIT
public static final boolean ANGSTROM_UNITBoolean constant used to specify that the coordinates are given in Ångstrom units.- See Also:
-
UNEXPECTED_END_OF_INPUT
- See Also:
-
-
Constructor Details
-
GamessReader
Constructs a new "GamessReader" object given a "Reader" object as input.The "Reader" object may be an instantiable object from the "Reader" hierarchy.
For more detail about the "Reader" objects that are really accepted by this "GamessReader" seeaccepts(IChemObject)method documentation.- Parameters:
inputReader- The "Reader" object given as input parameter.- See Also:
-
GamessReader
-
GamessReader
public GamessReader()
-
-
Method Details
-
getFormat
Description copied from interface:IChemObjectIOReturns theIResourceFormatclass for this IO class. -
setReader
Description copied from interface:IChemObjectReaderSets the Reader from which this ChemObjectReader should read the contents.- Throws:
CDKException
-
setReader
Description copied from interface:IChemObjectReaderSets the InputStream from which this ChemObjectReader should read the contents.- Throws:
CDKException
-
accepts
Description copied from interface:IChemObjectIOReturns whether the givenIChemObjectcan be read or written.- Parameters:
classObject-IChemObjectof which is tested if it can be handled.- Returns:
- true, if the
IChemObjectcan be handled.
-
read
Description copied from interface:ISimpleChemObjectReaderReads an IChemObject of type "object" from input. The constructor of the actual implementation may take a Reader as input to get a very flexible reader that can read from string, files, etc.- Parameters:
object- the type of object to return- Returns:
- returns an object of that contains the content (or part) of the input content
- Throws:
CDKException- it is thrown if the type of information is not available from the input
-
close
Description copied from interface:IChemObjectIOCloses this IChemObjectIO's resources.- Throws:
IOException- when the wrapper IO class cannot be closed.
-