annotate docs/modules/txt/MDLMolFileIO.txt @ 0:4816e4a8ae95 draft default tip

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