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

Description

A list of VuoRelativeTime elements.

Classes

struct  VuoList_VuoRelativeTime_struct
 A list of VuoRelativeTime elements. More...
 

Typedefs

typedef struct
VuoList_VuoRelativeTime_struct
VuoList_VuoRelativeTime
 A list of VuoRelativeTime elements.
 

Functions

VuoList_VuoRelativeTime VuoListCreate_VuoRelativeTime (void)
 Creates a new list of VuoRelativeTime elements.
 
VuoList_VuoRelativeTime VuoListCreateWithCount_VuoRelativeTime (const unsigned long count, const VuoRelativeTime value)
 Creates a new list of count instances of value.
 
VuoList_VuoRelativeTime VuoListCopy_VuoRelativeTime (const VuoList_VuoRelativeTime list)
 Makes a shallow copy of list — its items are retained (not copied) by the new list.
 
VuoRelativeTime VuoListGetValue_VuoRelativeTime (const VuoList_VuoRelativeTime list, const unsigned long index)
 Returns the VuoRelativeTime at index.
 
VuoRelativeTimeVuoListGetData_VuoRelativeTime (const VuoList_VuoRelativeTime list)
 Returns a pointer to a C array containing the list items.
 
void VuoListSetValue_VuoRelativeTime (const VuoList_VuoRelativeTime list, const VuoRelativeTime value, const unsigned long index, bool expandListIfNeeded)
 Changes the VuoRelativeTime at index.
 
void VuoListInsertValue_VuoRelativeTime (const VuoList_VuoRelativeTime list, const VuoRelativeTime value, const unsigned long index)
 Inserts the VuoRelativeTime immediately before index.
 
void VuoListPrependValue_VuoRelativeTime (VuoList_VuoRelativeTime list, const VuoRelativeTime value)
 Prepends value to list.
 
void VuoListAppendValue_VuoRelativeTime (VuoList_VuoRelativeTime list, const VuoRelativeTime value)
 Appends value to list.
 
void VuoListExchangeValues_VuoRelativeTime (VuoList_VuoRelativeTime list, const unsigned long indexA, const unsigned long indexB)
 Swaps the value at indexA with the value at indexB.
 
void VuoListShuffle_VuoRelativeTime (VuoList_VuoRelativeTime list, const double chaos)
 Generates a random permutation of list.
 
void VuoListReverse_VuoRelativeTime (VuoList_VuoRelativeTime list)
 Reverses the order of the items in list.
 
VuoList_VuoRelativeTime VuoListSubset_VuoRelativeTime (VuoList_VuoRelativeTime 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_VuoRelativeTime (VuoList_VuoRelativeTime list)
 Removes the first value from list.
 
void VuoListRemoveLastValue_VuoRelativeTime (VuoList_VuoRelativeTime list)
 Removes the last value from list.
 
void VuoListRemoveAll_VuoRelativeTime (VuoList_VuoRelativeTime list)
 Removes all values from list.
 
void VuoListRemoveValue_VuoRelativeTime (VuoList_VuoRelativeTime list, const unsigned long index)
 Removes the VuoRelativeTime at index.
 
unsigned long VuoListGetCount_VuoRelativeTime (const VuoList_VuoRelativeTime list)
 Returns the number of elements in list.
 
VuoList_VuoRelativeTime VuoList_VuoRelativeTime_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoList_VuoRelativeTime_getJson (const VuoList_VuoRelativeTime value)
 Encodes value as a JSON object.
 
char * VuoList_VuoRelativeTime_getSummary (const VuoList_VuoRelativeTime value)
 Produces a brief human-readable summary of value.
 
VuoList_VuoRelativeTime VuoList_VuoRelativeTime_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoList_VuoRelativeTime_getString (const VuoList_VuoRelativeTime value)
 Automatically generated function.
 

Class Documentation

struct VuoList_VuoRelativeTime_struct
Class Members
void * l

Typedef Documentation

typedef struct VuoList_VuoRelativeTime_struct * VuoList_VuoRelativeTime

A list of VuoRelativeTime elements.

Function Documentation

struct json_object* VuoList_VuoRelativeTime_getJson ( const VuoList_VuoRelativeTime  value)
read

Encodes value as a JSON object.

char* VuoList_VuoRelativeTime_getString ( const VuoList_VuoRelativeTime  value)

Automatically generated function.

char* VuoList_VuoRelativeTime_getSummary ( const VuoList_VuoRelativeTime  value)

Produces a brief human-readable summary of value.

VuoList_VuoRelativeTime VuoList_VuoRelativeTime_makeFromJson ( struct json_object js)

Decodes the JSON object js to create a new value.

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

Automatically generated function.

void VuoListAppendValue_VuoRelativeTime ( VuoList_VuoRelativeTime  list,
const VuoRelativeTime  value 
)

Appends value to list.

VuoList_VuoRelativeTime VuoListCopy_VuoRelativeTime ( const VuoList_VuoRelativeTime  list)

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

VuoList_VuoRelativeTime VuoListCreate_VuoRelativeTime ( void  )

Creates a new list of VuoRelativeTime elements.

VuoList_VuoRelativeTime VuoListCreateWithCount_VuoRelativeTime ( const unsigned long  count,
const VuoRelativeTime  value 
)

Creates a new list of count instances of value.

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

void VuoListExchangeValues_VuoRelativeTime ( VuoList_VuoRelativeTime  list,
const unsigned long  indexA,
const unsigned long  indexB 
)

Swaps the value at indexA with the value at indexB.

unsigned long VuoListGetCount_VuoRelativeTime ( const VuoList_VuoRelativeTime  list)

Returns the number of elements in list.

VuoRelativeTime* VuoListGetData_VuoRelativeTime ( const VuoList_VuoRelativeTime  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.

VuoRelativeTime VuoListGetValue_VuoRelativeTime ( const VuoList_VuoRelativeTime  list,
const unsigned long  index 
)

Returns the VuoRelativeTime 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_VuoRelativeTime ( const VuoList_VuoRelativeTime  list,
const VuoRelativeTime  value,
const unsigned long  index 
)

Inserts the VuoRelativeTime 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_VuoRelativeTime ( VuoList_VuoRelativeTime  list,
const VuoRelativeTime  value 
)

Prepends value to list.

void VuoListRemoveAll_VuoRelativeTime ( VuoList_VuoRelativeTime  list)

Removes all values from list.

void VuoListRemoveFirstValue_VuoRelativeTime ( VuoList_VuoRelativeTime  list)

Removes the first value from list.

void VuoListRemoveLastValue_VuoRelativeTime ( VuoList_VuoRelativeTime  list)

Removes the last value from list.

void VuoListRemoveValue_VuoRelativeTime ( VuoList_VuoRelativeTime  list,
const unsigned long  index 
)

Removes the VuoRelativeTime 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_VuoRelativeTime ( VuoList_VuoRelativeTime  list)

Reverses the order of the items in list.

void VuoListSetValue_VuoRelativeTime ( const VuoList_VuoRelativeTime  list,
const VuoRelativeTime  value,
const unsigned long  index,
bool  expandListIfNeeded 
)

Changes the VuoRelativeTime 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_VuoRelativeTime ( VuoList_VuoRelativeTime  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_VuoRelativeTime VuoListSubset_VuoRelativeTime ( VuoList_VuoRelativeTime  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.