Process.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/Process.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_Process_h
#define __PCL_Process_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/ProcessBase.h>
#include <pcl/ProcessParameter.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class ProcessPrivate;
 
class PCL_CLASS Process : public ProcessBase
{
public:
 
   using parameter_list = Array<ProcessParameter>;
 
   Process( const IsoString& classId );
 
   Process( const IsoString::ustring_base& classId )
      : Process( IsoString( classId ) )
   {
   }
 
   Process( const Process& proc );
 
   ~Process() override;
 
   IsoString Id() const override;
 
   IsoStringList Aliases() const;
 
   IsoStringList Categories() const;
 
   uint32 Version() const override;
 
   String Description() const override;
 
   String ScriptComment() const override;
 
   Bitmap Icon() const override;
 
   Bitmap SmallIcon() const override;
 
   bool CanProcessViews() const override;
 
   bool CanProcessGlobal() const override;
 
   bool CanProcessImages() const override;
 
   bool CanProcessCommandLines() const override;
 
   bool CanEditPreferences() const override;
 
   bool CanBrowseDocumentation() const override;
 
   bool IsAssignable() const override;
 
   bool NeedsInitialization() const override;
 
   bool NeedsValidation() const override;
 
   bool PrefersGlobalExecution() const override;
 
   bool EditPreferences() const override;
 
   bool BrowseDocumentation() const override;
 
   int RunCommandLine( const String& arguments ) const;
 
   bool Launch() const;
 
   parameter_list Parameters() const;
 
   bool HasParameter( const IsoString& paramId ) const;
 
   bool HasTableColumn( const IsoString& tableId, const IsoString& colId ) const;
 
   static IsoStringList AllProcessCategories();
 
   static Array<Process> AllProcesses();
 
   static Array<Process> ProcessesByCategory( const IsoString& category );
 
   static Array<Process> ProcessesByCategory( const IsoString::ustring_base& category )
   {
      return ProcessesByCategory( IsoString( category ) );
   }
 
private:
 
   AutoPointer<ProcessPrivate> m_data;
 
   Process( const void* );
 
   const void* Handle() const;
 
   friend class ProcessInstance;
   friend class ProcessParameter;
   friend class ProcessParameterPrivate;
   friend class InternalProcessEnumerator;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_Process_h
 
// ----------------------------------------------------------------------------
// EOF pcl/Process.h - Released 2024-06-18T15:48:54Z