StatusMonitor.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/StatusMonitor.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 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_StatusMonitor_h
#define __PCL_StatusMonitor_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Exception.h>
#include <pcl/String.h>
#include <pcl/Utility.h>
 
namespace pcl
{
 
class PCL_CLASS StatusMonitor;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS StatusCallback
{
public:
 
   StatusCallback() = default;
 
   StatusCallback( const StatusCallback& ) = default;
 
   StatusCallback( StatusCallback&& ) = default;
 
   virtual ~StatusCallback()
   {
   }
 
   StatusCallback& operator =( const StatusCallback& ) = default;
 
   StatusCallback& operator =( StatusCallback&& ) = default;
 
   virtual int Initialized( const StatusMonitor& monitor ) const = 0;
 
   virtual int Updated( const StatusMonitor& monitor ) const = 0;
 
   virtual int Completed( const StatusMonitor& monitor ) const = 0;
 
   virtual void InfoUpdated( const StatusMonitor& monitor ) const = 0;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS StatusMonitor
{
public:
 
   StatusMonitor() = default;
 
   StatusMonitor( const StatusMonitor& x )
   {
      Assign( x );
   }
 
   virtual ~StatusMonitor()
   {
      Clear();
   }
 
   StatusMonitor& operator =( const StatusMonitor& x )
   {
      if ( this != &x )
         Assign( x );
      return *this;
   }
 
   void Initialize( const String& info, size_type count = 0 );
 
   void DisableInitialization()
   {
      ++m_initDisableCount;
   }
 
   void EnableInitialization()
   {
      --m_initDisableCount;
   }
 
   bool IsInitializationEnabled() const
   {
      return m_initDisableCount <= 0;
   }
 
   bool IsInitialized() const
   {
      return m_initialized;
   }
 
   bool IsCompleted() const
   {
      return m_completed;
   }
 
   bool IsAborted() const
   {
      return m_aborted;
   }
 
   void SetInfo( const String& s )
   {
      m_info = s;
      if ( m_callback != nullptr )
         m_callback->InfoUpdated( *this );
   }
 
   void operator ++()
   {
      if ( ++m_count == m_total || m_needsUpdate  )
         Update();
   }
 
   void operator +=( size_type n )
   {
      m_count += n;
      if ( m_total != 0 ) // if not an unbounded monitor
         if ( m_count > m_total )
            m_count = m_total;
      if ( m_needsUpdate || m_count == m_total )
         Update();
   }
 
   void Complete()
   {
      m_count = m_total;
      Update();
   }
 
   const StatusCallback* Callback() const
   {
      return m_callback;
   }
 
   StatusCallback* Callback()
   {
      return m_callback;
   }
 
   void SetCallback( StatusCallback* callback )
   {
      Reset();
      m_callback = callback;
   }
 
   int ReturnValue() const
   {
      return m_retVal;
   }
 
   String Info() const
   {
      return m_info;
   }
 
   size_type Count() const
   {
      return m_count;
   }
 
   size_type Total() const
   {
      return m_total;
   }
 
   void Clear()
   {
      Reset();
   }
 
   static unsigned RefreshRate()
   {
      return s_msRefreshRate;
   }
 
   static void SetRefreshRate( unsigned ms );
 
private:
 
   StatusCallback* m_callback = nullptr;
   void*           m_thread = nullptr; // current thread when Initialize() was called
   bool            m_initialized = false;
   bool            m_completed = false;
   bool            m_aborted = false;
   bool            m_needsUpdate = false; // thread-safe flag set by the dispatcher
   int             m_initDisableCount = 0;
   int             m_retVal = 0;
   String          m_info;
   size_type       m_total = 0;
   size_type       m_count = 0;
 
   static unsigned s_msRefreshRate;
 
   void Reset();
   void Assign( const StatusMonitor& );
   void Update();
 
   friend class PCL_CLASS AutoStatusCallbackRestorer;
   friend class MonitorDispatcherThread;
};
 
// ----------------------------------------------------------------------------
 
}  // pcl
 
#endif   // __PCL_StatusMonitor_h
 
// ----------------------------------------------------------------------------
// EOF pcl/StatusMonitor.h - Released 2024-01-13T15:47:58Z