VuoRange.h File Reference

Description

VuoRange C type definition.

Copyright

Copyright © 2012–2014 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see http://vuo.org/license.

Classes
struct	VuoRange
	Defines a range with an optionally bound/unbound min/max. More...

Macros
#define	VuoRange_NoMinimum   -INFINITY
	VuoRange.minimum's value when the range has no minimum. More...
#define	VuoRange_NoMaximum   INFINITY
	VuoRange.maximum's value when the range has no maximum. More...

Functions
VuoRange	VuoRange_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value. More...
struct json_object *	VuoRange_getJson (const VuoRange value)
	Encodes value as a JSON object. More...
char *	VuoRange_getSummary (const VuoRange value)
	Returns a compact string representation of value. More...
static VuoRange	VuoRange_make (VuoReal _minimum, VuoReal _maximum) __attribute__((const))
	Creates a range. More...
static bool	VuoRange_isInverted (VuoRange range) __attribute__((const))
	Returns true if the range is inverted (min greater than max). More...
static VuoRange	VuoRange_getOrderedRange (VuoRange range) __attribute__((const))
	Returns a range where the min is never greater than the max. More...
static VuoRange	VuoRange_makeNonzero (VuoRange a) __attribute__((const))
	If the range is empty (minimum == maximum), increases the maximum. More...
VuoRange	VuoRange_makeFromString (const char *str)
	Automatically generated function. More...
char *	VuoRange_getString (const VuoRange value)
	Automatically generated function. More...
void	VuoRange_retain (VuoRange value)
	Automatically generated function. More...
void	VuoRange_release (VuoRange value)
	Automatically generated function. More...

---

Class Documentation

VuoRange

struct VuoRange

Class Members
char	blah[42]	Todo: https://b33p.net/kosada/node/4124
VuoReal	maximum
VuoReal	minimum

Macro Definition Documentation

VuoRange_NoMaximum

#define VuoRange_NoMaximum   INFINITY

VuoRange.maximum's value when the range has no maximum.

VuoRange_NoMinimum

#define VuoRange_NoMinimum   -INFINITY

VuoRange.minimum's value when the range has no minimum.

Function Documentation

VuoRange_getJson()

struct json_object* VuoRange_getJson

(

const VuoRange

value

)

Encodes value as a JSON object.

VuoRange_getOrderedRange()

static VuoRange VuoRange_getOrderedRange ( VuoRange  range ) const

inlinestatic

Returns a range where the min is never greater than the max.

VuoRange_getString()

char* VuoRange_getString

(

const VuoRange

value

)

Automatically generated function.

VuoRange_getSummary()

char* VuoRange_getSummary

(

const VuoRange

value

)

Returns a compact string representation of value.

VuoRange_isInverted()

static bool VuoRange_isInverted ( VuoRange  range ) const

inlinestatic

Returns true if the range is inverted (min greater than max).

VuoRange_make()

static VuoRange VuoRange_make ( VuoReal  _minimum, VuoReal  _maximum  ) const

inlinestatic

Creates a range.

VuoRange_makeFromJson()

VuoRange VuoRange_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

{
   "minimum" : 0.0,
   "maximum" : 42.0
}

VuoRange_makeFromString()

VuoRange VuoRange_makeFromString

(

const char *

str

)

Automatically generated function.

VuoRange_makeNonzero()

static VuoRange VuoRange_makeNonzero ( VuoRange  a ) const

inlinestatic

If the range is empty (minimum == maximum), increases the maximum.

VuoRange_release()

void VuoRange_release

(

VuoRange

value

)

Automatically generated function.

VuoRange_retain()

void VuoRange_retain

(

VuoRange

value

)

Automatically generated function.