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

Description

A list of VuoTimeUnit elements.

Classes

struct  VuoList_VuoTimeUnit_struct
 A list of VuoTimeUnit elements. More...
 

Typedefs

typedef struct
VuoList_VuoTimeUnit_struct
VuoList_VuoTimeUnit
 A list of VuoTimeUnit elements.
 

Functions

VuoList_VuoTimeUnit VuoListCreate_VuoTimeUnit (void)
 Creates a new list of VuoTimeUnit elements.
 
VuoList_VuoTimeUnit VuoListCreateWithCount_VuoTimeUnit (const unsigned long count, const VuoTimeUnit value)
 Creates a new list of count instances of value.
 
VuoList_VuoTimeUnit VuoListCopy_VuoTimeUnit (const VuoList_VuoTimeUnit list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoTimeUnit VuoListGetValue_VuoTimeUnit (const VuoList_VuoTimeUnit list, const unsigned long index)
 Returns the VuoTimeUnit at index.
 
VuoTimeUnitVuoListGetData_VuoTimeUnit (const VuoList_VuoTimeUnit list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoTimeUnit (const VuoList_VuoTimeUnit list, const VuoTimeUnit value, const unsigned long index)
 Changes the VuoTimeUnit at index.
 
void VuoListInsertValue_VuoTimeUnit (const VuoList_VuoTimeUnit list, const VuoTimeUnit value, const unsigned long index)
 Inserts the VuoTimeUnit immediately before index.
 
void VuoListPrependValue_VuoTimeUnit (VuoList_VuoTimeUnit list, const VuoTimeUnit value)
 Prepends value to list.
 
void VuoListAppendValue_VuoTimeUnit (VuoList_VuoTimeUnit list, const VuoTimeUnit value)
 Appends value to list.
 
void VuoListExchangeValues_VuoTimeUnit (VuoList_VuoTimeUnit list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoTimeUnit (VuoList_VuoTimeUnit list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoTimeUnit (VuoList_VuoTimeUnit list)
 Reverses the order of the items in list.
 
void VuoListCut_VuoTimeUnit (VuoList_VuoTimeUnit list, const signed long startIndex, const unsigned long itemCount)
 Removes items from the list except those in the range specified by startIndex and itemCount.
 
void VuoListRemoveFirstValue_VuoTimeUnit (VuoList_VuoTimeUnit list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoTimeUnit (VuoList_VuoTimeUnit list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoTimeUnit (VuoList_VuoTimeUnit list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoTimeUnit (VuoList_VuoTimeUnit list, const unsigned long index)
 Removes the VuoTimeUnit at index.
 
unsigned long VuoListGetCount_VuoTimeUnit (const VuoList_VuoTimeUnit list)
 Returns the number of elements in list.
 
VuoList_VuoTimeUnit VuoList_VuoTimeUnit_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoTimeUnit_getJson (const VuoList_VuoTimeUnit value)
 Encodes value as a JSON object.
 
char * VuoList_VuoTimeUnit_getSummary (const VuoList_VuoTimeUnit value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoTimeUnit VuoList_VuoTimeUnit_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoTimeUnit_getString (const VuoList_VuoTimeUnit value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoTimeUnit_struct
Class Members
void * l

Typedef Documentation

typedef struct VuoList_VuoTimeUnit_struct * VuoList_VuoTimeUnit

A list of VuoTimeUnit elements.

Function Documentation

struct json_object* VuoList_VuoTimeUnit_getJson ( const VuoList_VuoTimeUnit  value)
read

Encodes value as a JSON object.

char* VuoList_VuoTimeUnit_getString ( const VuoList_VuoTimeUnit  value)

Automatically generated function.

char* VuoList_VuoTimeUnit_getSummary ( const VuoList_VuoTimeUnit  value)

Produces a brief human-readable summary of value.

VuoList_VuoTimeUnit VuoList_VuoTimeUnit_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoTimeUnit ( VuoList_VuoTimeUnit  list,
const VuoTimeUnit  value 
)

Appends value to list.

VuoList_VuoTimeUnit VuoListCopy_VuoTimeUnit ( const VuoList_VuoTimeUnit  list)

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

VuoList_VuoTimeUnit VuoListCreate_VuoTimeUnit ( void  )

Creates a new list of VuoTimeUnit elements.

VuoList_VuoTimeUnit VuoListCreateWithCount_VuoTimeUnit ( const unsigned long  count,
const VuoTimeUnit  value 
)

Creates a new list of count instances of value.

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

void VuoListCut_VuoTimeUnit ( VuoList_VuoTimeUnit  list,
const signed long  startIndex,
const unsigned long  itemCount 
)

Removes items from the list except those in the range specified by startIndex and itemCount.

void VuoListExchangeValues_VuoTimeUnit ( VuoList_VuoTimeUnit  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoTimeUnit ( const VuoList_VuoTimeUnit  list)

Returns the number of elements in list.

VuoTimeUnit* VuoListGetData_VuoTimeUnit ( const VuoList_VuoTimeUnit  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.

VuoTimeUnit VuoListGetValue_VuoTimeUnit ( const VuoList_VuoTimeUnit  list,
const unsigned long  index 
)

Returns the VuoTimeUnit 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_VuoTimeUnit ( const VuoList_VuoTimeUnit  list,
const VuoTimeUnit  value,
const unsigned long  index 
)

Inserts the VuoTimeUnit 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_VuoTimeUnit ( VuoList_VuoTimeUnit  list,
const VuoTimeUnit  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoTimeUnit ( VuoList_VuoTimeUnit  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoTimeUnit ( VuoList_VuoTimeUnit  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoTimeUnit ( VuoList_VuoTimeUnit  list)

Removes the last value from list.

void VuoListRemoveValue_VuoTimeUnit ( VuoList_VuoTimeUnit  list,
const unsigned long  index 
)

Removes the VuoTimeUnit 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_VuoTimeUnit ( VuoList_VuoTimeUnit  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoTimeUnit ( const VuoList_VuoTimeUnit  list,
const VuoTimeUnit  value,
const unsigned long  index 
)

Changes the VuoTimeUnit at index.

Index values start at 1. 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).

void VuoListShuffle_VuoTimeUnit ( VuoList_VuoTimeUnit  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.