Index: trunk/psLib/src/collections/psMetadata.h =================================================================== --- trunk/psLib/src/collections/psMetadata.h (revision 1351) +++ trunk/psLib/src/collections/psMetadata.h (revision 1374) @@ -10,6 +10,6 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-07-30 19:37:07 $ +* @version $Revision: 1.7 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-04 00:55:17 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii @@ -18,5 +18,4 @@ #define PS_METADATA_H - /// @addtogroup Metadata /// @{ @@ -30,14 +29,14 @@ */ typedef enum { - PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items - PS_META_S32, ///< Signed 32-bit integer data. - PS_META_F32, ///< Single-precision float data. - PS_META_F64, ///< Double-precision float data. - PS_META_STR, ///< String data (Stored in as void *). - PS_META_IMG, ///< Image data (Stored in as void *). - PS_META_JPEG, ///< JPEG data (Stored in as void . - PS_META_PNG, ///< PNG data (Stored in as void *). - PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). - PS_META_UNKNOWN, ///< Other data (Stored in as void *). + PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items + PS_META_S32, ///< Signed 32-bit integer data. + PS_META_F32, ///< Single-precision float data. + PS_META_F64, ///< Double-precision float data. + PS_META_STR, ///< String data (Stored in as void *). + PS_META_IMG, ///< Image data (Stored in as void *). + PS_META_JPEG, ///< JPEG data (Stored in as void . + PS_META_PNG, ///< PNG data (Stored in as void *). + PS_META_ASTROM, ///< Astrometric coefficients (Stored in as void *). + PS_META_UNKNOWN, ///< Other data (Stored in as void *). PS_META_NTYPE ///< Number of types. Must be last. } psMetadataType; @@ -97,7 +96,7 @@ */ psMetadataItem *psMetadataItemAlloc( - const char *name, ///< Name of metadata item. - psMetadataType type, ///< Type of metadata item. - const char *comment, ///< Comment for metadata item. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. ... ///< Arguments for name formatting and metadata item data. ); @@ -117,7 +116,7 @@ */ psMetadataItem *psMetadataItemAllocV( - const char *name, ///< Name of metadata item. - psMetadataType type, ///< Type of metadata item. - const char *comment, ///< Comment for metadata item. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. va_list list ///< Arguments for name formatting and metadata item data. ); @@ -140,6 +139,6 @@ */ bool psMetadataAddItem( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where, ///< Location to be added. + psMetadata *restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. psMetadataItem *restrict item ///< Metadata item to be added. ); @@ -152,9 +151,9 @@ */ bool psMetadataAdd( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where, ///< Location to be added. - const char *name, ///< Name of metadata item. - psMetadataType type, ///< Type of metadata item. - const char *comment, ///< Comment for metadata item. + psMetadata *restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be added. + const char *name, ///< Name of metadata item. + psMetadataType type, ///< Type of metadata item. + const char *comment, ///< Comment for metadata item. ... ///< Arguments for name formatting and metadata item data. ); @@ -170,6 +169,6 @@ */ bool psMetadataRemove( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where, ///< Location to be removed. + psMetadata *restrict md, ///< Metadata collection to insert metadat item. + int where, ///< Location to be removed. const char *restrict key ///< Name of metadata key. ); @@ -183,5 +182,5 @@ */ psMetadataItem *psMetadataLookup( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. + psMetadata *restrict md, ///< Metadata collection to insert metadat item. const char *restrict key ///< Name of metadata key. ); @@ -194,5 +193,5 @@ */ psMetadataItem *psMetadataGet( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. + psMetadata *restrict md, ///< Metadata collection to insert metadat item. int where ///< Location to be retrieved. ); @@ -205,5 +204,5 @@ */ bool psMetadataSetIterator( - psMetadata *restrict md, ///< Metadata collection to iterate. + psMetadata *restrict md, ///< Metadata collection to iterate. int where ///< Location of iterator. ); @@ -216,6 +215,6 @@ */ psMetadataItem *psMetadataGetNext( - psMetadata *restrict md, ///< Metadata collection to iterate. - const char *restrict match, ///< Beginning of key name. + psMetadata *restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. int which ///< Iterator to be used. ); @@ -228,6 +227,6 @@ */ psMetadataItem *psMetadataGetPrevious( - psMetadata *restrict md, ///< Metadata collection to iterate. - const char *restrict match, ///< Beginning of key name. + psMetadata *restrict md, ///< Metadata collection to iterate. + const char *restrict match, ///< Beginning of key name. int which ///< Iterator to be used. ); @@ -244,6 +243,6 @@ */ void psMetadataItemPrint( - FILE *fd, ///< Pointer to file to write metadata item. - const char *format, ///< Format to print metadata item. + FILE *fd, ///< Pointer to file to write metadata item. + const char *format, ///< Format to print metadata item. const psMetadataItem *restrict metadataItem ///< Metadata item to print. ); @@ -256,7 +255,7 @@ */ psMetadata *psMetadataReadHeader( - psMetadata *output, ///< Resulting metadata from read. - const char *extname, ///< File name extension string. - int extnum, ///< File name extension number. + psMetadata *output, ///< Resulting metadata from read. + const char *extname, ///< File name extension string. + int extnum, ///< File name extension number. const char *filename ///< Name of file to read. ); @@ -269,7 +268,7 @@ */ psMetadata *psMetadataFReadHeader( - psMetadata *output, ///< Resulting metadata from read. - const char *extname, ///< File name extension string. - int extnum, ///< File name extension number. + psMetadata *output, ///< Resulting metadata from read. + const char *extname, ///< File name extension string. + int extnum, ///< File name extension number. fitsfile *fd ///< Pointer to file to read. );