casacore
Loading...
Searching...
No Matches
Json.h
Go to the documentation of this file.
1//# Json.h: Classes to read or write a Json file
2//# Copyright (C) 2016
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: aips2-request@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25//#
26//# $Id$
27
28
29#ifndef CASA_JSON_H
30#define CASA_JSON_H
31
32#include <casacore/casa/aips.h>
33
34#include <casacore/casa/Json/JsonOut.h>
35#include <casacore/casa/Json/JsonValue.h>
36#include <casacore/casa/Json/JsonParser.h>
37
38namespace casacore { //# NAMESPACE CASACORE - BEGIN
39
40// <module>
41//
42// <summary> Classes to read or write a JSON file </summary>
43
44// <reviewed reviewer="" date="" demos="">
45// </reviewed>
46
47// <synopsis>
48// This module handles JSON input and output. It supports the full Json
49// syntax (including null values) with the addition of complex numbers
50// represented as a nested JSON struct with fields "r" and "i".
51// <br>NaN and infinite floating point numbers are written as a null value.
52// <br>It supports comments in the JSON file using C, C++ or Python style
53// delimiters.
54//
55// It consists of the following classes:
56// <ul>
57// <li> <linkto class=JsonOut>JsonOut</linkto>
58// to create and populate a JSON file. Besides support of scalar values
59// and std::vector, it also supports Array, Record and ValueHolder objects.
60// <li> <linkto class=JsonOut>JsonParser</linkto>
61// to parse a JSON file and store the results in a JsonKVMap object.
62// The parser only accepts the rather strict JSON number representation.
63// <li> <linkto class=JsonOut>JsonKVMap</linkto>
64// to obtain the results from a parsed JSON file. It is possible to
65// obtain a (possible nested) sequence as an Array object.
66// </ul>
67// </synopsis>
68
69//# <todo asof="1995/03/20">
70//# <li>
71//# </todo>
72
73// </module>
74
75
76} //# NAMESPACE CASACORE - END
77
78#endif
79
this file contains all the compiler specific defines
Definition mainpage.dox:28