Vuo  2.0.0
Macros | Enumerations | Functions
VuoTimeUnit

Description

A delineation of time.

Enumerations

enum  VuoTimeUnit {
  VuoTimeUnit_Millennium, VuoTimeUnit_Century, VuoTimeUnit_Decade, VuoTimeUnit_Year,
  VuoTimeUnit_Quarter, VuoTimeUnit_Month, VuoTimeUnit_WeekSunday, VuoTimeUnit_WeekMonday,
  VuoTimeUnit_Day, VuoTimeUnit_Hour, VuoTimeUnit_HalfHour, VuoTimeUnit_QuarterHour,
  VuoTimeUnit_Minute, VuoTimeUnit_Second
}
 A delineation of time. More...
 

Functions

VuoTimeUnit VuoTimeUnit_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoTimeUnit_getJson (const VuoTimeUnit value)
 Encodes value as a JSON object. More...
 
VuoList_VuoTimeUnit VuoTimeUnit_getAllowedValues (void)
 Returns a list of values that instances of this type can have. More...
 
char * VuoTimeUnit_getSummary (const VuoTimeUnit value)
 Returns a compact string representation of value. More...
 
VuoInteger VuoTimeUnit_getSeconds (const VuoTimeUnit value)
 Returns the number of seconds the specified time unit is worth. More...
 
bool VuoTimeUnit_areEqual (const VuoTimeUnit valueA, const VuoTimeUnit valueB)
 Returns true if the two values are equal. More...
 
bool VuoTimeUnit_isLessThan (const VuoTimeUnit valueA, const VuoTimeUnit valueB)
 Returns true if valueA is less than valueB. More...
 
VuoTimeUnit VuoTimeUnit_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoTimeUnit_getString (const VuoTimeUnit value)
 Automatically generated function. More...
 
void VuoTimeUnit_retain (VuoTimeUnit value)
 Automatically generated function. More...
 
void VuoTimeUnit_release (VuoTimeUnit value)
 Automatically generated function. More...
 

Enumeration Type Documentation

◆ VuoTimeUnit

A delineation of time.

Definition at line 30 of file VuoTimeUnit.h.

Function Documentation

◆ VuoTimeUnit_areEqual()

bool VuoTimeUnit_areEqual ( const VuoTimeUnit  valueA,
const VuoTimeUnit  valueB 
)

Returns true if the two values are equal.

Definition at line 212 of file VuoTimeUnit.c.

◆ VuoTimeUnit_getAllowedValues()

VuoList_VuoTimeUnit VuoTimeUnit_getAllowedValues ( void  )

Returns a list of values that instances of this type can have.

Definition at line 113 of file VuoTimeUnit.c.

◆ VuoTimeUnit_getJson()

struct json_object* VuoTimeUnit_getJson ( const VuoTimeUnit  value)

Encodes value as a JSON object.

Definition at line 76 of file VuoTimeUnit.c.

◆ VuoTimeUnit_getSeconds()

VuoInteger VuoTimeUnit_getSeconds ( const VuoTimeUnit  value)

Returns the number of seconds the specified time unit is worth.

  • Years are 365 days (leap years are ignored)
  • Quarters are 121 days
  • Months are 30 days (28-, 29-, and 31-day months are ignored)

Definition at line 177 of file VuoTimeUnit.c.

◆ VuoTimeUnit_getString()

char* VuoTimeUnit_getString ( const VuoTimeUnit  value)

Automatically generated function.

◆ VuoTimeUnit_getSummary()

char* VuoTimeUnit_getSummary ( const VuoTimeUnit  value)

Returns a compact string representation of value.

Definition at line 136 of file VuoTimeUnit.c.

◆ VuoTimeUnit_isLessThan()

bool VuoTimeUnit_isLessThan ( const VuoTimeUnit  valueA,
const VuoTimeUnit  valueB 
)

Returns true if valueA is less than valueB.

Definition at line 220 of file VuoTimeUnit.c.

◆ VuoTimeUnit_makeFromJson()

VuoTimeUnit VuoTimeUnit_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
"quarter"

Definition at line 35 of file VuoTimeUnit.c.

◆ VuoTimeUnit_makeFromString()

VuoTimeUnit VuoTimeUnit_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoTimeUnit_release()

void VuoTimeUnit_release ( VuoTimeUnit  value)

Automatically generated function.

◆ VuoTimeUnit_retain()

void VuoTimeUnit_retain ( VuoTimeUnit  value)

Automatically generated function.