home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / ipipeline_profiler.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-06-18  |  2.8 KB  |  89 lines
  1. #ifndef K3DSDK_IPIPELINE_PROFILER_H
  2. #define K3DSDK_IPIPELINE_PROFILER_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2008, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "iunknown.h"
  28. #include "signal_system.h"
  29. #include "types.h"
  30.  
  31. namespace k3d
  32. {
  33.  
  34. class inode;
  35.     
  36. /// Abstract interface for an object that collects and distributes profiling data for the K-3D visualization pipeline
  37. class ipipeline_profiler :
  38.     public virtual iunknown
  39. {
  40. public:
  41.     /// Called by a node to indicate that it has begun processing the given task.  Note: it is critical that every call to start_execution() is balanced with a call to finish_execution().
  42.     virtual void start_execution(inode& Node, const string_t& Task) = 0;
  43.     /// Called by a node to indicate that it has finished processing the given task.  Note: it is critical that every call to finish_execution() matches a call to start_execution().
  44.     virtual void finish_execution(inode& Node, const string_t& Task) = 0;
  45.  
  46.     /// Called by a node to manually add a profiling entry.
  47.     virtual void add_timing_entry(inode& Node, const string_t& Task, const double TimingValue) = 0;
  48.     
  49.     /// Connects a slot that will be called to report the time in seconds that a node spent processing a given task
  50.     virtual sigc::connection connect_node_execution_signal(const sigc::slot<void, inode&, const string_t&, double>& Slot) = 0;
  51.  
  52.     /// RAII helper class that records profile information for the current scope with return- and exception-safety
  53.     class profile
  54.     {
  55.     public:
  56.         profile(ipipeline_profiler& Profiler, inode& Node, const string_t& Task) :
  57.             profiler(Profiler),
  58.             node(Node),
  59.             task(Task)
  60.         {
  61.             profiler.start_execution(node, task);
  62.         }
  63.  
  64.         ~profile()
  65.         {
  66.             profiler.finish_execution(node, task);
  67.         }
  68.         
  69.     private:
  70.         profile(const profile&);
  71.         profile& operator=(const profile&);
  72.         
  73.         ipipeline_profiler& profiler;
  74.         inode& node;
  75.         const string_t task;
  76.     };
  77.  
  78. protected:
  79.     ipipeline_profiler() {}
  80.     ipipeline_profiler(const ipipeline_profiler&) {}
  81.     ipipeline_profiler& operator=(const ipipeline_profiler&) { return *this; }
  82.     virtual ~ipipeline_profiler() {}
  83. };
  84.  
  85. } // namespace k3d
  86.  
  87. #endif // !K3DSDK_IPIPELINE_PROFILER_H
  88.  
  89.