Changeset 11724

Timestamp:

Feb 8, 2007, 3:26:00 PM (19 years ago)

Author:

Paul Price

Message:

Renaming psMetadataItemTransfer to psMetadataItemSupplement

Location:

trunk/psLib/src/types

Files:

• psMetadata.c (modified) (2 diffs)
• psMetadata.h (modified) (2 diffs)

trunk/psLib/src/types/psMetadata.c

@@ -12 +12 @@
  *  @author Ross Harman, MHPCC
  *
- *  @version $Revision: 1.151 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2007-02-08 21:17:02 $
+ *  @version $Revision: 1.152 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2007-02-09 01:26:00 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -492 +492 @@
 
 // may need to extend this to change the keyname in the copy
-bool psMetadataItemTransfer(psMetadata *out,
-                            const psMetadata *in,
-                            const char *key)
-{
-    if (in == NULL) {
-        psError(PS_ERR_BAD_PARAMETER_NULL, true,
-                "psMetadataItemTransfer:  'in' cannot be NULL.\n");
-        return false;
-    }
-    if (out == NULL) {
-        psError(PS_ERR_BAD_PARAMETER_NULL, true,
-                "psMetadataItemTransfer:  'out' cannot be NULL.\n");
-        return false;
-    }
-    if (key == NULL) {
-        psError(PS_ERR_BAD_PARAMETER_NULL, true,
-                "psMetadataItemTransfer:  'key' cannot be NULL.\n");
-        return false;
-    }
+bool psMetadataItemSupplement(psMetadata *out,
+                              const psMetadata *in,
+                              const char *key)
+{
+    PS_ASSERT_METADATA_NON_NULL(in, false);
+    PS_ASSERT_METADATA_NON_NULL(out, false);
+    PS_ASSERT_STRING_NON_EMPTY(key, false);
 
     psMetadataItem *item = psMetadataLookup(in, key);
     if (!item) {
-        psError(PS_ERR_BAD_PARAMETER_VALUE, true,
-                "psMetadataItemTransfer:  Could not find 'key' in psMetadata 'in'.\n");
+        psError(PS_ERR_BAD_PARAMETER_VALUE, true, "Could not find '%s' in metadata.\n", key);
         return false;
     }
     if (!psMetadataAddItem(out, item, PS_LIST_TAIL, PS_META_REPLACE) ) {
-        psError(PS_ERR_BAD_PARAMETER_VALUE, true,
-                "psMetadataItemTransfer:  Could not add item to psMetadata 'out'.\n");
+        psError(PS_ERR_BAD_PARAMETER_VALUE, true, "Could not add %s to metadata.\n", key);
         return false;
     }

trunk/psLib/src/types/psMetadata.h

@@ -9 +9 @@
 *  @author Ross Harman, MHPCC
 *
-*  @version $Revision: 1.97 $ $Name: not supported by cvs2svn $
-*  @date $Date: 2007-02-08 21:17:02 $
+*  @version $Revision: 1.98 $ $Name: not supported by cvs2svn $
+*  @date $Date: 2007-02-09 01:26:00 $
 *
 *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
@@ -480 +480 @@
 
 
-/** Copy a metadata item from one psMetadata to another.
- *
- *  Creates a copy of a psMetadataItem from in and appends it to out.  If out
- *  is NULL, a new container is created.
+/** Supplements a metadata with an item from another metadata.
+ *
+ *  Supplements the output metadata with the metadata item of the specified name from the input metadata.  If
+ *  out is NULL, a new container is created.
  *
  *  @return bool:       True if successful, otherwise false.
  */
-bool psMetadataItemTransfer(
+bool psMetadataItemSupplement(
     psMetadata *out,                   ///< output Metadata container for copying.
     const psMetadata *in,              ///< Metadata collection from which to copy.