Vuo  0.4.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Functions
Type Methods

Description

Functions to serialize, unserialize, and summarize values of the type.

Functions

MyType MyType_valueFromJson (json_object *js)
 Creates a new MyType value by unserializing a JSON-C object.
 
json_object * MyType_jsonFromValue (const MyType value)
 Serializes a MyType value to a JSON-C object.
 
char * MyType_summaryFromValue (const MyType value)
 Returns a brief description of a value.
 
char * MyType_interprocessStringFromValue (const MyType value)
 

Function Documentation

char* MyType_interprocessStringFromValue ( const MyType  value)
Todo:
https://b33p.net/kosada/node/5611

This function is optional.

json_object* MyType_jsonFromValue ( const MyType  value)

Serializes a MyType value to a JSON-C object.

This function is required.

Parameters
valueThe value to serialize.
Returns
A JSON-C object. It should have the same format as the argument to MyType_valueFromJson.
char* MyType_summaryFromValue ( const MyType  value)

Returns a brief description of a value.

This function is required.

Parameters
valueThe value to summarize.
Returns
The summary. It should be heap-allocated; the caller is responsible for freeing it.
MyType MyType_valueFromJson ( json_object *  js)

Creates a new MyType value by unserializing a JSON-C object.

This function is required.

Parameters
jsA JSON-C object from MyType_jsonFromValue, a constant port value defined in a composition, or a default port value defined in a node class implementation.
Returns
The unserialized value. For heap-allocated types, this function should register the value with vuoRegister.