pmConceptsWrite.h

Go to the documentation of this file.
00001 /* @file  pmConceptsWrite.h
00002  * @brief Writing concepts to a variety of sources.
00003  *
00004  * @author Paul Price, IfA
00005  *
00006  * @version $Revision: 1.5 $ $Name:  $
00007  * @date $Date: 2007/01/24 02:54:15 $
00008  * Copyright 2005-2006 Institute for Astronomy, University of Hawaii
00009  */
00010 
00011 #ifndef PM_CONCEPTS_WRITE_H
00012 #define PM_CONCEPTS_WRITE_H
00013 
00014 /// @addtogroup Concepts Data Abstraction Concepts
00015 /// @{
00016 
00017 #include <pslib.h>
00018 #include "pmFPA.h"
00019 
00020 /// "Write" concepts to (actually, check against) the camera format file's CELLS.
00021 ///
00022 /// Examines the CELLS metadata in the camera format file for the current type of cell, and checks that the
00023 /// concepts as defined there match the ones defined in the cell.  A warning is produced if the concepts do
00024 /// not match.
00025 bool p_pmConceptsWriteToCells(const psMetadata *specs, ///< The concept specifications
00026                               const pmCell *cell, ///< The cell
00027                               const psMetadata *concepts ///< The concepts
00028                              );
00029 
00030 /// "Write" concepts to (actually, check against) the camera format file's DEFAULTS.
00031 ///
00032 /// Examines the DEFAULTS metadata in the camera format file, and checks that the concepts as defined there
00033 /// match the ones defined in the cell.  A warning is produced if the concepts do not match.
00034 bool p_pmConceptsWriteToDefaults(const psMetadata *specs, ///< The concept specifications
00035                                  const pmFPA *fpa, ///< The FPA
00036                                  const pmChip *chip, ///< The chip
00037                                  const pmCell *cell, ///< The cell
00038                                  const psMetadata *concepts ///< The concepts
00039                                 );
00040 
00041 /// "Write" concepts to (actually, add to, pending a later write) the FITS header.
00042 ///
00043 /// Examines the FITS header TRANSLATION metadata in the camera format file, and writes concepts to the
00044 /// appropriate FITS headers in the HDU, in preparation for a future write of the HDU.
00045 bool p_pmConceptsWriteToHeader(const psMetadata *specs, ///< The concept specifications
00046                                const pmFPA *fpa, ///< The FPA
00047                                const pmChip *chip, ///< The chip
00048                                const pmCell *cell, ///< The cell
00049                                const psMetadata *concepts ///< The concepts
00050                               );
00051 
00052 /// Write concepts to the database.
00053 ///
00054 /// Examines the DATABASE metadata in the camera format file, and writes concepts to the database.
00055 /// Warning: This function has not been tested; use at your own risk.
00056 bool p_pmConceptsWriteToDatabase(const psMetadata *specs, ///< The concept specifications
00057                                  const pmFPA *fpa, ///< The FPA
00058                                  const pmChip *chip, ///< The chip
00059                                  const pmCell *cell, ///< The cell
00060                                  psDB *db,///< The database handle
00061                                  const psMetadata *concepts ///< The concepts
00062                                 );
00063 /// @}
00064 #endif

Generated on Fri Feb 2 22:35:28 2007 for Pan-STARRS Module Library by  doxygen 1.5.1