MessageSerivce Class Reference

#include <MessageService.h>

Public Types
enum	ErrorType {   WELCOME, ERROR, INFO, VERBOSE,   GOODBYE }
	Define the possible error types. More...
typedef std::basic_ostream< char, std::char_traits< char > >	CoutType
typedef CoutType &(*	StandardEndLine) (CoutType &)

Public Member Functions
void	printErrorCount ()
template<class T >
MessageSerivce &	operator<< (const T &v)
MessageSerivce &	operator<< (StandardEndLine manip)
	~MessageSerivce ()

Static Public Member Functions
static MessageSerivce &	getMessageService (ErrorType errorType)
static MessageSerivce &	getMessageService ()

Public Attributes
std::ostream &	_stream
	the output stream - by default this is std:cout More...
std::map< ErrorType, bool >	_outputOptions
std::map< ErrorType, TString >	_outputHeaders
bool	_endlCalled
bool	_printOrNot
ErrorType	_errorType
long int	_errorCount

Private Member Functions
	MessageSerivce ()

Static Private Attributes
static MessageSerivce *	s_messageService = 0
	static variable that holds the singleton object More...

Detailed Description

HyperPlot, Author: Sam Harnew, sam.h.nosp@m.arne.nosp@m.w@gma.nosp@m.il.c.nosp@m.om , Date: Dec 2015

This is used to print all of the output from HyperPlot to a chosen output stream (by default std::cout). Access to this class is done through the precompiler definitions.

WELCOME_LOG - A welcome message in the constructor of each class ERROR_LOG - Use to print error messages to the screen INFO_LOG - Use to print useful information to the screen VERBOSE_LOG - Use for verbose information GOODBYE_LOG - A goodbye message in the destructor of each class

ERROR_COUNT - Print out how many error messages have been shown. This is useful to call at the end of the main function

Definition at line 33 of file MessageService.h.

Member Typedef Documentation

CoutType

typedef std::basic_ostream<char, std::char_traits<char> > MessageSerivce::CoutType

this is the type of std::cout

Definition at line 131 of file MessageService.h.

StandardEndLine

typedef CoutType&(* MessageSerivce::StandardEndLine) (CoutType &)

this is the function signature of std::endl

Definition at line 135 of file MessageService.h.

Member Enumeration Documentation

ErrorType

enum MessageSerivce::ErrorType

Define the possible error types.

Enumerator
WELCOME
ERROR
INFO
VERBOSE
GOODBYE

Definition at line 45 of file MessageService.h.

{WELCOME, ERROR, INFO, VERBOSE, GOODBYE};

Constructor & Destructor Documentation

MessageSerivce()

MessageSerivce::MessageSerivce ( )

private

constuctor

Definition at line 55 of file MessageService.cpp.

                               :
  _stream(std::cout),
  _endlCalled(true),
  _errorCount(0)
{

  _outputOptions[WELCOME] = false;
  _outputOptions[ERROR  ] = true ;
  _outputOptions[INFO   ] = true ;
  _outputOptions[VERBOSE] = false;
  _outputOptions[GOODBYE] = false;

  _outputHeaders[WELCOME] = "HyperPlot Welcome : ";
  _outputHeaders[ERROR  ] = "\033[31mHyperPlot Error : ";
  _outputHeaders[INFO   ] = "\033[32mHyperPlot Info : ";
  _outputHeaders[VERBOSE] = "HyperPlot Verbose : ";
  _outputHeaders[GOODBYE] = "HyperPlot Goodbye : ";

}

~MessageSerivce()

MessageSerivce::~MessageSerivce

(

)

destuctor

Definition at line 88 of file MessageService.cpp.

                               {
  
  //turns out that it never gets destructed so this doesn't work. Bit of a shame
  if (_errorCount != 0){
    _errorCount--;
    getMessageService(ERROR) << "There was " << _errorCount << " errors during runtime" << std::endl;
  }

}

Member Function Documentation

getMessageService() [1/2]

MessageSerivce & MessageSerivce::getMessageService ( ErrorType  errorType )

static

Static function to retrive the MessageSerivce singleton. At the same time, also change the state of the MessageSerivce.

Definition at line 8 of file MessageService.cpp.

                                                                    {
  
  //if the singleton doesn't exist, return make it
  if (s_messageService == 0){
    s_messageService = new MessageSerivce();
  }
  
  //See if we should be printing the error type given.
  //Set the _printOrNot variable accordingly 
  s_messageService->_printOrNot = s_messageService->_outputOptions[errorType];
  


  //Set the error type to the one given
  if ( s_messageService->_printOrNot){

    //if the message type has changed, and no endl was called, then 
    //force a new line.
    if (s_messageService->_errorType != errorType && s_messageService->_endlCalled == 0){
      *s_messageService << std::endl;
    }

    s_messageService->_errorType = errorType;
  }
  
  //return the singleton
  return *s_messageService;

}

getMessageService() [2/2]

MessageSerivce & MessageSerivce::getMessageService ( )

static

Static function to retrive the MessageSerivce singleton without altering its message state

Definition at line 40 of file MessageService.cpp.

                                                 {
  
  //if the singleton doesn't exist, return make it
  if (s_messageService == 0){
    s_messageService = new MessageSerivce();
  }
  
  //return the singleton
  return *s_messageService;

}

operator<<() [1/2]

template<class T >

MessageSerivce& MessageSerivce::operator<< ( const T &  v )

inline

This makes is possible the do messageSerivce <<

Definition at line 83 of file MessageService.h.

  { 
  
    if (_printOrNot) {
      if (_endlCalled){
        _stream << _outputHeaders[_errorType];
        if (_errorType == ERROR) _errorCount++;
        _endlCalled = 0;
      }
      _stream << v;
    }
    return *this;
  }

operator<<() [2/2]

MessageSerivce& MessageSerivce::operator<< ( StandardEndLine  manip )

inline

define an operator<< to take in std::endl

Definition at line 139 of file MessageService.h.

  { 
    //SAM -> I'm assuming that when this gets called it's 
    //always endl - I imagine this isn't always the case.
    if (_printOrNot){
      _endlCalled = true;

    // call the function, but we cannot return it's value
      _stream << "\033[0m";
      manip(_stream);
      
    }
    return *this;
  }

printErrorCount()

void MessageSerivce::printErrorCount

(

)

print how many errors messages have been sent to the output stream

Definition at line 77 of file MessageService.cpp.

                                    {

  //turns out that it never gets destructed so this doesn't work. Bit of a shame
  if (_errorCount != 0){
    _errorCount--; //This isn't actually an error, so -1
    getMessageService(ERROR) << "There were " << _errorCount << " errors during runtime" << std::endl;
  } 
}

Member Data Documentation

_endlCalled

bool MessageSerivce::_endlCalled

bool was the last command sent to the steam a std::cout ?

Definition at line 61 of file MessageService.h.

_errorCount

long int MessageSerivce::_errorCount

Count the number of errors that happened.

Definition at line 74 of file MessageService.h.

_errorType

ErrorType MessageSerivce::_errorType

The current message type of the MessageSerivce

Definition at line 70 of file MessageService.h.

_outputHeaders

std::map<ErrorType, TString> MessageSerivce::_outputHeaders

this is the string that proceeds each of the message types

Definition at line 57 of file MessageService.h.

_outputOptions

std::map<ErrorType, bool> MessageSerivce::_outputOptions

this map decides what message types should be printed to the output stream (verbose, welcome and goodbye are off by default)

Definition at line 53 of file MessageService.h.

_printOrNot

bool MessageSerivce::_printOrNot

For the current message type, should I be printing to the stream (means you don't have to use the map many times in a row i.e. faster)

Definition at line 66 of file MessageService.h.

_stream

std::ostream& MessageSerivce::_stream

the output stream - by default this is std:cout

Definition at line 48 of file MessageService.h.

s_messageService

MessageSerivce * MessageSerivce::s_messageService = 0

staticprivate

static variable that holds the singleton object

Definition at line 38 of file MessageService.h.

---

The documentation for this class was generated from the following files:

• Mint/MessageService.h
• src/Mojito/Chi2Test/MessageService.cpp