aes70 1.3.8 → 1.4.0

package/src/controller/ControlClasses/OcaLibrary.js

@@ -1,15 +1,30 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaAgent } from './OcaAgent.js';
 import { OcaLibAccess } from '../../OCP1/OcaLibAccess.js';
 import { OcaLibVol } from '../../OCP1/OcaLibVol.js';
+import { OcaLibVolChangedEventData } from '../../OCP1/OcaLibVolChangedEventData.js';
 import { OcaLibVolType } from '../../OCP1/OcaLibVolType.js';
 import { OcaMap } from '../../OCP1/OcaMap.js';
-import { OcaPropertyChangeType } from '../../OCP1/OcaPropertyChangeType.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaAgent } from './OcaAgent.js';
 
 /**
- * A  **library**  is an agent that holds a collection of datasets. We refer to each dataset as a  **Volume** . There are two kinds of volumes:  **ParamSet**  (parameter set). A ParamSet is a collection of operating parameter settings that can be applied to a block. Each ParamSet is associated with a specific block type, but not with a specific instance of that type. A ParamSet may be applied to any block instance of the associated type. A block's type is the object number of its factory or, for factory-defined blocks, a unique identifier set at time of manufacture.  **Patch** . A Patch is a collection of ParamSet assignments. A ParamSet assigment is the description of a binding of a ParamSet to a block instance. To "apply" a Patch is to apply all of its assignments. To apply an assignment is to set all of its ParamSet's parameter values into its block. A given library instance can only hold one class of volume. A device that supports libraries can have any number of Patch and ParamSet libraries. If a device implements a Patch library, it must also implement at least one ParamSet library. However, the reverse is not true: a device may implement one or more ParamSet libraries without a Patch library.
+ * A **library** is an agent that holds a collection of datasets. We refer to
+ * each dataset as a **Volume**. There are two kinds of volumes: **ParamSet**
+ * (parameter set). A ParamSet is a collection of operating parameter settings
+ * that can be applied to a block. Each ParamSet is associated with a specific
+ * block type, but not with a specific instance of that type. A ParamSet may be
+ * applied to any block instance of the associated type. A block's type is the
+ * object number of its factory or, for factory-defined blocks, a unique
+ * identifier set at time of manufacture. **Patch**. A Patch is a collection of
+ * ParamSet assignments. A ParamSet assigment is the description of a binding of
+ * a ParamSet to a block instance. To "apply" a Patch is to apply all of its
+ * assignments. To apply an assignment is to set all of its ParamSet's parameter
+ * values into its block. A given library instance can only hold one class of
+ * volume. A device that supports libraries can have any number of Patch and
+ * ParamSet libraries. If a device implements a Patch library, it must also
+ * implement at least one ParamSet library. However, the reverse is not true: a
+ * device may implement one or more ParamSet libraries without a Patch library.
  * @extends OcaAgent
  * @class OcaLibrary
  */
@@ -34,30 +49,36 @@ export const OcaLibrary = make_control_class(
     ['Access', [OcaLibAccess], 3, 2, false, false, null],
     ['Volumes', [OcaMap(OcaUint32, OcaLibVol)], 3, 3, false, false, null],
   ],
-  [['OcaLibVolChanged', 3, 1, [OcaUint32, OcaPropertyChangeType]]]
+  [['OcaLibVolChanged', 3, 1, [OcaLibVolChangedEventData]]]
 );
 
 /**
- * Adds a volume to the library and returns its volume ID. The return value indicates whether the volume was successfully added. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.
+ * Adds a volume to the library and returns its volume ID. The return value
+ * indicates whether the volume was successfully added. Changed in version 2
+ * because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has
+ * changed.
  *
  * @method OcaLibrary#AddVolume
- * @param {OcaLibVol} Volume
+ * @param {IOcaLibVol} Volume
  *
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Replaces a volume in the library at the given volume ID. The return value indicates whether the volume was successfully replaced. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.
+ * Replaces a volume in the library at the given volume ID. The return value
+ * indicates whether the volume was successfully replaced. Changed in version 2
+ * because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has
+ * changed.
  *
  * @method OcaLibrary#ReplaceVolume
  * @param {number} ID
- *
- * @param {OcaLibVol} Volume
+ * @param {IOcaLibVol} Volume
  *
  * @returns {Promise<void>}
  */
 /**
- * Deletes a volume from the library. The return value indicates whether the group was successfully deleted.
+ * Deletes a volume from the library. The return value indicates whether the
+ * group was successfully deleted.
  *
  * @method OcaLibrary#DeleteVolume
  * @param {number} ID
@@ -65,7 +86,9 @@ export const OcaLibrary = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Retrieves a library volume. The return value indicates whether the volume was successfully retrieved. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.
+ * Retrieves a library volume. The return value indicates whether the volume was
+ * successfully retrieved. Changed in version 2 because the definition of
+ * OcaLibVolMetaData, which is part of OcaLibVol, has changed.
  *
  * @method OcaLibrary#GetVolume
  * @param {number} ID
@@ -74,61 +97,66 @@ export const OcaLibrary = make_control_class(
  *   A promise which resolves to a single value of type :class:`OcaLibVol`.
  */
 /**
- * Gets the count of volumes in this library. The return value indicates whether the count was successfully retrieved.
+ * Gets the count of volumes in this library. The return value indicates whether
+ * the count was successfully retrieved.
  *
  * @method OcaLibrary#GetVolumeCount
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Gets the list of volumes held in this library. The return value indicates whether the list was successfully retrieved. Changed in version 2 because the definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.
+ * Gets the list of volumes held in this library. The return value indicates
+ * whether the list was successfully retrieved. Changed in version 2 because the
+ * definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed.
  *
  * @method OcaLibrary#GetVolumes
  * @returns {Promise<Map<number, OcaLibVol>>}
  *   A promise which resolves to a single value of type ``Map<number, OcaLibVol>``.
  */
 /**
- * Gets allowed access mode for this library. The return value indicates whether the property was successfully retrieved.
+ * Gets allowed access mode for this library. The return value indicates whether
+ * the property was successfully retrieved.
  *
  * @method OcaLibrary#GetAccess
  * @returns {Promise<OcaLibAccess>}
  *   A promise which resolves to a single value of type :class:`OcaLibAccess`.
  */
 /**
- * Sets allowed access mode for this library. The return value indicates whether the property was successfully set. Not implemented for static, manufacturer-supplied libraries.
+ * Sets allowed access mode for this library. The return value indicates whether
+ * the property was successfully set. Not implemented for static,
+ * manufacturer-supplied libraries.
  *
  * @method OcaLibrary#SetAccess
- * @param {OcaLibAccess} Access
+ * @param {IOcaLibAccess} Access
  *
  * @returns {Promise<void>}
  */
 /**
- * Event that is raised whenever private property  **Volumes** changes. Added in OcaLibrary Version 2.
+ * Event that is raised whenever private property **Volumes** changes. Added in
+ * OcaLibrary Version 2.
  * @member OcaLibrary#OnOcaLibVolChanged {Event}
- * Event that is raised whenever private property <b>Volumes </b>changes.
- * Added in OcaLibrary Version 2.
  */
 /**
- * This event is emitted when the property VolumeType changes in the remote object.
+ * This event is emitted when the property ``VolumeType`` changes in the remote object.
  * The property ``VolumeType`` is described in the AES70 standard as follows.
  * Type of library volumes:
  *
  * @member {PropertyEvent<OcaLibVolType>} OcaLibrary#OnVolumeTypeChanged
  */
 /**
- * This event is emitted when the property Access changes in the remote object.
+ * This event is emitted when the property ``Access`` changes in the remote object.
  * The property ``Access`` is described in the AES70 standard as follows.
  * Readonly, read-expand, or full.
  *
  * @member {PropertyEvent<OcaLibAccess>} OcaLibrary#OnAccessChanged
  */
 /**
- * This event is emitted when the property Volumes changes in the remote object.
+ * This event is emitted when the property ``Volumes`` changes in the remote object.
  * The property ``Volumes`` is described in the AES70 standard as follows.
  * Map of volumes held in the Library. Changed in version 2 because the
- * definition of OcaLibVolMetaData, which is part of OcaLibVol, has
- * changed, and because it is now a private property whose changes are
- * signaled by the <b>OcaLibVolChanged </b>event.
+ * definition of OcaLibVolMetaData, which is part of OcaLibVol, has changed, and
+ * because it is now a private property whose changes are signaled by the
+ * **OcaLibVolChanged** event.
  *
  * @member {PropertyEvent<Map<number, OcaLibVol>>} OcaLibrary#OnVolumesChanged
  */

package/src/controller/ControlClasses/OcaLibraryManager.d.ts

@@ -1,20 +1,22 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaManager } from './OcaManager';
-
-import { PropertyEvent } from '../property_event';
-import { IOcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
+import {
+  IOcaLibVolIdentifier,
+  OcaLibVolIdentifier,
+} from '../../types/OcaLibVolIdentifier';
 import { IOcaLibVolType } from '../../types/OcaLibVolType';
-import { OcaLibVolIdentifier } from '../../types/OcaLibVolIdentifier';
 import { OcaLibraryIdentifier } from '../../types/OcaLibraryIdentifier';
+import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaManager } from './OcaManager';
 
 /**
  * Optional manager for handling device presets -- Patch and ParamSet libraries.
  *
- *  - May be instantiated once in any device.
  *
+ *  - May be instantiated once in any device.
  *
  *  - If instantiated, object number must be 8.
  *
+ *
  * @extends OcaManager
  * @class OcaLibraryManager
  */
@@ -32,10 +34,11 @@ export declare class OcaLibraryManager extends OcaManager {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Adds a library to the device. Return value indicates whether the library was successfully added.
+   * Adds a library to the device. Return value indicates whether the library
+   * was successfully added.
    *
    * @method OcaLibraryManager#AddLibrary
-   * @param {OcaLibVolType} Type
+   * @param {IOcaLibVolType} Type
    *
    * @returns {Promise<OcaLibraryIdentifier>}
    *   A promise which resolves to a single value of type :class:`OcaLibraryIdentifier`.
@@ -53,10 +56,11 @@ export declare class OcaLibraryManager extends OcaManager {
   DeleteLibrary(ID: number): Promise<void>;
 
   /**
-   * Returns the number of libraries of the given type that are instantiated in the device..
+   * Returns the number of libraries of the given type that are instantiated in
+   * the device..
    *
    * @method OcaLibraryManager#GetLibraryCount
-   * @param {OcaLibVolType} Type
+   * @param {IOcaLibVolType} Type
    *
    * @returns {Promise<number>}
    *   A promise which resolves to a single value of type ``number``.
@@ -64,18 +68,20 @@ export declare class OcaLibraryManager extends OcaManager {
   GetLibraryCount(Type: IOcaLibVolType): Promise<number>;
 
   /**
-   * Returns the list of object numbers of libraries of libraries of the given type that are instantiated in the device.
+   * Returns the list of object numbers of libraries of libraries of the given
+   * type that are instantiated in the device.
    *
    * @method OcaLibraryManager#GetLibraryList
-   * @param {OcaLibVolType} Type
+   * @param {IOcaLibVolType} Type
    *
    * @returns {Promise<OcaLibraryIdentifier[]>}
-   *   A promise which resolves to a single value of type ``OcaLibraryIdentifier[]``.
+   *   A promise which resolves to a single value of type :class:`OcaLibraryIdentifier[]`.
    */
   GetLibraryList(Type: IOcaLibVolType): Promise<OcaLibraryIdentifier[]>;
 
   /**
-   * Return the identifier of the most recently applied patch. The return value indicates whether the method succeeded.
+   * Return the identifier of the most recently applied patch. The return value
+   * indicates whether the method succeeded.
    *
    * @method OcaLibraryManager#GetCurrentPatch
    * @returns {Promise<OcaLibVolIdentifier>}
@@ -87,7 +93,7 @@ export declare class OcaLibraryManager extends OcaManager {
    * Apply a patch to the device.
    *
    * @method OcaLibraryManager#ApplyPatch
-   * @param {OcaLibVolIdentifier} ID
+   * @param {IOcaLibVolIdentifier} ID
    *
    * @returns {Promise<void>}
    */

package/src/controller/ControlClasses/OcaLibraryManager.js

@@ -1,20 +1,21 @@
-import { make_control_class } from '../make_control_class.js';
-import { OcaManager } from './OcaManager.js';
 import { OcaLibVolIdentifier } from '../../OCP1/OcaLibVolIdentifier.js';
 import { OcaLibVolType } from '../../OCP1/OcaLibVolType.js';
 import { OcaLibraryIdentifier } from '../../OCP1/OcaLibraryIdentifier.js';
 import { OcaList } from '../../OCP1/OcaList.js';
 import { OcaUint16 } from '../../OCP1/OcaUint16.js';
 import { OcaUint32 } from '../../OCP1/OcaUint32.js';
+import { make_control_class } from '../make_control_class.js';
+import { OcaManager } from './OcaManager.js';
 
 /**
  * Optional manager for handling device presets -- Patch and ParamSet libraries.
  *
- *  - May be instantiated once in any device.
  *
+ *  - May be instantiated once in any device.
  *
  *  - If instantiated, object number must be 8.
  *
+ *
  * @extends OcaManager
  * @class OcaLibraryManager
  */
@@ -40,10 +41,11 @@ export const OcaLibraryManager = make_control_class(
 );
 
 /**
- * Adds a library to the device. Return value indicates whether the library was successfully added.
+ * Adds a library to the device. Return value indicates whether the library was
+ * successfully added.
  *
  * @method OcaLibraryManager#AddLibrary
- * @param {OcaLibVolType} Type
+ * @param {IOcaLibVolType} Type
  *
  * @returns {Promise<OcaLibraryIdentifier>}
  *   A promise which resolves to a single value of type :class:`OcaLibraryIdentifier`.
@@ -57,25 +59,28 @@ export const OcaLibraryManager = make_control_class(
  * @returns {Promise<void>}
  */
 /**
- * Returns the number of libraries of the given type that are instantiated in the device..
+ * Returns the number of libraries of the given type that are instantiated in
+ * the device..
  *
  * @method OcaLibraryManager#GetLibraryCount
- * @param {OcaLibVolType} Type
+ * @param {IOcaLibVolType} Type
  *
  * @returns {Promise<number>}
  *   A promise which resolves to a single value of type ``number``.
  */
 /**
- * Returns the list of object numbers of libraries of libraries of the given type that are instantiated in the device.
+ * Returns the list of object numbers of libraries of libraries of the given
+ * type that are instantiated in the device.
  *
  * @method OcaLibraryManager#GetLibraryList
- * @param {OcaLibVolType} Type
+ * @param {IOcaLibVolType} Type
  *
  * @returns {Promise<OcaLibraryIdentifier[]>}
- *   A promise which resolves to a single value of type ``OcaLibraryIdentifier[]``.
+ *   A promise which resolves to a single value of type :class:`OcaLibraryIdentifier[]`.
  */
 /**
- * Return the identifier of the most recently applied patch. The return value indicates whether the method succeeded.
+ * Return the identifier of the most recently applied patch. The return value
+ * indicates whether the method succeeded.
  *
  * @method OcaLibraryManager#GetCurrentPatch
  * @returns {Promise<OcaLibVolIdentifier>}
@@ -85,23 +90,23 @@ export const OcaLibraryManager = make_control_class(
  * Apply a patch to the device.
  *
  * @method OcaLibraryManager#ApplyPatch
- * @param {OcaLibVolIdentifier} ID
+ * @param {IOcaLibVolIdentifier} ID
  *
  * @returns {Promise<void>}
  */
 /**
- * This event is emitted when the property Libraries changes in the remote object.
+ * This event is emitted when the property ``Libraries`` changes in the remote object.
  * The property ``Libraries`` is described in the AES70 standard as follows.
  * List of identifiers of all libraries in the device.
  *
  * @member {PropertyEvent<OcaLibraryIdentifier[]>} OcaLibraryManager#OnLibrariesChanged
  */
 /**
- * This event is emitted when the property CurrentPatch changes in the remote object.
+ * This event is emitted when the property ``CurrentPatch`` changes in the remote object.
  * The property ``CurrentPatch`` is described in the AES70 standard as follows.
- * Library volume identifier of the most-recently applied patch in this
- * device. Changing the value of this property applies the patch
- * represented by the new value.
+ * Library volume identifier of the most-recently applied patch in this device.
+ * Changing the value of this property applies the patch represented by the new
+ * value.
  *
  * @member {PropertyEvent<OcaLibVolIdentifier>} OcaLibraryManager#OnCurrentPatchChanged
  */

package/src/controller/ControlClasses/OcaManager.d.ts

@@ -2,7 +2,10 @@ import { RemoteDevice } from '../remote_device';
 import { OcaRoot } from './OcaRoot';
 
 /**
- * Abstract base class for classes that represent non-audio (i.e. control and monitoring) functions. All concrete manager objects are lockable (the constructor of this class initializes the Root object with property Lockable true).
+ * Abstract base class for classes that represent non-audio (i.e. control and
+ * monitoring) functions. All concrete manager objects are lockable (the
+ * constructor of this class initializes the Root object with property Lockable
+ * true).
  * @extends OcaRoot
  * @class OcaManager
  */

package/src/controller/ControlClasses/OcaManager.js

@@ -2,7 +2,10 @@ import { make_control_class } from '../make_control_class.js';
 import { OcaRoot } from './OcaRoot.js';
 
 /**
- * Abstract base class for classes that represent non-audio (i.e. control and monitoring) functions. All concrete manager objects are lockable (the constructor of this class initializes the Root object with property Lockable true).
+ * Abstract base class for classes that represent non-audio (i.e. control and
+ * monitoring) functions. All concrete manager objects are lockable (the
+ * constructor of this class initializes the Root object with property Lockable
+ * true).
  * @extends OcaRoot
  * @class OcaManager
  */

package/src/controller/ControlClasses/OcaMatrix.d.ts

@@ -1,11 +1,51 @@
-import { RemoteDevice } from '../remote_device';
-import { OcaWorker } from './OcaWorker';
 import { Arguments } from '../arguments';
-
 import { PropertyEvent } from '../property_event';
+import { RemoteDevice } from '../remote_device';
+import { OcaWorker } from './OcaWorker';
 
 /**
- * A matrix is a rectangular array of identical objects (" **members** ") that is coordinate addressable and has sets of common input and output ports. The matrix host does not instantiate these objects, but instead mediates the coordinate addressing, implements the common input and output ports, and provdes certain other aggregate functions. Matrix members may be workers (including blocks), or agents. All members of a matrix must be of the same class. No object may belong to more than one matrix at a time. No object may appear more than once in a given matrix. The complete model of an OCA matrix consists of: 1. One instance of  **OcaMatrix.**  2.  **(N x M) members** , where each member is an instance of a worker or agent class. For any given matrix, this class must be the same for all members, and is referred to as the  **member class.**  Members are sometimes referred to as  **cells**  of the matrix. 3. One additional instance of the member class, called the  **matrix proxy.**  Thus, the  **OcaMatrix**  instance is a container for the two-dimensional collection of its members. Once a matrix is set up, the controller may get and set member properties by the following procedures:  **Get**  To get a property value of member (x1, y1): 1. Controller calls  **OcaMatrix.SetXY(x1, y1)** . This action: - locks the  **OcaMatrix**  instance, and - posts x1 and y1 as coordinates of the object whose property value is to be retrieved. 2. Controller calls the matrix proxy's  **Get**  method for the property value desired. This action causes the  **OcaMatrix**  instance to: - decode the posted x1 and y1 values into a member ONo. - call the given  **Get**  method for the object identified by the decoded ONo. - aggregate the  **OcaResult**  from each  **Get**  call into a consolidated  **OcaResult** . - unlock the  **OcaMatrix**  instance. - return the consolidated  **OcaResult**  to the controller.  **Set**  To set a property value of member (x1, y1), or of row (0, y1) or column (x1, 0) or whole matrix (0,0) 1. Controller calls  **OcaMatrix.SetXY(x1, y1)** . This action: - locks the  **OcaMatrix**  instance, and - posts x1 and y1 as coordinates of the object whose property value is to be changed. 2. Controller calls the matrix proxy's  **Set**  method for the target property. This action causes the  **OcaMatrix**  instance to: - decode the posted x1 and y1 values into a list of target member ONos, as follows: If x1 :raw:html:`>` 0 and y1 :raw:html:`>` 0, the list will be the single ONo of the addressed cell. If x1 = 0 and y1 :raw:html:`>` 0, the list will be the list of ONos of the cells in row y1 . If x1 :raw:html:`>` 0 and y1 = 0, the list will be the list of ONos of the cells in column x1. If x1 = 0 and y1 = 0, the list will be the list of ONos of all cells of the matrix. - call the given  **Set**  method for each target member in the ONo list. - aggregate the  **OcaResult**  from each  **Set**  call into a consolidated  **OcaResult** . - unlock the  **OcaMatrix**  instance.
+ * A matrix is a rectangular array of identical objects ("**members**") that is
+ * coordinate addressable and has sets of common input and output ports. The
+ * matrix host does not instantiate these objects, but instead mediates the
+ * coordinate addressing, implements the common input and output ports, and
+ * provdes certain other aggregate functions. Matrix members may be workers
+ * (including blocks), or agents. All members of a matrix must be of the same
+ * class. No object may belong to more than one matrix at a time. No object may
+ * appear more than once in a given matrix. The complete model of an OCA matrix
+ * consists of: 1. One instance of **OcaMatrix.** 2. **(N x M) members**, where
+ * each member is an instance of a worker or agent class. For any given matrix,
+ * this class must be the same for all members, and is referred to as the
+ * **member class.** Members are sometimes referred to as **cells** of the
+ * matrix. 3. One additional instance of the member class, called the **matrix
+ * proxy.** Thus, the **OcaMatrix** instance is a container for the
+ * two-dimensional collection of its members. Once a matrix is set up, the
+ * controller may get and set member properties by the following procedures:
+ * **Get** To get a property value of member (x :sub:`1`, y :sub:`1`): 1.
+ * Controller calls **OcaMatrix.SetXY(x1, y1)**. This action: - locks the
+ * **OcaMatrix** instance, and - posts x :sub:`1` and y :sub:`1` as coordinates
+ * of the object whose property value is to be retrieved. 2. Controller calls
+ * the matrix proxy's **Get** method for the property value desired. This action
+ * causes the **OcaMatrix** instance to: - decode the posted x :sub:`1` and y
+ * :sub:`1` values into a member ONo. - call the given **Get** method for the
+ * object identified by the decoded ONo. - aggregate the **OcaResult** from each
+ * **Get** call into a consolidated **OcaResult**. - unlock the **OcaMatrix**
+ * instance. - return the consolidated **OcaResult** to the controller. **Set**
+ * ** **To set a property value of member (x :sub:`1`, y :sub:`1`), or of row
+ * (0, y :sub:`1`) or column (x :sub:`1`, 0) or whole matrix (0,0) 1. Controller
+ * calls **OcaMatrix.SetXY(x1, y1)**. This action: - locks the **OcaMatrix**
+ * instance, and - posts x :sub:`1` and y :sub:`1` as coordinates of the object
+ * whose property value is to be changed. 2. Controller calls the matrix proxy's
+ * **Set** method for the target property. This action causes the **OcaMatrix**
+ * instance to: - decode the posted x :sub:`1` and y :sub:`1` values into a list
+ * of target member ONos, as follows: If x :sub:`1` > 0 and y :sub:`1` > 0, the
+ * list will be the single ONo of the addressed cell. If x :sub:`1` = 0 and y
+ * :sub:`1` > 0, the list will be the list of ONos of the cells in row y
+ * :sub:`1` . If x :sub:`1` > 0 and y :sub:`1` = 0, the list will be the list of
+ * ONos of the cells in column x :sub:`1`. If x :sub:`1` = 0 and y :sub:`1` = 0,
+ * the list will be the list of ONos of all cells of the matrix. - call the
+ * given **Set** method for each target member in the ONo list. - aggregate the
+ * **OcaResult** from each **Set** call into a consolidated **OcaResult**. -
+ * unlock the **OcaMatrix** instance.
  * @extends OcaWorker
  * @class OcaMatrix
  */
@@ -53,7 +93,9 @@ export declare class OcaMatrix extends OcaWorker {
   constructor(objectNumber: number, device: RemoteDevice);
 
   /**
-   * Gets coordinates of the currently active area (cell, row, column, or whole matrix). The returned status indicates whether the operation was successful.
+   * Gets coordinates of the currently active area (cell, row, column, or whole
+   * matrix). The returned status indicates whether the operation was
+   * successful.
    * The return values of this method are
    *
    * - x of type ``number``
@@ -65,11 +107,11 @@ export declare class OcaMatrix extends OcaWorker {
   GetCurrentXY(): Promise<Arguments<[number, number]>>;
 
   /**
-   * Sets the currently active area (cell, row, column, or whole matrix). The returned status indicates whether the operation was successful.
+   * Sets the currently active area (cell, row, column, or whole matrix). The
+   * returned status indicates whether the operation was successful.
    *
    * @method OcaMatrix#SetCurrentXY
    * @param {number} x
-   *
    * @param {number} y
    *
    * @returns {Promise<void>}
@@ -77,7 +119,8 @@ export declare class OcaMatrix extends OcaWorker {
   SetCurrentXY(x: number, y: number): Promise<void>;
 
   /**
-   * Gets the matrix size. The returned status indicates whether the operation was successful.
+   * Gets the matrix size. The returned status indicates whether the operation
+   * was successful.
    * The return values of this method are
    *
    * - xSize of type ``number``
@@ -95,11 +138,11 @@ export declare class OcaMatrix extends OcaWorker {
   >;
 
   /**
-   * Sets the matrix size. The returned status indicates whether the operation was successful. This method will not be available for fixed-size matrices.
+   * Sets the matrix size. The returned status indicates whether the operation
+   * was successful. This method will not be available for fixed-size matrices.
    *
    * @method OcaMatrix#SetSize
    * @param {number} xSize
-   *
    * @param {number} ySize
    *
    * @returns {Promise<void>}
@@ -107,7 +150,8 @@ export declare class OcaMatrix extends OcaWorker {
   SetSize(xSize: number, ySize: number): Promise<void>;
 
   /**
-   * Retrieves the 2D array of member object numbers. Cells for which no member has been defined will return Zero as the object number.
+   * Retrieves the 2D array of member object numbers. Cells for which no member
+   * has been defined will return Zero as the object number.
    *
    * @method OcaMatrix#GetMembers
    * @returns {Promise<number[][]>}
@@ -116,7 +160,8 @@ export declare class OcaMatrix extends OcaWorker {
   GetMembers(): Promise<number[][]>;
 
   /**
-   * Sets the entire 2D array of member object numbers. Row and column size of the  **members**  parameter must be equal to the current size of the matrix.
+   * Sets the entire 2D array of member object numbers. Row and column size of
+   * the **members** parameter must be equal to the current size of the matrix.
    *
    * @method OcaMatrix#SetMembers
    * @param {number[][]} members
@@ -126,11 +171,11 @@ export declare class OcaMatrix extends OcaWorker {
   SetMembers(members: number[][]): Promise<void>;
 
   /**
-   * Retrieves the object number of the member at position (x,y). If no member is defined at this position, returns an object number value of Zero.
+   * Retrieves the object number of the member at position (x,y). If no member
+   * is defined at this position, returns an object number value of Zero.
    *
    * @method OcaMatrix#GetMember
    * @param {number} x
-   *
    * @param {number} y
    *
    * @returns {Promise<number>}
@@ -139,13 +184,12 @@ export declare class OcaMatrix extends OcaWorker {
   GetMember(x: number, y: number): Promise<number>;
 
   /**
-   * Installs a particular object as a member at position (x,y). If another object was at this position, it is removed.
+   * Installs a particular object as a member at position (x,y). If another
+   * object was at this position, it is removed.
    *
    * @method OcaMatrix#SetMember
    * @param {number} x
-   *
    * @param {number} y
-   *
    * @param {number} memberONo
    *
    * @returns {Promise<void>}
@@ -210,11 +254,12 @@ export declare class OcaMatrix extends OcaWorker {
   SetPortsPerColumn(Ports: number): Promise<void>;
 
   /**
-   * Sets the currently active area (cell, row, column, or whole matrix) and locks it. Fails if the referenced members cannot all be locked. The returned status indicates whether the operation was successful.
+   * Sets the currently active area (cell, row, column, or whole matrix) and
+   * locks it. Fails if the referenced members cannot all be locked. The
+   * returned status indicates whether the operation was successful.
    *
    * @method OcaMatrix#SetCurrentXYLock
    * @param {number} x
-   *
    * @param {number} y
    *
    * @returns {Promise<void>}
@@ -222,7 +267,11 @@ export declare class OcaMatrix extends OcaWorker {
   SetCurrentXYLock(x: number, y: number): Promise<void>;
 
   /**
-   * Unlocks the currently active area of the matrix. Fails if all the members of the currently active area cannot be unlocked. Failure is  _not_ triggered if one or more members of the currently active area are already unlocked at the time Unlock() is called. The returned status indicates whether the operation was successful.
+   * Unlocks the currently active area of the matrix. Fails if all the members
+   * of the currently active area cannot be unlocked. Failure is not triggered
+   * if one or more members of the currently active area are already unlocked at
+   * the time Unlock() is called. The returned status indicates whether the
+   * operation was successful.
    *
    * @method OcaMatrix#UnlockCurrent
    * @returns {Promise<void>}