cta_xml.h

Go to the documentation of this file.
00001 /*
00002 COSTA: Problem solving environment for data assimilation
00003 Copyright (C) 2005  Nils van Velzen
00004 
00005 This library is free software; you can redistribute it and/or
00006 modify it under the terms of the GNU Lesser General Public
00007 License as published by the Free Software Foundation; either
00008 version 2.1 of the License, or (at your option) any later version.
00009 
00010 This library is distributed in the hope that it will be useful,
00011 but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013 Lesser General Public License for more details.
00014 
00015 You should have received a copy of the GNU Lesser General Public
00016 License along with this library; if not, write to the Free Software
00017 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 */
00019 
00020 /**
00021 \file  cta_xml.h
00022 \brief Utilities for XML access: reading/writing of trees from/to a XML file.
00023 \note This is just a set of utility routines it does not define any COSTA component
00024 
00025 */
00026 
00027 #ifndef CTA_XML_H
00028 #define CTA_XML_H
00029 #include "cta_system.h"
00030 #include "cta_tree.h"
00031 #include "cta_string.h"
00032 
00033 /* tree functions */
00034 #ifdef __cplusplus
00035 extern "C" {
00036 #endif
00037 /** \brief Read a COSTA XML file into a new tree.
00038  *
00039  *  \param hfname  I  file name of XML file to read
00040  *  \param hroot   O  handle of a new COSTA tree
00041  *  \return CTA_OK if successful
00042  */
00043 CTAEXPORT int CTA_XML_Read(CTA_String hfname, CTA_Tree *hroot);
00044 
00045 
00046 /** \brief Write a tree to a COSTA XML file
00047  *
00048  *  \param hfname  I  file name of XML file to write
00049  *  \param hroot   I  handle of a COSTA tree
00050  *  \return CTA_OK if successful
00051  */
00052 CTAEXPORT int CTA_XML_Write(CTA_String hfname, CTA_Tree hroot);
00053 
00054 #ifdef __cplusplus
00055 }
00056 #endif
00057 #endif /* CTA_XML_H */

Generated on Mon Apr 6 14:05:58 2009 for COSTA by  doxygen 1.5.2