aes70 1.6.1 → 2.0.0

package/src/types/OcaTaskSchedulerState.d.ts

@@ -0,0 +1,63 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * States of **OcaTaskScheduler** object. State values shall change when the
+ * object receives a Command or when processing events (e.g. completion) occur.
+ * @class OcaTaskSchedulerState
+ */
+export class OcaTaskSchedulerState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static Unknown: OcaTaskSchedulerState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Running: OcaTaskSchedulerState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Paused: OcaTaskSchedulerState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static Draining: OcaTaskSchedulerState;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static Stopped: OcaTaskSchedulerState;
+
+  /**
+   * 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 IOcaTaskSchedulerState =
+  | OcaTaskSchedulerState
+  | 'Unknown'
+  | 'Running'
+  | 'Paused'
+  | 'Draining'
+  | 'Stopped'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 4;

package/src/types/OcaTaskSchedulerState.js

@@ -0,0 +1,53 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * States of **OcaTaskScheduler** object. State values shall change when the
+ * object receives a Command or when processing events (e.g. completion) occur.
+ * @class OcaTaskSchedulerState
+ */
+export class OcaTaskSchedulerState extends Enum({
+  Unknown: 0,
+  Running: 1,
+  Paused: 2,
+  Draining: 3,
+  Stopped: 4,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaTaskSchedulerState}
+ * @member Unknown
+ * @memberof OcaTaskSchedulerState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTaskSchedulerState}
+ * @member Running
+ * @memberof OcaTaskSchedulerState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaTaskSchedulerState}
+ * @member Paused
+ * @memberof OcaTaskSchedulerState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaTaskSchedulerState}
+ * @member Draining
+ * @memberof OcaTaskSchedulerState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaTaskSchedulerState}
+ * @member Stopped
+ * @memberof OcaTaskSchedulerState
+ * @static
+ */

package/src/types/OcaTaskStatus.d.ts

@@ -25,18 +25,8 @@ export declare interface IOcaTaskStatus {
 
 export declare class OcaTaskStatus implements IOcaTaskStatus {
   /**
-   * Status of an OcaTask: task state plus a nonspecific blob named Parameter
-   * which the application can use, or not.
-   *
-   *  - The initial value of Parameter is null.
-   *
-   *  - The controller sets the value of Parameter via the Control() method.
-   *
-   *  - If the task's state changes due to an internal event (examples: task
-   *    duration value reached; or failure due to an error), Parameter is not
-   *    changed.
-   *
-   *
+   * Status of an OcaTask: task state plus an error code that gives more detail.
+   * **Deprecated** in OCA 1.5.
    * @class OcaTaskStatus
    */
   constructor(ID: number, State: OcaTaskState, ErrorCode: number);

package/src/types/OcaTaskStatus.js

@@ -4,18 +4,8 @@
 
 export class OcaTaskStatus {
   /**
-   * Status of an OcaTask: task state plus a nonspecific blob named Parameter
-   * which the application can use, or not.
-   *
-   *  - The initial value of Parameter is null.
-   *
-   *  - The controller sets the value of Parameter via the Control() method.
-   *
-   *  - If the task's state changes due to an internal event (examples: task
-   *    duration value reached; or failure due to an error), Parameter is not
-   *    changed.
-   *
-   *
+   * Status of an OcaTask: task state plus an error code that gives more detail.
+   * **Deprecated** in OCA 1.5.
    * @class OcaTaskStatus
    */
   constructor(ID, State, ErrorCode) {

package/src/types/OcaTaskStatusChangedEventData.d.ts

@@ -0,0 +1,61 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaLibVolIdentifier,
+  OcaLibVolIdentifier,
+} from './OcaLibVolIdentifier';
+import { IOcaTaskStatus, OcaTaskStatus } from './OcaTaskStatus';
+
+export declare interface IOcaTaskStatusChangedEventData {
+  /**
+   * ID of Task
+   * @type number
+   */
+  TaskID: number;
+
+  /**
+   * Identifier of OcaLibrary volume that was executing.
+   * @type OcaLibVolIdentifier
+   */
+  ProgramID: IOcaLibVolIdentifier;
+
+  /**
+   * New task status
+   * @type OcaTaskStatus
+   */
+  Status: IOcaTaskStatus;
+}
+
+export declare class OcaTaskStatusChangedEventData
+  implements IOcaTaskStatusChangedEventData {
+  /**
+   * **Deprecated** event raised by **OcaTaskManager** when the status of a
+   * legacy task changes. Legacy task are task that execute now-deprecated
+   * **OcaLibrary** volumes.
+   * @class OcaTaskStatusChangedEventData
+   */
+  constructor(
+    TaskID: number,
+    ProgramID: OcaLibVolIdentifier,
+    Status: OcaTaskStatus
+  );
+
+  /**
+   * ID of Task
+   * @type number
+   */
+  TaskID: number;
+
+  /**
+   * Identifier of OcaLibrary volume that was executing.
+   * @type OcaLibVolIdentifier
+   */
+  ProgramID: OcaLibVolIdentifier;
+
+  /**
+   * New task status
+   * @type OcaTaskStatus
+   */
+  Status: OcaTaskStatus;
+}

package/src/types/OcaTaskStatusChangedEventData.js

@@ -0,0 +1,29 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTaskStatusChangedEventData {
+  /**
+   * **Deprecated** event raised by **OcaTaskManager** when the status of a
+   * legacy task changes. Legacy task are task that execute now-deprecated
+   * **OcaLibrary** volumes.
+   * @class OcaTaskStatusChangedEventData
+   */
+  constructor(TaskID, ProgramID, Status) {
+    /**
+     * ID of Task
+     * @type number
+     */
+    this.TaskID = TaskID;
+    /**
+     * Identifier of OcaLibrary volume that was executing.
+     * @type OcaLibVolIdentifier
+     */
+    this.ProgramID = ProgramID;
+    /**
+     * New task status
+     * @type OcaTaskStatus
+     */
+    this.Status = Status;
+  }
+}

package/src/types/OcaTime.d.ts

@@ -0,0 +1,56 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaTime {
+  /**
+   * TRUE if and only if time value is negative. Absolute times are always
+   * positive.
+   * @type boolean
+   */
+  Negative: boolean;
+
+  /**
+   * 64-bit integer whose value shall not exceed that of an unsigned 48 bit
+   * integer.
+   * @type number|BigInt
+   */
+  Seconds: number | BigInt;
+
+  /**
+   * 32 bits of nanoseconds
+   * @type number
+   */
+  Nanoseconds: number;
+}
+
+export declare class OcaTime implements IOcaTime {
+  /**
+   * Absolute or relative time. Time values in PTP presentation format with
+   * added sign. - 48 bit integer seconds - 32 bit integer nanoseconds - boolean
+   * sign (positive=TRUE) field. Absolute times are always positive. Relative
+   * times may be positive or negative.
+   * @class OcaTime
+   */
+  constructor(Negative: boolean, Seconds: number | BigInt, Nanoseconds: number);
+
+  /**
+   * TRUE if and only if time value is negative. Absolute times are always
+   * positive.
+   * @type boolean
+   */
+  Negative: boolean;
+
+  /**
+   * 64-bit integer whose value shall not exceed that of an unsigned 48 bit
+   * integer.
+   * @type number|BigInt
+   */
+  Seconds: number | BigInt;
+
+  /**
+   * 32 bits of nanoseconds
+   * @type number
+   */
+  Nanoseconds: number;
+}

package/src/types/OcaTime.js

@@ -0,0 +1,32 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTime {
+  /**
+   * Absolute or relative time. Time values in PTP presentation format with
+   * added sign. - 48 bit integer seconds - 32 bit integer nanoseconds - boolean
+   * sign (positive=TRUE) field. Absolute times are always positive. Relative
+   * times may be positive or negative.
+   * @class OcaTime
+   */
+  constructor(Negative, Seconds, Nanoseconds) {
+    /**
+     * TRUE if and only if time value is negative. Absolute times are always
+     * positive.
+     * @type boolean
+     */
+    this.Negative = Negative;
+    /**
+     * 64-bit integer whose value shall not exceed that of an unsigned 48 bit
+     * integer.
+     * @type number|BigInt
+     */
+    this.Seconds = Seconds;
+    /**
+     * 32 bits of nanoseconds
+     * @type number
+     */
+    this.Nanoseconds = Nanoseconds;
+  }
+}

package/src/types/OcaTimeDeliveryMechanism.d.ts

@@ -0,0 +1,167 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Types of time delivery mechanisms. See [RFC 7273] for a detailed discussion
+ * of time sources , particularly sections 4.4-4.8. See the various time
+ * delivery method specifications (e.g. [IEEE-1588] (PTP) [RFC 5905] (NTP)
+ * [AES11] for more details.
+ * @class OcaTimeDeliveryMechanism
+ */
+export class OcaTimeDeliveryMechanism {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static Undefined: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Local: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Private: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static NTP: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static SNTP: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static IEEE1588_2002: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``6``.
+   */
+  static IEEE1588_2008: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``7``.
+   */
+  static IEEE1588_2019: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``8``.
+   */
+  static IEEE8021AS: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``9``.
+   */
+  static StreamEndpoint: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``11``.
+   */
+  static AES11: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``12``.
+   */
+  static TerrestrialRadio: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``13``.
+   */
+  static GPS: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``14``.
+   */
+  static Galileo: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``15``.
+   */
+  static GLONASS: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``16``.
+   */
+  static Beidou: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``17``.
+   */
+  static INRSS: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``128``.
+   */
+  static ExpansionBase: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static None: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``5``.
+   */
+  static IEEE1588v1: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``6``.
+   */
+  static IEEE1588v2: OcaTimeDeliveryMechanism;
+  /**
+   * Singleton object corresponding to the entry with value ``7``.
+   */
+  static IEEE1588v2_1: OcaTimeDeliveryMechanism;
+
+  /**
+   * 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 IOcaTimeDeliveryMechanism =
+  | OcaTimeDeliveryMechanism
+  | 'Undefined'
+  | 'Local'
+  | 'Private'
+  | 'NTP'
+  | 'SNTP'
+  | 'IEEE1588_2002'
+  | 'IEEE1588_2008'
+  | 'IEEE1588_2019'
+  | 'IEEE8021AS'
+  | 'StreamEndpoint'
+  | 'AES11'
+  | 'TerrestrialRadio'
+  | 'GPS'
+  | 'Galileo'
+  | 'GLONASS'
+  | 'Beidou'
+  | 'INRSS'
+  | 'ExpansionBase'
+  | 'None'
+  | 'IEEE1588v1'
+  | 'IEEE1588v2'
+  | 'IEEE1588v2_1'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 4
+  | 5
+  | 6
+  | 7
+  | 8
+  | 9
+  | 11
+  | 12
+  | 13
+  | 14
+  | 15
+  | 16
+  | 17
+  | 128
+  | 1
+  | 5
+  | 6
+  | 7;

package/src/types/OcaTimeDeliveryMechanism.js

@@ -0,0 +1,191 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Types of time delivery mechanisms. See [RFC 7273] for a detailed discussion
+ * of time sources , particularly sections 4.4-4.8. See the various time
+ * delivery method specifications (e.g. [IEEE-1588] (PTP) [RFC 5905] (NTP)
+ * [AES11] for more details.
+ * @class OcaTimeDeliveryMechanism
+ */
+export class OcaTimeDeliveryMechanism extends Enum({
+  Undefined: 0,
+  Local: 1,
+  Private: 2,
+  NTP: 3,
+  SNTP: 4,
+  IEEE1588_2002: 5,
+  IEEE1588_2008: 6,
+  IEEE1588_2019: 7,
+  IEEE8021AS: 8,
+  StreamEndpoint: 9,
+  AES11: 11,
+  TerrestrialRadio: 12,
+  GPS: 13,
+  Galileo: 14,
+  GLONASS: 15,
+  Beidou: 16,
+  INRSS: 17,
+  ExpansionBase: 128,
+  None: 1,
+  IEEE1588v1: 5,
+  IEEE1588v2: 6,
+  IEEE1588v2_1: 7,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Undefined
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Local
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Private
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member NTP
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member SNTP
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2002
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2008
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``7``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588_2019
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``8``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE8021AS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``9``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member StreamEndpoint
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``11``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member AES11
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``12``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member TerrestrialRadio
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``13``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member GPS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``14``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Galileo
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``15``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member GLONASS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``16``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member Beidou
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``17``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member INRSS
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``128``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member ExpansionBase
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member None
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``5``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v1
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``6``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v2
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``7``.
+ * @type {OcaTimeDeliveryMechanism}
+ * @member IEEE1588v2_1
+ * @memberof OcaTimeDeliveryMechanism
+ * @static
+ */