PCL
ParallelProcess.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/ParallelProcess.h - Released 2019-11-07T10:59:34Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ParallelProcess_h
53 #define __PCL_ParallelProcess_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Utility.h>
59 
60 namespace pcl
61 {
62 
63 // ----------------------------------------------------------------------------
64 
72 class PCL_CLASS ParallelProcess
73 {
74 public:
75 
82  ParallelProcess() = default;
83 
87  ParallelProcess( const ParallelProcess& ) = default;
88 
92  ParallelProcess& operator =( const ParallelProcess& ) = default;
93 
99  {
100  return m_parallel;
101  }
102 
113  void EnableParallelProcessing( bool enable = true, int maxProcessors = 0 )
114  {
115  m_parallel = enable;
116  if ( m_parallel )
117  if ( maxProcessors > 0 )
118  SetMaxProcessors( maxProcessors );
119  }
120 
128  void DisableParallelProcessing( bool disable = true )
129  {
130  EnableParallelProcessing( !disable );
131  }
132 
142  int MaxProcessors() const
143  {
144  return m_maxProcessors;
145  }
146 
160  void SetMaxProcessors( int maxProcessors )
161  {
162  m_maxProcessors = Range( maxProcessors, 1, PCL_MAX_PROCESSORS );
163  }
164 
168  void Swap( ParallelProcess& process )
169  {
170  pcl::Swap( m_maxProcessors, process.m_maxProcessors );
171  pcl::Swap( m_parallel, process.m_parallel );
172  }
173 
174 protected:
175 
176  int m_maxProcessors = PCL_MAX_PROCESSORS; // maximum number of processors allowed
177  bool m_parallel = true; // use multiple threads?
178 };
179 
180 // ----------------------------------------------------------------------------
181 
182 } // pcl
183 
184 #endif // __PCL_ParallelProcess_h
185 
186 // ----------------------------------------------------------------------------
187 // EOF pcl/ParallelProcess.h - Released 2019-11-07T10:59:34Z
void Swap(GenericPoint< T > &p1, GenericPoint< T > &p2)
Definition: Point.h:1402
PCL root namespace.
Definition: AbstractImage.h:76
bool IsParallelProcessingEnabled() const
constexpr const T & Range(const T &x, const T &a, const T &b)
Definition: Utility.h:190
void Swap(ParallelProcess &process)
void SetMaxProcessors(int maxProcessors)
void DisableParallelProcessing(bool disable=true)
A process using multiple concurrent execution threads.
void EnableParallelProcessing(bool enable=true, int maxProcessors=0)