PCL
MuteStatus.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/MuteStatus.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_MuteStatus_h
53 #define __PCL_MuteStatus_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 
92 class PCL_CLASS MuteStatus : public StatusCallback
93 {
94 public:
95 
99  MuteStatus() = default;
100 
104  MuteStatus( const MuteStatus& x )
105  : StatusCallback( x )
106  {
107  }
108 
113  : StatusCallback( std::move( x ) )
114  , m_console( std::move( x.m_console ) )
115  , m_thread( x.m_thread )
116  {
117  x.m_thread = nullptr;
118  }
119 
123  ~MuteStatus() override
124  {
125  }
126 
130  MuteStatus& operator =( const MuteStatus& x )
131  {
132  return *this;
133  }
134 
138  MuteStatus& operator =( MuteStatus&& x )
139  {
140  if ( this != &x )
141  {
142  (void)StatusCallback::operator =( std::move( x ) );
143  m_console = std::move( x.m_console );
144  m_thread = x.m_thread;
145  x.m_thread = nullptr;
146  }
147  return *this;
148  }
149 
154  int Initialized( const StatusMonitor& monitor ) const override;
155 
160  int Updated( const StatusMonitor& monitor ) const override;
161 
166  int Completed( const StatusMonitor& monitor ) const override;
167 
172  void InfoUpdated( const StatusMonitor& monitor ) const override;
173 
174 private:
175 
176  mutable pcl::Console m_console;
177  mutable void* m_thread = nullptr;
178 };
179 
180 // ----------------------------------------------------------------------------
181 
182 } // pcl
183 
184 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
185 
186 #endif // __PCL_MuteStatus_h
187 
188 // ----------------------------------------------------------------------------
189 // EOF pcl/MuteStatus.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 does not provide any progress information.
Definition: MuteStatus.h:93
MuteStatus()=default
void InfoUpdated(const StatusMonitor &monitor) const override
int Initialized(const StatusMonitor &monitor) const override
int Updated(const StatusMonitor &monitor) const override
MuteStatus(const MuteStatus &x)
Definition: MuteStatus.h:104
MuteStatus(MuteStatus &&x)
Definition: MuteStatus.h:112
int Completed(const StatusMonitor &monitor) const override
~MuteStatus() override
Definition: MuteStatus.h:123
Provides status monitoring callback functions.
Definition: StatusMonitor.h:98
An asynchronous status monitoring system.
PCL root namespace.
Definition: AbstractImage.h:77