Medical Imaging Interaction Toolkit  2018.4.99-ae21cdc4
Medical Imaging Interaction Toolkit
berry::ILog Struct Referenceabstract

#include <berryILog.h>

Public Member Functions

virtual ~ILog ()
 
virtual void AddLogListener (ILogListener *listener)=0
 
virtual QSharedPointer< ctkPlugin > GetBundle () const =0
 
virtual void Log (const SmartPointer< IStatus > &status)=0
 
virtual void RemoveLogListener (ILogListener *listener)=0
 

Detailed Description

A log to which status events can be written. Logs appear on individual plug-ins and on the platform itself. Clients can register log listeners which will receive notification of all log events as they come in.

XXX Need to create a new log interface on common plugin. That interface should be a super interface of this ILog. getBundle() would stay here. In the super interface we would have getName()

This interface is not intended to be implemented by clients.

Definition at line 36 of file berryILog.h.

Constructor & Destructor Documentation

◆ ~ILog()

virtual berry::ILog::~ILog ( )
virtual

Member Function Documentation

◆ AddLogListener()

virtual void berry::ILog::AddLogListener ( ILogListener *  listener)
pure virtual

Adds the given log listener to this log. Subsequently the log listener will receive notification of all log events passing through this log. This method has no effect if the identical listener is already registered on this log.

Parameters
listenerthe listener to add to this log
See also
Platform::addLogListener(ILogListener)

◆ GetBundle()

virtual QSharedPointer<ctkPlugin> berry::ILog::GetBundle ( ) const
pure virtual

Returns the plug-in with which this log is associated.

Returns
the plug-in with which this log is associated

◆ Log()

virtual void berry::ILog::Log ( const SmartPointer< IStatus > &  status)
pure virtual

Logs the given status. The status is distributed to the log listeners installed on this log and then to the log listeners installed on the platform.

Parameters
statusthe status to log

◆ RemoveLogListener()

virtual void berry::ILog::RemoveLogListener ( ILogListener *  listener)
pure virtual

Removes the given log listener to this log. Subsequently the log listener will no longer receive notification of log events passing through this log. This method has no effect if the identical listener is not registered on this log.

Parameters
listenerthe listener to remove
See also
Platform::removeLogListener(ILogListener)

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