0
|
1 NAME
|
|
2 MDLMolFileIO
|
|
3
|
|
4 SYNOPSIS
|
|
5 use FileIO::MDLMolFileIO;
|
|
6
|
|
7 use FileIO::MDLMolFileIO qw(:all);
|
|
8
|
|
9 DESCRIPTION
|
|
10 MDLMolFIleIO class provides the following methods:
|
|
11
|
|
12 new, GenerateMoleculeString, IsMDLMolFile, ParseMoleculeString,
|
|
13 ReadMolecule, ReadMoleculeString, WriteMolecule
|
|
14
|
|
15 The following methods can also be used as functions:
|
|
16
|
|
17 GenerateMoleculeString, IsMDLMolFile, ParseMoleculeString
|
|
18
|
|
19 Data specific to MDLMolFileIO class not directly used by Molecule, Atom
|
|
20 and Bond objects - data label/value pairs, atom SteroParity and so on -
|
|
21 is associated to and retrieved from appropriate objects using following
|
|
22 methods:
|
|
23
|
|
24 SetMDL<PropertyName>
|
|
25 GetMDL<PropertyName>.
|
|
26
|
|
27 MDLMolFileIO class is derived from *FileIO* class and uses its methods
|
|
28 to support generic file related functionality.
|
|
29
|
|
30 METHODS
|
|
31 new
|
|
32 $NewMDLMolFileIO = new FileIO::MDLMolFileIO(%NamesAndValues);
|
|
33
|
|
34 Using specified *MDLMolFileIO* property names and values hash, new
|
|
35 method creates a new object and returns a reference to newly created
|
|
36 MDLMolFileIO object.
|
|
37
|
|
38 GenerateMoleculeString
|
|
39 $MoleculeString = $MDLMolFileIO->GenerateMoleculeString($Molecule);
|
|
40 $MoleculeString = FileIO::MDLMolFileIO::GenerateMoleculeString($Molecule);
|
|
41
|
|
42 Returns a MoleculeString in MDLMol format corresponding to
|
|
43 *Molecule*.
|
|
44
|
|
45 IsMDLMolFile
|
|
46 $Status = $MDLMolFileIO->IsMDLMolFile($FileName);
|
|
47 $Status = FileIO::MDLMolFileIO::IsMDLMolFile($FileName);
|
|
48
|
|
49 Returns 1 or 0 based on whether *FileName* is a MDLMol file.
|
|
50
|
|
51 ParseMoleculeString
|
|
52 $Molecule = $MDLMolFileIO->ParseMoleculeString($MoleculeString);
|
|
53 $Molecule = FileIO::MDLMolFileIO::ParseMoleculeString($MoleculeString);
|
|
54
|
|
55 Parses *MoleculeString* and returns a Molecule object.
|
|
56
|
|
57 ReadMolecule
|
|
58 $Molecule = $MDLMolFileIO->ReadMolecule($FileHandle);
|
|
59
|
|
60 Reads data for the compound in a file using already opened
|
|
61 *FileHandle*, creates, and returns a Molecule object.
|
|
62
|
|
63 ReadMoleculeString
|
|
64 $MoleculeString = $MDLMolFileIO->ReadMoleculeString($FileHandle);
|
|
65
|
|
66 Reads data for the compound in a file using already opened
|
|
67 *FileHandle* and returns a MoleculeString corresponding to compound
|
|
68 structure and other associated data.
|
|
69
|
|
70 WriteMolecule
|
|
71 $MDLMolFileIO->WriteMolecule($Molecule);
|
|
72
|
|
73 Writes *Molecule* data to a file in MDLMol format and returns
|
|
74 MDLMolFileIO.
|
|
75
|
|
76 AUTHOR
|
|
77 Manish Sud <msud@san.rr.com>
|
|
78
|
|
79 SEE ALSO
|
|
80 MoleculeFileIO.pm, SDFileIO.pm
|
|
81
|
|
82 COPYRIGHT
|
|
83 Copyright (C) 2015 Manish Sud. All rights reserved.
|
|
84
|
|
85 This file is part of MayaChemTools.
|
|
86
|
|
87 MayaChemTools is free software; you can redistribute it and/or modify it
|
|
88 under the terms of the GNU Lesser General Public License as published by
|
|
89 the Free Software Foundation; either version 3 of the License, or (at
|
|
90 your option) any later version.
|
|
91
|