PCL
ProcessBase.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ProcessBase.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_ProcessBase_h
53 #define __PCL_ProcessBase_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 #include <pcl/Diagnostics.h>
61 
62 #include <pcl/Bitmap.h>
63 #include <pcl/StringList.h>
64 
65 namespace pcl
66 {
67 
68 // ----------------------------------------------------------------------------
69 
94 class PCL_CLASS ProcessBase
95 {
96 public:
97 
102  {
103  }
104 
108  virtual ~ProcessBase() noexcept( false )
109  {
110  }
111 
117  virtual IsoString Id() const = 0;
118 
126  virtual uint32 Version() const = 0;
127 
142  virtual String Description() const = 0;
143 
152  virtual String ScriptComment() const = 0;
153 
163  virtual Bitmap Icon() const = 0;
164 
181  virtual Bitmap SmallIcon() const = 0;
182 
186  virtual bool CanProcessViews() const = 0;
187 
191  virtual bool CanProcessGlobal() const = 0;
192 
196  virtual bool CanProcessImages() const = 0;
197 
202  virtual bool CanProcessCommandLines() const = 0;
203 
207  virtual bool CanEditPreferences() const = 0;
208 
218  virtual bool CanBrowseDocumentation() const = 0;
219 
226  virtual bool IsAssignable() const = 0;
227 
239  virtual bool NeedsInitialization() const = 0;
240 
250  virtual bool NeedsValidation() const = 0;
251 
261  virtual bool PrefersGlobalExecution() const = 0;
262 
276  virtual bool EditPreferences() const = 0;
277 
291  virtual bool BrowseDocumentation() const = 0;
292 };
293 
294 // ----------------------------------------------------------------------------
295 
296 } // pcl
297 
298 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
299 
300 #endif // __PCL_ProcessBase_h
301 
302 // ----------------------------------------------------------------------------
303 // EOF pcl/ProcessBase.h - Released 2024-06-18T15:48:54Z
Client-side interface to a PixInsight Bitmap object.
Definition: Bitmap.h:204
Eight-bit string (ISO/IEC-8859-1 or UTF-8 string)
Definition: String.h:5425
Abstract base class for process descriptions.
Definition: ProcessBase.h:95
virtual ~ProcessBase() noexcept(false)
Definition: ProcessBase.h:108
virtual bool BrowseDocumentation() const =0
virtual bool IsAssignable() const =0
virtual bool EditPreferences() const =0
virtual bool CanProcessImages() const =0
virtual String Description() const =0
virtual IsoString Id() const =0
virtual bool CanBrowseDocumentation() const =0
virtual uint32 Version() const =0
virtual Bitmap SmallIcon() const =0
virtual bool PrefersGlobalExecution() const =0
virtual bool NeedsInitialization() const =0
virtual bool NeedsValidation() const =0
virtual bool CanProcessCommandLines() const =0
virtual bool CanEditPreferences() const =0
virtual bool CanProcessGlobal() const =0
virtual Bitmap Icon() const =0
virtual bool CanProcessViews() const =0
virtual String ScriptComment() const =0
Unicode (UTF-16) string.
Definition: String.h:8113
unsigned int uint32
Definition: Defs.h:666
PCL root namespace.
Definition: AbstractImage.h:77