Merge remote-tracking branch 'origin/feature/7954_isis_live_event_lis…

…tener'

Code/Mantid/Framework/ISISLiveData/CMakeLists.txt

@@ -1,10 +1,12 @@
 set ( SRC_FILES
    src/example.cpp
+   src/FakeISISEventDAE.cpp
 )
 
 set ( INC_FILES
-  inc/MantidISISLiveData/DllConfig.h
+  #inc/MantidISISLiveData/DllConfig.h
   inc/MantidISISLiveData/TCPEventStreamDefs.h
+  inc/MantidISISLiveData/FakeISISEventDAE.h
 )
 
 set ( TEST_FILES

Code/Mantid/Framework/ISISLiveData/inc/MantidISISLiveData/FakeISISEventDAE.h

@@ -0,0 +1,71 @@
+#ifndef MANTID_ISISLIVEDATA_FAKEISISHISTODAE_H_
+#define MANTID_ISISLIVEDATA_FAKEISISHISTODAE_H_
+
+//----------------------------------------------------------------------
+// Includes
+//----------------------------------------------------------------------
+#include "MantidAPI/Algorithm.h"
+
+namespace Poco
+{
+  namespace Net
+  {
+    class TCPServer;
+  }
+}
+
+namespace Mantid
+{
+namespace ISISLiveData
+{
+/**
+    Simulates ISIS histogram DAE. It runs continuously until canceled and listens to port 6789 for
+    ISIS DAE commands.
+
+    Copyright © 2008-9 ISIS Rutherford Appleton Laboratory & NScD Oak Ridge National Laboratory
+
+    This file is part of Mantid.
+
+    Mantid is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 3 of the License, or
+    (at your option) any later version.
+
+    Mantid is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+    File change history is stored at: <https://github.com/mantidproject/mantid>.
+    Code Documentation is available at: <http://doxygen.mantidproject.org>
+*/
+class FakeISISEventDAE : public API::Algorithm
+{
+public:
+  FakeISISEventDAE();
+  virtual ~FakeISISEventDAE();
+
+  /// Algorithm's name for identification overriding a virtual method
+  virtual const std::string name() const { return "FakeISISEventDAE";}
+  /// Algorithm's version for identification overriding a virtual method
+  virtual int version() const { return 1;}
+  /// Algorithm's category for identification overriding a virtual method
+  virtual const std::string category() const { return "DataHandling\\DataAcquisition";}
+
+private:
+  void initDocs();
+  void init();
+  void exec();
+  /// Poco TCP server
+  Poco::Net::TCPServer* m_server;
+  /// Mutex
+  Kernel::Mutex m_mutex;
+};
+
+} // namespace LiveData
+} // namespace Mantid
+
+#endif /*MANTID_LIVEDATA_FAKEISISHISTODAE_H_*/

Code/Mantid/Framework/ISISLiveData/inc/MantidISISLiveData/TCPEventStreamDefs.h

@@ -3,6 +3,8 @@
 
 #include <cstring>
 #include <stdint.h>
+#include <time.h>
+#include <vector>
 
 // to ignore warnings when comparing header versions
 #if defined(__GNUC__) && !(defined(__INTEL_COMPILER))

Code/Mantid/Framework/ISISLiveData/src/FakeISISEventDAE.cpp

@@ -0,0 +1,216 @@
+/*WIKI*
+
+Simulates ISIS event DAE. It runs continuously until canceled and listens to port 10000 for connection.
+When connected starts sending event packets.
+
+*WIKI*/
+//----------------------------------------------------------------------
+// Includes
+//----------------------------------------------------------------------
+#include "MantidISISLiveData/FakeISISEventDAE.h"
+#include "MantidISISLiveData/TCPEventStreamDefs.h"
+
+#include "MantidKernel/MersenneTwister.h"
+
+#include <Poco/Net/TCPServer.h>
+#include <Poco/Net/StreamSocket.h>
+#include <Poco/Thread.h>
+
+#include <boost/random/uniform_int.hpp>
+
+#include <numeric>
+
+namespace Mantid
+{
+namespace ISISLiveData
+{
+// Register the algorithm into the algorithm factory
+DECLARE_ALGORITHM(FakeISISEventDAE);
+
+/**
+ * Implements Poco TCPServerConnection and does the actual job of interpreting commands
+ * from a client and sending data.
+ */
+class TestServerConnection: public Poco::Net::TCPServerConnection
+{
+    int m_nPeriods;
+    int m_nSpectra;
+    int m_Rate;
+    int m_nEvents;
+public:
+  /**
+   * Constructor. Defines the simulated dataset dimensions.
+   * @param soc :: A socket that provides communication with the client.
+   */
+  TestServerConnection( const Poco::Net::StreamSocket & soc, int nper, int nspec,int rate, int nevents ):
+    Poco::Net::TCPServerConnection(soc),
+    m_nPeriods(nper),
+    m_nSpectra(nspec),
+      m_Rate(rate),
+      m_nEvents(nevents)
+  {
+    sendInitialSetup();
+  }
+  /// Destructor.
+  ~TestServerConnection()
+  {
+    //std::cerr << "Test connection deleted" << std::endl;
+  }
+  /// Sends an OK message when there is nothing to send or an error occured
+  void sendOK()
+  {
+    std::string comm = "OK";
+    socket().sendBytes(comm.c_str(), (int)comm.size());
+  }
+
+  /// Send initial setup header
+  void sendInitialSetup()
+  {
+      TCPStreamEventDataSetup setup;
+      setup.head_setup.run_number = 1234;
+      strcpy(setup.head_setup.inst_name,"MUSR");
+      socket().sendBytes(&setup,(int)sizeof(setup));
+  }
+
+  /**
+   * Main method that sends out the data.
+   */
+  void run()
+  {
+      Kernel::MersenneTwister tof(0,100.0,200.0);
+      Kernel::MersenneTwister spec(1234,0.0,static_cast<double>(m_nSpectra));
+      for(;;)
+      {
+          Poco::Thread::sleep(m_Rate);
+          TCPStreamEventDataNeutron data;
+          data.head_n.nevents = m_nEvents;
+
+          socket().sendBytes(&data.head,(int)sizeof(data.head));
+          socket().sendBytes(&data.head_n,(int)sizeof(data.head_n));
+
+          for(uint32_t i = 0; i < data.head_n.nevents; ++i)
+          {
+              TCPStreamEventNeutron neutron;
+              neutron.time_of_flight = static_cast<float>(tof.nextValue());
+              neutron.spectrum = static_cast<uint32_t>(spec.nextValue());
+              socket().sendBytes(&neutron,(int)sizeof(neutron));
+          }
+      }
+      TCPStreamEventDataSetup setup;
+      setup.head_setup.run_number = 1234;
+      strcpy(setup.head_setup.inst_name,"MUSR");
+      socket().sendBytes(&setup,(int)sizeof(setup));
+  }
+};
+
+/**
+ * Implements Poco TCPServerConnectionFactory
+ */
+class TestServerConnectionFactory: public Poco::Net::TCPServerConnectionFactory
+{
+    int m_nPeriods; ///< Number of periods in the fake dataset
+    int m_nSpectra; ///< Number of spectra in the fake dataset
+    int m_Rate;
+    int m_nEvents;
+public:
+  /**
+   * Constructor.
+   */
+  TestServerConnectionFactory(int nper, int nspec,int rate, int nevents):
+  Poco::Net::TCPServerConnectionFactory(),
+  m_nPeriods(nper),
+  m_nSpectra(nspec),
+      m_Rate(rate),
+      m_nEvents(nevents)
+  {}
+  /**
+   * The factory method.
+   * @param socket :: The socket.
+   */
+  Poco::Net::TCPServerConnection * createConnection(const Poco::Net::StreamSocket & socket)
+  {
+    return new TestServerConnection( socket, m_nPeriods, m_nSpectra, m_Rate, m_nEvents );
+  }
+};
+
+/// Sets documentation strings for this algorithm
+void FakeISISEventDAE::initDocs()
+{
+  this->setWikiSummary("Simulates ISIS event DAE. ");
+  this->setOptionalMessage("Simulates ISIS event DAE.");
+}
+
+
+using namespace Kernel;
+using namespace API;
+
+/// (Empty) Constructor
+FakeISISEventDAE::FakeISISEventDAE():m_server(NULL)
+{
+}
+
+/// Destructor
+FakeISISEventDAE::~FakeISISEventDAE()
+{
+  if ( m_server )
+  {
+    m_server->stop();
+    delete m_server;
+  }
+}
+
+/**
+ * Declare the algorithm properties
+ */
+void FakeISISEventDAE::init()
+{
+    declareProperty(new PropertyWithValue<int>("NPeriods", 1, Direction::Input),"Number of periods.");
+    declareProperty(new PropertyWithValue<int>("NSpectra", 100, Direction::Input),"Number of spectra.");
+    declareProperty(new PropertyWithValue<int>("Rate", 1000, Direction::Input),
+                    "Rate of sending the data: stream of NEvents events is sent every Rate microseconds.");
+    declareProperty(new PropertyWithValue<int>("NEvents", 100, Direction::Input),"Number of events in each packet.");
+}
+
+/**
+ * Execute the algorithm.
+ */
+void FakeISISEventDAE::exec()
+{
+    int nper = getProperty("NPeriods");
+    int nspec = getProperty("NSpectra");
+    int rate = getProperty("Rate");
+    int nevents = getProperty("NEvents");
+  Mutex::ScopedLock lock(m_mutex);
+  Poco::Net::ServerSocket socket(10000);
+  socket.listen();
+  m_server = new Poco::Net::TCPServer(
+              TestServerConnectionFactory::Ptr( new TestServerConnectionFactory(nper,nspec,rate,nevents) ), socket );
+  m_server->start();
+  // Keep going until you get cancelled
+  while (true)
+  {
+    try
+    {
+    // Exit if the user presses cancel
+      interruption_point();
+    }
+    catch(...)
+    {
+      break;
+    }
+    progress( 0.0, "Fake ISIS event DAE" );
+
+    // Sleep for 50 msec
+    Poco::Thread::sleep(50);
+  }
+  if ( m_server )
+  {
+    m_server->stop();
+    m_server = NULL;
+  }
+  socket.close();
+}
+
+} // namespace LiveData
+} // namespace Mantid
+

Code/Mantid/Framework/LiveData/CMakeLists.txt

@@ -14,6 +14,7 @@ set ( SRC_FILES
 	src/MonitorLiveData.cpp
 	src/SNSLiveEventDataListener.cpp
 	src/StartLiveData.cpp
+  src/ISISLiveEventDataListener.cpp
 )
 
 set ( SRC_UNITY_IGNORE_FILES src/LoadDAE/idc.cpp
@@ -33,6 +34,8 @@ set ( INC_FILES
 	inc/MantidLiveData/MonitorLiveData.h
 	inc/MantidLiveData/SNSLiveEventDataListener.h
 	inc/MantidLiveData/StartLiveData.h
+  inc/MantidLiveData/ISISLiveEventDataListener.h
+  inc/MantidLiveData/ISIS/TCPEventStreamDefs.h
 )
 
 set ( TEST_FILES