Changeset 1426 for trunk/psLib/src/collections/psMetadata.h
- Timestamp:
- Aug 9, 2004, 12:44:25 PM (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
r1407 r1426 11 11 * @author Ross Harman, MHPCC 12 12 * 13 * @version $Revision: 1.1 6$ $Name: not supported by cvs2svn $14 * @date $Date: 2004-08-0 7 00:06:06$13 * @version $Revision: 1.17 $ $Name: not supported by cvs2svn $ 14 * @date $Date: 2004-08-09 22:44:25 $ 15 15 * 16 16 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii … … 34 34 */ 35 35 typedef enum { 36 PS_META_ITEM_SET = 0, // 37 PS_META_BOOL, // 38 PS_META_S32, // 39 PS_META_F32, // 40 PS_META_F64, // 41 PS_META_STR, // 42 PS_META_IMG, // 43 PS_META_JPEG, // 44 PS_META_PNG, // 45 PS_META_ASTROM, // 46 PS_META_UNKNOWN, // 47 PS_META_NTYPE // 36 PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items 37 PS_META_BOOL, ///< Boolean data. 38 PS_META_S32, ///< Signed 32-bit integer data. 39 PS_META_F32, ///< Single-precision float data. 40 PS_META_F64, ///< Double-precision float data. 41 PS_META_STR, ///< String data (Stored in as void *). 42 PS_META_IMG, ///< Image data (Stored in as void *). 43 PS_META_JPEG, ///< JPEG data (Stored in as void . 44 PS_META_PNG, ///< PNG data (Stored in as void *). 45 PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). 46 PS_META_UNKNOWN, ///< Other data (Stored in as void *). 47 PS_META_NTYPE ///< Number of types. Must be last. 48 48 } psMetadataType; 49 49 … … 55 55 typedef struct psMetadataItem 56 56 { 57 const int id; // 58 char *restrict name; // 59 psMetadataType type; // 57 const int id; ///< Unique ID for metadata item. 58 char *restrict name; ///< Name of metadata item. 59 psMetadataType type; ///< Type of metadata item. 60 60 union { 61 61 bool B; 62 psS32 S32; // 63 psF32 F32; // 64 psF64 F64; // 65 psPTR V; // 66 } data; // 67 char *comment; // 68 psList *restrict items; // 62 psS32 S32; ///< Signed 32-bit integer data. 63 psF32 F32; ///< Single-precision float data. 64 psF64 F64; ///< Double-precision float data. 65 psPTR V; ///< Pointer to other type of data. 66 } data; ///< Union for data types. 67 char *comment; ///< Optional comment ("", not NULL). 68 psList *restrict items; ///< List of psMetadataItems with same name. 69 69 } 70 70 psMetadataItem; … … 102 102 * @return psMetadataItem*: Pointer metadata item. 103 103 */ 104 psMetadataItem *psMetadataItemAlloc(const char *name, // 105 psMetadataType type, // 106 const char *comment, // 107 ... // 104 psMetadataItem *psMetadataItemAlloc(const char *name, ///< Name of metadata item. 105 psMetadataType type, ///< Type of metadata item. 106 const char *comment, ///< Comment for metadata item. 107 ... ///< Arguments for name formatting and metadata item data. 108 108 ); 109 109 … … 121 121 * @return psMetadataItem*: Pointer metadata item. 122 122 */ 123 psMetadataItem *psMetadataItemAllocV(const char *name, // 124 psMetadataType type, // 125 const char *comment, // 126 va_list list // 123 psMetadataItem *psMetadataItemAllocV(const char *name, ///< Name of metadata item. 124 psMetadataType type, ///< Type of metadata item. 125 const char *comment, ///< Comment for metadata item. 126 va_list list ///< Arguments for name formatting and metadata item 127 127 // data. 128 128 ); … … 134 134 * @return psMetadata*: Pointer metadata. 135 135 */ 136 psMetadata *psMetadataAlloc(void // 136 psMetadata *psMetadataAlloc(void ///< Void. 137 137 ); 138 138 … … 143 143 * @return bool: True for success, false for failure. 144 144 */ 145 bool psMetadataAddItem(psMetadata * restrict md, // 146 int where, // 147 psMetadataItem * restrict item // 145 bool psMetadataAddItem(psMetadata * restrict md, ///< Metadata collection to insert metadat item. 146 int where, ///< Location to be added. 147 psMetadataItem * restrict item ///< Metadata item to be added. 148 148 ); 149 149 … … 154 154 * @return bool: True for success, false for failure. 155 155 */ 156 bool psMetadataAdd(psMetadata * restrict md, // 157 int where, // 158 const char *name, // 159 psMetadataType type, // 160 const char *comment, // 161 ... // 156 bool psMetadataAdd(psMetadata * restrict md, ///< Metadata collection to insert metadat item. 157 int where, ///< Location to be added. 158 const char *name, ///< Name of metadata item. 159 psMetadataType type, ///< Type of metadata item. 160 const char *comment, ///< Comment for metadata item. 161 ... ///< Arguments for name formatting and metadata item data. 162 162 ); 163 163 … … 171 171 * @return bool: True for success, false for failure. 172 172 */ 173 bool psMetadataRemove(psMetadata * restrict md, // 174 int where, // 175 const char *restrict key // 173 bool psMetadataRemove(psMetadata * restrict md, ///< Metadata collection to insert metadat item. 174 int where, ///< Location to be removed. 175 const char *restrict key ///< Name of metadata key. 176 176 ); 177 177 … … 183 183 * @return psMetadataItem*: Pointer metadata item. 184 184 */ 185 psMetadataItem *psMetadataLookup(psMetadata * restrict md, // 185 psMetadataItem *psMetadataLookup(psMetadata * restrict md, ///< Metadata collection to insert metadat 186 186 // item. 187 const char *restrict key // 187 const char *restrict key ///< Name of metadata key. 188 188 ); 189 189 … … 194 194 * @return psMetadataItem*: Pointer metadata item. 195 195 */ 196 psMetadataItem *psMetadataGet(psMetadata * restrict md, // 197 int where // 196 psMetadataItem *psMetadataGet(psMetadata * restrict md, ///< Metadata collection to insert metadat item. 197 int where ///< Location to be retrieved. 198 198 ); 199 199 … … 204 204 * @return void: void. 205 205 */ 206 bool psMetadataSetIterator(psMetadata * restrict md, // 207 int where // 206 bool psMetadataSetIterator(psMetadata * restrict md, ///< Metadata collection to iterate. 207 int where ///< Location of iterator. 208 208 ); 209 209 … … 214 214 * @return psMetadataItem*: Pointer metadata item. 215 215 */ 216 psMetadataItem *psMetadataGetNext(psMetadata * restrict md, // 217 const char *restrict match, // 218 int which // 216 psMetadataItem *psMetadataGetNext(psMetadata * restrict md, ///< Metadata collection to iterate. 217 const char *restrict match, ///< Beginning of key name. 218 int which ///< Iterator to be used. 219 219 ); 220 220 … … 225 225 * @return psMetadataItem*: Pointer metadata item. 226 226 */ 227 psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, // 228 const char *restrict match, // 229 int which // 227 psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, ///< Metadata collection to iterate. 228 const char *restrict match, ///< Beginning of key name. 229 int which ///< Iterator to be used. 230 230 ); 231 231 … … 240 240 * @return psMetadataItem*: Pointer metadata item. 241 241 */ 242 void psMetadataItemPrint(FILE * fd, // 243 const char *format, // 244 const psMetadataItem * restrict metadataItem // 242 void psMetadataItemPrint(FILE * fd, ///< Pointer to file to write metadata item. 243 const char *format, ///< Format to print metadata item. 244 const psMetadataItem * restrict metadataItem ///< Metadata item to print. 245 245 ); 246 246 … … 252 252 * @return psMetadata*: Pointer metadata. 253 253 */ 254 psMetadata *psMetadataReadHeader(psMetadata * output, // 255 char *extname, // 256 int extnum, // 257 char *filename // 254 psMetadata *psMetadataReadHeader(psMetadata * output, ///< Resulting metadata from read. 255 char *extname, ///< File name extension string. 256 int extnum, ///< File name extension number. Starts at 1. 257 char *filename ///< Name of file to read. 258 258 ); 259 259 … … 264 264 * @return psMetadata*: Pointer metadata. 265 265 */ 266 psMetadata *psMetadataFReadHeader(psMetadata * output, // 267 char *extName, // 268 int extNum, // 269 fitsfile * fd // 266 psMetadata *psMetadataFReadHeader(psMetadata * output, ///< Resulting metadata from read. 267 char *extName, ///< File name extension string. 268 int extNum, ///< File name extension number. 269 fitsfile * fd ///< Pointer to file to read. 270 270 ); 271 271
Note:
See TracChangeset
for help on using the changeset viewer.
