Changeset 9572 for trunk/psModules/src/concepts/pmConceptsWrite.c

Timestamp:

Oct 13, 2006, 4:35:39 PM (20 years ago)

Author:

Paul Price

Message:

Adding const where appropriate. Adding doxygen documentation to header files. Removing comments on functions defined in the header file, so that there's only a single source.

File:

• trunk/psModules/src/concepts/pmConceptsWrite.c (modified) (10 diffs)

trunk/psModules/src/concepts/pmConceptsWrite.c

@@ -18 +18 @@
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-static bool compareConcepts(psMetadataItem *compare, // Item to compare
-                            psMetadataItem *standard // Standard for comparison
+static bool compareConcepts(const psMetadataItem *compare, // Item to compare
+                            const psMetadataItem *standard // Standard for comparison
                            )
 {
@@ -105 +105 @@
 
 // Format a single concept
-static psMetadataItem *conceptFormat(pmConceptSpec *spec, // The concept specification
-                                     psMetadataItem *concept, // The concept to parse
-                                     psMetadata *cameraFormat, // The camera format
-                                     pmFPA *fpa, // The FPA
-                                     pmChip *chip, // The chip
-                                     pmCell *cell // The cell
+static psMetadataItem *conceptFormat(const pmConceptSpec *spec, // The concept specification
+                                     const psMetadataItem *concept, // The concept to parse
+                                     const psMetadata *cameraFormat, // The camera format
+                                     const pmFPA *fpa, // The FPA
+                                     const pmChip *chip, // The chip
+                                     const pmCell *cell // The cell
                                     )
 {
@@ -121 +121 @@
             formatted = spec->format(concept, cameraFormat, fpa, chip, cell);
         } else {
-            formatted = psMemIncrRefCounter(concept);
+            formatted = psMemIncrRefCounter((const psPtr)concept);
         }
 
@@ -132 +132 @@
 static bool writeSingleHeader(pmHDU *hdu, // HDU for which to add to the header
                               const char *keyword, // Keyword to add
-                              psMetadataItem *item // Item to add to the header; may be NULL
+                              const psMetadataItem *item // Item to add to the header; may be NULL
                              )
 {
@@ -182 +182 @@
 static bool writeHeader(pmHDU *hdu,     // HDU for which to add to the header
                         const char *keywords, // Keywords to add
-                        psMetadataItem *item // Item to add to the header
+                        const psMetadataItem *item // Item to add to the header
                        )
 {
@@ -220 +220 @@
 //////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-bool p_pmConceptsWriteToCells(psMetadata *specs, // The concept specifications
-                              pmCell *cell,   // The cell
-                              psMetadata *concepts // The concepts
-                             )
+bool p_pmConceptsWriteToCells(const psMetadata *specs, const pmCell *cell, const psMetadata *concepts)
 {
     PS_ASSERT_PTR_NON_NULL(specs, false);
@@ -230 +227 @@
         return false;
     }
-    if (!cell->config)
-        return false;
+    if (!cell->config) {
+        return false;
+    }
 
     pmHDU *hdu = pmHDUGetLowest(NULL, NULL, cell); // The HDU at the lowest level
@@ -291 +289 @@
 }
 
-bool p_pmConceptsWriteToDefaults(psMetadata *specs, // The concept specifications
-                                 pmFPA *fpa, // The FPA
-                                 pmChip *chip, // The chip
-                                 pmCell *cell, // The cell
-                                 psMetadata *concepts // The concepts
-                                )
+bool p_pmConceptsWriteToDefaults(const psMetadata *specs, const pmFPA *fpa, const pmChip *chip,
+                                 const pmCell *cell, psMetadata *concepts)
 {
     PS_ASSERT_PTR_NON_NULL(specs, false);
@@ -357 +351 @@
 
 
-bool p_pmConceptsWriteToHeader(psMetadata *specs, // The concept specifications
-                               pmFPA *fpa, // The FPA
-                               pmChip *chip, // The chip
-                               pmCell *cell, // The cell
-                               psMetadata *concepts // The concepts
-                              )
+bool p_pmConceptsWriteToHeader(const psMetadata *specs, const pmFPA *fpa, const pmChip *chip,
+                               const pmCell *cell, const psMetadata *concepts)
 {
     PS_ASSERT_PTR_NON_NULL(specs, false);
@@ -405 +395 @@
 
 // XXX Warning: This code has not been tested at all
-bool p_pmConceptsWriteToDatabase(psMetadata *specs, // The concept specifications
-                                 pmFPA *fpa, // The FPA
-                                 pmChip *chip, // The chip
-                                 pmCell *cell, // The cell
-                                 psDB *db,// The database handle
-                                 psMetadata *concepts // The concepts
-                                )
+bool p_pmConceptsWriteToDatabase(const psMetadata *specs, const pmFPA *fpa, const pmChip *chip,
+                                 const pmCell *cell, psDB *db, const psMetadata *concepts)
 {
     PS_ASSERT_PTR_NON_NULL(specs, false);