CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Static Public Attributes | List of all members
ctkEventConstants Struct Reference

#include <Libs/PluginFramework/service/event/ctkEventConstants.h>

Static Public Attributes

static const QString DELIVERY_ASYNC_ORDERED
 
static const QString DELIVERY_ASYNC_UNORDERED
 
static const QString EVENT
 
static const QString EVENT_DELIVERY
 
static const QString EVENT_FILTER
 
static const QString EVENT_TOPIC
 
static const QString EXCEPTION
 
static const QString EXCEPTION_CLASS
 
static const QString EXCEPTION_MESSAGE
 
static const QString MESSAGE
 
static const QString PLUGIN
 
static const QString PLUGIN_ID
 
static const QString PLUGIN_SYMBOLICNAME
 
static const QString PLUGIN_VERSION
 
static const QString SERVICE
 
static const QString SERVICE_ID
 
static const QString SERVICE_OBJECTCLASS
 
static const QString SERVICE_PID
 
static const QString TIMESTAMP
 

Detailed Description

Defines standard names for ctkEventHandler and Qt event slot properties.

See also
ctkEventHandler
ctkEventAdmin::subscribeSlot()

Definition at line 37 of file ctkEventConstants.h.

Member Data Documentation

◆ DELIVERY_ASYNC_ORDERED

const QString ctkEventConstants::DELIVERY_ASYNC_ORDERED
static

Event Handler delivery quality value specifying the Event Handler requires asynchronously delivered events be delivered in order. Ordered delivery is the default for asynchronously delivered events.

This delivery quality value is mutually exclusive with DELIVERY_ASYNC_UNORDERED. However, if both this value and DELIVERY_ASYNC_UNORDERED are specified for an event handler, this value takes precedence.

See also
EVENT_DELIVERY

Definition at line 110 of file ctkEventConstants.h.

◆ DELIVERY_ASYNC_UNORDERED

const QString ctkEventConstants::DELIVERY_ASYNC_UNORDERED
static

Event Handler delivery quality value specifying the Event Handler does not require asynchronously delivered events be delivered in order. This may allow an Event Admin implementation to optimize asynchronous event delivery by relaxing ordering requirements.

This delivery quality value is mutually exclusive with DELIVERY_ASYNC_ORDERED. However, if both this value and DELIVERY_ASYNC_ORDERED are specified for an event handler, DELIVERY_ASYNC_ORDERED takes precedence.

See also
EVENT_DELIVERY

Definition at line 126 of file ctkEventConstants.h.

◆ EVENT

const QString ctkEventConstants::EVENT
static

The forwarded event object. Used when rebroadcasting an event that was sent via some other event mechanism. The type of the value for this event property depends on the event topic (for org/commontk/PluginEvent/&0x42; the the type will be ctkPluginEvent).

Definition at line 158 of file ctkEventConstants.h.

◆ EVENT_DELIVERY

const QString ctkEventConstants::EVENT_DELIVERY
static

Service Registration property specifying the delivery qualities requested by an Event Handler service.

Event handlers MAY be registered with this property. Each value of this property is a string specifying a delivery quality for the Event handler.

The value of this property must be of type QString or QStringList.

See also
DELIVERY_ASYNC_ORDERED
DELIVERY_ASYNC_UNORDERED

Definition at line 95 of file ctkEventConstants.h.

◆ EVENT_FILTER

const QString ctkEventConstants::EVENT_FILTER
static

Registration property (named event.filter) specifying a filter to further select ctkEvent s of interest to an Event Handler (a service object or a subscribed slot).

Event handlers MAY be registered with this property. The value of this property is a QString containing an LDAP-style filter specification. Any of the event's properties may be used in the filter expression. Each event handler is notified for any event which belongs to the topics in which the handler has expressed an interest. If the event handler is also registered with this property, then the properties of the event must also match the filter for the event to be delivered to the event handler.

If the filter syntax is invalid, then the Event Handler must be ignored and a warning should be logged.

See also
ctkEvent
ctkLDAPSearchFilter

Definition at line 79 of file ctkEventConstants.h.

◆ EVENT_TOPIC

const QString ctkEventConstants::EVENT_TOPIC
static

Registration property (named event.topics) specifying the ctkEvent topics of interest to an Event Handler (a service object or a subscribed slot).

Event handlers SHOULD be registered with this property. The value of the property is a QString or a QStringList that describes the topics in which the handler is interested. An asterisk ('*') may be used as a trailing wildcard. Event handlers which do not have a value for this property must not receive events. More precisely, the value of each string must conform to the following grammar:

 topic-description := '*' | topic ( '&#47*' )?
 topic := token ( '/' token )*
See also
ctkEvent

Definition at line 58 of file ctkEventConstants.h.

◆ EXCEPTION

const QString ctkEventConstants::EXCEPTION
static

An exception or error. The type of the value for this event property is ctkRuntimeException.

Definition at line 164 of file ctkEventConstants.h.

◆ EXCEPTION_CLASS

const QString ctkEventConstants::EXCEPTION_CLASS
static

The name of the exception type. Must be equal to the name of the class of the exception in the event property EXCEPTION. The type of the value for this event property is QString.

Definition at line 171 of file ctkEventConstants.h.

◆ EXCEPTION_MESSAGE

const QString ctkEventConstants::EXCEPTION_MESSAGE
static

The exception message. Must be equal to the result of calling what() on the exception in the event property EXCEPTION. The type of the value for this event property is QString.

Definition at line 179 of file ctkEventConstants.h.

◆ MESSAGE

const QString ctkEventConstants::MESSAGE
static

A human-readable message that is usually not localized. The type of the value for this event property is QString.

Definition at line 185 of file ctkEventConstants.h.

◆ PLUGIN

const QString ctkEventConstants::PLUGIN
static

The ctkPlugin object of the plugin relevant to the event. The type of the value for this event property is QSharedPointer<ctkPlugin>.

Definition at line 144 of file ctkEventConstants.h.

◆ PLUGIN_ID

const QString ctkEventConstants::PLUGIN_ID
static

The Plugin id of the plugin relevant to the event. The type of the value for this event property is long.

Definition at line 138 of file ctkEventConstants.h.

◆ PLUGIN_SYMBOLICNAME

const QString ctkEventConstants::PLUGIN_SYMBOLICNAME
static

The Plugin Symbolic Name of the plugin relevant to the event. The type of the value for this event property is QString.

Definition at line 132 of file ctkEventConstants.h.

◆ PLUGIN_VERSION

const QString ctkEventConstants::PLUGIN_VERSION
static

The version of the plugin relevant to the event. The type of the value for this event property is ctkVersion.

Definition at line 150 of file ctkEventConstants.h.

◆ SERVICE

const QString ctkEventConstants::SERVICE
static

A service reference. The type of the value for this event property is ctkServiceReference.

Definition at line 191 of file ctkEventConstants.h.

◆ SERVICE_ID

const QString ctkEventConstants::SERVICE_ID
static

A service's id. The type of the value for this event property is long.

Definition at line 197 of file ctkEventConstants.h.

◆ SERVICE_OBJECTCLASS

const QString ctkEventConstants::SERVICE_OBJECTCLASS
static

A service's objectClass. The type of the value for this event property is QStringList.

Definition at line 203 of file ctkEventConstants.h.

◆ SERVICE_PID

const QString ctkEventConstants::SERVICE_PID
static

A service's persistent identity. The type of the value for this event property is QString.

Definition at line 209 of file ctkEventConstants.h.

◆ TIMESTAMP

const QString ctkEventConstants::TIMESTAMP
static

The time when the event occurred, as reported by QDateTime::currentDateTime(). The type of the value for this event property is QDateTime.

Definition at line 216 of file ctkEventConstants.h.


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