qgsprocessingmodelchildparametersource.cpp

Go to the documentation of this file.

/***************************************************************************
                         qgsprocessingmodelchildparametersource.cpp
                         ------------------------------------------
    begin                : June 2017
    copyright            : (C) 2017 by Nyall Dawson
    email                : nyall dot dawson at gmail dot com
 ***************************************************************************/
 
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/
 
#include "qgsprocessingmodelchildparametersource.h"
 
#include "qgsprocessingcontext.h"
#include "qgsprocessingmodelalgorithm.h"
#include "qgsprocessingparameters.h"
 
#include <QString>
 
using namespace Qt::StringLiterals;

 
bool QgsProcessingModelChildParameterSource::operator==( const QgsProcessingModelChildParameterSource &other ) const
{
  if ( mSource != other.mSource )
    return false;
 
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      return mStaticValue == other.mStaticValue;
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
      return mChildId == other.mChildId && mOutputName == other.mOutputName;
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
      return mParameterName == other.mParameterName;
    case Qgis::ProcessingModelChildParameterSource::Expression:
      return mExpression == other.mExpression;
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
      return mExpressionText == other.mExpressionText;
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      return true;
  }
  return false;
}
 
QgsProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::fromStaticValue( const QVariant &value )
{
  QgsProcessingModelChildParameterSource src;
  src.mSource = Qgis::ProcessingModelChildParameterSource::StaticValue;
  src.mStaticValue = value;
  return src;
}
 
QgsProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::fromModelParameter( const QString &parameterName )
{
  QgsProcessingModelChildParameterSource src;
  src.mSource = Qgis::ProcessingModelChildParameterSource::ModelParameter;
  src.mParameterName = parameterName;
  return src;
}
 
QgsProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::fromChildOutput( const QString &childId, const QString &outputName )
{
  QgsProcessingModelChildParameterSource src;
  src.mSource = Qgis::ProcessingModelChildParameterSource::ChildOutput;
  src.mChildId = childId;
  src.mOutputName = outputName;
  return src;
}
 
QgsProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::fromExpression( const QString &expression )
{
  QgsProcessingModelChildParameterSource src;
  src.mSource = Qgis::ProcessingModelChildParameterSource::Expression;
  src.mExpression = expression;
  return src;
}
 
QgsProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::fromExpressionText( const QString &text )
{
  QgsProcessingModelChildParameterSource src;
  src.mSource = Qgis::ProcessingModelChildParameterSource::ExpressionText;
  src.mExpressionText = text;
  return src;
}
 
Qgis::ProcessingModelChildParameterSource QgsProcessingModelChildParameterSource::source() const
{
  return mSource;
}
 
void QgsProcessingModelChildParameterSource::setSource( Qgis::ProcessingModelChildParameterSource source )
{
  mSource = source;
}
 
QVariant QgsProcessingModelChildParameterSource::toVariant() const
{
  QVariantMap map;
  map.insert( u"source"_s, static_cast< int >( mSource ) );
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
      map.insert( u"parameter_name"_s, mParameterName );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
      map.insert( u"child_id"_s, mChildId );
      map.insert( u"output_name"_s, mOutputName );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      map.insert( u"static_value"_s, mStaticValue );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::Expression:
      map.insert( u"expression"_s, mExpression );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
      map.insert( u"expression_text"_s, mExpressionText );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      break;
  }
  return map;
}
 
bool QgsProcessingModelChildParameterSource::loadVariant( const QVariantMap &map )
{
  mSource = static_cast< Qgis::ProcessingModelChildParameterSource >( map.value( u"source"_s ).toInt() );
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
      mParameterName = map.value( u"parameter_name"_s ).toString();
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
      mChildId = map.value( u"child_id"_s ).toString();
      mOutputName = map.value( u"output_name"_s ).toString();
      break;
 
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      mStaticValue = map.value( u"static_value"_s );
      break;
 
    case Qgis::ProcessingModelChildParameterSource::Expression:
      mExpression = map.value( u"expression"_s ).toString();
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
      mExpressionText = map.value( u"expression_text"_s ).toString();
      break;
 
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      break;
  }
  return true;
}
 
QString QgsProcessingModelChildParameterSource::asPythonCode( const QgsProcessing::PythonOutputType, const QgsProcessingParameterDefinition *definition, const QMap< QString, QString > &friendlyChildNames ) const
{
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
      return u"parameters['%1']"_s.arg( mParameterName );
 
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
      return u"outputs['%1']['%2']"_s.arg( friendlyChildNames.value( mChildId, mChildId ), mOutputName );
 
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      if ( definition )
      {
        QgsProcessingContext c;
        return definition->valueAsPythonString( mStaticValue, c );
      }
      else
      {
        return QgsProcessingUtils::variantToPythonLiteral( mStaticValue );
      }
 
    case Qgis::ProcessingModelChildParameterSource::Expression:
      return u"QgsExpression(%1).evaluate()"_s.arg( QgsProcessingUtils::stringToPythonLiteral( mExpression ) );
 
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
      return mExpressionText;
 
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      return QString();
  }
  return QString();
}
 
QString QgsProcessingModelChildParameterSource::asPythonComment( const QgsProcessingParameterDefinition *definition ) const
{
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
    case Qgis::ProcessingModelChildParameterSource::Expression:
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      return QString();
 
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      if ( definition )
      {
        QgsProcessingContext c;
        return definition->valueAsPythonComment( mStaticValue, c );
      }
      else
      {
        return QString();
      }
  }
  return QString();
}
 
QString QgsProcessingModelChildParameterSource::friendlyIdentifier( QgsProcessingModelAlgorithm *model ) const
{
  switch ( mSource )
  {
    case Qgis::ProcessingModelChildParameterSource::ModelParameter:
    {
      if ( model )
      {
        if ( const QgsProcessingParameterDefinition *paramDefinition = model->parameterDefinition( mParameterName ) )
        {
          // A model can be valid (non null) but the parameter may not exist yet (if input has not yet been set)
          return paramDefinition->description();
        }
      }
 
      return mParameterName;
    }
    case Qgis::ProcessingModelChildParameterSource::ChildOutput:
    {
      if ( model )
      {
        const QgsProcessingModelChildAlgorithm &alg = model->childAlgorithm( mChildId );
        QString outputName = alg.algorithm() && alg.algorithm()->outputDefinition( mOutputName ) ? alg.algorithm()->outputDefinition( mOutputName )->description() : mOutputName;
        // see if this output has been named by the model designer -- if so, we use that friendly name
        const QMap<QString, QgsProcessingModelOutput> outputs = alg.modelOutputs();
        for ( auto it = outputs.constBegin(); it != outputs.constEnd(); ++it )
        {
          if ( it.value().childOutputName() == mOutputName )
          {
            outputName = it.key();
            break;
          }
        }
        return QObject::tr( "'%1' from algorithm '%2'" ).arg( outputName, alg.description() );
      }
      else
      {
        return QObject::tr( "'%1' from algorithm '%2'" ).arg( mOutputName, mChildId );
      }
    }
 
    case Qgis::ProcessingModelChildParameterSource::StaticValue:
      return mStaticValue.toString();
 
    case Qgis::ProcessingModelChildParameterSource::Expression:
      return mExpression;
 
    case Qgis::ProcessingModelChildParameterSource::ExpressionText:
      return mExpressionText;
 
    case Qgis::ProcessingModelChildParameterSource::ModelOutput:
      return QString();
  }
  return QString();
}
 
QDataStream &operator<<( QDataStream &out, const QgsProcessingModelChildParameterSource &source )
{
  out << static_cast< int >( source.source() );
  out << source.staticValue();
  out << source.parameterName();
  out << source.outputChildId();
  out << source.outputName();
  out << source.expression();
  out << source.expressionText();
  return out;
}
 
QDataStream &operator>>( QDataStream &in, QgsProcessingModelChildParameterSource &source )
{
  int sourceType;
  QVariant staticValue;
  QString parameterName;
  QString outputChildId;
  QString outputName;
  QString expression;
  QString expressionText;
 
  in >> sourceType >> staticValue >> parameterName >> outputChildId >> outputName >> expression >> expressionText;
 
  source.setStaticValue( staticValue );
  source.setParameterName( parameterName );
  source.setOutputChildId( outputChildId );
  source.setOutputName( outputName );
  source.setExpression( expression );
  source.setExpressionText( expressionText );
  source.setSource( static_cast<Qgis::ProcessingModelChildParameterSource>( sourceType ) );
  return in;
}