diff --git a/Modules/Qmitk/QmitkServiceListWidget.cpp b/Modules/Qmitk/QmitkServiceListWidget.cpp index b8504ecb2a..53f85f22d0 100644 --- a/Modules/Qmitk/QmitkServiceListWidget.cpp +++ b/Modules/Qmitk/QmitkServiceListWidget.cpp @@ -1,191 +1,181 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ //#define _USE_MATH_DEFINES #include // STL HEaders #include //QT headers #include //microservices #include #include "mitkModuleContext.h" #include const std::string QmitkServiceListWidget::VIEW_ID = "org.mitk.views.QmitkServiceListWidget"; QmitkServiceListWidget::QmitkServiceListWidget(QWidget* parent, Qt::WindowFlags f): QWidget(parent, f) { m_Controls = NULL; CreateQtPartControl(this); } QmitkServiceListWidget::~QmitkServiceListWidget() { } //////////////////// INITIALIZATION ///////////////////// void QmitkServiceListWidget::CreateQtPartControl(QWidget *parent) { if (!m_Controls) { // create GUI widgets m_Controls = new Ui::QmitkServiceListWidgetControls; m_Controls->setupUi(parent); this->CreateConnections(); } m_Context = mitk::GetModuleContext(); } void QmitkServiceListWidget::CreateConnections() { if ( m_Controls ) { connect( m_Controls->m_ServiceList, SIGNAL(currentItemChanged( QListWidgetItem *, QListWidgetItem *)), this, SLOT(OnServiceSelectionChanged()) ); } } void QmitkServiceListWidget::InitPrivate(const std::string& namingProperty, const std::string& filter) { if (filter.empty()) m_Filter = "(" + mitk::ServiceConstants::OBJECTCLASS() + "=" + m_Interface + ")"; else m_Filter = filter; m_NamingProperty = namingProperty; m_Context->RemoveServiceListener(this, &QmitkServiceListWidget::OnServiceEvent); m_Context->AddServiceListener(this, &QmitkServiceListWidget::OnServiceEvent, m_Filter); // Empty ListWidget this->m_ListContent.clear(); m_Controls->m_ServiceList->clear(); // get Services std::list services = this->GetAllRegisteredServices(); // Transfer them to the List for(std::list::iterator it = services.begin(); it != services.end(); ++it) AddServiceToList(*it); } ///////////// Methods & Slots Handling Direct Interaction ///////////////// bool QmitkServiceListWidget::GetIsServiceSelected(){ return (this->m_Controls->m_ServiceList->currentItem() != 0); } void QmitkServiceListWidget::OnServiceSelectionChanged(){ mitk::ServiceReference ref = this->GetServiceForListItem(this->m_Controls->m_ServiceList->currentItem()); if (! ref) return; emit (ServiceSelectionChanged(&ref)); } mitk::ServiceReference QmitkServiceListWidget::GetSelectedService(){ return this->GetServiceForListItem(this->m_Controls->m_ServiceList->currentItem()); } ///////////////// Methods & Slots Handling Logic ////////////////////////// void QmitkServiceListWidget::OnServiceEvent(const mitk::ServiceEvent event){ switch (event.GetType()) { case mitk::ServiceEvent::MODIFIED: emit(ServiceModified(event.GetServiceReference())); RemoveServiceFromList(event.GetServiceReference()); AddServiceToList(event.GetServiceReference()); break; case mitk::ServiceEvent::REGISTERED: emit(ServiceRegistered(event.GetServiceReference())); AddServiceToList(event.GetServiceReference()); break; case mitk::ServiceEvent::UNREGISTERING: emit(ServiceUnregistering(event.GetServiceReference())); RemoveServiceFromList(event.GetServiceReference()); break; case mitk::ServiceEvent::MODIFIED_ENDMATCH: emit(ServiceModifiedEndMatch(event.GetServiceReference())); RemoveServiceFromList(event.GetServiceReference()); break; - //default: - // mitkThrow() << "ServiceListenerWidget recieved an unrecognized event. Please Update Implementation of QmitkServiceListWidget::OnServiceEvent()"; } } /////////////////////// HOUSEHOLDING CODE ///////////////////////////////// QListWidgetItem* QmitkServiceListWidget::AddServiceToList(mitk::ServiceReference serviceRef){ QListWidgetItem *newItem = new QListWidgetItem; std::string caption; //TODO allow more complex formatting if (m_NamingProperty.empty()) caption = m_Interface; else caption = serviceRef.GetProperty(m_NamingProperty).ToString(); newItem->setText(caption.c_str()); //Add new item to QListWidget m_Controls->m_ServiceList->addItem(newItem); // Construct link and add to internal List for reference QmitkServiceListWidget::ServiceListLink link; link.service = serviceRef; link.item = newItem; m_ListContent.push_back(link); return newItem; } bool QmitkServiceListWidget::RemoveServiceFromList(mitk::ServiceReference serviceRef){ for(std::vector::iterator it = m_ListContent.begin(); it != m_ListContent.end(); ++it){ if ( serviceRef == it->service ) { int row = m_Controls->m_ServiceList->row(it->item); QListWidgetItem* oldItem = m_Controls->m_ServiceList->takeItem(row); delete oldItem; this->m_ListContent.erase(it); return true; } } return false; } mitk::ServiceReference QmitkServiceListWidget::GetServiceForListItem(QListWidgetItem* item) { for(std::vector::iterator it = m_ListContent.begin(); it != m_ListContent.end(); ++it) if (item == it->item) return it->service; } std::list QmitkServiceListWidget::GetAllRegisteredServices(){ //Get Service References return m_Context->GetServiceReferences(m_Interface, m_Filter); -} - - -////////// DEBUG /////////// - - -mitk::ModuleContext* QmitkServiceListWidget::ProvideContext(){ - return m_Context; -} +} \ No newline at end of file diff --git a/Modules/Qmitk/QmitkServiceListWidget.h b/Modules/Qmitk/QmitkServiceListWidget.h index aab6177f1d..d3345ae171 100644 --- a/Modules/Qmitk/QmitkServiceListWidget.h +++ b/Modules/Qmitk/QmitkServiceListWidget.h @@ -1,222 +1,238 @@ /*=================================================================== The Medical Imaging Interaction Toolkit (MITK) Copyright (c) German Cancer Research Center, Division of Medical and Biological Informatics. All rights reserved. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See LICENSE.txt or http://www.mitk.org for details. ===================================================================*/ #ifndef _QmitkServiceListWidget_H_INCLUDED #define _QmitkServiceListWidget_H_INCLUDED #include "QmitkExports.h" #include "ui_QmitkServiceListWidgetControls.h" #include //QT headers #include #include //Microservices #include "usServiceReference.h" #include "usModuleContext.h" #include "usServiceEvent.h" #include "usServiceInterface.h" /** -* @brief This widget provides abstraction for MicroServices. Place one in your Plugin and set it to a certain interface. -* One can also specify a filter and / or a property to use for captioning of the services. It also offers functionality to be -* informed of ServiceEvents and to return the sctual classes, so only a minimum of interaction with the MicroserviceInterface is required. +* @brief This widget provides abstraction for the handling of MicroServices . Place one in your Plugin and set it to look for a certain interface. +* One can also specify a filter and / or a property to use for captioning of the services. It also offers functionality to signal +* ServiceEvents and to return the actual classes, so only a minimum of interaction with the MicroserviceInterface is required. * To get started, just put it in your Plugin or Widget, call the Initialize Method and optionally connect it's signals. * As QT limits templating possibilities, events only throw ServiceReferences. You can manually dereference them using TranslateServiceReference() * * @ingroup QMITK */ class QMITK_EXPORT QmitkServiceListWidget :public QWidget { //this is needed for all Qt objects that should have a MOC object (everything that derives from QObject) Q_OBJECT private: mitk::ModuleContext* m_Context; - /*! \brief a filter to further narrow down the list of results */ + /** \brief a filter to further narrow down the list of results*/ std::string m_Filter; - /*! \brief The name of the ServiceInterface that this class should list */ + /** \brief The name of the ServiceInterface that this class should list */ std::string m_Interface; - /*! \brief The name of the ServiceProperty that will be displayed in the List to represent the service */ + /** \brief The name of the ServiceProperty that will be displayed in the list to represent the service */ std::string m_NamingProperty; public: static const std::string VIEW_ID; QmitkServiceListWidget(QWidget* p = 0, Qt::WindowFlags f1 = 0); virtual ~QmitkServiceListWidget(); - /*! \brief This method is part of the widget an needs not to be called seperately. */ + /** \brief This method is part of the widget an needs not to be called separately. */ virtual void CreateQtPartControl(QWidget *parent); - /*! \brief This method is part of the widget an needs not to be called seperately. (Creation of the connections of main and control widget.)*/ + /** \brief This method is part of the widget an needs not to be called separately. (Creation of the connections of main and control widget.)*/ virtual void CreateConnections(); - /*! + /** * \brief Will return true, if a service is currently selected and false otherwise. - * Call this before requesting service references to avoid invalid objects + * + * Call this before requesting service references to avoid invalid ServiceReferences. */ bool GetIsServiceSelected(); - /*! + /** * \brief Returns the currently selected Service as a ServiceReference. + * + * If no Service is selected, the result will probably be a bad pointer. call GetIsServiceSelected() + * beforehand to avoid this */ mitk::ServiceReference GetSelectedService(); - /*! - * \brief Use this function to returns the currently selected service as a class directly. + /** + * \brief Use this function to return the currently selected service as a class directly. + * * Make sure you pass the appropriate type, or else this call will fail. + * Usually, you will pass the class itself, not the SmartPointer, but the function returns a pointer. Example: + * \verbatim mitk::USDevice::Pointer device = GetSelectedServiceAsClass(); \endverbatim */ template T* GetSelectedServiceAsClass() { mitk::ServiceReference ref = GetServiceForListItem( this->m_Controls->m_ServiceList->currentItem() ); return dynamic_cast ( m_Context->GetService(ref) ); } - /*! - * \brief Initializes the connection to the registry. The string filter is an LDAP parsable String, compare mitk::ModuleContext for examples on filtering. + /** + * \brief Initializes the Widget with essential parameters. + * + * The string filter is an LDAP parsable String, compare mitk::ModuleContext for examples on filtering. * This. Pass class T to tell the widget which class it should filter for - only services of this class will be listed. - * NamingProperty is a property that will be used to caption the Items in the list. If no filter is supplied, all matching interfaces are shown. If no namingProperty is supplied, - * the interfaceName will be used to caption Items in the list. + * NamingProperty is a property that will be used to caption the Items in the list. If no filter is supplied, all + * matching interfaces are shown. If no namingProperty is supplied, the interfaceName will be used to caption Items in the list. + * For example, this Initialization will filter for all USDevices that are set to active. The USDevice's model will be used to display it in the list: + * \verbatim + * std::string filter = "(&(" + mitk::ServiceConstants::OBJECTCLASS() + "=" + "org.mitk.services.UltrasoundDevice)(IsActive=true))"; + * m_Controls.m_ActiveVideoDevices->Initialize(mitk::USImageMetadata::PROP_DEV_MODEL ,filter); + * \endverbatim */ template void Initialize(const std::string& namingProperty, std::string& filter) { std::string interfaceName ( us_service_interface_iid() ); m_Interface = interfaceName; InitPrivate(namingProperty, filter); } - /*! - * \brief Translates a serviceReference to a class of the given type. Use this to translate the signal's parameters. - * To adhere to the MicroService contract, only ServiceReferences stemming from the same widget should be this method. + /** + * \brief Translates a serviceReference to a class of the given type. + * + * Use this to translate the signal's parameters. To adhere to the MicroService contract, + * only ServiceReferences stemming from the same widget should be used as parameters for this method. + * \verbatim mitk::USDevice::Pointer device = TranslateReference(myDeviceReference); \endverbatim */ template T* TranslateReference(mitk::ServiceReference reference) { return dynamic_cast ( m_Context->GetService(reference) ); } - /*! - *\brief This Function listens to ServiceRegistry changes and updates the - * list of services accordingly. The user of this widget does not need to call this method, - * it is instead used to recieve events from the module registry. + /** + *\brief This Function listens to ServiceRegistry changes and updates the list of services accordingly. + * + * The user of this widget does not need to call this method, it is instead used to recieve events from the module registry. */ void OnServiceEvent(const mitk::ServiceEvent event); - /*! - *\brief This is a legacy method that will be removed in the near future, do not use. - * Use the templated functions instead, as they provide a much cleaner API. - */ - mitk::ModuleContext* ProvideContext(); - - - signals: - /*! - *\brief Emitted when a new Service matching the filter is being registered. Be careful if you use a filter: + /** + *\brief Emitted when a new Service matching the filter is being registered. + * + * Be careful if you use a filter: * If a device does not match the filter when registering, but modifies it's properties later to match the filter, * then the first signal you will see this device in will be ServiceModified. */ void ServiceRegistered(mitk::ServiceReference); - /*! + /** *\brief Emitted directly before a Service matching the filter is being unregistered. */ void ServiceUnregistering(mitk::ServiceReference); - /*! + /** *\brief Emitted when a Service matching the filter changes it's properties, or when a service that formerly not matched the filter * changed it's properties and now matches the filter. */ void ServiceModified(mitk::ServiceReference); - /*! + /** *\brief Emitted when a Service matching the filter changes it's properties, + * * and the new properties make it fall trough the filter. This effectively means that * the widget will not track the service anymore. Usually, the Service should still be useable though */ void ServiceModifiedEndMatch(mitk::ServiceReference); - /*! - *\brief Emitted the user selects a Service from the list + /** + *\brief Emitted if the user selects a Service from the list. + * + * Returns null, if no service is selected anymore. */ void ServiceSelectionChanged(mitk::ServiceReference*); public slots: protected slots: - /*! - \brief Called, when the selection in the list of Services changes + /** + \brief Called, when the selection in the list of Services changes. */ void OnServiceSelectionChanged(); protected: Ui::QmitkServiceListWidgetControls* m_Controls; ///< member holding the UI elements of this widget - /*! + /** * \brief Internal structure used to link ServiceReferences to their QListWidgetItems */ struct ServiceListLink { mitk::ServiceReference service; QListWidgetItem* item; }; - /*! - * \brief Finishes initialization after Initialize has been called. This function assumes that m_Interface is set correctly (Which Initialize does). + /** + * \brief Finishes initialization after Initialize has been called. + * + * This function assumes that m_Interface is set correctly (Which Initialize does). */ void InitPrivate(const std::string& namingProperty, const std::string& filter); - /*! + /** * \brief Contains a list of currently active services and their entires in the list. This is wiped with every ServiceRegistryEvent. */ std::vector m_ListContent; - /*! + /** * \brief Constructs a ListItem from the given service, displays it, and locally stores the service. */ QListWidgetItem* AddServiceToList(mitk::ServiceReference serviceRef); - /*! + /** * \brief Removes the given service from the list and cleans up. Returns true if successful, false if service was not found. */ bool RemoveServiceFromList(mitk::ServiceReference serviceRef); - /*! + /** * \brief Returns the serviceReference corresponding to the given ListEntry or null if none was found (which really shouldn't happen). */ mitk::ServiceReference GetServiceForListItem(QListWidgetItem* item); - /*! + /** * \brief Returns a list of ServiceReferences matching the filter criteria by querying the service registry. */ std::list GetAllRegisteredServices(); }; #endif // _QmitkServiceListWidget_H_INCLUDED