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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head><meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>Plugins</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><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>
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#files">Files</a> |
<a href="#define-members">Defines</a> |
<a href="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">Plugins</div> </div>
</div>
<div class="contents">
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structOpenBabel_1_1CharPtrLess.shtml">CharPtrLess</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Case insensitive string comparison for PluginMapType key. <a href="structOpenBabel_1_1CharPtrLess.shtml#details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenBabel_1_1OBPlugin.shtml">OBPlugin</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Base class for all types of dynamic classes discovered at runtime. <a href="classOpenBabel_1_1OBPlugin.shtml#details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="files"></a>
Files</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="plugin_8h.shtml">plugin.h</a></td></tr>
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gadd740e2a386b7db3e1f0e271cbe8a3f1">MAKE_PLUGIN</a>(BaseClass)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gaac917d0f317751ba3ac45628fb467e58">OB_STATIC_PLUGIN</a>(className, instanceName)</td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef std::map< const char <br class="typebreak"/>
*, OBPlugin *, CharPtrLess > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga0fd3c807ed3341c33070c93b14739bc8">PluginMapType</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
PluginMapType::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga8fac85f5497f873a2dd8734b47f0bdc0">PluginIterator</a></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gac2505b03ab30bfd419b570e0324743ab">operator()</a> (const char *p1, const char *p2) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga2f6f0f4ddec879439f78de686c459fb0">~OBPlugin</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga4a6b8d1611d5d963fc29982cc1ebcbf7">Description</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga45dfda1fb13d3c26ab7f8f7631e3351c">TypeID</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gae0859fdbf134af95a8231eb32c73b7db">Display</a> (std::string &txt, const char *param, const char *ID=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual OBPlugin * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga9399e9568ab809d714385f1b237a9335">MakeInstance</a> (const std::vector< std::string > &)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga3e0b39e1326de703012f81ac2be7feba">Init</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OBPlugin * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga295dc7f1b94da710821c562bff3e7c97">GetPlugin</a> (const char *Type, const char *ID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga753a34173c6750388d33e5294556790f">GetID</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gaf95953a5793333ba51e978c4a0a00103">ListAsVector</a> (const char *PluginID, const char *param, std::vector< std::string > &vlist)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga9fabfd2513038ae6ac475ac0ff2c73cd">List</a> (const char *PluginID, const char *param=NULL, std::ostream *os=&std::cout)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gaba22c5352d36c7f058299af7ddffb03e">ListAsString</a> (const char *PluginID, const char *param=NULL)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga84fc973fdf4bba5a6b0e2d402077991c">FirstLine</a> (const char *txt)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PluginIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga1d4d73999ab0518ee471c635bd0a7e87">Begin</a> (const char *PluginID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PluginIterator </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga9a330280c1cd2e7119dac87a6fd0b762">End</a> (const char *PluginID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual PluginMapType & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gaabc1385cbe63145ffec6edf1f2c3be98">GetMap</a> () const =0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PluginMapType & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gac40457336d7b12bb632b4ac4e8955a3a">PluginMap</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static PluginMapType & </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#gadfcf9fda27cfbc4301fc94517a4250ef">GetTypeMap</a> (const char *PluginID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static OBPlugin * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga1e58b1811ec8c1b88254ee46ccef0b78">BaseFindType</a> (PluginMapType &Map, const char *ID)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga7a0297c3c2a3fa58bbd5e321b900ddec">EnableStaticPlugins</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="var-members"></a>
Variables</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__plugins.shtml#ga1f8d25dafb0bc13814ca451035f67955">_id</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<p>/ / </p>
<h3><a class="anchor" id="plugins"></a>Plugins</h3><div class="textblock"><p>Plugins are a way of extending <a class="el" href="namespaceOpenBabel.shtml" title="Global namespace for all Open Babel code.">OpenBabel</a> without having to alter any of the existing code. They may be built as shared libraries (DLLs with an extension .obf or .so files in a specified location) and distributed separately, but plugin classes can also be in the main code. In both cases they are discovered at startup when a global instance of the plugin class is instantiated. It iss registered by its constructor and is added to a static record of all the plugins of its particular type that are currently loaded.</p>
<p>There are two levels of plugin. The top layer (at the time of writing) are: formats descriptors fingerprints forcefields charges ops loaders but additional types can be added without disturbing the main API. At runtime babel -L will list the top level of plugins. They typically are abstract classes with virtual functions that define an interface for that type. Classes derived from these are the second layer of plugins, and can be listed at runtime like, for instance: babel -L formats cml where formats is the top level of plugin and cml is the id of a derived class of this type.</p>
<p>The top level of plugins will usually have their interfaces declared in header files compiled with the main API. The second level of plugin will typically not be known to the API at compile time, usually will not have a header file and must be accessed indirectly, to allow for the possibility that they may not be loaded: </p>
<div class="fragment"><pre class="fragment"> OBOp* pOp = OBOp::FindType(<span class="stringliteral">"gen3D"</span>);
<span class="keywordflow">if</span>(!pOp)
...report error
pOp->Do(mol);
</pre></div><p> This retrieves the global instance of the plugin. This is usually adequate but making a new instance may be appropriate in some cases.</p>
<p>Instances of some plugin classes can be constructed at startup from information in a text file and used in the same way as those defined in code. See OBDefine. This is appropriate for some classes that differ only by the datafile or SMARTS strings they use. </p>
</div><hr/><h2>Define Documentation</h2>
<a class="anchor" id="gadd740e2a386b7db3e1f0e271cbe8a3f1"></a><!-- doxytag: member="plugin.h::MAKE_PLUGIN" ref="gadd740e2a386b7db3e1f0e271cbe8a3f1" args="(BaseClass)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define MAKE_PLUGIN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">BaseClass</td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">protected</span>:\
static PluginMapType& Map(){<span class="keyword">static</span> PluginMapType m;<span class="keywordflow">return</span> m;}\
virtual PluginMapType& GetMap()<span class="keyword">const</span>{<span class="keywordflow">return</span> Map();}\
public:\
static BaseClass*& Default(){<span class="keyword">static</span> BaseClass* d;<span class="keywordflow">return</span> d;}\
BaseClass(<span class="keyword">const</span> <span class="keywordtype">char</span>* ID, <span class="keywordtype">bool</span> IsDefault=<span class="keyword">false</span>)\
{_id=ID;<span class="keywordflow">if</span>(ID&&*ID){<span class="keywordflow">if</span>(IsDefault || Map().empty()) Default() = <span class="keyword">this</span>;\
Map()[ID]=<span class="keyword">this</span>;PluginMap()[TypeID()] =<span class="keyword">this</span>;}}\
static BaseClass* FindType(<span class="keyword">const</span> <span class="keywordtype">char</span>* ID)\
{<span class="keywordflow">if</span>(!ID || *ID==0 || *ID==<span class="charliteral">' '</span>) <span class="keywordflow">return</span> Default();\
return <span class="keyword">static_cast<</span>BaseClass*<span class="keyword">></span>(BaseFindType(Map(),ID));}
</pre></div>
</div>
</div>
<a class="anchor" id="gaac917d0f317751ba3ac45628fb467e58"></a><!-- doxytag: member="plugin.h::OB_STATIC_PLUGIN" ref="gaac917d0f317751ba3ac45628fb467e58" args="(className, instanceName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define OB_STATIC_PLUGIN</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">className, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname">instanceName </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">class </span>className; \
OBAPI EXTERN className instanceName;
</pre></div>
</div>
</div>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="ga0fd3c807ed3341c33070c93b14739bc8"></a><!-- doxytag: member="OpenBabel::OBPlugin::PluginMapType" ref="ga0fd3c807ed3341c33070c93b14739bc8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef std::map<const char*, OBPlugin*, CharPtrLess> PluginMapType</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga8fac85f5497f873a2dd8734b47f0bdc0"></a><!-- doxytag: member="OpenBabel::OBPlugin::PluginIterator" ref="ga8fac85f5497f873a2dd8734b47f0bdc0" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef PluginMapType::const_iterator PluginIterator</td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="gac2505b03ab30bfd419b570e0324743ab"></a><!-- doxytag: member="OpenBabel::CharPtrLess::operator()" ref="gac2505b03ab30bfd419b570e0324743ab" args="(const char *p1, const char *p2) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool operator() </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>p2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="ga2f6f0f4ddec879439f78de686c459fb0"></a><!-- doxytag: member="OpenBabel::OBPlugin::~OBPlugin" ref="ga2f6f0f4ddec879439f78de686c459fb0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~OBPlugin </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Virtual destructor necessary for classes with virtual functions. </p>
</div>
</div>
<a class="anchor" id="ga4a6b8d1611d5d963fc29982cc1ebcbf7"></a><!-- doxytag: member="OpenBabel::OBPlugin::Description" ref="ga4a6b8d1611d5d963fc29982cc1ebcbf7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* Description </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Required description of a sub-type. </p>
<p>Reimplemented in <a class="el" href="classOpenBabel_1_1OBFormat.shtml#ab87525f269e7819d8462f450d30d56a7">OBFormat</a>, <a class="el" href="classOpenBabel_1_1OBGroupContrib.shtml#a4a6b8d1611d5d963fc29982cc1ebcbf7">OBGroupContrib</a>, and <a class="el" href="classOpenBabel_1_1OpTransform.shtml#a4a6b8d1611d5d963fc29982cc1ebcbf7">OpTransform</a>.</p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBOp.shtml#a64e598f68f30107a74319b9fc6d26cd0">OBOp::OpOptions()</a>.</p>
</div>
</div>
<a class="anchor" id="ga45dfda1fb13d3c26ab7f8f7631e3351c"></a><!-- doxytag: member="OpenBabel::OBPlugin::TypeID" ref="ga45dfda1fb13d3c26ab7f8f7631e3351c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual const char* TypeID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Redefined by each plugin type: "formats", "fingerprints", etc. </p>
<p>Reimplemented in <a class="el" href="classOpenBabel_1_1OBForceField.shtml#a45db88b29eb37e9dd105bf4032e421d2">OBForceField</a>, <a class="el" href="classOpenBabel_1_1OBFormat.shtml#a45db88b29eb37e9dd105bf4032e421d2">OBFormat</a>, <a class="el" href="classOpenBabel_1_1OBOp.shtml#a45dfda1fb13d3c26ab7f8f7631e3351c">OBOp</a>, <a class="el" href="classOpenBabel_1_1OBDescriptor.shtml#a45db88b29eb37e9dd105bf4032e421d2">OBDescriptor</a>, and <a class="el" href="classOpenBabel_1_1OBChargeModel.shtml#a45db88b29eb37e9dd105bf4032e421d2">OBChargeModel</a>.</p>
</div>
</div>
<a class="anchor" id="gae0859fdbf134af95a8231eb32c73b7db"></a><!-- doxytag: member="OpenBabel::OBPlugin::Display" ref="gae0859fdbf134af95a8231eb32c73b7db" args="(std::string &txt, const char *param, const char *ID=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Display </td>
<td>(</td>
<td class="paramtype">std::string & </td>
<td class="paramname"><em>txt</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ID</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write information on a plugin class to the string txt. Return false if not written. The default implementation outputs: the ID, a tab character, and the first line of the Description. The param string can be used in derived types to provide different outputs. </p>
<p>Reimplemented in <a class="el" href="classOpenBabel_1_1OBFormat.shtml#ae0859fdbf134af95a8231eb32c73b7db">OBFormat</a>, and <a class="el" href="classOpenBabel_1_1OBDescriptor.shtml#ae0859fdbf134af95a8231eb32c73b7db">OBDescriptor</a>.</p>
</div>
</div>
<a class="anchor" id="ga9399e9568ab809d714385f1b237a9335"></a><!-- doxytag: member="OpenBabel::OBPlugin::MakeInstance" ref="ga9399e9568ab809d714385f1b237a9335" args="(const std::vector< std::string > &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual OBPlugin* MakeInstance </td>
<td>(</td>
<td class="paramtype">const std::vector< std::string > & </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Make a new instance of the class. See <a class="el" href="classOpenBabel_1_1OpTransform.shtml" title="Applies molecular reactions/transforms (OBChemTsfm class) read from a datafile.">OpTransform</a>, <a class="el" href="classOpenBabel_1_1OBGroupContrib.shtml" title="Handle group contribution algorithms.">OBGroupContrib</a>, SmartsDescriptor classes for derived versions. Usually, the first parameter is the classname, the next three are parameters(ID, filename, description) for a constructor, and the rest data. </p>
<p>Reimplemented in <a class="el" href="classOpenBabel_1_1OBGroupContrib.shtml#ab91e9dba77605edc84876eac596f2094">OBGroupContrib</a>, and <a class="el" href="classOpenBabel_1_1OpTransform.shtml#aed21db4d9fb23cb30d0440e844a69f57">OpTransform</a>.</p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBConversion.shtml#acb5fa3f38f036bd82ba49a44d6b7a998">OBConversion::LoadFormatFiles()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3e0b39e1326de703012f81ac2be7feba"></a><!-- doxytag: member="OpenBabel::OBPlugin::Init" ref="ga3e0b39e1326de703012f81ac2be7feba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void Init </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initialize the plugin. The default version does nothing. </p>
</div>
</div>
<a class="anchor" id="ga295dc7f1b94da710821c562bff3e7c97"></a><!-- doxytag: member="OpenBabel::OBPlugin::GetPlugin" ref="ga295dc7f1b94da710821c562bff3e7c97" args="(const char *Type, const char *ID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OBPlugin * GetPlugin </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>Type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ID</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a pointer to a plugin from its type and ID. Return NULL if not found. If Type is NULL, search all types. Not cast to Type* </p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBConversion.shtml#acb5fa3f38f036bd82ba49a44d6b7a998">OBConversion::LoadFormatFiles()</a>.</p>
</div>
</div>
<a class="anchor" id="ga753a34173c6750388d33e5294556790f"></a><!-- doxytag: member="OpenBabel::OBPlugin::GetID" ref="ga753a34173c6750388d33e5294556790f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* GetID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the ID of the sub-type instance. </p>
</div>
</div>
<a class="anchor" id="gaf95953a5793333ba51e978c4a0a00103"></a><!-- doxytag: member="OpenBabel::OBPlugin::ListAsVector" ref="gaf95953a5793333ba51e978c4a0a00103" args="(const char *PluginID, const char *param, std::vector< std::string > &vlist)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ListAsVector </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< std::string > & </td>
<td class="paramname"><em>vlist</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Output a list of sub-type classes of the the type PluginID, or, if PluginID is "plugins" or empty, a list of the base types. If PluginID is not recognized or is NULL, the base types are output and the return is false. </p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBConversion.shtml#a137c540357b45e73f65e602e1196eed7">OBConversion::GetSupportedInputFormat()</a>, and <a class="el" href="classOpenBabel_1_1OBConversion.shtml#a353b3a6a53808b22361c9f44713978e8">OBConversion::GetSupportedOutputFormat()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9fabfd2513038ae6ac475ac0ff2c73cd"></a><!-- doxytag: member="OpenBabel::OBPlugin::List" ref="ga9fabfd2513038ae6ac475ac0ff2c73cd" args="(const char *PluginID, const char *param=NULL, std::ostream *os=&std::cout)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void List </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>param</em> = <code>NULL</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::ostream * </td>
<td class="paramname"><em>os</em> = <code>&std::cout</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>As ListAsVector but sent to an ostream with a default of cout if not specified. </p>
</div>
</div>
<a class="anchor" id="gaba22c5352d36c7f058299af7ddffb03e"></a><!-- doxytag: member="OpenBabel::OBPlugin::ListAsString" ref="gaba22c5352d36c7f058299af7ddffb03e" args="(const char *PluginID, const char *param=NULL)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string ListAsString </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>param</em> = <code>NULL</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>As ListAsVector but returns a string containing the list. </p>
</div>
</div>
<a class="anchor" id="ga84fc973fdf4bba5a6b0e2d402077991c"></a><!-- doxytag: member="OpenBabel::OBPlugin::FirstLine" ref="ga84fc973fdf4bba5a6b0e2d402077991c" args="(const char *txt)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string FirstLine </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>txt</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Utility function to return only the first line of a string. </p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBOp.shtml#a64e598f68f30107a74319b9fc6d26cd0">OBOp::OpOptions()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1d4d73999ab0518ee471c635bd0a7e87"></a><!-- doxytag: member="OpenBabel::OBPlugin::Begin" ref="ga1d4d73999ab0518ee471c635bd0a7e87" args="(const char *PluginID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static PluginIterator Begin </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return an iterator at the start of the map of the plugin types PluginID or, if there is no such map, the end of the top level plugin map. </p>
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBConversion.shtml#af0bee894a9ed7ca61637452dc2e264f2">OBConversion::GetNextFormat()</a>, and <a class="el" href="classOpenBabel_1_1OBOp.shtml#a64e598f68f30107a74319b9fc6d26cd0">OBOp::OpOptions()</a>.</p>
</div>
</div>
<a class="anchor" id="ga9a330280c1cd2e7119dac87a6fd0b762"></a><!-- doxytag: member="OpenBabel::OBPlugin::End" ref="ga9a330280c1cd2e7119dac87a6fd0b762" args="(const char *PluginID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static PluginIterator End </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em></td><td>)</td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Referenced by <a class="el" href="classOpenBabel_1_1OBConversion.shtml#af0bee894a9ed7ca61637452dc2e264f2">OBConversion::GetNextFormat()</a>, and <a class="el" href="classOpenBabel_1_1OBOp.shtml#a64e598f68f30107a74319b9fc6d26cd0">OBOp::OpOptions()</a>.</p>
</div>
</div>
<a class="anchor" id="gaabc1385cbe63145ffec6edf1f2c3be98"></a><!-- doxytag: member="OpenBabel::OBPlugin::GetMap" ref="gaabc1385cbe63145ffec6edf1f2c3be98" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual PluginMapType& GetMap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the map of the subtypes. </p>
<p>Referenced by <a class="el" href="group__plugins.shtml#gaf95953a5793333ba51e978c4a0a00103">OBPlugin::ListAsVector()</a>.</p>
</div>
</div>
<a class="anchor" id="gac40457336d7b12bb632b4ac4e8955a3a"></a><!-- doxytag: member="OpenBabel::OBPlugin::PluginMap" ref="gac40457336d7b12bb632b4ac4e8955a3a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static PluginMapType& PluginMap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline, static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a reference to the map of the plugin types. Is a function rather than a static member variable to avoid initialization problems. </p>
</div>
</div>
<a class="anchor" id="gadfcf9fda27cfbc4301fc94517a4250ef"></a><!-- doxytag: member="OpenBabel::OBPlugin::GetTypeMap" ref="gadfcf9fda27cfbc4301fc94517a4250ef" args="(const char *PluginID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OBPlugin::PluginMapType & GetTypeMap </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>PluginID</em></td><td>)</td>
<td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the map of a particular plugin type, e.g. GetMapType("fingerprints") </p>
</div>
</div>
<a class="anchor" id="ga1e58b1811ec8c1b88254ee46ccef0b78"></a><!-- doxytag: member="OpenBabel::OBPlugin::BaseFindType" ref="ga1e58b1811ec8c1b88254ee46ccef0b78" args="(PluginMapType &Map, const char *ID)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">OBPlugin * BaseFindType </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__plugins.shtml#ga0fd3c807ed3341c33070c93b14739bc8">PluginMapType</a> & </td>
<td class="paramname"><em>Map</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>ID</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static, protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the type with the specified ID, or NULL if not found. Needs to be cast to the appropriate class in the calling routine. </p>
</div>
</div>
<a class="anchor" id="ga7a0297c3c2a3fa58bbd5e321b900ddec"></a><!-- doxytag: member="OpenBabel::EnableStaticPlugins" ref="ga7a0297c3c2a3fa58bbd5e321b900ddec" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< std::string > EnableStaticPlugins </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Variable Documentation</h2>
<a class="anchor" id="ga1f8d25dafb0bc13814ca451035f67955"></a><!-- doxytag: member="OpenBabel::OBPlugin::_id" ref="ga1f8d25dafb0bc13814ca451035f67955" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* _id<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
</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:09 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>
|
