Index: trunk/psLib/src/collections/psMetadata.h =================================================================== --- trunk/psLib/src/collections/psMetadata.h (revision 1335) +++ trunk/psLib/src/collections/psMetadata.h (revision 1351) @@ -1,18 +1,18 @@ /** @file psMetadata.h - * - * @brief Contains metadata struuctures, enumerations and functions prototypes - * - * This file defines metadata item, metadata type, metadata flags, metadata containers, and function - * prototypes necessary creating psLib metadata APIs - * - * @ingroup Metadata - * - * @author Ross Harman, MHPCC - * - * @version $Revision: 1.5 $ $Name: not supported by cvs2svn $ - * @date $Date: 2004-07-29 20:16:34 $ - * - * Copyright 2004 Maui High Performance Computing Center, University of Hawaii - */ +* +* @brief Contains metadata struuctures, enumerations and functions prototypes +* +* This file defines metadata item, metadata type, metadata flags, metadata containers, and function +* prototypes necessary creating psLib metadata APIs +* +* @ingroup Metadata +* +* @author Ross Harman, MHPCC +* +* @version $Revision: 1.6 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-07-30 19:37:07 $ +* +* Copyright 2004 Maui High Performance Computing Center, University of Hawaii +*/ #ifndef PS_METADATA_H #define PS_METADATA_H @@ -30,14 +30,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; @@ -49,18 +49,18 @@ */ typedef struct psMetadataItem -{ - const int id; ///< Unique ID for metadata item. - char *restrict name; ///< Name of metadata item. - psMetadataType type; ///< Type of metadata item. - union { - psS32 S32; ///< Signed 32-bit integer data. - psF32 F32; ///< Single-precision float data. - psF64 F64; ///< Double-precision float data. - psPTR V; ///< Pointer to other type of data. - }data; ///< Union for data types. - char *comment; ///< Optional comment ("", not NULL). - psList *restrict items; ///< List of psMetadataItems with same name. -} + const int id; ///< Unique ID for metadata item. + char *restrict name; ///< Name of metadata item. + psMetadataType type; ///< Type of metadata item. + union + { + psS32 S32; ///< Signed 32-bit integer data. + psF32 F32; ///< Single-precision float data. + psF64 F64; ///< Double-precision float data. + psPTR V; ///< Pointer to other type of data. + }data; ///< Union for data types. + char *comment; ///< Optional comment ("", not NULL). + psList *restrict items; ///< List of psMetadataItems with same name. + } psMetadataItem; @@ -72,8 +72,8 @@ */ typedef struct psMetadata -{ - psList *restrict list; - psHash *restrict table; -} + { + psList *restrict list; + psHash *restrict table; + } psMetadata; @@ -97,7 +97,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 +117,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 +140,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 +152,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 +170,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 +183,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 +194,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 +205,5 @@ */ bool psMetadataSetIterator( - psMetadata *restrict md, ///< Metadata collection to iterate. + psMetadata *restrict md, ///< Metadata collection to iterate. int where ///< Location of iterator. ); @@ -216,6 +216,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 +228,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,7 +244,7 @@ */ void psMetadataItemPrint( - FILE *fd, ///< Pointer to file to write metadata item. - const char *format, ///< Format to print metadata item. - const psMetadataItem *restrict md ///< Metadata item to print. + 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 +256,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,8 +269,8 @@ */ psMetadata *psMetadataFReadHeader( - psMetadata *output, ///< Resulting metadata from read. - const char *extname, ///< File name extension string. - int extnum, ///< File name extension number. - FILE *fd ///< Pointer to file to read. + 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. ); /// @}