Changeset 4540 for trunk/psLib/src/xml/psXML.h

Timestamp:

Jul 12, 2005, 9:12:01 AM (21 years ago)

Author:

desonia

Message:

massive restructuring of codebase.

File:

• trunk/psLib/src/xml/psXML.h (modified) (2 diffs)

trunk/psLib/src/xml/psXML.h

@@ -1 @@
-/** @file  psMetadataIO.h
+/** @file  psXML.h
  *
- *  @brief Contains metadata input/output functions.
+ *  @brief Contains XML functions.
  *
- *  This file defines functions to read and write metadata to/from an external file.
+ *  This file defines functions to read metadata from an XML file.
  *
- *  @ingroup Metadata
+ *  @ingroup XML
  *
  *  @author Ross Harman, MHPCC
  *  @author Robert DeSonia, MHPCC
  *
- *  @version $Revision: 1.15 $ $Name: not supported by cvs2svn $
- *  @date $Date: 2005-06-28 20:17:52 $
+ *  @version $Revision: 1.16 $ $Name: not supported by cvs2svn $
+ *  @date $Date: 2005-07-12 19:12:01 $
  *
  *  Copyright 2004-2005 Maui High Performance Computing Center, University of Hawaii
  */
-#ifndef PS_METADATAIO_H
-#define PS_METADATAIO_H
+#ifndef PS_XML_H
+#define PS_XML_H
 
-/// @addtogroup Metadata
+#include "psMetadata.h"
+#include "psMetadataConfig.h"
+
+/// @addtogroup XML
 /// @{
-
-/** A metadata data structure used in parsing arrays.
- *  
- *  Contains array information and the metadata storage location.
-*/
-typedef struct
-{
-    psArray*    nonUniqueKeyArray;     ///< non-unique key names
-    psArray*    typeArray;             ///< array of user defined types
-    psArray*    templateArray;         ///< array of user type templates
-    psMetadata* metadata;              ///< metadata container
-    char*       name;                  ///< name of key
-}
-p_psParseLevelInfo;
-
-/** Allocates a p_psParseLevelInfo structure
- *   
- *  @return p_psParseLevelInfo* :   new p_psParseLevelInfo struct
- */
-p_psParseLevelInfo* p_psParseLevelInfoAlloc(void);
-
-/** Print metadata item to file.
- *
- *  Metadata items may be printed to an open file descriptor based on a
- *  provided format. The format is a sprintf format statement with exactly
- *  one % formatting command. If the metadata item type is a numeric type,
- *  this formatting command must also be numeric, and the type conversion
- *  performed to the value to match the format type. If the metadata type is
- *  a string, the fromatting command must also be for a string. If the
- *  metadata type is any other data type, printing is not allowed.
- *
- * @return psMetadataItem* : Pointer metadata item.
- */
-bool psMetadataItemPrint(
-    FILE * fd,                         ///< Pointer to file to write metadata item.
-    const char *format,                ///< Format to print metadata item.
-    const psMetadataItem* item         ///< Metadata item to print.
-);
-
-/** Read metadata header.
- *
- *  Read a metadata header from file. If the file is not found, an error is
- *  reported.
- *
- *  @return psMetadata* : Pointer to resulting metadata.
- */
-psMetadata* psMetadataReadHeader(
-    psMetadata* output,                ///< Resulting metadata from read.
-    char *extName,                     ///< File name extension string.
-    psS32 extNum,                      ///< File name extension number. Starts at 1.
-    char *fileName                     ///< Name of file to read.
-);
-
-/** Read metadata configuration file.
- *
- *  Loads pre-defined settings by parsing a configuration file into a psMetadata structure.
- *
- *  @return psMetadata* : Resulting metadata from read.
- */
-psMetadata* psMetadataConfigParse(
-    psMetadata* md,                    ///< Resulting metadata from read.
-    unsigned int *nFail,               ///< Number of failed lines.
-    const char *fileName,              ///< Name of file to read.
-    bool overwrite                     ///< Allow overwrite of duplicate specifications.
-);
-
-/** Read XML metadata configuration file.
- *
- *  Loads pre-defined XML settings by parsing a configuration file into a psMetadata structure.
- *
- *  @return psMetadata* : Resulting metadata from read.
- */
 
 psMetadata*  psMetadataConfigParseXml(
@@ -102 +33 @@
 /// @}
 
-#endif // #ifndef PS_METADATAIO_H
+#endif // #ifndef PS_XML_H