1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::FileStreamDataStream class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
---|
4 | <link type="text/css" rel="stylesheet" href="style.css"> |
---|
5 | </head> |
---|
6 | |
---|
7 | <body> |
---|
8 | <!-- Generated by Doxygen 1.3.6 --> |
---|
9 | <div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
---|
10 | <h1>Ogre::FileStreamDataStream Class Reference</h1>Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from std::basic_istream. |
---|
11 | <a href="#_details">More...</a> |
---|
12 | <p> |
---|
13 | <code>#include <<a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>></code> |
---|
14 | <p> |
---|
15 | <p>Inheritance diagram for Ogre::FileStreamDataStream: |
---|
16 | <p><center><img src="classOgre_1_1FileStreamDataStream.png" usemap="#Ogre::FileStreamDataStream_map" border="0" alt=""></center> |
---|
17 | <map name="Ogre::FileStreamDataStream_map"> |
---|
18 | <area href="classOgre_1_1DataStream.html" alt="Ogre::DataStream" shape="rect" coords="0,0,172,24"> |
---|
19 | </map> |
---|
20 | <a href="classOgre_1_1FileStreamDataStream-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
21 | <tr><td></td></tr> |
---|
22 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
23 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama0">FileStreamDataStream</a> (std::ifstream *s, bool freeOnClose=true)</td></tr> |
---|
24 | |
---|
25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct stream from an STL stream. <a href="#Ogre_1_1FileStreamDataStreama0"></a><br><br></td></tr> |
---|
26 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama1">FileStreamDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, std::ifstream *s, bool freeOnClose=true)</td></tr> |
---|
27 | |
---|
28 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct named stream from an STL stream. <a href="#Ogre_1_1FileStreamDataStreama1"></a><br><br></td></tr> |
---|
29 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama2">FileStreamDataStream</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &name, std::ifstream *s, size_t size, bool freeOnClose=true)</td></tr> |
---|
30 | |
---|
31 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Construct named stream from an STL stream, and tell it the size. <a href="#Ogre_1_1FileStreamDataStreama2"></a><br><br></td></tr> |
---|
32 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama3">~FileStreamDataStream</a> ()</td></tr> |
---|
33 | |
---|
34 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama4">read</a> (void *buf, size_t count)</td></tr> |
---|
35 | |
---|
36 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
37 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
38 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
39 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
40 | </table> |
---|
41 | </dl> |
---|
42 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
43 | <a href="#Ogre_1_1FileStreamDataStreama4"></a><br><br></td></tr> |
---|
44 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama5">readLine</a> (char *buf, size_t maxCount, const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
45 | |
---|
46 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Remarks:</b></dt><dd>The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character. </dd></dl> |
---|
47 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
48 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
49 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
50 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
51 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
52 | </table> |
---|
53 | </dl> |
---|
54 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
55 | <a href="#Ogre_1_1FileStreamDataStreama5"></a><br><br></td></tr> |
---|
56 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama6">skipLine</a> (const <a class="el" href="namespaceOgre.html#a471">String</a> &delim="\n")</td></tr> |
---|
57 | |
---|
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight"><dl compact><dt><b>Parameters:</b></dt><dd> |
---|
59 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
60 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
61 | </table> |
---|
62 | </dl> |
---|
63 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
64 | <a href="#Ogre_1_1FileStreamDataStreama6"></a><br><br></td></tr> |
---|
65 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama7">skip</a> (long count)</td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">This can also be a negative value, in which case the file pointer rewinds a defined number of bytes. <a href="#Ogre_1_1FileStreamDataStreama7"></a><br><br></td></tr> |
---|
68 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama8">seek</a> (size_t pos)</td></tr> |
---|
69 | |
---|
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileStreamDataStreama8"></a><br><br></td></tr> |
---|
71 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama9">tell</a> (void) const </td></tr> |
---|
72 | |
---|
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileStreamDataStreama9"></a><br><br></td></tr> |
---|
74 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama10">eof</a> (void) const </td></tr> |
---|
75 | |
---|
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileStreamDataStreama10"></a><br><br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreama11">close</a> (void)</td></tr> |
---|
78 | |
---|
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight"> <a href="#Ogre_1_1FileStreamDataStreama11"></a><br><br></td></tr> |
---|
80 | <tr><td class="memItemLeft" nowrap align=right valign=top>const <a class="el" href="namespaceOgre.html#a471">String</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama11">getName</a> (void)</td></tr> |
---|
81 | |
---|
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the stream, if it has one. <a href="#Ogre_1_1ZipDataStreama11"></a><br><br></td></tr> |
---|
83 | <tr><td class="memItemLeft" nowrap align=right valign=top>template<typename T> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama12">operator>></a> (T &val)</td></tr> |
---|
84 | |
---|
85 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama13">getLine</a> (bool trimAfter=true)</td></tr> |
---|
86 | |
---|
87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a String containing the next line of data, optionally trimmed for whitespace. <a href="#Ogre_1_1ZipDataStreama13"></a><br><br></td></tr> |
---|
88 | <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama14">getAsString</a> (void)</td></tr> |
---|
89 | |
---|
90 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a String containing the entire stream. <a href="#Ogre_1_1ZipDataStreama14"></a><br><br></td></tr> |
---|
91 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreama15">size</a> (void) const </td></tr> |
---|
92 | |
---|
93 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. <a href="#Ogre_1_1ZipDataStreama15"></a><br><br></td></tr> |
---|
94 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
95 | <tr><td class="memItemLeft" nowrap align=right valign=top>std::ifstream * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp0">mpStream</a></td></tr> |
---|
96 | |
---|
97 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Reference to source stream. <a href="#Ogre_1_1FileStreamDataStreamp0"></a><br><br></td></tr> |
---|
98 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp1">mFreeOnClose</a></td></tr> |
---|
99 | |
---|
100 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">mName</a></td></tr> |
---|
101 | |
---|
102 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The name (e.g. resource name) that can be used to identify the source fot his data (optional). <a href="#Ogre_1_1ZipDataStreamp2"></a><br><br></td></tr> |
---|
103 | <tr><td class="memItemLeft" nowrap align=right valign=top>size_t </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">mSize</a></td></tr> |
---|
104 | |
---|
105 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Size of the data in the stream (may be 0 if size cannot be determined). <a href="#Ogre_1_1ZipDataStreamp3"></a><br><br></td></tr> |
---|
106 | <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">mTmpArea</a> [OGRE_STREAM_TEMP_SIZE]</td></tr> |
---|
107 | |
---|
108 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Temporary buffer area used for formatted read. <a href="#Ogre_1_1ZipDataStreamp4"></a><br><br></td></tr> |
---|
109 | </table> |
---|
110 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
111 | Common subclass of <a class="el" href="classOgre_1_1DataStream.html">DataStream</a> for handling data from std::basic_istream. |
---|
112 | <p> |
---|
113 | |
---|
114 | <p> |
---|
115 | |
---|
116 | <p> |
---|
117 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00311">311</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> |
---|
118 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama0" doxytag="Ogre::FileStreamDataStream::FileStreamDataStream" ></a><p> |
---|
119 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
120 | <tr> |
---|
121 | <td class="mdRow"> |
---|
122 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
123 | <tr> |
---|
124 | <td class="md" nowrap valign="top"> Ogre::FileStreamDataStream::FileStreamDataStream </td> |
---|
125 | <td class="md" valign="top">( </td> |
---|
126 | <td class="md" nowrap valign="top">std::ifstream * </td> |
---|
127 | <td class="mdname" nowrap> <em>s</em>, </td> |
---|
128 | </tr> |
---|
129 | <tr> |
---|
130 | <td class="md" nowrap align="right"></td> |
---|
131 | <td></td> |
---|
132 | <td class="md" nowrap>bool </td> |
---|
133 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
134 | </tr> |
---|
135 | <tr> |
---|
136 | <td></td> |
---|
137 | <td class="md">) </td> |
---|
138 | <td class="md" colspan="2"></td> |
---|
139 | </tr> |
---|
140 | |
---|
141 | </table> |
---|
142 | </td> |
---|
143 | </tr> |
---|
144 | </table> |
---|
145 | <table cellspacing=5 cellpadding=0 border=0> |
---|
146 | <tr> |
---|
147 | <td> |
---|
148 | |
---|
149 | </td> |
---|
150 | <td> |
---|
151 | |
---|
152 | <p> |
---|
153 | Construct stream from an STL stream. |
---|
154 | <p> |
---|
155 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
156 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
157 | <tr><td valign=top><em>s</em> </td><td>Pointer to source stream </td></tr> |
---|
158 | <tr><td valign=top><em>freeOnClose</em> </td><td>Whether to delete the underlying stream on destruction of this class </td></tr> |
---|
159 | </table> |
---|
160 | </dl> |
---|
161 | </td> |
---|
162 | </tr> |
---|
163 | </table> |
---|
164 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama1" doxytag="Ogre::FileStreamDataStream::FileStreamDataStream" ></a><p> |
---|
165 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
166 | <tr> |
---|
167 | <td class="mdRow"> |
---|
168 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
169 | <tr> |
---|
170 | <td class="md" nowrap valign="top"> Ogre::FileStreamDataStream::FileStreamDataStream </td> |
---|
171 | <td class="md" valign="top">( </td> |
---|
172 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
173 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
174 | </tr> |
---|
175 | <tr> |
---|
176 | <td class="md" nowrap align="right"></td> |
---|
177 | <td></td> |
---|
178 | <td class="md" nowrap>std::ifstream * </td> |
---|
179 | <td class="mdname" nowrap> <em>s</em>, </td> |
---|
180 | </tr> |
---|
181 | <tr> |
---|
182 | <td class="md" nowrap align="right"></td> |
---|
183 | <td></td> |
---|
184 | <td class="md" nowrap>bool </td> |
---|
185 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
186 | </tr> |
---|
187 | <tr> |
---|
188 | <td></td> |
---|
189 | <td class="md">) </td> |
---|
190 | <td class="md" colspan="2"></td> |
---|
191 | </tr> |
---|
192 | |
---|
193 | </table> |
---|
194 | </td> |
---|
195 | </tr> |
---|
196 | </table> |
---|
197 | <table cellspacing=5 cellpadding=0 border=0> |
---|
198 | <tr> |
---|
199 | <td> |
---|
200 | |
---|
201 | </td> |
---|
202 | <td> |
---|
203 | |
---|
204 | <p> |
---|
205 | Construct named stream from an STL stream. |
---|
206 | <p> |
---|
207 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
208 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
209 | <tr><td valign=top><em>name</em> </td><td>The name to give this stream </td></tr> |
---|
210 | <tr><td valign=top><em>s</em> </td><td>Pointer to source stream </td></tr> |
---|
211 | <tr><td valign=top><em>freeOnClose</em> </td><td>Whether to delete the underlying stream on destruction of this class </td></tr> |
---|
212 | </table> |
---|
213 | </dl> |
---|
214 | </td> |
---|
215 | </tr> |
---|
216 | </table> |
---|
217 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama2" doxytag="Ogre::FileStreamDataStream::FileStreamDataStream" ></a><p> |
---|
218 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
219 | <tr> |
---|
220 | <td class="mdRow"> |
---|
221 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
222 | <tr> |
---|
223 | <td class="md" nowrap valign="top"> Ogre::FileStreamDataStream::FileStreamDataStream </td> |
---|
224 | <td class="md" valign="top">( </td> |
---|
225 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
226 | <td class="mdname" nowrap> <em>name</em>, </td> |
---|
227 | </tr> |
---|
228 | <tr> |
---|
229 | <td class="md" nowrap align="right"></td> |
---|
230 | <td></td> |
---|
231 | <td class="md" nowrap>std::ifstream * </td> |
---|
232 | <td class="mdname" nowrap> <em>s</em>, </td> |
---|
233 | </tr> |
---|
234 | <tr> |
---|
235 | <td class="md" nowrap align="right"></td> |
---|
236 | <td></td> |
---|
237 | <td class="md" nowrap>size_t </td> |
---|
238 | <td class="mdname" nowrap> <em>size</em>, </td> |
---|
239 | </tr> |
---|
240 | <tr> |
---|
241 | <td class="md" nowrap align="right"></td> |
---|
242 | <td></td> |
---|
243 | <td class="md" nowrap>bool </td> |
---|
244 | <td class="mdname" nowrap> <em>freeOnClose</em> = true</td> |
---|
245 | </tr> |
---|
246 | <tr> |
---|
247 | <td></td> |
---|
248 | <td class="md">) </td> |
---|
249 | <td class="md" colspan="2"></td> |
---|
250 | </tr> |
---|
251 | |
---|
252 | </table> |
---|
253 | </td> |
---|
254 | </tr> |
---|
255 | </table> |
---|
256 | <table cellspacing=5 cellpadding=0 border=0> |
---|
257 | <tr> |
---|
258 | <td> |
---|
259 | |
---|
260 | </td> |
---|
261 | <td> |
---|
262 | |
---|
263 | <p> |
---|
264 | Construct named stream from an STL stream, and tell it the size. |
---|
265 | <p> |
---|
266 | <dl compact><dt><b>Remarks:</b></dt><dd>This variant tells the class the size of the stream too, which means this class does not need to seek to the end of the stream to determine the size up-front. This can be beneficial if you have metadata about the contents of the stream already. </dd></dl> |
---|
267 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
268 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
269 | <tr><td valign=top><em>name</em> </td><td>The name to give this stream </td></tr> |
---|
270 | <tr><td valign=top><em>s</em> </td><td>Pointer to source stream </td></tr> |
---|
271 | <tr><td valign=top><em>size</em> </td><td>Size of the stream contents in bytes </td></tr> |
---|
272 | <tr><td valign=top><em>freeOnClose</em> </td><td>Whether to delete the underlying stream on destruction of this class </td></tr> |
---|
273 | </table> |
---|
274 | </dl> |
---|
275 | </td> |
---|
276 | </tr> |
---|
277 | </table> |
---|
278 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama3" doxytag="Ogre::FileStreamDataStream::~FileStreamDataStream" ></a><p> |
---|
279 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
280 | <tr> |
---|
281 | <td class="mdRow"> |
---|
282 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
283 | <tr> |
---|
284 | <td class="md" nowrap valign="top"> Ogre::FileStreamDataStream::~<a class="el" href="classOgre_1_1FileStreamDataStream.html">FileStreamDataStream</a> </td> |
---|
285 | <td class="md" valign="top">( </td> |
---|
286 | <td class="mdname1" valign="top" nowrap> </td> |
---|
287 | <td class="md" valign="top"> ) </td> |
---|
288 | <td class="md" nowrap></td> |
---|
289 | </tr> |
---|
290 | |
---|
291 | </table> |
---|
292 | </td> |
---|
293 | </tr> |
---|
294 | </table> |
---|
295 | <table cellspacing=5 cellpadding=0 border=0> |
---|
296 | <tr> |
---|
297 | <td> |
---|
298 | |
---|
299 | </td> |
---|
300 | <td> |
---|
301 | |
---|
302 | <p> |
---|
303 | </td> |
---|
304 | </tr> |
---|
305 | </table> |
---|
306 | <hr><h2>Member Function Documentation</h2> |
---|
307 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama11" doxytag="Ogre::FileStreamDataStream::close" ></a><p> |
---|
308 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
309 | <tr> |
---|
310 | <td class="mdRow"> |
---|
311 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
312 | <tr> |
---|
313 | <td class="md" nowrap valign="top"> void Ogre::FileStreamDataStream::close </td> |
---|
314 | <td class="md" valign="top">( </td> |
---|
315 | <td class="md" nowrap valign="top">void </td> |
---|
316 | <td class="mdname1" valign="top" nowrap> </td> |
---|
317 | <td class="md" valign="top"> ) </td> |
---|
318 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
319 | </tr> |
---|
320 | |
---|
321 | </table> |
---|
322 | </td> |
---|
323 | </tr> |
---|
324 | </table> |
---|
325 | <table cellspacing=5 cellpadding=0 border=0> |
---|
326 | <tr> |
---|
327 | <td> |
---|
328 | |
---|
329 | </td> |
---|
330 | <td> |
---|
331 | |
---|
332 | <p> |
---|
333 | |
---|
334 | <p> |
---|
335 | |
---|
336 | <p> |
---|
337 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama15">Ogre::DataStream</a>. </td> |
---|
338 | </tr> |
---|
339 | </table> |
---|
340 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama10" doxytag="Ogre::FileStreamDataStream::eof" ></a><p> |
---|
341 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
342 | <tr> |
---|
343 | <td class="mdRow"> |
---|
344 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
345 | <tr> |
---|
346 | <td class="md" nowrap valign="top"> bool Ogre::FileStreamDataStream::eof </td> |
---|
347 | <td class="md" valign="top">( </td> |
---|
348 | <td class="md" nowrap valign="top">void </td> |
---|
349 | <td class="mdname1" valign="top" nowrap> </td> |
---|
350 | <td class="md" valign="top"> ) </td> |
---|
351 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
352 | </tr> |
---|
353 | |
---|
354 | </table> |
---|
355 | </td> |
---|
356 | </tr> |
---|
357 | </table> |
---|
358 | <table cellspacing=5 cellpadding=0 border=0> |
---|
359 | <tr> |
---|
360 | <td> |
---|
361 | |
---|
362 | </td> |
---|
363 | <td> |
---|
364 | |
---|
365 | <p> |
---|
366 | |
---|
367 | <p> |
---|
368 | |
---|
369 | <p> |
---|
370 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama13">Ogre::DataStream</a>. </td> |
---|
371 | </tr> |
---|
372 | </table> |
---|
373 | <a class="anchor" name="Ogre_1_1ZipDataStreama14" doxytag="Ogre::FileStreamDataStream::getAsString" ></a><p> |
---|
374 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
375 | <tr> |
---|
376 | <td class="mdRow"> |
---|
377 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
378 | <tr> |
---|
379 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getAsString </td> |
---|
380 | <td class="md" valign="top">( </td> |
---|
381 | <td class="md" nowrap valign="top">void </td> |
---|
382 | <td class="mdname1" valign="top" nowrap> </td> |
---|
383 | <td class="md" valign="top"> ) </td> |
---|
384 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
385 | </tr> |
---|
386 | |
---|
387 | </table> |
---|
388 | </td> |
---|
389 | </tr> |
---|
390 | </table> |
---|
391 | <table cellspacing=5 cellpadding=0 border=0> |
---|
392 | <tr> |
---|
393 | <td> |
---|
394 | |
---|
395 | </td> |
---|
396 | <td> |
---|
397 | |
---|
398 | <p> |
---|
399 | Returns a String containing the entire stream. |
---|
400 | <p> |
---|
401 | <dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing all the data in the stream.</dd></dl> |
---|
402 | </td> |
---|
403 | </tr> |
---|
404 | </table> |
---|
405 | <a class="anchor" name="Ogre_1_1ZipDataStreama13" doxytag="Ogre::FileStreamDataStream::getLine" ></a><p> |
---|
406 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
407 | <tr> |
---|
408 | <td class="mdRow"> |
---|
409 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
410 | <tr> |
---|
411 | <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::DataStream::getLine </td> |
---|
412 | <td class="md" valign="top">( </td> |
---|
413 | <td class="md" nowrap valign="top">bool </td> |
---|
414 | <td class="mdname1" valign="top" nowrap> <em>trimAfter</em> = true </td> |
---|
415 | <td class="md" valign="top"> ) </td> |
---|
416 | <td class="md" nowrap><code> [virtual, inherited]</code></td> |
---|
417 | </tr> |
---|
418 | |
---|
419 | </table> |
---|
420 | </td> |
---|
421 | </tr> |
---|
422 | </table> |
---|
423 | <table cellspacing=5 cellpadding=0 border=0> |
---|
424 | <tr> |
---|
425 | <td> |
---|
426 | |
---|
427 | </td> |
---|
428 | <td> |
---|
429 | |
---|
430 | <p> |
---|
431 | Returns a String containing the next line of data, optionally trimmed for whitespace. |
---|
432 | <p> |
---|
433 | <dl compact><dt><b>Remarks:</b></dt><dd>This is a convenience method for text streams only, allowing you to retrieve a String object containing the next line of data. The data is read up to the next newline character and the result trimmed if required. </dd></dl> |
---|
434 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
435 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
436 | <tr><td valign=top><em>trimAfter</em> </td><td>If true, the line is trimmed for whitespace (as in String.trim(true,true))</td></tr> |
---|
437 | </table> |
---|
438 | </dl> |
---|
439 | </td> |
---|
440 | </tr> |
---|
441 | </table> |
---|
442 | <a class="anchor" name="Ogre_1_1ZipDataStreama11" doxytag="Ogre::FileStreamDataStream::getName" ></a><p> |
---|
443 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
444 | <tr> |
---|
445 | <td class="mdRow"> |
---|
446 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
447 | <tr> |
---|
448 | <td class="md" nowrap valign="top"> const <a class="el" href="namespaceOgre.html#a471">String</a>& Ogre::DataStream::getName </td> |
---|
449 | <td class="md" valign="top">( </td> |
---|
450 | <td class="md" nowrap valign="top">void </td> |
---|
451 | <td class="mdname1" valign="top" nowrap> </td> |
---|
452 | <td class="md" valign="top"> ) </td> |
---|
453 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
454 | </tr> |
---|
455 | |
---|
456 | </table> |
---|
457 | </td> |
---|
458 | </tr> |
---|
459 | </table> |
---|
460 | <table cellspacing=5 cellpadding=0 border=0> |
---|
461 | <tr> |
---|
462 | <td> |
---|
463 | |
---|
464 | </td> |
---|
465 | <td> |
---|
466 | |
---|
467 | <p> |
---|
468 | Returns the name of the stream, if it has one. |
---|
469 | <p> |
---|
470 | |
---|
471 | <p> |
---|
472 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00070">70</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. |
---|
473 | <p> |
---|
474 | References <a class="el" href="OgrePrerequisites_8h-source.html#l00156">Ogre::String</a>. </td> |
---|
475 | </tr> |
---|
476 | </table> |
---|
477 | <a class="anchor" name="Ogre_1_1ZipDataStreama12" doxytag="Ogre::FileStreamDataStream::operator>>" ></a><p> |
---|
478 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
479 | <tr> |
---|
480 | <td class="mdRow"> |
---|
481 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
482 | <tr> |
---|
483 | <td class="md" colspan="4"> |
---|
484 | template<typename T> </td> |
---|
485 | </tr> |
---|
486 | <tr> |
---|
487 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DataStream.html">DataStream</a>& Ogre::DataStream::operator>> </td> |
---|
488 | <td class="md" valign="top">( </td> |
---|
489 | <td class="md" nowrap valign="top">T & </td> |
---|
490 | <td class="mdname1" valign="top" nowrap> <em>val</em> </td> |
---|
491 | <td class="md" valign="top"> ) </td> |
---|
492 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
493 | </tr> |
---|
494 | |
---|
495 | </table> |
---|
496 | </td> |
---|
497 | </tr> |
---|
498 | </table> |
---|
499 | <table cellspacing=5 cellpadding=0 border=0> |
---|
500 | <tr> |
---|
501 | <td> |
---|
502 | |
---|
503 | </td> |
---|
504 | <td> |
---|
505 | |
---|
506 | <p> |
---|
507 | </td> |
---|
508 | </tr> |
---|
509 | </table> |
---|
510 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama4" doxytag="Ogre::FileStreamDataStream::read" ></a><p> |
---|
511 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
512 | <tr> |
---|
513 | <td class="mdRow"> |
---|
514 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
515 | <tr> |
---|
516 | <td class="md" nowrap valign="top"> size_t Ogre::FileStreamDataStream::read </td> |
---|
517 | <td class="md" valign="top">( </td> |
---|
518 | <td class="md" nowrap valign="top">void * </td> |
---|
519 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
520 | </tr> |
---|
521 | <tr> |
---|
522 | <td class="md" nowrap align="right"></td> |
---|
523 | <td></td> |
---|
524 | <td class="md" nowrap>size_t </td> |
---|
525 | <td class="mdname" nowrap> <em>count</em></td> |
---|
526 | </tr> |
---|
527 | <tr> |
---|
528 | <td></td> |
---|
529 | <td class="md">) </td> |
---|
530 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
531 | </tr> |
---|
532 | |
---|
533 | </table> |
---|
534 | </td> |
---|
535 | </tr> |
---|
536 | </table> |
---|
537 | <table cellspacing=5 cellpadding=0 border=0> |
---|
538 | <tr> |
---|
539 | <td> |
---|
540 | |
---|
541 | </td> |
---|
542 | <td> |
---|
543 | |
---|
544 | <p> |
---|
545 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
546 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
547 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
548 | <tr><td valign=top><em>count</em> </td><td>Number of bytes to read </td></tr> |
---|
549 | </table> |
---|
550 | </dl> |
---|
551 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read </dd></dl> |
---|
552 | |
---|
553 | <p> |
---|
554 | |
---|
555 | <p> |
---|
556 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama5">Ogre::DataStream</a>. </td> |
---|
557 | </tr> |
---|
558 | </table> |
---|
559 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama5" doxytag="Ogre::FileStreamDataStream::readLine" ></a><p> |
---|
560 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
561 | <tr> |
---|
562 | <td class="mdRow"> |
---|
563 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
564 | <tr> |
---|
565 | <td class="md" nowrap valign="top"> size_t Ogre::FileStreamDataStream::readLine </td> |
---|
566 | <td class="md" valign="top">( </td> |
---|
567 | <td class="md" nowrap valign="top">char * </td> |
---|
568 | <td class="mdname" nowrap> <em>buf</em>, </td> |
---|
569 | </tr> |
---|
570 | <tr> |
---|
571 | <td class="md" nowrap align="right"></td> |
---|
572 | <td></td> |
---|
573 | <td class="md" nowrap>size_t </td> |
---|
574 | <td class="mdname" nowrap> <em>maxCount</em>, </td> |
---|
575 | </tr> |
---|
576 | <tr> |
---|
577 | <td class="md" nowrap align="right"></td> |
---|
578 | <td></td> |
---|
579 | <td class="md" nowrap>const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
580 | <td class="mdname" nowrap> <em>delim</em> = "\n"</td> |
---|
581 | </tr> |
---|
582 | <tr> |
---|
583 | <td></td> |
---|
584 | <td class="md">) </td> |
---|
585 | <td class="md" colspan="2"><code> [virtual]</code></td> |
---|
586 | </tr> |
---|
587 | |
---|
588 | </table> |
---|
589 | </td> |
---|
590 | </tr> |
---|
591 | </table> |
---|
592 | <table cellspacing=5 cellpadding=0 border=0> |
---|
593 | <tr> |
---|
594 | <td> |
---|
595 | |
---|
596 | </td> |
---|
597 | <td> |
---|
598 | |
---|
599 | <p> |
---|
600 | <dl compact><dt><b>Remarks:</b></dt><dd>The delimiter character is not included in the data returned, and it is skipped over so the next read will occur after it. The buffer contents will include a terminating character. </dd></dl> |
---|
601 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
602 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
603 | <tr><td valign=top><em>buf</em> </td><td>Reference to a buffer pointer </td></tr> |
---|
604 | <tr><td valign=top><em>maxCount</em> </td><td>The maximum length of data to be read, excluding the terminating character </td></tr> |
---|
605 | <tr><td valign=top><em>delim</em> </td><td>The delimiter to stop at </td></tr> |
---|
606 | </table> |
---|
607 | </dl> |
---|
608 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes read, excluding the terminating character </dd></dl> |
---|
609 | |
---|
610 | <p> |
---|
611 | |
---|
612 | <p> |
---|
613 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama6">Ogre::DataStream</a>. </td> |
---|
614 | </tr> |
---|
615 | </table> |
---|
616 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama8" doxytag="Ogre::FileStreamDataStream::seek" ></a><p> |
---|
617 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
618 | <tr> |
---|
619 | <td class="mdRow"> |
---|
620 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
621 | <tr> |
---|
622 | <td class="md" nowrap valign="top"> void Ogre::FileStreamDataStream::seek </td> |
---|
623 | <td class="md" valign="top">( </td> |
---|
624 | <td class="md" nowrap valign="top">size_t </td> |
---|
625 | <td class="mdname1" valign="top" nowrap> <em>pos</em> </td> |
---|
626 | <td class="md" valign="top"> ) </td> |
---|
627 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
628 | </tr> |
---|
629 | |
---|
630 | </table> |
---|
631 | </td> |
---|
632 | </tr> |
---|
633 | </table> |
---|
634 | <table cellspacing=5 cellpadding=0 border=0> |
---|
635 | <tr> |
---|
636 | <td> |
---|
637 | |
---|
638 | </td> |
---|
639 | <td> |
---|
640 | |
---|
641 | <p> |
---|
642 | |
---|
643 | <p> |
---|
644 | |
---|
645 | <p> |
---|
646 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama11">Ogre::DataStream</a>. </td> |
---|
647 | </tr> |
---|
648 | </table> |
---|
649 | <a class="anchor" name="Ogre_1_1ZipDataStreama15" doxytag="Ogre::FileStreamDataStream::size" ></a><p> |
---|
650 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
651 | <tr> |
---|
652 | <td class="mdRow"> |
---|
653 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
654 | <tr> |
---|
655 | <td class="md" nowrap valign="top"> size_t Ogre::DataStream::size </td> |
---|
656 | <td class="md" valign="top">( </td> |
---|
657 | <td class="md" nowrap valign="top">void </td> |
---|
658 | <td class="mdname1" valign="top" nowrap> </td> |
---|
659 | <td class="md" valign="top"> ) </td> |
---|
660 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
661 | </tr> |
---|
662 | |
---|
663 | </table> |
---|
664 | </td> |
---|
665 | </tr> |
---|
666 | </table> |
---|
667 | <table cellspacing=5 cellpadding=0 border=0> |
---|
668 | <tr> |
---|
669 | <td> |
---|
670 | |
---|
671 | </td> |
---|
672 | <td> |
---|
673 | |
---|
674 | <p> |
---|
675 | Returns the total size of the data to be read from the stream, or 0 if this is indeterminate for this stream. |
---|
676 | <p> |
---|
677 | |
---|
678 | <p> |
---|
679 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00138">138</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
680 | </tr> |
---|
681 | </table> |
---|
682 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama7" doxytag="Ogre::FileStreamDataStream::skip" ></a><p> |
---|
683 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
684 | <tr> |
---|
685 | <td class="mdRow"> |
---|
686 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
687 | <tr> |
---|
688 | <td class="md" nowrap valign="top"> void Ogre::FileStreamDataStream::skip </td> |
---|
689 | <td class="md" valign="top">( </td> |
---|
690 | <td class="md" nowrap valign="top">long </td> |
---|
691 | <td class="mdname1" valign="top" nowrap> <em>count</em> </td> |
---|
692 | <td class="md" valign="top"> ) </td> |
---|
693 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
694 | </tr> |
---|
695 | |
---|
696 | </table> |
---|
697 | </td> |
---|
698 | </tr> |
---|
699 | </table> |
---|
700 | <table cellspacing=5 cellpadding=0 border=0> |
---|
701 | <tr> |
---|
702 | <td> |
---|
703 | |
---|
704 | </td> |
---|
705 | <td> |
---|
706 | |
---|
707 | <p> |
---|
708 | This can also be a negative value, in which case the file pointer rewinds a defined number of bytes. |
---|
709 | <p> |
---|
710 | |
---|
711 | <p> |
---|
712 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama10">Ogre::DataStream</a>. </td> |
---|
713 | </tr> |
---|
714 | </table> |
---|
715 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama6" doxytag="Ogre::FileStreamDataStream::skipLine" ></a><p> |
---|
716 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
717 | <tr> |
---|
718 | <td class="mdRow"> |
---|
719 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
720 | <tr> |
---|
721 | <td class="md" nowrap valign="top"> size_t Ogre::FileStreamDataStream::skipLine </td> |
---|
722 | <td class="md" valign="top">( </td> |
---|
723 | <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a471">String</a> & </td> |
---|
724 | <td class="mdname1" valign="top" nowrap> <em>delim</em> = "\n" </td> |
---|
725 | <td class="md" valign="top"> ) </td> |
---|
726 | <td class="md" nowrap><code> [virtual]</code></td> |
---|
727 | </tr> |
---|
728 | |
---|
729 | </table> |
---|
730 | </td> |
---|
731 | </tr> |
---|
732 | </table> |
---|
733 | <table cellspacing=5 cellpadding=0 border=0> |
---|
734 | <tr> |
---|
735 | <td> |
---|
736 | |
---|
737 | </td> |
---|
738 | <td> |
---|
739 | |
---|
740 | <p> |
---|
741 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
742 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
743 | <tr><td valign=top><em>delim</em> </td><td>The delimiter(s) to stop at </td></tr> |
---|
744 | </table> |
---|
745 | </dl> |
---|
746 | <dl compact><dt><b>Returns:</b></dt><dd>The number of bytes skipped </dd></dl> |
---|
747 | |
---|
748 | <p> |
---|
749 | |
---|
750 | <p> |
---|
751 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama9">Ogre::DataStream</a>. </td> |
---|
752 | </tr> |
---|
753 | </table> |
---|
754 | <a class="anchor" name="Ogre_1_1FileStreamDataStreama9" doxytag="Ogre::FileStreamDataStream::tell" ></a><p> |
---|
755 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
756 | <tr> |
---|
757 | <td class="mdRow"> |
---|
758 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
759 | <tr> |
---|
760 | <td class="md" nowrap valign="top"> size_t Ogre::FileStreamDataStream::tell </td> |
---|
761 | <td class="md" valign="top">( </td> |
---|
762 | <td class="md" nowrap valign="top">void </td> |
---|
763 | <td class="mdname1" valign="top" nowrap> </td> |
---|
764 | <td class="md" valign="top"> ) </td> |
---|
765 | <td class="md" nowrap> const<code> [virtual]</code></td> |
---|
766 | </tr> |
---|
767 | |
---|
768 | </table> |
---|
769 | </td> |
---|
770 | </tr> |
---|
771 | </table> |
---|
772 | <table cellspacing=5 cellpadding=0 border=0> |
---|
773 | <tr> |
---|
774 | <td> |
---|
775 | |
---|
776 | </td> |
---|
777 | <td> |
---|
778 | |
---|
779 | <p> |
---|
780 | |
---|
781 | <p> |
---|
782 | |
---|
783 | <p> |
---|
784 | Implements <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1DataStreama12">Ogre::DataStream</a>. </td> |
---|
785 | </tr> |
---|
786 | </table> |
---|
787 | <hr><h2>Member Data Documentation</h2> |
---|
788 | <a class="anchor" name="Ogre_1_1FileStreamDataStreamp1" doxytag="Ogre::FileStreamDataStream::mFreeOnClose" ></a><p> |
---|
789 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
790 | <tr> |
---|
791 | <td class="mdRow"> |
---|
792 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
793 | <tr> |
---|
794 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp1">Ogre::FileStreamDataStream::mFreeOnClose</a><code> [protected]</code> |
---|
795 | </table> |
---|
796 | </td> |
---|
797 | </tr> |
---|
798 | </table> |
---|
799 | <table cellspacing=5 cellpadding=0 border=0> |
---|
800 | <tr> |
---|
801 | <td> |
---|
802 | |
---|
803 | </td> |
---|
804 | <td> |
---|
805 | |
---|
806 | <p> |
---|
807 | |
---|
808 | <p> |
---|
809 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00316">316</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
810 | </tr> |
---|
811 | </table> |
---|
812 | <a class="anchor" name="Ogre_1_1ZipDataStreamp2" doxytag="Ogre::FileStreamDataStream::mName" ></a><p> |
---|
813 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
814 | <tr> |
---|
815 | <td class="mdRow"> |
---|
816 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
817 | <tr> |
---|
818 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp2">Ogre::DataStream::mName</a><code> [protected, inherited]</code> |
---|
819 | </table> |
---|
820 | </td> |
---|
821 | </tr> |
---|
822 | </table> |
---|
823 | <table cellspacing=5 cellpadding=0 border=0> |
---|
824 | <tr> |
---|
825 | <td> |
---|
826 | |
---|
827 | </td> |
---|
828 | <td> |
---|
829 | |
---|
830 | <p> |
---|
831 | The name (e.g. resource name) that can be used to identify the source fot his data (optional). |
---|
832 | <p> |
---|
833 | |
---|
834 | <p> |
---|
835 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00058">58</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
836 | </tr> |
---|
837 | </table> |
---|
838 | <a class="anchor" name="Ogre_1_1FileStreamDataStreamp0" doxytag="Ogre::FileStreamDataStream::mpStream" ></a><p> |
---|
839 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
840 | <tr> |
---|
841 | <td class="mdRow"> |
---|
842 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
843 | <tr> |
---|
844 | <td class="md" nowrap valign="top"> std::ifstream* <a class="el" href="classOgre_1_1FileStreamDataStream.html#Ogre_1_1FileStreamDataStreamp0">Ogre::FileStreamDataStream::mpStream</a><code> [protected]</code> |
---|
845 | </table> |
---|
846 | </td> |
---|
847 | </tr> |
---|
848 | </table> |
---|
849 | <table cellspacing=5 cellpadding=0 border=0> |
---|
850 | <tr> |
---|
851 | <td> |
---|
852 | |
---|
853 | </td> |
---|
854 | <td> |
---|
855 | |
---|
856 | <p> |
---|
857 | Reference to source stream. |
---|
858 | <p> |
---|
859 | |
---|
860 | <p> |
---|
861 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00315">315</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
862 | </tr> |
---|
863 | </table> |
---|
864 | <a class="anchor" name="Ogre_1_1ZipDataStreamp3" doxytag="Ogre::FileStreamDataStream::mSize" ></a><p> |
---|
865 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
866 | <tr> |
---|
867 | <td class="mdRow"> |
---|
868 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
869 | <tr> |
---|
870 | <td class="md" nowrap valign="top"> size_t <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp3">Ogre::DataStream::mSize</a><code> [protected, inherited]</code> |
---|
871 | </table> |
---|
872 | </td> |
---|
873 | </tr> |
---|
874 | </table> |
---|
875 | <table cellspacing=5 cellpadding=0 border=0> |
---|
876 | <tr> |
---|
877 | <td> |
---|
878 | |
---|
879 | </td> |
---|
880 | <td> |
---|
881 | |
---|
882 | <p> |
---|
883 | Size of the data in the stream (may be 0 if size cannot be determined). |
---|
884 | <p> |
---|
885 | |
---|
886 | <p> |
---|
887 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00060">60</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
888 | </tr> |
---|
889 | </table> |
---|
890 | <a class="anchor" name="Ogre_1_1ZipDataStreamp4" doxytag="Ogre::FileStreamDataStream::mTmpArea" ></a><p> |
---|
891 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
892 | <tr> |
---|
893 | <td class="mdRow"> |
---|
894 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
895 | <tr> |
---|
896 | <td class="md" nowrap valign="top"> char <a class="el" href="classOgre_1_1DataStream.html#Ogre_1_1ZipDataStreamp4">Ogre::DataStream::mTmpArea</a>[OGRE_STREAM_TEMP_SIZE]<code> [protected, inherited]</code> |
---|
897 | </table> |
---|
898 | </td> |
---|
899 | </tr> |
---|
900 | </table> |
---|
901 | <table cellspacing=5 cellpadding=0 border=0> |
---|
902 | <tr> |
---|
903 | <td> |
---|
904 | |
---|
905 | </td> |
---|
906 | <td> |
---|
907 | |
---|
908 | <p> |
---|
909 | Temporary buffer area used for formatted read. |
---|
910 | <p> |
---|
911 | |
---|
912 | <p> |
---|
913 | Definition at line <a class="el" href="OgreDataStream_8h-source.html#l00063">63</a> of file <a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a>. </td> |
---|
914 | </tr> |
---|
915 | </table> |
---|
916 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
917 | <li><a class="el" href="OgreDataStream_8h-source.html">OgreDataStream.h</a></ul> |
---|
918 | <hr> |
---|
919 | <p> |
---|
920 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
921 | <!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/> |
---|
922 | This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/> |
---|
923 | <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"> |
---|
924 | <Work rdf:about=""> |
---|
925 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
926 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
927 | </Work> |
---|
928 | <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> --> |
---|
929 | |
---|
930 | Last modified Sun Mar 12 14:38:38 2006 |
---|
931 | </p> |
---|
932 | </body> |
---|
933 | </html> |
---|