annotate mayachemtools/docs/modules/txt/SDFileIO.txt @ 9:ab29fa5c8c1f draft default tip

Uploaded
author deepakjadmin
date Thu, 15 Dec 2016 14:18:03 -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 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 SDFileIO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 use FileIO::SDFileIO;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 use FileIO::SDFileIO qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 SDFIleIO class provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateMoleculeString, IsSDFile, ParseMoleculeString,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 ReadMolecule, ReadMoleculeString, WriteMolecule
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 The following methods can also be used as functions:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 GenerateMoleculeString, IsSDFile, ParseMoleculeString
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 Data specific to SDFileIO class not directly used by Molecule, Atom and
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 Bond objects - data label/value pairs, atom SteroParity and so on - is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 associated to and retrieved from approptiate objects using following
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 SetMDL<PropertyName>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 GetMDL<PropertyName>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 SD data label and values are attached to Molecule object as a refernece
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28 to a hash using SetDataFieldLabelAndValues and can be retrieved using
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 GetDataFieldLabelAndValues method.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 SDFileIO class is derived from *FileIO* class and uses its methods to
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 support generic file related functionality.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35 new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 $NewSDFileIO = new FileIO::SDFileIO(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 Using specified *SDFileIO* property names and values hash, new
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 method creates a new object and returns a reference to newly created
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 SDFileIO object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 GenerateMoleculeString
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 $MoleculeString = $SDFileIO->GenerateMoleculeString($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 $MoleculeString = FileIO::SDFileIO::GenerateMoleculeString($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 Returns a MoleculeString in SD format corresponding to *Molecule*.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 IsSDFile
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 $Status = $SDFileIO->IsSDFile($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 $Status = FileIO::SDFileIO::IsSDFile($FileName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 Returns 1 or 0 based on whether *FileName* is a SD file.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 ParseMoleculeString
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 $Molecule = $SDFileIO->ParseMoleculeString($MoleculeString);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 $Molecule = FileIO::SDFileIO::ParseMoleculeString($MoleculeString);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 Parses *MoleculeString* and returns a Molecule object. SD data field
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 label and value pairs are associated to Molecule object as a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 reference to a hash using:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 $Molecule->SetDataFieldLabelAndValues(\%DataLabelsAndValues)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 The reference to hash can be retrieved by:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 $DataLabelsAndValues = $Molecule->GetDataFieldLabelAndValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 for $DataLabel (sort keys %{$DataLabelsAndValues}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 $DataValue = $DataLabelsAndValues->{$DataLabel};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 ReadMolecule
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 $Molecule = $SDFileIO->ReadMolecule($FileHandle);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 Reads data for the next compound in a file using already opened
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 *FileHandle*, creates, and returns a Molecule object.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 ReadMoleculeString
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 $MoleculeString = $SDFileIO->ReadMoleculeString($FileHandle);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 Reads data for the next compound in a file using already opened
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 *FileHandle* and returns a MoleculeString corresponding to compound
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 structure and other associated data.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 WriteMolecule
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 $SDFileIO->WriteMolecule($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 Writes *Molecule* data to a file in MDLMol format and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 SDFileIO.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 MoleculeFileIO.pm, MDLMolFileIO.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 MayaChemTools is free software; you can redistribute it and/or modify it
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 under the terms of the GNU Lesser General Public License as published by
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 the Free Software Foundation; either version 3 of the License, or (at
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 your option) any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105