PvlTranslationTable.h

Go to the documentation of this file.

#ifndef PvlTranslationTable_h
#define PvlTranslationTable_h

#include <iostream>
#include <vector>
#include <string>

#include "FileName.h"
#include "Pvl.h"

namespace Isis {
  class PvlTranslationTable {

    public:
      // Constructors
      PvlTranslationTable(FileName transFile);
      PvlTranslationTable(std::istream &istr);
      PvlTranslationTable();

      virtual ~PvlTranslationTable();

      // Return the associated input group from the trans table
      virtual PvlKeyword InputGroup(const QString translationGroupName, const int inst = 0) const;

      // Return the associated input keyword name from the trans table
      virtual QString InputKeywordName(const QString translationGroupName) const;

      // Return the associated input default value from the trans table
      QString InputDefault(const QString translationGroupName) const;

      // Translate a single input value associated with a output name to a output value
      QString Translate(const QString translationGroupName, const QString inputKeyValue = "") const;

      // Add more table entries to the translation table data
      void AddTable(std::istream &transStm);
      void AddTable(const QString &transFile);

    protected:
      Pvl &TranslationTable();
      const Pvl &TranslationTable() const;
      virtual std::vector< std::pair<QString, int> > validKeywords() const;

      bool hasInputDefault(const QString translationGroupName);
      bool IsAuto(const QString translationGroupName);
      bool IsOptional(const QString translationGroupName);
      PvlKeyword OutputPosition(const QString translationGroupName);
      QString OutputName(const QString translationGroupName);
      const PvlGroup &findTranslationGroup(const QString translationGroupName) const;

    private:
      Pvl p_trnsTbl;
  };
};

#endif