IVI-C Data Model

This is the data available to layout templates for IVI-C drivers. See the overview for conventions and the shared sub-context shapes. Properties marked HTML are pre-formatted — render them with the triple brace. IVI-C syntax contexts provide C: syntax.code.

Common reference shapes

Branch reference (branch) and Library reference (library): name, link.

Parameter (items of parameters, for functions and callbacks):

Property	Type	Description
name	text	Parameter name.
description	text	Help summary.
type	text	C type.
typeHtml	HTML	C type, linked.
direction	text	In, Out, or InOut.
modifier	text	[in], [out], or [in,out].
isArray, isOut, isRepCapIdentifier	bool	Parameter flags.

Defined values (definedValues, the enum values valid for a parameter or return value): each section has parameterKind (Parameter or Return Value), parameterName, and items where each item has prefixedName, value, description.

Member summary (items of functions, attributes, callbacks, childBranches): name, prefixedName, link, summary.

Function

Property	Type	Description
name, prefixedName	text	Function name, and the full prefixed name.
treeNodePath	text	Location in the driver tree.
summary, link	text	Summary and link.
parameters / hasParameters	section / bool	Parameters (items) and a flag.
definedValues	list	Defined-value sections for enum parameters.
commands / hasCommands	object / bool	Instrument commands (isSingle, command, items) and a flag.
supportedModels	object	Multi-model support (models).
branch, library	refs	Parent branch and library.
syntax	object	syntax.code (HTML, the C signature).
errorsWarningsLink	text	Link to the errors-and-warnings page.
customFields	object	Authored content.

Attribute

Property	Type	Description
name, prefixedName	text	Attribute name, and the full prefixed name.
treeNodePath	text	Location in the driver tree.
summary, link	text	Summary and link.
attributeId	text	Attribute ID in hex.
constantName, constantValue	text	Constant name and decimal value.
access	text	Read/Write, Read Only, or Write Only.
type, typeName	text	Formatted C type and raw type name.
definedValues	object	Defined values for an enum-typed attribute (items).
parameters	section	Parameters from the accessor signatures.
commands	object	Instrument commands (isSingle, command, items).
ranges	object	Continuous range (isSingle, description, items).
discreteValues	object	Discrete values (items).
supportedModels	object	Multi-model support (models).
branch, library	refs	Parent branch and library.
syntax	object	syntax.code (HTML), plus syntax.getter / syntax.setter (each with code).
customFields	object	Authored content (incl. units).

Callback function

Property	Type	Description
name, prefixedName, summary, link	text	Identity, summary, link.
parameters	section	Callback parameters.
returnValue	object	Return value (type, typeHtml (HTML), description); null if void.
definedValues	list	Defined-value sections for enum parameters/return.
library	ref	Library.
syntax	object	syntax.code (HTML, the typedef).
customFields	object	Authored content.

Branch

Property	Type	Description
name, link, summary	text	Identity and summary.
childBranches, functions, attributes	section	Listings (items of member summary; null if empty).
library	ref	Library.
customFields	object	Authored content.

Enum

Property	Type	Description
name, summary	text	Identity and summary.
syntax	HTML	C declaration (the #define list).
members	list	Each member: prefixedName, value, description (also summary).
library	ref	Library.
customFields	object	Authored content.

Library

Property	Type	Description
name, summary	text	Library prefix and summary.
functions, attributes, callbacks	section	Listings (items of member summary; null if empty).
customFields	object	Authored content.

Errors and Warnings

Property	Type	Description
errors, warnings	section	Each items entry: prefixedName, hexValue, decimalValue, message.
library	ref	Library.