Mercurial > repos > deepakjadmin > mayatool3_test1

comparison docs/modules/html/FileIO.html @ 1:2abf0d43254d draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:10:43 -0500
parents
children
comparison
equal deleted inserted replaced
0:1791cb0984a7 1:2abf0d43254d
1 <html>
2 <head>
3 <title>MayaChemTools:Documentation:FileIO::FileIO.pm</title>
4 <meta http-equiv="content-type" content="text/html;charset=utf-8">
5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css">
6 </head>
7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10">
8 <br/>
9 <center>
10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a>
11 </center>
12 <br/>
13 <div class="DocNav">
14 <table width="100%" border=0 cellpadding=0 cellspacing=2>
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>
16 </table>
17 </div>
18 <p>
19 </p>
20 <h2>NAME</h2>
21 <p>FileIO</p>
22 <p>
23 </p>
24 <h2>SYNOPSIS</h2>
25 <p>use FileIO::FileIO;</p>
26 <p>use FileIO::FileIO qw(:all);</p>
27 <p>
28 </p>
29 <h2>DESCRIPTION</h2>
30 <p><strong>FIleIO</strong> class provides following methods:</p>
31 <p> <a href="#new">new</a>, <a href="#close">Close</a>, <a href="#open">Open</a>, <a href="#setmode">SetMode</a>
32 </p><p><strong>FleIO</strong> class serves as a base class for all classes involved in file IO. It is derived from
33 <strong>ObjectProperty</strong> base class which provides methods not explicitly defined in <strong>Atom</strong> or
34 <strong>ObjectProperty</strong> class using Perl's AUTOLOAD functionality. These methods
35 are generated on-the-fly for a specified object property:</p>
36 <div class="OptionsBox">
37 Set&lt;PropertyName&gt;(&lt;PropertyValue&gt;);
38 <br/> $PropertyValue = Get&lt;PropertyName&gt;();
39 <br/> Delete&lt;PropertyName&gt;();</div>
40 <p>
41 </p>
42 <h2>METHODS</h2>
43 <dl>
44 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
45 <dd>
46 <div class="OptionsBox">
47 $NewFileIO = new FileIO(%NamesAndValues);</div>
48 <p>Using specified <em>FileIO</em> property names and values hash, <strong>new</strong> method creates a new object
49 and returns a reference to a newly created <strong>FileIO</strong> object. By default, the following properties are
50 initialized:</p>
51 <div class="OptionsBox">
52 Name = '';
53 <br/> Mode = 'Read';
54 <br/> Status = 0;
55 <br/> FileHandle = '';</div>
56 </dd>
57 <dt><strong><a name="close" class="item"><strong>Close</strong></a></strong></dt>
58 <dd>
59 <div class="OptionsBox">
60 $FileIO-&gt;Close();</div>
61 <p>Close open file and returns <em>FileIO</em>.</p>
62 </dd>
63 <dt><strong><a name="open" class="item"><strong>Open</strong></a></strong></dt>
64 <dd>
65 <div class="OptionsBox">
66 $FileIO-&gt;Open();</div>
67 <p>Opens the file using file <em>Name</em> and <em>Mode</em> and returns <em>FileIO</em>.</p>
68 </dd>
69 <dt><strong><a name="setmode" class="item"><strong>SetMode</strong></a></strong></dt>
70 <dd>
71 <div class="OptionsBox">
72 $FileIO-&gt;SetMode($Mode);</div>
73 <p>Sets up file <em>Mode</em> and returns <em>FileIO</em> Default <em>Mode</em> value: <em>Read</em>.
74 Supported <em>Mode</em> values:</p>
75 <div class="OptionsBox">
76 Read, Write, Append, &lt;, &gt;, &gt;&gt;, r, w, a</div>
77 </dd>
78 <dt><strong><a name="setname" class="item"><strong>SetName</strong></a></strong></dt>
79 <dd>
80 <div class="OptionsBox">
81 $FileIO-&gt;SetName($Name);</div>
82 <p>Sets up file <em>Name</em> and returns <em>FileIO</em>.</p>
83 </dd>
84 </dl>
85 <p>
86 </p>
87 <h2>AUTHOR</h2>
88 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
89 <p>
90 </p>
91 <h2>SEE ALSO</h2>
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>
93 </p>
94 <p>
95 </p>
96 <h2>COPYRIGHT</h2>
97 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
98 <p>This file is part of MayaChemTools.</p>
99 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
100 the terms of the GNU Lesser General Public License as published by the Free
101 Software Foundation; either version 3 of the License, or (at your option)
102 any later version.</p>
103 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
104 <table width="100%" border=0 cellpadding=0 cellspacing=2>
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>
106 </table>
107 </div>
108 <br />
109 <center>
110 <img src="../../images/h2o2.png">
111 </center>
112 </body>
113 </html>