IVI-COM Data Model

This is the data available to layout templates for IVI-COM 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-COM syntax contexts provide both C++ and C#: syntax.cpp.code and syntax.csharp.code.

Common reference shapes

Interface reference (parent, baseInterface, and items of a class’s interfaces): name, link, summary.

Namespace (namespace, a type library): name, assemblyName, assemblyFileName, link.

Parameter (items of parameters):

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

Return value (returnValue): type (text), typeHtml (HTML), cppType (text), description (text).

Method

Property	Type	Description
name, namespaceQualifiedName, summary	text	Identity and summary.
link	text	Link to the method page.
parent	interface ref	Declaring interface.
namespace	namespace	Type library.
typeLibrary	text	Type library name.
parameters / hasParameters	section / bool	Parameters (items) and a flag.
returnValue / hasReturnValue	object / bool	Return value and a flag.
commands / hasCommands	object / bool	Instrument commands (isSingle, command, items) and a flag.
supportedModels	object	Multi-model support (models).
syntax	object	syntax.cpp.code, syntax.csharp.code (HTML).
customFields	object	Authored content.

Property

Property	Type	Description
name, namespaceQualifiedName, summary	text	Identity and summary.
type / typeHtml	text / HTML	C++ property type (plain / linked).
cSharpType, typeName	text	C# type, object-model type name.
link	text	Link to the property page.
parent, namespace, typeLibrary	refs / text	Declaring interface, type library.
access	text	Read/Write, Read Only, or Write Only.
parameters	section	Indexer parameters (null if none).
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).
syntax	object	syntax.cpp.code, syntax.csharp.code (HTML).
customFields	object	Authored content (incl. units).

Interface

Property	Type	Description
name, namespaceQualifiedName, summary, link	text	Identity, summary, link.
namespace, typeLibrary	ref / text	Type library.
baseInterface	interface ref	Base interface (null if none).
methods, properties	section	Member listings (items of member summary).
syntax	object	syntax.cpp.code, syntax.csharp.code (HTML).
customFields	object	Authored content.

Class (coclass)

Property	Type	Description
name, namespaceQualifiedName, summary, link	text	Identity, summary, link.
namespace, typeLibrary	ref / text	Type library.
interfaces	list	Implemented interfaces (interface refs).
syntax	object	syntax.cpp.code, syntax.csharp.code (HTML).
customFields	object	Authored content.

Enum

Property	Type	Description
name, namespaceQualifiedName, summary, link	text	Identity, summary, link.
syntax	HTML	C++ enum declaration.
members	list	Each member: name, value, summary.
namespace, typeLibrary	ref / text	Type library.
customFields	object	Authored content.

Namespace (type library)

Property	Type	Description
name, assemblyName, assemblyFileName, summary, link	text	Identity and summary.
classes, interfaces, enums	section	Type listings (items of member summary; null if empty).
customFields	object	Authored content.

Errors and Warnings

Property	Type	Description
errors, warnings	section	Each items entry: name, hexValue, decimalValue, message.