Vuo  1.2.6
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Typedefs | Functions
VuoList_VuoOscMessage

Description

A list of VuoOscMessage elements.

Classes

struct  VuoList_VuoOscMessage_struct
 A list of VuoOscMessage elements. More...
 

Typedefs

typedef struct
VuoList_VuoOscMessage_struct
VuoList_VuoOscMessage
 A list of VuoOscMessage elements.
 

Functions

VuoList_VuoOscMessage VuoListCreate_VuoOscMessage (void)
 Creates a new list of VuoOscMessage elements.
 
VuoList_VuoOscMessage VuoListCreateWithCount_VuoOscMessage (const unsigned long count, const VuoOscMessage value)
 Creates a new list of count instances of value.
 
VuoList_VuoOscMessage VuoListCopy_VuoOscMessage (const VuoList_VuoOscMessage list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoOscMessage VuoListGetValue_VuoOscMessage (const VuoList_VuoOscMessage list, const unsigned long index)
 Returns the VuoOscMessage at index.
 
VuoOscMessageVuoListGetData_VuoOscMessage (const VuoList_VuoOscMessage list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoOscMessage (const VuoList_VuoOscMessage list, const VuoOscMessage value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoOscMessage at index.
 
void VuoListInsertValue_VuoOscMessage (const VuoList_VuoOscMessage list, const VuoOscMessage value, const unsigned long index)
 Inserts the VuoOscMessage immediately before index.
 
void VuoListPrependValue_VuoOscMessage (VuoList_VuoOscMessage list, const VuoOscMessage value)
 Prepends value to list.
 
void VuoListAppendValue_VuoOscMessage (VuoList_VuoOscMessage list, const VuoOscMessage value)
 Appends value to list.
 
void VuoListExchangeValues_VuoOscMessage (VuoList_VuoOscMessage list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoOscMessage (VuoList_VuoOscMessage list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoOscMessage (VuoList_VuoOscMessage list)
 Reverses the order of the items in list.
 
VuoList_VuoOscMessage VuoListSubset_VuoOscMessage (VuoList_VuoOscMessage 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.
 
void VuoListRemoveFirstValue_VuoOscMessage (VuoList_VuoOscMessage list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoOscMessage (VuoList_VuoOscMessage list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoOscMessage (VuoList_VuoOscMessage list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoOscMessage (VuoList_VuoOscMessage list, const unsigned long index)
 Removes the VuoOscMessage at index.
 
unsigned long VuoListGetCount_VuoOscMessage (const VuoList_VuoOscMessage list)
 Returns the number of elements in list.
 
VuoList_VuoOscMessage VuoList_VuoOscMessage_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoOscMessage_getJson (const VuoList_VuoOscMessage value)
 Encodes value as a JSON object.
 
char * VuoList_VuoOscMessage_getSummary (const VuoList_VuoOscMessage value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoOscMessage VuoList_VuoOscMessage_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoOscMessage_getString (const VuoList_VuoOscMessage value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoOscMessage_struct
Class Members
void * l

Typedef Documentation

A list of VuoOscMessage elements.

Function Documentation

struct json_object* VuoList_VuoOscMessage_getJson ( const VuoList_VuoOscMessage  value)
read

Encodes value as a JSON object.

char* VuoList_VuoOscMessage_getString ( const VuoList_VuoOscMessage  value)

Automatically generated function.

char* VuoList_VuoOscMessage_getSummary ( const VuoList_VuoOscMessage  value)

Produces a brief human-readable summary of value.

VuoList_VuoOscMessage VuoList_VuoOscMessage_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

Example:
["uno", "dos", "tres", "catorce"]
VuoList_VuoOscMessage VuoList_VuoOscMessage_makeFromString ( const char *  str)

Automatically generated function.

void VuoListAppendValue_VuoOscMessage ( VuoList_VuoOscMessage  list,
const VuoOscMessage  value 
)

Appends value to list.

VuoList_VuoOscMessage VuoListCopy_VuoOscMessage ( const VuoList_VuoOscMessage  list)

Makes a shallow copy of list — its items are retained (not copied) by the new list.

VuoList_VuoOscMessage VuoListCreate_VuoOscMessage ( void  )

Creates a new list of VuoOscMessage elements.

VuoList_VuoOscMessage VuoListCreateWithCount_VuoOscMessage ( const unsigned long  count,
const VuoOscMessage  value 
)

Creates a new list of count instances of value.

Use this in conjunction with VuoListGetData_VuoOscMessage to quickly initialize a large list.

void VuoListExchangeValues_VuoOscMessage ( VuoList_VuoOscMessage  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoOscMessage ( const VuoList_VuoOscMessage  list)

Returns the number of elements in list.

VuoOscMessage* VuoListGetData_VuoOscMessage ( const VuoList_VuoOscMessage  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.

VuoOscMessage VuoListGetValue_VuoOscMessage ( const VuoList_VuoOscMessage  list,
const unsigned long  index 
)

Returns the VuoOscMessage 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).

void VuoListInsertValue_VuoOscMessage ( const VuoList_VuoOscMessage  list,
const VuoOscMessage  value,
const unsigned long  index 
)

Inserts the VuoOscMessage 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.

void VuoListPrependValue_VuoOscMessage ( VuoList_VuoOscMessage  list,
const VuoOscMessage  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoOscMessage ( VuoList_VuoOscMessage  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoOscMessage ( VuoList_VuoOscMessage  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoOscMessage ( VuoList_VuoOscMessage  list)

Removes the last value from list.

void VuoListRemoveValue_VuoOscMessage ( VuoList_VuoOscMessage  list,
const unsigned long  index 
)

Removes the VuoOscMessage 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.

void VuoListReverse_VuoOscMessage ( VuoList_VuoOscMessage  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoOscMessage ( const VuoList_VuoOscMessage  list,
const VuoOscMessage  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoOscMessage 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.

void VuoListShuffle_VuoOscMessage ( VuoList_VuoOscMessage  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.

VuoList_VuoOscMessage VuoListSubset_VuoOscMessage ( VuoList_VuoOscMessage  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.