Vuo  2.3.2
Classes | Macros | Functions
VuoIntegerRange.h File Reference

Description

VuoIntegerRange C type definition.

Definition in file VuoIntegerRange.h.

Go to the source code of this file.

Classes

struct  VuoIntegerRange
 Defines an int range with an optionally bound/unbound min/max. More...
 

Macros

#define VuoIntegerRange_NoMinimum   INT64_MIN
 VuoIntegerRange.minimum's value when the range has no minimum. More...
 
#define VuoIntegerRange_NoMaximum   INT64_MAX
 VuoIntegerRange.maximum's value when the range has no maximum. More...
 

Functions

VuoIntegerRange VuoIntegerRange_makeFromJson (struct json_object *js)
 Decodes the JSON object js to create a new value. More...
 
struct json_objectVuoIntegerRange_getJson (const VuoIntegerRange value)
 Encodes value as a JSON object. More...
 
char * VuoIntegerRange_getSummary (const VuoIntegerRange value)
 Returns a compact string representation of value. More...
 
static VuoIntegerRange VuoIntegerRange_make (VuoInteger _minimum, VuoInteger _maximum) __attribute__((const))
 Creates an integer range. More...
 
static bool VuoIntegerRange_isInverted (VuoIntegerRange range) __attribute__((const))
 Returns true if the range is inverted (min greater than max). More...
 
static VuoIntegerRange VuoIntegerRange_getOrderedRange (VuoIntegerRange range) __attribute__((const))
 Returns a range where the min is never greater than the max. More...
 
VuoIntegerRange VuoIntegerRange_makeFromString (const char *str)
 Automatically generated function. More...
 
char * VuoIntegerRange_getString (const VuoIntegerRange value)
 Automatically generated function. More...
 
void VuoIntegerRange_retain (VuoIntegerRange value)
 Automatically generated function. More...
 
void VuoIntegerRange_release (VuoIntegerRange value)
 Automatically generated function. More...
 

Class Documentation

◆ VuoIntegerRange

struct VuoIntegerRange
Class Members
VuoInteger maximum
VuoInteger minimum

Macro Definition Documentation

◆ VuoIntegerRange_NoMaximum

#define VuoIntegerRange_NoMaximum   INT64_MAX

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

Definition at line 17 of file VuoIntegerRange.h.

◆ VuoIntegerRange_NoMinimum

#define VuoIntegerRange_NoMinimum   INT64_MIN

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

Definition at line 15 of file VuoIntegerRange.h.

Function Documentation

◆ VuoIntegerRange_getJson()

struct json_object* VuoIntegerRange_getJson ( const VuoIntegerRange  value)

Encodes value as a JSON object.

Definition at line 50 of file VuoIntegerRange.c.

◆ VuoIntegerRange_getOrderedRange()

static VuoIntegerRange VuoIntegerRange_getOrderedRange ( VuoIntegerRange  range) const
inlinestatic

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

Definition at line 66 of file VuoIntegerRange.h.

◆ VuoIntegerRange_getString()

char* VuoIntegerRange_getString ( const VuoIntegerRange  value)

Automatically generated function.

◆ VuoIntegerRange_getSummary()

char* VuoIntegerRange_getSummary ( const VuoIntegerRange  value)

Returns a compact string representation of value.

Definition at line 74 of file VuoIntegerRange.c.

◆ VuoIntegerRange_isInverted()

static bool VuoIntegerRange_isInverted ( VuoIntegerRange  range) const
inlinestatic

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

Definition at line 57 of file VuoIntegerRange.h.

◆ VuoIntegerRange_make()

static VuoIntegerRange VuoIntegerRange_make ( VuoInteger  _minimum,
VuoInteger  _maximum 
) const
inlinestatic

Creates an integer range.

Definition at line 48 of file VuoIntegerRange.h.

◆ VuoIntegerRange_makeFromJson()

VuoIntegerRange VuoIntegerRange_makeFromJson ( json_object js)

Decodes the JSON object js to create a new value.

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

Definition at line 38 of file VuoIntegerRange.c.

◆ VuoIntegerRange_makeFromString()

VuoIntegerRange VuoIntegerRange_makeFromString ( const char *  str)

Automatically generated function.

◆ VuoIntegerRange_release()

void VuoIntegerRange_release ( VuoIntegerRange  value)

Automatically generated function.

◆ VuoIntegerRange_retain()

void VuoIntegerRange_retain ( VuoIntegerRange  value)

Automatically generated function.