A wrapper for a variable whose type is determined at runtime. More...

#include <AnyMap.h>

Inheritance diagram for AnyValue:

Detailed Description

A wrapper for a variable whose type is determined at runtime.

Instances of AnyValue are used as values in an AnyMap. Values are converted to a concrete type using the templated as() method or convenience methods such as asString() and asDouble(). See AnyMap for usage examples.

Elements are set using assignment, and the assignment operator has been overloaded for specific types so that only those types are allowed to be used in an AnyValue. The allowed types are:

AnyMap
double
long int
bool
string
vector of any of the above

Definition at line 85 of file AnyMap.h.

Public Member Functions
bool	operator== (const AnyValue &other) const

bool	operator!= (const AnyValue &other) const

AnyValue &	operator[] (const string &key)
	If this AnyValue is an AnyMap, return the value stored in `key`. More...

const AnyValue &	operator[] (const string &key) const

bool	hasKey (const string &key) const
	Returns `true` if this AnyValue is an AnyMap and that map contains a key with the given name. More...

void	setKey (const string &key)
	Set the name of the key storing this value in an AnyMap. More...

void	propagateMetadata (shared_ptr< AnyMap > &file)
	Propagate metadata to any child elements. More...

template<class T >
const T &	as () const
	Get the value of this key as the specified type. More...

template<class T >
T &	as ()

const std::type_info &	type () const
	Returns the type of the held value. More...

string	type_str () const
	Returns a string specifying the type of the held value. More...

bool	empty () const
	Return boolean indicating whether AnyValue is empty. More...

template<class T >
bool	is () const
	Returns `true` if the held value is of the specified type. More...

template<class T >
bool	isVector () const
	Returns `true` if the held value is a vector of the specified type, such as `vector<double>`. More...

template<class T >
bool	isMatrix (size_t cols=npos) const
	Returns `true` if the held value is a matrix of the specified type and a consistent number of columns, such as `vector<vector<double>>`. More...

bool	isScalar () const
	Returns `true` if the held value is a scalar type (such as `double`, `long int`, `string`, or `bool`). More...

size_t	vectorSize () const
	Returns size of the held vector. More...

pair< size_t, size_t >	matrixShape () const
	Returns rows and columns of a matrix. More...

	AnyValue (const string &value)

	AnyValue (const char *value)

AnyValue &	operator= (const string &value)

AnyValue &	operator= (const char *value)

const string &	asString () const
	Return the held value, if it is a string. More...

bool	operator== (const string &other) const

bool	operator!= (const string &other) const

	AnyValue (double value)

AnyValue &	operator= (double value)

double &	asDouble ()
	Return the held value as a `double`, if it is a `double` or a `long int`. More...

const double &	asDouble () const

bool	operator== (const double &other) const

bool	operator!= (const double &other) const

	AnyValue (bool value)

AnyValue &	operator= (bool value)

bool &	asBool ()
	Return the held value, if it is a `bool`. More...

const bool &	asBool () const

	AnyValue (long int value)

	AnyValue (int value)

AnyValue &	operator= (long int value)

AnyValue &	operator= (int value)

long int &	asInt ()
	Return the held value, if it is a `long int`. More...

const long int &	asInt () const

bool	operator== (const long int &other) const

bool	operator!= (const long int &other) const

bool	operator== (const int &other) const

bool	operator!= (const int &other) const

template<class T >
AnyValue &	operator= (const vector< T > &value)

template<class T >
const vector< T > &	asVector (size_t nMin=npos, size_t nMax=npos) const
	Return the held value, if it is a vector of type `T`. More...

template<class T >
vector< T > &	asVector (size_t nMin=npos, size_t nMax=npos)

	AnyValue (const AnyMap &value)

AnyValue &	operator= (const AnyMap &value)

AnyValue &	operator= (AnyMap &&value)

template<class T >
AnyValue &	operator= (const std::unordered_map< string, T > items)

template<class T >
AnyValue &	operator= (const map< string, T > items)

template<class T >
map< string, T >	asMap () const
	Return the held `AnyMap` as a `map` where all of the values have the specified type. More...

std::unordered_map< string, const AnyMap * >	asMap (const string &name) const
	Access a `vector<AnyMap>` as a mapping using the value of `name` from each item as the key in the new mapping. More...

std::unordered_map< string, AnyMap * >	asMap (const string &name)

AnyMap &	getMapWhere (const string &key, const string &value, bool create=false)
	Treating the value as `vector<AnyMap>`, return the item where the given key has the specified value. More...

const AnyMap &	getMapWhere (const string &key, const string &value) const

bool	hasMapWhere (const string &key, const string &value) const
	Returns `true` when getMapWhere() would succeed. More...

pair< int, int >	order () const
	Return values used to determine the sort order when outputting to YAML. More...

void	applyUnits (shared_ptr< UnitSystem > &units)
	See AnyMap::applyUnits() More...

void	setFlowStyle (bool flow=true)
	See AnyMap::setFlowStyle() More...

template<>
bool	is () const

template<>
const vector< AnyValue > &	asVector (size_t nMin, size_t nMax) const

template<>
vector< AnyValue > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< double > &	asVector (size_t nMin, size_t nMax) const

template<>
vector< double > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< vector< double > > &	asVector (size_t nMin, size_t nMax) const

template<>
vector< vector< double > > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< AnyMap > &	asVector (size_t nMin, size_t nMax) const

template<>
vector< AnyMap > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< AnyValue > &	asVector (size_t nMin, size_t nMax) const
	Implicit conversion to vector<AnyValue> More...

template<>
vector< AnyValue > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< double > &	asVector (size_t nMin, size_t nMax) const
	Implicit conversion of long int to double if accessed as a vector<double> More...

template<>
vector< double > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< vector< double > > &	asVector (size_t nMin, size_t nMax) const
	Implicit conversion of long int to double if accessed as a vector<vector<double>> More...

template<>
vector< vector< double > > &	asVector (size_t nMin, size_t nMax)

template<>
const vector< AnyMap > &	asVector (size_t nMin, size_t nMax) const
	Implicit conversion of AnyMap to a vector<AnyMap> of length 1, or an empty vector<AnyValue> an empty vector<AnyMap> More...

template<>
vector< AnyMap > &	asVector (size_t nMin, size_t nMax)

template<>
bool	is () const

template<>
AnyMap &	as ()

Public Member Functions inherited from AnyBase
void	setLoc (int line, int column)
	For values which are derived from an input file, set the line and column of this value in that file. More...

const AnyValue &	getMetadata (const string &key) const
	Get a value from the metadata applicable to the AnyMap tree containing this node. More...

Private Types
typedef bool(*	Comparer) (const std::any &, const std::any &)

Private Member Functions
template<class T >
void	checkSize (const vector< T > &v, size_t nMin, size_t nMax) const

Static Private Member Functions
template<typename T >
static bool	eq_comparer (const std::any &lhs, const std::any &rhs)
	Equality comparison function used when lhs is of type T More...

template<class T , class U >
static bool	vector_eq (const std::any &lhs, const std::any &rhs)
	Helper function for comparing vectors of different (but comparable) types, for example `vector<double>` and `vector<long int>` More...

template<class T , class U >
static bool	vector2_eq (const std::any &lhs, const std::any &rhs)
	Helper function for comparing nested vectors of different (but comparable) types, for example `vector<vector<double>>` and `vector<vector<long int>>` More...

Private Attributes
string	m_key
	Key of this value in a parent `AnyMap` More...

std::any	m_value
	The held value. More...

Comparer	m_equals

Friends
bool	operator== (const string &lhs, const AnyValue &rhs)

bool	operator!= (const string &lhs, const AnyValue &rhs)

bool	operator== (const double &lhs, const AnyValue &rhs)

bool	operator!= (const double &lhs, const AnyValue &rhs)

bool	operator== (const long int &lhs, const AnyValue &rhs)

bool	operator!= (const long int &lhs, const AnyValue &rhs)

bool	operator== (const int &lhs, const AnyValue &rhs)

bool	operator!= (const int &lhs, const AnyValue &rhs)

YAML::Emitter &	YAML::operator<< (YAML::Emitter &out, const AnyValue &rhs)

Quantity conversions
Assign a quantity consisting of one or more values and their corresponding units, which will be converted to a target unit system when the applyUnits() function is later called on the root of the AnyMap.
typedef function< void(AnyValue &, const UnitSystem &)>	unitConverter

void	setQuantity (double value, const string &units, bool is_act_energy=false)
	Assign a scalar quantity with units as a string, for example `{3.0, "m^2"}`. More...

void	setQuantity (double value, const Units &units)
	Assign a scalar quantity with units as a Units object, for cases where the units vary and are determined dynamically, such as reaction pre-exponential factors. More...

void	setQuantity (const vector< double > &values, const string &units)
	Assign a vector where all the values have the same units. More...

void	setQuantity (const AnyValue &value, const unitConverter &converter)
	Assign a value of any type where the unit conversion requires a different behavior besides scaling all values by the same factor. More...

Additional Inherited Members
Protected Attributes inherited from AnyBase
int	m_line = -1
	The line where this value occurs in the input file. More...

int	m_column = 0
	If m_line >= 0, the column where this value occurs in the input file. More...

shared_ptr< AnyMap >	m_metadata
	Metadata relevant to an entire AnyMap tree, such as information about. More...

Member Function Documentation

◆ operator[]()

AnyValue & operator[] ( const string & key )

If this AnyValue is an AnyMap, return the value stored in key.

Definition at line 607 of file AnyMap.cpp.

◆ hasKey()

bool hasKey ( const string & key ) const

Returns true if this AnyValue is an AnyMap and that map contains a key with the given name.

Definition at line 617 of file AnyMap.cpp.

◆ setKey()

void setKey ( const string & key )

Set the name of the key storing this value in an AnyMap.

Used for providing informative error messages in class InputFileError.

Definition at line 621 of file AnyMap.cpp.

◆ propagateMetadata()

void propagateMetadata ( shared_ptr< AnyMap > & file )

Propagate metadata to any child elements.

Definition at line 627 of file AnyMap.cpp.

◆ as()

const T & as

Get the value of this key as the specified type.

Definition at line 16 of file AnyMap.inl.h.

◆ type()

const std::type_info & type ( ) const

Returns the type of the held value.

Definition at line 623 of file AnyMap.cpp.

◆ type_str()

string type_str ( ) const

Returns a string specifying the type of the held value.

Definition at line 643 of file AnyMap.cpp.

◆ empty()

bool empty ( ) const

Return boolean indicating whether AnyValue is empty.

Definition at line 647 of file AnyMap.cpp.

◆ is()

bool is

Returns true if the held value is of the specified type.

Definition at line 68 of file AnyMap.inl.h.

◆ isVector()

bool isVector

Returns true if the held value is a vector of the specified type, such as vector<double>.

Since: New in Cantera 3.0.

Definition at line 75 of file AnyMap.inl.h.

◆ isMatrix()

bool isMatrix ( size_t cols = npos ) const

Returns true if the held value is a matrix of the specified type and a consistent number of columns, such as vector<vector<double>>.

If the number of columns is provided, a match is required.

Since: New in Cantera 3.0.

Definition at line 80 of file AnyMap.inl.h.

◆ isScalar()

bool isScalar ( ) const

Returns true if the held value is a scalar type (such as double, long int, string, or bool).

Definition at line 651 of file AnyMap.cpp.

◆ vectorSize()

size_t vectorSize ( ) const

Returns size of the held vector.

If not a vector or the type is not supported npos is returned. Types considered include vector<double>, vector<long int>, vector<string>, and vector<bool.

Since: New in Cantera 3.0.

Definition at line 655 of file AnyMap.cpp.

◆ matrixShape()

pair< size_t, size_t > matrixShape ( ) const

Returns rows and columns of a matrix.

If the number of columns is not consistent, the number of columns is set to npos; if the type is not supported, a npos pair is returned. Types considered include vector<vector<double>>, vector<vector<long int>>, vector<vector<string>> and vector<vector<bool>>.

Since: New in Cantera 3.0.

Definition at line 671 of file AnyMap.cpp.

◆ asString()

const string & asString ( ) const

Return the held value, if it is a string.

Definition at line 739 of file AnyMap.cpp.

◆ setQuantity() [1/4]

void setQuantity	(	double	value,
		const string &	units,
		bool	is_act_energy = `false`
	)

Assign a scalar quantity with units as a string, for example {3.0, "m^2"}.

If the is_act_energy flag is set to true, the units will be converted using the special rules for activation energies.

Definition at line 769 of file AnyMap.cpp.

◆ setQuantity() [2/4]

void setQuantity	(	double	value,
		const Units &	units
	)

Assign a scalar quantity with units as a Units object, for cases where the units vary and are determined dynamically, such as reaction pre-exponential factors.

Definition at line 774 of file AnyMap.cpp.

◆ setQuantity() [3/4]

void setQuantity	(	const vector< double > &	values,
		const string &	units
	)

Assign a vector where all the values have the same units.

Definition at line 779 of file AnyMap.cpp.

◆ setQuantity() [4/4]

void setQuantity	(	const AnyValue &	value,
		const unitConverter &	converter
	)

Assign a value of any type where the unit conversion requires a different behavior besides scaling all values by the same factor.

Definition at line 786 of file AnyMap.cpp.

◆ asDouble()

double & asDouble ( )

Return the held value as a double, if it is a double or a long int.

Definition at line 824 of file AnyMap.cpp.

◆ asBool()

bool & asBool ( )

Return the held value, if it is a bool.

Definition at line 871 of file AnyMap.cpp.

◆ asInt()

long int & asInt ( )

Return the held value, if it is a long int.

Definition at line 903 of file AnyMap.cpp.

◆ asVector() [1/5]

const vector< T > & asVector	(	size_t	nMin = `npos`,
		size_t	nMax = `npos`
	)		const

Return the held value, if it is a vector of type T.

If called with one argument, requires the vector to be of the specified size. If called with two arguments, requires the vector to be within the range specified by the two values, inclusive.

Definition at line 109 of file AnyMap.inl.h.

◆ asMap() [1/2]

map< string, T > asMap

Return the held AnyMap as a map where all of the values have the specified type.

Definition at line 162 of file AnyMap.inl.h.

◆ asMap() [2/2]

std::unordered_map< string, const AnyMap * > asMap ( const string & name ) const

Access a vector<AnyMap> as a mapping using the value of name from each item as the key in the new mapping.

For example, for the list:

[{name: O2, weight: 32}, {name: CH4, weight: 16}]

calling asMap("name") will create a map with keys O2 and CH4.

Definition at line 976 of file AnyMap.cpp.

◆ getMapWhere()

AnyMap & getMapWhere	(	const string &	key,
		const string &	value,
		bool	create = `false`
	)

Treating the value as vector<AnyMap>, return the item where the given key has the specified value.

If value is the empty string, returns the first item in the list.

If the contained type is just AnyMap rather than vector<AnyMap>, it will be treated as a vector of length 1.

If the value does not exist but the create flag is set to true, a new map with that key and value will be created and returned.

Definition at line 1034 of file AnyMap.cpp.

◆ hasMapWhere()

bool hasMapWhere	(	const string &	key,
		const string &	value
	)		const

Returns true when getMapWhere() would succeed.

Definition at line 1084 of file AnyMap.cpp.

◆ order()

pair< int, int > order ( ) const

Return values used to determine the sort order when outputting to YAML.

Definition at line 1107 of file AnyMap.cpp.

◆ applyUnits()

void applyUnits ( shared_ptr< UnitSystem > & units )

See AnyMap::applyUnits()

Definition at line 1112 of file AnyMap.cpp.

◆ setFlowStyle()

void setFlowStyle ( bool flow = true )

See AnyMap::setFlowStyle()

Definition at line 1209 of file AnyMap.cpp.

◆ eq_comparer()

bool eq_comparer	(	const std::any &	lhs,
		const std::any &	rhs
	)

staticprivate

Equality comparison function used when lhs is of type T

Definition at line 216 of file AnyMap.inl.h.

◆ vector_eq()

bool vector_eq	(	const std::any &	lhs,
		const std::any &	rhs
	)

staticprivate

Helper function for comparing vectors of different (but comparable) types, for example vector<double> and vector<long int>

Definition at line 187 of file AnyMap.inl.h.

◆ vector2_eq()

bool vector2_eq	(	const std::any &	lhs,
		const std::any &	rhs
	)

staticprivate

Helper function for comparing nested vectors of different (but comparable) types, for example vector<vector<double>> and vector<vector<long int>>

Definition at line 199 of file AnyMap.inl.h.

◆ asVector() [2/5]

const vector<AnyValue>& asVector	(	size_t	nMin,
		size_t	nMax
	)		const

Implicit conversion to vector<AnyValue>

◆ asVector() [3/5]

const vector<double>& asVector	(	size_t	nMin,
		size_t	nMax
	)		const

Implicit conversion of long int to double if accessed as a vector<double>

◆ asVector() [4/5]

const vector<vector<double> >& asVector	(	size_t	nMin,
		size_t	nMax
	)		const

Implicit conversion of long int to double if accessed as a vector<vector<double>>

◆ asVector() [5/5]

const vector<AnyMap>& asVector	(	size_t	nMin,
		size_t	nMax
	)		const

Implicit conversion of AnyMap to a vector<AnyMap> of length 1, or an empty vector<AnyValue> an empty vector<AnyMap>

Member Data Documentation

◆ m_key

string m_key

private

Key of this value in a parent AnyMap

Definition at line 301 of file AnyMap.h.

◆ m_value

std::any m_value

private

The held value.

Definition at line 304 of file AnyMap.h.

The documentation for this class was generated from the following files:

Detailed Description

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Private Attributes

Friends

Quantity conversions

Additional Inherited Members

Member Function Documentation

◆ operator[]()

◆ hasKey()

◆ setKey()

◆ propagateMetadata()

◆ as()

◆ type()

◆ type_str()

◆ empty()

◆ is()

◆ isVector()

◆ isMatrix()

◆ isScalar()

◆ vectorSize()

◆ matrixShape()

◆ asString()

◆ setQuantity() [1/4]

◆ setQuantity() [2/4]

◆ setQuantity() [3/4]

◆ setQuantity() [4/4]

◆ asDouble()

◆ asBool()

◆ asInt()

◆ asVector() [1/5]

◆ asMap() [1/2]

◆ asMap() [2/2]

◆ getMapWhere()

◆ hasMapWhere()

◆ order()

◆ applyUnits()

◆ setFlowStyle()

◆ eq_comparer()

◆ vector_eq()

◆ vector2_eq()

◆ asVector() [2/5]

◆ asVector() [3/5]

◆ asVector() [4/5]

◆ asVector() [5/5]

Member Data Documentation

◆ m_key

◆ m_value