A simple (not thread-safe) set of key/value pairs. (New in SDK 16.3) More...

#include <ntv2nubaccess.h>

Public Types
typedef std::map< std::string, std::string >	Dict

typedef Dict::const_iterator	DictConstIter

Public Member Functions
size_t	initializeFrom (const Dict &inDict)

Inquiry
std::string	valueForKey (const std::string &inKey) const

uint16_t	u16ValueForKey (const std::string &inKey, const uint16_t inDefault=0) const

NTV2StringSet	keys (void) const

size_t	largestKeySize (void) const

size_t	largestValueSize (void) const

std::ostream &	Print (std::ostream &oss, const bool inCompact=true) const
	Prints human-readable representation to ostream. More...

bool	serialize (std::string &outStr) const
	Serializes my contents into the given string. More...

Changing
bool	insert (const std::string &inKey, const std::string &inValue)
	Stores the given value using the given key; overwrites existing value if already present. More...

size_t	updateFrom (const NTV2Dictionary &inDict)
	Updates all values from inDict with matching keys, ignoring all non-matching keys. More...

size_t	addFrom (const NTV2Dictionary &inDict)
	Adds all values from inDict with non-matching keys, ignoring all matching keys. More...

bool	deserialize (const std::string &inStr)
	Resets me from the given string. More...

Detailed Description

A simple (not thread-safe) set of key/value pairs. (New in SDK 16.3)

Definition at line 98 of file ntv2nubaccess.h.

Member Typedef Documentation

◆ Dict

typedef std::map<std::string, std::string> NTV2Dictionary::Dict

Definition at line 134 of file ntv2nubaccess.h.

◆ DictConstIter

typedef Dict::const_iterator NTV2Dictionary::DictConstIter

Definition at line 135 of file ntv2nubaccess.h.

Member Function Documentation

◆ addFrom()

size_t NTV2Dictionary::addFrom ( const NTV2Dictionary & inDict )

Adds all values from inDict with non-matching keys, ignoring all matching keys.

Definition at line 264 of file ntv2nubaccess.cpp.

◆ deserialize()

bool NTV2Dictionary::deserialize ( const std::string & inStr )

Resets me from the given string.

Definition at line 182 of file ntv2nubaccess.cpp.

◆ initializeFrom()

size_t NTV2Dictionary::initializeFrom ( const Dict & inDict )

inline

Definition at line 136 of file ntv2nubaccess.h.

◆ insert()

bool NTV2Dictionary::insert	(	const std::string &	inKey,
		const std::string &	inValue
	)

Stores the given value using the given key; overwrites existing value if already present.

Definition at line 239 of file ntv2nubaccess.cpp.

◆ keys()

NTV2StringSet NTV2Dictionary::keys ( void ) const

Returns: My keys

Definition at line 213 of file ntv2nubaccess.cpp.

◆ largestKeySize()

size_t NTV2Dictionary::largestKeySize ( void ) const

Returns: The length of my largest key, in bytes

Definition at line 221 of file ntv2nubaccess.cpp.

◆ largestValueSize()

size_t NTV2Dictionary::largestValueSize ( void ) const

Returns: The length of my largest value, in bytes

Definition at line 230 of file ntv2nubaccess.cpp.

◆ Print()

ostream & NTV2Dictionary::Print	(	std::ostream &	oss,
		const bool	inCompact = `true`
	)		const

Prints human-readable representation to ostream.

Definition at line 155 of file ntv2nubaccess.cpp.

◆ serialize()

bool NTV2Dictionary::serialize ( std::string & outStr ) const

Serializes my contents into the given string.

Definition at line 199 of file ntv2nubaccess.cpp.

◆ u16ValueForKey()

uint16_t NTV2Dictionary::u16ValueForKey	(	const std::string &	inKey,
		const uint16_t	inDefault = `0`
	)		const

Returns: The corresponding uint16_t value for the given key, or inDefault if no such key

Definition at line 119 of file ntv2nubaccess.cpp.

◆ updateFrom()

size_t NTV2Dictionary::updateFrom ( const NTV2Dictionary & inDict )

Updates all values from inDict with matching keys, ignoring all non-matching keys.

Definition at line 255 of file ntv2nubaccess.cpp.

◆ valueForKey()

string NTV2Dictionary::valueForKey ( const std::string & inKey ) const

Returns: The corresponding value for the given key, or empty string if no such key

Definition at line 111 of file ntv2nubaccess.cpp.

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

/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2nubaccess.h
/home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2nubaccess.cpp

Public Types

Public Member Functions