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
|
<HTML>
<HEAD>
<TITLE>ConsoleUtils Class 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> ·
<A href="classes.html">Classes</A> ·
<A href="annotated.html">Annotated Classes</A> ·
<A href="modules.html">Modules</A> ·
<A href="functions_func.html">Members</A> ·
<A href="namespaces.html">Namespaces</A> ·
<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_1ConsoleUtils.html">ConsoleUtils</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pri-methods">Private Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classOpenMS_1_1ConsoleUtils-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ConsoleUtils Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="ConsoleUtils_8h_source.html">OpenMS/APPLICATIONS/ConsoleUtils.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a507c970f7dd8235145346bf2c53a23a7"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#a507c970f7dd8235145346bf2c53a23a7">breakString</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &input, const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> indentation, const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> max_lines)</td></tr>
<tr class="separator:a507c970f7dd8235145346bf2c53a23a7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:af11d7a1c397aba0ead44dd955011a431"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#af11d7a1c397aba0ead44dd955011a431">readConsoleSize_</a> ()</td></tr>
<tr class="memdesc:af11d7a1c397aba0ead44dd955011a431"><td class="mdescLeft"> </td><td class="mdescRight">read console settings for output shaping <a href="#af11d7a1c397aba0ead44dd955011a431">More...</a><br/></td></tr>
<tr class="separator:af11d7a1c397aba0ead44dd955011a431"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac1016e06f98db0fdb8e510d87d06392a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classOpenMS_1_1String.html">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#ac1016e06f98db0fdb8e510d87d06392a">breakString_</a> (const <a class="el" href="classOpenMS_1_1String.html">String</a> &input, const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> indentation, const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> max_lines)</td></tr>
<tr class="memdesc:ac1016e06f98db0fdb8e510d87d06392a"><td class="mdescLeft"> </td><td class="mdescRight">returns a console friendly version of input <a href="#ac1016e06f98db0fdb8e510d87d06392a">More...</a><br/></td></tr>
<tr class="separator:ac1016e06f98db0fdb8e510d87d06392a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adacc6a5b28f41153377763cfbea24e1e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#adacc6a5b28f41153377763cfbea24e1e">ConsoleUtils</a> ()</td></tr>
<tr class="memdesc:adacc6a5b28f41153377763cfbea24e1e"><td class="mdescLeft"> </td><td class="mdescRight">C'tor. <a href="#adacc6a5b28f41153377763cfbea24e1e">More...</a><br/></td></tr>
<tr class="separator:adacc6a5b28f41153377763cfbea24e1e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab21743fc368dac847e67ce18a45faa76"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#ab21743fc368dac847e67ce18a45faa76">ConsoleUtils</a> (<a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> const &)</td></tr>
<tr class="memdesc:ab21743fc368dac847e67ce18a45faa76"><td class="mdescLeft"> </td><td class="mdescRight">Copy C'tor. <a href="#ab21743fc368dac847e67ce18a45faa76">More...</a><br/></td></tr>
<tr class="separator:ab21743fc368dac847e67ce18a45faa76"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac892f8c6fa39988d2402303dec0eddb8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#ac892f8c6fa39988d2402303dec0eddb8">operator=</a> (<a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> const &)</td></tr>
<tr class="memdesc:ac892f8c6fa39988d2402303dec0eddb8"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="#ac892f8c6fa39988d2402303dec0eddb8">More...</a><br/></td></tr>
<tr class="separator:ac892f8c6fa39988d2402303dec0eddb8"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:afe21d8f1835054777eef2c02f75dcc2e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classOpenMS_1_1ConsoleUtils.html#afe21d8f1835054777eef2c02f75dcc2e">console_width_</a></td></tr>
<tr class="memdesc:afe21d8f1835054777eef2c02f75dcc2e"><td class="mdescLeft"> </td><td class="mdescRight">width of console we are currently in (if not determinable, set to 80 as default) <a href="#afe21d8f1835054777eef2c02f75dcc2e">More...</a><br/></td></tr>
<tr class="separator:afe21d8f1835054777eef2c02f75dcc2e"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="adacc6a5b28f41153377763cfbea24e1e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>C'tor. </p>
</div>
</div>
<a class="anchor" id="ab21743fc368dac847e67ce18a45faa76"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> const & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy C'tor. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a507c970f7dd8235145346bf2c53a23a7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classOpenMS_1_1String.html">String</a> breakString </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td>
<td class="paramname"><em>indentation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td>
<td class="paramname"><em>max_lines</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>make a string console friendly by breaking it into multiple lines according to the console width The 'intendation' gives the number of spaces which is prepended beginning at the second (!) line, so one gets a left aligned block which has some space to the left. An intendation of 0 results in the native console's default behaviour: just break at the end of its width and start a new line. but usually one wants nicely intended blocks, which the console does not support 'max_lines' gives the upper limit of lines returned after breaking is finished. Excess lines are removed and replaced by '...', BUT the last line will be preserved. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">input</td><td><a class="el" href="classOpenMS_1_1String.html" title="A more convenient string class. ">String</a> to be split </td></tr>
<tr><td class="paramname">intendation</td><td>Number of spaces to use for lines 2 until last line. </td></tr>
<tr><td class="paramname">max_lines</td><td>Limit of output lines (all others are removed) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ac1016e06f98db0fdb8e510d87d06392a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classOpenMS_1_1String.html">String</a> breakString_ </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classOpenMS_1_1String.html">String</a> & </td>
<td class="paramname"><em>input</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td>
<td class="paramname"><em>indentation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__Concept.html#gaf9ecec2d692138fab9167164a457cbd4">Size</a> </td>
<td class="paramname"><em>max_lines</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>returns a console friendly version of input </p>
</div>
</div>
<a class="anchor" id="ac892f8c6fa39988d2402303dec0eddb8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classOpenMS_1_1ConsoleUtils.html">ConsoleUtils</a> const & </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
</div>
</div>
<a class="anchor" id="af11d7a1c397aba0ead44dd955011a431"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int readConsoleSize_ </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>read console settings for output shaping </p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="afe21d8f1835054777eef2c02f75dcc2e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int console_width_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>width of console we are currently in (if not determinable, set to 80 as default) </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:27 using doxygen 1.8.5</font></TD>
</TR>
</TABLE>
</BODY>
</HTML>
|
