annotate mayachemtools/docs/modules/html/FileIO.html @ 3:e420415a1799 draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 12:16:47 -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:Documentation:FileIO::FileIO.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/MayaChemTools.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 <div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./DBUtil.html" title="DBUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./FingerprintsFPFileIO.html" title="FingerprintsFPFileIO.html">Next</a></td><td width="34%" align="middle"><strong>FileIO::FileIO.pm</strong></td><td width="33%" align="right"><a href="././code/FileIO.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/FileIO.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/FileIO.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/FileIO.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/FileIO.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 <h2>NAME</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 <p>FileIO</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 <h2>SYNOPSIS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 <p>use FileIO::FileIO;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use FileIO::FileIO qw(:all);</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 <h2>DESCRIPTION</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 <p><strong>FIleIO</strong> class provides following methods:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 <p> <a href="#new">new</a>, <a href="#close">Close</a>, <a href="#open">Open</a>, <a href="#setmode">SetMode</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 </p><p><strong>FleIO</strong> class serves as a base class for all classes involved in file IO. It is derived from
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 <strong>ObjectProperty</strong> base class which provides methods not explicitly defined in <strong>Atom</strong> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 <strong>ObjectProperty</strong> class using Perl's AUTOLOAD functionality. These methods
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 are generated on-the-fly for a specified object property:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 Set&lt;PropertyName&gt;(&lt;PropertyValue&gt;);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 <br/> $PropertyValue = Get&lt;PropertyName&gt;();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 <br/> Delete&lt;PropertyName&gt;();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 <h2>METHODS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 $NewFileIO = new FileIO(%NamesAndValues);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 <p>Using specified <em>FileIO</em> property names and values hash, <strong>new</strong> method creates a new object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 and returns a reference to a newly created <strong>FileIO</strong> object. By default, the following properties are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 initialized:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 Name = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 <br/> Mode = 'Read';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 <br/> Status = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 <br/> FileHandle = '';</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 <dt><strong><a name="close" class="item"><strong>Close</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 $FileIO-&gt;Close();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <p>Close open file and returns <em>FileIO</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <dt><strong><a name="open" class="item"><strong>Open</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 $FileIO-&gt;Open();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <p>Opens the file using file <em>Name</em> and <em>Mode</em> and returns <em>FileIO</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 <dt><strong><a name="setmode" class="item"><strong>SetMode</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 $FileIO-&gt;SetMode($Mode);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 <p>Sets up file <em>Mode</em> and returns <em>FileIO</em> Default <em>Mode</em> value: <em>Read</em>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 Supported <em>Mode</em> values:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 Read, Write, Append, &lt;, &gt;, &gt;&gt;, r, w, a</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 <dt><strong><a name="setname" class="item"><strong>SetName</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 $FileIO-&gt;SetName($Name);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <p>Sets up file <em>Name</em> and returns <em>FileIO</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <p><a href="./MoleculeFileIO.html">MoleculeFileIO.pm</a>,&nbsp<a href="./MDLMolFileIO.html">MDLMolFileIO.pm</a>,&nbsp<a href="./SDFileIO.html">SDFileIO.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 <tr align="left" valign="top"><td width="33%" align="left"><a href="./DBUtil.html" title="DBUtil.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./FingerprintsFPFileIO.html" title="FingerprintsFPFileIO.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>FileIO::FileIO.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 </html>