First lot of updates for new loader check style. Refs #7263

mantidproject · Jul 4, 2013 · 5eec929 · 5eec929
1 parent ff1f7ad
commit 5eec929
Show file tree

Hide file tree

Showing 36 changed files with 326 additions and 798 deletions.
diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadEventNexus.h
@@ -4,7 +4,7 @@
 //----------------------------------------------------------------------
 // Includes
 //----------------------------------------------------------------------
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 #include "MantidDataObjects/EventWorkspace.h"
 #include <nexus/NeXusFile.hpp>
 #include <nexus/NeXusException.hpp>
@@ -68,7 +68,7 @@ namespace Mantid
 
     File change history is stored at: <https://github.com/mantidproject/mantid>
     */
-    class DLLExport LoadEventNexus : public API::IDataFileChecker
+    class DLLExport LoadEventNexus : public API::IHDFFileLoader
     {
     public:
       /// Sets documentation strings for this algorithm
@@ -80,10 +80,8 @@ namespace Mantid
       virtual int version() const { return 1;};
       virtual const std::string category() const { return "DataHandling\\Nexus";}
 
-      /// do a quick check that this file can be loaded 
-      bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      int fileCheck(const std::string& filePath);
+      /// Returns a confidence value that this algorithm can load a file
+      int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
       /** Sets whether the pixel counts will be pre-counted.
        * @param value :: true if you want to precount. */

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadILL.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadILL.h
@@ -4,8 +4,7 @@
 //---------------------------------------------------
 // Includes
 //---------------------------------------------------
-#include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 #include "MantidNexus/NexusClasses.h"
 
 namespace Mantid {
@@ -39,14 +38,13 @@ namespace DataHandling {
  File change history is stored at: <https://github.com/mantidproject/mantid>
  Code Documentation is available at: <http://doxygen.mantidproject.org>
  */
-  class DLLExport LoadILL: public API::IDataFileChecker {
+  class DLLExport LoadILL: public API::IHDFFileLoader 
+  {
   public:
     /// Constructor
-    LoadILL() :
-      API::IDataFileChecker(), m_instrumentName(""),
-      //m_nexusInstrumentEntryName(""),
-      m_wavelength(0), m_channelWidth(0) {
-
+    LoadILL() : API::IHDFFileLoader(), m_instrumentName(""),
+      m_wavelength(0), m_channelWidth(0) 
+    {
       supportedInstruments.push_back("IN4");
       supportedInstruments.push_back("IN5");
       supportedInstruments.push_back("IN6");
@@ -67,11 +65,10 @@ namespace DataHandling {
     virtual const std::string category() const {
       return "DataHandling";
     }
-    ///checks the file can be loaded by reading 1st 100 bytes and looking at the file extension.
-    bool quickFileCheck(const std::string& filePath, size_t nread,
-			const file_header& header);
-    /// check the structure of the file and if this file can be loaded return a value between 1 and 100
-    int fileCheck(const std::string& filePath);
+
+    /// Returns a confidence value that this algorithm can load a file
+    int confidence(const Kernel::HDFDescriptor & descriptor) const;
+
   private:
     /// Sets documentation strings for this algorithm
     virtual void initDocs();
@@ -81,7 +78,7 @@ namespace DataHandling {
     void exec();
 
     void setInstrumentName(NeXus::NXEntry& entry);
-    std::string getInstrumentName(NeXus::NXEntry& entry);
+    std::string getInstrumentName(NeXus::NXEntry& entry) const;
     void initWorkSpace(NeXus::NXEntry& entry);
     void initInstrumentSpecific();
     void loadRunDetails(NeXus::NXEntry & entry);
@@ -122,10 +119,6 @@ namespace DataHandling {
 
     std::vector<std::string> supportedInstruments;
 
-    // Nexus instrument entry is of the format /entry0/<XXX>/
-    // XXX changes from version to version
-    std::string m_nexusInstrumentEntryName;
-
 };
 
 } // namespace DataHandling

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadISISNexus2.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadISISNexus2.h
@@ -5,7 +5,7 @@
 // Includes
 //----------------------------------------------------------------------
 #include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 #include "MantidDataObjects/Workspace2D.h"
 #include "MantidDataHandling/ISISRunLogs.h"
 #include "MantidNexus/NexusClasses.h"
@@ -67,7 +67,7 @@ namespace Mantid
     File change history is stored at: <https://github.com/mantidproject/mantid>. 
     Code Documentation is available at: <http://doxygen.mantidproject.org>
     */
-    class DLLExport LoadISISNexus2 : public API::IDataFileChecker 
+    class DLLExport LoadISISNexus2 : public API::IHDFFileLoader 
     {
     public:
       /// Default constructor
@@ -81,11 +81,9 @@ namespace Mantid
       /// Algorithm's category for identification overriding a virtual method
       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;
 
-     /// do a quick check that this file can be loaded 
-      virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      virtual int fileCheck(const std::string& filePath);
       /// Spectra block descriptor
       struct SpectraBlock
       {

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadLLB.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadLLB.h
@@ -2,8 +2,7 @@
 #define MANTID_DATAHANDLING_LOADLLB_H_
 
 #include "MantidKernel/System.h"
-#include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 #include "MantidNexus/NexusClasses.h"
 
 namespace Mantid
@@ -33,26 +32,24 @@ namespace DataHandling
     File change history is stored at: <https://github.com/mantidproject/mantid>
     Code Documentation is available at: <http://doxygen.mantidproject.org>
   */
-class DLLExport LoadLLB: public API::IDataFileChecker  {
+class DLLExport LoadLLB: public API::IHDFFileLoader  {
 public:
 	LoadLLB();
 	virtual ~LoadLLB();
 
 	virtual const std::string name() const;
 	virtual int version() const;
 	virtual const std::string category() const;
-	///checks the file can be loaded by reading 1st 100 bytes and looking at the file extension.
-	bool quickFileCheck(const std::string& filePath, size_t nread,
-			const file_header& header);
-	/// check the structure of the file and if this file can be loaded return a value between 1 and 100
-	int fileCheck(const std::string& filePath);
+
+    /// Returns a confidence value that this algorithm can load a file
+    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
 private:
 	virtual void initDocs();
 	void init();
 	void exec();
 	void setInstrumentName(NeXus::NXEntry& entry);
-	std::string getInstrumentName(NeXus::NXEntry& entry);
+	std::string getInstrumentName(NeXus::NXEntry& entry) const;
 	void initWorkSpace(NeXus::NXEntry&);
 	void loadTimeDetails(NeXus::NXEntry& entry);
 	void loadDataIntoTheWorkSpace(NeXus::NXEntry&);
@@ -71,7 +68,6 @@ class DLLExport LoadLLB: public API::IDataFileChecker  {
 	void runLoadInstrument();
 
 	std::vector<std::string> supportedInstruments;
-	std::string m_nexusInstrumentEntryName;
 	std::string m_instrumentName;
 	API::MatrixWorkspace_sptr m_localWorkspace;
 	size_t m_numberOfTubes; // number of tubes - X

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMcStasNexus.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMcStasNexus.h
@@ -2,8 +2,7 @@
 #define MANTID_DATAHANDLING_LOADMCSTASNEXUS_H_
 
 #include "MantidKernel/System.h"
-#include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 
 namespace Mantid
 {
@@ -32,7 +31,7 @@ namespace DataHandling
     File change history is stored at: <https://github.com/mantidproject/mantid>
     Code Documentation is available at: <http://doxygen.mantidproject.org>
   */
-  class DLLExport LoadMcStasNexus  : public API::IDataFileChecker
+  class DLLExport LoadMcStasNexus  : public API::IHDFFileLoader
   {
   public:
     LoadMcStasNexus();
@@ -42,10 +41,8 @@ namespace DataHandling
     virtual int version() const;
     virtual const std::string category() const;
 
-    /// do a quick check that this file can be loaded 
-    virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-    /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-    virtual int fileCheck(const std::string& filePath);
+    /// Returns a confidence value that this algorithm can load a file
+    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
   private:
     virtual void initDocs();
@@ -59,4 +56,4 @@ namespace DataHandling
 } // namespace DataHandling
 } // namespace Mantid
 
-#endif  /* MANTID_DATAHANDLING_LOADMCSTASNEXUS_H_ */
+#endif  /* MANTID_DATAHANDLING_LOADMCSTASNEXUS_H_ */
diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus.h
@@ -4,9 +4,8 @@
 //----------------------------------------------------------------------
 // Includes
 //----------------------------------------------------------------------
-#include "MantidAPI/Algorithm.h"
+#include "MantidAPI/IHDFFileLoader.h"
 #include "MantidDataObjects/Workspace2D.h"
-#include "MantidAPI/IDataFileChecker.h"
 #include "MantidKernel/System.h"
 
 //----------------------------------------------------------------------
@@ -59,7 +58,7 @@ namespace Mantid
     File change history is stored at: <https://github.com/mantidproject/mantid>. 
     Code Documentation is available at: <http://doxygen.mantidproject.org>
     */
-    class DLLExport LoadMuonNexus : public API::IDataFileChecker
+    class DLLExport LoadMuonNexus : public API::IHDFFileLoader
     {
     public:
       /// Default constructor
@@ -73,10 +72,9 @@ namespace Mantid
       /// Algorithm's category for identification overriding a virtual method
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
-      /// do a quick check that this file can be loaded 
-      virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      virtual int fileCheck(const std::string& filePath);
+      /// Returns a confidence value that this algorithm can load a file
+      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+
     protected:
 
       virtual void runLoadInstrumentFromNexus(DataObjects::Workspace2D_sptr) {}

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus1.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus1.h
@@ -74,8 +74,9 @@ namespace Mantid
       /// Algorithm's category for identification overriding a virtual method
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      virtual int fileCheck(const std::string& filePath);
+      /// Returns a confidence value that this algorithm can load a file
+      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+
     protected:
       /// Overwrites Algorithm method
       void exec();

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus2.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadMuonNexus2.h
@@ -5,7 +5,6 @@
 // Includes
 //----------------------------------------------------------------------
 #include "MantidDataHandling/LoadMuonNexus.h"
-#include "MantidAPI/IDataFileChecker.h"
 #include "MantidNexus/NexusClasses.h"
 
 namespace Mantid
@@ -70,8 +69,9 @@ namespace Mantid
       /// Algorithm's category for identification overriding a virtual method
       virtual const std::string category() const { return "DataHandling\\Nexus;Muon"; }
 
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      virtual int fileCheck(const std::string& filePath);
+      /// Returns a confidence value that this algorithm can load a file
+      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
+
     private:
       /// Sets documentation strings for this algorithm
       virtual void initDocs();

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNXSPE.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNXSPE.h
@@ -2,8 +2,7 @@
 #define MANTID_DATAHANDLING_LOADNXSPE_H_
 
 #include "MantidKernel/System.h"
-#include "MantidAPI/Algorithm.h" 
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 
 namespace Mantid
 {
@@ -39,7 +38,7 @@ namespace DataHandling
     File change history is stored at: <https://github.com/mantidproject/mantid>
     Code Documentation is available at: <http://doxygen.mantidproject.org>
   */
-  class DLLExport LoadNXSPE  : public API::IDataFileChecker
+  class DLLExport LoadNXSPE  : public API::IHDFFileLoader
   {
   public:
     LoadNXSPE();
@@ -51,11 +50,9 @@ namespace DataHandling
     virtual int version() const { return 1;};
     /// Algorithm's category for identification
     virtual const std::string category() const { return "DataHandling\\Nexus;DataHandling\\SPE;Inelastic";}
-    /// Do a quick check that this file can be loaded
-    virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-    /// check the structure of the file and  return a value between
-    /// 0 and 100 of how much this file can be loaded
-    virtual int fileCheck(const std::string& filePath);
+
+    /// Returns a confidence value that this algorithm can load a file
+    virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
   private:
     /// Sets documentation strings for this algorithm

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNexusProcessed.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadNexusProcessed.h
@@ -4,8 +4,7 @@
 //----------------------------------------------------------------------
 // Includes
 //----------------------------------------------------------------------
-#include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 
 #include "MantidNexus/NexusClasses.h"
 #include <nexus/NeXusFile.hpp>
@@ -48,7 +47,7 @@ namespace Mantid
     File change history is stored at: <https://github.com/mantidproject/mantid>. 
     Code Documentation is available at: <http://doxygen.mantidproject.org>
     */
-    class DLLExport LoadNexusProcessed : public API::IDataFileChecker 
+    class DLLExport LoadNexusProcessed : public API::IHDFFileLoader
     {
 
     public:
@@ -63,10 +62,8 @@ namespace Mantid
       /// Algorithm's category for identification overriding a virtual method
       virtual const std::string category() const { return "DataHandling\\Nexus";}
 
-      /// do a quick check that this file can be loaded 
-      virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-      /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-      virtual int fileCheck(const std::string& filePath);
+      /// Returns a confidence value that this algorithm can load a file
+      virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
     private:
       /// Sets documentation strings for this algorithm

diff --git a/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadQKK.h b/Code/Mantid/Framework/DataHandling/inc/MantidDataHandling/LoadQKK.h
@@ -4,8 +4,7 @@
 //---------------------------------------------------
 // Includes
 //---------------------------------------------------
-#include "MantidAPI/Algorithm.h"
-#include "MantidAPI/IDataFileChecker.h"
+#include "MantidAPI/IHDFFileLoader.h"
 
 namespace Mantid
 {
@@ -38,7 +37,7 @@ namespace DataHandling
      File change history is stored at: <https://github.com/mantidproject/mantid>
      Code Documentation is available at: <http://doxygen.mantidproject.org>
   */
-class DLLExport LoadQKK : public  API::IDataFileChecker 
+class DLLExport LoadQKK : public  API::IHDFFileLoader
 {
 public:
   /// (Empty) Constructor
@@ -52,10 +51,8 @@ class DLLExport LoadQKK : public  API::IDataFileChecker
   /// Algorithm's category for identification
   virtual const std::string category() const { return "DataHandling"; }
 
-  /// do a quick check that this file can be loaded 
-  virtual bool quickFileCheck(const std::string& filePath,size_t nread,const file_header& header);
-  /// check the structure of the file and  return a value between 0 and 100 of how much this file can be loaded
-  virtual int fileCheck(const std::string& filePath);
+  /// Returns a confidence value that this algorithm can load a file
+  virtual int confidence(const Kernel::HDFDescriptor & descriptor) const;
 
 private:
   /// Sets documentation strings for this algorithm