Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLLogger Class Reference

Simple message logging class. More...

#include <Logger.h>

List of all members.

Public Types

Public Methods


Detailed Description

Simple message logging class.


Member Enumeration Documentation

enum CSLLogger::ELogType
 

Defines the various types of messages that can be logged.

Enumeration values:
SI_LOG_INIT  Logging ininitalization callback
SI_LOG_FATAL  No hope for recovery
SI_LOG_ERROR  User needs to correct something before going any further
SI_LOG_WARNING  Some problems where found and have been corrected automatically
SI_LOG_VERBOSE  Informative message
SI_LOG_TERM  Logging termination callback


Constructor & Destructor Documentation

CSLLogger::CSLLogger SLLoggerCallBack    OnInitFunc = StdOnInit,
SLLoggerCallBack    OnFatalFunc = StdOnFatal,
SLLoggerCallBack    OnErrorFunc = StdOnError,
SLLoggerCallBack    OnWarningFunc = StdOnWarning,
SLLoggerCallBack    OnVerboseFunc = StdOnVerbose,
SLLoggerCallBack    OnTermFunc = StdOnTerm,
SI_Void *    in_pUserData = 0
 

Logs SL-related information.

Parameters:
OnInitFunc  Callback used to initialize logging
OnFatalFunc  Callback that reports fatal errors
OnErrorFunc  Callback that reports errors
OnWarningFunc  Callback that reports warnings
OnVerboseFunc  Callback that reports general information
OnTermFunc  Callback used to oninitialize logging
in_pUserData  Pointer to user-supplied data (won't be freed by destructor)


Member Function Documentation

SLLoggerCallBack CSLLogger::GetCallBack ELogType    in_Callback
 

Get the current callback.

Parameters:
in_Callback  Type of the callback to retrieve
Returns:
SLLoggerCallBack The callback

SI_Bool CSLLogger::Log ELogType    in_Type,
SI_Void *    in_pData
 

Log a message.

Note:
This function dispatches the message to the appropriate callback
Parameters:
in_Type  Type of message being sent
in_pData  Data that will be used by the callback

SLLoggerCallBack CSLLogger::SetCallBack ELogType    in_Callback,
SLLoggerCallBack    in_NewCallback
 

Replace a callback with a new one.

Parameters:
in_Callback  Type of callback to replace
in_NewCallback  The new callback to use
Returns:
SLLoggerCallBack Pointer to the former callback

SI_Void * CSLLogger::SetData SI_Void *    in_pData
 

Set the internally stored user defined data.

Parameters:
in_pData  New user defined data to store
Returns:
SI_Void* Former user defined data


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.