All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dictionary.h File Reference
+ Include dependency graph for dictionary.h:

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 >
const T & VtDictionaryGet (const VtDictionary &dictionary, const std::string &key)
 Return a value held in a VtDictionary by reference. More...
 
template<class T , class U >
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...
 
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.