m_xml.h File Reference

Workspace methods and template functions for supergeneric XML IO. More...

#include "exceptions.h"
#include "xml_io.h"
#include "workspace_ng.h"
#include "agenda_class.h"

Include dependency graph for m_xml.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

template<typename T>
void ReadXML (T &v, const String &v_name, const String &f, const String &f_name)
 WORKSPACE METHOD: ReadXML.
void ReadXML (Workspace &ws, Agenda &v, const String &v_name, const String &f, const String &f_name)
template<typename T>
void WriteXML (const String &file_format, const T &v, const String &f, const String &v_name, const String &f_name)
 WORKSPACE METHOD: WriteXML.
void WriteXML (Workspace &ws, const String &file_format, const Agenda &v, const String &f, const String &v_name, const String &f_name)
template<typename T>
void WriteXMLIndexed (const String &file_format, const Index &file_index, const T &v, const String &f, const String &v_name, const String &f_name)
 WORKSPACE METHOD: WriteXMLIndexed.
void WriteXMLIndexed (Workspace &ws, const String &file_format, const Index &file_index, const Agenda &v, const String &f, const String &v_name, const String &f_name)
void output_file_formatSetAscii (String &file_format)
 WORKSPACE METHOD: output_file_formatSetAscii.
void output_file_formatSetZippedAscii (String &file_format)
 WORKSPACE METHOD: output_file_formatSetZippedAscii.
void output_file_formatSetBinary (String &file_format)
 WORKSPACE METHOD: output_file_formatSetBinary.

Detailed Description

Workspace methods and template functions for supergeneric XML IO.

Author:
Stefan Buehler <sbuehler@ltu.se>
Date:
2002-06-18

Definition in file m_xml.h.

Function Documentation

void output_file_formatSetAscii ( String &  output_file_format  ) 

WORKSPACE METHOD: output_file_formatSetAscii.

Sets the output file format to ASCII.

Author:
Oliver Lemke
Parameters:
[out] output_file_format WS Output

Definition at line 162 of file m_xml.h.

Referenced by output_file_formatSetAscii_g().

void output_file_formatSetBinary ( String &  output_file_format  ) 

WORKSPACE METHOD: output_file_formatSetBinary.

Sets the output file format to binary.

Author:
Oliver Lemke
Parameters:
[out] output_file_format WS Output

Definition at line 180 of file m_xml.h.

Referenced by output_file_formatSetBinary_g().

void output_file_formatSetZippedAscii ( String &  output_file_format  ) 

WORKSPACE METHOD: output_file_formatSetZippedAscii.

Sets the output file format to zipped ASCII.

Author:
Oliver Lemke
Parameters:
[out] output_file_format WS Output

Definition at line 171 of file m_xml.h.

Referenced by output_file_formatSetZippedAscii_g().

void ReadXML ( Workspace &  ws,
Agenda &  v,
const String &  v_name,
const String &  f,
const String &  f_name 
)

Definition at line 57 of file m_xml.h.

References ReadXML().

template<typename T>
void ReadXML ( T &  gout1,
const String &  gout1_wsvname,
const String &  filename,
const String &  filename_wsvname 
) [inline]

WORKSPACE METHOD: ReadXML.

Reads a workspace variable from an XML file.

This is a supergeneric method. It can read variables of any group.

If the filename is omitted, the variable is read from <basename>.<variable_name>.xml.

Author:
Oliver Lemke
Parameters:
[out] gout1 Supergeneric output
[in] gout1_wsvname Generic Output Name
[in] filename Generic Input
[in] filename_wsvname Generic Input Name

Definition at line 37 of file m_xml.h.

References filename_xml(), and xml_read_from_file().

Referenced by ReadXML(), ReadXML_sg_Agenda_g(), ReadXML_sg_ArrayOfArrayOfArrayOfArrayOfGridPos_g(), ReadXML_sg_ArrayOfArrayOfGField1_g(), ReadXML_sg_ArrayOfArrayOfGField3_g(), ReadXML_sg_ArrayOfArrayOfIndex_g(), ReadXML_sg_ArrayOfArrayOfLineRecord_g(), ReadXML_sg_ArrayOfArrayOfMatrix_g(), ReadXML_sg_ArrayOfArrayOfSpeciesTag_g(), ReadXML_sg_ArrayOfArrayOfTensor3_g(), ReadXML_sg_ArrayOfArrayOfTensor6_g(), ReadXML_sg_ArrayOfGField1_g(), ReadXML_sg_ArrayOfGField2_g(), ReadXML_sg_ArrayOfGField3_g(), ReadXML_sg_ArrayOfGField4_g(), ReadXML_sg_ArrayOfIndex_g(), ReadXML_sg_ArrayOfLineRecord_g(), ReadXML_sg_ArrayOfLineshapeSpec_g(), ReadXML_sg_ArrayOfMatrix_g(), ReadXML_sg_ArrayOfPpath_g(), ReadXML_sg_ArrayOfRetrievalQuantity_g(), ReadXML_sg_ArrayOfSingleScatteringData_g(), ReadXML_sg_ArrayOfString_g(), ReadXML_sg_ArrayOfTensor3_g(), ReadXML_sg_ArrayOfTensor4_g(), ReadXML_sg_ArrayOfTensor6_g(), ReadXML_sg_ArrayOfTensor7_g(), ReadXML_sg_ArrayOfVector_g(), ReadXML_sg_GasAbsLookup_g(), ReadXML_sg_GField1_g(), ReadXML_sg_GField2_g(), ReadXML_sg_GField3_g(), ReadXML_sg_GField4_g(), ReadXML_sg_GridPos_g(), ReadXML_sg_Index_g(), ReadXML_sg_Matrix_g(), ReadXML_sg_MCAntenna_g(), ReadXML_sg_Numeric_g(), ReadXML_sg_Ppath_g(), ReadXML_sg_SingleScatteringData_g(), ReadXML_sg_SLIData2_g(), ReadXML_sg_Sparse_g(), ReadXML_sg_String_g(), ReadXML_sg_Tensor3_g(), ReadXML_sg_Tensor4_g(), ReadXML_sg_Tensor5_g(), ReadXML_sg_Tensor6_g(), ReadXML_sg_Tensor7_g(), ReadXML_sg_Timer_g(), and ReadXML_sg_Vector_g().

void WriteXML ( Workspace &  ws,
const String &  file_format,
const Agenda &  v,
const String &  f,
const String &  v_name,
const String &  f_name 
)

Definition at line 108 of file m_xml.h.

References WriteXML().

template<typename T>
void WriteXML ( const String &  output_file_format,
const T &  gin1,
const String &  filename,
const String &  gin1_wsvname,
const String &  filename_wsvname 
) [inline]

WORKSPACE METHOD: WriteXML.

Writes a workspace variable to an XML file.

This is a supergeneric method. It can write variables of any group.

If the filename is omitted, the variable is written to <basename>.<variable_name>.xml.

Author:
Oliver Lemke
Parameters:
[in] output_file_format WS Input
[in] gin1 Generic Input
[in] filename Generic Input (Default: "")
[in] gin1_wsvname Generic Input Name
[in] filename_wsvname Generic Input Name

Definition at line 73 of file m_xml.h.

References FILE_TYPE_ASCII, FILE_TYPE_BINARY, FILE_TYPE_ZIPPED_ASCII, filename_xml(), and xml_write_to_file().

Referenced by Cloudbox_ppathCalc(), WriteXML(), WriteXML_sg_Agenda_g(), WriteXML_sg_ArrayOfArrayOfArrayOfArrayOfGridPos_g(), WriteXML_sg_ArrayOfArrayOfGField1_g(), WriteXML_sg_ArrayOfArrayOfGField3_g(), WriteXML_sg_ArrayOfArrayOfIndex_g(), WriteXML_sg_ArrayOfArrayOfLineRecord_g(), WriteXML_sg_ArrayOfArrayOfMatrix_g(), WriteXML_sg_ArrayOfArrayOfSpeciesTag_g(), WriteXML_sg_ArrayOfArrayOfTensor3_g(), WriteXML_sg_ArrayOfArrayOfTensor6_g(), WriteXML_sg_ArrayOfGField1_g(), WriteXML_sg_ArrayOfGField2_g(), WriteXML_sg_ArrayOfGField3_g(), WriteXML_sg_ArrayOfGField4_g(), WriteXML_sg_ArrayOfIndex_g(), WriteXML_sg_ArrayOfLineRecord_g(), WriteXML_sg_ArrayOfLineshapeSpec_g(), WriteXML_sg_ArrayOfMatrix_g(), WriteXML_sg_ArrayOfPpath_g(), WriteXML_sg_ArrayOfRetrievalQuantity_g(), WriteXML_sg_ArrayOfSingleScatteringData_g(), WriteXML_sg_ArrayOfString_g(), WriteXML_sg_ArrayOfTensor3_g(), WriteXML_sg_ArrayOfTensor4_g(), WriteXML_sg_ArrayOfTensor6_g(), WriteXML_sg_ArrayOfTensor7_g(), WriteXML_sg_ArrayOfVector_g(), WriteXML_sg_GasAbsLookup_g(), WriteXML_sg_GField1_g(), WriteXML_sg_GField2_g(), WriteXML_sg_GField3_g(), WriteXML_sg_GField4_g(), WriteXML_sg_GridPos_g(), WriteXML_sg_Index_g(), WriteXML_sg_Matrix_g(), WriteXML_sg_MCAntenna_g(), WriteXML_sg_Numeric_g(), WriteXML_sg_Ppath_g(), WriteXML_sg_SingleScatteringData_g(), WriteXML_sg_SLIData2_g(), WriteXML_sg_Sparse_g(), WriteXML_sg_String_g(), WriteXML_sg_Tensor3_g(), WriteXML_sg_Tensor4_g(), WriteXML_sg_Tensor5_g(), WriteXML_sg_Tensor6_g(), WriteXML_sg_Tensor7_g(), WriteXML_sg_Timer_g(), WriteXML_sg_Vector_g(), and WriteXMLIndexed().

void WriteXMLIndexed ( Workspace &  ws,
const String &  file_format,
const Index &  file_index,
const Agenda &  v,
const String &  f,
const String &  v_name,
const String &  f_name 
)

Definition at line 145 of file m_xml.h.

References WriteXMLIndexed().

template<typename T>
void WriteXMLIndexed ( const String &  output_file_format,
const Index &  file_index,
const T &  gin1,
const String &  filename,
const String &  gin1_wsvname,
const String &  filename_wsvname 
) [inline]

WORKSPACE METHOD: WriteXMLIndexed.

As *WriteXML*, but creates indexed file names.

The variable is written to a file with name: <br> <filename>.<file_index>.xml. where <file_index> is the value of *file_index*. This: <br> IndexSet(file_index){0} <br> IndexStep(file_index){} <br> WriteXML(ppath){"ppath"} will create the file ppath.1.xml.

This means that *filename* shall here not include the .xml extension. Omitting filename works as for *WriteXML*.

Author:
Patrick Eriksson
Parameters:
[in] output_file_format WS Input
[in] file_index WS Input
[in] gin1 Generic Input
[in] filename Generic Input (Default: "")
[in] gin1_wsvname Generic Input Name
[in] filename_wsvname Generic Input Name

Definition at line 124 of file m_xml.h.

References filename_xml_with_index(), and WriteXML().

Referenced by WriteXMLIndexed(), WriteXMLIndexed_sg_Agenda_g(), WriteXMLIndexed_sg_ArrayOfArrayOfArrayOfArrayOfGridPos_g(), WriteXMLIndexed_sg_ArrayOfArrayOfGField1_g(), WriteXMLIndexed_sg_ArrayOfArrayOfGField3_g(), WriteXMLIndexed_sg_ArrayOfArrayOfIndex_g(), WriteXMLIndexed_sg_ArrayOfArrayOfLineRecord_g(), WriteXMLIndexed_sg_ArrayOfArrayOfMatrix_g(), WriteXMLIndexed_sg_ArrayOfArrayOfSpeciesTag_g(), WriteXMLIndexed_sg_ArrayOfArrayOfTensor3_g(), WriteXMLIndexed_sg_ArrayOfArrayOfTensor6_g(), WriteXMLIndexed_sg_ArrayOfGField1_g(), WriteXMLIndexed_sg_ArrayOfGField2_g(), WriteXMLIndexed_sg_ArrayOfGField3_g(), WriteXMLIndexed_sg_ArrayOfGField4_g(), WriteXMLIndexed_sg_ArrayOfIndex_g(), WriteXMLIndexed_sg_ArrayOfLineRecord_g(), WriteXMLIndexed_sg_ArrayOfLineshapeSpec_g(), WriteXMLIndexed_sg_ArrayOfMatrix_g(), WriteXMLIndexed_sg_ArrayOfPpath_g(), WriteXMLIndexed_sg_ArrayOfRetrievalQuantity_g(), WriteXMLIndexed_sg_ArrayOfSingleScatteringData_g(), WriteXMLIndexed_sg_ArrayOfString_g(), WriteXMLIndexed_sg_ArrayOfTensor3_g(), WriteXMLIndexed_sg_ArrayOfTensor4_g(), WriteXMLIndexed_sg_ArrayOfTensor6_g(), WriteXMLIndexed_sg_ArrayOfTensor7_g(), WriteXMLIndexed_sg_ArrayOfVector_g(), WriteXMLIndexed_sg_GasAbsLookup_g(), WriteXMLIndexed_sg_GField1_g(), WriteXMLIndexed_sg_GField2_g(), WriteXMLIndexed_sg_GField3_g(), WriteXMLIndexed_sg_GField4_g(), WriteXMLIndexed_sg_GridPos_g(), WriteXMLIndexed_sg_Index_g(), WriteXMLIndexed_sg_Matrix_g(), WriteXMLIndexed_sg_MCAntenna_g(), WriteXMLIndexed_sg_Numeric_g(), WriteXMLIndexed_sg_Ppath_g(), WriteXMLIndexed_sg_SingleScatteringData_g(), WriteXMLIndexed_sg_SLIData2_g(), WriteXMLIndexed_sg_Sparse_g(), WriteXMLIndexed_sg_String_g(), WriteXMLIndexed_sg_Tensor3_g(), WriteXMLIndexed_sg_Tensor4_g(), WriteXMLIndexed_sg_Tensor5_g(), WriteXMLIndexed_sg_Tensor6_g(), WriteXMLIndexed_sg_Tensor7_g(), WriteXMLIndexed_sg_Timer_g(), and WriteXMLIndexed_sg_Vector_g().

Generated on Mon Mar 23 14:06:42 2009 for ARTS by  doxygen 1.5.6