aes70 1.6.2 → 2.0.0

package/src/types/OcaInterval.d.ts

@@ -0,0 +1,8 @@
+/*
+ * This file has been generated.
+ */
+export declare interface IOcaInterval<DT> {
+  Min: DT;
+  Max: DT;
+  Bounds: IOcaIntervalBounds;
+}

package/src/types/OcaInterval.js

@@ -0,0 +1,84 @@
+/*
+ * This file has been generated.
+ */
+export class OcaInterval {
+  /**
+   * Template datatype that expresses a range of values according to the
+   * mathematical definition of "interval". An interval consists of one or two
+   * values called "bounds".
+   *
+   *  - An interval with two bounds (an upper and a lower) is called "bounded".
+   *
+   *  - An interval with only one bound is called "half-bounded".
+   *
+   *
+   * A bound may be "inclusive" or "exclusive".
+   *
+   *  - An inclusive bound includes its value in the interval.
+   *
+   *  - An exclusive bound excludes its value from the interval.
+   *
+   *  - Inclusive bounds are usually indicated by "[ ]" delimiters, exclusive
+   *    bounds by "( )" or "][".
+   *
+   *
+   * For example:
+   *
+   *  - [5,10] includes all values V such that 5 ``<=`` V ``<=`` 10.
+   *
+   *  - (5,10) includes all values V such that 5 ``<`` V ``<`` 10.
+   *
+   *  - [5,10) includes all values V such that 5 ``<=`` V ``<`` 10.
+   *
+   *  - (5,10] includes all values V such that 5 ``<`` V ``<=`` 10.
+   *
+   *
+   * Here are some half-bounded intervals:
+   *
+   *  - [5,) and [5,] mean all values V such that 5 ``<=`` V.
+   *
+   *  - (5,) and (5,] mean all values V such that 5 ``<`` V.
+   *
+   *  - (,10] and [,10] mean all values V such that V ``<=`` 10.
+   *
+   *  - (,10) and [,10) mean all values V such that V ``<`` 10.
+   *
+   *
+   * When a datatype (e.g. **OcaFloat32**, **OcaFloat64**) has a value
+   * ("**inf**" below) to represent Infinity, it may be used as a bound. For
+   * example:
+   *
+   *  - [1.0, **inf**) means all values V such that 1.0 ``<=`` V and V ``<``
+   *    **inf**
+   *
+   *  - [1.0,** inf**] means all values V such that 1.0 ``<=`` V
+   *
+   *  - (**-inf**, 1.0] means all values V such that V ``<=`` 1.0 and V ``>``
+   *    **-inf**
+   *
+   *  - [**-inf**, 1.0] means all values V such that V ``<=`` 1.0
+   *
+   *
+   * ... and so on. The usual term "range" means an inclusive, bounded interval,
+   * e.g. "the range from 3 to 12" means [3,12]. The property **.Bounds** is a
+   * bitset that specifies which bounds are given and whether the given bounds
+   * are inclusive or exclusive. **OcaInterval** is a **template** datatype,
+   * where the template variable is the datatype of the bounds. Thus, may be
+   * defined for integers, floats, and even strings.
+   */
+  constructor(Min, Max, Bounds) {
+    /**
+     * Lower bound. Datatype is determined by the template variable DT.
+     */
+    this.Min = Min;
+    /**
+     * Upper bound. Datatype is determined by the template variable DT.
+     */
+    this.Max = Max;
+    /**
+     * Bounds descriptor. See the definition of **OcaIntervalBounds** for
+     * details and examples.
+     */
+    this.Bounds = Bounds;
+  }
+}

package/src/types/OcaIntervalBounds.d.ts

@@ -0,0 +1,41 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset describing which bounds of an **OcaInterval** have been specified, and
+ * whether each specified bound is inclusive or exclusive. Bitset values have
+ * the following meanings: **MinOmitted**: 0 if Min is specified, 1 if omitted
+ * **MaxOmitted**: 0 if Max is specified, 1 if omitted **MinInclusive**: 0 if
+ * Min is an exclusive bound, 1 if inclusive **MaxInclusive**: 0 if Max is an
+ * exclusive bound, 1 if inclusive Thus , for **OcaInterval** = **{Min, Max,
+ * Bounds}**, and where a means any bit value - 1 or 0 x means any number Q
+ * designates the quantity under test: {x,x,0b0000} = empty interval
+ * {x,x,0baa11} = whole number line {10,40,0b0000} = 10 ``<`` Q ``<`` 40
+ * {10,40,0b1100} = 10 ``<=`` Q ``<=`` 40 {10,x,0ba110} = 10 ``<=`` Q
+ * {10,x,0ba010} = 10 ``<`` Q
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaIntervalBounds: {
+  /**
+   * Entry with value ``1``.
+   */
+  MinOmitted: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  MaxOmitted: number;
+
+  /**
+   * Entry with value ``4``.
+   */
+  MinInclusive: number;
+
+  /**
+   * Entry with value ``8``.
+   */
+  MaxInclusive: number;
+};
+
+export declare type IOcaIntervalBounds = number;

package/src/types/OcaIntervalBounds.js

@@ -0,0 +1,53 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset describing which bounds of an **OcaInterval** have been specified, and
+ * whether each specified bound is inclusive or exclusive. Bitset values have
+ * the following meanings: **MinOmitted**: 0 if Min is specified, 1 if omitted
+ * **MaxOmitted**: 0 if Max is specified, 1 if omitted **MinInclusive**: 0 if
+ * Min is an exclusive bound, 1 if inclusive **MaxInclusive**: 0 if Max is an
+ * exclusive bound, 1 if inclusive Thus , for **OcaInterval** = **{Min, Max,
+ * Bounds}**, and where a means any bit value - 1 or 0 x means any number Q
+ * designates the quantity under test: {x,x,0b0000} = empty interval
+ * {x,x,0baa11} = whole number line {10,40,0b0000} = 10 ``<`` Q ``<`` 40
+ * {10,40,0b1100} = 10 ``<=`` Q ``<=`` 40 {10,x,0ba110} = 10 ``<=`` Q
+ * {10,x,0ba010} = 10 ``<`` Q
+ * @enum {number}
+ * @readonly
+ */
+export const OcaIntervalBounds = {
+  MinOmitted: 1,
+  MaxOmitted: 2,
+  MinInclusive: 4,
+  MaxInclusive: 8,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member MinOmitted
+ * @memberof OcaIntervalBounds
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member MaxOmitted
+ * @memberof OcaIntervalBounds
+ * @static
+ */
+/**
+ * Entry with value ``4``.
+ * @type {number}
+ * @member MinInclusive
+ * @memberof OcaIntervalBounds
+ * @static
+ */
+/**
+ * Entry with value ``8``.
+ * @type {number}
+ * @member MaxInclusive
+ * @memberof OcaIntervalBounds
+ * @static
+ */

package/src/types/OcaJobDisposedEventData.d.ts

@@ -0,0 +1,57 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaJobDisposition, OcaJobDisposition } from './OcaJobDisposition';
+import { IOcaJobQueueItem, OcaJobQueueItem } from './OcaJobQueueItem';
+
+export declare interface IOcaJobDisposedEventData {
+  /**
+   * The job queue item that is the subject of this event
+   * @type OcaJobQueueItem
+   */
+  QueueItem: IOcaJobQueueItem;
+
+  /**
+   * Enum specifying what happened to the queue item.
+   * @type OcaJobDisposition
+   */
+  Disposition: IOcaJobDisposition;
+
+  /**
+   * Optional disposition details
+   * @type Uint8Array
+   */
+  DispositionDetails: Uint8Array;
+}
+
+export declare class OcaJobDisposedEventData
+  implements IOcaJobDisposedEventData {
+  /**
+   * Notification data emitted by the **OcaTaskScheduler.RunQueueItemDisposed**
+   * event.
+   * @class OcaJobDisposedEventData
+   */
+  constructor(
+    QueueItem: OcaJobQueueItem,
+    Disposition: OcaJobDisposition,
+    DispositionDetails: Uint8Array
+  );
+
+  /**
+   * The job queue item that is the subject of this event
+   * @type OcaJobQueueItem
+   */
+  QueueItem: OcaJobQueueItem;
+
+  /**
+   * Enum specifying what happened to the queue item.
+   * @type OcaJobDisposition
+   */
+  Disposition: OcaJobDisposition;
+
+  /**
+   * Optional disposition details
+   * @type Uint8Array
+   */
+  DispositionDetails: Uint8Array;
+}

package/src/types/OcaJobDisposedEventData.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaJobDisposedEventData {
+  /**
+   * Notification data emitted by the **OcaTaskScheduler.RunQueueItemDisposed**
+   * event.
+   * @class OcaJobDisposedEventData
+   */
+  constructor(QueueItem, Disposition, DispositionDetails) {
+    /**
+     * The job queue item that is the subject of this event
+     * @type OcaJobQueueItem
+     */
+    this.QueueItem = QueueItem;
+    /**
+     * Enum specifying what happened to the queue item.
+     * @type OcaJobDisposition
+     */
+    this.Disposition = Disposition;
+    /**
+     * Optional disposition details
+     * @type Uint8Array
+     */
+    this.DispositionDetails = DispositionDetails;
+  }
+}

package/src/types/OcaJobDisposition.d.ts

@@ -0,0 +1,68 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Types of run queue item disposition
+ * @class OcaJobDisposition
+ */
+export class OcaJobDisposition {
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static RunStarted: OcaJobDisposition;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static ItemDeleted: OcaJobDisposition;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static FailedToStart_TaskNotAvailable: OcaJobDisposition;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static FailedToStart_TaskNotCompatible: OcaJobDisposition;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static FailedToStart_ResourceUnavailable: OcaJobDisposition;
+  /**
+   * Singleton object corresponding to the entry with value ``6``.
+   */
+  static FailedToStart_DeviceError: OcaJobDisposition;
+
+  /**
+   * 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 IOcaJobDisposition =
+  | OcaJobDisposition
+  | 'RunStarted'
+  | 'ItemDeleted'
+  | 'FailedToStart_TaskNotAvailable'
+  | 'FailedToStart_TaskNotCompatible'
+  | 'FailedToStart_ResourceUnavailable'
+  | 'FailedToStart_DeviceError'
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5
+  | 6;

package/src/types/OcaJobDisposition.js

@@ -0,0 +1,60 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Types of run queue item disposition
+ * @class OcaJobDisposition
+ */
+export class OcaJobDisposition extends Enum({
+  RunStarted: 1,
+  ItemDeleted: 2,
+  FailedToStart_TaskNotAvailable: 3,
+  FailedToStart_TaskNotCompatible: 4,
+  FailedToStart_ResourceUnavailable: 5,
+  FailedToStart_DeviceError: 6,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaJobDisposition}
+ * @member RunStarted
+ * @memberof OcaJobDisposition
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaJobDisposition}
+ * @member ItemDeleted
+ * @memberof OcaJobDisposition
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaJobDisposition}
+ * @member FailedToStart_TaskNotAvailable
+ * @memberof OcaJobDisposition
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaJobDisposition}
+ * @member FailedToStart_TaskNotCompatible
+ * @memberof OcaJobDisposition
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaJobDisposition}
+ * @member FailedToStart_ResourceUnavailable
+ * @memberof OcaJobDisposition
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaJobDisposition}
+ * @member FailedToStart_DeviceError
+ * @memberof OcaJobDisposition
+ * @static
+ */

package/src/types/OcaJobQueueItem.d.ts

@@ -0,0 +1,105 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaProgramRunMode } from './OcaProgramRunMode';
+import {
+  IOcaWhenPhysicalAbsolute,
+  OcaWhenPhysicalAbsolute,
+} from './OcaWhenPhysicalAbsolute';
+import {
+  IOcaWhenPhysicalRelative,
+  OcaWhenPhysicalRelative,
+} from './OcaWhenPhysicalRelative';
+
+export declare interface IOcaJobQueueItem {
+  /**
+   * ID of this queue item.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * ONo of Executable to run
+   * @type number
+   */
+  ProgramONo: number;
+
+  /**
+   * Run mode
+   * @type IOcaProgramRunMode
+   */
+  RunMode: IOcaProgramRunMode;
+
+  /**
+   * Run parameters to use
+   * @type Uint8Array
+   */
+  RunParameters: Uint8Array;
+
+  /**
+   * When to run the Task
+   * @type (OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)
+   */
+  RunWhen: IOcaWhenPhysicalAbsolute | IOcaWhenPhysicalRelative;
+
+  /**
+   * Where to run the Task. Special values are as follows: 0 do not run 1 run on
+   * any available task in the scheduler's task list 2-4095 reserved 4096-up
+   * Value of ONo of OcaTaskAgent to use
+   * @type number
+   */
+  RunWhere: number;
+}
+
+export declare class OcaJobQueueItem implements IOcaJobQueueItem {
+  /**
+   * An item of the Job Queue in **OcaTaskAgentManager**.
+   * @class OcaJobQueueItem
+   */
+  constructor(
+    ID: number,
+    ProgramONo: number,
+    RunMode: IOcaProgramRunMode,
+    RunParameters: Uint8Array,
+    RunWhen: OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative,
+    RunWhere: number
+  );
+
+  /**
+   * ID of this queue item.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * ONo of Executable to run
+   * @type number
+   */
+  ProgramONo: number;
+
+  /**
+   * Run mode
+   * @type IOcaProgramRunMode
+   */
+  RunMode: IOcaProgramRunMode;
+
+  /**
+   * Run parameters to use
+   * @type Uint8Array
+   */
+  RunParameters: Uint8Array;
+
+  /**
+   * When to run the Task
+   * @type (OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)
+   */
+  RunWhen: OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative;
+
+  /**
+   * Where to run the Task. Special values are as follows: 0 do not run 1 run on
+   * any available task in the scheduler's task list 2-4095 reserved 4096-up
+   * Value of ONo of OcaTaskAgent to use
+   * @type number
+   */
+  RunWhere: number;
+}

package/src/types/OcaJobQueueItem.js

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaJobQueueItem {
+  /**
+   * An item of the Job Queue in **OcaTaskAgentManager**.
+   * @class OcaJobQueueItem
+   */
+  constructor(ID, ProgramONo, RunMode, RunParameters, RunWhen, RunWhere) {
+    /**
+     * ID of this queue item.
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * ONo of Executable to run
+     * @type number
+     */
+    this.ProgramONo = ProgramONo;
+    /**
+     * Run mode
+     * @type IOcaProgramRunMode
+     */
+    this.RunMode = RunMode;
+    /**
+     * Run parameters to use
+     * @type Uint8Array
+     */
+    this.RunParameters = RunParameters;
+    /**
+     * When to run the Task
+     * @type (OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)
+     */
+    this.RunWhen = RunWhen;
+    /**
+     * Where to run the Task. Special values are as follows: 0 do not run 1 run
+     * on any available task in the scheduler's task list 2-4095 reserved
+     * 4096-up Value of ONo of OcaTaskAgent to use
+     * @type number
+     */
+    this.RunWhere = RunWhere;
+  }
+}

package/src/types/OcaLibVolType.d.ts

@@ -5,8 +5,7 @@
 export declare interface IOcaLibVolType {
   /**
    * Unique identifier of organization that has authority over this library
-   * volume type. A zero value indicates a standard library volume type defined
-   * by the AES70 standard.
+   * volume type.
    * @type Uint8Array
    */
   Authority: Uint8Array;
@@ -29,8 +28,7 @@ export declare class OcaLibVolType implements IOcaLibVolType {
 
   /**
    * Unique identifier of organization that has authority over this library
-   * volume type. A zero value indicates a standard library volume type defined
-   * by the AES70 standard.
+   * volume type.
    * @type Uint8Array
    */
   Authority: Uint8Array;

package/src/types/OcaLibVolType.js

@@ -10,8 +10,7 @@ export class OcaLibVolType {
   constructor(Authority, ID) {
     /**
      * Unique identifier of organization that has authority over this library
-     * volume type. A zero value indicates a standard library volume type
-     * defined by the AES70 standard.
+     * volume type.
      * @type Uint8Array
      */
     this.Authority = Authority;

package/src/types/OcaLockState.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Lock state of object
+ * @class OcaLockState
+ */
+export class OcaLockState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static NoLock: OcaLockState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static LockNoWrite: OcaLockState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static LockNoReadWrite: OcaLockState;
+
+  /**
+   * 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 IOcaLockState =
+  | OcaLockState
+  | 'NoLock'
+  | 'LockNoWrite'
+  | 'LockNoReadWrite'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaLockState.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Lock state of object
+ * @class OcaLockState
+ */
+export class OcaLockState extends Enum({
+  NoLock: 0,
+  LockNoWrite: 1,
+  LockNoReadWrite: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaLockState}
+ * @member NoLock
+ * @memberof OcaLockState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaLockState}
+ * @member LockNoWrite
+ * @memberof OcaLockState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaLockState}
+ * @member LockNoReadWrite
+ * @memberof OcaLockState
+ * @static
+ */