cxReporter.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.

Copyright (c) 2008-2014, SINTEF Department of Medical Technology
All rights reserved.

Redistribution and use in source and binary forms, with or without 
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, 
   this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, 
   this list of conditions and the following disclaimer in the documentation 
   and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors 
   may be used to endorse or promote products derived from this software 
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
=========================================================================*/

#ifndef CXREPORTER_H_
#define CXREPORTER_H_

#include "cxResourceExport.h"

#include <QMetaType>
#include <QObject>
#include <QMutex>
#include <QDateTime>
#include <QFile>
#include "boost/shared_ptr.hpp"
#include "boost/weak_ptr.hpp"
#include "cxDefinitions.h"
#include "cxAudio.h"
#include <sstream>
#include "cxTypeConversions.h"
#include "cxLogger.h"
#include "cxLogMessage.h"
#include "cxLogFileWatcher.h"

class QString;
class QDomNode;
class QDomDocument;
class QFile;
class QTextStream;

namespace cx
{
typedef boost::shared_ptr<class Reporter> ReporterPtr;

class cxResource_EXPORT Reporter : public Log
{
  Q_OBJECT

public:
        virtual ~Reporter();

  static void initialize(); 
  static void shutdown(); 

  static ReporterPtr getInstance(); 

  void setAudioSource(AudioPtr audioSource); 

  //Text
  void sendInfo(QString info); 
  void sendSuccess(QString success); 
  void sendWarning(QString warning); 
  void sendError(QString error); 
  void sendDebug(QString debug); 
  void sendVolatile(QString volatile_msg); 
  void sendRaw(QString raw); 

  void sendMessage(QString text, MESSAGE_LEVEL messageLevel=mlDEBUG, int timeout=-1, bool mute=false);
  void sendMessage(Message msg);

  //Audio
  void playStartSound(); 
  void playStopSound(); 
  void playCancelSound(); 

  void playSuccessSound(); 
  void playWarningSound(); 
  void playErrorSound(); 

  void playScreenShotSound(); 
  void playSampleSound(); 

private slots:
  virtual void onEmittedMessage(Message message);

protected:
  virtual LogThreadPtr createWorker();

private:
  bool hasAudioSource() const;
  Reporter();
  Reporter(const Reporter&);
  Reporter& operator=(const Reporter&);

  void playSound(MESSAGE_LEVEL messageLevel);

  AudioPtr mAudioSource;

//  static Reporter *mTheInstance; // global variable
  static boost::weak_ptr<Reporter> mWeakInstance; // global variable
  static boost::shared_ptr<Reporter> mPersistentInstance; // global variable
};

cxResource_EXPORT ReporterPtr reporter();


} //namespace cx

#endif /* CXREPORTER_H_ */