![]() |
CTK
0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
|
#include <Libs/PluginFramework/ctkPluginConstants.h>
Static Public Attributes | |
static const QString | ACTIVATION_EAGER |
static const QString | ACTIVATION_LAZY |
static const QString | FRAMEWORK_PLUGIN_LOAD_HINTS |
static const QString | FRAMEWORK_PRELOAD_LIBRARIES |
static const QString | FRAMEWORK_STORAGE |
static const QString | FRAMEWORK_STORAGE_CLEAN |
static const QString | FRAMEWORK_STORAGE_CLEAN_ONFIRSTINIT |
static const QString | FRAMEWORK_VENDOR |
static const QString | FRAMEWORK_VERSION |
static const QString | OBJECTCLASS |
static const QString | PLUGIN_ACTIVATIONPOLICY |
static const QString | PLUGIN_COPYRIGHT |
static const QString | PLUGIN_DESCRIPTION |
static const QString | PLUGIN_LOCALIZATION |
static const QString | PLUGIN_LOCALIZATION_DEFAULT_BASENAME |
static const QString | PLUGIN_NAME |
static const QString | PLUGIN_SYMBOLICNAME |
static const QString | PLUGIN_UPDATELOCATION |
static const QString | PLUGIN_VENDOR |
static const QString | PLUGIN_VERSION |
static const QString | PLUGIN_VERSION_ATTRIBUTE |
static const QString | REQUIRE_PLUGIN |
static const QString | RESOLUTION_DIRECTIVE |
static const QString | RESOLUTION_MANDATORY |
static const QString | RESOLUTION_OPTIONAL |
static const QString | SERVICE_DESCRIPTION |
static const QString | SERVICE_ID |
static const QString | SERVICE_PID |
static const QString | SERVICE_RANKING |
static const QString | SERVICE_VENDOR |
static const QString | SYSTEM_PLUGIN_LOCATION |
static const QString | SYSTEM_PLUGIN_SYMBOLICNAME |
Definition at line 32 of file ctkPluginConstants.h.
|
static |
Plugin activation policy declaring the plugin must be activated immediately.
A plugin with the eager activation policy that is started with the ctkPlugin::START_ACTIVATION_POLICY option will be activating immediately when the framework is started.
The activation policy value is specified as in the Plugin-ActivationPolicy manifest header like:
Plugin-ActivationPolicy: eager
Definition at line 271 of file ctkPluginConstants.h.
|
static |
Plugin activation policy declaring the plugin must be activated when the first object is instantiated from the plugin.
A plugin with the lazy activation policy that is started with the START_ACTIVATION_POLICY option will wait in the ctkPlugin::STARTING state until the first class instantiation from the plugin occurs. The plugin will then be activated before the instance is returned to the requester.
The lazy activation policy is the default for every plugin.
Definition at line 289 of file ctkPluginConstants.h.
|
static |
Specifies the hints on how symbols in dynamic shared objects (plug-ins) are resolved. The value of this property must be of type QLibrary::LoadHints.
Setting this property to QLibrary::ExportExternalSymbolsHint may be necessary on some platforms (e.g. ELF platforms with gcc < 4.5) to get RTTI working across DSO boundaries.
Definition at line 107 of file ctkPluginConstants.h.
|
static |
Specifies the set of libraries which should be dynamically opened when starting the framework. The value of this property must be either of type QString or QStringList. The given libraries are loaded with QLibrary::load(), using the load hints specified in FRAMEWORK_PLUGIN_LOAD_HINTS. The library search path is defined by the QLibrary class.
Setting this property can improve the initial framework start-up time dramatically if a lot of plug-ins with deeply nested library dependencies are installed. During initial framework start-up (no plug-in meta-data cached yet), the repeated loading and unloading of the installed plug-ins will then only lead to repeated loading and unloading of plug-in dependencies which are not contained in the transitive dependency closure of the given set of pre-loaded libraries.
Definition at line 123 of file ctkPluginConstants.h.
|
static |
Specifies the persistent storage area used by the framework. The value of this property must be a valid file path in the file system to a directory. If the specified directory does not exist then the framework will create the directory. If the specified path exists but is not a directory or if the framework fails to create the storage directory, then framework initialization must fail. The framework is free to use this directory as it sees fit. This area can not be shared with anything else.
If this property is not set, the framework should use a reasonable platform default for the persistent storage area.
Definition at line 79 of file ctkPluginConstants.h.
|
static |
Specifies if and when the persistent storage area for the framework should be cleaned. If this property is not set, then the framework storage area must not be cleaned.
Definition at line 88 of file ctkPluginConstants.h.
|
static |
Specifies that the framework storage area must be cleaned before the framework is initialized for the first time. Subsequent inits, starts or updates of the framework will not result in cleaning the framework storage area.
Definition at line 96 of file ctkPluginConstants.h.
|
static |
Framework environment property identifying the Framework implementation vendor.
The value of this property may be retrieved by calling the ctkPluginContext::getProperty
method.
Definition at line 65 of file ctkPluginConstants.h.
|
static |
Framework environment property identifying the Framework version.
The value of this property may be retrieved by calling the ctkPluginContext::getProperty
method.
Definition at line 55 of file ctkPluginConstants.h.
|
static |
Service property identifying all of the class names under which a service was registered in the Framework. The value of this property must be of type QStringList
.
This property is set by the Framework when a service is registered.
Definition at line 356 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's activation policy.
The attribute value may be retrieved from the QHash
object returned by the Plugin::getHeaders()
method.
Definition at line 240 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's copyright information.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 140 of file ctkPluginConstants.h.
|
static |
Manifest header containing a brief description of the plugin's functionality.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 149 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the base name of the plugin's Qt .qm files.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 178 of file ctkPluginConstants.h.
|
static |
Default value for the Plugin-Localization
manifest header.
Definition at line 185 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's name.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 157 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's symbolic name.
The attribute value may be retrieved from the QHash
object returned by the Plugin::getHeaders()
method.
Definition at line 132 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the location from which a new plugin version is obtained during a plugin update operation.
The attribute value may be retrieved from the ctkDictionary
object returned by the ctkPlugin::getHeaders()
method.
Definition at line 250 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's vendor.
The header value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 166 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the plugin's version.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders()
method.
Definition at line 230 of file ctkPluginConstants.h.
|
static |
Manifest header attribute identifying a range of versions for a plugin specified in the Require-Plugin
manifest headers. The default value is 0.0.0
.
The attribute value is encoded in the Require-Plugin manifest header like:
Require-Plugin: com.acme.module.test; plugin-version="1.1" Require-Plugin: com.acme.module.test; plugin-version="[1.0,2.0)"
The plugin-version attribute value uses a mathematical interval notation to specify a range of plugin versions. A plugin-version attribute value specified as a single version means a version range that includes any plugin version greater than or equal to the specified version.
Definition at line 220 of file ctkPluginConstants.h.
|
static |
Manifest header identifying the symbolic names of other plugins required by the plugin.
The attribute value may be retrieved from the QHash
object returned by the ctkPlugin::getHeaders
method.
Definition at line 196 of file ctkPluginConstants.h.
|
static |
Manifest header directive identifying the resolution type in the Require-Plugin manifest header. The default value is mandatory.
The directive value is encoded in the Require-Plugin manifest header like:
Require-Plugin: com.acme.module.test; resolution:="optional"
Definition at line 308 of file ctkPluginConstants.h.
|
static |
Manifest header directive value identifying a mandatory resolution type. A mandatory resolution type indicates that the required plugin must be resolved when the plugin is resolved. If such a require plugin cannot be resolved, the module fails to resolve.
The directive value is encoded in the Require-Plugin manifest header like:
Require-Plugin: com.acme.module.test; resolution:="manditory"
Definition at line 326 of file ctkPluginConstants.h.
|
static |
Manifest header directive value identifying an optional resolution type. An optional resolution type indicates that the require plugin is optional and the plugin may be resolved without the require plugin being resolved. If the require plugin is not resolved when the plugin is resolved, therequire plugin may not be resolved before the plugin is refreshed.
The directive value is encoded in the Require-Plugin manifest header like:
Require-Plugin: com.acme.module.test; resolution:="optional"
Definition at line 346 of file ctkPluginConstants.h.
|
static |
Service property identifying a service's description.
This property may be supplied in the properties ctkDictionary
object passed to the ctkPluginContext::registerService()
method.
Definition at line 436 of file ctkPluginConstants.h.
|
static |
Service property identifying a service's registration number. The value of this property must be of type qlonglong
.
The value of this property is assigned by the Framework when a service is registered. The Framework assigns a unique value that is larger than all previously assigned values since the Framework was started. These values are NOT persistent across restarts of the Framework.
Definition at line 369 of file ctkPluginConstants.h.
|
static |
Service property identifying a service's persistent identifier.
This property may be supplied in the properties
ctkDictionary
object passed to the ctkPluginContext::registerService
method. The value of this property must be of type QString
or QStringList
.
A service's persistent identifier uniquely identifies the service and persists across multiple Framework invocations.
By convention, every plugin has its own unique namespace, starting with the plugin's identifier (see ctkPlugin::getPluginId) and followed by a dot (.). A plugin may use this as the prefix of the persistent identifiers for the services it registers.
Definition at line 391 of file ctkPluginConstants.h.
|
static |
Service property identifying a service's ranking number.
This property may be supplied in the ctkDictionary
object passed to the ctkPluginContext::registerService
method. The value of this property must be of type int
.
The service ranking is used by the Framework to determine the natural order of services, see ctkServiceReference::operator<(const ctkServiceReference&), and the default service to be returned from a call to the ctkPluginContext::getServiceReference method.
The default ranking is zero (0). A service with a ranking of std::numeric_limits<int>::max()
is very likely to be returned as the default service, whereas a service with a ranking of std::numeric_limits<int>::min()
is very unlikely to be returned.
If the supplied property value is not of type int
, it is deemed to have a ranking value of zero.
Definition at line 418 of file ctkPluginConstants.h.
|
static |
Service property identifying a service's vendor.
This property may be supplied in the properties ctkDictionary
object passed to the ctkPluginContext::registerService()
method.
Definition at line 427 of file ctkPluginConstants.h.
|
static |
Location identifier of the CTK system plugin, which is defined to be "System Plugin".
Definition at line 38 of file ctkPluginConstants.h.
|
static |
Alias for the symbolic name of the CTK system plugin. It is defined to be "system.plugin".
Definition at line 45 of file ctkPluginConstants.h.