libcal3d-doc 0.11.0-7 / usr / share / doc / libcal3d-doc / html / classCalStreamSource.html

This file is indexed.

/usr/share/doc/libcal3d-doc/html/classCalStreamSource.html is in libcal3d-doc 0.11.0-7.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
<html>
  <head>
    <title>CalStreamSource Class Reference</title>
    <link href="doxygen.css" rel="stylesheet" type="text/css">
  </head>
<body bgcolor="#ffffff">
  <table width="100%" border="0" cellspacing="0" cellpadding="5" align="center">
    <tr>
      <td class="md" align="center">
        <small>
          <b>- Cal3D 0.11 API Reference -</b>
        </small>
      </td>
    </tr>
  </table>
  <br>
<!-- Generated by Doxygen 1.8.11 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classCalStreamSource-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">CalStreamSource Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classCalStreamSource.html" title="CalStreamSource class. ">CalStreamSource</a> class.  
 <a href="classCalStreamSource.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="streamsource_8h_source.html">streamsource.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for CalStreamSource:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classCalStreamSource.png" usemap="#CalStreamSource_map" alt=""/>
  <map id="CalStreamSource_map" name="CalStreamSource_map">
<area href="classCalDataSource.html" title="CalDataSource abstract interface class. " alt="CalDataSource" shape="rect" coords="0,0,111,24"/>
</map>
 </div></div>
<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:a8e1c256078c06d4b6c2bdfa231edab29"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#a8e1c256078c06d4b6c2bdfa231edab29">CalStreamSource</a> (std::istream &amp;inputStream)</td></tr>
<tr class="memdesc:a8e1c256078c06d4b6c2bdfa231edab29"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a stream source instance from an existing istream.  <a href="#a8e1c256078c06d4b6c2bdfa231edab29">More...</a><br /></td></tr>
<tr class="separator:a8e1c256078c06d4b6c2bdfa231edab29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab70f2ec3dd2e65fd0cd8bf61dbd6a61e"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#ab70f2ec3dd2e65fd0cd8bf61dbd6a61e">~CalStreamSource</a> ()</td></tr>
<tr class="memdesc:ab70f2ec3dd2e65fd0cd8bf61dbd6a61e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destruct the <a class="el" href="classCalStreamSource.html" title="CalStreamSource class. ">CalStreamSource</a>.  <a href="#ab70f2ec3dd2e65fd0cd8bf61dbd6a61e">More...</a><br /></td></tr>
<tr class="separator:ab70f2ec3dd2e65fd0cd8bf61dbd6a61e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3ffd2137af2a0166b66c8eca6c65b3d7"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#a3ffd2137af2a0166b66c8eca6c65b3d7">ok</a> () const </td></tr>
<tr class="memdesc:a3ffd2137af2a0166b66c8eca6c65b3d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the data source is in a good state.  <a href="#a3ffd2137af2a0166b66c8eca6c65b3d7">More...</a><br /></td></tr>
<tr class="separator:a3ffd2137af2a0166b66c8eca6c65b3d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afaea4bddb063a06e1349ee83630ee70c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaea4bddb063a06e1349ee83630ee70c"></a>
virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#afaea4bddb063a06e1349ee83630ee70c">setError</a> () const </td></tr>
<tr class="memdesc:afaea4bddb063a06e1349ee83630ee70c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the error code and message related to a streaming source. <br /></td></tr>
<tr class="separator:afaea4bddb063a06e1349ee83630ee70c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae9898a6cb9838f632fd92e20f8d5cd28"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#ae9898a6cb9838f632fd92e20f8d5cd28">readBytes</a> (void *pBuffer, int length)</td></tr>
<tr class="memdesc:ae9898a6cb9838f632fd92e20f8d5cd28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a number of bytes.  <a href="#ae9898a6cb9838f632fd92e20f8d5cd28">More...</a><br /></td></tr>
<tr class="separator:ae9898a6cb9838f632fd92e20f8d5cd28"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa09c0e2eaf2a0a55e6d257a4eff63d13"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#aa09c0e2eaf2a0a55e6d257a4eff63d13">readFloat</a> (float &amp;value)</td></tr>
<tr class="memdesc:aa09c0e2eaf2a0a55e6d257a4eff63d13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a float.  <a href="#aa09c0e2eaf2a0a55e6d257a4eff63d13">More...</a><br /></td></tr>
<tr class="separator:aa09c0e2eaf2a0a55e6d257a4eff63d13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c953882c703d8c5f9504ab00cc0e1ba"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#a7c953882c703d8c5f9504ab00cc0e1ba">readInteger</a> (int &amp;value)</td></tr>
<tr class="memdesc:a7c953882c703d8c5f9504ab00cc0e1ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads an integer.  <a href="#a7c953882c703d8c5f9504ab00cc0e1ba">More...</a><br /></td></tr>
<tr class="separator:a7c953882c703d8c5f9504ab00cc0e1ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6ac7d3205bcbed0686efd70b14638092"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCalStreamSource.html#a6ac7d3205bcbed0686efd70b14638092">readString</a> (std::string &amp;strValue)</td></tr>
<tr class="memdesc:a6ac7d3205bcbed0686efd70b14638092"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a string.  <a href="#a6ac7d3205bcbed0686efd70b14638092">More...</a><br /></td></tr>
<tr class="separator:a6ac7d3205bcbed0686efd70b14638092"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a65c2b02eb400b2fd9cf52144646a771e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c2b02eb400b2fd9cf52144646a771e"></a>
std::istream *&#160;</td><td class="memItemRight" valign="bottom"><b>mInputStream</b></td></tr>
<tr class="separator:a65c2b02eb400b2fd9cf52144646a771e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classCalStreamSource.html" title="CalStreamSource class. ">CalStreamSource</a> class. </p>
<p>This is an object designed to represent a source of Cal3d data as coming from a standard input stream. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a8e1c256078c06d4b6c2bdfa231edab29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">CalStreamSource::CalStreamSource </td>
          <td>(</td>
          <td class="paramtype">std::istream &amp;&#160;</td>
          <td class="paramname"><em>inputStream</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Constructs a stream source instance from an existing istream. </p>
<p>This function is the only constructor of the stream source.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">inputStream</td><td>The input stream to use, which should be set up and ready to be read from before making the stream source. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ab70f2ec3dd2e65fd0cd8bf61dbd6a61e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">CalStreamSource::~CalStreamSource </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destruct the <a class="el" href="classCalStreamSource.html" title="CalStreamSource class. ">CalStreamSource</a>. </p>
<p>Note that input stream is not closed here; this should be handled externally. </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a3ffd2137af2a0166b66c8eca6c65b3d7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool CalStreamSource::ok </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Checks whether the data source is in a good state. </p>
<p>This function checks if the istream can be used.</p>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if data source is in a good state </li>
<li><b>false</b> if not </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>

</div>
</div>
<a class="anchor" id="ae9898a6cb9838f632fd92e20f8d5cd28"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool CalStreamSource::readBytes </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>pBuffer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>length</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a number of bytes. </p>
<p>This function reads a given number of bytes from this data source.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">pBuffer</td><td>A pointer to the buffer where the bytes are stored into. </td></tr>
    <tr><td class="paramname">length</td><td>The number of bytes that should be read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>

</div>
</div>
<a class="anchor" id="aa09c0e2eaf2a0a55e6d257a4eff63d13"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool CalStreamSource::readFloat </td>
          <td>(</td>
          <td class="paramtype">float &amp;&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a float. </p>
<p>This function reads a float from this data source.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>A reference to the float into which the data is read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>

</div>
</div>
<a class="anchor" id="a7c953882c703d8c5f9504ab00cc0e1ba"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool CalStreamSource::readInteger </td>
          <td>(</td>
          <td class="paramtype">int &amp;&#160;</td>
          <td class="paramname"><em>value</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads an integer. </p>
<p>This function reads an integer from this data source.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>A reference to the integer into which the data is read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>

</div>
</div>
<a class="anchor" id="a6ac7d3205bcbed0686efd70b14638092"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool CalStreamSource::readString </td>
          <td>(</td>
          <td class="paramtype">std::string &amp;&#160;</td>
          <td class="paramname"><em>strValue</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Reads a string. </p>
<p>This function reads a string from this data source.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">value</td><td>A reference to the string into which the data is read.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>One of the following values: <ul>
<li><b>true</b> if successful </li>
<li><b>false</b> if an error happend </li>
</ul>
</dd></dl>

<p>Implements <a class="el" href="classCalDataSource.html">CalDataSource</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="streamsource_8h_source.html">streamsource.h</a></li>
<li>streamsource.cpp</li>
</ul>
</div><!-- contents -->
  <hr>
  <center>
    <small>
      Generated by
      <a href="http://gna.org/projects/cal3d/">The Cal3D Team</a>
      with
      <a href="http://www.doxygen.org/index.html">
      Doxygen 1.8.11
      </a>
    </small>
  </center>
</body>
</html>

APT Browse - Built by Thomas Orozco.