annotate mayachemtools/lib/FileIO/FileIO.pm @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
1 package FileIO::FileIO;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: FileIO.pm,v $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:48:43 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.27 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 use Exporter;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 use FileHandle;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 use ObjectProperty;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37 @ISA = qw(ObjectProperty Exporter);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 @EXPORT = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 @EXPORT_OK = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 # Setup class variables...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 my($ClassName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 _InitializeClass();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 # Class constructor...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 sub new {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 my($Class, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 # Initialize object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 my $This = {};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 bless $This, ref($Class) || $Class;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 $This->_InitializeFileIO();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 $This->_InitializeFileIOProperties(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 # Initialize object data...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 sub _InitializeFileIO {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 # File name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 $This->{Name} = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 # Read, write or append...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 $This->{Mode} = 'Read';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 # Open/close status...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 $This->{Status} = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 # File handle returned by file open...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 $This->{FileHandle} = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 # Initialize class ...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 sub _InitializeClass {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 #Class name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 $ClassName = __PACKAGE__;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 # Initialize object properties....
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 sub _InitializeFileIOProperties {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 my($This, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 my($Name, $Value, $MethodName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 while (($Name, $Value) = each %NamesAndValues) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 $MethodName = "Set${Name}";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 $This->$MethodName($Value);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 # Close any open file...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 sub DESTROY {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 $This->Close();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 # Set file name and make sure it's not already set...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 sub SetName {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 my($This, $Name) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 if ($This->{Name}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 croak "Error: ${ClassName}->SetName: Can't set file name to $Name: $This->{Name}...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 $This->{Name} = $Name;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 # Open file using specified mode...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 sub Open {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 my($This, $Mode) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 if ($This->{Status}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 croak "Error: ${ClassName}->Open: Can't open file $This->{Name}: It's already open...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 if (defined $Mode) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 # Set mode...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 $This->SetMode($Mode);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 # Get name and mode...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 my($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 $Name = $This->{Name};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 $Mode = $This->_GetOpenMode();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 # Open the file using specified mode and store FileHandle...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 my($FileHandle);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 $FileHandle = new FileHandle("${Mode}${Name}");
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 if (!defined $FileHandle) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 croak "Error: ${ClassName}->Open: Can't open $Name: $! ...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 $This->{FileHandle} = $FileHandle;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 $This->{Status} = 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 # Close an open file...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 sub Close {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 if ($This->{Status}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 $This->{FileHandle}->close();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160 $This->{Status} = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 # Supported Mode values are: Read, Write, Append, <, >, >>, r, w, a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 sub SetMode {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168 my($This, $SpecifiedMode) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 my($Mode);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 if (!defined $SpecifiedMode) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 $SpecifiedMode = 'Read';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 MODE: {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 if ($SpecifiedMode =~ /^(Read|<|r)$/i) { $Mode = 'Read'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 if ($SpecifiedMode =~ /^(Write|>|w)$/i) { $Mode = 'Write'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178 if ($SpecifiedMode =~ /^(Append|>>|a)$/i) { $Mode = 'Append'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 croak "Error: ${ClassName}->SetMode: Specified mode value, $SpecifiedMode, is not valid: Supported values: Read, Write, Append, <, >, >>, r, w, a...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 $This->{Mode} = $Mode;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 # Get mode values to be used for file open function: <, >, >>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188 sub _GetOpenMode {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190 my($Mode);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 MODE: {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193 if ($This->{Mode} =~ /^(Read|<|r)$/i) { $Mode = '<'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 if ($This->{Mode} =~ /^(Write|>|w)$/i) { $Mode = '>'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 if ($This->{Mode} =~ /^(Append|>>|a)$/i) { $Mode = '>>'; last MODE; }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 $Mode = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198 return $Mode;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203 __END__
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 =head1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 FileIO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 =head1 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 use FileIO::FileIO;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213 use FileIO::FileIO qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 =head1 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 B<FIleIO> class provides following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 new, Close, Open, SetMode
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221 B<FleIO> class serves as a base class for all classes involved in file IO. It is derived from
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 B<ObjectProperty> base class which provides methods not explicitly defined in B<Atom> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 B<ObjectProperty> class using Perl's AUTOLOAD functionality. These methods
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 are generated on-the-fly for a specified object property:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 Set<PropertyName>(<PropertyValue>);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227 $PropertyValue = Get<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 Delete<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 =head2 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 =over 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 =item B<new>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 $NewFileIO = new FileIO(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 Using specified I<FileIO> property names and values hash, B<new> method creates a new object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239 and returns a reference to a newly created B<FileIO> object. By default, the following properties are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 initialized:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 Name = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243 Mode = 'Read';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 Status = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245 FileHandle = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 =item B<Close>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 $FileIO->Close();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 Close open file and returns I<FileIO>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 =item B<Open>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255 $FileIO->Open();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 Opens the file using file I<Name> and I<Mode> and returns I<FileIO>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 =item B<SetMode>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 $FileIO->SetMode($Mode);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 Sets up file I<Mode> and returns I<FileIO> Default I<Mode> value: I<Read>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264 Supported I<Mode> values:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 Read, Write, Append, <, >, >>, r, w, a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 =item B<SetName>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 $FileIO->SetName($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 Sets up file I<Name> and returns I<FileIO>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 =back
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 =head1 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 =head1 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 MoleculeFileIO.pm, MDLMolFileIO.pm, SDFileIO.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 =head1 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293 any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295 =cut