Vuo
2.1.1
|
A list of VuoSyphonServerDescription elements.
Classes | |
struct | VuoList_VuoSyphonServerDescription_struct |
A list of VuoSyphonServerDescription elements. More... | |
Typedefs | |
typedef const struct VuoList_VuoSyphonServerDescription_struct * | VuoList_VuoSyphonServerDescription |
A list of VuoSyphonServerDescription elements. More... | |
typedef const struct VuoList_VuoSyphonServerDescription_struct * VuoList_VuoSyphonServerDescription |
A list of VuoSyphonServerDescription elements.
struct json_object* VuoList_VuoSyphonServerDescription_getJson | ( | const VuoList_VuoSyphonServerDescription | value | ) |
Encodes value
as a JSON object.
Definition at line 84 of file VuoList_VuoSyphonServerDescription.cc.
char* VuoList_VuoSyphonServerDescription_getString | ( | const VuoList_VuoSyphonServerDescription | value | ) |
Automatically generated function.
char* VuoList_VuoSyphonServerDescription_getSummary | ( | const VuoList_VuoSyphonServerDescription | value | ) |
Produces a brief human-readable summary of value
.
Definition at line 119 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoList_VuoSyphonServerDescription_makeFromJson | ( | struct json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 63 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoList_VuoSyphonServerDescription_makeFromString | ( | const char * | str | ) |
Automatically generated function.
void VuoListAppendValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value | ||
) |
Appends value
to list
.
Definition at line 308 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoListCopy_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list | ) |
Makes a shallow copy of list
— its items are retained (not copied) by the new list.
Definition at line 174 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoListCreate_VuoSyphonServerDescription | ( | void | ) |
Creates a new list of VuoSyphonServerDescription elements.
Definition at line 154 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoListCreateWithCount_VuoSyphonServerDescription | ( | const unsigned long | count, |
const VuoSyphonServerDescription | value | ||
) |
Creates a new list of count
instances of value
.
Use this in conjunction with VuoListGetData_VuoSyphonServerDescription to quickly initialize a large list.
Definition at line 161 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListExchangeValues_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const unsigned long | indexA, | ||
const unsigned long | indexB | ||
) |
Swaps the value at indexA
with the value at indexB
.
Definition at line 318 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListForeach_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
bool(^)(const VuoSyphonServerDescription value) | function | ||
) |
Applies function
to each of list
's items, serially in order of index.
If function
returns false, visiting will stop immediately (possibly before all items have been visited).
Definition at line 229 of file VuoList_VuoSyphonServerDescription.cc.
unsigned long VuoListGetCount_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list | ) |
Returns the number of elements in list
.
Definition at line 553 of file VuoList_VuoSyphonServerDescription.cc.
VuoSyphonServerDescription* VuoListGetData_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | 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 219 of file VuoList_VuoSyphonServerDescription.cc.
VuoSyphonServerDescription VuoListGetValue_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const unsigned long | index | ||
) |
Returns the VuoSyphonServerDescription 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).
If iterating over an entire list, consider using VuoListGetData_VuoSyphonServerDescription or VuoListForeach_VuoSyphonServerDescription.
Definition at line 203 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListInsertValue_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value, | ||
const unsigned long | index | ||
) |
Inserts the VuoSyphonServerDescription
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 276 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListPrependValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value | ||
) |
Prepends value
to list
.
Definition at line 298 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListRemoveAll_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes all values from list
.
Definition at line 527 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListRemoveFirstValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes the first value from list
.
Definition at line 499 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListRemoveLastValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Removes the last value from list
.
Definition at line 513 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListRemoveValue_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list, |
const unsigned long | index | ||
) |
Removes the VuoSyphonServerDescription
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 536 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListReverse_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | list | ) |
Reverses the order of the items in list
.
Definition at line 422 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListSetValue_VuoSyphonServerDescription | ( | const VuoList_VuoSyphonServerDescription | list, |
const VuoSyphonServerDescription | value, | ||
const unsigned long | index, | ||
bool | expandListIfNeeded | ||
) |
Changes the VuoSyphonServerDescription 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 241 of file VuoList_VuoSyphonServerDescription.cc.
void VuoListShuffle_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | 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 401 of file VuoList_VuoSyphonServerDescription.cc.
VuoList_VuoSyphonServerDescription VuoListSubset_VuoSyphonServerDescription | ( | VuoList_VuoSyphonServerDescription | 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 431 of file VuoList_VuoSyphonServerDescription.cc.