Resource.h

Go to the documentation of this file.

#ifndef Resource_h
#define Resource_h
 
/* SPDX-License-Identifier: CC0-1.0 */
 
// Qt library
#include <QExplicitlySharedDataPointer>
#include <QMap>
#include <QMetaType>
#include <QSharedData>
#include <QString>
#include <QVariant>
 
#include "GisGeometry.h"  // SharedGisGeometry type
#include "PvlFlatMap.h"
 
namespace Isis {
 
  class PvlContainer;
  class PvlKeyword;
  class PvlObject;
 
  class Resource  {
 
    public:
      Resource();
      Resource(const QString &name);
      Resource(const QString &name, const PvlFlatMap &profile);
      Resource(const QString &name, const PvlContainer &profile);
      Resource(const Resource &other);
      virtual ~Resource();
 
      QString name() const;
      void setName(const QString &identity);
      bool isEqual(const Resource &other) const;
 
      bool exists(const QString &keywordName) const;
      int  count(const QString &keywordName) const;
      bool isNull(const QString &keywordName, const int keywordIndex = 0) const;
 
      const PvlFlatMap &keys() const;
      QString value(const QString &keywordName, const int &keywordIndex  = 0) const;
      QString value(const QString &keywordName, const QString &defValue,
                    const int &keywordIndex  = 0) const;
      PvlKeyword keyword(const QString &keywordName) const;
 
      void add(const QString &keywordName, const QString &keywordValue);
      void add(const PvlKeyword &keyword);
      void add(const PvlFlatMap &keys);
      void append(const QString &keywordName, const QString &keywordValue);
 
      int erase(const QString &keywordName);
 
      void add(GisGeometry *geom);
      void add(SharedGisGeometry &geom);
 
      bool hasGeometry() const;
      bool hasValidGeometry() const;
      SharedGisGeometry geometry() const;
 
      void activate();
      bool isActive() const;
      void discard();
      bool isDiscarded() const;
 
      bool hasAsset(const QString &assetName) const;
      void addAsset(const QString &assetName, QVariant &assetValue);
      QVariant asset(const QString &assetName) const;
      int removeAsset(const QString &assetName);
      int clearAssets();
 
      virtual Resource *copy() const;
      virtual Resource *clone(const QString &name, 
                              const bool &withAssets=false) const;
 
      virtual PvlObject toPvl(const QString &pvlName = "Resource") const;
 
    protected:
      Resource(const Resource &other, const bool deepcopy);
 
    private:
      typedef QMap<QString, QVariant> VariantList;
 
      class ResourceData : public QSharedData {
        public:
          ResourceData() : m_name("Resource"), m_keys(), 
                           m_assets(), m_geom(0) { }
          ResourceData(const ResourceData &other) : QSharedData(other), 
                                                    m_name(other.m_name),
                                                    m_keys(other.m_keys),
                                                    m_assets(other.m_assets),
                                                    m_geom(other.m_geom) { }
          ResourceData(const QString &name) : QSharedData(),
                                              m_name(name),
                                              m_keys(),
                                              m_assets(),
                                              m_geom(0) { }
          ResourceData(const QString &name, const PvlFlatMap &profile) : 
                                             QSharedData(),
                                              m_name(name),
                                              m_keys(profile),
                                              m_assets(),
                                              m_geom(0) { }
 
          QString           m_name;    
          PvlFlatMap        m_keys;    
          VariantList       m_assets;  
          SharedGisGeometry m_geom;    
      };
 
      // Member variables
      QExplicitlySharedDataPointer<ResourceData> m_data; 
      bool                  m_discard; 
  };
  
  typedef QSharedPointer<Resource> SharedResource;
  
  typedef QList<SharedResource> ResourceList;
 
 
} // Namespace Isis
 
// Declarations so they can be stored as QVariants (assets)
Q_DECLARE_METATYPE(Isis::SharedResource);
Q_DECLARE_METATYPE(Isis::ResourceList);
 
#endif