VuoDictionary_VuoText_VuoText

Description

A mapping from keys to values. (To be replaced with a generic VuoDictionary type in the future.)

Classes
struct	VuoDictionary_VuoText_VuoText
	A mapping from keys to values. More...

Functions
VuoDictionary_VuoText_VuoText	VuoDictionary_VuoText_VuoText_makeFromJson (json_object *js)
json_object *	VuoDictionary_VuoText_VuoText_getJson (const VuoDictionary_VuoText_VuoText d)
char *	VuoDictionary_VuoText_VuoText_getSummary (const VuoDictionary_VuoText_VuoText d)
VuoDictionary_VuoText_VuoText	VuoDictionaryCreate_VuoText_VuoText (void)
VuoText	VuoDictionaryGetValueForKey_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key)
void	VuoDictionarySetKeyValue_VuoText_VuoText (VuoDictionary_VuoText_VuoText d, VuoText key, VuoText value)
VuoDictionary_VuoText_VuoText	VuoDictionaryCreateWithLists_VuoText_VuoText (const VuoList_VuoText keys, const VuoList_VuoText values)
	Creates a dictionary consisting of the specified keys and values. More...
VuoDictionary_VuoText_VuoText	VuoDictionary_VuoText_VuoText_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoDictionary_VuoText_VuoText_getString (const VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoText_retain (VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoText_release (VuoDictionary_VuoText_VuoText value)
	Automatically generated function. More...

---

Class Documentation

VuoDictionary_VuoText_VuoText

struct VuoDictionary_VuoText_VuoText

Class Members
VuoList_VuoText	keys
char	unused
VuoList_VuoText	values

Function Documentation

VuoDictionary_VuoText_VuoText_getJson()

struct json_object * VuoDictionary_VuoText_VuoText_getJson

(

const VuoDictionary_VuoText_VuoText

d

)

Encodes the value as a JSON object.

Definition at line 65 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionary_VuoText_VuoText_getString()

char* VuoDictionary_VuoText_VuoText_getString

(

const VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_getSummary()

char * VuoDictionary_VuoText_VuoText_getSummary

(

const VuoDictionary_VuoText_VuoText

d

)

Returns a brief description of the value.

Definition at line 79 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionary_VuoText_VuoText_makeFromJson()

VuoDictionary_VuoText_VuoText VuoDictionary_VuoText_VuoText_makeFromJson

(

json_object *

js

)

Decodes the JSON object to create a new value.

Example:

{
  "keys" : ["a","b","c"],
  "values" : [1.2, 3.4, 5.6]
}

Definition at line 47 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionary_VuoText_VuoText_makeFromString()

VuoDictionary_VuoText_VuoText VuoDictionary_VuoText_VuoText_makeFromString

(

const char *

str

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_release()

void VuoDictionary_VuoText_VuoText_release

(

VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoText_retain()

void VuoDictionary_VuoText_VuoText_retain

(

VuoDictionary_VuoText_VuoText

value

)

Automatically generated function.

VuoDictionaryCreate_VuoText_VuoText()

VuoDictionary_VuoText_VuoText VuoDictionaryCreate_VuoText_VuoText

(

void

)

Creates an empty dictionary.

Definition at line 120 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionaryCreateWithLists_VuoText_VuoText()

VuoDictionary_VuoText_VuoText VuoDictionaryCreateWithLists_VuoText_VuoText	(	const VuoList_VuoText	keys,
		const VuoList_VuoText	values
	)

Creates a dictionary consisting of the specified keys and values.

Definition at line 129 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionaryGetValueForKey_VuoText_VuoText()

VuoText VuoDictionaryGetValueForKey_VuoText_VuoText	(	VuoDictionary_VuoText_VuoText	d,
		VuoText	key
	)

Returns the value mapped from key in the dictionary.

In order to match, key must use the same Unicode character compositions as the dictionary's key.

Definition at line 140 of file VuoDictionary_VuoText_VuoText.cc.

VuoDictionarySetKeyValue_VuoText_VuoText()

void VuoDictionarySetKeyValue_VuoText_VuoText	(	VuoDictionary_VuoText_VuoText	d,
		VuoText	key,
		VuoText	value
	)

Sets the value mapped from key in the dictionary to value.

(Currently, this only allows adding a key-value mapping, not changing an existing one. When this type is replaced with a generic VuoDictionary type, this function will allow the latter.)

Definition at line 157 of file VuoDictionary_VuoText_VuoText.cc.