OmgPluginMessenger Class Reference
[Library]

#include <omgpluginmessenger.h>

Inheritance diagram for OmgPluginMessenger:

[legend]Collaboration diagram for OmgPluginMessenger:

[legend]List of all members.

---

Detailed Description

A delegate class for passing messages between plugins and the application. qt plugins should not inherit qobject and thus dont support signals and slots. Thus we need this messenger delegate to connect signals from the plugin to slots in the parent app. In fact the qtplugins inheriting qobject do work under lin and mac but they dont work under win.

Definition at line 35 of file omgpluginmessenger.h.

Public Slots
void	emitError (QString theError)
void	emitMessage (QString theMessage)
void	emitModelError (QString theModelGuid, QString theMessage)
void	emitModelMessage (QString theModelGuid, QString theMessage)
void	emitModelDone (QString theModelGuid)
void	emitModelCreationProgress (QString theModelGuid, int theProgress)
void	emitModelProjectionProgress (QString theModelGuid, int theProgress)
void	emitRefresh ()
void	emitFileWritten (QString theShapeFile, QString theTextFile, QString theTaxonName, int theCount)
void	emitFileNotWritten (QString theTaxonName)
Signals
void	error (QString)
void	message (QString)
void	modelError (QString theModelGuid, QString theMessage)
void	modelMessage (QString theModelGuid, QString theMessage)
void	modelDone (QString theModelGuid)
void	modelCreationProgress (QString theModelGuid, int theProgress)
void	modelProjectionProgress (QString theModelGuid, int theProgress)
void	refresh ()
void	fileWritten (QString theShapeFile, QString theTextFile, QString theTaxonName, int theCount)
void	fileNotWritten (QString theTaxonName)
Public Member Functions
	OmgPluginMessenger (QObject *parent=0)
virtual	~OmgPluginMessenger ()

---

Constructor & Destructor Documentation

OmgPluginMessenger::OmgPluginMessenger (  QObject *  parent = 0  )

Definition at line 29 of file omgpluginmessenger.cpp.

OmgPluginMessenger::~OmgPluginMessenger (   )  [virtual]

Definition at line 33 of file omgpluginmessenger.cpp.

---

Member Function Documentation

void OmgPluginMessenger::emitError (  QString  theError  )  [slot]

Delegate for the error signal (calling this method will cause that signal to be emitted) Parameters: theError  The error message to be emitted as a signal. Returns: void See also: error(QString) Definition at line 38 of file omgpluginmessenger.cpp. References error(). Referenced by OmgScraperPluginInterface::createTextFile(), OmgModellerWebServicesPlugin::getAlgorithmSet(), OmgScraperGbif::localitiesRequestDone(), OmgScraperSplink::search(), OmgScraperGbifRest::search(), OmgScraperGbif::search(), and OmgScraperGbif::taxonIdRequestDone().

void OmgPluginMessenger::emitFileNotWritten (  QString  theTaxonName  )  [slot]

Delegate for the fileNotWritten signal (calling this method will cause that signal to be emitted.) Notifies any listeners that a scraper plugin has failed to write a file. Parameters: theTaxonName  - name of the taxon that is associated with this failure Returns: void Definition at line 94 of file omgpluginmessenger.cpp. References fileNotWritten(). Referenced by OmgScraperGbif::localitiesRequestDone(), OmgScraperSplink::search(), OmgScraperGbifRest::search(), and OmgScraperGbif::taxonIdRequestDone().

void OmgPluginMessenger::emitFileWritten (  QString  theShapeFile, QString  theTextFile, QString  theTaxonName, int  theCount )  [slot]

Delegate for the fileWritten signal (calling this method will cause that signal to be emitted). Notifies any listeners that a scraper plugin has written a file. Parameters: theShapeFile  - name of the shapefile that was written theTextFile  - name of the text file that was written theTaxonName  - name of the taxon that is associated with these files theCount  - the number of locality recs written Returns: void Definition at line 90 of file omgpluginmessenger.cpp. References fileWritten(). Referenced by OmgScraperGbif::localitiesRequestDone(), OmgScraperSplink::search(), and OmgScraperGbifRest::search().

void OmgPluginMessenger::emitMessage (  QString  theMessage  )  [slot]

Delegate for the message signal (calling this method will cause that signal to be emitted) Parameters: theMessage  The message to be emitted as a signal. Returns: void See also: message(QString) Definition at line 44 of file omgpluginmessenger.cpp. References message(). Referenced by OmgScraperGbif::localitiesRequestDone(), OmgScraperGbifRest::setStatus(), and OmgScraperGbif::taxonIdRequestDone().

void OmgPluginMessenger::emitModelCreationProgress (  QString  theModelGuid, int  theProgress )  [slot]

Delegate for the modelCreationProgress signal (calling this method will cause that signal to be emitted) Parameters: theModelId  The model id that the message is associated with theProgress  The current progress of the model creation (0-100)%. Returns: void See also: modelCreationProgress(int,QString) Definition at line 69 of file omgpluginmessenger.cpp. References modelCreationProgress(). Referenced by OmgModellerWebServicesPlugin::createModel(), OmgModellerLocalPlugin::createModel(), and OmgModellerLocalPlugin::setCreationProgress().

void OmgPluginMessenger::emitModelDone (  QString  theModelGuid  )  [slot]

Delegate for the modelDone signal (calling this method will cause that signal to be emitted) Parameters: theModelId  The model id that the message is associated with Returns: void See also: modelDone(int) Definition at line 63 of file omgpluginmessenger.cpp. References modelDone(). Referenced by OmgModellerLocalPlugin::createModel().

void OmgPluginMessenger::emitModelError (  QString  theModelGuid, QString  theMessage )  [slot]

Delegate for the modelError signal (calling this method will cause that signal to be emitted) Parameters: theModelId  The model id that the message is associated with theMessage  The message to be emitted as a signal. Returns: void See also: modelError(QString,QString) Definition at line 50 of file omgpluginmessenger.cpp. References modelError(). Referenced by OmgModellerWebServicesPlugin::createModel(), OmgModellerLocalPlugin::createModel(), OmgModellerWebServicesPlugin::projectModel(), and OmgModellerLocalPlugin::projectModel().

void OmgPluginMessenger::emitModelMessage (  QString  theModelGuid, QString  theMessage )  [slot]

Delegate for the modelMessage signal (calling this method will cause that signal to be emitted) Parameters: theModelId  The model id that the message is associated with theMessage  The message to be emitted as a signal. Returns: void See also: modelMessage(QString,QString) Definition at line 56 of file omgpluginmessenger.cpp. References modelMessage(). Referenced by OmgModellerWebServicesPlugin::createModel(), OmgModellerLocalPlugin::createModel(), OmgModellerWebServicesPlugin::projectModel(), and OmgModellerLocalPlugin::projectModel().

void OmgPluginMessenger::emitModelProjectionProgress (  QString  theModelGuid, int  theProgress )  [slot]

Delegate for the modelProjectionProgress signal (calling this method will cause that signal to be emitted) Parameters: theModelId  The model id that the message is associated with theProgress  The current progress of the model projection (0-100)%. Returns: void See also: modelCreationProgress(int,QString) Definition at line 75 of file omgpluginmessenger.cpp. References modelProjectionProgress(). Referenced by OmgModellerWebServicesPlugin::projectModel(), OmgModellerLocalPlugin::projectModel(), and OmgModellerLocalPlugin::setProjectionProgress().

void OmgPluginMessenger::emitRefresh (   )  [slot]

Delegate for refresh signal to push a refresh instruction out to any listeners. Definition at line 81 of file omgpluginmessenger.cpp. References refresh().

void OmgPluginMessenger::error (  QString   )  [signal]

Notifies any listeners of an error message. Parameters: theError  The error message to be emitted as a signal. Returns: void Referenced by emitError().

void OmgPluginMessenger::fileNotWritten (  QString  theTaxonName  )  [signal]

Notifies any listeners that a scraper plugin has failed to write a file. Parameters: theTaxonName  - name of the taxon that is associated with this failure Returns: void Referenced by emitFileNotWritten().

void OmgPluginMessenger::fileWritten (  QString  theShapeFile, QString  theTextFile, QString  theTaxonName, int  theCount )  [signal]

Notifies any listeners that a scraper plugin has written a file. Parameters: theShapeFile  - name of the shapefile that was written theTextFile  - name of the text file that was written theTaxonName  - name of the taxon that is associated with these files theCount  - the number of locality recs written Returns: void Referenced by emitFileWritten().

void OmgPluginMessenger::message (  QString   )  [signal]

Notifies any listeners of message. Parameters: theError  The message to be emitted as a signal. Returns: void Referenced by emitMessage().

void OmgPluginMessenger::modelCreationProgress (  QString  theModelGuid, int  theProgress )  [signal]

Notifies any listeners how far the current model CREATION has progressed (progress is expressed as a percentage) Parameters: theProgress  See also: setCreationProgress(int theProgress) Referenced by emitModelCreationProgress().

void OmgPluginMessenger::modelDone (  QString  theModelGuid  )  [signal]

Notifies any listeners that the currently running model is finished Parameters: theModeId  - id of the model that was completed * Referenced by emitModelDone().

void OmgPluginMessenger::modelError (  QString  theModelGuid, QString  theMessage )  [signal]

Notifies any listeners of an updated log error from openmodeller. Parameters: theMessage  The message received by the log callback theModelGuid  Global identifier of the mode associated with this message Referenced by emitModelError().

void OmgPluginMessenger::modelMessage (  QString  theModelGuid, QString  theMessage )  [signal]

Notifies any listeners of an updated log message from openmodeller. Parameters: theMessage  The message received by the log callback theModelGuid  Global identifier of the mode associated with this message Referenced by emitModelMessage().

void OmgPluginMessenger::modelProjectionProgress (  QString  theModelGuid, int  theProgress )  [signal]

Notifies any listeners how far the current model PROJECTION has progressed (progress is expressed as a percentage) Parameters: theProgress  See also: setProjectionProgress(int theProgress) Referenced by emitModelProjectionProgress().

void OmgPluginMessenger::refresh (   )  [signal]

Notifies any listeners they should refresh their display Referenced by emitRefresh().

---

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

• lib/omgpluginmessenger.h
• lib/omgpluginmessenger.cpp

---