summaryrefslogtreecommitdiffstats
path: root/ue1/doxygen/classCFile.html
diff options
context:
space:
mode:
Diffstat (limited to 'ue1/doxygen/classCFile.html')
-rw-r--r--ue1/doxygen/classCFile.html292
1 files changed, 292 insertions, 0 deletions
diff --git a/ue1/doxygen/classCFile.html b/ue1/doxygen/classCFile.html
new file mode 100644
index 0000000..729c872
--- /dev/null
+++ b/ue1/doxygen/classCFile.html
@@ -0,0 +1,292 @@
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>imgsynth: CFile Class Reference</title>
4<link href="doxygen.css" rel="stylesheet" type="text/css">
5<link href="tabs.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.3 -->
8<div class="tabs">
9 <ul>
10 <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
11 <li><a href="namespaces.html"><span>Namespaces</span></a></li>
12 <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
13 <li><a href="files.html"><span>Files</span></a></li>
14 </ul>
15</div>
16<div class="tabs">
17 <ul>
18 <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
19 <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
20 <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
21 </ul>
22</div>
23<h1>CFile Class Reference</h1><!-- doxytag: class="CFile" -->Abstract class for handling files. Needed for generic use in <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>.
24<a href="#_details">More...</a>
25<p>
26<code>#include &lt;<a class="el" href="cfile_8h-source.html">cfile.h</a>&gt;</code>
27<p>
28<div class="dynheader">
29Inheritance diagram for CFile:</div>
30<div class="dynsection">
31
32<p><center><img src="classCFile.png" usemap="#CFile_map" border="0" alt=""></center>
33<map name="CFile_map">
34<area href="classCBitmap.html" alt="CBitmap" shape="rect" coords="0,56,58,80">
35</map>
36</div>
37
38<p>
39<a href="classCFile-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
40<tr><td></td></tr>
41<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
42<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#ebb1693f8c740d139f553b58874f82c1">~CFile</a> ()</td></tr>
43
44<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor (virtual). <a href="#ebb1693f8c740d139f553b58874f82c1"></a><br></td></tr>
45<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#fa8780b6d34045102aff06fceccaf075">read</a> (std::ifstream &amp;in)=0</td></tr>
46
47<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual method (interface). Should read data from filestream. <a href="#fa8780b6d34045102aff06fceccaf075"></a><br></td></tr>
48<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#a77cd4604afac7b3b1384ca15ef4750e">write</a> (std::ofstream &amp;out)=0</td></tr>
49
50<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual method (interface). Should write data to filestream. <a href="#a77cd4604afac7b3b1384ca15ef4750e"></a><br></td></tr>
51<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#3991c5f43fab6365cc82ba80afccd791">callFunc</a> (const std::string &amp;func, const std::list&lt; std::string &gt; &amp;params)=0</td></tr>
52
53<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pure virtual method (interface). Should delegate the function and its parameters to the correct internal method. <a href="#3991c5f43fab6365cc82ba80afccd791"></a><br></td></tr>
54<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#7a3148cb5797198cd856587bf001445f">supportsType</a> (const std::string &amp;type)</td></tr>
55
56<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if filetype is supported by this implementation. <a href="#7a3148cb5797198cd856587bf001445f"></a><br></td></tr>
57<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
58<tr><td class="memItemLeft" nowrap align="right" valign="top">std::set&lt; std::string &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile.html#63719f47953108756b34b6c7e701f536">m_types</a></td></tr>
59
60<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
61<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCFile_1_1FileError.html">FileError</a></td></tr>
62
63<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Exception thrown by implemententations of <a class="el" href="classCFile.html" title="Abstract class for handling files. Needed for generic use in CScriptparser.">CFile</a>. <a href="classCFile_1_1FileError.html#_details">More...</a><br></td></tr>
64</table>
65<hr><a name="_details"></a><h2>Detailed Description</h2>
66Abstract class for handling files. Needed for generic use in <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>.
67<p>
68<dl class="user" compact><dt><b>Modulname:</b></dt><dd>cfile </dd></dl>
69<dl class="author" compact><dt><b>Author:</b></dt><dd>Manuel Mausz, 0728348 </dd></dl>
70<dl class="date" compact><dt><b>Date:</b></dt><dd>17.04.2009</dd></dl>
71Abstract class for handling files. Needed for generic use in <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>.<p>
72In order for <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a> to determine which instance of <a class="el" href="classCFile.html" title="Abstract class for handling files. Needed for generic use in CScriptparser.">CFile</a> supports which filetype, every implemententation need to insert their filetypes to the member m_types in their constructor.<p>
73On error throw <a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">FileError</a>. <hr><h2>Constructor &amp; Destructor Documentation</h2>
74<a class="anchor" name="ebb1693f8c740d139f553b58874f82c1"></a><!-- doxytag: member="CFile::~CFile" ref="ebb1693f8c740d139f553b58874f82c1" args="()" -->
75<div class="memitem">
76<div class="memproto">
77 <table class="memname">
78 <tr>
79 <td class="memname">virtual CFile::~CFile </td>
80 <td>(</td>
81 <td class="paramname"> </td>
82 <td>&nbsp;)&nbsp;</td>
83 <td width="100%"><code> [inline, virtual]</code></td>
84 </tr>
85 </table>
86</div>
87<div class="memdoc">
88
89<p>
90Default dtor (virtual).
91<p>
92<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CFile </dd></dl>
93<dl compact><dt><b>Parameters:</b></dt><dd>
94 <table border="0" cellspacing="2" cellpadding="0">
95 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
96 </table>
97</dl>
98<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
99<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
100<dl compact><dt><b>Exceptions:</b></dt><dd>
101 <table border="0" cellspacing="2" cellpadding="0">
102 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
103 </table>
104</dl>
105<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
106
107</div>
108</div><p>
109<hr><h2>Member Function Documentation</h2>
110<a class="anchor" name="fa8780b6d34045102aff06fceccaf075"></a><!-- doxytag: member="CFile::read" ref="fa8780b6d34045102aff06fceccaf075" args="(std::ifstream &amp;in)=0" -->
111<div class="memitem">
112<div class="memproto">
113 <table class="memname">
114 <tr>
115 <td class="memname">virtual void CFile::read </td>
116 <td>(</td>
117 <td class="paramtype">std::ifstream &amp;&nbsp;</td>
118 <td class="paramname"> <em>in</em> </td>
119 <td>&nbsp;)&nbsp;</td>
120 <td width="100%"><code> [pure virtual]</code></td>
121 </tr>
122 </table>
123</div>
124<div class="memdoc">
125
126<p>
127Pure virtual method (interface). Should read data from filestream.
128<p>
129<dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl>
130<dl compact><dt><b>Parameters:</b></dt><dd>
131 <table border="0" cellspacing="2" cellpadding="0">
132 <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>filestream to read data from </td></tr>
133 </table>
134</dl>
135<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
136<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
137<dl compact><dt><b>Exceptions:</b></dt><dd>
138 <table border="0" cellspacing="2" cellpadding="0">
139 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">FileError</a></em>&nbsp;</td><td></td></tr>
140 </table>
141</dl>
142<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
143
144<p>Implemented in <a class="el" href="classCBitmap.html#f52d73977516ddcc13951b972acdc29b">CBitmap</a>.</p>
145
146</div>
147</div><p>
148<a class="anchor" name="a77cd4604afac7b3b1384ca15ef4750e"></a><!-- doxytag: member="CFile::write" ref="a77cd4604afac7b3b1384ca15ef4750e" args="(std::ofstream &amp;out)=0" -->
149<div class="memitem">
150<div class="memproto">
151 <table class="memname">
152 <tr>
153 <td class="memname">virtual void CFile::write </td>
154 <td>(</td>
155 <td class="paramtype">std::ofstream &amp;&nbsp;</td>
156 <td class="paramname"> <em>out</em> </td>
157 <td>&nbsp;)&nbsp;</td>
158 <td width="100%"><code> [pure virtual]</code></td>
159 </tr>
160 </table>
161</div>
162<div class="memdoc">
163
164<p>
165Pure virtual method (interface). Should write data to filestream.
166<p>
167<dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl>
168<dl compact><dt><b>Parameters:</b></dt><dd>
169 <table border="0" cellspacing="2" cellpadding="0">
170 <tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>filestream to write data to </td></tr>
171 </table>
172</dl>
173<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
174<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
175<dl compact><dt><b>Exceptions:</b></dt><dd>
176 <table border="0" cellspacing="2" cellpadding="0">
177 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">FileError</a></em>&nbsp;</td><td></td></tr>
178 </table>
179</dl>
180<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
181
182<p>Implemented in <a class="el" href="classCBitmap.html#ce6bed4399a6d35874223ada4f802b3d">CBitmap</a>.</p>
183
184</div>
185</div><p>
186<a class="anchor" name="3991c5f43fab6365cc82ba80afccd791"></a><!-- doxytag: member="CFile::callFunc" ref="3991c5f43fab6365cc82ba80afccd791" args="(const std::string &amp;func, const std::list&lt; std::string &gt; &amp;params)=0" -->
187<div class="memitem">
188<div class="memproto">
189 <table class="memname">
190 <tr>
191 <td class="memname">virtual void CFile::callFunc </td>
192 <td>(</td>
193 <td class="paramtype">const std::string &amp;&nbsp;</td>
194 <td class="paramname"> <em>func</em>, </td>
195 </tr>
196 <tr>
197 <td class="paramkey"></td>
198 <td></td>
199 <td class="paramtype">const std::list&lt; std::string &gt; &amp;&nbsp;</td>
200 <td class="paramname"> <em>params</em></td><td>&nbsp;</td>
201 </tr>
202 <tr>
203 <td></td>
204 <td>)</td>
205 <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
206 </tr>
207 </table>
208</div>
209<div class="memdoc">
210
211<p>
212Pure virtual method (interface). Should delegate the function and its parameters to the correct internal method.
213<p>
214<dl class="user" compact><dt><b>Methodname:</b></dt><dd>callFunc </dd></dl>
215<dl compact><dt><b>Parameters:</b></dt><dd>
216 <table border="0" cellspacing="2" cellpadding="0">
217 <tr><td valign="top"></td><td valign="top"><em>func</em>&nbsp;</td><td>function name </td></tr>
218 <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>function parameters as list </td></tr>
219 </table>
220</dl>
221<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
222<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
223<dl compact><dt><b>Exceptions:</b></dt><dd>
224 <table border="0" cellspacing="2" cellpadding="0">
225 <tr><td valign="top"></td><td valign="top"><em><a class="el" href="classCFile_1_1FileError.html" title="Exception thrown by implemententations of CFile.">FileError</a></em>&nbsp;</td><td></td></tr>
226 </table>
227</dl>
228<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
229
230<p>Implemented in <a class="el" href="classCBitmap.html#9227003c492ed640ed0ea661d7d052c2">CBitmap</a>.</p>
231
232</div>
233</div><p>
234<a class="anchor" name="7a3148cb5797198cd856587bf001445f"></a><!-- doxytag: member="CFile::supportsType" ref="7a3148cb5797198cd856587bf001445f" args="(const std::string &amp;type)" -->
235<div class="memitem">
236<div class="memproto">
237 <table class="memname">
238 <tr>
239 <td class="memname">bool CFile::supportsType </td>
240 <td>(</td>
241 <td class="paramtype">const std::string &amp;&nbsp;</td>
242 <td class="paramname"> <em>type</em> </td>
243 <td>&nbsp;)&nbsp;</td>
244 <td width="100%"><code> [inline]</code></td>
245 </tr>
246 </table>
247</div>
248<div class="memdoc">
249
250<p>
251Check if filetype is supported by this implementation.
252<p>
253<dl class="user" compact><dt><b>Methodname:</b></dt><dd>supportsType </dd></dl>
254<dl compact><dt><b>Parameters:</b></dt><dd>
255 <table border="0" cellspacing="2" cellpadding="0">
256 <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>filetype </td></tr>
257 </table>
258</dl>
259<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if filetype is supported. false otherwise </dd></dl>
260<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
261<dl compact><dt><b>Exceptions:</b></dt><dd>
262 <table border="0" cellspacing="2" cellpadding="0">
263 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
264 </table>
265</dl>
266<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
267
268</div>
269</div><p>
270<hr><h2>Member Data Documentation</h2>
271<a class="anchor" name="63719f47953108756b34b6c7e701f536"></a><!-- doxytag: member="CFile::m_types" ref="63719f47953108756b34b6c7e701f536" args="" -->
272<div class="memitem">
273<div class="memproto">
274 <table class="memname">
275 <tr>
276 <td class="memname">std::set&lt;std::string&gt; <a class="el" href="classCFile.html#63719f47953108756b34b6c7e701f536">CFile::m_types</a><code> [protected]</code> </td>
277 </tr>
278 </table>
279</div>
280<div class="memdoc">
281
282<p>
283set of filetypes suppported by this implementation
284</div>
285</div><p>
286<hr>The documentation for this class was generated from the following file:<ul>
287<li>imgsynth/<a class="el" href="cfile_8h-source.html">cfile.h</a></ul>
288<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 26 12:25:52 2009 for imgsynth by&nbsp;
289<a href="http://www.doxygen.org/index.html">
290<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
291</body>
292</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-11 20:44:46 +0000