IVI.NET Data Model

This is the data available to layout templates for IVI.NET drivers. See the overview for conventions (case-insensitivity, {{ }} vs {{{ }}}, sections, and the shared sub-context shapes referenced below). Properties marked HTML are pre-formatted — render them with the triple brace.

Common reference shapes

These objects are referenced by the entity contexts below.

Type reference (parent, baseClass): name, fullName, cSharpName, fullCSharpName, summary, typeKind, isInterface, isClass, isEnum, isStruct, isDelegate, link.

Assembly (assembly): name, fileName, summary, link.

Namespace (namespace): name, link.

Parameter (items of parameters):

Property	Type	Description
name	text	Parameter name.
description	text	Help summary.
type	text	C# type (with keywords/generics).
typeHtml	HTML	C# type, linked.
fullTypeName	text	Fully-qualified type.
direction	text	In, Out, or InOut.
isOut, isRef, isParams	bool	Parameter kind flags.
modifier	text	out / ref / params, or empty.
isRepCapIdentifier	bool	True for a repeated-capability selector.

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

Type parameter (items of typeParameters): name, description.

Syntax (syntax): syntax.csharp.code (HTML, the C# signature).

Method

Property	Type	Description
name	text	Method name.
nameWithGenericArguments	text	e.g. GetValue<T>.
fullyQualifiedName	text	Type.Method.
summary	text	Help summary.
link	text	Link to the method page.
parent	type ref	Declaring type.
assembly	assembly	Containing assembly.
namespace	text	Namespace name.
parameters / hasParameters	section / bool	Parameters (items) and a flag.
returnValue / hasReturnValue	object / bool	Return value and a flag.
typeParameters / hasTypeParameters	section / bool	Generic parameters and a flag.
commands	object	Instrument commands (isSingle, command, items).
supportedModels	object	Multi-model support (models).
syntax	object	syntax.csharp.code (HTML).
customFields	object	Authored content.
isStatic, isConstructor, isOverloaded	bool	Method flags.

Property

Property	Type	Description
name, fullyQualifiedName, summary	text	Identity and summary.
type / typeHtml	text / HTML	Property type (plain / linked).
link	text	Link to the property page.
parent, assembly, namespace	refs	Declaring type, assembly, namespace.
parameters	section	Indexer parameters (null if not an indexer).
commands	object	Instrument commands (isSingle, command, items).
ranges	object	Continuous range (isSingle, description, items of range item).
discreteValues	object	Discrete values (items of discrete value).
supportedModels	object	Multi-model support (models).
syntax	object	syntax.csharp.code (HTML).
customFields	object	Authored content (incl. units).

Class / Interface / Struct

These three share the same shape (interfaces have no constructors):

Property	Type	Description
name, fullyQualifiedName, summary	text	Identity and summary.
syntax	HTML	The C# declaration.
typeParameters	section	Generic parameters (null if non-generic).
constructors	section	Member listing (class/struct only).
properties, methods, events	section	Member listings (items of member summary).
baseClass	type ref	Base class (class only; null if Object/undocumented).
namespace, assembly	refs	Namespace and assembly.
customFields	object	Authored content.

Enum

Property	Type	Description
name, fullyQualifiedName, summary	text	Identity and summary.
syntax	HTML	The C# declaration (includes [Flags] when applicable).
members	list	Each member: name, value, summary.
namespace, assembly	refs	Namespace and assembly.
customFields	object	Authored content.

Event

Property	Type	Description
name, fullyQualifiedName, summary	text	Identity and summary.
syntax	HTML	The C# declaration.
parent, namespace, assembly	refs	Declaring type, namespace, assembly.
customFields	object	Authored content.

Constructor

Property	Type	Description
name	text	Same as the parent type.
displayName	text	Name with parameter types (overload disambiguation).
fullyQualifiedName, summary	text	Identity and summary.
syntax	HTML	The C# declaration.
parameters	section	Constructor parameters.
parent, namespace, assembly	refs	Declaring type, namespace, assembly.
customFields	object	Authored content.

Delegate

Property	Type	Description
name, fullyQualifiedName, summary	text	Identity and summary.
syntax	HTML	The C# declaration.
typeParameters	section	Generic parameters (null if non-generic).
parameters	section	Delegate parameters.
returnValue	object	Return value (null if void).
namespace, assembly	refs	Namespace and assembly.
customFields	object	Authored content.

Assembly

Property	Type	Description
name, fileName, summary, link	text	Identity, file name, summary, link.
classes, interfaces, structs, delegates, enums, exceptions	section	Type listings (items of member summary; null if empty).
customFields	object	Authored content.