Changeset 1351 for trunk/psLib/src/collections/psMetadata.h
- Timestamp:
- Jul 30, 2004, 9:37:07 AM (22 years ago)
- File:
-
- 1 edited
-
trunk/psLib/src/collections/psMetadata.h (modified) (17 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/psLib/src/collections/psMetadata.h
r1335 r1351 1 1 /** @file psMetadata.h 2 3 4 5 6 7 8 9 10 11 12 * @version $Revision: 1.5$ $Name: not supported by cvs2svn $13 * @date $Date: 2004-07-29 20:16:34$14 15 16 2 * 3 * @brief Contains metadata struuctures, enumerations and functions prototypes 4 * 5 * This file defines metadata item, metadata type, metadata flags, metadata containers, and function 6 * prototypes necessary creating psLib metadata APIs 7 * 8 * @ingroup Metadata 9 * 10 * @author Ross Harman, MHPCC 11 * 12 * @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ 13 * @date $Date: 2004-07-30 19:37:07 $ 14 * 15 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii 16 */ 17 17 #ifndef PS_METADATA_H 18 18 #define PS_METADATA_H … … 30 30 */ 31 31 typedef enum { 32 PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items33 PS_META_S32, ///< Signed 32-bit integer data.34 PS_META_F32, ///< Single-precision float data.35 PS_META_F64, ///< Double-precision float data.36 PS_META_STR, ///< String data (Stored in as void *).37 PS_META_IMG, ///< Image data (Stored in as void *).38 PS_META_JPEG, ///< JPEG data (Stored in as void .39 PS_META_PNG, ///< PNG data (Stored in as void *).40 PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *).41 PS_META_UNKNOWN, ///< Other data (Stored in as void *).32 PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items 33 PS_META_S32, ///< Signed 32-bit integer data. 34 PS_META_F32, ///< Single-precision float data. 35 PS_META_F64, ///< Double-precision float data. 36 PS_META_STR, ///< String data (Stored in as void *). 37 PS_META_IMG, ///< Image data (Stored in as void *). 38 PS_META_JPEG, ///< JPEG data (Stored in as void . 39 PS_META_PNG, ///< PNG data (Stored in as void *). 40 PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). 41 PS_META_UNKNOWN, ///< Other data (Stored in as void *). 42 42 PS_META_NTYPE ///< Number of types. Must be last. 43 43 } psMetadataType; … … 49 49 */ 50 50 typedef struct psMetadataItem 51 {52 const int id; ///< Unique ID for metadata item.53 char *restrict name; ///< Name of metadata item.54 psMetadataType type; ///< Type of metadata item.55 union56 51 { 57 psS32 S32; ///< Signed 32-bit integer data. 58 psF32 F32; ///< Single-precision float data. 59 psF64 F64; ///< Double-precision float data. 60 psPTR V; ///< Pointer to other type of data. 61 }data; ///< Union for data types. 62 char *comment; ///< Optional comment ("", not NULL). 63 psList *restrict items; ///< List of psMetadataItems with same name. 64 } 52 const int id; ///< Unique ID for metadata item. 53 char *restrict name; ///< Name of metadata item. 54 psMetadataType type; ///< Type of metadata item. 55 union 56 { 57 psS32 S32; ///< Signed 32-bit integer data. 58 psF32 F32; ///< Single-precision float data. 59 psF64 F64; ///< Double-precision float data. 60 psPTR V; ///< Pointer to other type of data. 61 }data; ///< Union for data types. 62 char *comment; ///< Optional comment ("", not NULL). 63 psList *restrict items; ///< List of psMetadataItems with same name. 64 } 65 65 psMetadataItem; 66 66 … … 72 72 */ 73 73 typedef struct psMetadata 74 {75 psList *restrict list;76 psHash *restrict table;77 }74 { 75 psList *restrict list; 76 psHash *restrict table; 77 } 78 78 psMetadata; 79 79 … … 97 97 */ 98 98 psMetadataItem *psMetadataItemAlloc( 99 const char *name, ///< Name of metadata item.100 psMetadataType type, ///< Type of metadata item.101 const char *comment, ///< Comment for metadata item.99 const char *name, ///< Name of metadata item. 100 psMetadataType type, ///< Type of metadata item. 101 const char *comment, ///< Comment for metadata item. 102 102 ... ///< Arguments for name formatting and metadata item data. 103 103 ); … … 117 117 */ 118 118 psMetadataItem *psMetadataItemAllocV( 119 const char *name, ///< Name of metadata item.120 psMetadataType type, ///< Type of metadata item.121 const char *comment, ///< Comment for metadata item.119 const char *name, ///< Name of metadata item. 120 psMetadataType type, ///< Type of metadata item. 121 const char *comment, ///< Comment for metadata item. 122 122 va_list list ///< Arguments for name formatting and metadata item data. 123 123 ); … … 140 140 */ 141 141 bool psMetadataAddItem( 142 psMetadata *restrict md, ///< Metadata collection to insert metadat item.143 int where, ///< Location to be added.142 psMetadata *restrict md, ///< Metadata collection to insert metadat item. 143 int where, ///< Location to be added. 144 144 psMetadataItem *restrict item ///< Metadata item to be added. 145 145 ); … … 152 152 */ 153 153 bool psMetadataAdd( 154 psMetadata *restrict md, ///< Metadata collection to insert metadat item.155 int where, ///< Location to be added.156 const char *name, ///< Name of metadata item.157 psMetadataType type, ///< Type of metadata item.158 const char *comment, ///< Comment for metadata item.154 psMetadata *restrict md, ///< Metadata collection to insert metadat item. 155 int where, ///< Location to be added. 156 const char *name, ///< Name of metadata item. 157 psMetadataType type, ///< Type of metadata item. 158 const char *comment, ///< Comment for metadata item. 159 159 ... ///< Arguments for name formatting and metadata item data. 160 160 ); … … 170 170 */ 171 171 bool psMetadataRemove( 172 psMetadata *restrict md, ///< Metadata collection to insert metadat item.173 int where, ///< Location to be removed.172 psMetadata *restrict md, ///< Metadata collection to insert metadat item. 173 int where, ///< Location to be removed. 174 174 const char *restrict key ///< Name of metadata key. 175 175 ); … … 183 183 */ 184 184 psMetadataItem *psMetadataLookup( 185 psMetadata *restrict md, ///< Metadata collection to insert metadat item.185 psMetadata *restrict md, ///< Metadata collection to insert metadat item. 186 186 const char *restrict key ///< Name of metadata key. 187 187 ); … … 194 194 */ 195 195 psMetadataItem *psMetadataGet( 196 psMetadata *restrict md, ///< Metadata collection to insert metadat item.196 psMetadata *restrict md, ///< Metadata collection to insert metadat item. 197 197 int where ///< Location to be retrieved. 198 198 ); … … 205 205 */ 206 206 bool psMetadataSetIterator( 207 psMetadata *restrict md, ///< Metadata collection to iterate.207 psMetadata *restrict md, ///< Metadata collection to iterate. 208 208 int where ///< Location of iterator. 209 209 ); … … 216 216 */ 217 217 psMetadataItem *psMetadataGetNext( 218 psMetadata *restrict md, ///< Metadata collection to iterate.219 const char *restrict match, ///< Beginning of key name.218 psMetadata *restrict md, ///< Metadata collection to iterate. 219 const char *restrict match, ///< Beginning of key name. 220 220 int which ///< Iterator to be used. 221 221 ); … … 228 228 */ 229 229 psMetadataItem *psMetadataGetPrevious( 230 psMetadata *restrict md, ///< Metadata collection to iterate.231 const char *restrict match, ///< Beginning of key name.230 psMetadata *restrict md, ///< Metadata collection to iterate. 231 const char *restrict match, ///< Beginning of key name. 232 232 int which ///< Iterator to be used. 233 233 ); … … 244 244 */ 245 245 void psMetadataItemPrint( 246 FILE *fd, ///< Pointer to file to write metadata item.247 const char *format, ///< Format to print metadata item.248 const psMetadataItem *restrict m d///< Metadata item to print.246 FILE *fd, ///< Pointer to file to write metadata item. 247 const char *format, ///< Format to print metadata item. 248 const psMetadataItem *restrict metadataItem ///< Metadata item to print. 249 249 ); 250 250 … … 256 256 */ 257 257 psMetadata *psMetadataReadHeader( 258 psMetadata *output, ///< Resulting metadata from read.259 const char *extname, ///< File name extension string.260 int extnum, ///< File name extension number.258 psMetadata *output, ///< Resulting metadata from read. 259 const char *extname, ///< File name extension string. 260 int extnum, ///< File name extension number. 261 261 const char *filename ///< Name of file to read. 262 262 ); … … 269 269 */ 270 270 psMetadata *psMetadataFReadHeader( 271 psMetadata *output, ///< Resulting metadata from read.272 const char *extname, ///< File name extension string.273 int extnum, ///< File name extension number.274 FILE *fd///< Pointer to file to read.271 psMetadata *output, ///< Resulting metadata from read. 272 const char *extname, ///< File name extension string. 273 int extnum, ///< File name extension number. 274 fitsfile *fd ///< Pointer to file to read. 275 275 ); 276 276 /// @}
Note:
See TracChangeset
for help on using the changeset viewer.
