aes70 2.0.4 → 2.0.7

package/src/controller/ControlClasses/OcaLibrary.js

@@ -1,162 +0,0 @@
-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 { 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.
- * @extends OcaAgent
- * @class OcaLibrary
- */
-export const OcaLibrary = make_control_class(
-  'OcaLibrary',
-  3,
-  '\u0001\u0002\u0005',
-  2,
-  OcaAgent,
-  [
-    ['AddVolume', 3, 1, [OcaLibVol], [OcaUint32]],
-    ['ReplaceVolume', 3, 2, [OcaUint32, OcaLibVol], []],
-    ['DeleteVolume', 3, 3, [OcaUint32], []],
-    ['GetVolume', 3, 4, [OcaUint32], [OcaLibVol]],
-    ['GetVolumeCount', 3, 5, [], [OcaUint16]],
-    ['GetVolumes', 3, 6, [], [OcaMap(OcaUint32, OcaLibVol)]],
-    ['GetAccess', 3, 7, [], [OcaLibAccess]],
-    ['SetAccess', 3, 8, [OcaLibAccess], []],
-  ],
-  [
-    ['VolumeType', [OcaLibVolType], 3, 1, false, false, null],
-    ['Access', [OcaLibAccess], 3, 2, false, false, null],
-    ['Volumes', [OcaMap(OcaUint32, OcaLibVol)], 3, 3, false, false, null],
-  ],
-  [['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.
- *
- * @method OcaLibrary#AddVolume
- * @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.
- *
- * @method OcaLibrary#ReplaceVolume
- * @param {number} ID
- * @param {IOcaLibVol} Volume
- *
- * @returns {Promise<void>}
- */
-/**
- * Deletes a volume from the library. The return value indicates whether the
- * group was successfully deleted.
- *
- * @method OcaLibrary#DeleteVolume
- * @param {number} ID
- *
- * @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.
- *
- * @method OcaLibrary#GetVolume
- * @param {number} ID
- *
- * @returns {Promise<OcaLibVol>}
- *   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.
- *
- * @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.
- *
- * @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.
- *
- * @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.
- *
- * @method OcaLibrary#SetAccess
- * @param {IOcaLibAccess} Access
- *
- * @returns {Promise<void>}
- */
-/**
- * Event that is raised whenever private property **Volumes** changes. Added in
- * OcaLibrary Version 2.
- * @member OcaLibrary#OnOcaLibVolChanged {Event}
- */
-/**
- * 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.
- * 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.
- * 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
- * **OcaLibVolChanged** event.
- *
- * @member {PropertyEvent<Map<number, OcaLibVol>>} OcaLibrary#OnVolumesChanged
- */

package/src/types/OcaClassAuthorityID.d.ts

@@ -1,54 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export declare interface IOcaClassAuthorityID {
-  /**
-   * Sentinel signifying an Authority ID
-   * @type number
-   */
-  Sentinel: number;
-
-  /**
-   * Reserved, must be zero.
-   * @type number
-   */
-  Reserved: number;
-
-  /**
-   * Authority's IEEE public Company ID (public CID) or IEEE Organizational
-   * Unique Identifier (OUI), or the value zero, which signifies the Authority
-   * of this AES70 standard.
-   * @type Uint8Array
-   */
-  OrganizationID: Uint8Array;
-}
-
-export declare class OcaClassAuthorityID implements IOcaClassAuthorityID {
-  /**
-   * Class authority identifier. Identifies the authority for a class's
-   * definition.
-   * @class OcaClassAuthorityID
-   */
-  constructor(Sentinel: number, Reserved: number, OrganizationID: Uint8Array);
-
-  /**
-   * Sentinel signifying an Authority ID
-   * @type number
-   */
-  Sentinel: number;
-
-  /**
-   * Reserved, must be zero.
-   * @type number
-   */
-  Reserved: number;
-
-  /**
-   * Authority's IEEE public Company ID (public CID) or IEEE Organizational
-   * Unique Identifier (OUI), or the value zero, which signifies the Authority
-   * of this AES70 standard.
-   * @type Uint8Array
-   */
-  OrganizationID: Uint8Array;
-}

package/src/types/OcaClassAuthorityID.js

@@ -1,30 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaClassAuthorityID {
-  /**
-   * Class authority identifier. Identifies the authority for a class's
-   * definition.
-   * @class OcaClassAuthorityID
-   */
-  constructor(Sentinel, Reserved, OrganizationID) {
-    /**
-     * Sentinel signifying an Authority ID
-     * @type number
-     */
-    this.Sentinel = Sentinel;
-    /**
-     * Reserved, must be zero.
-     * @type number
-     */
-    this.Reserved = Reserved;
-    /**
-     * Authority's IEEE public Company ID (public CID) or IEEE Organizational
-     * Unique Identifier (OUI), or the value zero, which signifies the Authority
-     * of this AES70 standard.
-     * @type Uint8Array
-     */
-    this.OrganizationID = OrganizationID;
-  }
-}

package/src/types/OcaClassID.js

@@ -1,22 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaClassID {
-  /**
-   * Class identifier : vector that describes the class's ancestry. The normative definition of the Class identifier is given in Part 1 of this standard, in the section entitled "Class identifiers". The UML definition given here is intended to be identical, but in the case of any discrepancy, Part 1 shall be definitive..
-   * @class OcaClassID
-   */
-  constructor(FieldCount, Fields) {
-    /**
-     * Identifies the number of fields of the ClassID, i.e. the level of the class tree the class is in. For example if this field count is 3, the ClassID is of the form 'n.m.p'. The minimum field count is 1 (OcaRoot class). A field count of zero is invalid.
-     * @type number
-     */
-    this.FieldCount = FieldCount;
-    /**
-     * Array of actual fields of the ClassID. The array has 'FieldCount' entries. If for example the field count is 3 and the Fields array has value {1, 2, 3} the ClassID is '1.2.3'.
-     * @type FieldType
-     */
-    this.Fields = Fields;
-  }
-}

package/src/types/OcaEnumItem.d.ts

@@ -1,25 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export declare interface IOcaEnumItem {
-  /**
-   * This was not documented in the OCA standard.
-   * @type number
-   */
-  Value: number;
-}
-
-export declare class OcaEnumItem implements IOcaEnumItem {
-  /**
-   * The datatype of an enumeration choice.
-   * @class OcaEnumItem
-   */
-  constructor(Value: number);
-
-  /**
-   * This was not documented in the OCA standard.
-   * @type number
-   */
-  Value: number;
-}

package/src/types/OcaEnumItem.js

@@ -1,17 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaEnumItem {
-  /**
-   * The datatype of an enumeration choice.
-   * @class OcaEnumItem
-   */
-  constructor(Value) {
-    /**
-     * This was not documented in the OCA standard.
-     * @type number
-     */
-    this.Value = Value;
-  }
-}

package/src/types/OcaEnumItem16.d.ts

@@ -1,25 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export declare interface IOcaEnumItem16 {
-  /**
-   * This was not documented in the OCA standard.
-   * @type number
-   */
-  Value: number;
-}
-
-export declare class OcaEnumItem16 implements IOcaEnumItem16 {
-  /**
-   * The datatype of an enumeration choice. Long format, used if normal 8-bit format isn't going to be big enough.
-   * @class OcaEnumItem16
-   */
-  constructor(Value: number);
-
-  /**
-   * This was not documented in the OCA standard.
-   * @type number
-   */
-  Value: number;
-}

package/src/types/OcaEnumItem16.js

@@ -1,17 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaEnumItem16 {
-  /**
-   * The datatype of an enumeration choice. Long format, used if normal 8-bit format isn't going to be big enough.
-   * @class OcaEnumItem16
-   */
-  constructor(Value) {
-    /**
-     * This was not documented in the OCA standard.
-     * @type number
-     */
-    this.Value = Value;
-  }
-}

package/src/types/OcaLibAccess.d.ts

@@ -1,56 +0,0 @@
-/*
- * This file has been generated.
- */
-/**
- * Library volume access modes
- * @class OcaLibAccess
- */
-export class OcaLibAccess {
-  /**
-   * Singleton object corresponding to the entry with value ``0``.
-   */
-  static None: OcaLibAccess;
-  /**
-   * Singleton object corresponding to the entry with value ``1``.
-   */
-  static ReadOnly: OcaLibAccess;
-  /**
-   * Singleton object corresponding to the entry with value ``2``.
-   */
-  static ReadExpand: OcaLibAccess;
-  /**
-   * Singleton object corresponding to the entry with value ``3``.
-   */
-  static Full: OcaLibAccess;
-
-  /**
-   * Returns the numeric value of this enum entry.
-   */
-  valueOf(): number;
-
-  /**
-   * Returns the string representation of this enum entry.
-   */
-  toString(): string;
-
-  /**
-   * Returns the name of an enum entry.
-   */
-  static getName(value: number): string;
-
-  /**
-   * Returns the value of an enum entry name.
-   */
-  static getValue(name: string): number;
-}
-
-export type IOcaLibAccess =
-  | OcaLibAccess
-  | 'None'
-  | 'ReadOnly'
-  | 'ReadExpand'
-  | 'Full'
-  | 0
-  | 1
-  | 2
-  | 3;

package/src/types/OcaLibAccess.js

@@ -1,44 +0,0 @@
-/*
- * This file has been generated.
- */
-import { Enum } from './Enum.js';
-
-/**
- * Library volume access modes
- * @class OcaLibAccess
- */
-export class OcaLibAccess extends Enum({
-  None: 0,
-  ReadOnly: 1,
-  ReadExpand: 2,
-  Full: 3,
-}) {}
-
-/**
- * Singleton object corresponding to the entry with value ``0``.
- * @type {OcaLibAccess}
- * @member None
- * @memberof OcaLibAccess
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``1``.
- * @type {OcaLibAccess}
- * @member ReadOnly
- * @memberof OcaLibAccess
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``2``.
- * @type {OcaLibAccess}
- * @member ReadExpand
- * @memberof OcaLibAccess
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``3``.
- * @type {OcaLibAccess}
- * @member Full
- * @memberof OcaLibAccess
- * @static
- */

package/src/types/OcaLibParamSetAssignment.d.ts

@@ -1,43 +0,0 @@
-/*
- * This file has been generated.
- */
-import {
-  IOcaLibVolIdentifier,
-  OcaLibVolIdentifier,
-} from './OcaLibVolIdentifier';
-
-export declare interface IOcaLibParamSetAssignment {
-  /**
-   * Identifier of the library volume that holds the paramset.
-   * @type OcaLibVolIdentifier
-   */
-  ParamSetIdentifier: IOcaLibVolIdentifier;
-
-  /**
-   * Object number of the block to which the paramset assignment applies.
-   * @type number
-   */
-  TargetBlockONo: number;
-}
-
-export declare class OcaLibParamSetAssignment
-  implements IOcaLibParamSetAssignment {
-  /**
-   * A ParamSet assigment is the description of a binding of a ParamSet to a
-   * block instance.
-   * @class OcaLibParamSetAssignment
-   */
-  constructor(ParamSetIdentifier: OcaLibVolIdentifier, TargetBlockONo: number);
-
-  /**
-   * Identifier of the library volume that holds the paramset.
-   * @type OcaLibVolIdentifier
-   */
-  ParamSetIdentifier: OcaLibVolIdentifier;
-
-  /**
-   * Object number of the block to which the paramset assignment applies.
-   * @type number
-   */
-  TargetBlockONo: number;
-}

package/src/types/OcaLibParamSetAssignment.js

@@ -1,23 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaLibParamSetAssignment {
-  /**
-   * A ParamSet assigment is the description of a binding of a ParamSet to a
-   * block instance.
-   * @class OcaLibParamSetAssignment
-   */
-  constructor(ParamSetIdentifier, TargetBlockONo) {
-    /**
-     * Identifier of the library volume that holds the paramset.
-     * @type OcaLibVolIdentifier
-     */
-    this.ParamSetIdentifier = ParamSetIdentifier;
-    /**
-     * Object number of the block to which the paramset assignment applies.
-     * @type number
-     */
-    this.TargetBlockONo = TargetBlockONo;
-  }
-}

package/src/types/OcaLibVol.d.ts

@@ -1,39 +0,0 @@
-/*
- * This file has been generated.
- */
-import { IOcaLibVolMetadata, OcaLibVolMetadata } from './OcaLibVolMetadata';
-
-export declare interface IOcaLibVol {
-  /**
-   * Descriptor of library volume
-   * @type OcaLibVolMetadata
-   */
-  Metadata: IOcaLibVolMetadata;
-
-  /**
-   * Contents of library volume. Type depends on template parameter.
-   * @type Uint8Array
-   */
-  Data: Uint8Array;
-}
-
-export declare class OcaLibVol implements IOcaLibVol {
-  /**
-   * Library volume. template. Template parameter is datatype of the volume. See
-   * **03 OcaLibrary** for explanation.
-   * @class OcaLibVol
-   */
-  constructor(Metadata: OcaLibVolMetadata, Data: Uint8Array);
-
-  /**
-   * Descriptor of library volume
-   * @type OcaLibVolMetadata
-   */
-  Metadata: OcaLibVolMetadata;
-
-  /**
-   * Contents of library volume. Type depends on template parameter.
-   * @type Uint8Array
-   */
-  Data: Uint8Array;
-}

package/src/types/OcaLibVol.js

@@ -1,23 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaLibVol {
-  /**
-   * Library volume. template. Template parameter is datatype of the volume. See
-   * **03 OcaLibrary** for explanation.
-   * @class OcaLibVol
-   */
-  constructor(Metadata, Data) {
-    /**
-     * Descriptor of library volume
-     * @type OcaLibVolMetadata
-     */
-    this.Metadata = Metadata;
-    /**
-     * Contents of library volume. Type depends on template parameter.
-     * @type Uint8Array
-     */
-    this.Data = Data;
-  }
-}

package/src/types/OcaLibVolChangedEventData.d.ts

@@ -1,43 +0,0 @@
-/*
- * This file has been generated.
- */
-import {
-  IOcaPropertyChangeType,
-  OcaPropertyChangeType,
-} from './OcaPropertyChangeType';
-
-export declare interface IOcaLibVolChangedEventData {
-  /**
-   * ID of library volume that changed.
-   * @type number
-   */
-  VolumeID: number;
-
-  /**
-   * Type of change : Will be either itemChanged, itemAdded, or itemDeleted.
-   * @type OcaPropertyChangeType
-   */
-  ChangeType: IOcaPropertyChangeType;
-}
-
-export declare class OcaLibVolChangedEventData
-  implements IOcaLibVolChangedEventData {
-  /**
-   * Event data for the **OcaLibVolChanged** event, which signals a change in an
-   * **OcaLibrary.Volumes** property.
-   * @class OcaLibVolChangedEventData
-   */
-  constructor(VolumeID: number, ChangeType: OcaPropertyChangeType);
-
-  /**
-   * ID of library volume that changed.
-   * @type number
-   */
-  VolumeID: number;
-
-  /**
-   * Type of change : Will be either itemChanged, itemAdded, or itemDeleted.
-   * @type OcaPropertyChangeType
-   */
-  ChangeType: OcaPropertyChangeType;
-}

package/src/types/OcaLibVolChangedEventData.js

@@ -1,23 +0,0 @@
-/*
- * This file has been generated.
- */
-
-export class OcaLibVolChangedEventData {
-  /**
-   * Event data for the **OcaLibVolChanged** event, which signals a change in an
-   * **OcaLibrary.Volumes** property.
-   * @class OcaLibVolChangedEventData
-   */
-  constructor(VolumeID, ChangeType) {
-    /**
-     * ID of library volume that changed.
-     * @type number
-     */
-    this.VolumeID = VolumeID;
-    /**
-     * Type of change : Will be either itemChanged, itemAdded, or itemDeleted.
-     * @type OcaPropertyChangeType
-     */
-    this.ChangeType = ChangeType;
-  }
-}