<html>
<head>
<title>Ogre::Profile class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<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> </center>
<hr><h1>Ogre::Profile Class Reference</h1>An individual profile that will be processed by the <a class="el" href="classOgre_1_1Profiler.html">Profiler</a>.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreProfiler_8h-source.html">OgreProfiler.h</a>></code>
<p>
Collaboration diagram for Ogre::Profile:<p><center><img src="classOgre_1_1Profile__coll__graph.png" border="0" usemap="#Ogre_1_1Profile__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1Profile__coll__map">
<area href="classOgre_1_1String.html" shape="rect" coords="9,36,89,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1Profile-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Profile.html#Ogre_1_1Profilea0">Profile</a> (const <a class="el" href="classOgre_1_1String.html">String</a> &profileName)</td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1Profile.html#Ogre_1_1Profilea1">~Profile</a> ()</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a> </td><td valign=bottom><a class="el" href="classOgre_1_1Profile.html#Ogre_1_1Profilen0">mName</a></td></tr>
<tr><td> </td><td><font size=-1><em>The name of this profile.</em> <a href="#Ogre_1_1Profilen0"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An individual profile that will be processed by the <a class="el" href="classOgre_1_1Profiler.html">Profiler</a>.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Use the macro <a class="el" href="OgreProfiler_8h.html#a0">OgreProfile</a>(name) instead of instantiating this profile directly <dd>
We use this <a class="el" href="classOgre_1_1Profile.html">Profile</a> to allow scoping rules to signify the beginning and end of the profile. Use the <a class="el" href="classOgre_1_1Profiler.html">Profiler</a> singleton (through the macro <a class="el" href="OgreProfiler_8h.html#a1">OgreProfileBegin</a>(name) and <a class="el" href="OgreProfiler_8h.html#a2">OgreProfileEnd</a>(name)) directly if you want a profile to last outside of a scope (ie the main game loop). </dl><dl compact><dt><b>
Author: </b><dd>
Amit Mathew (amitmathew (at) yahoo (dot) com) </dl>
<p>
<p>
Definition at line <a class="el" href="OgreProfiler_8h-source.html#l00073">73</a> of file <a class="el" href="OgreProfiler_8h-source.html">OgreProfiler.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1Profilea0" doxytag="Ogre::Profile::Profile"></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"> Ogre::Profile::Profile </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const <a class="el" href="classOgre_1_1String.html">String</a> & </td>
<td class="mdname1" valign="top" nowrap> <em>profileName</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="OgreProfiler_8cpp-source.html#l00053">53</a> of file <a class="el" href="OgreProfiler_8cpp-source.html">OgreProfiler.cpp</a>.
<p>
References <a class="el" href="OgreProfiler_8cpp-source.html#l00273">Ogre::Profiler::beginProfile</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00834">Ogre::Profiler::getSingleton</a>(), and <a class="el" href="OgreProfiler_8h-source.html#l00082">mName</a>. </td>
</tr>
</table>
<a name="Ogre_1_1Profilea1" doxytag="Ogre::Profile::~Profile"></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"> Ogre::Profile::~Profile </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="OgreProfiler_8cpp-source.html#l00061">61</a> of file <a class="el" href="OgreProfiler_8cpp-source.html">OgreProfiler.cpp</a>.
<p>
References <a class="el" href="OgreProfiler_8cpp-source.html#l00385">Ogre::Profiler::endProfile</a>(), <a class="el" href="OgreProfiler_8cpp-source.html#l00834">Ogre::Profiler::getSingleton</a>(), and <a class="el" href="OgreProfiler_8h-source.html#l00082">mName</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1Profilen0" doxytag="Ogre::Profile::mName"></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="classOgre_1_1String.html">String</a> Ogre::Profile::mName<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The name of this profile.
<p>
<p>
Definition at line <a class="el" href="OgreProfiler_8h-source.html#l00082">82</a> of file <a class="el" href="OgreProfiler_8h-source.html">OgreProfiler.h</a>.
<p>
Referenced by <a class="el" href="OgreProfiler_8cpp-source.html#l00053">Profile</a>(), and <a class="el" href="OgreProfiler_8cpp-source.html#l00061">~Profile</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreProfiler_8h-source.html">OgreProfiler.h</a><li><a class="el" href="OgreProfiler_8cpp-source.html">OgreProfiler.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:19:10 2004
</p>
</body>
</html>
