VuoRelativeTime

Description

An offset from a Date-Time.

Typedefs
typedef double	VuoRelativeTime
	An offset from a Date-Time. More...

Functions
VuoRelativeTime	VuoRelativeTime_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value. More...
struct json_object *	VuoRelativeTime_getJson (const VuoRelativeTime value)
	Encodes value as a JSON object. More...
char *	VuoRelativeTime_getSummary (const VuoRelativeTime value)
	Returns a compact string representation of value. More...
bool	VuoRelativeTime_areEqual (const VuoRelativeTime valueA, const VuoRelativeTime valueB)
	Returns true if the two values are equal. More...
bool	VuoRelativeTime_isLessThan (const VuoRelativeTime valueA, const VuoRelativeTime valueB)
	Returns true if valueA is less than valueB. More...
VuoRelativeTime	VuoRelativeTime_make (VuoInteger years, VuoInteger months, VuoInteger days, VuoInteger hours, VuoInteger minutes, VuoReal seconds)
	Creates a relative date-time from component values. More...
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. More...
VuoRelativeTime	VuoRelativeTime_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoRelativeTime_getString (const VuoRelativeTime value)
	Automatically generated function. More...
void	VuoRelativeTime_retain (VuoRelativeTime value)
	Automatically generated function. More...
void	VuoRelativeTime_release (VuoRelativeTime value)
	Automatically generated function. More...

Typedef Documentation

VuoRelativeTime

typedef double VuoRelativeTime

An offset from a Date-Time.

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

Definition at line 33 of file VuoRelativeTime.h.

Function Documentation

VuoRelativeTime_areEqual()

bool VuoRelativeTime_areEqual	(	const VuoRelativeTime	valueA,
		const VuoRelativeTime	valueB
	)

Returns true if the two values are equal.

Definition at line 152 of file VuoRelativeTime.c.

VuoRelativeTime_getComponents()

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

relativeTime	The offset to dissect.
years	365 days (leap years are ignored)
months	30 days (28-, 29-, and 31-day months are ignored)
days	24 hours
hours	60 minutes
minutes	60 seconds
seconds	Includes fractional seconds.

Definition at line 188 of file VuoRelativeTime.c.

VuoRelativeTime_getJson()

struct json_object* VuoRelativeTime_getJson

(

const VuoRelativeTime

value

)

Encodes value as a JSON object.

Definition at line 43 of file VuoRelativeTime.c.

VuoRelativeTime_getString()

char* VuoRelativeTime_getString

(

const VuoRelativeTime

value

)

Automatically generated function.

VuoRelativeTime_getSummary()

char* VuoRelativeTime_getSummary

(

const VuoRelativeTime

value

)

Returns a compact string representation of value.

Definition at line 51 of file VuoRelativeTime.c.

VuoRelativeTime_isLessThan()

bool VuoRelativeTime_isLessThan	(	const VuoRelativeTime	valueA,
		const VuoRelativeTime	valueB
	)

Returns true if valueA is less than valueB.

Definition at line 160 of file VuoRelativeTime.c.

VuoRelativeTime_make()

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.

Definition at line 170 of file VuoRelativeTime.c.

VuoRelativeTime_makeFromJson()

VuoRelativeTime VuoRelativeTime_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

42.0 

Definition at line 35 of file VuoRelativeTime.c.

VuoRelativeTime_makeFromString()

VuoRelativeTime VuoRelativeTime_makeFromString

(

const char *

str

)

Automatically generated function.

VuoRelativeTime_release()

void VuoRelativeTime_release

(

VuoRelativeTime

value

)

Automatically generated function.

VuoRelativeTime_retain()

void VuoRelativeTime_retain

(

VuoRelativeTime

value

)

Automatically generated function.