Allow stored NeXus handle to be use in ::confidence checks. Refs #7263

Code/Mantid/Framework/API/inc/MantidAPI/IHDFFileLoader.h

@@ -37,7 +37,7 @@ namespace Mantid
     {
     public:
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const = 0;
+      virtual int confidence(Kernel::HDFDescriptor & descriptor) const = 0;
     };
 
   } // namespace API

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h

@@ -81,7 +81,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus";}
 
       /// Returns a confidence value that this algorithm can load a file
-      int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      int confidence(Kernel::HDFDescriptor & descriptor) const;
 
       /** Sets whether the pixel counts will be pre-counted.
        * @param value :: true if you want to precount. */

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadILL.h

@@ -67,7 +67,7 @@ namespace DataHandling {
     }
 
     /// Returns a confidence value that this algorithm can load a file
-    int confidence(const Kernel::HDFDescriptor & descriptor) const;
+    int confidence(Kernel::HDFDescriptor & descriptor) const;
 
   private:
     /// Sets documentation strings for this algorithm

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadISISNexus2.h

@@ -82,7 +82,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus"; }
 
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
       /// Spectra block descriptor
       struct SpectraBlock

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadLLB.h

@@ -42,7 +42,7 @@ class DLLExport LoadLLB: public API::IHDFFileLoader  {
 	virtual const std::string category() const;
 
     /// Returns a confidence value that this algorithm can load a file
-    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+    virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
 private:
 	virtual void initDocs();

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMcStasNexus.h

@@ -42,7 +42,7 @@ namespace DataHandling
     virtual const std::string category() const;
 
     /// Returns a confidence value that this algorithm can load a file
-    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+    virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
   private:
     virtual void initDocs();

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h

@@ -73,7 +73,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      virtual int confidence(Kernel::HDFDescriptor &) const;
 
     protected:
 

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus1.h

@@ -75,7 +75,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
     protected:
       /// Overwrites Algorithm method

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus2.h

@@ -70,7 +70,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
     private:
       /// Sets documentation strings for this algorithm

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNXSPE.h

@@ -52,7 +52,7 @@ namespace DataHandling
     virtual const std::string category() const { return "DataHandling\\Nexus;DataHandling\\SPE;Inelastic";}
 
     /// Returns a confidence value that this algorithm can load a file
-    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+    virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
   private:
     /// Sets documentation strings for this algorithm

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNexusProcessed.h

@@ -63,7 +63,7 @@ namespace Mantid
       virtual const std::string category() const { return "DataHandling\\Nexus";}
 
       /// Returns a confidence value that this algorithm can load a file
-      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+      virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
     private:
       /// Sets documentation strings for this algorithm

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadQKK.h

@@ -52,7 +52,7 @@ class DLLExport LoadQKK : public  API::IHDFFileLoader
   virtual const std::string category() const { return "DataHandling"; }
 
   /// Returns a confidence value that this algorithm can load a file
-  virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+  virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
 private:
   /// Sets documentation strings for this algorithm

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadSINQ.h

@@ -51,7 +51,7 @@ class DLLExport LoadSINQ: public API::IHDFFileLoader
 	virtual const std::string category() const;
 
 	/// Returns a confidence value that this algorithm can load a file
-  virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+  virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
 private:
 	virtual void initDocs();

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadSNSNexus.h

@@ -59,7 +59,7 @@ namespace Mantid
       virtual const std::string category() const { return "Deprecated"; }
 
       /// Returns a confidence value that this algorithm can load a file (Required by base class)
-      virtual int confidence(const Kernel::HDFDescriptor &) const { return 0; }
+      virtual int confidence(Kernel::HDFDescriptor &) const { return 0; }
     };
 
   } // namespace DataHandling

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadSassena.h

@@ -68,7 +68,7 @@ namespace Mantid
     virtual const std::string category() const { return "DataHandling\\Sassena"; }
 
     /// Returns a confidence value that this algorithm can load a file
-    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+    virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
   protected:
     /// Add a workspace to the group and register in the analysis data service

Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadTOFRawNexus.h

@@ -64,7 +64,7 @@ class DLLExport LoadTOFRawNexus : public API::IHDFFileLoader
   static std::string getEntryName(const std::string & filename);
 
   /// Returns a confidence value that this algorithm can load a file
-  virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+  virtual int confidence(Kernel::HDFDescriptor & descriptor) const;
 
   void countPixels(const std::string &nexusfilename, const std::string & entry_name,
        std::vector<std::string> & bankNames);

Code/Mantid/Framework/DataHandling/src/LoadEventNexus.cpp

@@ -914,7 +914,7 @@ LoadEventNexus::~LoadEventNexus()
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadEventNexus::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadEventNexus::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   int confidence(0);
   if(descriptor.classTypeExists("NXevent_data"))

Code/Mantid/Framework/DataHandling/src/LoadILL.cpp

@@ -52,7 +52,7 @@ namespace Mantid {
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadILL::confidence(const Kernel::HDFDescriptor & descriptor) const
+    int LoadILL::confidence(Kernel::HDFDescriptor & descriptor) const
     {
       const std::string root =  "/" + descriptor.firstEntryNameType().first + "/";
       for(auto it = supportedInstruments.begin(); it != supportedInstruments.end() ; ++it)

Code/Mantid/Framework/DataHandling/src/LoadISISNexus2.cpp

@@ -64,7 +64,7 @@ namespace Mantid
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadISISNexus2::confidence(const Kernel::HDFDescriptor & descriptor) const
+    int LoadISISNexus2::confidence(Kernel::HDFDescriptor & descriptor) const
     {
       if(descriptor.pathOfTypeExists("/raw_data_1","NXentry")) return 80;
       return 0;

Code/Mantid/Framework/DataHandling/src/LoadLLB.cpp

@@ -61,7 +61,7 @@ const std::string LoadLLB::category() const {
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadLLB::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadLLB::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   const auto & firstEntry = descriptor.firstEntryNameType();
   if(descriptor.pathExists("/" + firstEntry.first + "/nxinstrument/name")) return 80;

Code/Mantid/Framework/DataHandling/src/LoadMcStasNexus.cpp

@@ -57,7 +57,7 @@ namespace DataHandling
    * @param descriptor A descriptor for the file
    * @returns An integer specifying the confidence level. 0 indicates it will not be used
    */
-  int LoadMcStasNexus::confidence(const Kernel::HDFDescriptor & descriptor) const
+  int LoadMcStasNexus::confidence(Kernel::HDFDescriptor & descriptor) const
   {
     using namespace ::NeXus;
 	  // We will look at the first entry and check for a

Code/Mantid/Framework/DataHandling/src/LoadMuonNexus.cpp

@@ -167,7 +167,7 @@ namespace Mantid
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadMuonNexus::confidence(const Kernel::HDFDescriptor &) const
+    int LoadMuonNexus::confidence(Kernel::HDFDescriptor &) const
     {
       return 0; // Not to be used but LoadMuonNexus2, which inherits from this will
     }

Code/Mantid/Framework/DataHandling/src/LoadMuonNexus1.cpp

@@ -639,7 +639,7 @@ namespace Mantid
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadMuonNexus1::confidence(const Kernel::HDFDescriptor & descriptor) const
+    int LoadMuonNexus1::confidence(Kernel::HDFDescriptor & descriptor) const
     {
       const auto & firstEntryNameType = descriptor.firstEntryNameType();
       const std::string root = "/" + firstEntryNameType.first;
@@ -655,20 +655,24 @@ namespace Mantid
 
       try
       {
-        NXRoot root(descriptor.filename());
-        NXEntry entry = root.openFirstEntry();
         std::string versionField = "idf_version";
         if(upperIDF) versionField = "IDF_version";
 
-        if ( entry.getInt( versionField ) != 1 ) return 0;
-        std::string definition = entry.getString( "analysis" );
-        if ( definition == "muonTD" || definition == "pulsedTD" )
+        auto &file = descriptor.data();
+        file.openPath(root + "/" + versionField);
+        int32_t version = 0;
+        file.getData(&version);
+        if ( version != 1 ) return 0;
+
+        file.openPath(root + "/analysis");
+        std::string def = file.getStrData();
+        if (def == "muonTD" || def == "pulsedTD")
         {
           // If all this succeeded then we'll assume this is an ISIS Muon NeXus file version 2
           return 81;
         }
       }
-      catch( ... )
+      catch(...)
       {
       }
       return 0;

Code/Mantid/Framework/DataHandling/src/LoadMuonNexus2.cpp

@@ -103,8 +103,9 @@ namespace Mantid
       std::string filePath = getPropertyValue("Filename");
       LoadMuonNexus1 load1; load1.initialize();
 
-      int confidence1 = load1.confidence( filePath );
-      int confidence2 = this->confidence( filePath );
+      Kernel::HDFDescriptor descriptor(filePath);
+      int confidence1 = load1.confidence(descriptor);
+      int confidence2 = this->confidence(descriptor);
 
       // if none can load the file throw
       if ( confidence1 < 80 && confidence2 < 80)
@@ -487,7 +488,7 @@ namespace Mantid
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadMuonNexus2::confidence(const Kernel::HDFDescriptor & descriptor) const
+    int LoadMuonNexus2::confidence(Kernel::HDFDescriptor & descriptor) const
     {
       const auto & firstEntryNameType = descriptor.firstEntryNameType();
       const std::string root = "/" + firstEntryNameType.first;
@@ -503,15 +504,18 @@ namespace Mantid
 
       try
       {
-        NXRoot root(descriptor.filename());
-        NXEntry entry = root.openFirstEntry();
-
         std::string versionField = "idf_version";
         if(upperIDF) versionField = "IDF_version";
 
-        if ( entry.getInt(versionField) != 2 ) return 0;
-        std::string definition = entry.getString("definition");
-        if ( definition == "muonTD" || definition == "pulsedTD" )
+        auto &file = descriptor.data();
+        file.openPath(root + "/" + versionField);
+        int32_t version = 0;
+        file.getData(&version);
+        if ( version != 2 ) return 0;
+
+        file.openPath(root + "/definition");
+        std::string def = file.getStrData();
+        if ( def == "muonTD" || def == "pulsedTD" )
         {
           // If all this succeeded then we'll assume this is an ISIS Muon NeXus file version 2
           return 81;

Code/Mantid/Framework/DataHandling/src/LoadNXSPE.cpp

@@ -64,7 +64,7 @@ namespace DataHandling
    * @param descriptor A descriptor for the file
    * @returns An integer specifying the confidence level. 0 indicates it will not be used
    */
-  int LoadNXSPE::confidence(const Kernel::HDFDescriptor & descriptor) const
+  int LoadNXSPE::confidence(Kernel::HDFDescriptor & descriptor) const
   {
     int confidence(0);
     typedef std::map<std::string,std::string> string_map_t;

Code/Mantid/Framework/DataHandling/src/LoadNexusProcessed.cpp

@@ -93,7 +93,7 @@ LoadNexusProcessed::~LoadNexusProcessed()
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadNexusProcessed::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadNexusProcessed::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   if(descriptor.pathExists("/mantid_workspace_1")) return 80;
   else return 0;

Code/Mantid/Framework/DataHandling/src/LoadQKK.cpp

@@ -39,7 +39,7 @@ namespace Mantid
      * @param descriptor A descriptor for the file
      * @returns An integer specifying the confidence level. 0 indicates it will not be used
      */
-    int LoadQKK::confidence(const Kernel::HDFDescriptor & descriptor) const
+    int LoadQKK::confidence(Kernel::HDFDescriptor & descriptor) const
     {
       const auto & firstEntryName = descriptor.firstEntryNameType().first;
       if(descriptor.pathExists("/" + firstEntryName + "/data/hmm_xy")) return 80;

Code/Mantid/Framework/DataHandling/src/LoadSINQ.cpp

@@ -72,7 +72,7 @@ void LoadSINQ::initDocs() {
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadSINQ::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadSINQ::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   const std::string root =  "/" + descriptor.firstEntryNameType().first + "/";
   for(auto it = supportedInstruments.begin(); it != supportedInstruments.end() ; ++it)

Code/Mantid/Framework/DataHandling/src/LoadSassena.cpp

@@ -55,7 +55,7 @@ void LoadSassena::initDocs()
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadSassena::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadSassena::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   if(descriptor.hasRootAttr("sassena_version")) return 99;
   return 0;

Code/Mantid/Framework/DataHandling/src/LoadTOFRawNexus.cpp

@@ -83,7 +83,7 @@ void LoadTOFRawNexus::init()
  * @param descriptor A descriptor for the file
  * @returns An integer specifying the confidence level. 0 indicates it will not be used
  */
-int LoadTOFRawNexus::confidence(const Kernel::HDFDescriptor & descriptor) const
+int LoadTOFRawNexus::confidence(Kernel::HDFDescriptor & descriptor) const
 {
   int confidence(0);
   if( descriptor.pathOfTypeExists("/entry", "NXentry") ||

Code/Mantid/Framework/DataHandling/src/UpdateInstrumentFromFile.cpp

@@ -137,8 +137,10 @@ namespace Mantid
       if(HDFDescriptor::isHDF(filename))
       {
         LoadISISNexus2 isisNexus;
-        if(isisNexus.confidence(filename) > 0)
+        auto *descriptor = new Kernel::HDFDescriptor(filename);
+        if(isisNexus.confidence(*descriptor) > 0)
         {
+          delete descriptor;
           updateFromNeXus(filename);
           return;
         }

Code/Mantid/Framework/DataHandling/test/LoadQKKTest.h

@@ -31,8 +31,8 @@ class LoadQKKTest : public CxxTest::TestSuite
     Mantid::DataHandling::LoadQKK loader;
     loader.initialize();
     loader.setPropertyValue("Filename", "QKK0029775.nx.hdf"); // find the full path
-
-    TS_ASSERT_EQUALS(80, loader.confidence(loader.getPropertyValue("Filename")));
+    Mantid::Kernel::HDFDescriptor descr(loader.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS(80, loader.confidence(descr));
   }
 
   void testInit()

Code/Mantid/Framework/DataHandling/test/LoadSassenaTest.h

@@ -28,7 +28,8 @@ class LoadSassenaTest : public CxxTest::TestSuite
   {
     if( !m_alg.isInitialized() ) m_alg.initialize();
     m_alg.setPropertyValue( "Filename", m_inputFile );
-    TS_ASSERT_EQUALS(m_alg.confidence(m_alg.getPropertyValue("Filename")), 99);
+    Mantid::Kernel::HDFDescriptor descr(m_alg.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS(m_alg.confidence(descr), 99);
   }
 
   void test_exec()

Code/Mantid/Framework/DataHandling/test/LoadTOFRawNexusTest.h

@@ -31,14 +31,22 @@ class LoadTOFRawNexusTest: public CxxTest::TestSuite
   {
     LoadTOFRawNexus alg;
     TS_ASSERT_THROWS_NOTHING( alg.initialize() );
+
     alg.setPropertyValue("Filename", "REF_L_32035.nxs");
-    TS_ASSERT_EQUALS( alg.confidence(alg.getPropertyValue("Filename")), 80 );
+    Mantid::Kernel::HDFDescriptor descr(alg.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS( alg.confidence(descr), 80 );
+
     alg.setPropertyValue("Filename", "CNCS_7860_event.nxs");
-    TS_ASSERT_EQUALS( alg.confidence(alg.getPropertyValue("Filename")), 20 );
+    Mantid::Kernel::HDFDescriptor descr2(alg.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS( alg.confidence(descr2), 20 );
+
     alg.setPropertyValue("Filename", "argus0026577.nxs");
-    TS_ASSERT_EQUALS( alg.confidence(alg.getPropertyValue("Filename")), 0 );
+    Mantid::Kernel::HDFDescriptor descr3(alg.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS( alg.confidence(descr3), 0 );
+
     alg.setPropertyValue("Filename", "PG3_733.nxs");
-    TS_ASSERT_EQUALS( alg.confidence(alg.getPropertyValue("Filename")), 0 );
+    Mantid::Kernel::HDFDescriptor descr4(alg.getPropertyValue("Filename"));
+    TS_ASSERT_EQUALS( alg.confidence(descr4), 0 );
 
   }