diff options
Diffstat (limited to 'docs/doxygen/nel/classNLMISC_1_1CTime.html')
| -rw-r--r-- | docs/doxygen/nel/classNLMISC_1_1CTime.html | 252 |
1 files changed, 252 insertions, 0 deletions
diff --git a/docs/doxygen/nel/classNLMISC_1_1CTime.html b/docs/doxygen/nel/classNLMISC_1_1CTime.html new file mode 100644 index 00000000..61c9ca87 --- /dev/null +++ b/docs/doxygen/nel/classNLMISC_1_1CTime.html @@ -0,0 +1,252 @@ +<!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>NLMISC::CTime Class Reference</h1>This class provide a independant local time system. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="time__nl_8h-source.html">time_nl.h</a>></code> +<p> +<p>Inheritance diagram for NLMISC::CTime: +<p><center><img src="classNLMISC_1_1CTime.gif" usemap="#NLMISC::CTime_map" border="0"></center> +<map name="NLMISC::CTime_map"> +<area href="classNLNET_1_1__CUniTime.html" alt="NLNET::_CUniTime" shape="rect" coords="0,56,118,80"> +</map> +<a href="classNLMISC_1_1CTime-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> +<tr><td colspan=2><br><h2>Static Public Methods</h2></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="memory__common_8h.html#a11">uint32</a> </td><td valign=bottom><a class="el" href="classNLMISC_1_1CTime.html#d0">getSecondsSince1970</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>returns the number of second since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock.</em> <a href="#d0">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a183">TTime</a> </td><td valign=bottom><a class="el" href="classNLMISC_1_1CTime.html#d1">getLocalTime</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>get the time in millisecond.</em> <a href="#d1">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a class="el" href="namespaceNLMISC.html#a184">TTicks</a> </td><td valign=bottom><a class="el" href="classNLMISC_1_1CTime.html#d2">getPerformanceTime</a> ()</td></tr> +<tr><td> </td><td><font size=-1><em>get the time in processor ticks.</em> <a href="#d2">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top>double </td><td valign=bottom><a class="el" href="classNLMISC_1_1CTime.html#d3">ticksToSecond</a> (<a class="el" href="namespaceNLMISC.html#a184">TTicks</a> ticks)</td></tr> +<tr><td> </td><td><font size=-1><em>convert a ticks count into second.</em> <a href="#d3">More...</a><em></em></font><br><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +This class provide a independant local time system. +<p> +<dl compact><dt><b> +Author: </b><dd> +Vianney Lecroart , Nevrax France </dl><dl compact><dt><b> +Date: </b><dd> +2000 </dl> +<p> + +<p> +Definition at line <a class="el" href="time__nl_8h-source.html#l00057">57</a> of file <a class="el" href="time__nl_8h-source.html">time_nl.h</a>.<hr><h2>Member Function Documentation</h2> +<a name="d1" doxytag="NLMISC::CTime::getLocalTime"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLMISC.html#a183">TTime</a> NLMISC::CTime::getLocalTime </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> +get the time in millisecond. +<p> +It's a <b>local</b> time, it means that the value is <b>different</b> on 2 differents computers. Use the CUniTime to get a universal time that is the same on all computers. <dl compact><dt><b> +Warning: </b><dd> +On Windows, the value is on 32 bits only. </dl> +<p> +Definition at line <a class="el" href="time__nl_8cpp-source.html#l00055">55</a> of file <a class="el" href="time__nl_8cpp-source.html">time_nl.cpp</a>. +<p> +References <a class="el" href="time__nl_8cpp-source.html#l00105">getPerformanceTime</a>, <a class="el" href="debug_8h-source.html#l00133">nlerror</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. +<p> +Referenced by <a class="el" href="agent__timer_8cpp-source.html#l00396">NLAIAGENT::CAgentWatchTimer::attach</a>, <a class="el" href="audio__mixer__user_8h-source.html#l00431">NLSOUND::CAudioMixerUser::curTime</a>, <a class="el" href="simple__source_8h-source.html#l00083">NLSOUND::CSimpleSource::getPlayTime</a>, <a class="el" href="complex__source_8cpp-source.html#l00365">NLSOUND::CComplexSource::getTime</a>, <a class="el" href="load__form_8h-source.html#l00113">loadForm</a>, <a class="el" href="complex__source_8cpp-source.html#l00493">NLSOUND::CComplexSource::onEvent</a>, <a class="el" href="background__source_8cpp-source.html#l00246">NLSOUND::CBackgroundSource::onEvent</a>, <a class="el" href="complex__source_8cpp-source.html#l00380">NLSOUND::CComplexSource::onUpdate</a>, <a class="el" href="background__source_8cpp-source.html#l00189">NLSOUND::CBackgroundSource::onUpdate</a>, <a class="el" href="complex__source_8cpp-source.html#l00096">NLSOUND::CComplexSource::play</a>, <a class="el" href="background__source_8cpp-source.html#l00122">NLSOUND::CBackgroundSource::play</a>, <a class="el" href="agent__timer_8cpp-source.html#l00140">NLAIAGENT::CAgentManagerTimer::CRunTimer::run</a>, <a class="el" href="agent__timer_8cpp-source.html#l00631">NLAIAGENT::CAgentClockTimer::runActivity</a>, <a class="el" href="agent__timer_8cpp-source.html#l00280">NLAIAGENT::CAgentWatchTimer::runActivity</a>, <a class="el" href="water__model_8cpp-source.html#l00816">NL3D::CWaterRenderObs::setupMaterialNVertexShader</a>, <a class="el" href="time__nl_8cpp-source.html#l00143">ticksToSecond</a>, and <a class="el" href="audio__mixer__user_8cpp-source.html#l00592">NLSOUND::CAudioMixerUser::update</a>. </td> + </tr> +</table> +<a name="d2" doxytag="NLMISC::CTime::getPerformanceTime"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="namespaceNLMISC.html#a184">TTicks</a> NLMISC::CTime::getPerformanceTime </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> +get the time in processor ticks. +<p> +Use it for profile purpose. Only implemented under windows for the time. If the performance time is not supported on this hardware, it returns 0. +<p> +Definition at line <a class="el" href="time__nl_8cpp-source.html#l00105">105</a> of file <a class="el" href="time__nl_8cpp-source.html">time_nl.cpp</a>. +<p> +References <a class="el" href="debug_8h-source.html#l00114">nlwarning</a>, <a class="el" href="time__nl_8h-source.html#l00048">NLMISC::TTicks</a>, and <a class="el" href="driver__opengl__extension__def_8h-source.html#l00233">x</a>. +<p> +Referenced by <a class="el" href="time__nl_8cpp-source.html#l00055">getLocalTime</a>, <a class="el" href="scene_8cpp-source.html#l00374">NL3D::CScene::render</a>, <a class="el" href="agent__script_8cpp-source.html#l01574">NLAIAGENT::CAgentScript::run</a>, <a class="el" href="agent__script_8cpp-source.html#l01230">NLAIAGENT::CAgentScript::sendMessage</a>, and <a class="el" href="time__nl_8cpp-source.html#l00143">ticksToSecond</a>. </td> + </tr> +</table> +<a name="d0" doxytag="NLMISC::CTime::getSecondsSince1970"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> <a class="el" href="memory__common_8h.html#a11">uint32</a> NLMISC::CTime::getSecondsSince1970 </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> +returns the number of second since midnight (00:00:00), January 1, 1970, coordinated universal time, according to the system clock. +<p> +This values is the same on all computer if computers are synchronized (with NTP for example). +<p> +Definition at line <a class="el" href="time__nl_8cpp-source.html#l00045">45</a> of file <a class="el" href="time__nl_8cpp-source.html">time_nl.cpp</a>. </td> + </tr> +</table> +<a name="d3" doxytag="NLMISC::CTime::ticksToSecond"></a><p> +<table width="100%" cellpadding="2" cellspacing="0" border="0"> + <tr> + <td class="md"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"> double NLMISC::CTime::ticksToSecond </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="namespaceNLMISC.html#a184">TTicks</a> </td> + <td class="mdname1" valign="top" nowrap> <em>ticks</em> </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> +convert a ticks count into second. +<p> +If the performance time is not supported on this hardware, it returns 0.0. +<p> +Definition at line <a class="el" href="time__nl_8cpp-source.html#l00143">143</a> of file <a class="el" href="time__nl_8cpp-source.html">time_nl.cpp</a>. +<p> +References <a class="el" href="time__nl_8cpp-source.html#l00055">getLocalTime</a>, <a class="el" href="time__nl_8cpp-source.html#l00105">getPerformanceTime</a>, <a class="el" href="time__nl_8h-source.html#l00048">NLMISC::TTicks</a>, and <a class="el" href="time__nl_8h-source.html#l00047">NLMISC::TTime</a>. +<p> +Referenced by <a class="el" href="scene_8cpp-source.html#l00374">NL3D::CScene::render</a>. </td> + </tr> +</table> +<hr>The documentation for this class was generated from the following files:<ul> +<li><a class="el" href="time__nl_8h-source.html">time_nl.h</a><li><a class="el" href="time__nl_8cpp-source.html">time_nl.cpp</a></ul> + + +<!-- 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> |