ProcessParameter.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/ProcessParameter.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_ProcessParameter_h
#define __PCL_ProcessParameter_h
 
 
#ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#include <pcl/Defs.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/Variant.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace ProcessParameterType
{
   enum value_type
   {
      Invalid = -1,
      UInt8 = 0,
      Int8,
      UInt16,
      Int16,
      UInt32,
      Int32,
      UInt64,
      Int64,
      Float,
      Double,
      Boolean,
      Enumeration,
      String,
      Block,
      Table,
      NumberOfTypes
   };
 
   inline bool IsNumeric( int type )
   {
      return type >= UInt8 && type <= Double;
   }
 
   inline bool IsInteger( int type )
   {
      return type >= UInt8 && type <= Int64;
   }
 
   inline bool IsReal( int type )
   {
      return type == Float || type == Double;
   }
 
   inline bool IsVariableLength( int type )
   {
      return type == String || type == Block || type == Table;
   }
}
 
// ----------------------------------------------------------------------------
 
class Process;
class ProcessParameterPrivate;
 
class PCL_CLASS ProcessParameter
{
public:
 
   using data_type = ProcessParameterType::value_type;
 
   using parameter_list = Array<ProcessParameter>;
 
   struct EnumerationElement
   {
      IsoString     id;      
      IsoStringList aliases; 
      int           value;   
   };
 
   using enumeration_element_list = Array<EnumerationElement>;
 
   ProcessParameter( const Process& process, const IsoString& paramId );
 
   ProcessParameter( const Process& process, const IsoString::ustring_base& paramId )
      : ProcessParameter( process, IsoString( paramId ) )
   {
   }
 
   ProcessParameter( const ProcessParameter& table, const IsoString& colId );
 
   ProcessParameter( const ProcessParameter& table, const IsoString::ustring_base& colId )
      : ProcessParameter( table, IsoString( colId ) )
   {
   }
 
   ProcessParameter( const ProcessParameter& p );
 
   virtual ~ProcessParameter();
 
   bool IsNull() const;
 
   static ProcessParameter& Null();
 
   Process& ParentProcess() const;
 
   ProcessParameter ParentTable() const;
 
   IsoString Id() const;
 
   IsoStringList Aliases() const;
 
   bool IsRequired() const;
 
   bool IsReadOnly() const;
 
   String Description() const;
 
   String ScriptComment() const;
 
   data_type Type() const;
 
   data_type DataInterpretation() const;
 
   bool IsBoolean() const
   {
      return Type() == ProcessParameterType::Boolean;
   }
 
   bool IsNumeric() const
   {
      return ProcessParameterType::IsNumeric( Type() );
   }
 
   bool IsInteger() const
   {
      return ProcessParameterType::IsInteger( Type() );
   }
 
   bool IsReal() const
   {
      return ProcessParameterType::IsReal( Type() );
   }
 
   bool IsEnumeration() const
   {
      return Type() == ProcessParameterType::Enumeration;
   }
 
   bool IsVariableLength() const
   {
      return ProcessParameterType::IsVariableLength( Type() );
   }
 
   bool IsString() const
   {
      return Type() == ProcessParameterType::String;
   }
 
   bool IsBlock() const
   {
      return Type() == ProcessParameterType::Block;
   }
 
   bool IsTable() const
   {
      return Type() == ProcessParameterType::Table;
   }
 
   Variant DefaultValue() const;
 
   void GetNumericRange( double& minValue, double& maxValue ) const;
 
   double MinimumValue() const
   {
      double min, dum;
      GetNumericRange( min, dum );
      return min;
   }
 
   double MaximumValue() const
   {
      double dum, max;
      GetNumericRange( dum, max );
      return max;
   }
 
   int Precision() const;
 
   bool ScientificNotation() const;
 
   void GetLengthLimits( size_type& minLength, size_type& maxLength ) const;
 
   size_type MinimumLength() const
   {
      size_type min, dum;
      GetLengthLimits( min, dum );
      return min;
   }
 
   size_type MaximumLength() const
   {
      size_type dum, max;
      GetLengthLimits( dum, max );
      return max;
   }
 
   enumeration_element_list EnumerationElements() const;
 
   String AllowedCharacters() const;
 
   parameter_list TableColumns() const;
 
   // -------------------------------------------------------------------------
 
private:
 
   AutoPointer<ProcessParameterPrivate> m_data;
 
   ProcessParameter( const void* );
 
   const void* Handle() const;
 
   friend class ProcessInstance;
   friend class InternalParameterEnumerator;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_BUILDING_PIXINSIGHT_APPLICATION
 
#endif   // __PCL_ProcessParameter_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ProcessParameter.h - Released 2024-01-13T15:47:58Z