dictionary.h File Reference

Include dependency graph for dictionary.h:

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

Go to the source code of this file.

Classes
class	VtDictionary
	A map with string keys and VtValue values. More...

Functions
VT_API bool	operator== (VtDictionary const &, VtDictionary const &)
	Equality comparison. More...
VT_API bool	operator!= (VtDictionary const &, VtDictionary const &)
VT_API std::ostream &	operator<< (std::ostream &, VtDictionary const &)
	Write the contents of a VtDictionary to a stream, formatted like "{ 'key1': value1, 'key2': value2 }". More...
VT_API VtDictionary const &	VtGetEmptyDictionary ()
template<typename T >
bool	VtDictionaryIsHolding (const VtDictionary &dictionary, const std::string &key)
	Returns true if dictionary contains key and the corresponding value is of type T. More...
template<typename T >
bool	VtDictionaryIsHolding (const VtDictionary &dictionary, const char *key)
template<typename T >
const T &	VtDictionaryGet (const VtDictionary &dictionary, const std::string &key)
	Return a value held in a VtDictionary by reference. More...
template<typename T >
const T &	VtDictionaryGet (const VtDictionary &dictionary, const char *key)
template<class T , class U >
T	VtDictionaryGet (const VtDictionary &dictionary, const std::string &key, Vt_DefaultHolder< U > const &def)
	Return a value held in a VtDictionary, or a default value either if the supplied key is missing or if the types do not match. More...
template<class T , class U >
T	VtDictionaryGet (const VtDictionary &dictionary, const char *key, Vt_DefaultHolder< U > const &def)
VT_API VtDictionary	VtDictionaryOver (const VtDictionary &strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
	Creates a dictionary containing strong composed over weak. More...
VT_API void	VtDictionaryOver (VtDictionary *strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
	Updates strong to become strong composed over weak. More...
VT_API void	VtDictionaryOver (const VtDictionary &strong, VtDictionary *weak, bool coerceToWeakerOpinionType=false)
	Updates weak to become strong composed over weak. More...
VT_API VtDictionary	VtDictionaryOverRecursive (const VtDictionary &strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
	Returns a dictionary containing strong recursively composed over weak. More...
VT_API void	VtDictionaryOverRecursive (VtDictionary *strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
	Updates strong to become strong composed recursively over weak. More...
VT_API void	VtDictionaryOverRecursive (const VtDictionary &strong, VtDictionary *weak, bool coerceToWeakerOpinionType=false)
	Updates weak to become strong composed recursively over weak. More...

Variables
VT_API Vt_DefaultGenerator	VtDefault

Function Documentation

VT_API std::ostream& operator<<	(	std::ostream &	,
		VtDictionary const &
	)

Write the contents of a VtDictionary to a stream, formatted like "{ 'key1': value1, 'key2': value2 }".

VT_API bool operator==	(	VtDictionary const &	,
		VtDictionary const &
	)

Equality comparison.

const T& VtDictionaryGet	(	const VtDictionary &	dictionary,
		const char *	key
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 429 of file dictionary.h.

T VtDictionaryGet	(	const VtDictionary &	dictionary,
		const char *	key,
		Vt_DefaultHolder< U > const &	def
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 489 of file dictionary.h.

bool VtDictionaryIsHolding	(	const VtDictionary &	dictionary,
		const char *	key
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 390 of file dictionary.h.