Utilities.IO.Logging.BaseClasses.LogBase< LogType > Class Template Reference

Base class for logs More...

Inheritance diagram for Utilities.IO.Logging.BaseClasses.LogBase< LogType >:

Public Member Functions
virtual void	LogMessage (string Message, MessageType Type, params object[] args)
	Logs a message More...
override string	ToString ()
	String representation of the logger More...
Public Member Functions inherited from Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass
void	Dispose ()
	Dispose function More...

Protected Member Functions
	LogBase (string Name)
	Constructor More...
override void	Dispose (bool Managed)
	Disposes of the objects More...
Protected Member Functions inherited from Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass
	SafeDisposableBaseClass ()
	Construct More...

Properties
string	Name [get]
	Name of the log More...
Action< LogType >	End [get, set]
	Called when the log is "closed" More...
Format	FormatMessage [get, set]
	Format message function More...
IDictionary< MessageType, Action< string > >	Log [get]
	Called to log the current message More...
Action< LogType >	Start [get, set]
	Called when the log is "opened" More...
Properties inherited from Utilities.IO.Logging.Interfaces.ILog
string	Name [get]
	Name of the logger More...

Detailed Description

Base class for logs

Template Parameters

LogType

Log type

Type Constraints

LogType

:

LogBase<LogType>

Definition at line 45 of file LogBase.cs.

Constructor & Destructor Documentation

Utilities.IO.Logging.BaseClasses.LogBase< LogType >.LogBase ( string  Name )

protected

Constructor

Parameters

Name	Name of the log

Definition at line 52 of file LogBase.cs.

Member Function Documentation

override void Utilities.IO.Logging.BaseClasses.LogBase< LogType >.Dispose ( bool  Managed )

protectedvirtual

Disposes of the objects

Parameters

Managed

True to dispose of all resources, false only disposes of native resources

Implements Utilities.DataTypes.Patterns.BaseClasses.SafeDisposableBaseClass.

Definition at line 111 of file LogBase.cs.

virtual void Utilities.IO.Logging.BaseClasses.LogBase< LogType >.LogMessage ( string  Message, MessageType  Type, params object[]  args  )

virtual

Logs a message

Parameters

Message	Message to log
Type	Type of message
args	args to format/insert into the message

Implements Utilities.IO.Logging.Interfaces.ILog.

Definition at line 89 of file LogBase.cs.

override string Utilities.IO.Logging.BaseClasses.LogBase< LogType >.ToString

(

)

String representation of the logger

Returns

The name of the logger

Definition at line 100 of file LogBase.cs.

Property Documentation

Action<LogType> Utilities.IO.Logging.BaseClasses.LogBase< LogType >.End

getsetprotected

Called when the log is "closed"

Definition at line 66 of file LogBase.cs.

Format Utilities.IO.Logging.BaseClasses.LogBase< LogType >.FormatMessage

getsetprotected

Format message function

Definition at line 71 of file LogBase.cs.

IDictionary<MessageType, Action<string> > Utilities.IO.Logging.BaseClasses.LogBase< LogType >.Log

getprotected

Called to log the current message

Definition at line 76 of file LogBase.cs.

string Utilities.IO.Logging.BaseClasses.LogBase< LogType >.Name

get

Name of the log

Definition at line 61 of file LogBase.cs.

Action<LogType> Utilities.IO.Logging.BaseClasses.LogBase< LogType >.Start

getsetprotected

Called when the log is "opened"

Definition at line 81 of file LogBase.cs.

---

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

• Utilities/IO/Logging/BaseClasses/LogBase.cs