IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Oct 13, 2006, 3:02:31 PM (20 years ago)
Author:
Paul Price
Message:

Renaming functions in pmConceptsRead.h and pmConceptsWrite.h to be private ("p_").
Adding const where appropriate, and changing order of parameters to match usual
convention (outputs go first).

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/psModules/src/concepts/pmConceptsRead.h

    r7017 r9570  
    22#define PM_CONCEPTS_READ_H
    33
    4 #include "pslib.h"
     4#include <pslib.h>
    55#include "pmFPA.h"
    66
    7 bool pmConceptsReadFromCamera(psMetadata *specs, // The concept specifications
    8                               pmCell *cell,  // The cell
    9                               psMetadata *target // Place into which to read the concepts
    10                              );
    11 bool pmConceptsReadFromDefaults(psMetadata *specs, // The concept specifications
    12                                 pmFPA *fpa, // The FPA
    13                                 pmChip *chip, // The chip
    14                                 pmCell *cell, // The cell
    15                                 psMetadata *target // Place into which to read the concepts
    16                                );
    17 bool pmConceptsReadFromHeader(psMetadata *specs, // The concept specifications
    18                               pmFPA *fpa, // The FPA
    19                               pmChip *chip, // The chip
    20                               pmCell *cell,  // The cell
    21                               psMetadata *target // Place into which to read the concepts
    22                              );
    23 bool pmConceptsReadFromDatabase(psMetadata *specs, // The concept specifications
    24                                 pmFPA *fpa, // The FPA
    25                                 pmChip *chip, // The chip
    26                                 pmCell *cell,  // The cell
    27                                 psDB *db, // The database handle
    28                                 psMetadata *target // Place into which to read the concepts
     7/// Read concepts from the camera configuration file's CELLS.
     8///
     9/// Examines the CELLS metadata in the camera configuration file
     10/// for the current type of cell, and sucks in the concepts defined there.
     11/// This is a useful way of defining concepts that vary depending on the
     12/// type of the cell.
     13bool p_pmConceptsReadFromCells(psMetadata *target, ///< Place into which to read the concepts
     14                               const psMetadata *specs, ///< The concept specifications
     15                               const pmCell *cell ///< The cell
     16                              );
     17
     18/// Read concepts from the DEFAULTS in the camera configuration file.
     19///
     20/// Examines the DEFAULTS metadata in the camera configuration file
     21/// for concepts in the specs, and imports them into the target.
     22bool p_pmConceptsReadFromDefaults(psMetadata *target, // Place into which to read the concepts
     23                                  const psMetadata *specs, // The concept specifications
     24                                  const pmFPA *fpa, // The FPA
     25                                  const pmChip *chip, // The chip
     26                                  const pmCell *cell // The cell
     27                                 );
     28
     29/// Read concepts from the header TRANSLATION in the camera configuration file.
     30///
     31/// Examines the TRANSLATION metadata in the camera configuration file
     32/// for concepts in the specs, and imports them into the target.
     33bool p_pmConceptsReadFromHeader(psMetadata *target, // Place into which to read the concepts
     34                                const psMetadata *specs, // The concept specifications
     35                                const pmFPA *fpa, // The FPA
     36                                const pmChip *chip, // The chip
     37                                const pmCell *cell  // The cell
    2938                               );
    3039
    31 
    32 
    33 
    34 #ifdef OLD
    35 psMetadataItem *pmConceptReadFromCamera(pmCell *cell, // The cell
    36                                         const char *concept // Name of concept
    37                                        );
    38 
    39 psMetadataItem *pmConceptReadFromHeader(pmFPA *fpa, // The FPA that contains the chip
    40                                         pmChip *chip, // The chip that contains the cell
    41                                         pmCell *cell, // The cell
    42                                         const char *concept // Name of concept
    43                                        );
    44 
    45 psMetadataItem *pmConceptReadFromDefault(pmFPA *fpa, // The FPA that contains the chip
    46         pmChip *chip, // The chip that contains the cell
    47         pmCell *cell, // The cell
    48         const char *concept // Name of concept
    49                                         );
    50 
    51 psMetadataItem *pmConceptReadFromDB(pmFPA *fpa, // The FPA that contains the chip
    52                                     pmChip *chip, // The chip that contains the cell
    53                                     pmCell *cell, // The cell
    54                                     psDB *db, // DB handle
    55                                     const char *concept // Name of concept
    56                                    );
    57 
    58 psMetadataItem *pmConceptRead(pmFPA *fpa, // The FPA
    59                               pmChip *chip,// The chip
    60                               pmCell *cell, // The cell
    61                               psDB *db, // DB handle
    62                               const char *concept // Concept name
    63                              );
    64 
    65 float pmConceptReadF32(pmFPA *fpa,        // The FPA
    66                        pmChip *chip,      // The chip
    67                        pmCell *cell,      // The cell
    68                        psDB *db,          // DB handle
    69                        const char *name // Name of the concept
    70                       );
    71 
    72 double pmConceptReadF64(pmFPA *fpa,   // The FPA
    73                         pmChip *chip, // The chip
    74                         pmCell *cell, // The cell
    75                         psDB *db,     // DB handle
    76                         const char *name // Name of the concept
    77                        );
    78 
    79 int pmConceptReadS32(pmFPA *fpa,   // The FPA
    80                      pmChip *chip, // The chip
    81                      pmCell *cell, // The cell
    82                      psDB *db,     // DB handle
    83                      const char *name // Name of the concept
    84                     );
    85 
    86 psString pmConceptReadString(pmFPA *fpa, // The FPA
    87                              pmChip *chip, // The chip
    88                              pmCell *cell, // The cell
    89                              psDB *db,  // DB handle
    90                              const char *name // Name of the concept
    91                             );
    92 #endif
     40/// Read concepts from the header DATABASE in the camera configuration file.
     41///
     42/// Examines the DATABASE metadata in the camera configuration file
     43/// for concepts in the specs, and imports them into the target.
     44/// WARNING: This function has not been tested; use at your own risk!
     45bool p_pmConceptsReadFromDatabase(psMetadata *target, // Place into which to read the concepts
     46                                  const psMetadata *specs, // The concept specifications
     47                                  const pmFPA *fpa, // The FPA
     48                                  const pmChip *chip, // The chip
     49                                  const pmCell *cell,  // The cell
     50                                  psDB *db // The database handle
     51                                 );
    9352
    9453#endif
Note: See TracChangeset for help on using the changeset viewer.