PCL
StatusMonitor.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/StatusMonitor.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_StatusMonitor_h
53 #define __PCL_StatusMonitor_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/Exception.h>
60 #include <pcl/String.h>
61 #include <pcl/Utility.h>
62 
63 namespace pcl
64 {
65 
66 class PCL_CLASS StatusMonitor;
67 
68 // ----------------------------------------------------------------------------
69 
97 class PCL_CLASS StatusCallback
98 {
99 public:
100 
104  StatusCallback() = default;
105 
109  StatusCallback( const StatusCallback& ) = default;
110 
114  StatusCallback( StatusCallback&& ) = default;
115 
119  virtual ~StatusCallback()
120  {
121  }
122 
126  StatusCallback& operator =( const StatusCallback& ) = default;
127 
131  StatusCallback& operator =( StatusCallback&& ) = default;
132 
145  virtual int Initialized( const StatusMonitor& monitor ) const = 0;
146 
162  virtual int Updated( const StatusMonitor& monitor ) const = 0;
163 
181  virtual int Completed( const StatusMonitor& monitor ) const = 0;
182 
190  virtual void InfoUpdated( const StatusMonitor& monitor ) const = 0;
191 };
192 
193 // ----------------------------------------------------------------------------
194 
222 class PCL_CLASS StatusMonitor
223 {
224 public:
225 
229  StatusMonitor() = default;
230 
236  {
237  Assign( x );
238  }
239 
243  virtual ~StatusMonitor()
244  {
245  Clear();
246  }
247 
251  StatusMonitor& operator =( const StatusMonitor& x )
252  {
253  if ( this != &x )
254  Assign( x );
255  return *this;
256  }
257 
277  void Initialize( const String& info, size_type count = 0 );
278 
339  {
340  ++m_initDisableCount;
341  }
342 
353  {
354  --m_initDisableCount;
355  }
356 
365  {
366  return m_initDisableCount <= 0;
367  }
368 
375  bool IsInitialized() const
376  {
377  return m_initialized;
378  }
379 
386  bool IsCompleted() const
387  {
388  return m_completed;
389  }
390 
403  bool IsAborted() const
404  {
405  return m_aborted;
406  }
407 
414  void SetInfo( const String& s )
415  {
416  m_info = s;
417  if ( m_callback != nullptr )
418  m_callback->InfoUpdated( *this );
419  }
420 
435  void operator ++()
436  {
437  if ( ++m_count == m_total || m_needsUpdate )
438  Update();
439  }
440 
447  void operator +=( size_type n )
448  {
449  m_count += n;
450  if ( m_total != 0 ) // if not an unbounded monitor
451  if ( m_count > m_total )
452  m_count = m_total;
453  if ( m_needsUpdate || m_count == m_total )
454  Update();
455  }
456 
464  void Complete()
465  {
466  m_count = m_total;
467  Update();
468  }
469 
475  const StatusCallback* Callback() const
476  {
477  return m_callback;
478  }
479 
486  {
487  return m_callback;
488  }
489 
500  void SetCallback( StatusCallback* callback )
501  {
502  Reset();
503  m_callback = callback;
504  }
505 
517  int ReturnValue() const
518  {
519  return m_retVal;
520  }
521 
526  String Info() const
527  {
528  return m_info;
529  }
530 
537  size_type Count() const
538  {
539  return m_count;
540  }
541 
548  size_type Total() const
549  {
550  return m_total;
551  }
552 
557  void Clear()
558  {
559  Reset();
560  }
561 
570  static unsigned RefreshRate()
571  {
572  return s_msRefreshRate;
573  }
574 
587  static void SetRefreshRate( unsigned ms );
588 
589 private:
590 
591  StatusCallback* m_callback = nullptr;
592  bool m_initialized = false;
593  bool m_completed = false;
594  bool m_aborted = false;
595  bool m_needsUpdate = false; // thread-safe flag set by the dispatcher
596  int m_initDisableCount = 0;
597  int m_retVal = 0;
598  String m_info;
599  size_type m_total = 0;
600  size_type m_count = 0;
601 
602  static unsigned s_msRefreshRate;
603 
604  void Reset();
605  void Assign( const StatusMonitor& );
606  void Update();
607 
608  friend class MonitorDispatcherThread;
609 };
610 
611 // ----------------------------------------------------------------------------
612 
613 } // pcl
614 
615 #endif // __PCL_StatusMonitor_h
616 
617 // ----------------------------------------------------------------------------
618 // EOF pcl/StatusMonitor.h - Released 2019-11-07T10:59:34Z
String Info() const
PCL root namespace.
Definition: AbstractImage.h:76
static unsigned RefreshRate()
bool IsAborted() const
void SetInfo(const String &s)
bool IsInitializationEnabled() const
size_t size_type
Definition: Defs.h:543
Unicode (UTF-16) string.
Definition: String.h:7911
const StatusCallback * Callback() const
An asynchronous status monitoring system.
virtual ~StatusCallback()
bool IsInitialized() const
int ReturnValue() const
void SetCallback(StatusCallback *callback)
Provides status monitoring callback functions.
Definition: StatusMonitor.h:97
size_type Count() const
virtual ~StatusMonitor()
StatusCallback * Callback()
bool IsCompleted() const
size_type Total() const
void DisableInitialization()
StatusMonitor(const StatusMonitor &x)