#include <Libs/PluginFramework/service/log/ctkLogReaderService.h>

Public Member Functions
virtual bool	connectLogListener (const QObject receiver, const char slot)=0

virtual QList< ctkLogEntryPtr >	getLog ()=0

virtual	~ctkLogReaderService ()

Detailed Description

Provides methods to retrieve ctkLogEntry objects from the log.

There are three ways to retrieve ctkLogEntry objects:

The primary way to retrieve ctkLogEntry objects is to register a ctkLogListener object with the service registry whose ctkLogListener::logged() method will be called for each entry added to the log. This way you do not need to retrieve any service object to express an interest in log entries.
A Qt slot can be connected to the ctkLogReaderService by using connectLogListener().
To retrieve past ctkLogEntry objects, the getLog() method can be called which will return a QList of all ctkLogEntry objects in the log.

Remarks: This class is thread safe.

See also: ctkLogEntry; ctkLogListener; ctkLogListener::logged(ctkLogEntryPtr)

Definition at line 54 of file ctkLogReaderService.h.

Constructor & Destructor Documentation

◆ ~ctkLogReaderService()

virtual ctkLogReaderService::~ctkLogReaderService ( )

inlinevirtual

Definition at line 56 of file ctkLogReaderService.h.

Member Function Documentation

◆ connectLogListener()

virtual bool ctkLogReaderService::connectLogListener	(	const QObject *	receiver,
		const char *	slot
	)

pure virtual

Subscribes to ctkLogEntry objects.

This method connects a Qt slot with the Log Reader Service. The slot must take a ctkLogEntryPtr as the only argument and will be called for each ctkLogEntry object placed into the log.

When a plugin which connects a Qt slot is stopped, the Log Reader Service must disconnect all of the plugin's connected slots.

If the same slot from the same object is already connected, this method does nothing.

Parameters

receiver	The object to connect to.
slot	The name of the slot to be connected.

Returns: true if the connection was successfull; false otherwise.

See also: ctkLogListener; ctkLogEntry; ctkLogListener::logged(ctkLogEntryPtr)

◆ getLog()

virtual QList<ctkLogEntryPtr> ctkLogReaderService::getLog ( )

pure virtual

Returns a QList of all ctkLogEntry objects in the log.

Each element of the QList is a ctkLogEntry object, ordered with the most recent entry first. Whether the list is of all ctkLogEntry objects since the Log Service was started or some recent past is implementation-specific. Also implementation-specific is whether informational and debug ctkLogEntry objects are included in the list.

Returns: A QList of all ctkLogEntry objects in the log.

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