diff options
Diffstat (limited to 'docs/doxygen/nel/a02227.html')
| -rw-r--r-- | docs/doxygen/nel/a02227.html | 508 |
1 files changed, 508 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02227.html b/docs/doxygen/nel/a02227.html new file mode 100644 index 00000000..e6878460 --- /dev/null +++ b/docs/doxygen/nel/a02227.html @@ -0,0 +1,508 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>NeL: NLSOUND::CAsyncFileManagerSound class Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.3.6 --> +<div class="qindex"> <form class="search" action="search.php" method="get"> +<a class="qindex" href="main.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">Data Structures</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">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a> | <span class="search"><u>S</u>earch for <input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div> +<h1>NLSOUND::CAsyncFileManagerSound Class Reference</h1><code>#include <<a class="el" href="a05460.html">async_file_manager_sound.h</a>></code> +<p> +<hr><a name="_details"></a><h2>Detailed Description</h2> +<a class="el" href="a02227.html">CAsyncFileManagerSound</a> is a class that manage sound file loading in a seperate thread This class mostly depend on the CAsyncFileManager class for serializing async file loas request. <dl compact><dt><b>Author:</b></dt><dd>Boris Boucher <p> +Nevrax France </dd></dl> +<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl> + +<p> + +<p> +Definition at line <a class="el" href="a05460.html#l00042">42</a> of file <a class="el" href="a05460.html">async_file_manager_sound.h</a>.<table border=0 cellpadding=0 cellspacing=0> +<tr><td></td></tr> +<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda0">cancelLoadWaveFile</a> (const std::string &<a class="el" href="a04560.html#a1">filename</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda1">cancelSignal</a> (bool *pSgn)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda2">loadFile</a> (const std::string &fileName, <a class="el" href="a04558.html#a7">uint8</a> **pPtr)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda3">loadFiles</a> (const std::vector< std::string > &vFileNames, const std::vector< <a class="el" href="a04558.html#a7">uint8</a> ** > &vPtrs)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda4">loadWavFile</a> (<a class="el" href="a02298.html">IBuffer</a> *pdestBuffer, const std::string &<a class="el" href="a04560.html#a1">filename</a>)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda5">signal</a> (bool *pSgn)</td></tr> + +<tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounda6">terminate</a> ()</td></tr> + +<tr><td colspan=2><br><h2>Static Public Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02227.html">CAsyncFileManagerSound</a> & </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounde0">getInstance</a> ()</td></tr> + +<tr><td colspan=2><br><h2>Private Member Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundd0">CAsyncFileManagerSound</a> ()</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#NLSOUND_1_1CAsyncFileManagerSoundd0"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Static Private Attributes</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="a02227.html">CAsyncFileManagerSound</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Singleton instance. <a href="#NLSOUND_1_1CAsyncFileManagerSoundv0"></a><br><br></td></tr> +<tr><td colspan=2><br><h2>Friends</h2></td></tr> +<tr><td class="memItemLeft" nowrap align=right valign=top>class </td><td class="memItemRight" valign=bottom><a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundn0">CCancelLoadWavFile</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A non exported class for load canceling purpose. <a href="#NLSOUND_1_1CAsyncFileManagerSoundn0"></a><br><br></td></tr> +</table> +<hr><h2>Constructor & Destructor Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSoundd0" doxytag="NLSOUND::CAsyncFileManagerSound::CAsyncFileManagerSound" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> NLSOUND::CAsyncFileManagerSound::CAsyncFileManagerSound </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [inline, private]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Constructor. +<p> + +<p> +Definition at line <a class="el" href="a05460.html#l00061">61</a> of file <a class="el" href="a05460.html">async_file_manager_sound.h</a>. +<p> +Referenced by <a class="el" href="a05459.html#l00042">getInstance()</a>. +<p> +<div class="fragment"><pre>00061 {}; +</pre></div> </td> + </tr> +</table> +<hr><h2>Member Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda0" doxytag="NLSOUND::CAsyncFileManagerSound::cancelLoadWaveFile" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::cancelLoadWaveFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname1" valign="top" nowrap> <em>filename</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00091">91</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00092 { +00093 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"CAsyncFileManagerSound::cancelLoadWaveFile : not implemented yet !"</span>); +00094 <span class="comment">// CAsyncFileManager::getInstance().cancelLoadTask(CCancelLoadWavFile(filename));</span> +00095 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda1" doxytag="NLSOUND::CAsyncFileManagerSound::cancelSignal" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::cancelSignal </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool * </td> + <td class="mdname1" valign="top" nowrap> <em>pSgn</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00125">125</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00126 { +00127 <span class="keywordflow">if</span> (pSgn == 0) +00128 { +00129 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"CAsyncFileManagerSound::cancelSignal : trying to remove a signal with a null pointer !"</span>); +00130 <span class="keywordflow">return</span>; +00131 } +00132 CAsyncFileManager::getInstance().cancelSignal(pSgn); +00133 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounde0" doxytag="NLSOUND::CAsyncFileManagerSound::getInstance" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02227.html">CAsyncFileManagerSound</a> & NLSOUND::CAsyncFileManagerSound::getInstance </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap><code> [static]</code></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00042">42</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05460.html#l00061">CAsyncFileManagerSound()</a>. +<p> +Referenced by <a class="el" href="a05459.html#l00053">terminate()</a>. +<p> +<div class="fragment"><pre>00043 { +00044 NL_ALLOC_CONTEXT(NLSOUND_CAsyncFileManagerSound); +00045 <span class="keywordflow">if</span> (<a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a> == NULL) +00046 { +00047 <a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a> = <span class="keyword">new</span> <a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundd0">CAsyncFileManagerSound</a>(); +00048 } +00049 <span class="keywordflow">return</span> *<a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a>; +00050 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda2" doxytag="NLSOUND::CAsyncFileManagerSound::loadFile" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::loadFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::string & </td> + <td class="mdname" nowrap> <em>fileName</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap><a class="el" href="a04558.html#a7">uint8</a> ** </td> + <td class="mdname" nowrap> <em>pPtr</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00099">99</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05981.html#l00096">uint8</a>. +<p> +<div class="fragment"><pre>00100 { +00101 CAsyncFileManager::getInstance().loadFile(fileName, pPtr); +00102 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda3" doxytag="NLSOUND::CAsyncFileManagerSound::loadFiles" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::loadFiles </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const std::vector< std::string > & </td> + <td class="mdname" nowrap> <em>vFileNames</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::vector< <a class="el" href="a04558.html#a7">uint8</a> ** > & </td> + <td class="mdname" nowrap> <em>vPtrs</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00104">104</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00105 { +00106 <span class="keywordflow">if</span> (vFileNames.size() != vPtrs.size()) +00107 { +00108 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"CAsyncFileManagerSound::loadFiles : number of filenames and pointer differ ! (%u file, %u ptr)"</span>, vFileNames.size(), vPtrs.size()); +00109 <span class="comment">// ignore load request...</span> +00110 <span class="keywordflow">return</span>; +00111 } +00112 CAsyncFileManager::getInstance().loadFiles(vFileNames, vPtrs); +00113 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda4" doxytag="NLSOUND::CAsyncFileManagerSound::loadWavFile" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::loadWavFile </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="a02298.html">IBuffer</a> * </td> + <td class="mdname" nowrap> <em>pdestBuffer</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td></td> + <td class="md" nowrap>const std::string & </td> + <td class="mdname" nowrap> <em>filename</em></td> + </tr> + <tr> + <td></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00062">62</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +<div class="fragment"><pre>00063 { +00064 NL_ALLOC_CONTEXT(NLSOUND_CAsyncFileManagerSound); +00065 CAsyncFileManager::getInstance().addLoadTask(<span class="keyword">new</span> CLoadWavFile(pdestBuffer, filename)); +00066 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda5" doxytag="NLSOUND::CAsyncFileManagerSound::signal" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::signal </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">bool * </td> + <td class="mdname1" valign="top" nowrap> <em>pSgn</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00115">115</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05622.html#l00135">nlwarning</a>. +<p> +<div class="fragment"><pre>00116 { +00117 <span class="keywordflow">if</span> (pSgn == 0) +00118 { +00119 <a class="code" href="a04199.html#a2">nlwarning</a>(<span class="stringliteral">"CAsyncFileManagerSound::signal : trying to signal with a null pointer !"</span>); +00120 <span class="keywordflow">return</span>; +00121 } +00122 CAsyncFileManager::getInstance().signal(pSgn); +00123 } +</pre></div> </td> + </tr> +</table> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSounda6" doxytag="NLSOUND::CAsyncFileManagerSound::terminate" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> void NLSOUND::CAsyncFileManagerSound::terminate </td> + <td class="md" valign="top">( </td> + <td class="mdname1" valign="top" nowrap> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00053">53</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. +<p> +References <a class="el" href="a05459.html#l00042">getInstance()</a>. +<p> +<div class="fragment"><pre>00054 { +00055 <span class="keywordflow">if</span> (<a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a> != NULL) +00056 { +00057 <span class="keyword">delete</span> &<a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSounde0">getInstance</a>(); +00058 <a class="code" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">_Singleton</a> = NULL; +00059 } +00060 } +</pre></div> </td> + </tr> +</table> +<hr><h2>Friends And Related Function Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSoundn0" doxytag="NLSOUND::CAsyncFileManagerSound::CCancelLoadWavFile" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> friend class <a class="el" href="a02330.html">CCancelLoadWavFile</a><code> [friend]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +A non exported class for load canceling purpose. +<p> + +<p> +Definition at line <a class="el" href="a05460.html#l00068">68</a> of file <a class="el" href="a05460.html">async_file_manager_sound.h</a>. </td> + </tr> +</table> +<hr><h2>Field Documentation</h2> +<a class="anchor" name="NLSOUND_1_1CAsyncFileManagerSoundv0" doxytag="NLSOUND::CAsyncFileManagerSound::_Singleton" ></a><p> +<table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="a02227.html">CAsyncFileManagerSound</a> * <a class="el" href="a02227.html#NLSOUND_1_1CAsyncFileManagerSoundv0">NLSOUND::CAsyncFileManagerSound::_Singleton</a><code> [static, private]</code> + </table> + </td> + </tr> +</table> +<table cellspacing=5 cellpadding=0 border=0> + <tr> + <td> + + </td> + <td> + +<p> +Singleton instance. +<p> + +<p> +Definition at line <a class="el" href="a05459.html#l00039">39</a> of file <a class="el" href="a05459.html">async_file_manager_sound.cpp</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="a05460.html">async_file_manager_sound.h</a><li><a class="el" href="a05459.html">async_file_manager_sound.cpp</a></ul> +<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 14:28:13 2004 for NeL by +<a href="http://www.doxygen.org/index.html"> +<img src="doxygen.png" alt="doxygen" align="middle" border=0 > +</a>1.3.6 </small></address> +</body> +</html> |