scope::ScopeLogger Class Reference

#include <ScopeLogger.h>

Classes
class	Impl

Public Member Functions
	ScopeLogger (const log_message_type &_filem=log_all, const log_message_type &_consolem=log_all, const log_message_type &_logboxm=log_all)
void	SetFilepath (const std::wstring &_filepath=L"C:\\ScopeData")
void	Log (const std::wstring &message, const log_message_type &msgtype)
void	AttachLogFrame (gui::CLogFrame *const _logframe)
HWND	GetLogFrameWindow ()
bool	HasLogFrame ()
void	GetUserLoggings ()
void	DetachLogFrame ()
void	Shutdown ()

Protected Member Functions
Impl &	GetImpl (const log_message_type &filem, const log_message_type &consolem, const log_message_type &logboxm)
Impl *const	Pimpl ()

Protected Attributes
Impl *const	pimpl

Detailed Description

A logger class to log various messages and user comments.

Definition at line 24 of file ScopeLogger.h.

Constructor & Destructor Documentation

scope::ScopeLogger::ScopeLogger	(	const log_message_type &	_filem = log_all,
		const log_message_type &	_consolem = log_all,
		const log_message_type &	_logboxm = log_all
	)

Sets the pimpl from GetImpl.

Definition at line 18 of file ScopeLogger.cpp.

Member Function Documentation

ScopeLogger::Impl & scope::ScopeLogger::GetImpl ( const log_message_type &  filem, const log_message_type &  consolem, const log_message_type &  logboxm  )

protected

Has the local static implementation object static local variable is in there.

Definition at line 9 of file ScopeLogger.cpp.

ScopeLogger::Impl *const scope::ScopeLogger::Pimpl ( )

protected

Returns

pointer to the hidden implementation

Definition at line 14 of file ScopeLogger.cpp.

void scope::ScopeLogger::SetFilepath

(

const std::wstring &

_filepath = L"C:\\ScopeData"

)

Sets the filepath and creates logfile.

Definition at line 22 of file ScopeLogger.cpp.

void scope::ScopeLogger::Log	(	const std::wstring &	message,
		const log_message_type &	msgtype
	)

Logs a message.

Calls ScopeLoggerImpl::Log.

Definition at line 26 of file ScopeLogger.cpp.

void scope::ScopeLogger::AttachLogFrame

(

gui::CLogFrame *const

_logframe

)

Attaches a CLogFrame as the logbook window.

Calls ScopeLogger::Impl::AttachLogFrame.

Definition at line 30 of file ScopeLogger.cpp.

HWND scope::ScopeLogger::GetLogFrameWindow

(

)

Saves log frame parameters into Window (for recreating windows on startup).

Calls ScopeLogger::Impl::GetLogFrameWindow.

Definition at line 34 of file ScopeLogger.cpp.

bool scope::ScopeLogger::HasLogFrame

(

)

Returns

logbook already attached? Calls ScopeLogger::Impl::HasLogFrame.

Definition at line 38 of file ScopeLogger.cpp.

void scope::ScopeLogger::GetUserLoggings

(

)

Gets the text in the logbook window and calls FlushLogbox.

Calls ScopeLogger::Impl::GetUserLoggings.

Definition at line 42 of file ScopeLogger.cpp.

void scope::ScopeLogger::DetachLogFrame

(

)

Detaches a CLogFrame.

Calls ScopeLogger::Impl::DetachLogFrame.

Definition at line 46 of file ScopeLogger.cpp.

void scope::ScopeLogger::Shutdown

(

)

Calls ScopeLogger::Impl::Shutdown.

Definition at line 50 of file ScopeLogger.cpp.

Member Data Documentation

Impl* const scope::ScopeLogger::pimpl

protected

pointer to the implementation

Definition at line 28 of file ScopeLogger.h.

---

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

• scope/controllers/ScopeLogger.h
• scope/controllers/ScopeLogger.cpp