Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

Common/vtkCriticalSection.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkCriticalSection.h,v $
00005   Language:  C++
00006 
00007 
00008 Copyright (c) 1993-2001 Ken Martin, Will Schroeder, Bill Lorensen 
00009 All rights reserved.
00010 
00011 Redistribution and use in source and binary forms, with or without
00012 modification, are permitted provided that the following conditions are met:
00013 
00014  * Redistributions of source code must retain the above copyright notice,
00015    this list of conditions and the following disclaimer.
00016 
00017  * Redistributions in binary form must reproduce the above copyright notice,
00018    this list of conditions and the following disclaimer in the documentation
00019    and/or other materials provided with the distribution.
00020 
00021  * Neither name of Ken Martin, Will Schroeder, or Bill Lorensen nor the names
00022    of any contributors may be used to endorse or promote products derived
00023    from this software without specific prior written permission.
00024 
00025  * Modified source versions must be plainly marked as such, and must not be
00026    misrepresented as being the original software.
00027 
00028 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00029 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00030 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00031 ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE FOR
00032 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00033 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00034 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00035 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00036 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00037 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 
00039 =========================================================================*/
00063 #ifndef __vtkCriticalSection_h
00064 #define __vtkCriticalSection_h
00065 
00066 #include "vtkObject.h"
00067 
00068 //BTX
00069 
00070 #ifdef VTK_USE_SPROC
00071 #include <abi_mutex.h>
00072 typedef abilock_t vtkCritSecType;
00073 #endif
00074 
00075 #ifdef VTK_USE_PTHREADS
00076 #include <pthread.h>
00077 typedef pthread_mutex_t vtkCritSecType;
00078 #endif
00079  
00080 #ifdef VTK_USE_WIN32_THREADS
00081 #include <winbase.h>
00082 typedef CRITICAL_SECTION vtkCritSecType;
00083 #endif
00084 
00085 #ifndef VTK_USE_SPROC
00086 #ifndef VTK_USE_PTHREADS
00087 #ifndef VTK_USE_WIN32_THREADS
00088 typedef int vtkCritSecType;
00089 #endif
00090 #endif
00091 #endif
00092 
00093 // Critical Section object that is not a vtkObject.
00094 class VTK_COMMON_EXPORT vtkSimpleCriticalSection
00095 {
00096 public:
00097   vtkSimpleCriticalSection()
00098     {
00099       this->Init();
00100     }
00101 
00102   vtkSimpleCriticalSection(int isLocked)
00103     {
00104       this->Init();
00105       if(isLocked)
00106         {
00107         this->Lock();
00108         }
00109     }
00110 
00111   void Init();
00112 
00113   virtual ~vtkSimpleCriticalSection();
00114 
00115   static vtkSimpleCriticalSection *New();
00116 
00117   // What's the point of these (here and in MutexLock)? This class
00118   // is not part of the hierarchy!! -CRV
00119   virtual const char *GetClassName() {return "vtkSimpleCriticalSection";};
00120   virtual int IsA(const char *name);
00121   static vtkSimpleCriticalSection *SafeDownCast(vtkSimpleCriticalSection *o);
00122 
00123   void Delete() {delete this;}
00124   
00126   void Lock( void );
00127 
00129   void Unlock( void );
00130 
00131 protected:
00132   vtkCritSecType   CritSec;
00133 };
00134 
00135 //ETX
00136 
00137 class VTK_COMMON_EXPORT vtkCriticalSection : public vtkObject
00138 {
00139 public:
00140   static vtkCriticalSection *New();
00141 
00142   vtkTypeMacro(vtkCriticalSection,vtkObject);
00143   void PrintSelf(ostream& os, vtkIndent indent);
00144   
00146   void Lock( void );
00147 
00149   void Unlock( void );
00150 
00151 protected:
00152   vtkSimpleCriticalSection   SimpleCriticalSection;
00153   vtkCriticalSection() {};
00154 private:
00155   vtkCriticalSection(const vtkCriticalSection&);  // Not implemented.
00156   void operator=(const vtkCriticalSection&);  // Not implemented.
00157 };
00158 
00159 
00160 inline void vtkCriticalSection::Lock( void )
00161 {
00162   this->SimpleCriticalSection.Lock();
00163 }
00164 
00165 inline void vtkCriticalSection::Unlock( void )
00166 {
00167   this->SimpleCriticalSection.Unlock();
00168 }
00169 
00170 #endif

Generated on Thu Mar 28 14:19:14 2002 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001