MetaProcess.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.9.3
// ----------------------------------------------------------------------------
// pcl/MetaProcess.h - Released 2025-02-21T12:13:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2025 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_MetaProcess_h
#define __PCL_MetaProcess_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/MetaObject.h>
#include <pcl/ProcessBase.h>
#include <pcl/Property.h>
#include <pcl/StringList.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class View;
class ImageWindow;
class ProcessImplementation;
class ProcessInterface;
class MetaParameter;
 
class PCL_CLASS MetaProcess : public MetaObject, public ProcessBase
{
public:
 
   MetaProcess();
 
   ~MetaProcess() noexcept( false ) override
   {
   }
 
   MetaProcess( const MetaProcess& ) = delete;
 
   MetaProcess& operator =( const MetaProcess& ) = delete;
 
   MetaProcess( MetaProcess&& x ) = delete;
 
   MetaProcess& operator =( MetaProcess&& x ) = delete;
 
   virtual IsoString Id() const override = 0;
 
   virtual IsoString Aliases() const
   {
      return IsoString();
   }
 
   virtual IsoString Categories() const
   {
      return IsoString(); // General category
   }
 
   virtual IsoString Category() const // ### PCL 2.x: Remove
   {
      return Categories();
   }
 
   uint32 Version() const override
   {
      return 0x100;
   }
 
   String Description() const override
   {
      return String();
   }
 
   String ScriptComment() const override
   {
      return String();
   }
 
   virtual IsoString IconImageSVG() const
   {
      return IsoString();
   }
 
   virtual String IconImageSVGFile() const
   {
      return String();
   }
 
   virtual const char** IconImageXPM() const
   {
      return nullptr;
   }
 
   virtual String IconImageFile() const
   {
      return String();
   }
 
   virtual const char** SmallIconImageXPM() const
   {
      return nullptr;
   }
 
   virtual String SmallIconImageFile() const
   {
      return String();
   }
 
   Bitmap Icon() const override;
 
   Bitmap SmallIcon() const override;
 
   virtual void InitializeClass()
   {
   }
 
   virtual ProcessInterface* DefaultInterface() const
   {
      return nullptr; // by default, processes have no associated interfaces.
   }
 
   bool CanProcessViews() const override
   {
      return true;
   }
 
   bool CanProcessGlobal() const override
   {
      return true;
   }
 
   bool CanProcessImages() const override
   {
      return false;
   }
 
   bool CanProcessCommandLines() const override
   {
      return false;
   }
 
   bool CanEditPreferences() const override
   {
      return false;
   }
 
   bool CanBrowseDocumentation() const override
   {
      return true;
   }
 
   virtual ProcessImplementation* Create() const = 0;
 
   virtual ProcessImplementation* Clone( const ProcessImplementation& ) const = 0;
 
   virtual ProcessImplementation* TestClone( const ProcessImplementation& p ) const
   {
      return Clone( p );
   }
 
   bool IsAssignable() const override
   {
      return true; // by default, processes are considered assignable.
   }
 
   bool NeedsInitialization() const override
   {
      return false; // by default, process instances are not initialized.
   }
 
   bool NeedsValidation() const override
   {
      return false; // by default, process instances are not validated.
   }
 
   bool PrefersGlobalExecution() const override
   {
      return false; // by default, processes prefer execution on views.
   }
 
   virtual int ProcessCommandLine( const StringList& argv ) const;
 
   bool EditPreferences() const override;
 
   bool BrowseDocumentation() const override;
 
   const MetaParameter* operator[]( size_type i ) const;
 
   virtual bool CanProcessIPCMessages() const
   {
      return false;
   }
 
   virtual void IPCStart( int instance, const IsoString& messageUID, const String& parameters ) const;
 
   virtual void IPCStop( int instance, const IsoString& messageUID ) const;
 
   virtual void IPCSetParameters( int instance, const IsoString& messageUID, const String& parameters ) const;
 
   virtual int IPCStatus( int instance, const IsoString& messageUID ) const;
 
   Property SignatureProperty( const IsoString& taskId ) const;
 
private:
 
   void PerformAPIDefinitions() const override;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_MetaProcess_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MetaProcess.h - Released 2025-02-21T12:13:32Z