VuoDictionary_VuoText_VuoReal

Description

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

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

Functions
VuoDictionary_VuoText_VuoReal	VuoDictionary_VuoText_VuoReal_makeFromJson (json_object *js)
json_object *	VuoDictionary_VuoText_VuoReal_getJson (const VuoDictionary_VuoText_VuoReal d)
char *	VuoDictionary_VuoText_VuoReal_getSummary (const VuoDictionary_VuoText_VuoReal d)
VuoDictionary_VuoText_VuoReal	VuoDictionaryCreate_VuoText_VuoReal (void)
VuoReal	VuoDictionaryGetValueForKey_VuoText_VuoReal (VuoDictionary_VuoText_VuoReal d, VuoText key)
void	VuoDictionarySetKeyValue_VuoText_VuoReal (VuoDictionary_VuoText_VuoReal d, VuoText key, VuoReal value)
VuoDictionary_VuoText_VuoReal	VuoDictionaryCreateWithLists_VuoText_VuoReal (const VuoList_VuoText keys, const VuoList_VuoReal values)
	Creates a dictionary consisting of the specified keys and values. More...
VuoDictionary_VuoText_VuoReal	VuoDictionary_VuoText_VuoReal_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoDictionary_VuoText_VuoReal_getString (const VuoDictionary_VuoText_VuoReal value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoReal_retain (VuoDictionary_VuoText_VuoReal value)
	Automatically generated function. More...
void	VuoDictionary_VuoText_VuoReal_release (VuoDictionary_VuoText_VuoReal value)
	Automatically generated function. More...

---

Class Documentation

VuoDictionary_VuoText_VuoReal

struct VuoDictionary_VuoText_VuoReal

Class Members
VuoList_VuoText	keys
char	unused
VuoList_VuoReal	values

Function Documentation

VuoDictionary_VuoText_VuoReal_getJson()

struct json_object * VuoDictionary_VuoText_VuoReal_getJson

(

const VuoDictionary_VuoText_VuoReal

d

)

Encodes the value as a JSON object.

Definition at line 67 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionary_VuoText_VuoReal_getString()

char* VuoDictionary_VuoText_VuoReal_getString

(

const VuoDictionary_VuoText_VuoReal

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoReal_getSummary()

char * VuoDictionary_VuoText_VuoReal_getSummary

(

const VuoDictionary_VuoText_VuoReal

d

)

Returns a brief description of the value.

Definition at line 81 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionary_VuoText_VuoReal_makeFromJson()

VuoDictionary_VuoText_VuoReal VuoDictionary_VuoText_VuoReal_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 49 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionary_VuoText_VuoReal_makeFromString()

VuoDictionary_VuoText_VuoReal VuoDictionary_VuoText_VuoReal_makeFromString

(

const char *

str

)

Automatically generated function.

VuoDictionary_VuoText_VuoReal_release()

void VuoDictionary_VuoText_VuoReal_release

(

VuoDictionary_VuoText_VuoReal

value

)

Automatically generated function.

VuoDictionary_VuoText_VuoReal_retain()

void VuoDictionary_VuoText_VuoReal_retain

(

VuoDictionary_VuoText_VuoReal

value

)

Automatically generated function.

VuoDictionaryCreate_VuoText_VuoReal()

VuoDictionary_VuoText_VuoReal VuoDictionaryCreate_VuoText_VuoReal

(

void

)

Creates an empty dictionary.

Definition at line 121 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionaryCreateWithLists_VuoText_VuoReal()

VuoDictionary_VuoText_VuoReal VuoDictionaryCreateWithLists_VuoText_VuoReal	(	const VuoList_VuoText	keys,
		const VuoList_VuoReal	values
	)

Creates a dictionary consisting of the specified keys and values.

Definition at line 130 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionaryGetValueForKey_VuoText_VuoReal()

VuoReal VuoDictionaryGetValueForKey_VuoText_VuoReal	(	VuoDictionary_VuoText_VuoReal	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 141 of file VuoDictionary_VuoText_VuoReal.cc.

VuoDictionarySetKeyValue_VuoText_VuoReal()

void VuoDictionarySetKeyValue_VuoText_VuoReal	(	VuoDictionary_VuoText_VuoReal	d,
		VuoText	key,
		VuoReal	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 158 of file VuoDictionary_VuoText_VuoReal.cc.