File: classOpenMS_1_1Map.html

package info (click to toggle)
openms 1.11.1-5
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 436,688 kB
  • ctags: 150,907
  • sloc: cpp: 387,126; xml: 71,547; python: 7,764; ansic: 2,626; php: 2,499; sql: 737; ruby: 342; sh: 325; makefile: 128
file content (276 lines) | stat: -rw-r--r-- 16,394 bytes parent folder | download 
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
 
<HTML>
<HEAD>
<TITLE>Map&lt; Key, T &gt; Class Template Reference</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
<LINK HREF="style_ini.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<A href="index.html">Home</A> &nbsp;&middot;
<A href="classes.html">Classes</A> &nbsp;&middot;
<A href="annotated.html">Annotated Classes</A> &nbsp;&middot;
<A href="modules.html">Modules</A> &nbsp;&middot;
<A href="functions_func.html">Members</A> &nbsp;&middot;
<A href="namespaces.html">Namespaces</A> &nbsp;&middot;
<A href="pages.html">Related Pages</A>
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<!-- Generated by Doxygen 1.8.5 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceOpenMS.html">OpenMS</a></li><li class="navelem"><a class="el" href="classOpenMS_1_1Map.html">Map</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classOpenMS_1_1Map-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">Map&lt; Key, T &gt; Class Template Reference<div class="ingroups"><a class="el" href="group__Datastructures.html">Datastructures</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classOpenMS_1_1Map.html" title="Map class based on the STL map (containing serveral convenience functions) ">Map</a> class based on the STL map (containing serveral convenience functions)  
 <a href="classOpenMS_1_1Map.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Map_8h_source.html">OpenMS/DATASTRUCTURES/Map.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for Map&lt; Key, T &gt;:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classOpenMS_1_1Map.png" usemap="#Map&lt; Key, T &gt;_map" alt=""/>
  <map id="Map&lt; Key, T &gt;_map" name="Map&lt; Key, T &gt;_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map_1_1IllegalKey.html">IllegalKey</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classOpenMS_1_1Map.html" title="Map class based on the STL map (containing serveral convenience functions) ">Map</a> illegal key exception.  <a href="classOpenMS_1_1Map_1_1IllegalKey.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">OpenMS style typedefs</div></td></tr>
<tr class="memitem:a6f5795dc8e1989c91c40df623a83e79b"><td class="memItemLeft" align="right" valign="top">typedef std::map&lt; Key, T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#a6f5795dc8e1989c91c40df623a83e79b">Base</a></td></tr>
<tr class="separator:a6f5795dc8e1989c91c40df623a83e79b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4f6c906b63d16311ff63a2f4b184919"><td class="memItemLeft" align="right" valign="top">typedef Base::value_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#af4f6c906b63d16311ff63a2f4b184919">ValueType</a></td></tr>
<tr class="separator:af4f6c906b63d16311ff63a2f4b184919"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b910f030bda3b43ee972dd68638eb7d"><td class="memItemLeft" align="right" valign="top">typedef Key&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#a5b910f030bda3b43ee972dd68638eb7d">KeyType</a></td></tr>
<tr class="separator:a5b910f030bda3b43ee972dd68638eb7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6b548b8516b3cdaf19f75dbf0adcb66"><td class="memItemLeft" align="right" valign="top">typedef Base::value_type *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#ae6b548b8516b3cdaf19f75dbf0adcb66">PointerType</a></td></tr>
<tr class="separator:ae6b548b8516b3cdaf19f75dbf0adcb66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad436ba4f307bb17e3a999bf315125b33"><td class="memItemLeft" align="right" valign="top">typedef Base::iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#ad436ba4f307bb17e3a999bf315125b33">Iterator</a></td></tr>
<tr class="separator:ad436ba4f307bb17e3a999bf315125b33"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab0b72f785126c7046aa106fc05a8cda4"><td class="memItemLeft" align="right" valign="top">typedef Base::const_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#ab0b72f785126c7046aa106fc05a8cda4">ConstIterator</a></td></tr>
<tr class="separator:ab0b72f785126c7046aa106fc05a8cda4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aba21528f2ca3da3a55e0265213b889e7"><td class="memItemLeft" align="right" valign="top">typedef Base::reverse_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#aba21528f2ca3da3a55e0265213b889e7">ReverseIterator</a></td></tr>
<tr class="separator:aba21528f2ca3da3a55e0265213b889e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8858439b94989776fb9148e9c31366ed"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak"/>
Base::const_reverse_iterator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#a8858439b94989776fb9148e9c31366ed">ConstReverseIterator</a></td></tr>
<tr class="separator:a8858439b94989776fb9148e9c31366ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9eabefcb1631e53589789d97d0a72f9d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#a9eabefcb1631e53589789d97d0a72f9d">has</a> (const Key &amp;key) const </td></tr>
<tr class="memdesc:a9eabefcb1631e53589789d97d0a72f9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test whether the map contains the given key.  <a href="#a9eabefcb1631e53589789d97d0a72f9d">More...</a><br/></td></tr>
<tr class="separator:a9eabefcb1631e53589789d97d0a72f9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3f95e2e82a56ac466ed04b0e254e67fa"><td class="memItemLeft" align="right" valign="top">const T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#a3f95e2e82a56ac466ed04b0e254e67fa">operator[]</a> (const Key &amp;key) const </td></tr>
<tr class="memdesc:a3f95e2e82a56ac466ed04b0e254e67fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a constant reference to the element whose key is <code>key</code>.  <a href="#a3f95e2e82a56ac466ed04b0e254e67fa">More...</a><br/></td></tr>
<tr class="separator:a3f95e2e82a56ac466ed04b0e254e67fa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afca8f26c81138f0a8f7fa6f5a94dcf95"><td class="memItemLeft" align="right" valign="top">T &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1Map.html#afca8f26c81138f0a8f7fa6f5a94dcf95">operator[]</a> (const Key &amp;key)</td></tr>
<tr class="memdesc:afca8f26c81138f0a8f7fa6f5a94dcf95"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a mutable reference to the element whose key is <code>key</code>. If an element with the key <code>key</code> does not exist, it is inserted.  <a href="#afca8f26c81138f0a8f7fa6f5a94dcf95">More...</a><br/></td></tr>
<tr class="separator:afca8f26c81138f0a8f7fa6f5a94dcf95"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_classstd_1_1map"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_classstd_1_1map')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="classstd_1_1map.html">map&lt; K, T &gt;</a></td></tr>
<tr class="memitem:a4736f9b2b54dddaa10b54581a23a1789 inherit pub_attribs_classstd_1_1map"><td class="memItemLeft" align="right" valign="top">K&#160;</td><td class="memItemRight" valign="bottom"><b>keys</b></td></tr>
<tr class="memdesc:a4736f9b2b54dddaa10b54581a23a1789 inherit pub_attribs_classstd_1_1map"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL member.  <a href="#a4736f9b2b54dddaa10b54581a23a1789">More...</a><br/></td></tr>
<tr class="separator:a4736f9b2b54dddaa10b54581a23a1789 inherit pub_attribs_classstd_1_1map"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af400dbe3fe1572c567f882190c772196 inherit pub_attribs_classstd_1_1map"><td class="memItemLeft" align="right" valign="top">T&#160;</td><td class="memItemRight" valign="bottom"><b>elements</b></td></tr>
<tr class="memdesc:af400dbe3fe1572c567f882190c772196 inherit pub_attribs_classstd_1_1map"><td class="mdescLeft">&#160;</td><td class="mdescRight">STL member.  <a href="#af400dbe3fe1572c567f882190c772196">More...</a><br/></td></tr>
<tr class="separator:af400dbe3fe1572c567f882190c772196 inherit pub_attribs_classstd_1_1map"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class Key, class T&gt;<br/>
class OpenMS::Map&lt; Key, T &gt;</h3>

<p><a class="el" href="classOpenMS_1_1Map.html" title="Map class based on the STL map (containing serveral convenience functions) ">Map</a> class based on the STL map (containing serveral convenience functions) </p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a class="anchor" id="a6f5795dc8e1989c91c40df623a83e79b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::map&lt;Key, T&gt; <a class="el" href="classOpenMS_1_1Map.html#a6f5795dc8e1989c91c40df623a83e79b">Base</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ab0b72f785126c7046aa106fc05a8cda4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::const_iterator <a class="el" href="classOpenMS_1_1Map.html#ab0b72f785126c7046aa106fc05a8cda4">ConstIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a8858439b94989776fb9148e9c31366ed"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::const_reverse_iterator <a class="el" href="classOpenMS_1_1Map.html#a8858439b94989776fb9148e9c31366ed">ConstReverseIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ad436ba4f307bb17e3a999bf315125b33"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::iterator <a class="el" href="classOpenMS_1_1Map.html#ad436ba4f307bb17e3a999bf315125b33">Iterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="a5b910f030bda3b43ee972dd68638eb7d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Key <a class="el" href="classOpenMS_1_1Map.html#a5b910f030bda3b43ee972dd68638eb7d">KeyType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="ae6b548b8516b3cdaf19f75dbf0adcb66"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::value_type* <a class="el" href="classOpenMS_1_1Map.html#ae6b548b8516b3cdaf19f75dbf0adcb66">PointerType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="aba21528f2ca3da3a55e0265213b889e7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::reverse_iterator <a class="el" href="classOpenMS_1_1Map.html#aba21528f2ca3da3a55e0265213b889e7">ReverseIterator</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<a class="anchor" id="af4f6c906b63d16311ff63a2f4b184919"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef Base::value_type <a class="el" href="classOpenMS_1_1Map.html#af4f6c906b63d16311ff63a2f4b184919">ValueType</a></td>
        </tr>
      </table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9eabefcb1631e53589789d97d0a72f9d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool has </td>
          <td>(</td>
          <td class="paramtype">const Key &amp;&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Test whether the map contains the given key. </p>

<p>Referenced by <a class="el" href="classOpenMS_1_1Internal_1_1MzMLHandler.html#aeee3146ed1c95bbbc3e69b4d5dca3041">MzMLHandler&lt; MapType &gt;::writeHeader_()</a>, and <a class="el" href="classOpenMS_1_1Internal_1_1MzDataHandler.html#a0038ff865ac073e00ca829d977f2ccdf">MzDataHandler&lt; MapType &gt;::writeTo()</a>.</p>

</div>
</div>
<a class="anchor" id="a3f95e2e82a56ac466ed04b0e254e67fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const T &amp; operator[] </td>
          <td>(</td>
          <td class="paramtype">const Key &amp;&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return a constant reference to the element whose key is <code>key</code>. </p>
<dl class="exception"><dt>Exceptions</dt><dd>
  <table class="exception">
    <tr><td class="paramname"><a class="el" href="classOpenMS_1_1Map_1_1IllegalKey.html" title="Map illegal key exception. ">IllegalKey</a></td><td>if the given key does not exist </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afca8f26c81138f0a8f7fa6f5a94dcf95"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">T &amp; operator[] </td>
          <td>(</td>
          <td class="paramtype">const Key &amp;&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Return a mutable reference to the element whose key is <code>key</code>. If an element with the key <code>key</code> does not exist, it is inserted. </p>

</div>
</div>
</div><!-- contents -->
<HR style="height:1px; border:none; border-top:1px solid #c0c0c0;">
<TABLE width="100%" border="0">
<TR>
<TD><font color="#c0c0c0">OpenMS / TOPP release 1.11.1</font></TD>
<TD align="right"><font color="#c0c0c0">Documentation generated on Thu Nov 14 2013 11:19:29 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>