aes70 1.6.1 → 2.0.0

package/src/types/OcaStatus.d.ts

@@ -66,6 +66,18 @@ export class OcaStatus {
    * Singleton object corresponding to the entry with value ``14``.
    */
   static BufferOverflow: OcaStatus;
+  /**
+   * Singleton object corresponding to the entry with value ``15``.
+   */
+  static PermissionDenied: OcaStatus;
+  /**
+   * Singleton object corresponding to the entry with value ``16``.
+   */
+  static OutOfMemory: OcaStatus;
+  /**
+   * Singleton object corresponding to the entry with value ``17``.
+   */
+  static Busy: OcaStatus;
 
   /**
    * Returns the numeric value of this enum entry.
@@ -105,6 +117,9 @@ export type IOcaStatus =
   | 'PartiallySucceeded'
   | 'Timeout'
   | 'BufferOverflow'
+  | 'PermissionDenied'
+  | 'OutOfMemory'
+  | 'Busy'
   | 0
   | 1
   | 2
@@ -119,4 +134,7 @@ export type IOcaStatus =
   | 11
   | 12
   | 13
-  | 14;
+  | 14
+  | 15
+  | 16
+  | 17;

package/src/types/OcaStatus.js

@@ -23,6 +23,9 @@ export class OcaStatus extends Enum({
   PartiallySucceeded: 12,
   Timeout: 13,
   BufferOverflow: 14,
+  PermissionDenied: 15,
+  OutOfMemory: 16,
+  Busy: 17,
 }) {}
 
 /**
@@ -130,3 +133,24 @@ export class OcaStatus extends Enum({
  * @memberof OcaStatus
  * @static
  */
+/**
+ * Singleton object corresponding to the entry with value ``15``.
+ * @type {OcaStatus}
+ * @member PermissionDenied
+ * @memberof OcaStatus
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``16``.
+ * @type {OcaStatus}
+ * @member OutOfMemory
+ * @memberof OcaStatus
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``17``.
+ * @type {OcaStatus}
+ * @member Busy
+ * @memberof OcaStatus
+ * @static
+ */

package/src/types/OcaStream.d.ts

@@ -54,7 +54,7 @@ export declare interface IOcaStream {
   RemoteConnectorIdentification: IOcaStreamConnectorIdentification;
 
   /**
-   * True iff connection is secure.
+   * True if and only if connection is secure.
    * @type boolean
    */
   Secure: boolean;
@@ -158,7 +158,7 @@ export declare class OcaStream implements IOcaStream {
   RemoteConnectorIdentification: OcaStreamConnectorIdentification;
 
   /**
-   * True iff connection is secure.
+   * True if and only if connection is secure.
    * @type boolean
    */
   Secure: boolean;

package/src/types/OcaStream.js

@@ -74,7 +74,7 @@ export class OcaStream {
      */
     this.RemoteConnectorIdentification = RemoteConnectorIdentification;
     /**
-     * True iff connection is secure.
+     * True if and only if connection is secure.
      * @type boolean
      */
     this.Secure = Secure;

package/src/types/OcaTask.d.ts

@@ -5,8 +5,8 @@ import {
   IOcaLibVolIdentifier,
   OcaLibVolIdentifier,
 } from './OcaLibVolIdentifier';
+import { IOcaTime, OcaTime } from './OcaTime';
 import { IOcaTimeMode, OcaTimeMode } from './OcaTimeMode';
-import { IOcaTimePTP, OcaTimePTP } from './OcaTimePTP';
 
 export declare interface IOcaTask {
   /**
@@ -21,7 +21,7 @@ export declare interface IOcaTask {
   Label: string;
 
   /**
-   * ID of program this task was given or null if it's idle.
+   * ID of program this task was given or all null if it's idle.
    * @type OcaLibVolIdentifier
    */
   ProgramID: IOcaLibVolIdentifier;
@@ -39,8 +39,7 @@ export declare interface IOcaTask {
   TimeMode: IOcaTimeMode;
 
   /**
-   * ONo of relevant **OcaTimeSource** object or zero to use device time (see
-   * **OcaDeviceTimeManager**).
+   * ONo of relevant OcaTimeSource object, or zero if none.
    * @type number
    */
   TimeSourceONo: number;
@@ -50,19 +49,19 @@ export declare interface IOcaTask {
    * **TimeMode=Relative**, the actual event start time equals the value of
    * **StartTime** plus the absolute time that **StartTime** was most recently
    * set. Datatype shall depend on value of **TimeUnits**: - If **TimeUnits** is
-   * seconds, datatype shall be **OcaTimePTP;** - If TimeUnits is samples,
-   * datatype shall be **OcaUint64**. If **TimeMode=Absolute**, the actual event
-   * start time equals the value of **StartTime**
-   * @type OcaTimePTP
+   * seconds, datatype shall be **OcaTime;** - If TimeUnits is samples, datatype
+   * shall be **OcaUint64**. If **TimeMode=Absolute**, the actual event start
+   * time equals the value of **StartTime**
+   * @type OcaTime
    */
-  StartTime: IOcaTimePTP;
+  StartTime: IOcaTime;
 
   /**
    * Duration of task execution, or zero to run until complete or explicitly
    * stopped.
-   * @type OcaTimePTP
+   * @type number
    */
-  Duration: IOcaTimePTP;
+  Duration: number;
 
   /**
    * Arbitrary application-specific parameters for the Task and its Program.
@@ -74,7 +73,8 @@ export declare interface IOcaTask {
 export declare class OcaTask implements IOcaTask {
   /**
    * An execution thread that runs an AES70 Program. Programs are OcaLibrary
-   * volumes that contain application-specific execution instructions.
+   * volumes that contain application-specific execution instructions. **
+   * Deprecated** in OCA 1.5.
    * @class OcaTask
    */
   constructor(
@@ -84,8 +84,8 @@ export declare class OcaTask implements IOcaTask {
     GroupID: number,
     TimeMode: OcaTimeMode,
     TimeSourceONo: number,
-    StartTime: OcaTimePTP,
-    Duration: OcaTimePTP,
+    StartTime: OcaTime,
+    Duration: number,
     ApplicationSpecificParameters: Uint8Array
   );
 
@@ -101,7 +101,7 @@ export declare class OcaTask implements IOcaTask {
   Label: string;
 
   /**
-   * ID of program this task was given or null if it's idle.
+   * ID of program this task was given or all null if it's idle.
    * @type OcaLibVolIdentifier
    */
   ProgramID: OcaLibVolIdentifier;
@@ -119,8 +119,7 @@ export declare class OcaTask implements IOcaTask {
   TimeMode: OcaTimeMode;
 
   /**
-   * ONo of relevant **OcaTimeSource** object or zero to use device time (see
-   * **OcaDeviceTimeManager**).
+   * ONo of relevant OcaTimeSource object, or zero if none.
    * @type number
    */
   TimeSourceONo: number;
@@ -130,19 +129,19 @@ export declare class OcaTask implements IOcaTask {
    * **TimeMode=Relative**, the actual event start time equals the value of
    * **StartTime** plus the absolute time that **StartTime** was most recently
    * set. Datatype shall depend on value of **TimeUnits**: - If **TimeUnits** is
-   * seconds, datatype shall be **OcaTimePTP;** - If TimeUnits is samples,
-   * datatype shall be **OcaUint64**. If **TimeMode=Absolute**, the actual event
-   * start time equals the value of **StartTime**
-   * @type OcaTimePTP
+   * seconds, datatype shall be **OcaTime;** - If TimeUnits is samples, datatype
+   * shall be **OcaUint64**. If **TimeMode=Absolute**, the actual event start
+   * time equals the value of **StartTime**
+   * @type OcaTime
    */
-  StartTime: OcaTimePTP;
+  StartTime: OcaTime;
 
   /**
    * Duration of task execution, or zero to run until complete or explicitly
    * stopped.
-   * @type OcaTimePTP
+   * @type number
    */
-  Duration: OcaTimePTP;
+  Duration: number;
 
   /**
    * Arbitrary application-specific parameters for the Task and its Program.

package/src/types/OcaTask.js

@@ -5,7 +5,8 @@
 export class OcaTask {
   /**
    * An execution thread that runs an AES70 Program. Programs are OcaLibrary
-   * volumes that contain application-specific execution instructions.
+   * volumes that contain application-specific execution instructions. **
+   * Deprecated** in OCA 1.5.
    * @class OcaTask
    */
   constructor(
@@ -29,7 +30,7 @@ export class OcaTask {
      */
     this.Label = Label;
     /**
-     * ID of program this task was given or null if it's idle.
+     * ID of program this task was given or all null if it's idle.
      * @type OcaLibVolIdentifier
      */
     this.ProgramID = ProgramID;
@@ -44,8 +45,7 @@ export class OcaTask {
      */
     this.TimeMode = TimeMode;
     /**
-     * ONo of relevant **OcaTimeSource** object or zero to use device time (see
-     * **OcaDeviceTimeManager**).
+     * ONo of relevant OcaTimeSource object, or zero if none.
      * @type number
      */
     this.TimeSourceONo = TimeSourceONo;
@@ -54,16 +54,16 @@ export class OcaTask {
      * **TimeMode=Relative**, the actual event start time equals the value of
      * **StartTime** plus the absolute time that **StartTime** was most recently
      * set. Datatype shall depend on value of **TimeUnits**: - If **TimeUnits**
-     * is seconds, datatype shall be **OcaTimePTP;** - If TimeUnits is samples,
+     * is seconds, datatype shall be **OcaTime;** - If TimeUnits is samples,
      * datatype shall be **OcaUint64**. If **TimeMode=Absolute**, the actual
      * event start time equals the value of **StartTime**
-     * @type OcaTimePTP
+     * @type OcaTime
      */
     this.StartTime = StartTime;
     /**
      * Duration of task execution, or zero to run until complete or explicitly
      * stopped.
-     * @type OcaTimePTP
+     * @type number
      */
     this.Duration = Duration;
     /**

package/src/types/OcaTaskCommand.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Commands controllers can send to OcaTasks to change their states
+ * Commands controllers can send to OcaTasks to change their states.
+ * **Deprecated** in OCA 1.5.
  * @class OcaTaskCommand
  */
 export class OcaTaskCommand {
@@ -14,10 +15,6 @@ export class OcaTaskCommand {
    * Singleton object corresponding to the entry with value ``1``.
    */
   static Prepare: OcaTaskCommand;
-  /**
-   * Singleton object corresponding to the entry with value ``2``.
-   */
-  static Enable: OcaTaskCommand;
   /**
    * Singleton object corresponding to the entry with value ``3``.
    */
@@ -64,7 +61,6 @@ export type IOcaTaskCommand =
   | OcaTaskCommand
   | 'None'
   | 'Prepare'
-  | 'Enable'
   | 'Start'
   | 'Stop'
   | 'Abort'
@@ -72,7 +68,6 @@ export type IOcaTaskCommand =
   | 'Clear'
   | 0
   | 1
-  | 2
   | 3
   | 4
   | 5

package/src/types/OcaTaskCommand.js

@@ -4,13 +4,13 @@
 import { Enum } from './Enum.js';
 
 /**
- * Commands controllers can send to OcaTasks to change their states
+ * Commands controllers can send to OcaTasks to change their states.
+ * **Deprecated** in OCA 1.5.
  * @class OcaTaskCommand
  */
 export class OcaTaskCommand extends Enum({
   None: 0,
   Prepare: 1,
-  Enable: 2,
   Start: 3,
   Stop: 4,
   Abort: 5,
@@ -32,13 +32,6 @@ export class OcaTaskCommand extends Enum({
  * @memberof OcaTaskCommand
  * @static
  */
-/**
- * Singleton object corresponding to the entry with value ``2``.
- * @type {OcaTaskCommand}
- * @member Enable
- * @memberof OcaTaskCommand
- * @static
- */
 /**
  * Singleton object corresponding to the entry with value ``3``.
  * @type {OcaTaskCommand}

package/src/types/OcaTaskExecutionTerminatedEventData.d.ts

@@ -0,0 +1,64 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaCommandSetResult,
+  OcaCommandSetResult,
+} from './OcaCommandSetResult';
+import { IOcaExecutableType, OcaExecutableType } from './OcaExecutableType';
+import { IOcaProgramResult, OcaProgramResult } from './OcaProgramResult';
+
+export declare interface IOcaTaskExecutionTerminatedEventData {
+  /**
+   * Type of Executable - Program or Commandset.
+   * @type OcaExecutableType
+   */
+  ExecutableType: IOcaExecutableType;
+
+  /**
+   * Object number of Executable.
+   * @type number
+   */
+  ExecutableONo: number;
+
+  /**
+   * Execution result: {generic status, program-type-specific details}. Datatype
+   * depends on whether Executable is a Program or a Commandset.
+   * @type (OcaProgramResult | OcaCommandSetResult)
+   */
+  Result: IOcaProgramResult | IOcaCommandSetResult;
+}
+
+export declare class OcaTaskExecutionTerminatedEventData
+  implements IOcaTaskExecutionTerminatedEventData {
+  /**
+   * Notification data emitted by the **OcaTaskAgent.TaskChanged** event upon
+   * successful or unsuccessful termination of an Executable the task agent has
+   * been running.
+   * @class OcaTaskExecutionTerminatedEventData
+   */
+  constructor(
+    ExecutableType: OcaExecutableType,
+    ExecutableONo: number,
+    Result: OcaProgramResult | OcaCommandSetResult
+  );
+
+  /**
+   * Type of Executable - Program or Commandset.
+   * @type OcaExecutableType
+   */
+  ExecutableType: OcaExecutableType;
+
+  /**
+   * Object number of Executable.
+   * @type number
+   */
+  ExecutableONo: number;
+
+  /**
+   * Execution result: {generic status, program-type-specific details}. Datatype
+   * depends on whether Executable is a Program or a Commandset.
+   * @type (OcaProgramResult | OcaCommandSetResult)
+   */
+  Result: OcaProgramResult | OcaCommandSetResult;
+}

package/src/types/OcaTaskExecutionTerminatedEventData.js

@@ -0,0 +1,30 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTaskExecutionTerminatedEventData {
+  /**
+   * Notification data emitted by the **OcaTaskAgent.TaskChanged** event upon
+   * successful or unsuccessful termination of an Executable the task agent has
+   * been running.
+   * @class OcaTaskExecutionTerminatedEventData
+   */
+  constructor(ExecutableType, ExecutableONo, Result) {
+    /**
+     * Type of Executable - Program or Commandset.
+     * @type OcaExecutableType
+     */
+    this.ExecutableType = ExecutableType;
+    /**
+     * Object number of Executable.
+     * @type number
+     */
+    this.ExecutableONo = ExecutableONo;
+    /**
+     * Execution result: {generic status, program-type-specific details}.
+     * Datatype depends on whether Executable is a Program or a Commandset.
+     * @type (OcaProgramResult | OcaCommandSetResult)
+     */
+    this.Result = Result;
+  }
+}

package/src/types/OcaTaskGenericState.d.ts

@@ -0,0 +1,64 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * States of OcaTask object. State values shall change as a result of the
+ * object's having received a Command or encountering processing events (e.g.
+ * completion).
+ * @class OcaTaskGenericState
+ */
+export class OcaTaskGenericState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static None: OcaTaskGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Idle: OcaTaskGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Ready: OcaTaskGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static Running: OcaTaskGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``4``.
+   */
+  static Ended: OcaTaskGenericState;
+
+  /**
+   * 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 IOcaTaskGenericState =
+  | OcaTaskGenericState
+  | 'None'
+  | 'Idle'
+  | 'Ready'
+  | 'Running'
+  | 'Ended'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 4;

package/src/types/OcaTaskGenericState.js

@@ -0,0 +1,54 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * States of OcaTask object. State values shall change as a result of the
+ * object's having received a Command or encountering processing events (e.g.
+ * completion).
+ * @class OcaTaskGenericState
+ */
+export class OcaTaskGenericState extends Enum({
+  None: 0,
+  Idle: 1,
+  Ready: 2,
+  Running: 3,
+  Ended: 4,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaTaskGenericState}
+ * @member None
+ * @memberof OcaTaskGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaTaskGenericState}
+ * @member Idle
+ * @memberof OcaTaskGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaTaskGenericState}
+ * @member Ready
+ * @memberof OcaTaskGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaTaskGenericState}
+ * @member Running
+ * @memberof OcaTaskGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``4``.
+ * @type {OcaTaskGenericState}
+ * @member Ended
+ * @memberof OcaTaskGenericState
+ * @static
+ */

package/src/types/OcaTaskManagerState.d.ts

@@ -25,6 +25,7 @@
  *  - passing a **Stop** or **Abort** command to each task individually.
  *
  *
+ * **Deprecated** in OCA 1.5.
  * @class OcaTaskManagerState
  */
 export class OcaTaskManagerState {

package/src/types/OcaTaskManagerState.js

@@ -27,6 +27,7 @@ import { Enum } from './Enum.js';
  *  - passing a **Stop** or **Abort** command to each task individually.
  *
  *
+ * **Deprecated** in OCA 1.5.
  * @class OcaTaskManagerState
  */
 export class OcaTaskManagerState extends Enum({

package/src/types/OcaTaskOperationalState.d.ts

@@ -0,0 +1,43 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaTaskGenericState,
+  OcaTaskGenericState,
+} from './OcaTaskGenericState';
+import { IOcaTypedBlob, OcaTypedBlob } from './OcaTypedBlob';
+
+export declare interface IOcaTaskOperationalState {
+  /**
+   * Generic state of this Task Agent.
+   * @type OcaTaskGenericState
+   */
+  Generic: IOcaTaskGenericState;
+
+  /**
+   * Device-specific state details (optional)
+   * @type OcaTypedBlob[]
+   */
+  Details: IOcaTypedBlob[];
+}
+
+export declare class OcaTaskOperationalState
+  implements IOcaTaskOperationalState {
+  /**
+   * Operational state of task: generic state + task-specific details
+   * @class OcaTaskOperationalState
+   */
+  constructor(Generic: OcaTaskGenericState, Details: OcaTypedBlob[]);
+
+  /**
+   * Generic state of this Task Agent.
+   * @type OcaTaskGenericState
+   */
+  Generic: OcaTaskGenericState;
+
+  /**
+   * Device-specific state details (optional)
+   * @type OcaTypedBlob[]
+   */
+  Details: OcaTypedBlob[];
+}

package/src/types/OcaTaskOperationalState.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaTaskOperationalState {
+  /**
+   * Operational state of task: generic state + task-specific details
+   * @class OcaTaskOperationalState
+   */
+  constructor(Generic, Details) {
+    /**
+     * Generic state of this Task Agent.
+     * @type OcaTaskGenericState
+     */
+    this.Generic = Generic;
+    /**
+     * Device-specific state details (optional)
+     * @type OcaTypedBlob[]
+     */
+    this.Details = Details;
+  }
+}