casa  $Rev:20696$
Public Member Functions | Private Attributes
casa::MsPlotLogger Class Reference

#include <MsPlotLogger.h>

Inheritance diagram for casa::MsPlotLogger:
casa::LogIO

List of all members.

Public Member Functions

 MsPlotLogger (const String &classNm, const String FnName)
 Simple constructor, assumes there is no Class to be added to the message origin.
 MsPlotLogger (const String &classNm)
 Constructor.
 MsPlotLogger ()
 Simple constructor, assumes there is no Class to be added to the message origin.
 ~MsPlotLogger ()
 Destructor.
void setClassName (String classNm)
 Methods to set and get the class name used with this logger.
String getClassName ()
void setFnName (String fnName)
 Methods to set and get the function name associated with logged messages.
String getFnName ()
void fnEnter (String fnName, String fnCall)
 Generic debug message added to log when entering a function.
void fnExit (String fnName)
 Generic debug message added to log when exiting a function.
void fnExit ()
void logMessage (const String &msg, const String &classname, const String &fnname, LogMessage::Priority msglevel=LogMessage::NORMAL2, Bool onconsole=False, Bool throwexcep=False)
 Log a message to the CASA logging facilities.
void logMessage (const String &msg, const String &fnname, LogMessage::Priority msglevel=LogMessage::NORMAL2, Bool onconsole=False, Bool throwexcep=False)
void logMessage (const String &msg, LogMessage::Priority msglevel=LogMessage::NORMAL2, Bool onconsole=False, Bool throwexcep=False)
void debugMessage (const String &msg, const String &classname, const String &fnname, LogMessage::Priority msglevel=LogMessage::DEBUGGING)
 Log a debugging message to the CASA logging facilities.
void debugMessage (const String &msg, const String &fnname, LogMessage::Priority msglevel=LogMessage::DEBUGGING)
void debugMessage (const String &msg, LogMessage::Priority msglevel=LogMessage::DEBUGGING)

Private Attributes

String itsClassNm
 Name of the class the msgs.
String itsFnName
 Name of the function/method the msgs.

Detailed Description

Definition at line 125 of file MsPlotLogger.h.


Constructor & Destructor Documentation

casa::MsPlotLogger::MsPlotLogger ( const String classNm,
const String  FnName 
) [inline]

Simple constructor, assumes there is no Class to be added to the message origin.

Definition at line 131 of file MsPlotLogger.h.

References casa::LogMessage::DEBUG1, itsClassNm, itsFnName, casa::LogIO::origin(), casa::LogIO::output(), casa::LogIO::post(), and casa::LogIO::priority().

casa::MsPlotLogger::MsPlotLogger ( const String classNm) [inline]

Constructor.

The Class name is given, which will be used for all messages created.

Definition at line 145 of file MsPlotLogger.h.

References casa::LogMessage::DEBUG1, itsClassNm, itsFnName, casa::LogIO::origin(), casa::LogIO::output(), casa::LogIO::post(), and casa::LogIO::priority().

casa::MsPlotLogger::MsPlotLogger ( ) [inline]

Simple constructor, assumes there is no Class to be added to the message origin.

Definition at line 159 of file MsPlotLogger.h.

References casa::LogMessage::DEBUG1, itsClassNm, itsFnName, casa::LogIO::origin(), casa::LogIO::output(), casa::LogIO::post(), and casa::LogIO::priority().

casa::MsPlotLogger::~MsPlotLogger ( ) [inline]

Member Function Documentation

void casa::MsPlotLogger::debugMessage ( const String msg,
const String classname,
const String fnname,
LogMessage::Priority  msglevel = LogMessage::DEBUGGING 
) [inline]

Log a debugging message to the CASA logging facilities.

Definition at line 282 of file MsPlotLogger.h.

References casa::False, itsClassNm, itsFnName, and logMessage().

Referenced by debugMessage().

void casa::MsPlotLogger::debugMessage ( const String msg,
const String fnname,
LogMessage::Priority  msglevel = LogMessage::DEBUGGING 
) [inline]

Definition at line 293 of file MsPlotLogger.h.

References debugMessage(), and itsClassNm.

void casa::MsPlotLogger::debugMessage ( const String msg,
LogMessage::Priority  msglevel = LogMessage::DEBUGGING 
) [inline]

Definition at line 300 of file MsPlotLogger.h.

References debugMessage(), itsClassNm, and itsFnName.

void casa::MsPlotLogger::fnEnter ( String  fnName,
String  fnCall 
) [inline]

Generic debug message added to log when entering a function.

Definition at line 201 of file MsPlotLogger.h.

References casa::String::c_str(), casa::LogMessage::DEBUG1, itsClassNm, itsFnName, casa::LogIO::origin(), casa::LogIO::output(), casa::LogIO::post(), and casa::LogIO::priority().

void casa::MsPlotLogger::fnExit ( String  fnName) [inline]

Generic debug message added to log when exiting a function.

Definition at line 215 of file MsPlotLogger.h.

References casa::String::c_str(), casa::LogMessage::DEBUG1, itsClassNm, itsFnName, casa::LogIO::origin(), casa::LogIO::output(), casa::LogIO::post(), and casa::LogIO::priority().

void casa::MsPlotLogger::fnExit ( ) [inline]

Definition at line 226 of file MsPlotLogger.h.

References itsFnName.

String casa::MsPlotLogger::getClassName ( ) [inline]

Definition at line 186 of file MsPlotLogger.h.

References itsClassNm.

String casa::MsPlotLogger::getFnName ( ) [inline]

Definition at line 194 of file MsPlotLogger.h.

References itsFnName.

void casa::MsPlotLogger::logMessage ( const String msg,
const String classname,
const String fnname,
LogMessage::Priority  msglevel = LogMessage::NORMAL2,
Bool  onconsole = False,
Bool  throwexcep = False 
) [inline]
void casa::MsPlotLogger::logMessage ( const String msg,
const String fnname,
LogMessage::Priority  msglevel = LogMessage::NORMAL2,
Bool  onconsole = False,
Bool  throwexcep = False 
) [inline]

Definition at line 260 of file MsPlotLogger.h.

References itsClassNm, and logMessage().

void casa::MsPlotLogger::logMessage ( const String msg,
LogMessage::Priority  msglevel = LogMessage::NORMAL2,
Bool  onconsole = False,
Bool  throwexcep = False 
) [inline]

Definition at line 269 of file MsPlotLogger.h.

References itsClassNm, itsFnName, and logMessage().

void casa::MsPlotLogger::setClassName ( String  classNm) [inline]

Methods to set and get the class name used with this logger.

Definition at line 185 of file MsPlotLogger.h.

References itsClassNm.

void casa::MsPlotLogger::setFnName ( String  fnName) [inline]

Methods to set and get the function name associated with logged messages.

Definition at line 193 of file MsPlotLogger.h.

References itsFnName.


Member Data Documentation

Name of the class the msgs.

belong to.

Definition at line 304 of file MsPlotLogger.h.

Referenced by debugMessage(), fnEnter(), fnExit(), getClassName(), logMessage(), MsPlotLogger(), setClassName(), and ~MsPlotLogger().

Name of the function/method the msgs.

belong to.

Definition at line 313 of file MsPlotLogger.h.

Referenced by debugMessage(), fnEnter(), fnExit(), getFnName(), logMessage(), MsPlotLogger(), and setFnName().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines