Log Class Reference

A log object to stream messages. More...

Inherits AttributeMap.

Public Member Functions
Log	AddMessage (string text)
	Adds a message to the log.
Log	AddMessageLine (string text)
	Adds a message and the default line terminator to the log.
Log	AddAttribute (string name, string value)
	Adds a string attribute to the log.
Log	AddAttribute (string name, long value)
	Adds a long attribute to the log.
Log	AddAttribute (string name, bool value)
	Adds a bool attribute to the log.
Log	AddAttribute (string name, double value)
	Adds a double attribute to the log.
Public Member Functions inherited from AttributeMap
virtual void	Dispose (bool disposing)
	IDisposable helper function.
void	Dispose ()
	IDisposable implementation.

Protected Member Functions
override void	SendData ()
	Called when AttributeMap parent is disposed and enabled.
Protected Member Functions inherited from AttributeMap
void	Attribute (string name, string value)
	Adds a string attribute to the map.
void	Attribute (string name, bool value)
	Adds a bool attribute to the map.
void	Attribute (string name, long value)
	Adds a long attribute to the map.
void	Attribute (string name, double value)
	Adds a double attribute to the map.
void	SendData ()
	Sends the data.

Additional Inherited Members
Properties inherited from AttributeMap
bool	IsEnabled [get]
	If this object is active.
IntPtr	Handle [get]
	Native handle of the Module.
bool	IsDisposed [get]
	Gets if the native handle has been disposed.
Events inherited from AttributeMap
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.
Events inherited from INativeHandle
NativeHandleEventDelegate	ObjectDisposing
	Raised when this object is about to be disposed via the IDisposable.Dispose method.

Detailed Description

A log object to stream messages.

When logging is disabled, operations on a Log object are no-ops. Stored messages and attributes are sent when the object is disposed.

Member Function Documentation

AddAttribute() [1/4]

Log AddAttribute	(	string	name,
		bool	value )

Adds a bool attribute to the log.

Parameters

name	Name/key of the attribute.
value	Value of the attribute.

Returns

This log object.

AddAttribute() [2/4]

Log AddAttribute	(	string	name,
		double	value )

Adds a double attribute to the log.

Parameters

name	Name/key of the attribute.
value	Value of the attribute.

Returns

This log object.

AddAttribute() [3/4]

Log AddAttribute	(	string	name,
		long	value )

Adds a long attribute to the log.

Parameters

name	Name/key of the attribute.
value	Value of the attribute.

Returns

This log object.

AddAttribute() [4/4]

Log AddAttribute	(	string	name,
		string	value )

Adds a string attribute to the log.

Parameters

name	Name/key of the attribute.
value	Value of the attribute.

Returns

This log object.

AddMessage()

Log AddMessage

(

string

text

)

Adds a message to the log.

Parameters

text	Text to log.

Returns

This log object.

AddMessageLine()

Log AddMessageLine

(

string

text

)

Adds a message and the default line terminator to the log.

Parameters

text	Text to log.

Returns

This log object.