Allow QtChannel to filter on a given source. Refs #6202

mantidproject · Apr 9, 2013 · 858ff82 · 858ff82
1 parent 025b543
commit 858ff82
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 5 deletions.
diff --git a/Code/Mantid/MantidQt/API/inc/MantidQtAPI/QtSignalChannel.h b/Code/Mantid/MantidQt/API/inc/MantidQtAPI/QtSignalChannel.h
@@ -44,11 +44,16 @@ namespace MantidQt
     Q_OBJECT
 
     public:
-      /// Constructor
-      QtSignalChannel();
+      /// Default constructor
+      QtSignalChannel(const QString & source = "");
       /// Destructor
       ~QtSignalChannel();
 
+      /// If set, only Mantid log messages from this source are emitted
+      void setSource(const QString & source);
+      /// Get the current source are emitted
+      inline const QString & source() const { return m_source; }
+
       /// Converts the Poco::Message to a Qt signal
       void log(const Poco::Message& msg);
 
@@ -62,6 +67,9 @@ namespace MantidQt
 
     private:
       Q_DISABLE_COPY(QtSignalChannel);
+
+      /// Optional source (use std::string to avoid conversion in comparison)
+      QString m_source;
    };
   }
 }

diff --git a/Code/Mantid/MantidQt/API/src/QtSignalChannel.cpp b/Code/Mantid/MantidQt/API/src/QtSignalChannel.cpp
@@ -10,25 +10,43 @@ namespace MantidQt
   {
 
     /**
+     * Creates a QtSignalChannel. This channel receives
+     * Poco::Message objects and re-emits MantidQt Message objects
+     * with the option to specify that only messages from a defined
+     * source are emitted.
+     * @param source A string specifying a source for the message
      */
-    QtSignalChannel::QtSignalChannel()
-      :  QObject(), Poco::Channel()
+    QtSignalChannel::QtSignalChannel(const QString & source)
+      :  QObject(), Poco::Channel(), m_source(source)
     {
     }
 
     /**
      */
     QtSignalChannel::~QtSignalChannel()
     {
+    }
 
+    /**
+     * @param source A string specifying the required source for messages
+     * that will be emitted
+     */
+    void QtSignalChannel::setSource(const QString & source)
+    {
+      m_source = source;
     }
 
     /**
+     * If the source is set then only messages with a matching source
+     * cause a Qt signal to be emitted
      * @param msg A Poco message object containing a priority & the string message
      */
     void QtSignalChannel::log(const Poco::Message& msg)
     {
-      emit messageReceived(API::Message(QString::fromStdString(msg.getText()), msg.getPriority()));
+      if(m_source.isEmpty() || this->source() == msg.getSource().c_str())
+      {
+        emit messageReceived(API::Message(QString::fromStdString(msg.getText()), msg.getPriority()));
+      }
     }
 
     /*

diff --git a/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/MessageDisplay.h b/Code/Mantid/MantidQt/MantidWidgets/inc/MantidQtMantidWidgets/MessageDisplay.h
@@ -38,6 +38,7 @@ namespace MantidQt
     class MessageDisplay : public QWidget
     {
       Q_OBJECT
+      Q_PROPERTY(QString source READ source WRITE setSource);
 
     public:
       /// Controls whether the display is allowed to set the log levels
@@ -56,10 +57,16 @@ namespace MantidQt
 
       // Setup logging framework connections
       void attachLoggingChannel();
+      /// If set, only Mantid log messages from this source are emitted
+      void setSource(const QString & source);
+      /// Get the current source are emitted
+      inline const QString & source() const { return m_logChannel->source(); }
 
     signals:
       /// Indicate that a message of error or higher has been received.
       void errorReceived(const QString & text);
+      /// Indicate that a message of warning or higher has been received.
+      void warningReceived(const QString & text);
 
     public slots:
       /// Convenience method for appending message at fatal level

diff --git a/Code/Mantid/MantidQt/MantidWidgets/src/MessageDisplay.cpp b/Code/Mantid/MantidQt/MantidWidgets/src/MessageDisplay.cpp
@@ -90,6 +90,15 @@ namespace MantidQt
           this, SLOT(append(const Message &)));
     }
 
+    /**
+     * @param source A string specifying the required source for messages
+     * that will be emitted
+     */
+    void MessageDisplay::setSource(const QString & source)
+    {
+      m_logChannel->setSource(source);
+    }
+
     //----------------------------------------------------------------------------------------
     // Public slots
     //----------------------------------------------------------------------------------------
@@ -154,6 +163,7 @@ namespace MantidQt
       scrollToBottom();
 
       if(msg.priority() <= Message::Priority::PRIO_ERROR ) emit errorReceived(msg.text());
+      if(msg.priority() <= Message::Priority::PRIO_WARNING ) emit warningReceived(msg.text());
     }
 
     /**
@@ -285,6 +295,7 @@ namespace MantidQt
     void MessageDisplay::setupTextArea()
     {
       m_textDisplay->setReadOnly(true);
+      m_textDisplay->ensureCursorVisible();
 
       this->setLayout(new QHBoxLayout(this));
       QLayout *layout = this->layout();