summaryrefslogtreecommitdiffstats
path: root/ue2/doxygen/classCFile.html
diff options
context:
space:
mode:
authormanuel <manuel@nc8430.lan>2009-05-02 18:58:26 +0200
committermanuel <manuel@nc8430.lan>2009-05-02 18:58:26 +0200
commit93a6590af7f866838d883d92fac655251685c3d7 (patch)
tree57401b84345a4a36cee8cca2731fe567577f29e2 /ue2/doxygen/classCFile.html
parentbc94c4be2e7e37f1f3e8892dc115e61ed6b640e7 (diff)
downloadooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.gz
ooprog-93a6590af7f866838d883d92fac655251685c3d7.tar.bz2
ooprog-93a6590af7f866838d883d92fac655251685c3d7.zip
adding doxygen files
Diffstat (limited to 'ue2/doxygen/classCFile.html')
-rw-r--r--ue2/doxygen/classCFile.html294
1 files changed, 294 insertions, 0 deletions
diff --git a/ue2/doxygen/classCFile.html b/ue2/doxygen/classCFile.html
new file mode 100644
index 0000000..960cc29
--- /dev/null
+++ b/ue2/doxygen/classCFile.html
@@ -0,0 +1,294 @@
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>imgsynth2: 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="59,56,167,80">
35<area href="classCPixmap.html" alt="CPixmap" shape="rect" coords="0,112,108,136">
36<area href="classCWindowsBitmap.html" alt="CWindowsBitmap" shape="rect" coords="118,112,226,136">
37</map>
38</div>
39
40<p>
41<a href="classCFile-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
42<tr><td></td></tr>
43<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
44<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>
45
46<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default dtor (virtual). <a href="#ebb1693f8c740d139f553b58874f82c1"></a><br></td></tr>
47<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>
48
49<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>
50<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>
51
52<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>
53<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>
54
55<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>
56<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>
57
58<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if filetype is supported by this implementation. <a href="#7a3148cb5797198cd856587bf001445f"></a><br></td></tr>
59<tr><td colspan="2"><br><h2>Protected Attributes</h2></td></tr>
60<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>
61
62<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
63<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>
64
65<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>
66</table>
67<hr><a name="_details"></a><h2>Detailed Description</h2>
68Abstract class for handling files. Needed for generic use in <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>.
69<p>
70<dl class="user" compact><dt><b>Modulname:</b></dt><dd>cfile </dd></dl>
71<dl class="author" compact><dt><b>Author:</b></dt><dd>Guenther Neuwirth (0626638), Manuel Mausz (0728348) </dd></dl>
72<dl class="date" compact><dt><b>Date:</b></dt><dd>17.04.2009</dd></dl>
73Abstract class for handling files. Needed for generic use in <a class="el" href="classCScriptparser.html" title="class for parsing simple scriptfiles">CScriptparser</a>.<p>
74In 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>
75On 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>
76<a class="anchor" name="ebb1693f8c740d139f553b58874f82c1"></a><!-- doxytag: member="CFile::~CFile" ref="ebb1693f8c740d139f553b58874f82c1" args="()" -->
77<div class="memitem">
78<div class="memproto">
79 <table class="memname">
80 <tr>
81 <td class="memname">virtual CFile::~CFile </td>
82 <td>(</td>
83 <td class="paramname"> </td>
84 <td>&nbsp;)&nbsp;</td>
85 <td width="100%"><code> [inline, virtual]</code></td>
86 </tr>
87 </table>
88</div>
89<div class="memdoc">
90
91<p>
92Default dtor (virtual).
93<p>
94<dl class="user" compact><dt><b>Methodname:</b></dt><dd>~CFile </dd></dl>
95<dl compact><dt><b>Parameters:</b></dt><dd>
96 <table border="0" cellspacing="2" cellpadding="0">
97 <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td></td></tr>
98 </table>
99</dl>
100<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
101<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
102<dl compact><dt><b>Exceptions:</b></dt><dd>
103 <table border="0" cellspacing="2" cellpadding="0">
104 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
105 </table>
106</dl>
107<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
108
109</div>
110</div><p>
111<hr><h2>Member Function Documentation</h2>
112<a class="anchor" name="fa8780b6d34045102aff06fceccaf075"></a><!-- doxytag: member="CFile::read" ref="fa8780b6d34045102aff06fceccaf075" args="(std::ifstream &amp;in)=0" -->
113<div class="memitem">
114<div class="memproto">
115 <table class="memname">
116 <tr>
117 <td class="memname">virtual void CFile::read </td>
118 <td>(</td>
119 <td class="paramtype">std::ifstream &amp;&nbsp;</td>
120 <td class="paramname"> <em>in</em> </td>
121 <td>&nbsp;)&nbsp;</td>
122 <td width="100%"><code> [pure virtual]</code></td>
123 </tr>
124 </table>
125</div>
126<div class="memdoc">
127
128<p>
129Pure virtual method (interface). Should read data from filestream.
130<p>
131<dl class="user" compact><dt><b>Methodname:</b></dt><dd>read </dd></dl>
132<dl compact><dt><b>Parameters:</b></dt><dd>
133 <table border="0" cellspacing="2" cellpadding="0">
134 <tr><td valign="top"></td><td valign="top"><em>in</em>&nbsp;</td><td>filestream to read data from </td></tr>
135 </table>
136</dl>
137<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
138<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
139<dl compact><dt><b>Exceptions:</b></dt><dd>
140 <table border="0" cellspacing="2" cellpadding="0">
141 <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>
142 </table>
143</dl>
144<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
145
146<p>Implemented in <a class="el" href="classCBitmap.html#beaf444a418973a1bf8373f236d54421">CBitmap</a>, <a class="el" href="classCPixmap.html#ef3b715729ca384e6817a3fcdddfa261">CPixmap</a>, and <a class="el" href="classCWindowsBitmap.html#cab005df5352370dd2fcb8a52738f81d">CWindowsBitmap</a>.</p>
147
148</div>
149</div><p>
150<a class="anchor" name="a77cd4604afac7b3b1384ca15ef4750e"></a><!-- doxytag: member="CFile::write" ref="a77cd4604afac7b3b1384ca15ef4750e" args="(std::ofstream &amp;out)=0" -->
151<div class="memitem">
152<div class="memproto">
153 <table class="memname">
154 <tr>
155 <td class="memname">virtual void CFile::write </td>
156 <td>(</td>
157 <td class="paramtype">std::ofstream &amp;&nbsp;</td>
158 <td class="paramname"> <em>out</em> </td>
159 <td>&nbsp;)&nbsp;</td>
160 <td width="100%"><code> [pure virtual]</code></td>
161 </tr>
162 </table>
163</div>
164<div class="memdoc">
165
166<p>
167Pure virtual method (interface). Should write data to filestream.
168<p>
169<dl class="user" compact><dt><b>Methodname:</b></dt><dd>write </dd></dl>
170<dl compact><dt><b>Parameters:</b></dt><dd>
171 <table border="0" cellspacing="2" cellpadding="0">
172 <tr><td valign="top"></td><td valign="top"><em>out</em>&nbsp;</td><td>filestream to write data to </td></tr>
173 </table>
174</dl>
175<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
176<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
177<dl compact><dt><b>Exceptions:</b></dt><dd>
178 <table border="0" cellspacing="2" cellpadding="0">
179 <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>
180 </table>
181</dl>
182<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
183
184<p>Implemented in <a class="el" href="classCBitmap.html#bfa214932af1cc21817dde3dbe3c61c6">CBitmap</a>, <a class="el" href="classCPixmap.html#507d5a88f8af0e41e418108e01572f13">CPixmap</a>, and <a class="el" href="classCWindowsBitmap.html#95c314ad2c9b14dbe5189799bc7e4f71">CWindowsBitmap</a>.</p>
185
186</div>
187</div><p>
188<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" -->
189<div class="memitem">
190<div class="memproto">
191 <table class="memname">
192 <tr>
193 <td class="memname">virtual void CFile::callFunc </td>
194 <td>(</td>
195 <td class="paramtype">const std::string &amp;&nbsp;</td>
196 <td class="paramname"> <em>func</em>, </td>
197 </tr>
198 <tr>
199 <td class="paramkey"></td>
200 <td></td>
201 <td class="paramtype">const std::list&lt; std::string &gt; &amp;&nbsp;</td>
202 <td class="paramname"> <em>params</em></td><td>&nbsp;</td>
203 </tr>
204 <tr>
205 <td></td>
206 <td>)</td>
207 <td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
208 </tr>
209 </table>
210</div>
211<div class="memdoc">
212
213<p>
214Pure virtual method (interface). Should delegate the function and its parameters to the correct internal method.
215<p>
216<dl class="user" compact><dt><b>Methodname:</b></dt><dd>callFunc </dd></dl>
217<dl compact><dt><b>Parameters:</b></dt><dd>
218 <table border="0" cellspacing="2" cellpadding="0">
219 <tr><td valign="top"></td><td valign="top"><em>func</em>&nbsp;</td><td>function name </td></tr>
220 <tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>function parameters as list </td></tr>
221 </table>
222</dl>
223<dl class="return" compact><dt><b>Returns:</b></dt><dd>- </dd></dl>
224<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
225<dl compact><dt><b>Exceptions:</b></dt><dd>
226 <table border="0" cellspacing="2" cellpadding="0">
227 <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>
228 </table>
229</dl>
230<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
231
232<p>Implemented in <a class="el" href="classCBitmap.html#9227003c492ed640ed0ea661d7d052c2">CBitmap</a>.</p>
233
234</div>
235</div><p>
236<a class="anchor" name="7a3148cb5797198cd856587bf001445f"></a><!-- doxytag: member="CFile::supportsType" ref="7a3148cb5797198cd856587bf001445f" args="(const std::string &amp;type)" -->
237<div class="memitem">
238<div class="memproto">
239 <table class="memname">
240 <tr>
241 <td class="memname">bool CFile::supportsType </td>
242 <td>(</td>
243 <td class="paramtype">const std::string &amp;&nbsp;</td>
244 <td class="paramname"> <em>type</em> </td>
245 <td>&nbsp;)&nbsp;</td>
246 <td width="100%"><code> [inline]</code></td>
247 </tr>
248 </table>
249</div>
250<div class="memdoc">
251
252<p>
253Check if filetype is supported by this implementation.
254<p>
255<dl class="user" compact><dt><b>Methodname:</b></dt><dd>supportsType </dd></dl>
256<dl compact><dt><b>Parameters:</b></dt><dd>
257 <table border="0" cellspacing="2" cellpadding="0">
258 <tr><td valign="top"></td><td valign="top"><em>type</em>&nbsp;</td><td>filetype </td></tr>
259 </table>
260</dl>
261<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if filetype is supported. false otherwise </dd></dl>
262<dl class="user" compact><dt><b>Global variables used:</b></dt><dd>none </dd></dl>
263<dl compact><dt><b>Exceptions:</b></dt><dd>
264 <table border="0" cellspacing="2" cellpadding="0">
265 <tr><td valign="top"></td><td valign="top"><em>none</em>&nbsp;</td><td></td></tr>
266 </table>
267</dl>
268<dl class="user" compact><dt><b>Conditions:</b></dt><dd>none </dd></dl>
269
270</div>
271</div><p>
272<hr><h2>Member Data Documentation</h2>
273<a class="anchor" name="63719f47953108756b34b6c7e701f536"></a><!-- doxytag: member="CFile::m_types" ref="63719f47953108756b34b6c7e701f536" args="" -->
274<div class="memitem">
275<div class="memproto">
276 <table class="memname">
277 <tr>
278 <td class="memname">std::set&lt;std::string&gt; <a class="el" href="classCFile.html#63719f47953108756b34b6c7e701f536">CFile::m_types</a><code> [protected]</code> </td>
279 </tr>
280 </table>
281</div>
282<div class="memdoc">
283
284<p>
285set of filetypes suppported by this implementation
286</div>
287</div><p>
288<hr>The documentation for this class was generated from the following file:<ul>
289<li>imgsynth2/<a class="el" href="cfile_8h-source.html">cfile.h</a></ul>
290<hr size="1"><address style="text-align: right;"><small>Generated on Sat May 2 18:58:11 2009 for imgsynth2 by&nbsp;
291<a href="http://www.doxygen.org/index.html">
292<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.3 </small></address>
293</body>
294</html>
generated by cgit v1.2.3 (git 2.25.1) at 2026-01-12 07:33:57 +0000