ParallelProcess.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.4.9
// ----------------------------------------------------------------------------
// pcl/ParallelProcess.h - Released 2021-04-09T19:40:59Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2021 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------

#ifndef __PCL_ParallelProcess_h
#define __PCL_ParallelProcess_h


#include <pcl/Defs.h>
#include <pcl/Utility.h>

namespace pcl
{

// ----------------------------------------------------------------------------

class PCL_CLASS ParallelProcess
{
public:

   ParallelProcess() = default;

   ParallelProcess( const ParallelProcess& ) = default;

   ParallelProcess& operator =( const ParallelProcess& ) = default;

   bool IsParallelProcessingEnabled() const noexcept
   {
      return m_parallel;
   }

   void EnableParallelProcessing( bool enable = true, int maxProcessors = 0 ) noexcept
   {
      m_parallel = enable;
      if ( m_parallel )
         if ( maxProcessors > 0 )
            SetMaxProcessors( maxProcessors );
   }

   void DisableParallelProcessing( bool disable = true ) noexcept
   {
      EnableParallelProcessing( !disable );
   }

   int MaxProcessors() const noexcept
   {
      return m_maxProcessors;
   }

   void SetMaxProcessors( int maxProcessors ) noexcept
   {
      m_maxProcessors = Range( maxProcessors, 1, PCL_MAX_PROCESSORS );
   }

   void Swap( ParallelProcess& process ) noexcept
   {
      pcl::Swap( m_maxProcessors, process.m_maxProcessors );
      pcl::Swap( m_parallel, process.m_parallel );
   }

protected:

   int  m_maxProcessors = PCL_MAX_PROCESSORS; // maximum number of processors allowed
   bool m_parallel = true; // use multiple threads?
};

// ----------------------------------------------------------------------------

} // pcl

#endif   // __PCL_ParallelProcess_h

// ----------------------------------------------------------------------------
// EOF pcl/ParallelProcess.h - Released 2021-04-09T19:40:59Z