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

Description

An offset from a Date-Time.

Typedefs

typedef double VuoRelativeTime
 An offset from a Date-Time.
 

Functions

VuoRelativeTime VuoRelativeTime_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value.
 
struct json_objectVuoRelativeTime_getJson (const VuoRelativeTime value)
 Encodes value as a JSON object.
 
char * VuoRelativeTime_getSummary (const VuoRelativeTime value)
 Returns a compact string representation of value.
 
bool VuoRelativeTime_areEqual (const VuoRelativeTime valueA, const VuoRelativeTime valueB)
 Returns true if the two values are equal.
 
bool VuoRelativeTime_isLessThan (const VuoRelativeTime valueA, const VuoRelativeTime valueB)
 Returns true if valueA is less than valueB.
 
VuoRelativeTime VuoRelativeTime_make (VuoInteger years, VuoInteger months, VuoInteger days, VuoInteger hours, VuoInteger minutes, VuoReal seconds)
 Creates a relative date-time from component values.
 
void VuoRelativeTime_getComponents (VuoRelativeTime relativeTime, VuoInteger *years, VuoInteger *months, VuoInteger *days, VuoInteger *hours, VuoInteger *minutes, VuoReal *seconds)
 Splits a given relativeTime into its human-readable parts.
 
VuoRelativeTime VuoRelativeTime_makeFromString (const char *str)
 Automatically generated function.
 
char * VuoRelativeTime_getString (const VuoRelativeTime value)
 Automatically generated function.
 
void VuoRelativeTime_retain (VuoRelativeTime value)
 Automatically generated function.
 
void VuoRelativeTime_release (VuoRelativeTime value)
 Automatically generated function.
 

Typedef Documentation

typedef double VuoRelativeTime

An offset from a Date-Time.

The number of seconds since another time, including fractional seconds.

Function Documentation

bool VuoRelativeTime_areEqual ( const VuoRelativeTime  valueA,
const VuoRelativeTime  valueB 
)

Returns true if the two values are equal.

void VuoRelativeTime_getComponents ( VuoRelativeTime  relativeTime,
VuoInteger years,
VuoInteger months,
VuoInteger days,
VuoInteger hours,
VuoInteger minutes,
VuoReal seconds 
)

Splits a given relativeTime into its human-readable parts.

It's OK to pass NULL for any of the output pointers.

Parameters
relativeTimeThe offset to dissect.
years365 days (leap years are ignored)
months30 days (28-, 29-, and 31-day months are ignored)
days24 hours
hours60 minutes
minutes60 seconds
secondsIncludes fractional seconds.
struct json_object* VuoRelativeTime_getJson ( const VuoRelativeTime  value)
read

Encodes value as a JSON object.

char* VuoRelativeTime_getString ( const VuoRelativeTime  value)

Automatically generated function.

char* VuoRelativeTime_getSummary ( const VuoRelativeTime  value)

Returns a compact string representation of value.

bool VuoRelativeTime_isLessThan ( const VuoRelativeTime  valueA,
const VuoRelativeTime  valueB 
)

Returns true if valueA is less than valueB.

VuoRelativeTime VuoRelativeTime_make ( VuoInteger  years,
VuoInteger  months,
VuoInteger  days,
VuoInteger  hours,
VuoInteger  minutes,
VuoReal  seconds 
)

Creates a relative date-time from component values.

See VuoRelativeTime_getComponents for parameter definitions.

VuoRelativeTime VuoRelativeTime_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

Example:
42.0
VuoRelativeTime VuoRelativeTime_makeFromString ( const char *  str)

Automatically generated function.

void VuoRelativeTime_release ( VuoRelativeTime  value)

Automatically generated function.

void VuoRelativeTime_retain ( VuoRelativeTime  value)

Automatically generated function.