Difference between revisions of "EpikTimer/fr"

From Free Pascal wiki
Jump to navigationJump to search
Line 18: Line 18:
 
[http://www.opensource.org/licenses/lgpl-license.php LGPL] (please contact the author if the LGPL doesn't work with your project licensing)
 
[http://www.opensource.org/licenses/lgpl-license.php LGPL] (please contact the author if the LGPL doesn't work with your project licensing)
 
   
 
   
 +
===Subversion===
 +
 +
<pre>
 +
svn co https://lazarus-ccr.svn.sourceforge.net/svnroot/lazarus-ccr/components/epiktimer epiktimer
 +
</pre>
 +
 
=== Download ===
 
=== Download ===
 
The latest stable release can be found on the [http://sourceforge.net/project/showfiles.php?group_id=92177 Lazarus CCR Files page] or [http://sourceforge.net/project/showfiles.php?group_id=92177&package_id=98235 here].
 
The latest stable release can be found on the [http://sourceforge.net/project/showfiles.php?group_id=92177 Lazarus CCR Files page] or [http://sourceforge.net/project/showfiles.php?group_id=92177&package_id=98235 here].
Line 71: Line 77:
  
 
'''If the timer is named ET'''
 
'''If the timer is named ET'''
−
Procedure InstrumentedCall;
+
<delphi>
−
  Begin
+
uses epiktimer;
−
    ET.Clear; // optional... timer is cleared at creation
+
 
−
    ET.Start;
+
var
−
    ExecuteFirstTimedSection;
+
  ET: TEpikTimer;
−
    ET.Stop; // the timer is actually paused and can be restarted later
+
 
−
    TimedSection1:=ET.Elapsed; // store the elapsed in a global
+
procedure InitTimer;
−
    MakeAnUntimedOverheadCall; // not counted in the timer
+
begin
−
    ET.Start; //resume the timer... continue accumulating ticks
+
  ET := TEpikTimer.Create(Application);
−
    CallTimedSection2;
+
end;
−
    TimedSection2:=ET.Elapsed; //timer keeps running... we've just sample it.
+
 
−
    CallTimedSection3;
+
procedure InstrumentedCall;
−
    CallSomethingElse;
+
Begin
−
    TimedSection3:=ET.Elapsed; //keep counting... tap the elapsed
+
  ET.Clear; // optional... timer is cleared at creation
−
    CallTimedSection4;
+
  ET.Start;
−
    TimedSection4:=ET.Elapsed; //keep counting... tap the elapsed
+
  ExecuteFirstTimedSection;
−
    ET.clear // done... timer is stopped and zeroed
+
  ET.Stop; // the timer is actually paused and can be restarted later
−
  end;
+
  TimedSection1:=ET.Elapsed; // store the elapsed in a global
 +
  MakeAnUntimedOverheadCall; // not counted in the timer
 +
  ET.Start; //resume the timer... continue accumulating ticks
 +
  CallTimedSection2;
 +
  TimedSection2:=ET.Elapsed; //timer keeps running... we've just sample it.
 +
  CallTimedSection3;
 +
  CallSomethingElse;
 +
  TimedSection3:=ET.Elapsed; //keep counting... tap the elapsed
 +
  CallTimedSection4;
 +
  TimedSection4:=ET.Elapsed; //keep counting... tap the elapsed
 +
  ET.clear // done... timer is stopped and zeroed
 +
end;</delphi>
  
 
You can also create any number of timers from a single component on the form by declaring a TimerData record and passing it as a parameter to start, stop, elapsed and clear using the overloaded methods in the component. An example would be:
 
You can also create any number of timers from a single component on the form by declaring a TimerData record and passing it as a parameter to start, stop, elapsed and clear using the overloaded methods in the component. An example would be:
  
−
Function TimedExecution:Extended;
+
<delphi>Function TimedExecution: Extended;
−
  Var DiskAccessTime:TimerData;
+
Var  
−
  Begin
+
  DiskAccessTime:TimerData;
−
    ET.Clear(DiskAccessTimer); // Declared timers *must* be cleared before use.  
+
Begin
−
    ET.Start(DiskAccessTimer);
+
  ET.Clear(DiskAccessTimer); // Declared timers *must* be cleared before use.  
−
    ExecuteTheTimedSection;
+
  ET.Start(DiskAccessTimer);
−
    Result:=ET.Elapsed(DiskAccessTimer); // the timer keeps running...
+
  ExecuteTheTimedSection;
−
    etc...
+
  Result:=ET.Elapsed(DiskAccessTimer); // the timer keeps running...
 +
  etc...</delphi>
  
 
One particular use for EpikTimer is checking if a given amount of time has elapsed before continuing with a task or to another iteration of the same task.
 
One particular use for EpikTimer is checking if a given amount of time has elapsed before continuing with a task or to another iteration of the same task.
  
−
<pre>
+
<delphi>DelayInSeconds := 8.5; // or any value
−
DelayInSeconds := 8.5; // or any value
+
OldTime := ET.Elapse;
−
OldTime := ET.Elapse;
 
  
−
while ((ET.Elapsed - OldTime) < DelayInSeconds) do
+
while ((ET.Elapsed - OldTime) < DelayInSeconds) do
−
begin
+
begin
−
  ET.SystemSleep(10);
+
  ET.SystemSleep(10);
−
end;
+
end;
  
−
  // DelayInSeconds has elapsed and now you can continue executing the code
+
// DelayInSeconds has elapsed and now you can continue executing the code</delphi>
−
</pre>
 
  
 
See etdemo.pas for additional examples of component usage
 
See etdemo.pas for additional examples of component usage
 +
 +
==== EpikTimer as a profiler ====
 +
 +
EpikTimer can be used to profile the speed of procedures:
 +
 +
<delphi>
 +
uses
 +
  {$ifdef PROFILING}epiktimer,{$endif}
 +
  ...
 +
 +
type
 +
  TMyClass = class
 +
  private
 +
    {$ifdef PROFILING}
 +
    profiler: Tepiktimer;
 +
    {$endif}
 +
    ...
 +
  end;
 +
 +
implementation
 +
 +
constructor TMyClass.Create(AOwner: TComponent);
 +
begin
 +
  inherited Create(AOwner);
 +
 +
  ...
 +
 +
  {$ifdef CARDROOM_PROFILING}
 +
  profiler := TEpikTimer.Create(Self)
 +
  {$endif}
 +
end;
 +
 +
procedure TMyClass.MethodToBeProfiled;
 +
begin
 +
  {$ifdef PROFILING}
 +
  profiler.Clear;
 +
  profiler.Start;
 +
  {$endif}
 +
  // do stuff
 +
  {$ifdef PROFILING}
 +
  OPDebugLn('TMyClass.MethodToBeProfiled ' + FloatToStr(profiler.Elapsed));
 +
  {$endif}
 +
end;
 +
</delphi>
  
 
=== The ETDemo Application ===
 
=== The ETDemo Application ===
Line 127: Line 187:
 
* run
 
* run
  
−
=== Orginal contributors ===
+
=== Original contributors ===
 
This page has been converted from epikwiki. Original content by [[User:VlxAdmin|Tom Lisjac]].
 
This page has been converted from epikwiki. Original content by [[User:VlxAdmin|Tom Lisjac]].
  
 
[[Category:Components]]
 
[[Category:Components]]

Revision as of 18:29, 16 October 2010

│ Deutsch (de) │ English (en) │ français (fr) │ русский (ru) │

About

EpikTimer is a programmer's stopwatch that is capable of measuring very short events with traceably high precision over long periods of time. It's simple to use, consumes virtually no CPU and requires only 25 bytes of ram to implement a timer instance. The component provides a single internal timer... but unlimited numbers can be declared externally and linked to a single EpikTimer component on the form.

The download contains the component, an installation package and a demo application, that illustrates the features of the component along with some instrumentation for evaluating the clock sources on a given system.

This component was designed for cross-platform applications and was written specifically for the Lazarus IDE and Free Pascal Compiler and includes a demo application.

Author

Tom Lisjac

Contributors

License

LGPL (please contact the author if the LGPL doesn't work with your project licensing)

Subversion

svn co https://lazarus-ccr.svn.sourceforge.net/svnroot/lazarus-ccr/components/epiktimer epiktimer

Download

The latest stable release can be found on the Lazarus CCR Files page or here.

Status: Production/Stable

Change Log

  • Initially written on 24-06-2003 TL
  • Pre-release 30-06-2003 TL - Needs testing on the BSD's and Win32
  • Version 0.1 1-7-2003 TL
  1. initial beta release
  • Version 0.2 3-7-2003 TL
  1. Revised logic around hardware detection to prevent executing extended instructions if the HasCapabilityData call returns false.
  2. Removed exposed low level diagnositic functions from unit interface.
  3. Revised demo.
  • Version 0.3 15-11-2005
  1. Updated 0.2 version to make it compile on the latest Lazarus (0.9.10).
  2. Added LCL to the required packages.
  3. Changed mode to Delphi in order to compile.
  4. Changed windows timebase to use QueryPerformanceCounter, because has a much greater precision then GetSystemTime.
  5. Added changes to ensure the component compiles on Delphi 7.0
  6. Made tests on Windows and Linux
  7. Small changes to the demo to make it compile
  • Version 1.0 06-10-2006
  1. Changes for 64 bits operation
  2. Added units BaseUnix, Unix and UnixUtil, removed oldlinux (obsolete)
  3. Gettimeofday -> fpGettimeofday
  4. Changed systemsleep for 64 bits systems
  5. Some changes in timeval
  6. Tested on AMD64 (linux)

Dependencies / System Requirements

  • Nanosecond resolution is supported on Intel Pentium versions with a Timestamp Counter.
  • Microsecond system clock is the default timebase.

Tested on:

  • Pentium IV 3,2Mhz on Windows and Linux with great precision (~ 3,220,000,000 ticks per second)
  • Pentium 233Mhz with Damn Small Linux. Works great with hardware clock.
  • Mobile AMD 64 Athlon 3200+ on Windows XP Home (32 bit), Lazarus 9.13
  • AMD 64 CPU, running 64 bit version of Ubuntu Linux, Lazarus 9.18.

Issues: Needs testing on FreeBSD and older machines that lack TSC hardware.

Installation

  • In Components/Open Package File, open etpackage.lpk.
  • Compile the component to verify that everything is there.
  • Install and let Lazarus rebuild
  • Component will be in the System Palette (stopwatch-ruler icon)

Usage

Drop the component on a form. The component contains a single timer instance and parameterless calls to start, stop, elapsed and clear will implicitly reference it.

If the timer is named ET <delphi> uses epiktimer;

var 

 ET: TEpikTimer;

procedure InitTimer; begin 

 ET := TEpikTimer.Create(Application);

end;

procedure InstrumentedCall; Begin 

 ET.Clear; // optional... timer is cleared at creation
 ET.Start;
 ExecuteFirstTimedSection;
 ET.Stop; // the timer is actually paused and can be restarted later
 TimedSection1:=ET.Elapsed; // store the elapsed in a global
 MakeAnUntimedOverheadCall; // not counted in the timer
 ET.Start; //resume the timer... continue accumulating ticks
 CallTimedSection2;
 TimedSection2:=ET.Elapsed; //timer keeps running... we've just sample it.
 CallTimedSection3;
 CallSomethingElse;
 TimedSection3:=ET.Elapsed; //keep counting... tap the elapsed
 CallTimedSection4;
 TimedSection4:=ET.Elapsed; //keep counting... tap the elapsed
 ET.clear // done... timer is stopped and zeroed

end;</delphi>

You can also create any number of timers from a single component on the form by declaring a TimerData record and passing it as a parameter to start, stop, elapsed and clear using the overloaded methods in the component. An example would be:

<delphi>Function TimedExecution: Extended; Var 

 DiskAccessTime:TimerData;

Begin 

 ET.Clear(DiskAccessTimer); // Declared timers *must* be cleared before use. 
 ET.Start(DiskAccessTimer);
 ExecuteTheTimedSection;
 Result:=ET.Elapsed(DiskAccessTimer); // the timer keeps running...
 etc...</delphi>

One particular use for EpikTimer is checking if a given amount of time has elapsed before continuing with a task or to another iteration of the same task.

<delphi>DelayInSeconds := 8.5; // or any value OldTime := ET.Elapse;

while ((ET.Elapsed - OldTime) < DelayInSeconds) do begin 

 ET.SystemSleep(10);

end;

// DelayInSeconds has elapsed and now you can continue executing the code</delphi>

See etdemo.pas for additional examples of component usage

EpikTimer as a profiler

EpikTimer can be used to profile the speed of procedures:

<delphi> uses 

 {$ifdef PROFILING}epiktimer,{$endif}
 ...

type 

 TMyClass = class
 private
   {$ifdef PROFILING}
   profiler: Tepiktimer;
   {$endif}
   ...
 end;

implementation

constructor TMyClass.Create(AOwner: TComponent); begin 

 inherited Create(AOwner);

 ...

 {$ifdef CARDROOM_PROFILING}
 profiler := TEpikTimer.Create(Self)
 {$endif}

end;

procedure TMyClass.MethodToBeProfiled; begin 

 {$ifdef PROFILING}
 profiler.Clear;
 profiler.Start;
 {$endif}
 // do stuff
 {$ifdef PROFILING}
 OPDebugLn('TMyClass.MethodToBeProfiled ' + FloatToStr(profiler.Elapsed));
 {$endif}

end; </delphi>

The ETDemo Application

The ETDemo application does not require EpikTimer to be installed in order to compile and operate. I never liked having to install a palette full of components only to find out that I didn't like any of them! :)

Installation

  • Open etdemo.lpi
  • compile
  • run

Original contributors

This page has been converted from epikwiki. Original content by Tom Lisjac.

Retrieved from "http://wiki.freepascal.org/index.php?title=EpikTimer/fr&oldid=45787"