Vuo
2.0.0
|
A list of VuoSerialDevice elements.
Classes | |
struct | VuoList_VuoSerialDevice_struct |
A list of VuoSerialDevice elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoSerialDevice_struct * | VuoList_VuoSerialDevice |
A list of VuoSerialDevice elements. More... | |
Functions | |
VuoList_VuoSerialDevice | VuoListCreate_VuoSerialDevice (void) |
Creates a new list of VuoSerialDevice elements. More... | |
VuoList_VuoSerialDevice | VuoListCreateWithCount_VuoSerialDevice (const unsigned long count, const VuoSerialDevice value) |
Creates a new list of count instances of value . More... | |
VuoList_VuoSerialDevice | VuoListCopy_VuoSerialDevice (const VuoList_VuoSerialDevice list) |
Makes a shallow copy of list — its items are retained (not copied) by the new list. More... | |
VuoSerialDevice | VuoListGetValue_VuoSerialDevice (const VuoList_VuoSerialDevice list, const unsigned long index) |
Returns the VuoSerialDevice at index . More... | |
VuoSerialDevice * | VuoListGetData_VuoSerialDevice (const VuoList_VuoSerialDevice list) |
Returns a pointer to a C array containing the list items. More... | |
void | VuoListSetValue_VuoSerialDevice (const VuoList_VuoSerialDevice list, const VuoSerialDevice value, const unsigned long index, bool expandListIfNeeded) |
Changes the VuoSerialDevice at index . More... | |
void | VuoListInsertValue_VuoSerialDevice (const VuoList_VuoSerialDevice list, const VuoSerialDevice value, const unsigned long index) |
Inserts the VuoSerialDevice immediately before index . More... | |
void | VuoListPrependValue_VuoSerialDevice (VuoList_VuoSerialDevice list, const VuoSerialDevice value) |
Prepends value to list . More... | |
void | VuoListAppendValue_VuoSerialDevice (VuoList_VuoSerialDevice list, const VuoSerialDevice value) |
Appends value to list . More... | |
void | VuoListExchangeValues_VuoSerialDevice (VuoList_VuoSerialDevice list, const unsigned long indexA, const unsigned long indexB) |
Swaps the value at indexA with the value at indexB . More... | |
void | VuoListShuffle_VuoSerialDevice (VuoList_VuoSerialDevice list, const double chaos) |
Generates a random permutation of list . More... | |
void | VuoListReverse_VuoSerialDevice (VuoList_VuoSerialDevice list) |
Reverses the order of the items in list . More... | |
VuoList_VuoSerialDevice | VuoListSubset_VuoSerialDevice (VuoList_VuoSerialDevice list, const signed long startIndex, const unsigned long itemCount) |
Returns a new list containing items from the original list in the range specified by startIndex and itemCount . More... | |
void | VuoListRemoveFirstValue_VuoSerialDevice (VuoList_VuoSerialDevice list) |
Removes the first value from list . More... | |
void | VuoListRemoveLastValue_VuoSerialDevice (VuoList_VuoSerialDevice list) |
Removes the last value from list . More... | |
void | VuoListRemoveAll_VuoSerialDevice (VuoList_VuoSerialDevice list) |
Removes all values from list . More... | |
void | VuoListRemoveValue_VuoSerialDevice (VuoList_VuoSerialDevice list, const unsigned long index) |
Removes the VuoSerialDevice at index . More... | |
unsigned long | VuoListGetCount_VuoSerialDevice (const VuoList_VuoSerialDevice list) |
Returns the number of elements in list . More... | |
VuoList_VuoSerialDevice | VuoList_VuoSerialDevice_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoList_VuoSerialDevice_getJson (const VuoList_VuoSerialDevice value) |
Encodes value as a JSON object. More... | |
char * | VuoList_VuoSerialDevice_getSummary (const VuoList_VuoSerialDevice value) |
Produces a brief human-readable summary of value . More... | |
VuoList_VuoSerialDevice | VuoList_VuoSerialDevice_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoList_VuoSerialDevice_getString (const VuoList_VuoSerialDevice value) |
Automatically generated function. More... | |
typedef const struct VuoList_VuoSerialDevice_struct * VuoList_VuoSerialDevice |
A list of VuoSerialDevice elements.
struct json_object* VuoList_VuoSerialDevice_getJson | ( | const VuoList_VuoSerialDevice | value | ) |
Encodes value
as a JSON object.
Definition at line 81 of file VuoList_VuoSerialDevice.cc.
char* VuoList_VuoSerialDevice_getString | ( | const VuoList_VuoSerialDevice | value | ) |
Automatically generated function.
char* VuoList_VuoSerialDevice_getSummary | ( | const VuoList_VuoSerialDevice | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 113 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoList_VuoSerialDevice_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoList_VuoSerialDevice_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const VuoSerialDevice | value | ||
) |
Appends value
to list
.
Definition at line 287 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoListCopy_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 165 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoListCreate_VuoSerialDevice | ( | void | ) |
Creates a new list of VuoSerialDevice elements.
Definition at line 151 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoListCreateWithCount_VuoSerialDevice | ( | const unsigned long | count, |
const VuoSerialDevice | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoSerialDevice to quickly initialize a large list.
Definition at line 158 of file VuoList_VuoSerialDevice.cc.
void VuoListExchangeValues_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 297 of file VuoList_VuoSerialDevice.cc.
unsigned long VuoListGetCount_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list | ) |
Returns the number of elements in list
.
Definition at line 532 of file VuoList_VuoSerialDevice.cc.
VuoSerialDevice* VuoListGetData_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list | ) |
Returns a pointer to a C array containing the list items.
Use this if you need a fast way to get or change multiple list items.
You can modify values in the list by changing them in this array. Just don't attempt to access beyond the list size.
The pointer becomes invalid if you modify the list size using other functions (e.g., Insert, Prepend, Append, Cut, Remove); if you use those functions, just get a new pointer by calling this function again.
If the list has no items, returns NULL.
The pointer remains owned by the list; don't free it.
Definition at line 210 of file VuoList_VuoSerialDevice.cc.
VuoSerialDevice VuoListGetValue_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list, |
const unsigned long | index | ||
) |
Returns the VuoSerialDevice at index
.
Index values start at 1. If the list has no items, returns a default value. Attempting to access an out-of-bounds index returns the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
Definition at line 194 of file VuoList_VuoSerialDevice.cc.
void VuoListInsertValue_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list, |
const VuoSerialDevice | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoSerialDevice
immediately before index
.
Index values start at 1. Inserting at index 0 prepends the value to the list. Inserting at an index beyond the last value in the list appends the value to the list.
Definition at line 255 of file VuoList_VuoSerialDevice.cc.
void VuoListPrependValue_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const VuoSerialDevice | value | ||
) |
Prepends value
to list
.
Definition at line 277 of file VuoList_VuoSerialDevice.cc.
void VuoListRemoveAll_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list | ) |
Removes all values from list
.
Definition at line 506 of file VuoList_VuoSerialDevice.cc.
void VuoListRemoveFirstValue_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list | ) |
Removes the first value from list
.
Definition at line 478 of file VuoList_VuoSerialDevice.cc.
void VuoListRemoveLastValue_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list | ) |
Removes the last value from list
.
Definition at line 492 of file VuoList_VuoSerialDevice.cc.
void VuoListRemoveValue_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const unsigned long | index | ||
) |
Removes the VuoSerialDevice
at index
.
Index values start at 1. Attempting to remove index 0 or an index beyond the last value in the list has no effect.
Definition at line 515 of file VuoList_VuoSerialDevice.cc.
void VuoListReverse_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list | ) |
Reverses the order of the items in list
.
Definition at line 401 of file VuoList_VuoSerialDevice.cc.
void VuoListSetValue_VuoSerialDevice | ( | const VuoList_VuoSerialDevice | list, |
const VuoSerialDevice | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoSerialDevice at index
.
Index values start at 1.
If expandListIfNeeded
is false: If the list has no items, nothing is changed. Attempting to change an out-of-bounds index changes the first item in the list (if the index is 0), or last item in the list (if the index is greater than the list size).
If expandListIfNeeded
is true: If the list has less than index
elements, it is expanded to accommodate the specified index
. If index
is 0, the list is resized to contain 1 item set to value
.
Definition at line 220 of file VuoList_VuoSerialDevice.cc.
void VuoListShuffle_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const double | chaos | ||
) |
Generates a random permutation of list
.
chaos
ranges from 0 to 1. When chaos
is 1, a full Fisher–Yates shuffle is performed. When less than 1, fewer iterations are performed.
Definition at line 380 of file VuoList_VuoSerialDevice.cc.
VuoList_VuoSerialDevice VuoListSubset_VuoSerialDevice | ( | VuoList_VuoSerialDevice | list, |
const signed long | startIndex, | ||
const unsigned long | itemCount | ||
) |
Returns a new list containing items from the original list in the range specified by startIndex
and itemCount
.
Items in the new list are retained (not copied) from the original list.
Definition at line 410 of file VuoList_VuoSerialDevice.cc.