Index: trunk/psLib/src/collections/psMetadata.h =================================================================== --- trunk/psLib/src/collections/psMetadata.h (revision 1394) +++ trunk/psLib/src/collections/psMetadata.h (revision 1407) @@ -1,2 +1,3 @@ + /** @file psMetadata.h * @@ -10,18 +11,18 @@ * @author Ross Harman, MHPCC * -* @version $Revision: 1.15 $ $Name: not supported by cvs2svn $ -* @date $Date: 2004-08-05 20:55:22 $ +* @version $Revision: 1.16 $ $Name: not supported by cvs2svn $ +* @date $Date: 2004-08-07 00:06:06 $ * * Copyright 2004 Maui High Performance Computing Center, University of Hawaii */ #ifndef PS_METADATA_H -#define PS_METADATA_H - -#include -#include -#include - -#include "psHash.h" -#include "psList.h" +# define PS_METADATA_H + +# include +# include +# include + +# include "psHash.h" +# include "psList.h" /// @addtogroup Metadata @@ -33,16 +34,16 @@ */ typedef enum { - PS_META_ITEM_SET = 0, ///< Null. Metadata is in psMetadataItem.items - PS_META_BOOL, ///< Boolean data. - 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. + PS_META_ITEM_SET = 0, // /< Null. Metadata is in psMetadataItem.items + PS_META_BOOL, // /< Boolean data. + 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; @@ -54,17 +55,16 @@ 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 - { + const int id; // /< Unique ID for metadata item. + char *restrict name; // /< Name of metadata item. + psMetadataType type; // /< Type of metadata item. + union { bool B; - 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. + 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; @@ -78,12 +78,13 @@ typedef struct psMetadata { - psList* restrict list; - psHash* restrict table; + psList *restrict list; + psHash *restrict table; } psMetadata; - /*****************************************************************************/ + /* FUNCTION PROTOTYPES */ + /*****************************************************************************/ @@ -101,10 +102,9 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAlloc( - 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. -); +psMetadataItem *psMetadataItemAlloc(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. + ); /** Create a metadata item with va_list. @@ -121,10 +121,10 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataItemAllocV( - 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. -); +psMetadataItem *psMetadataItemAllocV(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. + ); /** Create a metadata collection. @@ -134,7 +134,6 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataAlloc( - void ///< Void. -); +psMetadata *psMetadataAlloc(void // /< Void. + ); /** Add existing metadata item to metadata collection. @@ -144,9 +143,8 @@ * @return bool: True for success, false for failure. */ -bool psMetadataAddItem( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where, ///< Location to be added. - psMetadataItem *restrict item ///< Metadata item to be added. -); +bool psMetadataAddItem(psMetadata * restrict md, // /< Metadata collection to insert metadat item. + int where, // /< Location to be added. + psMetadataItem * restrict item // /< Metadata item to be added. + ); /** Create and add a metadata item to metadata collection. @@ -156,12 +154,11 @@ * @return bool: True for success, false for failure. */ -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. - ... ///< Arguments for name formatting and metadata item data. -); +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. + ... // /< Arguments for name formatting and metadata item data. + ); /** Remove an item from metadata collection. @@ -174,9 +171,8 @@ * @return bool: True for success, false for failure. */ -bool psMetadataRemove( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where, ///< Location to be removed. - const char *restrict key ///< Name of metadata key. -); +bool psMetadataRemove(psMetadata * restrict md, // /< Metadata collection to insert metadat item. + int where, // /< Location to be removed. + const char *restrict key // /< Name of metadata key. + ); /** Find an item in the metadata collection based on key name. @@ -187,8 +183,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataLookup( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - const char *restrict key ///< Name of metadata key. -); +psMetadataItem *psMetadataLookup(psMetadata * restrict md, // /< Metadata collection to insert metadat + // item. + const char *restrict key // /< Name of metadata key. + ); /** Find an item in the metadata collection based on list index. @@ -198,8 +194,7 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGet( - psMetadata *restrict md, ///< Metadata collection to insert metadat item. - int where ///< Location to be retrieved. -); +psMetadataItem *psMetadataGet(psMetadata * restrict md, // /< Metadata collection to insert metadat item. + int where // /< Location to be retrieved. + ); /** Set or reset metadata iterator. @@ -209,8 +204,7 @@ * @return void: void. */ -bool psMetadataSetIterator( - psMetadata *restrict md, ///< Metadata collection to iterate. - int where ///< Location of iterator. -); +bool psMetadataSetIterator(psMetadata * restrict md, // /< Metadata collection to iterate. + int where // /< Location of iterator. + ); /** Get next metadata item. @@ -220,9 +214,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetNext( - psMetadata *restrict md, ///< Metadata collection to iterate. - const char *restrict match, ///< Beginning of key name. - int which ///< Iterator to be used. -); +psMetadataItem *psMetadataGetNext(psMetadata * restrict md, // /< Metadata collection to iterate. + const char *restrict match, // /< Beginning of key name. + int which // /< Iterator to be used. + ); /** Get previous metadata item. @@ -232,9 +225,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -psMetadataItem *psMetadataGetPrevious( - psMetadata *restrict md, ///< Metadata collection to iterate. - const char *restrict match, ///< Beginning of key name. - int which ///< Iterator to be used. -); +psMetadataItem *psMetadataGetPrevious(psMetadata * restrict md, // /< Metadata collection to iterate. + const char *restrict match, // /< Beginning of key name. + int which // /< Iterator to be used. + ); /** Print metadata item to file. @@ -248,9 +240,8 @@ * @return psMetadataItem*: Pointer metadata item. */ -void psMetadataItemPrint( - 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. -); +void psMetadataItemPrint(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. + ); /** Read metadata header. @@ -261,10 +252,9 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataReadHeader( - psMetadata *output, ///< Resulting metadata from read. - char *extname, ///< File name extension string. - int extnum, ///< File name extension number. Starts at 1. - char *filename ///< Name of file to read. -); +psMetadata *psMetadataReadHeader(psMetadata * output, // /< Resulting metadata from read. + char *extname, // /< File name extension string. + int extnum, // /< File name extension number. Starts at 1. + char *filename // /< Name of file to read. + ); /** Read metadata header. @@ -274,10 +264,10 @@ * @return psMetadata*: Pointer metadata. */ -psMetadata *psMetadataFReadHeader( - psMetadata *output, ///< Resulting metadata from read. - char *extName, ///< File name extension string. - int extNum, ///< File name extension number. - fitsfile *fd ///< Pointer to file to read. -); +psMetadata *psMetadataFReadHeader(psMetadata * output, // /< Resulting metadata from read. + char *extName, // /< File name extension string. + int extNum, // /< File name extension number. + fitsfile * fd // /< Pointer to file to read. + ); + /// @}