STYLE: Replace QMutex with QMutexLocker in the ctkJobScheduler

STYLE: Fix indentation for visual dicom borwser classes STYLE: Fix doxygen for visual dicom borwser classes Co-authored-by: Jean-Christophe Fillion-Robin <[email protected]> Co-authored-by: Andras Lasso <[email protected]>
commontk · Apr 8, 2024 · 8a61e8a · 8a61e8a
1 parent e4093e2
commit 8a61e8a
Show file tree

Hide file tree

Showing 18 changed files with 353 additions and 319 deletions.
diff --git a/Libs/Core/ctkJobScheduler.cpp b/Libs/Core/ctkJobScheduler.cpp
diff --git a/Libs/DICOM/Core/ctkDICOMDatabase.cpp b/Libs/DICOM/Core/ctkDICOMDatabase.cpp
@@ -410,9 +410,9 @@ bool ctkDICOMDatabasePrivate::insertConnectionName(int& dbConnectionNameID,
     logger.debug("New connection name inserted: database item ID = " + QString().setNum(dbConnectionNameID));
   }
 
-  patientConnectionName dbpConnectionName;
-  dbpConnectionName.connectionName = connectionName;
-  dbpConnectionName.dbPatientID = dbPatientID;
+  PatientConnectionName dbpConnectionName;
+  dbpConnectionName.ConnectionName = connectionName;
+  dbpConnectionName.DBPatientID = dbPatientID;
   this->InsertedConnectionNamesIDCache[dbpConnectionName] = dbConnectionNameID;
   return connectionNameFound;
 }
@@ -777,10 +777,10 @@ bool ctkDICOMDatabasePrivate::insertPatientStudySeries(const ctkDICOMItem& datas
     }
   }
 
-  patientConnectionName dbpConnectionName;
-  dbpConnectionName.connectionName = connectionName;
-  dbpConnectionName.dbPatientID = dbPatientID;
-  QMap<patientConnectionName, int>::iterator connectionNameIDit =
+  PatientConnectionName dbpConnectionName;
+  dbpConnectionName.ConnectionName = connectionName;
+  dbpConnectionName.DBPatientID = dbPatientID;
+  QMap<PatientConnectionName, int>::iterator connectionNameIDit =
     this->InsertedConnectionNamesIDCache.find(dbpConnectionName);
   if (connectionNameIDit == this->InsertedConnectionNamesIDCache.end())
   {

diff --git a/Libs/DICOM/Core/ctkDICOMDatabase_p.h b/Libs/DICOM/Core/ctkDICOMDatabase_p.h
@@ -149,21 +149,21 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMDatabasePrivate
   QMap<QString, int> InsertedPatientsCompositeIDCache;
 
   /// map from patient database ID and connection name to database ID
-  struct patientConnectionName{
-    int dbPatientID;
-    QString connectionName;
+  struct PatientConnectionName{
+    int DBPatientID;
+    QString ConnectionName;
 
     // Define comparison function for sorting
-    bool operator < (const patientConnectionName& other) const
+    bool operator < (const PatientConnectionName& other) const
     {
-      if (dbPatientID != other.dbPatientID)
+      if (DBPatientID != other.DBPatientID)
       {
-        return dbPatientID < other.dbPatientID;
+        return DBPatientID < other.DBPatientID;
       }
-      return connectionName < other.connectionName;
+      return ConnectionName < other.ConnectionName;
     }
   };
-  QMap<patientConnectionName, int> InsertedConnectionNamesIDCache;
+  QMap<PatientConnectionName, int> InsertedConnectionNamesIDCache;
 
   /// map studies and series UIDs
   QSet<QString> InsertedStudyUIDsCache;

diff --git a/Libs/DICOM/Core/ctkDICOMEcho.cpp b/Libs/DICOM/Core/ctkDICOMEcho.cpp
@@ -44,7 +44,7 @@ class ctkDICOMEchoPrivate
   ctkDICOMEchoPrivate();
   ~ctkDICOMEchoPrivate();
 
-  /// Warning: releaseAssociation is not a thread safe method.
+  /// \warning: releaseAssociation is not a thread safe method.
   /// If called concurrently from different threads DCMTK can crash.
   /// Therefore use this method instead of calling directly SCU->releaseAssociation()
   OFCondition releaseAssociation();
@@ -96,14 +96,14 @@ ctkDICOMEchoPrivate::ctkDICOMEchoPrivate()
 ctkDICOMEchoPrivate::~ctkDICOMEchoPrivate()
 {
   if (this->SCU && this->SCU->isConnected())
-    {
-      this->releaseAssociation();
-    }
+  {
+    this->releaseAssociation();
+  }
 
-    if (this->SCU)
-    {
-      delete this->SCU;
-    }
+  if (this->SCU)
+  {
+    delete this->SCU;
+  }
 }
 
 //------------------------------------------------------------------------------
@@ -115,17 +115,15 @@ OFCondition ctkDICOMEchoPrivate::releaseAssociation()
     return status;
     }
 
-  this->AssociationMutex.lock();
+  QMutexLocker locker(&this->AssociationMutex);
   if (this->AssociationClosing)
   {
-    this->AssociationMutex.unlock();
     return status;
   }
 
   this->AssociationClosing = true;
   status = this->SCU->releaseAssociation();
   this->AssociationClosing = false;
-  this->AssociationMutex.unlock();
 
   return status;
 }

diff --git a/Libs/DICOM/Core/ctkDICOMEcho.h b/Libs/DICOM/Core/ctkDICOMEcho.h
@@ -87,14 +87,14 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMEcho : public QObject
   int connectionTimeout() const;
   ///@}
 
-  /// operation is canceled?
+  /// Return true if the operation was canceled.
   Q_INVOKABLE bool wasCanceled();
 
   /// Echo connection.
   Q_INVOKABLE bool echo();
 
   ///@{
-  /// Access the list of datasets from the last operation.
+  /// Reference job uid.
   void setJobUID(const QString& jobUID);
   QString jobUID() const;
   ///@}

diff --git a/Libs/DICOM/Core/ctkDICOMEchoWorker.h b/Libs/DICOM/Core/ctkDICOMEchoWorker.h
@@ -50,10 +50,12 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMEchoWorker : public ctkAbstractWorker
   /// Cancel worker. This method is thread safe
   void requestCancel() override;
 
+  ///@{
   /// Job.
   /// These methods are not thread safe
   void setJob(QSharedPointer<ctkAbstractJob> job) override;
   using ctkAbstractWorker::setJob;
+  ///@}
 
   ///@{
   /// Echo.

diff --git a/Libs/DICOM/Core/ctkDICOMInserter.h b/Libs/DICOM/Core/ctkDICOMInserter.h
@@ -63,7 +63,7 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMInserter : public QObject
   QStringList tagsToExcludeFromStorage() const;
   ///@}
 
-  /// operation is canceled?
+  /// Return true if the operation was canceled.
   Q_INVOKABLE bool wasCanceled();
 
   /// add JobResponseSets from queries and retrieves

diff --git a/Libs/DICOM/Core/ctkDICOMJobResponseSet.h b/Libs/DICOM/Core/ctkDICOMJobResponseSet.h
@@ -96,7 +96,7 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMJobResponseSet : public QObject
   ///@}
 
   ///@{
-  /// Task UID
+  /// Job UID
   void setJobUID(const QString& jobUID);
   QString jobUID() const;
   ///@}

diff --git a/Libs/DICOM/Core/ctkDICOMQuery.cpp b/Libs/DICOM/Core/ctkDICOMQuery.cpp
@@ -98,7 +98,7 @@ class ctkDICOMQueryPrivate
   /// Add StudyInstanceUID and SeriesInstanceUID that may be further retrieved
   void addStudyAndSeriesInstanceUID( const QString& studyInstanceUID, const QString& seriesInstanceUID );
 
-  /// Warning: releaseAssociation is not a thread safe method.
+  /// \warning: releaseAssociation is not a thread safe method.
   /// If called concurrently from different threads DCMTK can crash.
   /// Therefore use this method instead of calling directly SCU->releaseAssociation()
   OFCondition releaseAssociation();
@@ -173,21 +173,19 @@ OFCondition ctkDICOMQueryPrivate::releaseAssociation()
 {
   OFCondition status = EC_IllegalCall;
   if (!this->SCU)
-    {
+  {
     return status;
-    }
+  }
 
-  this->AssociationMutex.lock();
+  QMutexLocker locker(&this->AssociationMutex);
   if (this->AssociationClosing)
   {
-    this->AssociationMutex.unlock();
     return status;
   }
 
   this->AssociationClosing = true;
   status = this->SCU->releaseAssociation();
   this->AssociationClosing = false;
-  this->AssociationMutex.unlock();
 
   return status;
 }

diff --git a/Libs/DICOM/Core/ctkDICOMQuery.h b/Libs/DICOM/Core/ctkDICOMQuery.h
@@ -118,7 +118,7 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMQuery : public QObject
   Q_INVOKABLE QMap<QString,QVariant> filters()const;
   ///@}
 
-  /// operation is canceled?
+  /// Return true if the operation was canceled.
   Q_INVOKABLE bool wasCanceled();
 
   /// Query a remote DICOM Image Store SCP.
@@ -153,11 +153,15 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMQuery : public QObject
                                   const QString& studyInstanceUID,
                                   const QString& seriesInstanceUID);
 
-  ///@{
+
   /// Access the list of datasets from the last queryPatients, queryStudies,
   /// querySeries and queryInstances methods.
   Q_INVOKABLE QList<ctkDICOMJobResponseSet*> jobResponseSets() const;
   QList<QSharedPointer<ctkDICOMJobResponseSet>> jobResponseSetsShared() const;
+  ///@}
+
+  ///@{
+  /// Reference job uid.
   void setJobUID(const QString& jobUID);
   QString jobUID() const;
   ///@}

diff --git a/Libs/DICOM/Core/ctkDICOMQueryWorker.h b/Libs/DICOM/Core/ctkDICOMQueryWorker.h
@@ -51,10 +51,12 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMQueryWorker : public ctkAbstractWorker
   /// Cancel worker. This method is thread safe
   void requestCancel() override;
 
+  ///@{
   /// Job.
   /// These methods are not thread safe
   void setJob(QSharedPointer<ctkAbstractJob> job) override;
   using ctkAbstractWorker::setJob;
+  ///@}
 
   ///@{
   /// Querier.

diff --git a/Libs/DICOM/Core/ctkDICOMRetrieve.cpp b/Libs/DICOM/Core/ctkDICOMRetrieve.cpp
@@ -200,7 +200,7 @@ class ctkDICOMRetrievePrivate: public QObject
   ctkDICOMRetrievePrivate(ctkDICOMRetrieve& obj);
   ~ctkDICOMRetrievePrivate();
 
-  /// Warning: releaseAssociation is not a thread safe method.
+  /// \warning: releaseAssociation is not a thread safe method.
   /// If called concurrently from different threads DCMTK can crash.
   /// Therefore use this method instead of calling directly SCU->releaseAssociation()
   OFCondition releaseAssociation();
@@ -323,17 +323,15 @@ OFCondition ctkDICOMRetrievePrivate::releaseAssociation()
     return status;
     }
 
-  this->AssociationMutex.lock();
+  QMutexLocker locker(&this->AssociationMutex);
   if (this->AssociationClosing)
   {
-    this->AssociationMutex.unlock();
     return status;
   }
 
   this->AssociationClosing = true;
   status = this->SCU->releaseAssociation();
   this->AssociationClosing = false;
-  this->AssociationMutex.unlock();
 
   return status;
 }

diff --git a/Libs/DICOM/Core/ctkDICOMRetrieve.h b/Libs/DICOM/Core/ctkDICOMRetrieve.h
@@ -109,7 +109,7 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMRetrieve : public QObject
   int connectionTimeout() const;
   ///@}
 
-  /// operation is canceled?
+  /// Return true if the operation was canceled.
   Q_INVOKABLE bool wasCanceled();
 
   ///@{
@@ -128,6 +128,10 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMRetrieve : public QObject
   Q_INVOKABLE void addJobResponseSet(ctkDICOMJobResponseSet& jobResponseSet);
   void addJobResponseSet(QSharedPointer<ctkDICOMJobResponseSet> jobResponseSet);
   void removeJobResponseSet(QSharedPointer<ctkDICOMJobResponseSet> jobResponseSet);
+  ///@}
+
+  ///@{
+  /// Reference job uid.
   void setJobUID(const QString& jobUID);
   QString jobUID() const;
   ///@}

diff --git a/Libs/DICOM/Core/ctkDICOMRetrieveWorker.h b/Libs/DICOM/Core/ctkDICOMRetrieveWorker.h
@@ -50,10 +50,12 @@ class CTK_DICOM_CORE_EXPORT ctkDICOMRetrieveWorker : public ctkAbstractWorker
   /// Cancel worker. This method is thread safe
   void requestCancel() override;
 
+  ///@{
   /// Job.
   /// These methods are not thread safe
   void setJob(QSharedPointer<ctkAbstractJob> job) override;
   using ctkAbstractWorker::setJob;
+  ///@}
 
   ///@{
   /// Retriever.