IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

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

    r9510 r9572  
    22#define PM_CONCEPTS_STANDARD_H
    33
    4 #include "pslib.h"
     4#include <pslib.h>
    55#include "pmFPA.h"
    66
    77// Functions to parse and format the standard concepts
    88
    9 psMetadataItem *p_pmConceptParse_FPA_Coords(psMetadataItem *concept,
    10         psMetadataItem *pattern,
    11         psMetadata *cameraFormat,
    12         pmFPA *fpa,
    13         pmChip *chip,
    14         pmCell *cell);
    15 psMetadataItem *p_pmConceptFormat_FPA_Coords(psMetadataItem *concept,
    16         psMetadata *cameraFormat,
    17         pmFPA *fpa,
    18         pmChip *chip,
    19         pmCell *cell);
    20 psMetadataItem *p_pmConceptParse_CELL_TRIMSEC(psMetadataItem *concept,
    21         psMetadataItem *pattern,
    22         psMetadata *cameraFormat,
    23         pmFPA *fpa,
    24         pmChip *chip,
    25         pmCell *cell);
    26 psMetadataItem *p_pmConceptParse_CELL_BIASSEC(psMetadataItem *concept,
    27         psMetadataItem *pattern,
    28         psMetadata *cameraFormat,
    29         pmFPA *fpa,
    30         pmChip *chip,
    31         pmCell *cell);
    32 psMetadataItem *p_pmConceptParse_CELL_Binning(psMetadataItem *concept,
    33         psMetadataItem *pattern,
    34         psMetadata *cameraFormat,
    35         pmFPA *fpa,
    36         pmChip *chip,
    37         pmCell *cell);
    38 psMetadataItem *p_pmConceptParse_TIMESYS(psMetadataItem *concept,
    39         psMetadataItem *pattern,
    40         psMetadata *cameraFormat,
    41         pmFPA *fpa,
    42         pmChip *chip,
    43         pmCell *cell);
    44 psMetadataItem *p_pmConceptParse_TIME(psMetadataItem *concept,
    45                                       psMetadataItem *pattern,
    46                                       psMetadata *cameraFormat,
    47                                       pmFPA *fpa,
    48                                       pmChip *chip,
    49                                       pmCell *cell);
    50 psMetadataItem *p_pmConceptParse_Positions(psMetadataItem *concept,
    51         psMetadataItem *pattern,
    52         psMetadata *cameraFormat,
    53         pmFPA *fpa,
    54         pmChip *chip,
    55         pmCell *cell);
    56 psMetadataItem *p_pmConceptFormat_CELL_TRIMSEC(psMetadataItem *concept,
    57         psMetadata *cameraFormat,
    58         pmFPA *fpa,
    59         pmChip *chip,
    60         pmCell *cell);
    61 psMetadataItem *p_pmConceptFormat_CELL_BIASSEC(psMetadataItem *concept,
    62         psMetadata *cameraFormat,
    63         pmFPA *fpa,
    64         pmChip *chip,
    65         pmCell *cell);
    66 psMetadataItem *p_pmConceptFormat_CELL_XBIN(psMetadataItem *concept,
    67         psMetadata *cameraFormat,
    68         pmFPA *fpa,
    69         pmChip *chip,
    70         pmCell *cell);
    71 psMetadataItem *p_pmConceptFormat_CELL_YBIN(psMetadataItem *concept,
    72         psMetadata *cameraFormat,
    73         pmFPA *fpa,
    74         pmChip *chip,
    75         pmCell *cell);
    76 psMetadataItem *p_pmConceptFormat_TIMESYS(psMetadataItem *concept,
    77         psMetadata *cameraFormat,
    78         pmFPA *fpa,
    79         pmChip *chip,
    80         pmCell *cell);
    81 psMetadataItem *p_pmConceptFormat_TIME(psMetadataItem *concept,
    82                                        psMetadata *cameraFormat,
    83                                        pmFPA *fpa,
    84                                        pmChip *chip,
    85                                        pmCell *cell);
    86 psMetadataItem *p_pmConceptFormat_Positions(psMetadataItem *concept,
    87         psMetadata *cameraFormat,
    88         pmFPA *fpa,
    89         pmChip *chip,
    90         pmCell *cell);
     9
     10/// Parse the coordinates concepts: FPA.RA and FPA.DEC
     11psMetadataItem *p_pmConceptParse_FPA_Coords(const psMetadataItem *concept, ///< Concept to parse
     12        const psMetadataItem *pattern, ///< Pattern to use in parsing
     13        const psMetadata *cameraFormat, ///< Camera format definition
     14        const pmFPA *fpa, ///< FPA for concept, or NULL
     15        const pmChip *chip, ///< Chip for concept, or NULL
     16        const pmCell *cell ///< Cell for concept, or NULL
     17                                           );
     18
     19/// Format the coordinates concepts: FPA.RA and FPA.DEC
     20psMetadataItem *p_pmConceptFormat_FPA_Coords(const psMetadataItem *concept, ///< Concept to format
     21        const psMetadata *cameraFormat, ///< Camera format definition
     22        const pmFPA *fpa, ///< FPA for concept, or NULL
     23        const pmChip *chip, ///< Chip for concept, or NULL
     24        const pmCell *cell ///< Cell for concept, or NULL
     25                                            );
     26
     27/// Parse the CELL.TRIMSEC concept
     28psMetadataItem *p_pmConceptParse_CELL_TRIMSEC(const psMetadataItem *concept, ///< Concept to parse
     29        const psMetadataItem *pattern, ///< Pattern to use in parsing
     30        const psMetadata *cameraFormat, ///< Camera format definition
     31        const pmFPA *fpa, ///< FPA for concept, or NULL
     32        const pmChip *chip, ///< Chip for concept, or NULL
     33        const pmCell *cell ///< Cell for concept, or NULL
     34                                             );
     35
     36/// Parse the CELL.BIASSEC concept
     37psMetadataItem *p_pmConceptParse_CELL_BIASSEC(const psMetadataItem *concept, ///< Concept to parse
     38        const psMetadataItem *pattern, ///< Pattern to use in parsing
     39        const psMetadata *cameraFormat, ///< Camera format definition
     40        const pmFPA *fpa, ///< FPA for concept, or NULL
     41        const pmChip *chip, ///< Chip for concept, or NULL
     42        const pmCell *cell ///< Cell for concept, or NULL
     43                                             );
     44
     45/// Parse the cell binning concepts: CELL.XBIN, CELL.YBIN
     46psMetadataItem *p_pmConceptParse_CELL_Binning(const psMetadataItem *concept, ///< Concept to parse
     47        const psMetadataItem *pattern, ///< Pattern to use in parsing
     48        const psMetadata *cameraFormat, ///< Camera format definition
     49        const pmFPA *fpa, ///< FPA for concept, or NULL
     50        const pmChip *chip, ///< Chip for concept, or NULL
     51        const pmCell *cell ///< Cell for concept, or NULL
     52                                             );
     53
     54/// Parse the time system concepts: FPA.TIMESYS and CELL.TIMESYS
     55psMetadataItem *p_pmConceptParse_TIMESYS(const psMetadataItem *concept, ///< Concept to parse
     56        const psMetadataItem *pattern, ///< Pattern to use in parsing
     57        const psMetadata *cameraFormat, ///< Camera format definition
     58        const pmFPA *fpa, ///< FPA for concept, or NULL
     59        const pmChip *chip, ///< Chip for concept, or NULL
     60        const pmCell *cell ///< Cell for concept, or NULL
     61                                        );
     62
     63/// Parse the time concepts: FPA.TIME and CELL.TIME
     64psMetadataItem *p_pmConceptParse_TIME(const psMetadataItem *concept, ///< Concept to parse
     65                                      const psMetadataItem *pattern, ///< Pattern to use in parsing
     66                                      const psMetadata *cameraFormat, ///< Camera format definition
     67                                      const pmFPA *fpa, ///< FPA for concept, or NULL
     68                                      const pmChip *chip, ///< Chip for concept, or NULL
     69                                      const pmCell *cell ///< Cell for concept, or NULL
     70                                     );
     71
     72/// Parse a cell position concept, e.g., CELL.X0
     73psMetadataItem *p_pmConceptParse_Positions(const psMetadataItem *concept, ///< Concept to parse
     74        const psMetadataItem *pattern, ///< Pattern to use in parsing
     75        const psMetadata *cameraFormat, ///< Camera format definition
     76        const pmFPA *fpa, ///< FPA for concept, or NULL
     77        const pmChip *chip, ///< Chip for concept, or NULL
     78        const pmCell *cell ///< Cell for concept, or NULL
     79                                          );
     80
     81/// Format the CELL.TRIMSEC concept
     82psMetadataItem *p_pmConceptFormat_CELL_TRIMSEC(const psMetadataItem *concept, ///< Concept to format
     83        const psMetadata *cameraFormat, ///< Camera format definition
     84        const pmFPA *fpa, ///< FPA for concept, or NULL
     85        const pmChip *chip, ///< Chip for concept, or NULL
     86        const pmCell *cell ///< Cell for concept, or NULL
     87                                              );
     88
     89/// Format the CELL.BIASSEC concept
     90psMetadataItem *p_pmConceptFormat_CELL_BIASSEC(const psMetadataItem *concept, ///< Concept to format
     91        const psMetadata *cameraFormat, ///< Camera format definition
     92        const pmFPA *fpa, ///< FPA for concept, or NULL
     93        const pmChip *chip, ///< Chip for concept, or NULL
     94        const pmCell *cell ///< Cell for concept, or NULL
     95                                              );
     96
     97/// Format the CELL.XBIN concept
     98psMetadataItem *p_pmConceptFormat_CELL_XBIN(const psMetadataItem *concept, ///< Concept to format
     99        const psMetadata *cameraFormat, ///< Camera format definition
     100        const pmFPA *fpa, ///< FPA for concept, or NULL
     101        const pmChip *chip, ///< Chip for concept, or NULL
     102        const pmCell *cell ///< Cell for concept, or NULL
     103                                           );
     104
     105/// Format the CELL.YBIN concept
     106psMetadataItem *p_pmConceptFormat_CELL_YBIN(const psMetadataItem *concept, ///< Concept to format
     107        const psMetadata *cameraFormat, ///< Camera format definition
     108        const pmFPA *fpa, ///< FPA for concept, or NULL
     109        const pmChip *chip, ///< Chip for concept, or NULL
     110        const pmCell *cell ///< Cell for concept, or NULL
     111                                           );
     112
     113/// Format the time system concepts: FPA.TIMESYS and CELL.TIMESYS
     114psMetadataItem *p_pmConceptFormat_TIMESYS(const psMetadataItem *concept, ///< Concept to format
     115        const psMetadata *cameraFormat, ///< Camera format definition
     116        const pmFPA *fpa, ///< FPA for concept, or NULL
     117        const pmChip *chip, ///< Chip for concept, or NULL
     118        const pmCell *cell ///< Cell for concept, or NULL
     119                                         );
     120
     121/// Format the time concepts: FPA.TIME and CELL.TIME
     122psMetadataItem *p_pmConceptFormat_TIME(const psMetadataItem *concept, ///< Concept to format
     123                                       const psMetadata *cameraFormat, ///< Camera format definition
     124                                       const pmFPA *fpa, ///< FPA for concept, or NULL
     125                                       const pmChip *chip, ///< Chip for concept, or NULL
     126                                       const pmCell *cell ///< Cell for concept, or NULL
     127                                      );
     128
     129/// Format a cell position concept, e.g., CELL.X0
     130psMetadataItem *p_pmConceptFormat_Positions(const psMetadataItem *concept, ///< Concept to format
     131        const psMetadata *cameraFormat, ///< Camera format definition
     132        const pmFPA *fpa, ///< FPA for concept, or NULL
     133        const pmChip *chip, ///< Chip for concept, or NULL
     134        const pmCell *cell ///< Cell for concept, or NULL
     135                                           );
    91136
    92137#endif
Note: See TracChangeset for help on using the changeset viewer.