ARTS  2.2.66
xml_io_types.h
Go to the documentation of this file.
1 /* Copyright (C) 2003-2012 Oliver Lemke <olemke@core-dump.info>
2 
3  This program is free software; you can redistribute it and/or modify it
4  under the terms of the GNU General Public License as published by the
5  Free Software Foundation; either version 2, or (at your option) any
6  later version.
7 
8  This program is distributed in the hope that it will be useful,
9  but WITHOUT ANY WARRANTY; without even the implied warranty of
10  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  GNU General Public License for more details.
12 
13  You should have received a copy of the GNU General Public License
14  along with this program; if not, write to the Free Software
15  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
16  USA. */
17 
18 
20 // File description
22 
32 #ifndef xml_io_types_h
33 #define xml_io_types_h
34 
35 #include <stdexcept>
36 #include <cfloat>
37 #include "absorption.h"
38 #include "agenda_class.h"
39 #include "array.h"
40 #include "bifstream.h"
41 #include "bofstream.h"
42 #include "cia.h"
43 #include "gas_abs_lookup.h"
44 #include "gridded_fields.h"
45 #include "jacobian.h"
46 #include "m_general.h"
47 #include "mc_antenna.h"
48 #include "mc_interp.h"
49 #include "matpackII.h"
50 #include "matpackVII.h"
51 #include "messages.h"
52 #include "optproperties.h"
53 #include "ppath.h"
54 #include "xml_io_private.h"
55 
56 #define TMPL_XML_READ_WRITE_STREAM(what) \
57  void xml_read_from_stream(istream&, what&, bifstream *, const Verbosity&); \
58  void xml_write_to_stream(ostream&, const what&, bofstream *, \
59  const String&, const Verbosity&);
60 
61 
63 // Overloaded reading/writing routines for XML streams
65 
66 //=== Basic Types ==========================================================
67 
68 TMPL_XML_READ_WRITE_STREAM(Index)
69 TMPL_XML_READ_WRITE_STREAM(Matrix)
70 TMPL_XML_READ_WRITE_STREAM(Numeric)
71 TMPL_XML_READ_WRITE_STREAM(Sparse)
72 TMPL_XML_READ_WRITE_STREAM(String)
73 TMPL_XML_READ_WRITE_STREAM(Tensor3)
74 TMPL_XML_READ_WRITE_STREAM(Tensor4)
75 TMPL_XML_READ_WRITE_STREAM(Tensor5)
76 TMPL_XML_READ_WRITE_STREAM(Tensor6)
77 TMPL_XML_READ_WRITE_STREAM(Tensor7)
78 TMPL_XML_READ_WRITE_STREAM(Timer)
79 TMPL_XML_READ_WRITE_STREAM(Vector)
80 
81 //=== Compound Types =======================================================
82 
83 TMPL_XML_READ_WRITE_STREAM(Agenda)
84 TMPL_XML_READ_WRITE_STREAM(CIARecord)
85 TMPL_XML_READ_WRITE_STREAM(GriddedField1)
86 TMPL_XML_READ_WRITE_STREAM(GriddedField2)
87 TMPL_XML_READ_WRITE_STREAM(GriddedField3)
88 TMPL_XML_READ_WRITE_STREAM(GriddedField4)
89 TMPL_XML_READ_WRITE_STREAM(GriddedField5)
90 TMPL_XML_READ_WRITE_STREAM(GriddedField6)
91 TMPL_XML_READ_WRITE_STREAM(GasAbsLookup)
92 TMPL_XML_READ_WRITE_STREAM(GridPos)
93 TMPL_XML_READ_WRITE_STREAM(IsotopologueRecord)
94 TMPL_XML_READ_WRITE_STREAM(LineMixingRecord)
95 TMPL_XML_READ_WRITE_STREAM(MCAntenna)
96 TMPL_XML_READ_WRITE_STREAM(Ppath)
97 TMPL_XML_READ_WRITE_STREAM(QuantumNumberRecord)
98 TMPL_XML_READ_WRITE_STREAM(QuantumNumbers)
99 TMPL_XML_READ_WRITE_STREAM(RetrievalQuantity)
100 TMPL_XML_READ_WRITE_STREAM(ScatteringMetaData)
101 TMPL_XML_READ_WRITE_STREAM(SLIData2)
102 TMPL_XML_READ_WRITE_STREAM(SingleScatteringData)
103 TMPL_XML_READ_WRITE_STREAM(SpeciesAuxData)
104 TMPL_XML_READ_WRITE_STREAM(SpeciesRecord)
105 TMPL_XML_READ_WRITE_STREAM(SpeciesTag)
106 TMPL_XML_READ_WRITE_STREAM(Verbosity)
107 
108 //=== Array Types ==========================================================
109 
110 TMPL_XML_READ_WRITE_STREAM(Array<IsotopologueRecord> )
111 TMPL_XML_READ_WRITE_STREAM(Array<SpeciesRecord> )
112 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfArrayOfArrayOfGridPos)
113 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfGriddedField1)
114 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfGriddedField2)
115 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfGriddedField3)
116 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfGridPos)
117 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfArrayOfGridPos)
118 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfIndex)
119 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfLineMixingRecord)
120 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfLineRecord)
121 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfMatrix)
122 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfSpeciesTag)
123 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfTensor3)
124 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfTensor6)
125 TMPL_XML_READ_WRITE_STREAM(ArrayOfArrayOfVector)
126 TMPL_XML_READ_WRITE_STREAM(ArrayOfCIARecord)
127 TMPL_XML_READ_WRITE_STREAM(ArrayOfGriddedField1)
128 TMPL_XML_READ_WRITE_STREAM(ArrayOfGriddedField2)
129 TMPL_XML_READ_WRITE_STREAM(ArrayOfGriddedField3)
130 TMPL_XML_READ_WRITE_STREAM(ArrayOfGriddedField4)
131 TMPL_XML_READ_WRITE_STREAM(ArrayOfGridPos)
132 TMPL_XML_READ_WRITE_STREAM(ArrayOfIndex)
133 TMPL_XML_READ_WRITE_STREAM(ArrayOfLineMixingRecord)
134 TMPL_XML_READ_WRITE_STREAM(ArrayOfLineRecord)
135 TMPL_XML_READ_WRITE_STREAM(ArrayOfLineshapeSpec)
136 TMPL_XML_READ_WRITE_STREAM(ArrayOfMatrix)
137 TMPL_XML_READ_WRITE_STREAM(ArrayOfSparse)
138 TMPL_XML_READ_WRITE_STREAM(ArrayOfPpath)
139 TMPL_XML_READ_WRITE_STREAM(ArrayOfRetrievalQuantity)
140 TMPL_XML_READ_WRITE_STREAM(ArrayOfScatteringMetaData)
141 TMPL_XML_READ_WRITE_STREAM(ArrayOfSingleScatteringData)
142 TMPL_XML_READ_WRITE_STREAM(ArrayOfSpeciesTag)
143 TMPL_XML_READ_WRITE_STREAM(ArrayOfString)
144 TMPL_XML_READ_WRITE_STREAM(ArrayOfTensor3)
145 TMPL_XML_READ_WRITE_STREAM(ArrayOfTensor4)
146 TMPL_XML_READ_WRITE_STREAM(ArrayOfTensor6)
147 TMPL_XML_READ_WRITE_STREAM(ArrayOfTensor7)
148 TMPL_XML_READ_WRITE_STREAM(ArrayOfVector)
149 
150 //==========================================================================
151 
152 // Undefine the macro to avoid it being used anywhere else
153 #undef TMPL_XML_READ_WRITE_STREAM
154 
155 void xml_parse_from_stream(istream&, Vector&, bifstream*, ArtsXMLTag&, const Verbosity& verbosity);
156 
157 void xml_read_from_stream(istream&, ArrayOfLineRecord&, const Numeric, const Numeric, bifstream*,
158  const Verbosity&);
159 
160 void xml_parse_from_stream(istream&, ArrayOfString&, bifstream*, ArtsXMLTag&, const Verbosity&);
161 
162 #endif /* xml_io_types_h */
Index
INDEX Index
The type to use for all integer numbers and indices.
Definition: matpack.h:35
m_general.h
Template functions for general supergeneric ws methods.
cia.h
Header file for work with HITRAN collision induced absorption (CIA).
Agenda
The Agenda class.
Definition: agenda_class.h:44
mc_interp.h
Interpolation classes and functions created for use within Monte Carlo scattering simulations...
messages.h
Declarations having to do with the four output streams.
jacobian.h
Declarations required for the calculation of jacobians.
Vector
The Vector class.
Definition: matpackI.h:556
Sparse
The Sparse class.
Definition: matpackII.h:55
Tensor4
The Tensor4 class.
Definition: matpackIV.h:383
Tensor7
The Tensor7 class.
Definition: matpackVII.h:1931
SingleScatteringData
Structure which describes the single scattering properties of a particle or a particle distribution...
Definition: optproperties.h:84
SLIData2
A 2D sequential linear interpolation (SLI) lookup table.
Definition: mc_interp.h:57
mc_antenna.h
Workspace functions for the solution of cloud-box radiative transfer by Monte Carlo methods...
GridPos
Structure to store a grid position.
Definition: interpolation.h:74
RetrievalQuantity
Contains the data for one retrieval quantity.
Definition: jacobian.h:45
array.h
This file contains the definition of Array.
xml_read_from_stream
void xml_read_from_stream(istream &, ArrayOfLineRecord &, const Numeric, const Numeric, bifstream *, const Verbosity &)
Reads ArrayOfLineRecord from XML input stream within specified frequency range.
Definition: xml_io_array_types.cc:2466
my_basic_string
The implementation for String, the ARTS string class.
Definition: mystring.h:63
ArtsXMLTag
The ARTS XML tag class.
Definition: xml_io_private.h:79
Tensor3
The Tensor3 class.
Definition: matpackIII.h:348
QuantumNumberRecord
Record containing upper and lower quantum numbers.
Definition: quantum.h:93
matpackII.h
Header file for sparse matrices.
agenda_class.h
Declarations for agendas.
bifstream
Binary output file stream class.
Definition: bifstream.h:44
bifstream.h
This file contains the class declaration of bifstream.
bofstream.h
This file contains the class declaration of bofstream.
SpeciesRecord
Contains the lookup data for one species.
Definition: absorption.h:367
SpeciesTag
A tag group can consist of the sum of several of these.
Definition: abs_species_tags.h:46
GasAbsLookup
An absorption lookup table.
Definition: gas_abs_lookup.h:46
Numeric
NUMERIC Numeric
The type to use for all floating point numbers.
Definition: matpack.h:29
Matrix
The Matrix class.
Definition: matpackI.h:788
gas_abs_lookup.h
Declarations for the gas absorption lookup table.
absorption.h
Declarations required for the calculation of absorption coefficients.
MCAntenna
An Antenna object used by MCGeneral.
Definition: mc_antenna.h:56
ppath.h
Propagation path structure and functions.
QuantumNumbers
Container class for Quantum Numbers.
Definition: quantum.h:57
IsotopologueRecord
Contains the lookup data for one isotopologue.
Definition: absorption.h:191
Tensor6
The Tensor6 class.
Definition: matpackVI.h:950
CIARecord
CIA data for a single pair of molecules.
Definition: cia.h:68
gridded_fields.h
Implementation of gridded fields.
TMPL_XML_READ_WRITE_STREAM
#define TMPL_XML_READ_WRITE_STREAM(what)
Definition: xml_io_types.h:56
xml_parse_from_stream
void xml_parse_from_stream(istream &, Vector &, bifstream *, ArtsXMLTag &, const Verbosity &verbosity)
Parses Vector from XML input stream.
Definition: xml_io_basic_types.cc:1319
Ppath
The structure to describe a propagation path and releated quantities.
Definition: ppath.h:59
SpeciesAuxData
Auxiliary data for isotopologues.
Definition: absorption.h:439
xml_io_private.h
This file contains private function declarations and template instantiation to handle XML data files...
optproperties.h
Scattering database structure and functions.
Tensor5
The Tensor5 class.
Definition: matpackV.h:451