Public Types | Public Member Functions | Properties

ctkPluginFrameworkEvent Class Reference

#include <Libs/PluginFramework/ctkPluginFrameworkEvent.h>

List of all members.

Public Types

enum  Type {
  STARTED, ERROR, WARNING, INFO,
  STOPPED, STOPPED_UPDATE, WAIT_TIMEDOUT
}

Public Member Functions

 ctkPluginFrameworkEvent ()
 ctkPluginFrameworkEvent (Type type, ctkPlugin *plugin, const std::exception &fwException)
 ctkPluginFrameworkEvent (const ctkPluginFrameworkEvent &other)
 ctkPluginFrameworkEvent (Type type, ctkPlugin *plugin)
QString getErrorString () const
ctkPlugingetPlugin () const
Type getType () const

Properties

QSharedDataPointer
< ctkPluginFrameworkEventData
d
QString errorString
ctkPlugin plugin
Type type

Detailed Description

A general event from the Framework.

ctkPluginFrameworkEvent objects are delivered to slots connected FrameworkListeners when a general event occurs within the plugin environment. A type code is used to identify the event type for future extendability.

See also:
ctkPluginContext::connectFrameworkListener
ctkEventBus

Definition at line 46 of file ctkPluginFrameworkEvent.h.


Member Enumeration Documentation

Enumerator:
STARTED 

The Framework has started.

This event is fired when the Framework has started after all installed plugins that are marked to be started have been started and the Framework has reached the initial start level. The source of this event is the System Plugin.

ERROR 

An error has occurred.

There was an error associated with a plugin.

WARNING 

A warning has occurred.

There was a warning associated with a plugin.

INFO 

An informational event has occurred.

There was an informational event associated with a plugin.

STOPPED 

The Framework has stopped.

This event is fired when the Framework has been stopped because of a stop operation on the system plugin. The source of this event is the System Plugin.

STOPPED_UPDATE 

The Framework has stopped during update.

This event is fired when the Framework has been stopped because of an update operation on the system plugin. The Framework will be restarted after this event is fired. The source of this event is the System Plugin.

WAIT_TIMEDOUT 

The Framework did not stop before the wait timeout expired.

This event is fired when the Framework did not stop before the wait timeout expired. The source of this event is the System Plugin.

Definition at line 58 of file ctkPluginFrameworkEvent.h.


Constructor & Destructor Documentation

ctkPluginFrameworkEvent::ctkPluginFrameworkEvent (  ) 

Default constructor for use with the Qt meta object system.

Definition at line 25 of file ctkPluginFrameworkEvent.cpp.

ctkPluginFrameworkEvent::ctkPluginFrameworkEvent ( Type  type,
ctkPlugin plugin,
const std::exception &  fwException 
)

Creates a Framework event regarding the specified plugin and exception.

Parameters:
type The event type.
plugin The event source.
fwException The related exception.

Definition at line 31 of file ctkPluginFrameworkEvent.cpp.

ctkPluginFrameworkEvent::ctkPluginFrameworkEvent ( Type  type,
ctkPlugin plugin 
)

Creates a Framework event regarding the specified plugin.

Parameters:
type The event type.
plugin The event source.

Definition at line 37 of file ctkPluginFrameworkEvent.cpp.

ctkPluginFrameworkEvent::ctkPluginFrameworkEvent ( const ctkPluginFrameworkEvent other  ) 

Definition at line 43 of file ctkPluginFrameworkEvent.cpp.


Member Function Documentation

QString ctkPluginFrameworkEvent::getErrorString (  )  const

Returns the exception error string related to this event.

Returns:
The related error string.

Definition at line 49 of file ctkPluginFrameworkEvent.cpp.

ctkPlugin * ctkPluginFrameworkEvent::getPlugin (  )  const

Returns the plugin associated with the event. This plugin is also the source of the event.

Returns:
The plugin associated with the event.

Definition at line 54 of file ctkPluginFrameworkEvent.cpp.

ctkPluginFrameworkEvent::Type ctkPluginFrameworkEvent::getType (  )  const

Returns the type of framework event.

The type values are:

Returns:
The type of state change.

Definition at line 59 of file ctkPluginFrameworkEvent.cpp.


Property Documentation

QSharedDataPointer<ctkPluginFrameworkEventData> ctkPluginFrameworkEvent::d

Definition at line 54 of file ctkPluginFrameworkEvent.h.

QString ctkPluginFrameworkEvent::errorString [read]

Definition at line 51 of file ctkPluginFrameworkEvent.h.

ctkPlugin ctkPluginFrameworkEvent::plugin [read]

Definition at line 50 of file ctkPluginFrameworkEvent.h.

Type ctkPluginFrameworkEvent::type [read]

Definition at line 49 of file ctkPluginFrameworkEvent.h.


The documentation for this class was generated from the following files:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines