Medical Imaging Interaction Toolkit  2018.4.99-f51274ea
Medical Imaging Interaction Toolkit
berry::Plugin Class Reference

#include <berryPlugin.h>

Inheritance diagram for berry::Plugin:
Collaboration diagram for berry::Plugin:

Public Member Functions

 Plugin ()
 
void start (ctkPluginContext *context) override
 
void stop (ctkPluginContext *context) override
 
QSharedPointer< ctkPlugin > GetPlugin () const
 
ILogGetLog () const
 
QString GetStateLocation () const
 

Protected Attributes

ctkPluginContext * m_Context
 

Detailed Description

Definition at line 24 of file berryPlugin.h.

Constructor & Destructor Documentation

◆ Plugin()

berry::Plugin::Plugin ( )

Definition at line 18 of file berryPlugin.cpp.

Member Function Documentation

◆ GetLog()

ILog * berry::Plugin::GetLog ( ) const

Returns the log for this plug-in. If no such log exists, one is created.

Returns
the log for this plug-in XXX change this into a LogMgr service that would keep track of the map. See if it can be a service factory.

Definition at line 38 of file berryPlugin.cpp.

References m_Context.

Referenced by berry::WorkbenchPlugin::Log().

◆ GetPlugin()

QSharedPointer< ctkPlugin > berry::Plugin::GetPlugin ( ) const

Definition at line 33 of file berryPlugin.cpp.

References m_Context.

Referenced by GetStateLocation().

◆ GetStateLocation()

QString berry::Plugin::GetStateLocation ( ) const

Returns the location in the local file system of the plug-in state area for this plug-in. If the plug-in state area did not exist prior to this call, it is created.

The plug-in state area is a file directory within the platform's metadata area where a plug-in is free to create files. The content and structure of this area is defined by the plug-in, and the particular plug-in is solely responsible for any files it puts there. It is recommended for plug-in preference settings and other configuration parameters.

Exceptions
ctkIllegalStateException,whenthe system is running with no data area (-data ), or when a data area has not been set yet.
Returns
a local file system path

Definition at line 43 of file berryPlugin.cpp.

References GetPlugin().

◆ start()

void berry::Plugin::start ( ctkPluginContext *  context)
override

Definition at line 23 of file berryPlugin.cpp.

References m_Context.

Referenced by berry::AbstractUICTKPlugin::start().

◆ stop()

void berry::Plugin::stop ( ctkPluginContext *  context)
override

Definition at line 28 of file berryPlugin.cpp.

References m_Context.

Referenced by berry::AbstractUICTKPlugin::stop().

Member Data Documentation

◆ m_Context

ctkPluginContext* berry::Plugin::m_Context
protected

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