1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>format.h Source File</title>
<link href="/site.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="search/search.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!--#include file="header.html" -->
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.shtml"><span>Main Page</span></a></li>
<li><a href="pages.shtml"><span>Related Pages</span></a></li>
<li><a href="modules.shtml"><span>Modules</span></a></li>
<li><a href="namespaces.shtml"><span>Namespaces</span></a></li>
<li><a href="annotated.shtml"><span>Classes</span></a></li>
<li class="current"><a href="files.shtml"><span>Files</span></a></li>
<li><a href="examples.shtml"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.shtml"><span>File List</span></a></li>
<li><a href="globals.shtml"><span>File Members</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<div class="title">format.h</div> </div>
</div>
<div class="contents">
<a href="format_8h.shtml">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/**********************************************************************</span>
<a name="l00002"></a>00002 <span class="comment">obconversion.cpp - Declarations for OBFormat</span>
<a name="l00003"></a>00003 <span class="comment"></span>
<a name="l00004"></a>00004 <span class="comment">Copyright (C) 2004-2007 by Chris Morley</span>
<a name="l00005"></a>00005 <span class="comment">Some portions Copyright (C) 2005-2007 by Geoffrey Hutchison</span>
<a name="l00006"></a>00006 <span class="comment"></span>
<a name="l00007"></a>00007 <span class="comment">This file is part of the Open Babel project.</span>
<a name="l00008"></a>00008 <span class="comment">For more information, see <http://openbabel.org/></span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment">This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment">it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment">the Free Software Foundation version 2 of the License.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment">This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment">but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment">MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00017"></a>00017 <span class="comment">GNU General Public License for more details.</span>
<a name="l00018"></a>00018 <span class="comment">***********************************************************************/</span>
<a name="l00019"></a>00019 <span class="preprocessor">#ifndef OB_FORMAT_H</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define OB_FORMAT_H</span>
<a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#include <openbabel/babelconfig.h></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <<a class="code" href="plugin_8h.shtml" title="Simplify 'plugin' classes to be discovered and/or loaded at runtime.">openbabel/plugin.h</a>></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <typeinfo></span>
<a name="l00024"></a>00024
<a name="l00025"></a>00025 <span class="keyword">namespace </span>OpenBabel
<a name="l00026"></a>00026 {
<a name="l00027"></a>00027 <span class="keyword">class </span>OBBase;
<a name="l00028"></a>00028 <span class="keyword">class </span>OBConversion;
<a name="l00029"></a>00029
<a name="l00031"></a><a class="code" href="format_8h.shtml#a5d766d529e097f852406cf0c434e54e0">00031</a> <span class="preprocessor">#define NOTREADABLE 0x01</span>
<a name="l00032"></a><a class="code" href="format_8h.shtml#aec13538a29f6a7d630b3a59ccce0e03c">00032</a> <span class="preprocessor"></span><span class="preprocessor">#define READONEONLY 0x02</span>
<a name="l00033"></a><a class="code" href="format_8h.shtml#a95479d1fb64936c936077e47356bf6e2">00033</a> <span class="preprocessor"></span><span class="preprocessor">#define READBINARY 0x04</span>
<a name="l00034"></a><a class="code" href="format_8h.shtml#a0e12fffdb9815dc9bb44cb0635667146">00034</a> <span class="preprocessor"></span><span class="preprocessor">#define ZEROATOMSOK 0x08</span>
<a name="l00035"></a><a class="code" href="format_8h.shtml#a201c57b6b8e95558ead652e391d2e157">00035</a> <span class="preprocessor"></span><span class="preprocessor">#define NOTWRITABLE 0x10</span>
<a name="l00036"></a><a class="code" href="format_8h.shtml#ab95246c97f4ade91aee102631b6b8666">00036</a> <span class="preprocessor"></span><span class="preprocessor">#define WRITEONEONLY 0x20</span>
<a name="l00037"></a><a class="code" href="format_8h.shtml#a655ed7589181707a2c6d18d7777cb1c6">00037</a> <span class="preprocessor"></span><span class="preprocessor">#define WRITEBINARY 0x40</span>
<a name="l00038"></a><a class="code" href="format_8h.shtml#ac3cad6ca6aadd6aa9eccfc793e01b30e">00038</a> <span class="preprocessor"></span><span class="preprocessor">#define READXML 0x80</span>
<a name="l00039"></a><a class="code" href="format_8h.shtml#a114620de287b71102355c29edc4b0115">00039</a> <span class="preprocessor"></span><span class="preprocessor">#define DEFAULTFORMAT 0x4000</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00042"></a>00042 <span class="comment">// class introduction in obconversion.cpp</span>
<a name="l00043"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml">00043</a> <span class="keyword">class </span>OBCONV <a class="code" href="classOpenBabel_1_1OBFormat.shtml" title="Base class for file formats.">OBFormat</a> : <span class="keyword">public</span> <a class="code" href="classOpenBabel_1_1OBPlugin.shtml" title="Base class for all types of dynamic classes discovered at runtime.">OBPlugin</a>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="comment">//Macro to include functions to handle plugin operations</span>
<a name="l00046"></a>00046 <a class="code" href="group__plugins.shtml#gadd740e2a386b7db3e1f0e271cbe8a3f1">MAKE_PLUGIN</a>(<a class="code" href="classOpenBabel_1_1OBFormat.shtml" title="Base class for file formats.">OBFormat</a>);
<a name="l00047"></a>00047
<a name="l00048"></a>00048 <span class="keyword">public</span>:
<a name="l00049"></a>00049
<a name="l00051"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a11590b0840c8360ab4c3b62476d49863">00051</a> <a class="code" href="classOpenBabel_1_1OBFormat.shtml#a11590b0840c8360ab4c3b62476d49863" title="Default constructor. Registration via RegisterFormat(), not via constructor as in other plugins...">OBFormat</a>(){}
<a name="l00052"></a>00052
<a name="l00053"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a45db88b29eb37e9dd105bf4032e421d2">00053</a> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOpenBabel_1_1OBFormat.shtml#a45db88b29eb37e9dd105bf4032e421d2" title="Redefined by each plugin type: "formats", "fingerprints", etc.">TypeID</a>(){ <span class="keywordflow">return</span> <span class="stringliteral">"formats"</span>; }
<a name="l00054"></a>00054
<a name="l00056"></a>00056
<a name="l00060"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a1e309febfaef70cc3c8d98afc1540931">00060</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadMolecule(<a class="code" href="classOpenBabel_1_1OBBase.shtml" title="Base Class.">OBBase</a>* <span class="comment">/*pOb*/</span>, <a class="code" href="classOpenBabel_1_1OBConversion.shtml" title="Class to convert from one format to another.">OBConversion</a>* <span class="comment">/*pConv*/</span>)
<a name="l00061"></a>00061 { std::cerr << <span class="stringliteral">"HIER"</span> << std::endl;
<a name="l00062"></a>00062 std::cerr << <span class="stringliteral">"Not a valid input format"</span>; <span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00063"></a>00063
<a name="l00065"></a>00065
<a name="l00069"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a6044ced825a2a83b7cfe7c45eea63c99">00069</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> ReadChemObject(<a class="code" href="classOpenBabel_1_1OBConversion.shtml" title="Class to convert from one format to another.">OBConversion</a>* <span class="comment">/*pConv*/</span>)
<a name="l00070"></a>00070 { std::cerr << <span class="stringliteral">"Not a valid input format"</span>; <span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00071"></a>00071
<a name="l00073"></a>00073
<a name="l00078"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a663171ec9788e2d1621d374848b3888b">00078</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> WriteMolecule(<a class="code" href="classOpenBabel_1_1OBBase.shtml" title="Base Class.">OBBase</a>* <span class="comment">/*pOb*/</span>, <a class="code" href="classOpenBabel_1_1OBConversion.shtml" title="Class to convert from one format to another.">OBConversion</a>* <span class="comment">/*pConv*/</span>)
<a name="l00079"></a>00079 { std::cerr << <span class="stringliteral">"Not a valid output format"</span>; <span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00080"></a>00080
<a name="l00082"></a>00082
<a name="l00086"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a5ea5d9623cd9594549a52e116caecaa2">00086</a> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> WriteChemObject(<a class="code" href="classOpenBabel_1_1OBConversion.shtml" title="Class to convert from one format to another.">OBConversion</a>* <span class="comment">/*pConv*/</span>)
<a name="l00087"></a>00087 { std::cerr << <span class="stringliteral">"Not a valid output format"</span>; <span class="keywordflow">return</span> <span class="keyword">false</span>;}
<a name="l00088"></a>00088
<a name="l00090"></a>00090
<a name="l00094"></a>00094 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* Description()=0;
<a name="l00095"></a>00095
<a name="l00097"></a>00097
<a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* TargetClassDescription();
<a name="l00100"></a>00100
<a name="l00102"></a>00102
<a name="l00105"></a>00105 <span class="keyword">virtual</span> <span class="keyword">const</span> std::type_info& GetType();
<a name="l00106"></a>00106
<a name="l00108"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a1d3a8785a0ad0c85b98fa3406a64d50f">00108</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOpenBabel_1_1OBFormat.shtml#a1d3a8785a0ad0c85b98fa3406a64d50f" title="Web address where the format is defined.">SpecificationURL</a>() { <span class="keywordflow">return</span> <span class="stringliteral">""</span>; }
<a name="l00109"></a>00109
<a name="l00111"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a0e10219d8aedefa78ef16fc7fded85ec">00111</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classOpenBabel_1_1OBFormat.shtml#a0e10219d8aedefa78ef16fc7fded85ec" title="Chemical MIME type associated with this file type (if any)">GetMIMEType</a>() { <span class="keywordflow">return</span> pMime; }
<a name="l00112"></a>00112
<a name="l00114"></a>00114
<a name="l00118"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a94a94537cc5ba96b1876db1b612b91a3">00118</a> <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="classOpenBabel_1_1OBFormat.shtml#a94a94537cc5ba96b1876db1b612b91a3" title="Decribes the capabilities of the format (Read only etc.)">Flags</a>() { <span class="keywordflow">return</span> 0;};
<a name="l00119"></a>00119
<a name="l00121"></a>00121
<a name="l00123"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a1f0ee7ba19cc62b53a7ee06fa4f91509">00123</a> <span class="keyword">virtual</span> <span class="keywordtype">int</span> SkipObjects(<span class="keywordtype">int</span> <span class="comment">/*n*/</span>, <a class="code" href="classOpenBabel_1_1OBConversion.shtml" title="Class to convert from one format to another.">OBConversion</a>* <span class="comment">/*pConv*/</span>)
<a name="l00124"></a>00124 {
<a name="l00125"></a>00125 <span class="keywordflow">return</span> 0; <span class="comment">//shows not implemented in the format class</span>
<a name="l00126"></a>00126 };
<a name="l00127"></a>00127
<a name="l00129"></a>00129
<a name="l00133"></a><a class="code" href="classOpenBabel_1_1OBFormat.shtml#a0924b1a442d147fa036bff23a4cf04ef">00133</a> <span class="keyword">virtual</span> <a class="code" href="classOpenBabel_1_1OBFormat.shtml" title="Base class for file formats.">OBFormat</a>* MakeNewInstance()
<a name="l00134"></a>00134 {
<a name="l00135"></a>00135 <span class="keywordflow">return</span> NULL; <span class="comment">//shows not implemented in the format class</span>
<a name="l00136"></a>00136 }
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="comment">//New functions since OBFormat is derived from OBPlugin</span>
<a name="l00139"></a>00139 <span class="comment">//\brief Called from, and an alternative to, OBConversion::RegisterFormat();</span>
<a name="l00140"></a>00140 <span class="keywordtype">int</span> RegisterFormat(<span class="keyword">const</span> <span class="keywordtype">char</span>* ID, <span class="keyword">const</span> <span class="keywordtype">char</span>* MIME = NULL);
<a name="l00141"></a>00141
<a name="l00146"></a>00146 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Display(std::string& txt, <span class="keyword">const</span> <span class="keywordtype">char</span>* param, <span class="keyword">const</span> <span class="keywordtype">char</span>* ID=NULL);
<a name="l00147"></a>00147
<a name="l00148"></a>00148 <span class="keyword">static</span> <a class="code" href="classOpenBabel_1_1OBFormat.shtml" title="Base class for file formats.">OBFormat</a>* FormatFromMIME(<span class="keyword">const</span> <span class="keywordtype">char</span>* MIME);
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="keyword">private</span>:
<a name="l00151"></a>00151 <span class="keyword">static</span> PluginMapType &FormatsMIMEMap()
<a name="l00152"></a>00152 {
<a name="l00153"></a>00153 <span class="keyword">static</span> PluginMapType m;
<a name="l00154"></a>00154 <span class="keywordflow">return</span> m;
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156
<a name="l00157"></a>00157 <span class="keyword">const</span> <span class="keywordtype">char</span>* pMime;
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="comment">/* Functions provided by the MAKE_PLUGIN macro</span>
<a name="l00160"></a>00160 <span class="comment"></span>
<a name="l00162"></a>00162 <span class="comment"> Not currently used for formats</span>
<a name="l00163"></a>00163 <span class="comment"> OBFormat(const char* ID, bool IsDefault=false);</span>
<a name="l00164"></a>00164 <span class="comment"></span>
<a name="l00166"></a>00166 <span class="comment"> static OBFormat* FindType(const char* ID);</span>
<a name="l00167"></a>00167 <span class="comment"></span>
<a name="l00168"></a>00168 <span class="comment">*/</span>};
<a name="l00169"></a>00169
<a name="l00170"></a>00170 }<span class="comment">//namespace</span>
<a name="l00171"></a>00171 <span class="preprocessor">#endif</span>
<a name="l00172"></a>00172 <span class="preprocessor"></span>
</pre></div></div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- end content -->
<!--#include file="footer.html" -->
<div id="footer">
<hr size="1">
<img src="http://openbabel.org/babel256.png" width="136" height="127" alt="" style="float: left;" />
<p>This file is part of the documentation for <a href="http://openbabel.org/wiki/">Open Babel</a>, version 2.3.</p>
<div class="bottom">
Documentation copyright © 1998-2007, the <a href="http://openbabel.org/wiki/THANKS">Open Babel Developers</a>.<br>
Open Babel is hosted by: <a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=40728"
width="88" height="31" border="0" alt="SourceForge Logo"></a><br>
Generated on Thu Oct 13 2011 16:08:06 by <a href="http://www.doxygen.org/"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.5.1.
</div>
</body>
</html>
|
