PCL
Process.h
Go to the documentation of this file.
1
// ____ ______ __
2
// / __ \ / ____// /
3
// / /_/ // / / /
4
// / ____// /___ / /___ PixInsight Class Library
5
// /_/ \____//_____/ PCL 2.6.5
6
// ----------------------------------------------------------------------------
7
// pcl/Process.h - Released 2024-01-13T15:47:58Z
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_Process_h
53
#define __PCL_Process_h
54
56
57
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58
59
#include <
pcl/Defs.h
>
60
61
#include <
pcl/AutoPointer.h
>
62
#include <
pcl/ProcessBase.h
>
63
#include <
pcl/ProcessParameter.h
>
64
65
namespace
pcl
66
{
67
68
// ----------------------------------------------------------------------------
69
70
class
ProcessPrivate;
71
98
class
PCL_CLASS
Process
:
public
ProcessBase
99
{
100
public
:
101
108
using
parameter_list
=
Array<ProcessParameter>
;
109
125
Process
(
const
IsoString
& classId );
126
127
Process
(
const
IsoString::ustring_base
& classId )
128
:
Process
(
IsoString
( classId ) )
129
{
130
}
131
136
Process
(
const
Process
& proc );
137
145
~
Process
()
override
;
146
149
IsoString
Id
()
const override
;
150
169
IsoStringList
Aliases()
const
;
170
186
IsoStringList
Categories()
const
;
187
190
uint32
Version
()
const override
;
191
194
String
Description()
const override
;
195
198
String
ScriptComment()
const override
;
199
202
Bitmap
Icon()
const override
;
203
206
Bitmap
SmallIcon()
const override
;
207
210
bool
CanProcessViews()
const override
;
211
214
bool
CanProcessGlobal()
const override
;
215
218
bool
CanProcessImages()
const override
;
219
222
bool
CanProcessCommandLines()
const override
;
223
226
bool
CanEditPreferences()
const override
;
227
230
bool
CanBrowseDocumentation()
const override
;
231
234
bool
IsAssignable()
const override
;
235
238
bool
NeedsInitialization()
const override
;
239
242
bool
NeedsValidation()
const override
;
243
246
bool
PrefersGlobalExecution()
const override
;
247
250
bool
EditPreferences()
const override
;
251
254
bool
BrowseDocumentation()
const override
;
255
277
int
RunCommandLine(
const
String
& arguments )
const
;
278
295
bool
Launch()
const
;
296
301
parameter_list Parameters()
const
;
302
307
bool
HasParameter(
const
IsoString
& paramId )
const
;
308
313
bool
HasTableColumn(
const
IsoString
& tableId,
const
IsoString
& colId )
const
;
314
319
static
IsoStringList
AllProcessCategories();
320
325
static
Array<Process>
AllProcesses();
326
335
static
Array<Process>
ProcessesByCategory(
const
IsoString
& category );
336
337
static
Array<Process>
ProcessesByCategory(
const
IsoString::ustring_base
& category )
338
{
339
return
ProcessesByCategory(
IsoString
( category ) );
340
}
341
342
private
:
343
344
AutoPointer<ProcessPrivate> m_data;
345
346
Process(
const
void
* );
347
348
const
void
* Handle()
const
;
349
350
friend
class
ProcessInstance;
351
friend
class
ProcessParameter;
352
friend
class
ProcessParameterPrivate;
353
friend
class
InternalProcessEnumerator;
354
};
355
356
// ----------------------------------------------------------------------------
357
358
}
// pcl
359
360
#endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
361
362
#endif // __PCL_Process_h
363
364
// ----------------------------------------------------------------------------
365
// EOF pcl/Process.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition:
AbstractImage.h:76
pcl::Bitmap
Client-side interface to a PixInsight Bitmap object.
Definition:
Bitmap.h:203
pcl::ImageOp::Id
String Id(value_type operation)
pcl::String
Unicode (UTF-16) string.
Definition:
String.h:8112
pcl::IsoString
Eight-bit string (ISO/IEC-8859-1 or UTF-8 string)
Definition:
String.h:5424
pcl::uint32
unsigned int uint32
Definition:
Defs.h:669
pcl::Process
High-level interface to an installed process.
Definition:
Process.h:98
ProcessParameter.h
pcl::GenericString< char16_type, CharTraits, PCL_STRING_ALLOCATOR >
pcl::Version
Provides PCL version numbers.
Definition:
Version.h:75
pcl::ProcessBase
Abstract base class for process descriptions.
Definition:
ProcessBase.h:94
pcl::Array
Generic dynamic array.
Definition:
Array.h:99
AutoPointer.h
ProcessBase.h
Defs.h
Process.h
Generated on Sun Jan 14 2024 20:52:44 for PCL by
1.8.17