keyvaluetree.h File Reference

#include <algorithm>
#include <functional>
#include <map>
#include <string>
#include <utility>
#include <vector>
#include "gromacs/utility/real.h"
#include "gromacs/utility/variant.h"

Include dependency graph for keyvaluetree.h:

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

Description

Declares a data structure for JSON-like structured key-value mapping.

A tree is composed of nodes that can have different types:

• Value (gmx::KeyValueTreeValue) is a generic node that can represent either a scalar value of arbitrary type, or an object or an array.
• Array (gmx::KeyValueTreeArray) is a collection of any number of values (including zero). The values can be of any type and different types can be mixed in the same array.
• Object (gmx::KeyValueTreeObject) is a collection of properties. Each property must have a unique key. Order of properties is preserved, i.e., they can be iterated in the order they were added.
• Property (gmx::KeyValueTreeProperty) is an arbitrary type of value associated with a string key. The root object of a tree is typically an object, but could also be an array. The data structure itself does not enforce any other constraints, but the context in which it is used can limit the allowed scalar types or, e.g., require arrays to have values of uniform type. Also, several operations defined for the structure (string output, comparison, serialization, etc.) only work on a limited set of scalar types, or have limitations with the types of trees they work on (in particular, arrays are currently poorly supported).

Author

Teemu Murtola teemu.nosp@m..mur.nosp@m.tola@.nosp@m.gmai.nosp@m.l.com

Classes
class	gmx::KeyValueTreePath
	Identifies an entry in a key-value tree. More...

Functions
KeyValueTreePath	gmx::operator+ (const KeyValueTreePath &a, const KeyValueTreePath &b)
	Combines two paths as with KeyValueTreePath::append().
KeyValueTreePath	gmx::operator+ (const KeyValueTreePath &a, const std::string &b)
	Combines an element to a path as with KeyValueTreePath::append().
void	gmx::dumpKeyValueTree (TextWriter *writer, const KeyValueTreeObject &tree)
	Writes a human-readable representation of the tree with given writer. More...
void	gmx::compareKeyValueTrees (TextWriter *writer, const KeyValueTreeObject &tree1, const KeyValueTreeObject &tree2, real ftol, real abstol)
	Compares two KeyValueTrees and prints any differences.
static std::string	gmx::simpleValueToString (const KeyValueTreeValue &value)
	Helper function to format a simple KeyValueTreeValue.