Changeset 9572 for trunk/psModules/src/concepts/pmConceptsStandard.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/pmConceptsStandard.c (modified) (17 diffs)

trunk/psModules/src/concepts/pmConceptsStandard.c

@@ -30 +30 @@
 
 
-static double defaultCoordScaling(psMetadataItem *pattern)
+static double defaultCoordScaling(const psMetadataItem *pattern)
 {
     if (strcmp(pattern->name, "FPA.RA") == 0) {
@@ -46 +46 @@
 
 // FPA.RA and FPA.DEC
-psMetadataItem *p_pmConceptParse_FPA_Coords(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_FPA_Coords(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -115 +115 @@
 
 // FPA.RA and FPA.DEC
-psMetadataItem *p_pmConceptFormat_FPA_Coords(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_FPA_Coords(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -165 +165 @@
 
 
-psMetadataItem *p_pmConceptParse_CELL_TRIMSEC(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_CELL_TRIMSEC(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -189 +189 @@
 }
 
-psMetadataItem *p_pmConceptParse_CELL_BIASSEC(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_CELL_BIASSEC(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -245 +245 @@
 
 // CELL.XBIN and CELL.YBIN
-psMetadataItem *p_pmConceptParse_CELL_Binning(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_CELL_Binning(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -282 +282 @@
 
 
-psMetadataItem *p_pmConceptParse_TIMESYS(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_TIMESYS(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -311 +311 @@
 }
 
-psMetadataItem *p_pmConceptParse_TIME(psMetadataItem *concept,
-                                      psMetadataItem *pattern,
-                                      psMetadata *cameraFormat,
-                                      pmFPA *fpa,
-                                      pmChip *chip,
-                                      pmCell *cell)
+psMetadataItem *p_pmConceptParse_TIME(const psMetadataItem *concept,
+                                      const psMetadataItem *pattern,
+                                      const psMetadata *cameraFormat,
+                                      const pmFPA *fpa,
+                                      const pmChip *chip,
+                                      const pmCell *cell)
 {
     assert(concept);
@@ -523 +523 @@
 
 // Correct a position --- in case the user wants FORTRAN indexing (like the FITS standard...)
-static int fortranCorr(psMetadata *cameraFormat, // The camera format description
+static int fortranCorr(const psMetadata *cameraFormat, // The camera format description
                        const char *name // Name of concept to check for FORTRAN indexing
                       )
@@ -538 +538 @@
 }
 
-psMetadataItem *p_pmConceptParse_Positions(psMetadataItem *concept,
-        psMetadataItem *pattern,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptParse_Positions(const psMetadataItem *concept,
+        const psMetadataItem *pattern,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -572 +572 @@
 
 
-psMetadataItem *p_pmConceptFormat_CELL_TRIMSEC(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_CELL_TRIMSEC(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -588 +588 @@
 }
 
-psMetadataItem *p_pmConceptFormat_CELL_BIASSEC(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_CELL_BIASSEC(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     // Return a metadata item containing a list of metadata items of region strings
@@ -614 +614 @@
 // This function actually does both CELL.XBIN and CELL.YBIN if CELL.XBIN and CELL.YBIN are specified by the
 // same header.
-psMetadataItem *p_pmConceptFormat_CELL_XBIN(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_CELL_XBIN(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -637 +637 @@
 
     // Otherwise, there's no formatting required
-    return psMemIncrRefCounter(concept);
+    return psMetadataItemCopy(concept);
 }
 
 // Only need to format if both if CELL.XBIN and CELL.YBIN are not specified by the same header.
-psMetadataItem *p_pmConceptFormat_CELL_YBIN(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_CELL_YBIN(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);
@@ -660 +660 @@
 
     // No formatting required
-    return psMemIncrRefCounter(concept);
-}
-
-
-psMetadataItem *p_pmConceptFormat_TIMESYS(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+    return psMetadataItemCopy(concept);
+}
+
+
+psMetadataItem *p_pmConceptFormat_TIMESYS(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     psString sys = NULL;            // String to store
@@ -693 +693 @@
 }
 
-psMetadataItem *p_pmConceptFormat_TIME(psMetadataItem *concept,
-                                       psMetadata *cameraFormat,
-                                       pmFPA *fpa,
-                                       pmChip *chip,
-                                       pmCell *cell)
+psMetadataItem *p_pmConceptFormat_TIME(const psMetadataItem *concept,
+                                       const psMetadata *cameraFormat,
+                                       const pmFPA *fpa,
+                                       const pmChip *chip,
+                                       const pmCell *cell)
 {
     psTime *time = concept->data.V;     // The time
@@ -808 +808 @@
 }
 
-psMetadataItem *p_pmConceptFormat_Positions(psMetadataItem *concept,
-        psMetadata *cameraFormat,
-        pmFPA *fpa,
-        pmChip *chip,
-        pmCell *cell)
+psMetadataItem *p_pmConceptFormat_Positions(const psMetadataItem *concept,
+        const psMetadata *cameraFormat,
+        const pmFPA *fpa,
+        const pmChip *chip,
+        const pmCell *cell)
 {
     assert(concept);