Vuo
2.0.0
|
Information about a serial I/O device.
Classes | |
struct | VuoSerialDevice |
Information about a serial I/O device. More... | |
Enumerations | |
enum | VuoSerialDevice_MatchType { VuoSerialDevice_MatchName, VuoSerialDevice_MatchPath } |
Which field to match on. More... | |
Functions | |
VuoSerialDevice | VuoSerialDevice_makeFromJson (struct json_object *js) |
Decodes the JSON object js to create a new value. More... | |
struct json_object * | VuoSerialDevice_getJson (const VuoSerialDevice value) |
Encodes value as a JSON object. More... | |
char * | VuoSerialDevice_getSummary (const VuoSerialDevice value) |
Returns a compact string representation of value . More... | |
bool | VuoSerialDevice_areEqual (const VuoSerialDevice valueA, const VuoSerialDevice valueB) |
Returns true if the two values are equal. More... | |
bool | VuoSerialDevice_isLessThan (const VuoSerialDevice valueA, const VuoSerialDevice valueB) |
Returns true if valueA is less than valueB . More... | |
bool | VuoSerialDevice_realize (VuoSerialDevice device, VuoSerialDevice *realizedDevice) VuoWarnUnusedResult |
If device specifies name-matching: More... | |
VuoSerialDevice | VuoSerialDevice_makeFromString (const char *str) |
Automatically generated function. More... | |
char * | VuoSerialDevice_getString (const VuoSerialDevice value) |
Automatically generated function. More... | |
void | VuoSerialDevice_retain (VuoSerialDevice value) |
Automatically generated function. More... | |
void | VuoSerialDevice_release (VuoSerialDevice value) |
Automatically generated function. More... | |
struct VuoSerialDevice |
Class Members | ||
---|---|---|
VuoSerialDevice_MatchType | matchType | Which field to use for matching a VuoSerialDevice structure to an actual device. |
VuoText | name | The device's display name. |
VuoText | path | The POSIX filesystem path to the device file. |
Which field to match on.
Definition at line 25 of file VuoSerialDevice.h.
bool VuoSerialDevice_areEqual | ( | const VuoSerialDevice | valueA, |
const VuoSerialDevice | valueB | ||
) |
Returns true if the two values are equal.
Definition at line 99 of file VuoSerialDevice.c.
struct json_object* VuoSerialDevice_getJson | ( | const VuoSerialDevice | value | ) |
Encodes value
as a JSON object.
Definition at line 74 of file VuoSerialDevice.c.
char* VuoSerialDevice_getString | ( | const VuoSerialDevice | value | ) |
Automatically generated function.
char* VuoSerialDevice_getSummary | ( | const VuoSerialDevice | value | ) |
Returns a compact string representation of value
.
Definition at line 188 of file VuoSerialDevice.c.
bool VuoSerialDevice_isLessThan | ( | const VuoSerialDevice | valueA, |
const VuoSerialDevice | valueB | ||
) |
Returns true if valueA
is less than valueB
.
Definition at line 116 of file VuoSerialDevice.c.
VuoSerialDevice VuoSerialDevice_makeFromJson | ( | json_object * | js | ) |
Decodes the JSON object js
to create a new value.
Definition at line 62 of file VuoSerialDevice.c.
VuoSerialDevice VuoSerialDevice_makeFromString | ( | const char * | str | ) |
Automatically generated function.
bool VuoSerialDevice_realize | ( | VuoSerialDevice | device, |
VuoSerialDevice * | realizedDevice | ||
) |
If device
specifies name-matching:
realizedDevice
to a specific, existing device matched by its POSIX path, and returns true.realizedDevice
unset.If device
specifies path-matching, sets realizedDevice
to a copy of device
, and returns true. (Doesn't bother checking whether the path actually exists.)
Definition at line 130 of file VuoSerialDevice.c.
void VuoSerialDevice_release | ( | VuoSerialDevice | value | ) |
Automatically generated function.
void VuoSerialDevice_retain | ( | VuoSerialDevice | value | ) |
Automatically generated function.