annotate mayachemtools/docs/modules/html/code/MoleculeFileIO.html @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -0500
parents 73ae111cf86f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 <html>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 <head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 <title>MayaChemTools:Code:MoleculeFileIO.pm</title>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 <link rel="stylesheet" type="text/css" href="../../../css/MayaChemToolsCode.css">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 </head>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 <br/>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 <pre>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <a name="package-MoleculeFileIO-"></a> 1 <span class="k">package </span><span class="i">MoleculeFileIO</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 2 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 3 <span class="c"># $RCSfile: MoleculeFileIO.pm,v $</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 4 <span class="c"># $Date: 2015/02/28 20:47:18 $</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 5 <span class="c"># $Revision: 1.32 $</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 6 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 7 <span class="c"># Author: Manish Sud &lt;msud@san.rr.com&gt;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 8 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 9 <span class="c"># Copyright (C) 2015 Manish Sud. All rights reserved.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 10 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 11 <span class="c"># This file is part of MayaChemTools.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 12 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 13 <span class="c"># MayaChemTools is free software; you can redistribute it and/or modify it under</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 14 <span class="c"># the terms of the GNU Lesser General Public License as published by the Free</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 15 <span class="c"># Software Foundation; either version 3 of the License, or (at your option) any</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 16 <span class="c"># later version.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 17 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 18 <span class="c"># MayaChemTools is distributed in the hope that it will be useful, but without</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 19 <span class="c"># any warranty; without even the implied warranty of merchantability of fitness</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 20 <span class="c"># for a particular purpose. See the GNU Lesser General Public License for more</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 21 <span class="c"># details.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 22 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 23 <span class="c"># You should have received a copy of the GNU Lesser General Public License</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 24 <span class="c"># along with MayaChemTools; if not, see &lt;http://www.gnu.org/licenses/&gt; or</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 25 <span class="c"># write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 26 <span class="c"># Boston, MA, 02111-1307, USA.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 27 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 29 <span class="k">use</span> <span class="w">strict</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 30 <span class="k">use</span> <span class="w">Carp</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 31 <span class="k">use</span> <span class="w">Exporter</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 32 <span class="k">use</span> <span class="w">Scalar::Util</span> <span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 33 <span class="k">use</span> <span class="w">FileIO::SDFileIO</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 34 <span class="k">use</span> <span class="w">FileIO::MDLMolFileIO</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 36 <span class="k">use</span> <span class="w">vars</span> <span class="q">qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 37
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 38 <span class="i">@ISA</span> = <span class="q">qw(Exporter)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 39 <span class="i">@EXPORT</span> = <span class="q">qw()</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 40 <span class="i">@EXPORT_OK</span> = <span class="q">qw(IsSupportedMoleculeFileFormat)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 42 <span class="i">%EXPORT_TAGS</span> = <span class="s">(</span><span class="w">all</span> <span class="cm">=&gt;</span> <span class="s">[</span><span class="i">@EXPORT</span><span class="cm">,</span> <span class="i">@EXPORT_OK</span><span class="s">]</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 43
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 44 <span class="c"># Setup class variables...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 45 <span class="k">my</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 46 <span class="i">_InitializeClass</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 48 <span class="c"># Class constructor...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <a name="new-"></a> 49 <span class="k">sub </span><span class="m">new</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 50 <span class="k">my</span><span class="s">(</span><span class="i">$Class</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 51
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 52 <span class="c"># Initialize object...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 53 <span class="k">my</span> <span class="i">$This</span> = <span class="s">{</span><span class="s">}</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 54 <span class="k">bless</span> <span class="i">$This</span><span class="cm">,</span> <span class="k">ref</span><span class="s">(</span><span class="i">$Class</span><span class="s">)</span> || <span class="i">$Class</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 55 <span class="i">$This</span><span class="i">-&gt;_InitializeMoleculeFileIO</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 57 <span class="i">$This</span><span class="i">-&gt;_InitializeMoleculeFileIOProperties</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 59 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 60 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 62 <span class="c"># Initialize object data...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 63 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 <a name="_InitializeMoleculeFileIO-"></a> 64 <span class="k">sub </span><span class="m">_InitializeMoleculeFileIO</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 65 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 67 <span class="c"># Reference to specific FileIO object...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 68 <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>} = <span class="q">&#39;&#39;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 69
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 70 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 71 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 72
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 73 <span class="c"># Initialize class ...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <a name="_InitializeClass-"></a> 74 <span class="k">sub </span><span class="m">_InitializeClass</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 75 <span class="c">#Class name...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 76 <span class="i">$ClassName</span> = <span class="w">__PACKAGE__</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 77
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 78 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 79
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 80 <span class="c"># Initialize object properties......</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 81 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <a name="_InitializeMoleculeFileIOProperties-"></a> 82 <span class="k">sub </span><span class="m">_InitializeMoleculeFileIOProperties</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 83 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 84
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 85 <span class="k">if</span> <span class="s">(</span>!<span class="k">exists</span> <span class="i">$NamesAndValues</span>{<span class="w">Name</span>}<span class="s">)</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 86 <span class="w">croak</span> <span class="q">&quot;Error: ${ClassName}-&gt;New: Object can&#39;t be instantiated without specifying file name...&quot;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 87 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 88
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 89 <span class="k">if</span> <span class="s">(</span>!<span class="k">exists</span> <span class="i">$NamesAndValues</span>{<span class="w">Mode</span>}<span class="s">)</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 90 <span class="i">$NamesAndValues</span>{<span class="w">Mode</span>} = <span class="q">&#39;Read&#39;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 91 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 92
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 93 <span class="c"># Make sure its a supported format and intialize FileIO object reference...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 94 <span class="i">$This</span><span class="i">-&gt;_SetFileIORef</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 95
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 96 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 97 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 98
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 99 <span class="c"># Setup FileIO object reference...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 <a name="_SetFileIORef-"></a> 100 <span class="k">sub </span><span class="m">_SetFileIORef</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 101 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">%NamesAndValues</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 102 <span class="k">my</span><span class="s">(</span><span class="i">$Name</span><span class="cm">,</span> <span class="i">$Status</span><span class="cm">,</span> <span class="i">$Format</span><span class="cm">,</span> <span class="i">$IOPackageName</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 103
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 104 <span class="i">$Name</span> = <span class="i">$NamesAndValues</span>{<span class="w">Name</span>}<span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 105
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 106 <span class="s">(</span><span class="i">$Status</span><span class="cm">,</span> <span class="i">$Format</span><span class="cm">,</span> <span class="i">$IOPackageName</span><span class="s">)</span> = <span class="i">$This</span><span class="i">-&gt;IsSupportedMoleculeFileFormat</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 107 <span class="k">if</span> <span class="s">(</span>!<span class="i">$Status</span><span class="s">)</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 108 <span class="w">croak</span> <span class="q">&quot;Error: ${ClassName}-&gt;New: Object can&#39;t be instantiated: File format, $Name, is not supported: Currently supported file formats are: SDF, MDLMol...&quot;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 109 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 110
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 111 <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>} = <span class="i">$</span>{<span class="w">IOPackageName</span>}<span class="i">-&gt;new</span><span class="s">(</span><span class="i">%NamesAndValues</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 112
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 113 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 114 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 115
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 116 <span class="c"># Is it a supported file format?</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 117 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 118 <span class="c"># In scalar context only status is returned; otherwise, file format and file IO package name is also</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 119 <span class="c"># returned.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 120 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 121 <span class="c"># Note:</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 122 <span class="c"># . To support additional file formats, this is the only method which needs to be changed.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 123 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 124 <span class="c"># . Currently supported file formats are:</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 125 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 126 <span class="c"># SDF .sdf, .sd</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 127 <span class="c"># MDLMol .mol</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 128 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 <a name="IsSupportedMoleculeFileFormat-"></a> 129 <span class="k">sub </span><span class="m">IsSupportedMoleculeFileFormat</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 130 <span class="k">my</span><span class="s">(</span><span class="i">$FirstParameter</span><span class="cm">,</span> <span class="i">$SecondParameter</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 131 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 132
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 133 <span class="k">if</span> <span class="s">(</span><span class="s">(</span><span class="i">@_</span> == <span class="n">2</span><span class="s">)</span> &amp;&amp; <span class="s">(</span><span class="i">_IsMoleculeFileIO</span><span class="s">(</span><span class="i">$FirstParameter</span><span class="s">)</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 134 <span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="s">(</span><span class="i">$FirstParameter</span><span class="cm">,</span> <span class="i">$SecondParameter</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 135 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 136 <span class="k">else</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 137 <span class="s">(</span><span class="i">$Name</span><span class="s">)</span> = <span class="s">(</span><span class="i">$FirstParameter</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 138 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 139 <span class="k">my</span><span class="s">(</span><span class="i">$Status</span><span class="cm">,</span> <span class="i">$Format</span><span class="cm">,</span> <span class="i">$IOPackageName</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 140
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 141 <span class="i">$Status</span> = <span class="n">0</span><span class="sc">;</span> <span class="i">$Format</span> = <span class="q">&#39;NotSupported&#39;</span><span class="sc">;</span> <span class="i">$IOPackageName</span> = <span class="q">&#39;Unknown&#39;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 142
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 143 <span class="j">FORMAT:</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 144 <span class="k">if</span> <span class="s">(</span><span class="i">FileIO::SDFileIO::IsSDFile</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Status</span> = <span class="n">1</span><span class="sc">;</span> <span class="i">$Format</span> = <span class="q">&#39;SDF&#39;</span><span class="sc">;</span> <span class="i">$IOPackageName</span> = <span class="q">&#39;FileIO::SDFileIO&#39;</span><span class="sc">;</span> <span class="k">last</span> <span class="j">FORMAT</span><span class="sc">;</span> <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 145 <span class="k">if</span> <span class="s">(</span><span class="i">FileIO::MDLMolFileIO::IsMDLMolFile</span><span class="s">(</span><span class="i">$Name</span><span class="s">)</span><span class="s">)</span> <span class="s">{</span> <span class="i">$Status</span> = <span class="n">1</span><span class="sc">;</span> <span class="i">$Format</span> = <span class="q">&#39;MDLMol&#39;</span><span class="sc">;</span> <span class="i">$IOPackageName</span> = <span class="q">&#39;FileIO::MDLMolFileIO&#39;</span><span class="sc">;</span> <span class="k">last</span> <span class="j">FORMAT</span><span class="sc">;</span> <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 146 <span class="i">$Status</span> = <span class="n">0</span><span class="sc">;</span> <span class="i">$Format</span> = <span class="q">&#39;NotSupported&#39;</span><span class="sc">;</span> <span class="i">$IOPackageName</span> = <span class="q">&#39;Unknown&#39;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 147 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 148
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 149 <span class="k">return</span> <span class="k">wantarray</span> ? <span class="s">(</span><span class="i">$Status</span><span class="cm">,</span> <span class="i">$Format</span><span class="cm">,</span> <span class="i">$IOPackageName</span><span class="s">)</span> <span class="co">:</span> <span class="i">$Status</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 150 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 151
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 152 <span class="c"># Prohibit file ref change...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 153 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 <a name="SetFileIORef-"></a> 154 <span class="k">sub </span><span class="m">SetFileIORef</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 155 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Value</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 156
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170 157 <span class="w">carp</span> <span class="q">&quot;Warning: ${ClassName}-&gt;SetFileIORef: Explicit setting of file ref is not supported...&quot;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 158
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 159 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 160 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 161
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 162 <span class="c"># Prohibit file name change...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 163 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 <a name="SetName-"></a> 164 <span class="k">sub </span><span class="m">SetName</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 165 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Name</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 166
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 167 <span class="w">carp</span> <span class="q">&quot;Warning: ${ClassName}-&gt;SetName: Explicit setting of file name is not supported: It must be set during object instantiation...&quot;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 168
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 169 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 170 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 171
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 172 <span class="c"># Prohibit file mode change...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 173 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 <a name="SetMode-"></a> 174 <span class="k">sub </span><span class="m">SetMode</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 175 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Mode</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 176
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 177 <span class="w">carp</span> <span class="q">&quot;Warning: ${ClassName}-&gt;SetMode: Explicit setting of file mode is not supported: It must be set during object instantiation...&quot;</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 178
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 179 <span class="k">return</span> <span class="i">$This</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 180 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 181
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 182 <span class="c"># Open file in a specific mode; default mode is Read only.</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 183 <span class="c"># Supported mode values are: Read, Write, Append, &lt;, &gt;, &gt;&gt;, r, w, a</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 184 <span class="c">#</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 <a name="Open-"></a> 185 <span class="k">sub </span><span class="m">Open</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 186 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Mode</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200 187
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 188 <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>}<span class="i">-&gt;Open</span><span class="s">(</span><span class="i">$Mode</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 189 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 190
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 191 <span class="c"># close file...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 <a name="Close-"></a> 192 <span class="k">sub </span><span class="m">Close</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 193 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 194
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 195 <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>}<span class="i">-&gt;Close</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 196 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 197
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 198 <span class="c"># Read molecule string from file and return a molecule object...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 <a name="ReadMolecule-"></a> 199 <span class="k">sub </span><span class="m">ReadMolecule</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 200 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 201
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 202 <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>}<span class="i">-&gt;ReadMolecule</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216 203 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 204
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 205 <span class="c"># Retrieve molecule string from file...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 <a name="ReadMoleculeString-"></a> 206 <span class="k">sub </span><span class="m">ReadMoleculeString</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 207 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 208
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 209 <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>}<span class="i">-&gt;ReadMoleculeString</span><span class="s">(</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 210 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 211
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 212 <span class="c"># Write molecule using molecule object...</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 <a name="WriteMolecule-"></a> 213 <span class="k">sub </span><span class="m">WriteMolecule</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 214 <span class="k">my</span><span class="s">(</span><span class="i">$This</span><span class="cm">,</span> <span class="i">$Molecule</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 215
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229 216 <span class="k">return</span> <span class="i">$This</span>-&gt;{<span class="w">FileIORef</span>}<span class="i">-&gt;WriteMolecule</span><span class="s">(</span><span class="i">$Molecule</span><span class="s">)</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 217 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 218
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 219 <span class="c"># Is it a MoleculeFileIO object?</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233 <a name="_IsMoleculeFileIO-"></a> 220 <span class="k">sub </span><span class="m">_IsMoleculeFileIO</span> <span class="s">{</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 221 <span class="k">my</span><span class="s">(</span><span class="i">$Object</span><span class="s">)</span> = <span class="i">@_</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 222
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 223 <span class="k">return</span> <span class="s">(</span><span class="i">Scalar::Util::blessed</span><span class="s">(</span><span class="i">$Object</span><span class="s">)</span> &amp;&amp; <span class="i">$Object</span><span class="i">-&gt;isa</span><span class="s">(</span><span class="i">$ClassName</span><span class="s">)</span><span class="s">)</span> ? <span class="n">1</span> <span class="co">:</span> <span class="n">0</span><span class="sc">;</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 224 <span class="s">}</span>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 225
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 <a name="EOF-"></a></pre>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 <p>&nbsp;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 <img src="../../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 </html>