dictionary.h File Reference

#include "pxr/pxr.h"
#include "pxr/base/vt/api.h"
#include "pxr/base/vt/value.h"
#include "pxr/base/tf/diagnostic.h"
#include "pxr/base/tf/hash.h"
#include "pxr/base/tf/mallocTag.h"
#include <hboost/iterator/iterator_adaptor.hpp>
#include <initializer_list>
#include <iosfwd>
#include <map>
#include <memory>

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
class	VtDictionary::Iterator< UnderlyingMapPtr, UnderlyingIterator >
struct	Vt_DefaultHolder< T >
struct	Vt_DefaultGenerator
struct	VtDictionaryHash

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 &)
VT_API VtDictionary const &	VtGetEmptyDictionary ()
template<typename T >
bool	VtDictionaryIsHolding (const VtDictionary &dictionary, const std::string &key)
template<typename T >
bool	VtDictionaryIsHolding (const VtDictionary &dictionary, const char *key)
template<typename T >
const T &	VtDictionaryGet (const VtDictionary &dictionary, const std::string &key)
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)
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)
VT_API void	VtDictionaryOver (VtDictionary *strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
VT_API void	VtDictionaryOver (const VtDictionary &strong, VtDictionary *weak, bool coerceToWeakerOpinionType=false)
VT_API VtDictionary	VtDictionaryOverRecursive (const VtDictionary &strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
VT_API void	VtDictionaryOverRecursive (VtDictionary *strong, const VtDictionary &weak, bool coerceToWeakerOpinionType=false)
VT_API void	VtDictionaryOverRecursive (const VtDictionary &strong, VtDictionary *weak, bool coerceToWeakerOpinionType=false)

Variables
VT_API Vt_DefaultGenerator	VtDefault

Function Documentation

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 }".

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

Equality comparison.

template<typename T >

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 428 of file dictionary.h.

template<class T , class U >

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 488 of file dictionary.h.

template<typename T >

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 389 of file dictionary.h.

VT_API VtDictionary const& VtGetEmptyDictionary

(

)

Variable Documentation

VT_API Vt_DefaultGenerator VtDefault