Updated the skeleton of some more classes.
Started documenting BStopWatch to test some things. This is probably not the final documentation of that class. I stopped the tedious work of manually converting every Windows line-endings into UNIX line-ends. If this does cause problems for anyone, let me know and I'll do it. git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@19641 a95241bf-73f2-0310-859d-f6bbb57e9c96
This commit is contained in:
Niels Sascha Reedijk
@@ -0,0 +1,53 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<sect2 id="bdataio">
|
||||||
|
<title>BDataIO</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis>Derived from:</emphasis> none</para></listitem>
|
||||||
|
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
|
||||||
|
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
|
<para><classname>BDataIO</classname> provides a base interface for reading and writing data.</para>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
|
||||||
|
<sect3 id="bdataio_constructor">
|
||||||
|
<title>BDataIO()</title>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BDataIO</methodname>
|
||||||
|
</constructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bdataio_destructor">
|
||||||
|
<title>~BDataIO()</title>
|
||||||
|
|
||||||
|
<destructorsynopsis>
|
||||||
|
<modifier>virtual</modifier><methodname>~BDataIO</methodname>
|
||||||
|
</destructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Member Functions</bridgehead>
|
||||||
|
<sect3 id="bdataio_read">
|
||||||
|
<title>Read()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname>
|
||||||
|
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
<modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bdataio_write">
|
||||||
|
<title>Write()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
<modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
</sect2>
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<sect2 id="bmallocio">
|
||||||
|
<title>BMallocIO</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem>
|
||||||
|
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
|
||||||
|
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
|
<para><classname>BMallocIO</classname> provides an interface for reading, writing and seeking in a buffer that it maintains itself.</para>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
|
||||||
|
<sect3 id="bmallocio_constructor">
|
||||||
|
<title>BMallocIO()</title>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BMallocIO</methodname>
|
||||||
|
</constructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_destructor">
|
||||||
|
<title>~BMallocIO()</title>
|
||||||
|
|
||||||
|
<destructorsynopsis>
|
||||||
|
<modifier>virtual</modifier><methodname>~BMallocIO</methodname>
|
||||||
|
</destructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Member functions</bridgehead>
|
||||||
|
<sect3 id="bmallocio_buffer">
|
||||||
|
<title>Buffer()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>const void *</type><methodname>Buffer</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_bufferlength">
|
||||||
|
<title>BufferLength()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>size_t</type><methodname>BufferLength()</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_position">
|
||||||
|
<title>Position()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_readat">
|
||||||
|
<title>ReadAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_seek">
|
||||||
|
<title>Seek()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_setblocksize">
|
||||||
|
<title>SetBlockSize()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<void/><methodname>SetBlockSize</methodname>
|
||||||
|
<methodparam><type>size_t</type><parameter>blockSize</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_setsize">
|
||||||
|
<title>SetSize()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmallocio_writeat">
|
||||||
|
<title>WriteAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
</sect2>
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<sect2 id="bmemoryio">
|
||||||
|
<title>BMemoryIO</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bpositionio"><classname>BPositionIO</classname></link></para></listitem>
|
||||||
|
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
|
||||||
|
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
|
<para><classname>BMemoryIO</classname> implements reading, writing and seeking in a data buffer.</para>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
|
||||||
|
<sect3 id="bmemoryio_constructor">
|
||||||
|
<title>BMemoryIO()</title>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BMemoryIO</methodname>
|
||||||
|
<methodparam><type>void *</type><parameter>data</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>length</parameter></methodparam>
|
||||||
|
</constructorsynopsis>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BMemoryIO</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>data</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>length</parameter></methodparam>
|
||||||
|
</constructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmemoryio_destructor">
|
||||||
|
<title>~BMemoryIO()</title>
|
||||||
|
|
||||||
|
<destructorsynopsis>
|
||||||
|
<modifier>virtual</modifier><methodname>~BMemoryIO</methodname>
|
||||||
|
</destructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Member functions</bridgehead>
|
||||||
|
<sect3 id="bmemoryio_position">
|
||||||
|
<title>Position()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmemoryio_readat">
|
||||||
|
<title>ReadAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmemoryio_seek">
|
||||||
|
<title>Seek()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmemoryio_setsize">
|
||||||
|
<title>SetSize()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bmemoryio_writeat">
|
||||||
|
<title>WriteAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
</sect2>
|
||||||
@@ -0,0 +1,112 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<sect2 id="bpositionio">
|
||||||
|
<title>BPositionIO</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis>Derived from:</emphasis><link linkend="bdataio"><classname>BDataIO</classname></link></para></listitem>
|
||||||
|
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/DataIO.h</filename></para></listitem>
|
||||||
|
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
|
<para><classname>BPositionIO</classname> provides an interface for reading, writing and seeking within data.</para>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
|
||||||
|
<sect3 id="bpositionio_constructor">
|
||||||
|
<title>BPositionIO()</title>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BPositionIO</methodname>
|
||||||
|
</constructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_destructor">
|
||||||
|
<title>~BPositionIO()</title>
|
||||||
|
|
||||||
|
<destructorsynopsis>
|
||||||
|
<modifier>virtual</modifier><methodname>~BPositionIO</methodname>
|
||||||
|
</destructorsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Member functions</bridgehead>
|
||||||
|
<sect3 id="bpositionio_getsize">
|
||||||
|
<title>GetSize()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>status_t</type><methodname>GetSize</methodname>
|
||||||
|
<methodparam><type>off_t *</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_position">
|
||||||
|
<title>Position()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Position</methodname><modifier>const</modifier><modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_read">
|
||||||
|
<title>Read()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>Read</methodname>
|
||||||
|
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_readat">
|
||||||
|
<title>ReadAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>ReadAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
<modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_seek">
|
||||||
|
<title>Seek()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>off_t</type><methodname>Seek</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><type>uint32</type><parameter>seekMode</parameter></methodparam>
|
||||||
|
<modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_setsize">
|
||||||
|
<title>SetSize()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>status_t</type><methodname>SetSize</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_write">
|
||||||
|
<title>Write()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>Write</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bpositionio_writeat">
|
||||||
|
<title>WriteAt()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<modifier>virtual</modifier><type>ssize_t</type><methodname>WriteAt</methodname>
|
||||||
|
<methodparam><type>off_t</type><parameter>position</parameter></methodparam>
|
||||||
|
<methodparam><modifier>const</modifier><type>void *</type><parameter>buffer</parameter></methodparam>
|
||||||
|
<methodparam><type>size_t</type><parameter>size</parameter></methodparam>
|
||||||
|
<modifier>= 0</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
</sect2>
|
||||||
@@ -0,0 +1,151 @@
|
|||||||
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
|
<sect2 id="bstopwatch">
|
||||||
|
<title>BStopWatch</title>
|
||||||
|
|
||||||
|
<itemizedlist>
|
||||||
|
<listitem><para><emphasis>Derived from:</emphasis> none</para></listitem>
|
||||||
|
<listitem><para><emphasis>Declared in:</emphasis> <filename>os/support/StopWatch.h</filename></para></listitem>
|
||||||
|
<listitem><para><emphasis>Library:</emphasis> <filename>libbe.so</filename></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
|
||||||
|
<para><classname>BStopWatch</classname> is a timer class.</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This class provides method to time events. The interface is designed to behave like a
|
||||||
|
physical stopwatch. It is especially useful for debugging certain parts of your code, since
|
||||||
|
it can behave like a 'cheap' profiler.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Constructors and Destructors</bridgehead>
|
||||||
|
<sect3 id="bstopwatch_constructor">
|
||||||
|
<title>BStopWatch()</title>
|
||||||
|
|
||||||
|
<constructorsynopsis>
|
||||||
|
<methodname>BStopWatch</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>name</parameter></methodparam>
|
||||||
|
<methodparam><type>bool</type><parameter>silent</parameter><initializer>false</initializer></methodparam>
|
||||||
|
</constructorsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The constructor creates a clean <classname>BStopWatch</classname> object. This object
|
||||||
|
can be given a <parameter>name</parameter>. As soon as the object is created, the time
|
||||||
|
will start ticking away. This class is designed to be usuable as a primitive profiling tool.
|
||||||
|
If you are profiling your code with this class, pass <literal>true</literal> as the
|
||||||
|
<parameter>silent</parameter> parameter. Whenever the object is destroyed, information on
|
||||||
|
the elapsed time will be streamed to standard output.
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_destructor">
|
||||||
|
<title>~BStopWatch()</title>
|
||||||
|
|
||||||
|
<destructorsynopsis>
|
||||||
|
<modifier>virtual</modifier><methodname>~BStopWatch</methodname>
|
||||||
|
</destructorsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Destroys the object. If the object was constructed with the parameter
|
||||||
|
<literal>silent</literal> set t to <literal>false</literal>, this destructor will print
|
||||||
|
information on the elapsed time to standard output.
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<bridgehead renderas="sect2">Member Functions</bridgehead>
|
||||||
|
<sect3 id="bstopwatch_elapsedtime">
|
||||||
|
<title>ElapsedTime()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>bigtime_t</type><methodname>ElapsedTime</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This method returns the elapsed time in microseconds since the object was created. If
|
||||||
|
the object is suspended, the time until the suspend will be returned.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
See also: Suspend().
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_lap">
|
||||||
|
<title>Lap</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>bigtime_t</type><methodname>Lap</methodname>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This method sets a lap. With the current implementation you are unable to actually
|
||||||
|
retrieve the timings of the laps. This is only printed to the standard output when the
|
||||||
|
object is destroyed. Thus making this tool only usuable for use when doing some
|
||||||
|
profiling.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<note><para>
|
||||||
|
Please note that the current implementation is limited to 10 laps. The value returned
|
||||||
|
is the time that has passed since the timer was started (and not the time that has
|
||||||
|
passed since the last lap). Any lap call beyond the 10th lap will overwrite the last
|
||||||
|
value. Note that if the timer is suspended, nothing happens and the method will return
|
||||||
|
<returnvalue>0</returnvalue>.
|
||||||
|
</para></note>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_name">
|
||||||
|
<title>Name()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>const char *</type><methodname>Name</methodname><modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Returns the name that was given when the object was constructed.
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_reset">
|
||||||
|
<title>Reset()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<void/><methodname>Reset</methodname>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Resets the object: it clears the start time, it clears the stored laps and it restarts
|
||||||
|
the timer.
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_resume">
|
||||||
|
<title>Resume()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<void/><methodname>Resume</methodname>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Resumes the timer when it is in a suspended state.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
See Also: Suspend().
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstopwatch_suspend">
|
||||||
|
<title>Suspend()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<void/><methodname>Suspend</methodname>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
Suspends the timer.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
See Also: Resume().
|
||||||
|
</para>
|
||||||
|
</sect3>
|
||||||
|
</sect2>
|
||||||
@@ -148,6 +148,92 @@
|
|||||||
</methodsynopsis>
|
</methodsynopsis>
|
||||||
</sect3>
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstring_findfirst">
|
||||||
|
<title>FindFirst()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>fromOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>fromOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><type>char</type><parameter>character</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindFirst</methodname>
|
||||||
|
<methodparam><type>char</type><parameter>character</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>fromOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstring_findlast">
|
||||||
|
<title>FindLast()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>beforeOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>beforeOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><type>char</type><parameter>character</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>FindLast</methodname>
|
||||||
|
<methodparam><type>char</type><parameter>character</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>beforeOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
<sect3 id="bstring_icompare">
|
<sect3 id="bstring_icompare">
|
||||||
<title>ICompare()</title>
|
<title>ICompare()</title>
|
||||||
|
|
||||||
@@ -178,6 +264,66 @@
|
|||||||
</methodsynopsis>
|
</methodsynopsis>
|
||||||
</sect3>
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstring_ifindfirst">
|
||||||
|
<title>IFindFirst()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>fromOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindFirst</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>fromOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
|
<sect3 id="bstring_ifindlast">
|
||||||
|
<title>IFindLast()</title>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>BString &</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>beforeOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
|
||||||
|
<methodsynopsis>
|
||||||
|
<type>int32</type><methodname>IFindLast</methodname>
|
||||||
|
<methodparam><modifier>const</modifier><type>char *</type><parameter>string</parameter></methodparam>
|
||||||
|
<methodparam><type>int32</type><parameter>beforeOffset</parameter></methodparam>
|
||||||
|
<modifier>const</modifier>
|
||||||
|
</methodsynopsis>
|
||||||
|
</sect3>
|
||||||
|
|
||||||
<sect3 id="bstring_insert">
|
<sect3 id="bstring_insert">
|
||||||
<title>Insert()</title>
|
<title>Insert()</title>
|
||||||
|
|
||||||
|
|||||||
@@ -5,9 +5,14 @@
|
|||||||
<!ENTITY archivable SYSTEM "Archivable.xml">
|
<!ENTITY archivable SYSTEM "Archivable.xml">
|
||||||
<!ENTITY autolock SYSTEM "Autolock.xml">
|
<!ENTITY autolock SYSTEM "Autolock.xml">
|
||||||
<!ENTITY blockcache SYSTEM "BlockCache.xml">
|
<!ENTITY blockcache SYSTEM "BlockCache.xml">
|
||||||
|
<!ENTITY dataio SYSTEM "DataIO.xml">
|
||||||
<!ENTITY flattenable SYSTEM "Flattenable.xml">
|
<!ENTITY flattenable SYSTEM "Flattenable.xml">
|
||||||
<!ENTITY list SYSTEM "List.xml">
|
<!ENTITY list SYSTEM "List.xml">
|
||||||
<!ENTITY locker SYSTEM "Locker.xml">
|
<!ENTITY locker SYSTEM "Locker.xml">
|
||||||
|
<!ENTITY mallocio SYSTEM "MallocIO.xml">
|
||||||
|
<!ENTITY memoryio SYSTEM "MemoryIO.xml">
|
||||||
|
<!ENTITY positionio SYSTEM "PositionIO.xml">
|
||||||
|
<!ENTITY stopwatch SYSTEM "StopWatch.xml">
|
||||||
<!ENTITY string SYSTEM "String.xml">
|
<!ENTITY string SYSTEM "String.xml">
|
||||||
|
|
||||||
]>
|
]>
|
||||||
@@ -17,9 +22,14 @@
|
|||||||
|
|
||||||
&archivable;
|
&archivable;
|
||||||
&autolock;
|
&autolock;
|
||||||
|
&dataio;
|
||||||
&blockcache;
|
&blockcache;
|
||||||
&flattenable;
|
&flattenable;
|
||||||
&list;
|
&list;
|
||||||
&locker;
|
&locker;
|
||||||
|
&mallocio;
|
||||||
|
&memoryio;
|
||||||
|
&positionio;
|
||||||
|
&stopwatch;
|
||||||
&string;
|
&string;
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|||||||
@@ -17,15 +17,21 @@
|
|||||||
<listitem><para> "Thread Local Storage" </para></listitem>
|
<listitem><para> "Thread Local Storage" </para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para>
|
<listitem><para>Archiving and IO:</para>
|
||||||
Archiving and IO:
|
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem><para><link linkend="barchivable">BArchivable</link></para></listitem>
|
<listitem><para><link linkend="barchivable">BArchivable</link></para></listitem>
|
||||||
<listitem><para><link linkend="bflattenable">BFlattenable</link></para></listitem>
|
<listitem><para><link linkend="bflattenable">BFlattenable</link></para></listitem>
|
||||||
<listitem><para> BDataIO and BPositionIO </para></listitem>
|
<listitem><para><link linkend="bdataio">BDataIO</link></para>
|
||||||
<listitem><para> BMemoryIO and BMallocIO </para></listitem>
|
<itemizedlist>
|
||||||
</itemizedlist>
|
<listitem><para><link linkend="bpositionio">BPositionIO</link></para>
|
||||||
</para></listitem>
|
<itemizedlist>
|
||||||
|
<listitem><para><link linkend="bmemoryio">BMemoryIO</link></para></listitem>
|
||||||
|
<listitem><para><link linkend="bmallocio">BMallocIO</link></para></listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist>
|
||||||
|
</listitem>
|
||||||
|
</itemizedlist></listitem>
|
||||||
<listitem><para>
|
<listitem><para>
|
||||||
Container classes:
|
Container classes:
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
@@ -34,7 +40,7 @@
|
|||||||
<listitem><para><link linkend="bstring">BString</link></para></listitem>
|
<listitem><para><link linkend="bstring">BString</link></para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</para></listitem>
|
</para></listitem>
|
||||||
<listitem><para> BStopWatch </para></listitem>
|
<listitem><para><link linkend="bstopwatch">BStopWatch</link></para></listitem>
|
||||||
<listitem><para> Common types and constants </para></listitem>
|
<listitem><para> Common types and constants </para></listitem>
|
||||||
<listitem><para> Error codes for all kits </para></listitem>
|
<listitem><para> Error codes for all kits </para></listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
|
|||||||
Reference in New Issue
Block a user