ILiveListener.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2012 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 "MantidAPI/DllConfig.h"
#include "MantidGeometry/IDTypes.h"
#include "MantidKernel/DateAndTime.h"
#include "MantidKernel/PropertyManager.h"
#include <Poco/Net/SocketAddress.h>
#include <optional>
#include <string>
 
namespace Mantid {
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class Workspace;
 
enum class ListenerState {
  Disconnected, 
  Connected,    
  ReadWait,     
  Error         
};
 
class MANTID_API_DLL ILiveListener : public Kernel::PropertyManager {
public:
  //----------------------------------------------------------------------
  // Static properties
  //----------------------------------------------------------------------
 
  virtual std::string name() const = 0;
  virtual bool supportsHistory() const = 0;
  virtual bool buffersEvents() const = 0;
 
  //----------------------------------------------------------------------
  // Actions
  //----------------------------------------------------------------------
 
  virtual bool connect(const Poco::Net::SocketAddress &address) = 0;
 
  virtual void start(Types::Core::DateAndTime startTime = Types::Core::DateAndTime()) = 0;
 
  virtual std::shared_ptr<Workspace> extractData() = 0;
 
  //----------------------------------------------------------------------
  // State information
  //----------------------------------------------------------------------
 
  virtual bool isConnected() = 0;
 
  virtual bool dataReset() = 0;
 
  enum RunStatus { NoRun = 0, JoiningRun = 1, BeginRun = 2, Running = 3, EndRun = 4 };
 
  // ----- Pure state queries (no side effects, all const) -----------------
 
  virtual RunStatus runState() const { return NoRun; }
 
  virtual bool isPaused() const { return false; }
 
  virtual ListenerState listenerState() const = 0;
 
  virtual std::optional<RunStatus> lastTransition() const { return std::nullopt; }
 
  virtual int runNumber() const = 0;
 
  virtual void setSpectra(const std::vector<specnum_t> &specList) = 0;
 
  virtual void setAlgorithm(const class IAlgorithm &callingAlgorithm) = 0;
};
 
using ILiveListener_sptr = std::shared_ptr<ILiveListener>;
 
} // namespace API
} // namespace Mantid