KeywordHandler.h

Go to the documentation of this file.

//_Title KeywordHandler.h Definition of basic ISIS support structure
//
//_Descr ISIS3 file/functionality definition.
//
//_Hist Jul 24 2004 Kris Becker, USGS
//_Version: $Id: KeywordHandler.h,v 1.4 2007/04/26 16:38:58 kbecker Exp $
//_End

#if !defined(KeywordHandler_h)
#define KeywordHandler_h
#include <string>
#include <vector>

#include <QString>
#include <QList>
#include <QStringList>
#include <QVariant>
#include <QMetaType>

#include "Cube.h"
#include "Pvl.h"
#include "PvlKeyword.h"
#include "IException.h"
#include "IString.h"

namespace ISISDLM {
class PvlSpecs {
  public:
    typedef enum { Object, Group, Container, Keyword, None } PvlType;
    PvlSpecs();
    PvlSpecs(const QString &spec, const PvlType &ptype);
    ~PvlSpecs() { }

    QString name() const;
    PvlType type() const;

    void setType(const PvlType &ptype);
    bool hasQualifiers(Isis::PvlContainer &element) const;

  private:
    QString           m_spec;
    QString           m_name;
    PvlType           m_type;
    QList<Isis::PvlKeyword> m_qualifiers;

    void init(const QString &spec);
};


class KeywordHandler {
  public:
    typedef PvlSpecs::PvlType PvlType;
    KeywordHandler( );
    KeywordHandler(const QString &path, const PvlType &type = PvlSpecs::Keyword,
                   const bool &recurse = false);
    KeywordHandler(const std::string &path, const PvlType &type = PvlSpecs::Keyword,
                   const bool &recurse = false);
    ~KeywordHandler() { }

    void setRecursive();
    void setNoRecursive();

    Isis::PvlKeyword read(Isis::Pvl &pvl) const;
    static Isis::PvlKeyword read(const QString &path, Isis::Pvl &pvl);

#if defined(FULL_IMPLEMENTATION)
    bool exists(const Pvl &pvl) const;
    bool write(const QStringList &values, Pvl &pvl) const;
    bool remove(Pvl &pvl) const;

    static bool exists(const QString &path, const Pvl &pvl, 
                       const PvlType &type = Keyword);
 
    static bool write(const QString &path, const QStringList &values, Pvl &pvl); 
    static bool remove(const QString &path, Pvl &pvl, 
                       const PvlType &ptype = Keyword);
    static bool create(const QString &path, PvlType &ptype, Pvl &pvl);
#endif

  private:
    typedef QList<PvlSpecs> PvlElementList;
    QString         m_path;
    PvlElementList  m_pvlParts;
    bool            m_recursive;

    void init(const QString &path, const PvlType &type);
    QVariant find(Isis::PvlObject &pvl) const;
    QVariant findElement(const PvlElementList &plist, const QVariant &source) const;
    Isis::PvlKeyword *getKeyword(Isis::PvlContainer *pvl, const QString &name) const;


};

} // namespace ISISDLM

// Add Pvl elements to QVariant type list
Q_DECLARE_METATYPE(Isis::PvlKeyword *);
Q_DECLARE_METATYPE(Isis::PvlContainer *);
Q_DECLARE_METATYPE(Isis::PvlObject *);
#endif