source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1DynLibManager.html @ 657

Revision 657, 18.4 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::DynLibManager 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&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>Ogre::DynLibManager Class Reference</h1>Manager for Dynamic-loading Libraries. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreDynLibManager_8h-source.html">OgreDynLibManager.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::DynLibManager:
16<p><center><img src="classOgre_1_1DynLibManager.png" usemap="#Ogre::DynLibManager_map" border="0" alt=""></center>
17<map name="Ogre::DynLibManager_map">
18<area href="classOgre_1_1Singleton.html" alt="Ogre::Singleton< DynLibManager >" shape="rect" coords="0,0,214,24">
19</map>
20<a href="classOgre_1_1DynLibManager-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>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagera0">DynLibManager</a> ()</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor.  <a href="#Ogre_1_1DynLibManagera0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagera1">~DynLibManager</a> ()</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor.  <a href="#Ogre_1_1DynLibManagera1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1DynLib.html">DynLib</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagera2">load</a> (const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;filename)</td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Loads the passed library.  <a href="#Ogre_1_1DynLibManagera2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagera3">unload</a> (<a class="el" href="classOgre_1_1DynLib.html">DynLib</a> *lib)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Unloads the passed library.  <a href="#Ogre_1_1DynLibManagera3"></a><br><br></td></tr>
35<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagere0">getSingleton</a> (void)</td></tr>
37
38<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1DynLibManagere0"></a><br><br></td></tr>
39<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagere1">getSingletonPtr</a> (void)</td></tr>
40
41<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.  <a href="#Ogre_1_1DynLibManagere1"></a><br><br></td></tr>
42<tr><td colspan=2><br><h2>Protected Types</h2></td></tr>
43<tr><td class="memItemLeft" nowrap align=right valign=top>typedef std::map&lt; <a class="el" href="namespaceOgre.html#a426">String</a>,<br>
44 <a class="el" href="classOgre_1_1DynLib.html">DynLib</a> * &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerx0">DynLibList</a></td></tr>
45
46<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
47<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerx0">DynLibList</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerp0">mLibList</a></td></tr>
48
49<tr><td colspan=2><br><h2>Static Protected Attributes</h2></td></tr>
50<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a></td></tr>
51
52</table>
53<hr><a name="_details"></a><h2>Detailed Description</h2>
54Manager for Dynamic-loading Libraries.
55<p>
56<dl compact><dt><b>Remarks:</b></dt><dd>This manager keeps a track of all the open dynamic-loading libraries, opens them and returns references to already-open libraries. </dd></dl>
57
58<p>
59
60<p>
61Definition at line <a class="el" href="OgreDynLibManager_8h-source.html#l00038">38</a> of file <a class="el" href="OgreDynLibManager_8h-source.html">OgreDynLibManager.h</a>.<hr><h2>Member Typedef Documentation</h2>
62<a class="anchor" name="Ogre_1_1DynLibManagerx0" doxytag="Ogre::DynLibManager::DynLibList" ></a><p>
63<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
64  <tr>
65    <td class="mdRow">
66      <table cellpadding="0" cellspacing="0" border="0">
67        <tr>
68          <td class="md" nowrap valign="top"> typedef std::map&lt;<a class="el" href="namespaceOgre.html#a426">String</a>, <a class="el" href="classOgre_1_1DynLib.html">DynLib</a>*&gt; <a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerx0">Ogre::DynLibManager::DynLibList</a><code> [protected]</code>
69      </table>
70    </td>
71  </tr>
72</table>
73<table cellspacing=5 cellpadding=0 border=0>
74  <tr>
75    <td>
76      &nbsp;
77    </td>
78    <td>
79
80<p>
81
82<p>
83Definition at line <a class="el" href="OgreDynLibManager_8h-source.html#l00041">41</a> of file <a class="el" href="OgreDynLibManager_8h-source.html">OgreDynLibManager.h</a>.    </td>
84  </tr>
85</table>
86<hr><h2>Constructor &amp; Destructor Documentation</h2>
87<a class="anchor" name="Ogre_1_1DynLibManagera0" doxytag="Ogre::DynLibManager::DynLibManager" ></a><p>
88<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
89  <tr>
90    <td class="mdRow">
91      <table cellpadding="0" cellspacing="0" border="0">
92        <tr>
93          <td class="md" nowrap valign="top"> Ogre::DynLibManager::DynLibManager </td>
94          <td class="md" valign="top">(&nbsp;</td>
95          <td class="mdname1" valign="top" nowrap>          </td>
96          <td class="md" valign="top">&nbsp;)&nbsp;</td>
97          <td class="md" nowrap></td>
98        </tr>
99
100      </table>
101    </td>
102  </tr>
103</table>
104<table cellspacing=5 cellpadding=0 border=0>
105  <tr>
106    <td>
107      &nbsp;
108    </td>
109    <td>
110
111<p>
112Default constructor.
113<p>
114<dl compact><dt><b>Note:</b></dt><dd><br>
115Should never be called as the singleton is automatically created during the creation of the <a class="el" href="classOgre_1_1Root.html">Root</a> object. </dd></dl>
116<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roota0">Root::Root</a> </dd></dl>
117    </td>
118  </tr>
119</table>
120<a class="anchor" name="Ogre_1_1DynLibManagera1" doxytag="Ogre::DynLibManager::~DynLibManager" ></a><p>
121<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
122  <tr>
123    <td class="mdRow">
124      <table cellpadding="0" cellspacing="0" border="0">
125        <tr>
126          <td class="md" nowrap valign="top"> virtual Ogre::DynLibManager::~<a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a> </td>
127          <td class="md" valign="top">(&nbsp;</td>
128          <td class="mdname1" valign="top" nowrap>          </td>
129          <td class="md" valign="top">&nbsp;)&nbsp;</td>
130          <td class="md" nowrap><code> [virtual]</code></td>
131        </tr>
132
133      </table>
134    </td>
135  </tr>
136</table>
137<table cellspacing=5 cellpadding=0 border=0>
138  <tr>
139    <td>
140      &nbsp;
141    </td>
142    <td>
143
144<p>
145Default destructor.
146<p>
147<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1Root.html#Ogre_1_1Roota1">Root::~Root</a> </dd></dl>
148    </td>
149  </tr>
150</table>
151<hr><h2>Member Function Documentation</h2>
152<a class="anchor" name="Ogre_1_1DynLibManagere0" doxytag="Ogre::DynLibManager::getSingleton" ></a><p>
153<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
154  <tr>
155    <td class="mdRow">
156      <table cellpadding="0" cellspacing="0" border="0">
157        <tr>
158          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a>&amp; Ogre::DynLibManager::getSingleton </td>
159          <td class="md" valign="top">(&nbsp;</td>
160          <td class="md" nowrap valign="top">void&nbsp;</td>
161          <td class="mdname1" valign="top" nowrap>          </td>
162          <td class="md" valign="top">&nbsp;)&nbsp;</td>
163          <td class="md" nowrap><code> [static]</code></td>
164        </tr>
165
166      </table>
167    </td>
168  </tr>
169</table>
170<table cellspacing=5 cellpadding=0 border=0>
171  <tr>
172    <td>
173      &nbsp;
174    </td>
175    <td>
176
177<p>
178Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
179<p>
180<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
181<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
182
183<p>
184Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone0">Ogre::Singleton&lt; DynLibManager &gt;</a>.    </td>
185  </tr>
186</table>
187<a class="anchor" name="Ogre_1_1DynLibManagere1" doxytag="Ogre::DynLibManager::getSingletonPtr" ></a><p>
188<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
189  <tr>
190    <td class="mdRow">
191      <table cellpadding="0" cellspacing="0" border="0">
192        <tr>
193          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a>* Ogre::DynLibManager::getSingletonPtr </td>
194          <td class="md" valign="top">(&nbsp;</td>
195          <td class="md" nowrap valign="top">void&nbsp;</td>
196          <td class="mdname1" valign="top" nowrap>          </td>
197          <td class="md" valign="top">&nbsp;)&nbsp;</td>
198          <td class="md" nowrap><code> [static]</code></td>
199        </tr>
200
201      </table>
202    </td>
203  </tr>
204</table>
205<table cellspacing=5 cellpadding=0 border=0>
206  <tr>
207    <td>
208      &nbsp;
209    </td>
210    <td>
211
212<p>
213Override standard <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> retrieval.
214<p>
215<dl compact><dt><b>Remarks:</b></dt><dd>Why do we do this? Well, it's because the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a> template to work, but we actually only want it compiled into the implementation of the class based on the <a class="el" href="classOgre_1_1Singleton.html">Singleton</a>, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll. </dd></dl>
216<dl compact><dt><b></b></dt><dd>This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors. </dd></dl>
217
218<p>
219Reimplemented from <a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletone1">Ogre::Singleton&lt; DynLibManager &gt;</a>.    </td>
220  </tr>
221</table>
222<a class="anchor" name="Ogre_1_1DynLibManagera2" doxytag="Ogre::DynLibManager::load" ></a><p>
223<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
224  <tr>
225    <td class="mdRow">
226      <table cellpadding="0" cellspacing="0" border="0">
227        <tr>
228          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DynLib.html">DynLib</a>* Ogre::DynLibManager::load </td>
229          <td class="md" valign="top">(&nbsp;</td>
230          <td class="md" nowrap valign="top">const <a class="el" href="namespaceOgre.html#a426">String</a> &amp;&nbsp;</td>
231          <td class="mdname1" valign="top" nowrap> <em>filename</em>          </td>
232          <td class="md" valign="top">&nbsp;)&nbsp;</td>
233          <td class="md" nowrap></td>
234        </tr>
235
236      </table>
237    </td>
238  </tr>
239</table>
240<table cellspacing=5 cellpadding=0 border=0>
241  <tr>
242    <td>
243      &nbsp;
244    </td>
245    <td>
246
247<p>
248Loads the passed library.
249<p>
250<dl compact><dt><b>Parameters:</b></dt><dd>
251  <table border="0" cellspacing="2" cellpadding="0">
252    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The name of the library. The extension can be ommitted </td></tr>
253  </table>
254</dl>
255    </td>
256  </tr>
257</table>
258<a class="anchor" name="Ogre_1_1DynLibManagera3" doxytag="Ogre::DynLibManager::unload" ></a><p>
259<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
260  <tr>
261    <td class="mdRow">
262      <table cellpadding="0" cellspacing="0" border="0">
263        <tr>
264          <td class="md" nowrap valign="top"> void Ogre::DynLibManager::unload </td>
265          <td class="md" valign="top">(&nbsp;</td>
266          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1DynLib.html">DynLib</a> *&nbsp;</td>
267          <td class="mdname1" valign="top" nowrap> <em>lib</em>          </td>
268          <td class="md" valign="top">&nbsp;)&nbsp;</td>
269          <td class="md" nowrap></td>
270        </tr>
271
272      </table>
273    </td>
274  </tr>
275</table>
276<table cellspacing=5 cellpadding=0 border=0>
277  <tr>
278    <td>
279      &nbsp;
280    </td>
281    <td>
282
283<p>
284Unloads the passed library.
285<p>
286<dl compact><dt><b>Parameters:</b></dt><dd>
287  <table border="0" cellspacing="2" cellpadding="0">
288    <tr><td valign=top><em>filename</em>&nbsp;</td><td>The name of the library. The extension can be ommitted</td></tr>
289  </table>
290</dl>
291    </td>
292  </tr>
293</table>
294<hr><h2>Member Data Documentation</h2>
295<a class="anchor" name="Ogre_1_1DynLibManagerp0" doxytag="Ogre::DynLibManager::mLibList" ></a><p>
296<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
297  <tr>
298    <td class="mdRow">
299      <table cellpadding="0" cellspacing="0" border="0">
300        <tr>
301          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerx0">DynLibList</a> <a class="el" href="classOgre_1_1DynLibManager.html#Ogre_1_1DynLibManagerp0">Ogre::DynLibManager::mLibList</a><code> [protected]</code>
302      </table>
303    </td>
304  </tr>
305</table>
306<table cellspacing=5 cellpadding=0 border=0>
307  <tr>
308    <td>
309      &nbsp;
310    </td>
311    <td>
312
313<p>
314
315<p>
316Definition at line <a class="el" href="OgreDynLibManager_8h-source.html#l00042">42</a> of file <a class="el" href="OgreDynLibManager_8h-source.html">OgreDynLibManager.h</a>.    </td>
317  </tr>
318</table>
319<a class="anchor" name="Ogre_1_1Singletont0" doxytag="Ogre::DynLibManager::ms_Singleton" ></a><p>
320<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
321  <tr>
322    <td class="mdRow">
323      <table cellpadding="0" cellspacing="0" border="0">
324        <tr>
325          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a> * <a class="el" href="classOgre_1_1Singleton.html">Ogre::Singleton</a>&lt; <a class="el" href="classOgre_1_1DynLibManager.html">DynLibManager</a>  &gt;::<a class="el" href="classOgre_1_1Singleton.html#Ogre_1_1Singletont0">ms_Singleton</a><code> [static, protected, inherited]</code>
326      </table>
327    </td>
328  </tr>
329</table>
330<table cellspacing=5 cellpadding=0 border=0>
331  <tr>
332    <td>
333      &nbsp;
334    </td>
335    <td>
336
337<p>
338
339<p>
340Definition at line <a class="el" href="OgreSingleton_8h-source.html#l00054">54</a> of file <a class="el" href="OgreSingleton_8h-source.html">OgreSingleton.h</a>.    </td>
341  </tr>
342</table>
343<hr>The documentation for this class was generated from the following file:<ul>
344<li><a class="el" href="OgreDynLibManager_8h-source.html">OgreDynLibManager.h</a></ul>
345<hr>
346<p>
347Copyright &copy; 2000-2005 by The OGRE Team<br />
348<!--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/>
349This 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/>
350                <!--/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#">
351                <Work rdf:about="">
352                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
353        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
354                </Work>
355                <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> -->
356
357Last modified Sun Feb 12 13:00:21 2006
358</p>
359</body>
360</html>
Note: See TracBrowser for help on using the repository browser.