TestDemo.cxx

Go to the documentation of this file.

// $Id: TestDemo.cxx,v 1.3 2006/10/28 05:07:14 gmieg Exp $
//
// A simple program to demonstrate how clients use the message service
//
// messier@huhepl.harvard.edu
#include "MessageService/MsgService.h"

//
// If you plan to use the message service you need a line that looks
// like the following at the top of the file. Note that cvs will fill
// in everything between the ":" and the final "$" automatically so
// you can leave that part blank.
//
CVSID("$Id: TestDemo.cxx,v 1.3 2006/10/28 05:07:14 gmieg Exp $");

//......................................................................

static void theBasics()
{
//======================================================================
// Send some messages to the stream -- this is basically all a
// typical program should ever have to use. In the following the
// "Bsx" would get replaced with the package prefix of the package
// that was sending the message
//======================================================================
  try {
    MSG("Bsx", Msg::kVerbose) << "This is a  VERBOSE message\n";
    MSG("Bsx", Msg::kDebug)   << "This is a  DEBUG   message\n";
    MSG("Bsx", Msg::kInfo)    << "This is an INFO    message\n";
    MSG("Bsx", Msg::kWarning) << "This is a  WARNING message\n";
    MSG("Bsx", Msg::kError)   << "This is an ERROR   message\n";
    MSG("Bsx", Msg::kFatal)   << "This is a  FATAL   message\n";
  }
  catch(MSGException) {
    cerr << endl << endl;
    cerr << "***************** MSGException *****************" << endl;
    cerr << "******** MSGException caught (TestDemo) ********" << endl;
    cerr << "***************** MSGException *****************" << endl;
    cerr << endl;
    MSG("Bsx", Msg::kError)   << "This is a  FATAL   message\n";
  }
}

//......................................................................

static void fancyStuff()
//======================================================================
// Show how to configure the message service and message streams
//======================================================================
{
  // Get pointers to the message service and to the stream I want ("Str")
  // If you just want to use the defaults these line are not needed
  MsgService* msvc = MsgService::Instance();
  MsgStream*  mstr = msvc->GetStream("Fan");

  // Set the log level for the stream. If you just want the default
  // (kInfo) this line is not needed
  mstr->SetLogLevel(Msg::kDebug);

  // Set where the output should go. These are the defaults so
  // techically this code fragment is not needed, however, "cerr" and
  // "cout" could be replaced with filenames if the user wants the
  // output in a text file
  mstr->AttachOStream(Msg::kVerbose, "cerr");
  mstr->AttachOStream(Msg::kInfo,    "cout");

  // If you don't like the default information that gets printed with
  // the messages you can change them like this:

  // Set the format flags for verbose messages
  mstr->SetFormat(Msg::kVerbose, Msg::kPriority + Msg::kName);

  // Add a format flag for warning messages
  mstr->AddFormat(Msg::kWarning, Msg::kTime);

  // Lower a format flag for warning messages
  mstr->RemoveFormat(Msg::kWarning, Msg::kName);
}

//......................................................................

static void fancyMessages()
{
//======================================================================
// Print some more messages just to make the example more interesting
// Use the strem configured in "fancyStuff" above
//======================================================================

  try {
    MSG("Fan", Msg::kVerbose) << "This is a  VERBOSE message\n";
    MSG("Fan", Msg::kDebug)   << "This is a  DEBUG   message\n";
    MSG("Fan", Msg::kInfo)    << "This is an INFO    message\n";
    MSG("Fan", Msg::kWarning) << "This is a  WARNING message\n";
    MSG("Fan", Msg::kError)   << "This is an ERROR   message\n";
    MSG("Fan", Msg::kFatal)   << "This is a  FATAL   message\n";
  }
  catch(MSGException) {
    cerr << endl << endl;
    cerr << "***************** MSGException *****************" << endl;
    cerr << "******** MSGException caught (TestDemo) ********" << endl;
    cerr << "***************** MSGException *****************" << endl;
    cerr << endl;
    MSG("Fan", Msg::kError)   << "This is a  FATAL   message\n";
  }
}

//......................................................................

static void manyMessageExample()
{
//======================================================================
// Give an example where several messages all go to the same stream
//======================================================================
  // If you have lots of messages going to the same stream you can do this:
  MsgStream *m1 = &MSGSTREAM("Mny", Msg::kError);
  (*m1) << " ===== *\n";
  (*m1) << "* Messages like this can save a little time and typing.  *\n";
  (*m1) << "* However, notice that only one header gets printed!     *\n";
  (*m1) << "* That's why I don't recommend using this for errors and *\n";
  (*m1) << "* warnings.                                              *\n";
  (*m1) << "* ====================================================== *\n";
}

//......................................................................

static void printStatistics() 
{
//======================================================================
// Show how to print message service usage statistics
//======================================================================
  // Print message service usage statistics
  MsgService::Instance()->PrintStatistics();
}

//......................................................................

int main(void) { 

  theBasics();
  fancyStuff();
  fancyMessages();
  manyMessageExample();
  printStatistics();
  
  return EXIT_SUCCESS;
}

---