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

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.h (modified) (1 diff)

trunk/psModules/src/concepts/pmConceptsWrite.h

@@ -5 +5 @@
 #include "pmFPA.h"
 
-bool p_pmConceptsWriteToCells(psMetadata *specs, // The concept specifications
-                              pmCell *cell,   // The cell
-                              psMetadata *concepts // The concepts
+/// "Write" concepts to (actually, check against) the camera format file's CELLS.
+///
+/// Examines the CELLS metadata in the camera format file for the current type of cell, and checks that the
+/// concepts as defined there match the ones defined in the cell.  A warning is produced if the concepts do
+/// not match.
+bool p_pmConceptsWriteToCells(const psMetadata *specs, ///< The concept specifications
+                              const pmCell *cell, ///< The cell
+                              const psMetadata *concepts ///< The concepts
                              );
-bool p_pmConceptsWriteToDefaults(psMetadata *specs, // The concept specifications
-                                 pmFPA *fpa, // The FPA
-                                 pmChip *chip, // The chip
-                                 pmCell *cell, // The cell
-                                 psMetadata *concepts // The concepts
+
+/// "Write" concepts to (actually, check against) the camera format file's DEFAULTS.
+///
+/// Examines the DEFAULTS metadata in the camera format file, and checks that the concepts as defined there
+/// match the ones defined in the cell.  A warning is produced if the concepts do not match.
+bool p_pmConceptsWriteToDefaults(const psMetadata *specs, ///< The concept specifications
+                                 const pmFPA *fpa, ///< The FPA
+                                 const pmChip *chip, ///< The chip
+                                 const pmCell *cell, ///< The cell
+                                 const psMetadata *concepts ///< The concepts
                                 );
-bool p_pmConceptsWriteToHeader(psMetadata *specs, // The concept specifications
-                               pmFPA *fpa, // The FPA
-                               pmChip *chip, // The chip
-                               pmCell *cell, // The cell
-                               psMetadata *concepts // The concepts
+
+/// "Write" concepts to (actually, add to, pending a later write) the FITS header.
+///
+/// Examines the FITS header TRANSLATION metadata in the camera format file, and writes concepts to the
+/// appropriate FITS headers in the HDU, in preparation for a future write of the HDU.
+bool p_pmConceptsWriteToHeader(const psMetadata *specs, ///< The concept specifications
+                               const pmFPA *fpa, ///< The FPA
+                               const pmChip *chip, ///< The chip
+                               const pmCell *cell, ///< The cell
+                               const psMetadata *concepts ///< The concepts
                               );
-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
+
+/// Write concepts to the database.
+///
+/// Examines the DATABASE metadata in the camera format file, and writes concepts to the database.
+/// Warning: This function has not been tested; use at your own risk.
+bool p_pmConceptsWriteToDatabase(const psMetadata *specs, ///< The concept specifications
+                                 const pmFPA *fpa, ///< The FPA
+                                 const pmChip *chip, ///< The chip
+                                 const pmCell *cell, ///< The cell
+                                 psDB *db,///< The database handle
+                                 const psMetadata *concepts ///< The concepts
                                 );