annotate docs/modules/txt/FileIO.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 FileIO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use FileIO::FileIO;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use FileIO::FileIO qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 FIleIO class provides following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 new, Close, Open, SetMode
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 FleIO class serves as a base class for all classes involved in file IO.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 It is derived from ObjectProperty base class which provides methods not
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 explicitly defined in Atom or ObjectProperty class using Perl's AUTOLOAD
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 functionality. These methods are generated on-the-fly for a specified
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 $NewFileIO = new FileIO(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 Using specified *FileIO* property names and values hash, new method
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 creates a new object and returns a reference to a newly created
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 FileIO object. By default, the following properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Name = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 Mode = 'Read';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 Status = 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 FileHandle = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 Close
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 $FileIO->Close();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 Close open file and returns *FileIO*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 Open
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 $FileIO->Open();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 Opens the file using file *Name* and *Mode* and returns *FileIO*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 SetMode
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 $FileIO->SetMode($Mode);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Sets up file *Mode* and returns *FileIO* Default *Mode* value:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 *Read*. Supported *Mode* values:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 Read, Write, Append, <, >, >>, r, w, a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 SetName
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 $FileIO->SetName($Name);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 Sets up file *Name* and returns *FileIO*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64 MoleculeFileIO.pm, MDLMolFileIO.pm, SDFileIO.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75