NexusFile_fwd.h

Go to the documentation of this file.

 
#pragma once
 
#include "MantidNexus/DllConfig.h"
#include "MantidNexus/NexusAddress.h"
#include <iosfwd>
#include <map>
#include <string>
#include <vector>
 
// forward declare typedefs from hdf5
typedef int64_t hid_t;
typedef uint64_t hsize_t;
typedef int herr_t;
 
enum class NXaccess : unsigned int { READ = 0x0000u, RDWR = 0x0001u, CREATE5 = 0x0002u };
 
MANTID_NEXUS_DLL std::ostream &operator<<(std::ostream &os, const NXaccess &value);
 
enum class NXentrytype : int { group = 0, sds = 1 };
 
typedef struct {
  std::string targetAddress; /* address to item to link */
  NXentrytype linkType;      /* HDF5: 0 for group link, 1 for SDS link */
} NXlink;
 
/*--------------------------------------------------------------------------*/
 
class MANTID_NEXUS_DLL NXnumtype {
public:
  // first hexadigit: 2 = float, 1 = signed int, 0 = unsigned int, F = special
  // second hexadigit: width in bytes
  static unsigned short constexpr FLOAT32 = 0x24u; // 10 0100 = 0x24
  static unsigned short constexpr FLOAT64 = 0x28u; // 10 1000 = 0x28
  static unsigned short constexpr INT8 = 0x11u;    // 01 0001 = 0x11
  static unsigned short constexpr INT16 = 0x12u;   // 01 0010 = 0x12
  static unsigned short constexpr INT32 = 0x14u;   // 01 0100 = 0x14
  static unsigned short constexpr INT64 = 0x18u;   // 01 1000 = 0x18
  static unsigned short constexpr UINT8 = 0x01u;   // 00 0001 = 0x01
  static unsigned short constexpr UINT16 = 0x02u;  // 00 0010 = 0x02
  static unsigned short constexpr UINT32 = 0x04u;  // 00 0100 = 0x04
  static unsigned short constexpr UINT64 = 0x08u;  // 00 1000 = 0x08
  static unsigned short constexpr CHAR = 0xF0u;    // 11 0000 = 0xF0
  static unsigned short constexpr BINARY = 0xF1u;  // 11 0001 = 0xF1
  static unsigned short constexpr BAD = 0xFFu;     // 11 1111 = 0xFF
 
  // for &'ing with a type to check what it is:
  // & will be true (nonzero) if it is of type indicated; false (zero) else
  static unsigned short constexpr FLOAT_TYPE = 0x20u;
  static unsigned short constexpr SPECIAL_TYPE = 0x80u;
 
private:
  int m_val;
  static int validate_val(int const x);
 
public:
  NXnumtype();
  NXnumtype(int const val);
  NXnumtype &operator=(int const);
  operator int() const;
  operator std::string() const;
 
  // Will return true if the type is a float
  bool isFloat() { return m_val & FLOAT_TYPE; }
  // Will return true if the type is a special (char, binary, or bad)
  bool isSpecial() { return m_val & SPECIAL_TYPE; }
};
 
MANTID_NEXUS_DLL std::ostream &operator<<(std::ostream &os, const NXnumtype &value);
 
enum class NXcompression { CHUNK, NONE, LZW, RLE, HUF };
 
MANTID_NEXUS_DLL std::ostream &operator<<(std::ostream &os, const NXcompression &value);
 
// forward declare
namespace Mantid::Nexus {
 
inline std::string const GROUP_CLASS_SPEC("NX_class");
inline std::string const UNKNOWN_GROUP_SPEC("NX_UNKNOWN_GROUP");
inline std::string const SCIENTIFIC_DATA_SET("SDS");
 
typedef hsize_t dimsize_t;
typedef std::vector<dimsize_t> DimVector;
 
typedef std::pair<std::string, std::string> Entry;
typedef std::map<std::string, std::string> Entries;
 
struct Info {
  NXnumtype type;
  DimVector dims;
};
 
struct AttrInfo {
  NXnumtype type;
  std::size_t length;
  std::string name;
};
 
class File;
} // namespace Mantid::Nexus
 
constexpr std::size_t NX_MAXRANK(32);
constexpr Mantid::Nexus::dimsize_t NX_UNLIMITED(-1); // AKA max of unsigned long, equivalent to H5S_UNLIMITED