![]() |
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/service/cm/ctkConfigurationEvent.h>
Public Types | |
enum | Type { CM_UPDATED = 0x00000001 , CM_DELETED = 0x00000002 } |
Public Member Functions | |
ctkConfigurationEvent () | |
ctkConfigurationEvent (const ctkConfigurationEvent &other) | |
ctkConfigurationEvent (const ctkServiceReference &reference, Type type, const QString &factoryPid, const QString &pid) | |
QString | getFactoryPid () const |
QString | getPid () const |
ctkServiceReference | getReference () const |
int | getType () const |
bool | isNull () const |
ctkConfigurationEvent & | operator= (const ctkConfigurationEvent &other) |
~ctkConfigurationEvent () | |
A Configuration Event.
ctkConfigurationEvent
objects are delivered to all registered ctkConfigurationListener
service objects. ctkConfigurationEvents must be asynchronously delivered in chronological order with respect to each listener.
An enum type is used to identify the type of event. The following event types are defined:
Additional event types may be defined in the future.
Security Considerations. ctkConfigurationEvent
objects do not provide ctkConfiguration
objects, so no sensitive configuration information is available from the event. If the listener wants to locate the ctkConfiguration
object for the specified pid, it must use ctkConfigurationAdmin
.
Definition at line 61 of file ctkConfigurationEvent.h.
Enumerator | |
---|---|
CM_UPDATED | A This An event is fired when a call to ctkConfiguration#update(const ctkDictionary&) successfully changes a configuration. The value of |
CM_DELETED | A This An event is fired when a call to ctkConfiguration#remove() successfully deletes a configuration. The value of |
Definition at line 68 of file ctkConfigurationEvent.h.
ctkConfigurationEvent::ctkConfigurationEvent | ( | ) |
Default constructor for use with the Qt meta object system.
ctkConfigurationEvent::~ctkConfigurationEvent | ( | ) |
ctkConfigurationEvent::ctkConfigurationEvent | ( | const ctkServiceReference & | reference, |
Type | type, | ||
const QString & | factoryPid, | ||
const QString & | pid | ||
) |
Constructs a ConfigurationEvent
object from the given ServiceReference
object, event type, and pids.
reference | The ServiceReference object of the Configuration Admin service that created this event. |
type | The event type. See getType. |
factoryPid | The factory pid of the associated configuration if the target of the configuration is a ManagedServiceFactory. Otherwise null if the target of the configuration is a ManagedService. |
pid | The pid of the associated configuration. |
ctkConfigurationEvent::ctkConfigurationEvent | ( | const ctkConfigurationEvent & | other | ) |
QString ctkConfigurationEvent::getFactoryPid | ( | ) | const |
Returns the factory pid of the associated configuration.
QString ctkConfigurationEvent::getPid | ( | ) | const |
Returns the pid of the associated configuration.
ctkServiceReference ctkConfigurationEvent::getReference | ( | ) | const |
Return the ctkServiceReference
object of the Configuration Admin service that created this event.
ctkServiceReference
object for the Configuration Admin service that created this event. int ctkConfigurationEvent::getType | ( | ) | const |
Return the type of this event.
The type values are:
bool ctkConfigurationEvent::isNull | ( | ) | const |
Can be used to check if this ctkConfigurationEvent instance is valid, or if it has been constructed using the default constructor.
true
if this event object is valid, false
otherwise. ctkConfigurationEvent& ctkConfigurationEvent::operator= | ( | const ctkConfigurationEvent & | other | ) |