annotate mayachemtool/mayachemtools/docs/modules/txt/FileIO.txt @ 0:68300206e90d draft default tip

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