ProcessInstance.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.9.3
// ----------------------------------------------------------------------------
// pcl/ProcessInstance.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_ProcessInstance_h
#define __PCL_ProcessInstance_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/Process.h>
#include <pcl/ProcessParameter.h>
#include <pcl/Variant.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Process;
class PCL_CLASS ImageWindow;
class PCL_CLASS View;
 
class PCL_CLASS ProcessInstance : public UIObject
{
public:
 
   ProcessInstance( const Process& process );
 
   ProcessInstance( const ProcessInstance& p ) : UIObject( p )
   {
   }
 
   ~ProcessInstance() override
   {
   }
 
   static ProcessInstance& Null();
 
   Process ParentProcess() const;
 
   uint32 Version() const;
 
   ProcessInstance& operator =( const ProcessInstance& p )
   {
      SetHandle( p.handle );
      return *this;
   }
 
   ProcessInstance Clone() const;
 
   bool Assign( const ProcessInstance& p );
 
   bool Validate( String& whyNot );
 
   bool IsHistoryUpdater( const View& view ) const;
 
   bool IsMaskable( const View& view, const ImageWindow& mask ) const;
 
   bool CanExecuteOn( const View& view, String& whyNot ) const;
 
   bool ExecuteOn( View& view, bool swapFile = true );
 
   bool CanExecuteGlobal( String& whyNot ) const;
 
   bool ExecuteGlobal();
 
   bool CanExecuteOn( const ImageVariant& image, String& whyNot ) const;
 
   bool ExecuteOn( ImageVariant& image, const IsoString& hints = IsoString() );
 
   bool ExecuteOn( ImageVariant& image, const IsoString::ustring_base& hints )
   {
      return ExecuteOn( image, IsoString( hints ) );
   }
 
   bool Launch();
 
   bool CanLaunchInterface() const;
 
   bool LaunchInterface();
 
   String Description() const;
 
   void SetDescription( const String& text );
 
   void GetExecutionTimes( double& startJD, double& elapsedSecs ) const;
 
   double StartJD() const
   {
      double startJD, dum;
      GetExecutionTimes( startJD, dum );
      return startJD;
   }
 
   double ElapsedTime() const
   {
      double dum, elapsedSecs;
      GetExecutionTimes( dum, elapsedSecs );
      return elapsedSecs;
   }
 
   String ToSource( const IsoString& language = "JavaScript",
                    const IsoString& varId = IsoString(), int indent = 0 ) const;
 
   String ToHistorySource( const String& xmlSource = String() ) const;
 
   static ProcessInstance FromSource( const String& source,
                                      const IsoString& language = "JavaScript" );
 
   static ProcessInstance FromIcon( const IsoString& iconId );
 
   static ProcessInstance FromIcon( const IsoString::ustring_base& iconId )
   {
      return FromIcon( IsoString( iconId ) );
   }
 
   static IsoStringList Icons();
 
   static IsoStringList IconsByProcessId( const IsoString& processId );
 
   static IsoStringList IconsByProcessId( const IsoString::ustring_base& processId )
   {
      return IconsByProcessId( IsoString( processId ) );
   }
 
   Variant ParameterValue( const ProcessParameter& parameter, size_type rowIndex = ~size_type( 0 ) ) const;
 
   Variant ParameterValue( const IsoString& parameterId, size_type rowIndex = ~size_type( 0 ) ) const
   {
      return ParameterValue( ProcessParameter( ParentProcess(), parameterId ), rowIndex );
   }
 
   Variant ParameterValue( const IsoString::ustring_base& parameterId, size_type rowIndex = ~size_type( 0 ) ) const
   {
      return ParameterValue( IsoString( parameterId ), rowIndex );
   }
 
   bool SetParameterValue( const Variant& value,
                           const ProcessParameter& parameter, size_type rowIndex = ~size_type( 0 ) );
 
   bool SetParameterValue( const Variant& value, const IsoString& parameterId, size_type rowIndex = ~size_type( 0 ) )
   {
      return SetParameterValue( value, ProcessParameter( ParentProcess(), parameterId ), rowIndex );
   }
 
   bool SetParameterValue( const Variant& value, const IsoString::ustring_base& parameterId, size_type rowIndex = ~size_type( 0 ) )
   {
      return SetParameterValue( value, IsoString( parameterId ), rowIndex );
   }
 
   size_type TableRowCount( const ProcessParameter& table ) const;
 
   size_type TableRowCount( const IsoString& tableId ) const
   {
      return TableRowCount( ProcessParameter( ParentProcess(), tableId ) );
   }
 
   size_type TableRowCount( const IsoString::ustring_base& tableId ) const
   {
      return TableRowCount( IsoString( tableId ) );
   }
 
   bool AllocateTableRows( const ProcessParameter& table, size_type rowCount );
 
   bool AllocateTableRows( const IsoString& tableId, size_type rowCount )
   {
      return AllocateTableRows( ProcessParameter( ParentProcess(), tableId ), rowCount );
   }
 
   bool AllocateTableRows( const IsoString::ustring_base& tableId, size_type rowCount )
   {
      return AllocateTableRows( IsoString( tableId ), rowCount );
   }
 
private:
 
   ProcessInstance( void* h ) : UIObject( h )
   {
   }
 
   ProcessInstance( const void* h ) : UIObject( h )
   {
   }
 
   void* CloneHandle() const override;
 
   friend class ProcessInstancePrivate;
   friend class InterfaceDispatcher;
   friend class InternalIconEnumerator;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ProcessInstance_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ProcessInstance.h - Released 2025-02-21T12:13:32Z