Changeset 2648 for trunk/psLib/src/collections/psMetadata.h

Timestamp:

Dec 7, 2004, 9:09:18 AM (22 years ago)

Author:

harman

Message:

Added new functions in SDRS 10

File:

• trunk/psLib/src/collections/psMetadata.h (modified) (10 diffs)

trunk/psLib/src/collections/psMetadata.h

@@ -11 +11 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.27 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2004-12-03 23:14:34 $
+*  @version $Revision: 1.28 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2004-12-07 19:08:58 $
 *
 *  Copyright 2004 Maui High Performance Computing Center, University of Hawaii
@@ -56 +56 @@
 typedef struct psMetadata
 {
-    psList* restrict list;             ///< the metadata in linked-list
-    psHash* restrict table;            ///< the metadata in a hash table
+    psList*  list;                     ///< Metadata in linked-list
+    psHash*  table;                    ///< Metadata in a hash table
 }
 psMetadata;
@@ -148 +148 @@
  */
 psBool psMetadataAddItem(
-    psMetadata* restrict md,           ///< Metadata collection to insert metadat item.
-    psMetadataItem* restrict item,     ///< Metadata item to be added.
-    psS32 location                     ///< Location to be added.
+    psMetadata*  md,          ///< Metadata collection to insert metadat item.
+    psMetadataItem*  item,    ///< Metadata item to be added.
+    psS32 location            ///< Location to be added.
 );
 
@@ -160 +160 @@
  */
 psBool psMetadataAdd(
-    psMetadata* restrict md,           ///< Metadata collection to insert metadat item.
-    psS32 where,                       ///< Location to be added.
-    const char *name,                  ///< Name of metadata item.
-    psElemType pType,                  ///< Primitive type.
-    psMetadataType type,               ///< Type of metadata item.
-    const char *comment,               ///< Comment for metadata item.
-    ...                                ///< Arguments for name formatting and metadata item data.
+    psMetadata* md,           ///< Metadata collection to insert metadat item.
+    psS32 where,              ///< Location to be added.
+    const char *name,         ///< Name of metadata item.
+    psElemType pType,         ///< Primitive type.
+    psMetadataType type,      ///< Type of metadata item.
+    const char *comment,      ///< Comment for metadata item.
+    ...                       ///< Arguments for name formatting and metadata item data.
 );
 
@@ -180 +180 @@
  */
 psBool psMetadataRemove(
-    psMetadata* restrict md,           ///< Metadata collection to insert metadat item.
-    psS32 where,                       ///< Location to be removed.
-    const char *restrict key           ///< Name of metadata key.
+    psMetadata*  md,           ///< Metadata collection to remove metadata item.
+    psS32 where,               ///< Location to be removed.
+    const char * key           ///< Name of metadata key.
 );
 
@@ -194 +194 @@
  */
 psMetadataItem* psMetadataLookup(
-    psMetadata* restrict md,           ///< Metadata collection to insert metadata item.
-    const char *restrict key           ///< Name of metadata key.
+    psMetadata * md,           ///< Metadata collection to lookup metadata item.
+    const char * key           ///< Name of metadata key.
+);
+
+/** Find an item in the metadata collection based on key name and return its double precision value.
+ *
+ *  Items may be found in the metadata by providing a key. If the key is
+ *  non-unique, the value of the first item is returned. If the item is not found, zero is
+ *  returned.
+ *
+ * @return psF64 : Value of metadata item.
+ */
+psF64 psMetadataLookupF64(
+    psMetadata *md,            ///< Metadata collection to lookup metadata item.
+    const char *key            ///< Name of metadata key.
+);
+
+/** Find an item in the metadata collection based on key name and return its integer value.
+ *
+ *  Items may be found in the metadata by providing a key. If the key is
+ *  non-unique, the value of the first item is returned. If the item is not found, zero is
+ *  returned.
+ *
+ * @return psS32 : Value of metadata item.
+ */
+psS32 psMetadataLookupS32(
+    psMetadata *md,            ///< Metadata collection to lookup metadata item.
+    const char *key            ///< Name of metadata key.
+);
+
+/** Find an item in the metadata collection based on key name and return its integer value.
+ *
+ *  Items may be found in the metadata by providing a key. If the key is
+ *  non-unique, the value of the first item is returned. If the item is not found, zero is
+ *  returned.
+ *
+ * @return void* : Value of metadata item.
+ */
+void* psMetadataLookupPtr(
+    psMetadata* md,            ///< Metadata collection to lookup metadata item.
+    const char *key            ///< Name of metadata key.
 );
 
@@ -206 +245 @@
  */
 psMetadataItem* psMetadataGet(
-    psMetadata* restrict md,           ///< Metadata collection to insert metadat item.
-    psS32 where                        ///< Location to be retrieved.
+    psMetadata*  md,           ///< Metadata collection to insert metadat item.
+    psS32 where                ///< Location to be retrieved.
 );
 
@@ -218 +257 @@
  */
 psBool psMetadataSetIterator(
-    psMetadata* restrict md,           ///< Metadata collection to iterate.
-    psS32 where                        ///< Location of iterator.
+    psMetadata*  md,           ///< Metadata collection to iterate.
+    psS32 where                ///< Location of iterator.
 );
 
@@ -229 +268 @@
  */
 psMetadataItem* psMetadataGetNext(
-    psMetadata* restrict md,           ///< Metadata collection to iterate.
-    const char *restrict match,        ///< Beginning of key name.
-    psS32 which                        ///< Iterator to be used.
+    psMetadata*  md,           ///< Metadata collection to iterate.
+    const char * match,        ///< Beginning of key name.
+    psS32 which                ///< Iterator to be used.
 );
 
@@ -241 +280 @@
  */
 psMetadataItem* psMetadataGetPrevious(
-    psMetadata* restrict md,           ///< Metadata collection to iterate.
-    const char *restrict match,        ///< Beginning of key name.
-    psS32 which                        ///< Iterator to be used.
+    psMetadata *md,            ///< Metadata collection to iterate.
+    const char *match,         ///< Beginning of key name.
+    psS32 which                ///< Iterator to be used.
 );