InstrumentInfo.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidKernel/DllConfig.h"
#include "MantidKernel/LiveListenerInfo.h"
#include "MantidKernel/TopicInfo.h"
 
#include <map>
#include <set>
#include <string>
#include <vector>
 
//----------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------
namespace Poco {
namespace XML {
class Element;
}
} // namespace Poco
 
namespace Mantid {
namespace Kernel {
 
//----------------------------------------------------------------------
// Forward declarations
//----------------------------------------------------------------------
class FacilityInfo;
 
class MANTID_KERNEL_DLL InstrumentInfo {
public:
  InstrumentInfo(const FacilityInfo *f, const Poco::XML::Element *elem);
  bool operator==(const InstrumentInfo &rhs) const;
  const std::string name() const;
  const std::string shortName() const;
  int zeroPadding(unsigned int runNumber) const;
  std::string filePrefix(unsigned int runNumber) const;
  std::string delimiter() const;
  const std::set<std::string> &techniques() const;
  const FacilityInfo &facility() const;
 
  std::string liveListener(const std::string &name = "") const;
  std::string liveDataAddress(const std::string &name = "") const;
  const LiveListenerInfo &liveListenerInfo(std::string name = "") const;
  bool hasLiveListenerInfo() const;
  const std::vector<LiveListenerInfo> &liveListenerInfoList() const;
  const std::vector<TopicInfo> &topicInfoList() const { return m_kafkaTopics; }
 
private:
  void fillTechniques(const Poco::XML::Element *elem);
  void fillLiveData(const Poco::XML::Element *elem);
  void fillZeroPadding(const Poco::XML::Element *elem);
 
  using ZeroPaddingMap = std::map<unsigned int, std::pair<std::string, int>>;
  int getZeroPadding(ZeroPaddingMap::const_iterator it) const { return it->second.second; }
  const std::string &getPrefix(ZeroPaddingMap::const_iterator it) const { return it->second.first; }
 
  const FacilityInfo *m_facility;    
  std::string m_name;                
  std::string m_shortName;           
  ZeroPaddingMap m_zeroPadding;      
  std::string m_delimiter;           
  std::set<std::string> m_technique; 
 
  std::vector<LiveListenerInfo> m_listeners; 
  std::vector<TopicInfo> m_kafkaTopics;      
  std::string m_defaultListener;             
};
 
MANTID_KERNEL_DLL std::ostream &operator<<(std::ostream &buffer, const InstrumentInfo &instrumentDescriptor);
 
} // namespace Kernel
} // namespace Mantid