diff options
Diffstat (limited to 'docs/doxygen/nel/async__file__manager_8h-source.html')
| -rw-r--r-- | docs/doxygen/nel/async__file__manager_8h-source.html | 176 |
1 files changed, 176 insertions, 0 deletions
diff --git a/docs/doxygen/nel/async__file__manager_8h-source.html b/docs/doxygen/nel/async__file__manager_8h-source.html new file mode 100644 index 00000000..512bffe1 --- /dev/null +++ b/docs/doxygen/nel/async__file__manager_8h-source.html @@ -0,0 +1,176 @@ +<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd"> +<HTML> +<HEAD> + <TITLE>nevrax.org : docs</TITLE> + <LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css"> + <link href="doxygen.css" rel="stylesheet" type="text/css"> +</HEAD> +<BODY MARGINHEIGHT="0" MARGINWIDTH="0"> + +<!-- uplinks --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A> </TD> + <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle> <A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A> </TD> + </TR> +</TABLE> + +<!-- banner Nevrax --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 WIDTH=100%> + <TR><TD BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR> +</TABLE> + +<!-- main table --> +<TABLE CELLSPACING=0 CELLPADDING=0 BORDER=0 height=100%> + <TR> + <TD WIDTH=16><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD> + <TD WIDTH=140 BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + + <!------ Begin Box ------> + <TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0 cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black> + <FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td colspan=2 bgcolor=#FFFFFF> + <TABLE cellspacing=0 cellpadding=1 border=0> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr> + <tr><td ALIGN=middle><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img width=18 height=12 hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr> + </TABLE> + </TD></TR></TABLE></TD></TR></TABLE> + <!------ End Box ------> + + </TD> + <TD WIDTH=15><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD> + <TD ALIGN=left valign=top><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT=""> + +<!-- title --> +<TABLE background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td> +<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A> +</td><td><IMG SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT=""> +</td></tr></table> + + +<!-- block --> +<TABLE bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0 BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD> + <TD><B>Documentation</B></TD> + <TD ALIGN=RIGHT> </td> +</tr></table> +<!-- Generated by Doxygen 1.2.14 --> +<center> +<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">Compound 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">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> </center> +<hr><h1>async_file_manager.h</h1><a href="async__file__manager_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 +00007 <font class="comment">/* Copyright, 2000 Nevrax Ltd.</font> +00008 <font class="comment"> *</font> +00009 <font class="comment"> * This file is part of NEVRAX NEL.</font> +00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font> +00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font> +00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font> +00013 <font class="comment"> * any later version.</font> +00014 <font class="comment"></font> +00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font> +00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font> +00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font> +00018 <font class="comment"> * General Public License for more details.</font> +00019 <font class="comment"></font> +00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font> +00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font> +00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font> +00023 <font class="comment"> * MA 02111-1307, USA.</font> +00024 <font class="comment"> */</font> +00025 <font class="preprocessor">#ifndef NL_ASYNC_FILE_MANAGER_H</font> +00026 <font class="preprocessor"></font><font class="preprocessor">#define NL_ASYNC_FILE_MANAGER_H</font> +00027 <font class="preprocessor"></font> +00028 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font> +00029 <font class="preprocessor">#include "<a class="code" href="task__manager_8h.html">nel/misc/task_manager.h</a>"</font> +00030 +00031 +00032 <font class="keyword">namespace </font>NLMISC +00033 { +00034 +<a name="l00041"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager.html">00041</a> <font class="keyword">class </font>CAsyncFileManager : <font class="keyword">public</font> CTaskManager +00042 { +00043 +00044 <font class="keyword">public</font>: +00045 +00046 <font class="keyword">static</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#c0">CAsyncFileManager</a> &<a class="code" href="classNLMISC_1_1CAsyncFileManager.html#d0">getInstance</a> (); <font class="comment">// Must be called instead of constructing the object</font> +00047 <font class="keyword">static</font> <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#d1">terminate</a> (); <font class="comment">// End all tasks and terminate if any tasks</font> +00048 +00049 <font class="comment">// Do not use these methods with the bigfile manager</font> +00050 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a0">loadFile</a> (<font class="keyword">const</font> std::string &fileName, uint8 **pPtr); +00051 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a1">loadFiles</a> (<font class="keyword">const</font> std::vector<std::string> &vFileNames, <font class="keyword">const</font> std::vector<uint8**> &vPtrs); +00052 +00053 +00054 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a2">signal</a> (<font class="keywordtype">bool</font> *pSgn); <font class="comment">// Signal a end of loading for a group of "mesh or file" added</font> +00055 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a3">cancelSignal</a> (<font class="keywordtype">bool</font> *pSgn); +00056 +<a name="l00065"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1ICancelCallback.html">00065</a> <font class="keyword">class </font>ICancelCallback +00066 { +00067 <font class="keyword">public</font>: +00068 <font class="keyword">virtual</font> <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1ICancelCallback.html#a0">callback</a>(<font class="keyword">const</font> IRunnable *prunnable) <font class="keyword">const</font> =0; +00069 }; +00070 +00072 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a4">addLoadTask</a>(IRunnable *ploadTask); +00076 <font class="keywordtype">bool</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#a5">cancelLoadTask</a>(<font class="keyword">const</font> ICancelCallback &cancelCallBack); +00077 +00078 <font class="keyword">private</font>: +00079 +00080 <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#c0">CAsyncFileManager</a> (); <font class="comment">// Singleton mode -> access it with the getInstance function</font> +00081 +00082 <font class="keyword">static</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager.html#c0">CAsyncFileManager</a> *<a class="code" href="classNLMISC_1_1CAsyncFileManager.html#r0">_Singleton</a>; +00083 +00084 <font class="comment">// All the tasks</font> +00085 <font class="comment">// -------------</font> +00086 +00087 <font class="comment">// Load a file</font> +<a name="l00088"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html">00088</a> <font class="keyword">class </font>CFileLoad : <font class="keyword">public</font> IRunnable +00089 { +<a name="l00090"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#o0">00090</a> std::string <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#o0">_FileName</a>; +<a name="l00091"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#o1">00091</a> uint8 **<a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#o1">_ppFile</a>; +00092 <font class="keyword">public</font>: +00093 <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#a0">CFileLoad</a> (<font class="keyword">const</font> std::string& sFileName, uint8 **ppFile); +00094 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CFileLoad.html#a1">run</a> (<font class="keywordtype">void</font>); +00095 }; +00096 +00097 <font class="comment">// Load multiple files</font> +<a name="l00098"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html">00098</a> <font class="keyword">class </font>CMultipleFileLoad : <font class="keyword">public</font> IRunnable +00099 { +<a name="l00100"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#o0">00100</a> std::vector<std::string> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#o0">_FileNames</a>; +<a name="l00101"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#o1">00101</a> std::vector<uint8**> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#o1">_Ptrs</a>; +00102 <font class="keyword">public</font>: +00103 <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#a0">CMultipleFileLoad</a> (<font class="keyword">const</font> std::vector<std::string> &vFileNames, <font class="keyword">const</font> std::vector<uint8**> &vPtrs); +00104 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CMultipleFileLoad.html#a1">run</a> (<font class="keywordtype">void</font>); +00105 }; +00106 +00107 <font class="comment">// Signal</font> +<a name="l00108"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CSignal.html">00108</a> <font class="keyword">class </font>CSignal : <font class="keyword">public</font> IRunnable +00109 { +00110 <font class="keyword">public</font>: +<a name="l00111"></a><a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CSignal.html#m0">00111</a> <font class="keywordtype">bool</font> *<a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CSignal.html#m0">Sgn</a>; +00112 <font class="keyword">public</font>: +00113 <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CSignal.html#a0">CSignal</a> (<font class="keywordtype">bool</font> *pSgn); +00114 <font class="keywordtype">void</font> <a class="code" href="classNLMISC_1_1CAsyncFileManager_1_1CSignal.html#a1">run</a> (<font class="keywordtype">void</font>); +00115 }; +00116 +00117 }; +00118 +00119 +00120 } <font class="comment">// NLMISC</font> +00121 +00122 +00123 <font class="preprocessor">#endif // NL_ASYNC_FILE_MANAGER_H</font> +00124 <font class="preprocessor"></font> +00125 <font class="comment">/* End of async_file_manager.h */</font> +</pre></div> + +<!-- footer --> +<BR><FONT Size=+5> </FONT> +</TD> +<TD WIDTH=15><IMG SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD> +</TR> +</TABLE> +</BODY> +</HTML> |