iviconfigurationstore

Create IVI configuration store object

Description

An IVI^® configuration store object represents a connection to the IVI Configuration Server.

Creation

Syntax

obj = iviconfigurationstore

obj = iviconfigurationstore('file')

Description

obj = iviconfigurationstore creates an IVI configuration store object and establishes a connection to the IVI Configuration Server. The data in the default configuration store location is used.

obj = iviconfigurationstore('file') creates an IVI configuration store object and establishes a connection to the IVI Configuration Server. The data in the configuration store, file, is used. If file cannot be found or is not a valid configuration store, an error occurs.

Properties

Server Properties

Name — Name of IVI configuration server

character vector

This property is read-only.

Name of the IVI configuration store server.

Vendor — IVI configuration server vendor

character vector

This property is read-only.

Vendor of the IVI configuration server.

Revision — IVI configuration store version

character vector

This property is read-only.

Version of the IVI configuration store.

SpecificationVersion — IVI configuration server specification version

character vector

This property is read-only.

Specification version of the IVI configuration store server that this server revision complies with.

Configuration Store Properties

DefaultLocation — Full pathname of default configuration store file

character vector

This property is read-only.

Default configuration store location. The default value is set at IVI installation.

ProcessLocation — Configuration store file for process to use if default configuration store is not used

character vector

This property is read-only.

IVI configuration store being used as an alternative to the default configuration store. The use of an alternative is particular to each iviconfigurationstore object, and is specified when the object is created. The default value is an empty character vector.

ActualLocation — Configuration store file used by IVI configuration store object

character vector

This property is read-only.

Location of the IVI configuration store actually being used. It is either the default configuration store location, or the ProcessLocation if an alternative to the default configuration store location was specified when the IVI configuration store object was created. The default value is the default configuration store location.

Other Properties

DriverSessions — Array of driver sessions contained in IVI configuration store

structure

This property is read-only.

All the driver sessions in the IVI configuration store. Each driver session maps a software module to a hardware asset and its IOResourceDescriptor. A driver session also determines default settings and behavior for its software module.

HardwareAssets — Array of hardware assets contained in IVI configuration store

structure

This property is read-only.

All hardware assets in the IVI configuration store, each hardware asset referencing an IOResourceDescriptor. The default value is empty.

LogicalNames — Array of logical names contained in IVI configuration store

structure

This property is read-only.

Logical name in the IVI configuration store. Each logical name references a driver session in the configuration store, and is used in creating device objects with the icdevice function.

PublishedAPIs — Array of published APIs in IVI configuration store

structure

This property is read-only.

Published APIs in the IVI configuration store server.

ServerDescription — IVI configuration store server description

character vector

This property is read-only.

Description of the IVI configuration store server.

Sessions — Array of driver sessions in IVI configuration store

structure

This property is read-only.

Sessions in the IVI configuration store, including the driver sessions.

SoftwareModules — Array of software modules in IVI configuration store

structure

This property is read-only.

Software modules in the IVI configuration store. These are installed by the user, but are not configurable. They include instrument drivers. The default value is empty when no software modules are installed.

Object Functions

add	Add entry to IVI configuration store object
commit	Save IVI configuration store object to data file
remove	Remove entry from IVI configuration store object
update	Update entry of IVI configuration store object

Version History

Introduced before R2006a

R2023a: Renamed from MasterLocation

The MasterLocation property has been renamed to DefaultLocation. This change reflects the adoption of inclusive terminology in MathWorks^® software and documentation. There are no plans to remove support for references to MasterLocation.