MXALogger Class Reference

MXALogger is a wrapper class around the actual implementation class. MXALogger should be used to log debug information into a log file or to std::cout. More...

Collaboration diagram for MXALogger:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MXA_SHARED_POINTERS (MXALogger)
virtual ~MXALogger ()

Static Public Member Functions

static MXALogger::Pointer instance ()

Public Attributes

MXALogger_Implementation mxaLogger

Private Member Functions

 MXALogger ()

Detailed Description

MXALogger is a wrapper class around the actual implementation class. MXALogger should be used to log debug information into a log file or to std::cout.

To use this class you should use the macros provided in this class header. To get an instance of the global logger use the folling in your code: MXALOGGER_METHOD_VARIABLE_INSTANCE Then to use to the logger it can be syntactically the same as 'stdcout <<' style by using the 'mxa_log' macro definition. mxa_log << "My debugging statement " << errorCode << std::endl;

If you want your class to have an class wide instance variable to the global logger then you can use the following macros: In your class declaration use 'MXALOGGER_CLASS_VARIABLE_DECLARATION' macro. In the code within the class method definitions use the 'mxa_log' macro. Do NOT forget to 'mxa_log.open(filename)' using the path/name to a log file otherwise the logging output will simply be sent to 'stdcout'.

Author:
Michael A. Jackson for BlueQuartz Software
Date:
May 26, 2009
Version:
1.0


Constructor & Destructor Documentation

MXALogger::~MXALogger (  )  [virtual]

MXALogger::MXALogger (  )  [private]


Member Function Documentation

MXALogger::MXA_SHARED_POINTERS ( MXALogger   ) 

MXALogger::Pointer MXALogger::instance (  )  [static]


Member Data Documentation

MXALogger_Implementation MXALogger::mxaLogger


The documentation for this class was generated from the following files:
Generated on Tue Nov 17 18:43:15 2009 for MXADataModel by  doxygen 1.5.2