SerialNumber.cpp

 
/* SPDX-License-Identifier: CC0-1.0 */
#include <map>
 
#include "SerialNumber.h"
#include "ObservationNumber.h"
#include "SerialNumberList.h"
#include "IException.h"
#include "Pvl.h"
#include "Cube.h"
#include "Process.h"
#include "PvlToPvlTranslationManager.h"
#include "FileName.h"
 
namespace Isis {
  SerialNumber::SerialNumber() {}

  SerialNumber::~SerialNumber() {}

  QString SerialNumber::Compose(Pvl &label, bool def2filename) {
 
    QString sn;
    try {
      PvlGroup snGroup = FindSerialTranslation(label);
      sn = CreateSerialNumber(snGroup, (int)snGroup["ObservationKeys"]);
    }
    catch(IException &) {
      if(def2filename) {
        //  Try to return the filename if it exists in the label, otherwise use
        //  "Unknown" as a last resort.
        QString snTemp = label.fileName();
        if(!snTemp.isEmpty()) {
          sn = FileName(snTemp).name();
        }
        else {
          sn = "Unknown";
        }
      }
      else {
        sn = "Unknown";
      }
    }
    
    return sn;
  }

  QString SerialNumber::Compose(Cube &cube, bool def2filename) {
    return Compose(*cube.label(), def2filename);
  }

  QString SerialNumber::Compose(const QString &filename, bool def2filename) {
    Pvl p(filename);
    return Compose(p, def2filename);
  }

  PvlGroup SerialNumber::FindSerialTranslation(Pvl &label) {
    Pvl outLabel;
 
    // check if label has CSM information
    if(label.findObject("IsisCube").hasGroup("CsmInfo")) {
      static QString csmTransFile = "$ISISROOT/appdata/translations/CsmSerialNumber.trn";
      PvlToPvlTranslationManager csmTranslator(label, csmTransFile);
      csmTranslator.Auto(outLabel);
    }
    else {
      // Get the mission name
      static QString missionTransFile = "$ISISROOT/appdata/translations/MissionName2DataDir.trn";
      static PvlToPvlTranslationManager missionXlater(missionTransFile);
      missionXlater.SetLabel(label);
      QString mission = missionXlater.Translate("MissionName");
 
      // Get the instrument name
      static QString instTransFile = "$ISISROOT/appdata/translations/Instruments.trn";
      static PvlToPvlTranslationManager instrumentXlater(instTransFile);
      instrumentXlater.SetLabel(label);
      QString instrument = instrumentXlater.Translate("InstrumentName");
 
      // We want to use this instrument's translation manager. It's much faster for
      //   SerialNumberList if we keep the translation manager in memory, so re-reading
      //   from the disk is not necessary every time. To do this, we'll use a map to store
      //   the translation managers with a string identifier to find them. This identifier
      //   needs to have the mission name and the instrument name.
 
      //  Create the static map to keep the translation managers in memory
      static std::map<QString, PvlToPvlTranslationManager> missionTranslators;
 
      // Determine the key for this translation manager - must have both mission and instrument
      QString key = mission + "_" + instrument;
 
      // Try to find an existing translation manager with the key
      std::map<QString, PvlToPvlTranslationManager>::iterator translationIterator = missionTranslators.find(key);
 
      // If we don't succeed, create one
      if(translationIterator == missionTranslators.end()) {
        // Get the file
 
        FileName snFile((QString) "$ISISROOT/appdata/translations/" + mission + instrument + "SerialNumber.trn");
 
        // use the translation file to generate keywords
        missionTranslators.insert(
          std::pair<QString, PvlToPvlTranslationManager>(key, PvlToPvlTranslationManager(snFile.expanded()))
        );
 
        translationIterator = missionTranslators.find(key);
      }
      translationIterator->second.SetLabel(label);
      translationIterator->second.Auto(outLabel);
    }
 
    PvlGroup snGroup = outLabel.findGroup("SerialNumberKeywords");
    snGroup += PvlKeyword("ObservationKeys", toString(snGroup.keywords()));
 
    return snGroup;
  }

  QString SerialNumber::CreateSerialNumber(PvlGroup &snGroup, int keys) {
    QString sn = snGroup["Keyword1"][0];
    for(int i = 2; i <= keys; i++) {
      QString keyword = QString("Keyword%1").arg(i);
      sn += "/" + snGroup[keyword][0];
    }
    return sn;
  }

  QString SerialNumber::ComposeObservation(const QString &sn, SerialNumberList &list, bool def2filename) {
    QString filename = list.fileName(sn);
    return ObservationNumber::Compose(filename, def2filename);
  }
}