Strategy.h

Go to the documentation of this file.

#ifndef Strategy_h
#define Strategy_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
// Qt library
#include <QList>
#include <QPair>
#include <QScopedPointer>
#include <QSharedPointer>
#include <QString>
 
// SharedResource and ResourceList typedefs
#include "Resource.h"
#include "PvlObject.h"
 
class QStringList;
 
namespace Isis {
 
  class GisGeometry;
  class Progress;
 
 
  class Strategy {
  
    public:
      Strategy();
      Strategy(const PvlObject &definition, const ResourceList &globals);
      virtual ~Strategy();
  
      QString name() const;
      QString type() const;
      QString description() const;
  
      // Not intended to be reimplemented but available for direct calls
      int apply(ResourceList &resources);
      int apply(SharedResource &resource);
 
      // Inheriting strategies must reimplement either one or both of these
      virtual int apply(ResourceList &resources, const ResourceList &globals);
      virtual int apply(SharedResource &resource, const ResourceList &globals);
  
      unsigned int totalProcessed() const;
  
   protected:
     typedef QSharedPointer<PvlObject> SharedPvlObject;
  
     // For default constructions
     Strategy(const QString &name, const QString &type);
 
     void setName(const QString &name);
     void setType(const QString &type);
 
     ResourceList getGlobalDefaults() const;
     ResourceList getGlobals(SharedResource &myGlobals, 
                             const ResourceList &globals) const;
     const PvlObject &getDefinition() const;
     PvlFlatMap getDefinitionMap() const;
 
  
     void setApplyToDiscarded();
     bool isApplyToDiscarded() const;
     void setDoNotApplyToDiscarded();  // default
  
     int applyToResources(ResourceList &resources, const ResourceList &globals);
     unsigned int processed();
     void resetProcessed();
  
     int countActive(const ResourceList &resources) const;
     int countDiscarded(const ResourceList &resources) const;
     ResourceList assetResourceList(const SharedResource &resource, 
                                       const QString &name) const;
  
     QString findReplacement(const QString &target, const ResourceList &globals,
                             const int &index = 0, 
                             const QString &defValue = "") const;
     QStringList qualifiers(const QString &keyspec, 
                               const QString &delimiter = "::") const;
     QString scanAndReplace(const QString &input, const QString &target, 
                            const QString &replacement) const;
     QString translateKeywordArgs(const QString &value,
                                  const ResourceList &globals,
                                  const QString &defValue = "") const; 
     QString processArgs(const QString &value, const QStringList &argKeys,
                         const ResourceList &globals,
                         const QString &defValue = "") const;
  
     void propagateKeys(SharedResource &source, SharedResource &target) const;
     SharedResource composite(SharedResource &resourceA, SharedResource &resourceB,
        const QPair<QString, QString> &keySuffix = qMakePair(QString("A"),QString("B"))) const;
     bool importGeometry(SharedResource &resource, 
                         const ResourceList &globals) const;
  
     ResourceList activeList(ResourceList &resources) const;
     void activateList(ResourceList &resources) const;
     void deactivateList(ResourceList &resources) const;
     ResourceList copyList(const ResourceList &resources) const;
     ResourceList cloneList(const ResourceList &resources,
                            const bool &withAssets = false) const;
 
     int applyToIntersectedGeometry(ResourceList &resources, GisGeometry &geom,
                                    const ResourceList &globals);
     bool isDebug() const;
 
     bool doShowProgress() const;
     bool initProgress(const int &nsteps = 0, const QString &text = "");
 
     static void queryCallback(void *item, void *userdata);
 
     QStringList getObjectList(const PvlObject &object) const;
 
     template <class STRATEGYLIST, class STRATEGYFACTORY> 
       STRATEGYLIST LoadMinerStrategies(const QString &minerName, 
                                        const ResourceList &globals) const {
         STRATEGYFACTORY *factory = STRATEGYFACTORY::instance();
 
         STRATEGYLIST miner;
         QString config = translateKeywordArgs(minerName+"ConfigFile", globals);
         if ( !config.isEmpty() ) {
           miner = factory->buildRun(config, globals);
         }
         else if ( getDefinition().hasObject(minerName+"Miner") ) {
           miner = factory->buildRun(getDefinition().findObject(minerName+"Miner"), 
                                                globals);
       }
       
       return (miner);
     }
 
  private:
     ResourceList   m_globals;    
     SharedPvlObject m_definition; 
      QString      m_name;           
      QString      m_type;           
      unsigned int m_total;          
      bool         m_applyDiscarded; 
      bool         m_debug;          
      QScopedPointer<Progress> m_progress; 
  
  };
  
  typedef QSharedPointer<Strategy> SharedStrategy;
  
  typedef QList<SharedStrategy> StrategyList;
 
} // Namespace Isis
 
Q_DECLARE_METATYPE(Isis::SharedStrategy);
 
#endif