Minor fixes to formatting and API documentation.

Minor fixes to source code formatting and API documentation of some SR IOD constraint checker classes.
DCMTK · Sep 6, 2024 · f18f498 · f18f498
1 parent 919e3a9
commit f18f498
Show file tree

Hide file tree

Showing 13 changed files with 39 additions and 51 deletions.
diff --git a/dcmsr/include/dcmtk/dcmsr/dsrchecc.h b/dcmsr/include/dcmtk/dcmsr/dsrchecc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2003-2015, OFFIS e.V.
+ *  Copyright (C) 2003-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -63,10 +63,9 @@ class DCMTK_DCMSR_EXPORT DSRChestCadSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrcolcc.h b/dcmsr/include/dcmtk/dcmsr/dsrcolcc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2010-2015, OFFIS e.V.
+ *  Copyright (C) 2010-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -61,10 +61,9 @@ class DCMTK_DCMSR_EXPORT DSRColonCadSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrimpcc.h b/dcmsr/include/dcmtk/dcmsr/dsrimpcc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2010-2015, OFFIS e.V.
+ *  Copyright (C) 2010-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRImplantationPlanSRDocumentConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrkeycc.h b/dcmsr/include/dcmtk/dcmsr/dsrkeycc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2003-2015, OFFIS e.V.
+ *  Copyright (C) 2003-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRKeyObjectSelectionDocumentConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrmaccc.h b/dcmsr/include/dcmtk/dcmsr/dsrmaccc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2010-2015, OFFIS e.V.
+ *  Copyright (C) 2010-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRMacularGridThicknessAndVolumeReportConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrmamcc.h b/dcmsr/include/dcmtk/dcmsr/dsrmamcc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2003-2015, OFFIS e.V.
+ *  Copyright (C) 2003-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -64,10 +64,9 @@ class DCMTK_DCMSR_EXPORT DSRMammographyCadSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrpficc.h b/dcmsr/include/dcmtk/dcmsr/dsrpficc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2019, J. Riesmeier, Oldenburg, Germany
+ *  Copyright (C) 2019-2024, J. Riesmeier, Oldenburg, Germany
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -34,7 +34,7 @@
  *---------------------*/
 
 /** Class for checking the relationship content constraints of the Performed Imaging Agent
- *  Administration SR  IOD.
+ *  Administration SR IOD.
  *  According to DICOM PS 3.3: "The document shall be constructed from TID 11020
  *  (Performed Imaging Agent Administration) invoked at the root node."
  */
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRPerformedImagingAgentAdministrationSRConstraintCheck
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrplicc.h b/dcmsr/include/dcmtk/dcmsr/dsrplicc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2019, J. Riesmeier, Oldenburg, Germany
+ *  Copyright (C) 2019-2024, J. Riesmeier, Oldenburg, Germany
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -34,7 +34,7 @@
  *---------------------*/
 
 /** Class for checking the relationship content constraints of the Planned Imaging Agent
- *  Administration SR  IOD.
+ *  Administration SR IOD.
  *  According to DICOM PS 3.3: "The document shall be constructed from TID 11001
  *  (Planned Imaging Agent Administration) invoked at the root node."
  */
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRPlannedImagingAgentAdministrationSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrprdcc.h b/dcmsr/include/dcmtk/dcmsr/dsrprdcc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2017, J. Riesmeier, Oldenburg, Germany
+ *  Copyright (C) 2017-2024, J. Riesmeier, Oldenburg, Germany
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRPatientRadiationDoseSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrrsdcc.h b/dcmsr/include/dcmtk/dcmsr/dsrrsdcc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2020, J. Riesmeier, Oldenburg, Germany
+ *  Copyright (C) 2020-2024, J. Riesmeier, Oldenburg, Germany
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRRenditionSelectionDocumentConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrsaecc.h b/dcmsr/include/dcmtk/dcmsr/dsrsaecc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2016, J. Riesmeier, Oldenburg, Germany
+ *  Copyright (C) 2016-2024, J. Riesmeier, Oldenburg, Germany
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation are maintained by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRSimplifiedAdultEchoSRConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/include/dcmtk/dcmsr/dsrspecc.h b/dcmsr/include/dcmtk/dcmsr/dsrspecc.h
@@ -1,6 +1,6 @@
 /*
  *
- *  Copyright (C) 2010-2015, OFFIS e.V.
+ *  Copyright (C) 2010-2024, OFFIS e.V.
  *  All rights reserved.  See COPYRIGHT file for details.
  *
  *  This software and supporting documentation were developed by
@@ -62,10 +62,9 @@ class DCMTK_DCMSR_EXPORT DSRSpectaclePrescriptionReportConstraintChecker
      */
     virtual OFBool isTemplateSupportRequired() const;
 
-    /** get identifier and mapping resource of the root template (if any)
-     ** @param  templateIdentifier  identifier of the root template (might be empty)
+    /** get identifier and mapping resource of the root template
+     ** @param  templateIdentifier  identifier of the root template
      *  @param  mappingResource     mapping resource that defines the root template
-     *                              (might be empty)
      ** @return status, EC_Normal if successful, an error code otherwise
      */
     virtual OFCondition getRootTemplateIdentification(OFString &templateIdentifier,

diff --git a/dcmsr/libsrc/dsrplicc.cc b/dcmsr/libsrc/dsrplicc.cc
@@ -121,7 +121,7 @@ OFBool DSRPlannedImagingAgentAdministrationSRConstraintChecker::checkContentRela
         else if ((relationshipType == RT_hasProperties) && (sourceValueType == VT_PName))
         {
             result = (targetValueType == VT_Text) || (targetValueType == VT_Code)   || (targetValueType == VT_DateTime) ||
-                     (targetValueType == VT_Date) || (targetValueType == VT_UIDRef) ||(targetValueType == VT_PName);
+                     (targetValueType == VT_Date) || (targetValueType == VT_UIDRef) || (targetValueType == VT_PName);
         }
         /* row 8 of the table */
         else if ((relationshipType == RT_inferredFrom) &&