Changeset 1440 for trunk/psLib/src/collections/psMetadata.h
- Timestamp:
- Aug 9, 2004, 1:34:58 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
r1426 r1440 11 11 * @author Ross Harman, MHPCC 12 12 * 13 * @version $Revision: 1.1 7$ $Name: not supported by cvs2svn $14 * @date $Date: 2004-08-09 2 2:44:25$13 * @version $Revision: 1.18 $ $Name: not supported by cvs2svn $ 14 * @date $Date: 2004-08-09 23:34:57 $ 15 15 * 16 16 * Copyright 2004 Maui High Performance Computing Center, University of Hawaii … … 66 66 } data; ///< Union for data types. 67 67 char *comment; ///< Optional comment ("", not NULL). 68 psList *restrict items; ///< List of psMetadataItems with same name.68 psList* restrict items; ///< List of psMetadataItems with same name. 69 69 } 70 70 psMetadataItem; … … 78 78 typedef struct psMetadata 79 79 { 80 psList *restrict list;81 psHash *restrict table;80 psList* restrict list; 81 psHash* restrict table; 82 82 } 83 83 psMetadata; … … 100 100 * specified size and type. 101 101 * 102 * @return psMetadataItem* : Pointer metadata item.103 */ 104 psMetadataItem *psMetadataItemAlloc(const char *name, ///< Name of metadata item.102 * @return psMetadataItem* : Pointer metadata item. 103 */ 104 psMetadataItem* psMetadataItemAlloc(const char *name, ///< Name of metadata item. 105 105 psMetadataType type, ///< Type of metadata item. 106 106 const char *comment, ///< Comment for metadata item. … … 119 119 * specified size and type. 120 120 * 121 * @return psMetadataItem* : Pointer metadata item.122 */ 123 psMetadataItem *psMetadataItemAllocV(const char *name, ///< Name of metadata item.121 * @return psMetadataItem* : Pointer metadata item. 122 */ 123 psMetadataItem* psMetadataItemAllocV(const char *name, ///< Name of metadata item. 124 124 psMetadataType type, ///< Type of metadata item. 125 125 const char *comment, ///< Comment for metadata item. … … 132 132 * Returns an empty metadata container with fully allocated internal metadata containers. 133 133 * 134 * @return psMetadata* : Pointer metadata.135 */ 136 psMetadata *psMetadataAlloc(void ///< Void.134 * @return psMetadata* : Pointer metadata. 135 */ 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, ///< Metadata collection to insert metadat item.145 bool psMetadataAddItem(psMetadata* restrict md, ///< Metadata collection to insert metadat item. 146 146 int where, ///< Location to be added. 147 psMetadataItem * restrict item ///< Metadata item 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, ///< Metadata collection to insert metadat item.156 bool psMetadataAdd(psMetadata* restrict md, ///< Metadata collection to insert metadat item. 157 157 int where, ///< Location to be added. 158 158 const char *name, ///< Name of metadata item. … … 171 171 * @return bool: True for success, false for failure. 172 172 */ 173 bool psMetadataRemove(psMetadata * restrict md, ///< Metadata collection to insert metadat item.173 bool psMetadataRemove(psMetadata* restrict md, ///< Metadata collection to insert metadat item. 174 174 int where, ///< Location to be removed. 175 175 const char *restrict key ///< Name of metadata key. … … 181 181 * returned. If the item is not found, null is returned. 182 182 * 183 * @return psMetadataItem* : Pointer metadata item.184 */ 185 psMetadataItem *psMetadataLookup(psMetadata* restrict md, ///< Metadata collection to insert metadat183 * @return psMetadataItem* : Pointer metadata item. 184 */ 185 psMetadataItem* psMetadataLookup(psMetadata* restrict md, ///< Metadata collection to insert metadat 186 186 // item. 187 187 const char *restrict key ///< Name of metadata key. … … 192 192 * Items may be found in the metadata by their entry position in the list container. 193 193 * 194 * @return psMetadataItem* : Pointer metadata item.195 */ 196 psMetadataItem *psMetadataGet(psMetadata* restrict md, ///< Metadata collection to insert metadat item.194 * @return psMetadataItem* : Pointer metadata item. 195 */ 196 psMetadataItem* psMetadataGet(psMetadata* restrict md, ///< Metadata collection to insert metadat item. 197 197 int where ///< Location to be retrieved. 198 198 ); … … 204 204 * @return void: void. 205 205 */ 206 bool psMetadataSetIterator(psMetadata * restrict md, ///< Metadata collection to iterate.206 bool psMetadataSetIterator(psMetadata* restrict md, ///< Metadata collection to iterate. 207 207 int where ///< Location of iterator. 208 208 ); … … 212 212 * Get next metadata item in iterator list. 213 213 * 214 * @return psMetadataItem* : Pointer metadata item.215 */ 216 psMetadataItem *psMetadataGetNext(psMetadata* restrict md, ///< Metadata collection to iterate.214 * @return psMetadataItem* : Pointer metadata item. 215 */ 216 psMetadataItem* psMetadataGetNext(psMetadata* restrict md, ///< Metadata collection to iterate. 217 217 const char *restrict match, ///< Beginning of key name. 218 218 int which ///< Iterator to be used. … … 223 223 * Get previous metadata item in iterator list. 224 224 * 225 * @return psMetadataItem* : Pointer metadata item.226 */ 227 psMetadataItem *psMetadataGetPrevious(psMetadata* restrict md, ///< Metadata collection to iterate.225 * @return psMetadataItem* : Pointer metadata item. 226 */ 227 psMetadataItem* psMetadataGetPrevious(psMetadata* restrict md, ///< Metadata collection to iterate. 228 228 const char *restrict match, ///< Beginning of key name. 229 229 int which ///< Iterator to be used. … … 238 238 * metadata type is any other data type, printing is not allowed. 239 239 * 240 * @return psMetadataItem* : Pointer metadata item.240 * @return psMetadataItem* : Pointer metadata item. 241 241 */ 242 242 void psMetadataItemPrint(FILE * fd, ///< Pointer to file to write metadata item. 243 243 const char *format, ///< Format to print metadata item. 244 const psMetadataItem * restrict metadataItem ///< Metadata item to print.244 const psMetadataItem* restrict metadataItem ///< Metadata item to print. 245 245 ); 246 246 … … 250 250 * unimplemented. 251 251 * 252 * @return psMetadata* : Pointer metadata.253 */ 254 psMetadata *psMetadataReadHeader(psMetadata* output, ///< Resulting metadata from read.252 * @return psMetadata* : Pointer metadata. 253 */ 254 psMetadata* psMetadataReadHeader(psMetadata* output, ///< Resulting metadata from read. 255 255 char *extname, ///< File name extension string. 256 256 int extnum, ///< File name extension number. Starts at 1. … … 262 262 * Read a metadata header from file. If the file is not found, an error is reported. 263 263 * 264 * @return psMetadata* : Pointer metadata.265 */ 266 psMetadata *psMetadataFReadHeader(psMetadata* output, ///< Resulting metadata from read.264 * @return psMetadata* : Pointer metadata. 265 */ 266 psMetadata* psMetadataFReadHeader(psMetadata* output, ///< Resulting metadata from read. 267 267 char *extName, ///< File name extension string. 268 268 int extNum, ///< File name extension number.
Note:
See TracChangeset
for help on using the changeset viewer.
