PCL
SpinStatus.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/SpinStatus.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_SpinStatus_h
53 #define __PCL_SpinStatus_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 
61 #include <pcl/Console.h>
62 #include <pcl/StatusMonitor.h>
63 
64 namespace pcl
65 {
66 
67 // ----------------------------------------------------------------------------
68 
100 class PCL_CLASS SpinStatus : public StatusCallback
101 {
102 public:
103 
107  SpinStatus() = default;
108 
112  SpinStatus( const SpinStatus& x )
113  : StatusCallback( x )
114  , m_spinCount( x.m_spinCount )
115  {
116  }
117 
122  : StatusCallback( std::move( x ) )
123  , m_console( std::move( x.m_console ) )
124  , m_spinCount( x.m_spinCount )
125  , m_thread( x.m_thread )
126  {
127  x.m_thread = nullptr;
128  }
129 
133  ~SpinStatus() override
134  {
135  }
136 
140  SpinStatus& operator =( const SpinStatus& x )
141  {
142  (void)StatusCallback::operator =( x );
143  m_spinCount = x.m_spinCount;
144  return *this;
145  }
146 
150  SpinStatus& operator =( SpinStatus&& x )
151  {
152  if ( this != &x )
153  {
154  (void)StatusCallback::operator =( std::move( x ) );
155  m_console = std::move( x.m_console );
156  m_spinCount = x.m_spinCount;
157  m_thread = x.m_thread;
158  x.m_thread = nullptr;
159  }
160  return *this;
161  }
162 
167  int Initialized( const StatusMonitor& m ) const override;
168 
173  int Updated( const StatusMonitor& m ) const override;
174 
179  int Completed( const StatusMonitor& m ) const override;
180 
185  void InfoUpdated( const StatusMonitor& m ) const override;
186 
187 private:
188 
189  mutable pcl::Console m_console;
190  mutable unsigned m_spinCount = 0;
191  mutable void* m_thread = nullptr;
192 };
193 
194 // ----------------------------------------------------------------------------
195 
196 } // pcl
197 
198 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
199 
200 #endif // __PCL_SpinStatus_h
201 
202 // ----------------------------------------------------------------------------
203 // EOF pcl/SpinStatus.h - Released 2024-06-18T15:48:54Z
A high-level interface to a PixInsight processing console.
Definition: Console.h:359
A status monitoring callback that shows a spinning character animation on the processing console.
Definition: SpinStatus.h:101
SpinStatus(SpinStatus &&x)
Definition: SpinStatus.h:121
void InfoUpdated(const StatusMonitor &m) const override
~SpinStatus() override
Definition: SpinStatus.h:133
int Updated(const StatusMonitor &m) const override
int Initialized(const StatusMonitor &m) const override
int Completed(const StatusMonitor &m) const override
SpinStatus()=default
SpinStatus(const SpinStatus &x)
Definition: SpinStatus.h:112
Provides status monitoring callback functions.
Definition: StatusMonitor.h:98
An asynchronous status monitoring system.
PCL root namespace.
Definition: AbstractImage.h:77