PCL
RealTimeProgressStatus.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/RealTimeProgressStatus.h - Released 2024-06-18T15:48:54Z
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-2024 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 (https://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_RealTimeProgressStatus_h
53 #define __PCL_RealTimeProgressStatus_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 
61 #include <pcl/MuteStatus.h>
62 #include <pcl/RealTimePreview.h>
63 
64 namespace pcl
65 {
66 
67 // ----------------------------------------------------------------------------
68 
85 class PCL_CLASS RealTimeProgressStatus : public MuteStatus
86 {
87 public:
88 
97  : m_title( title )
98  {
99  }
100 
105  : MuteStatus( x )
106  , m_title( x.m_title )
107  {
108  }
109 
118  int Initialized( const StatusMonitor& monitor ) const override
119  {
120  if ( MuteStatus::Initialized( monitor ) == 0 )
121  {
122  RealTimePreview::ShowProgressDialog( m_title, monitor.Info(), monitor.Total() );
123  return 0;
124  }
125  return 1;
126  }
127 
135  int Updated( const StatusMonitor& monitor ) const override
136  {
137  if ( MuteStatus::Updated( monitor ) == 0 )
138  {
140  return 0;
141  }
142  return 1;
143  }
144 
152  int Completed( const StatusMonitor& monitor ) const override
153  {
154  if ( MuteStatus::Completed( monitor ) == 0 )
155  {
157  return 0;
158  }
159  return 1;
160  }
161 
169  void InfoUpdated( const StatusMonitor& monitor ) const override
170  {
172  }
173 
174 private:
175 
176  String m_title;
177 };
178 
179 // ----------------------------------------------------------------------------
180 
181 } // pcl
182 
183 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
184 
185 #endif // __PCL_RealTimeProgressStatus_h
186 
187 // ----------------------------------------------------------------------------
188 // EOF pcl/RealTimeProgressStatus.h - Released 2024-06-18T15:48:54Z
A status monitoring callback that does not provide any progress information.
Definition: MuteStatus.h:93
int Initialized(const StatusMonitor &monitor) const override
int Updated(const StatusMonitor &monitor) const override
int Completed(const StatusMonitor &monitor) const override
static void SetProgressText(const String &text)
static void SetProgressCount(size_type count)
static void ShowProgressDialog(const String &title, const String &text, size_type total)
static void CloseProgressDialog()
A status monitoring callback to provide progress feedback during long real-time preview generation pr...
RealTimeProgressStatus(const String &title)
RealTimeProgressStatus(const RealTimeProgressStatus &x)
int Completed(const StatusMonitor &monitor) const override
void InfoUpdated(const StatusMonitor &monitor) const override
int Initialized(const StatusMonitor &monitor) const override
int Updated(const StatusMonitor &monitor) const override
An asynchronous status monitoring system.
String Info() const
size_type Count() const
size_type Total() const
Unicode (UTF-16) string.
Definition: String.h:8113
PCL root namespace.
Definition: AbstractImage.h:77