VuoRealRegulation

Description

Parameters describing how to regulate a real number.

Classes
struct	VuoRealRegulation
	Parameters describing how to regulate a real number. More...

Functions
VuoRealRegulation	VuoRealRegulation_makeFromJson (struct json_object *js)
	Decodes the JSON object js to create a new value.
struct json_object *	VuoRealRegulation_getJson (const VuoRealRegulation value)
	Encodes value as a JSON object.
char *	VuoRealRegulation_getSummary (const VuoRealRegulation value)
	Returns a compact string representation of value.
VuoRealRegulation	VuoRealRegulation_make (VuoText name, VuoReal minimumValue, VuoReal maximumValue, VuoReal defaultValue, VuoReal smoothDuration)
	Returns a Real Regulation with the specified values.
char *	VuoRealRegulation_getString (const VuoRealRegulation value)
	Automatically generated function.
void	VuoRealRegulation_retain (VuoRealRegulation value)
	Automatically generated function.
void	VuoRealRegulation_release (VuoRealRegulation value)
	Automatically generated function.

---

Class Documentation

VuoRealRegulation

struct VuoRealRegulation

Class Members
VuoReal	defaultValue
VuoReal	maximumValue
VuoReal	minimumValue
VuoText	name
VuoReal	smoothDuration

Function Documentation

VuoRealRegulation_getJson()

struct json_object * VuoRealRegulation_getJson

(

const VuoRealRegulation

value

)

Encodes value as a JSON object.

Definition at line 54 of file VuoRealRegulation.c.

VuoRealRegulation_getString()

char * VuoRealRegulation_getString

(

const VuoRealRegulation

value

)

Automatically generated function.

VuoRealRegulation_getSummary()

char * VuoRealRegulation_getSummary

(

const VuoRealRegulation

value

)

Returns a compact string representation of value.

Definition at line 68 of file VuoRealRegulation.c.

VuoRealRegulation_make()

VuoRealRegulation VuoRealRegulation_make	(	VuoText	name,
		VuoReal	minimumValue,
		VuoReal	maximumValue,
		VuoReal	defaultValue,
		VuoReal	smoothDuration
	)

Returns a Real Regulation with the specified values.

Definition at line 76 of file VuoRealRegulation.c.

VuoRealRegulation_makeFromJson()

VuoRealRegulation VuoRealRegulation_makeFromJson

(

json_object *

js

)

Decodes the JSON object js to create a new value.

Example:

{
  "name" : "",
  "minimumValue" : 0,
  "maximumValue" : 1,
  "defaultValue" : 0.5,
  "smoothDuration" : 2
}

Definition at line 40 of file VuoRealRegulation.c.

VuoRealRegulation_release()

void VuoRealRegulation_release

(

VuoRealRegulation

value

)

Automatically generated function.

VuoRealRegulation_retain()

void VuoRealRegulation_retain

(

VuoRealRegulation

value

)

Automatically generated function.