aes70 1.3.7 → 1.4.0

package/src/types/OcaTask.js

@@ -4,7 +4,8 @@
 
 export class OcaTask {
   /**
-   * An execution thread that runs an AES70 Program. Programs are OcaLibrary volumes that contain application-specific execution instructions.
+   * An execution thread that runs an AES70 Program. Programs are OcaLibrary
+   * volumes that contain application-specific execution instructions.
    * @class OcaTask
    */
   constructor(
@@ -24,7 +25,6 @@ export class OcaTask {
      */
     this.ID = ID;
     /**
-     * This was not documented in the OCA standard.
      * @type string
      */
     this.Label = Label;
@@ -44,23 +44,31 @@ 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 to use device time (see
+     * **OcaDeviceTimeManager**).
      * @type number
      */
     this.TimeSourceONo = TimeSourceONo;
     /**
-     * Time at which to start task, or zero if task will be manually started. If  **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**
+     * Time at which to start task, or zero if task will be manually started. If
+     * **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
      */
     this.StartTime = StartTime;
     /**
-     * Duration of task execution, or zero to run until complete or explicitly stopped.
+     * Duration of task execution, or zero to run until complete or explicitly
+     * stopped.
      * @type OcaTimePTP
      */
     this.Duration = Duration;
     /**
      * Arbitrary application-specific parameters for the Task and its Program.
-     * @type string
+     * @type Uint8Array
      */
     this.ApplicationSpecificParameters = ApplicationSpecificParameters;
   }

package/src/types/OcaTaskManagerState.d.ts

@@ -2,25 +2,29 @@
  * This file has been generated.
  */
 /**
- * States of  **OcaTaskManager** object. These states represent the overall state of task processing in the device.
+ * States of **OcaTaskManager** object. These states represent the overall state
+ * of task processing in the device.
  *
- *  - Device task processing state is  **Enabled** by default. In  **Enabled** state, tasks may be running.
+ *  - Device task processing state is **Enabled** by default. In **Enabled**
+ *    state, tasks may be running.
  *
+ *  - Device task processing state may be **Disabled** by the **OcaTaskManager
+ *    Disable** command.
  *
- *  - Device task processing state may be  **Disabled** by the  **OcaTaskManager Disable** command.
+ *  - The **Disable** command will succeed only if no tasks are running.
  *
  *
- *  - The  **Disable** command will succeed only if no tasks are running.
- *   Tasks may be stopped by:
+ * Tasks may be stopped by:
  *
- *  - passing the  **OcaTaskManager** a  **Stop** or  **Abort** command, which will stop all tasks in the device; or
+ *  - passing the **OcaTaskManager** a **Stop** or **Abort** command, which will
+ *    stop all tasks in the device; or
  *
+ *  - passing a **Stop** or **Abort** command to each **OcaTaskGroup** agent,
+ *    which will stop all the tasks in the given task groups; or
  *
- *  - passing a  **Stop** or  **Abort** command to each  **OcaTaskGroup** agent, which will stop all the tasks in the given task groups; or
+ *  - passing a **Stop** or **Abort** command to each task individually.
  *
  *
- *  - passing a  **Stop** or  **Abort** command to each task individually.
- *
  * @class OcaTaskManagerState
  */
 export class OcaTaskManagerState {

package/src/types/OcaTaskManagerState.js

@@ -4,25 +4,29 @@
 import { Enum } from './Enum.js';
 
 /**
- * States of  **OcaTaskManager** object. These states represent the overall state of task processing in the device.
+ * States of **OcaTaskManager** object. These states represent the overall state
+ * of task processing in the device.
  *
- *  - Device task processing state is  **Enabled** by default. In  **Enabled** state, tasks may be running.
+ *  - Device task processing state is **Enabled** by default. In **Enabled**
+ *    state, tasks may be running.
  *
+ *  - Device task processing state may be **Disabled** by the **OcaTaskManager
+ *    Disable** command.
  *
- *  - Device task processing state may be  **Disabled** by the  **OcaTaskManager Disable** command.
+ *  - The **Disable** command will succeed only if no tasks are running.
  *
  *
- *  - The  **Disable** command will succeed only if no tasks are running.
- *   Tasks may be stopped by:
+ * Tasks may be stopped by:
  *
- *  - passing the  **OcaTaskManager** a  **Stop** or  **Abort** command, which will stop all tasks in the device; or
+ *  - passing the **OcaTaskManager** a **Stop** or **Abort** command, which will
+ *    stop all tasks in the device; or
  *
+ *  - passing a **Stop** or **Abort** command to each **OcaTaskGroup** agent,
+ *    which will stop all the tasks in the given task groups; or
  *
- *  - passing a  **Stop** or  **Abort** command to each  **OcaTaskGroup** agent, which will stop all the tasks in the given task groups; or
+ *  - passing a **Stop** or **Abort** command to each task individually.
  *
  *
- *  - passing a  **Stop** or  **Abort** command to each task individually.
- *
  * @class OcaTaskManagerState
  */
 export class OcaTaskManagerState extends Enum({

package/src/types/OcaTaskState.d.ts

@@ -2,7 +2,9 @@
  * This file has been generated.
  */
 /**
- * States of OcaTask object. State values change as a result of the object's having received a comment or encountering processing events (e.g. completion).
+ * States of OcaTask object. State values change as a result of the object's
+ * having received a comment or encountering processing events (e.g.
+ * completion).
  * @class OcaTaskState
  */
 export class OcaTaskState {

package/src/types/OcaTaskState.js

@@ -4,7 +4,9 @@
 import { Enum } from './Enum.js';
 
 /**
- * States of OcaTask object. State values change as a result of the object's having received a comment or encountering processing events (e.g. completion).
+ * States of OcaTask object. State values change as a result of the object's
+ * having received a comment or encountering processing events (e.g.
+ * completion).
  * @class OcaTaskState
  */
 export class OcaTaskState extends Enum({

package/src/types/OcaTaskStateChangedEventData.d.ts

@@ -1,12 +1,11 @@
 /*
  * This file has been generated.
  */
-
 import {
-  OcaLibVolIdentifier,
   IOcaLibVolIdentifier,
+  OcaLibVolIdentifier,
 } from './OcaLibVolIdentifier';
-import { OcaTaskStatus, IOcaTaskStatus } from './OcaTaskStatus';
+import { IOcaTaskStatus, OcaTaskStatus } from './OcaTaskStatus';
 
 export declare interface IOcaTaskStateChangedEventData {
   /**
@@ -16,7 +15,8 @@ export declare interface IOcaTaskStateChangedEventData {
   TaskID: number;
 
   /**
-   * Library volume identifier of Program running in the task at the time of the change, or null
+   * Library volume identifier of Program running in the task at the time of the
+   * change, or null
    * @type OcaLibVolIdentifier
    */
   ProgramID: IOcaLibVolIdentifier;
@@ -31,7 +31,6 @@ export declare interface IOcaTaskStateChangedEventData {
 export declare class OcaTaskStateChangedEventData
   implements IOcaTaskStateChangedEventData {
   /**
-   * This was not documented in the OCA standard.
    * @class OcaTaskStateChangedEventData
    */
   constructor(
@@ -47,7 +46,8 @@ export declare class OcaTaskStateChangedEventData
   TaskID: number;
 
   /**
-   * Library volume identifier of Program running in the task at the time of the change, or null
+   * Library volume identifier of Program running in the task at the time of the
+   * change, or null
    * @type OcaLibVolIdentifier
    */
   ProgramID: OcaLibVolIdentifier;

package/src/types/OcaTaskStateChangedEventData.js

@@ -4,7 +4,6 @@
 
 export class OcaTaskStateChangedEventData {
   /**
-   * This was not documented in the OCA standard.
    * @class OcaTaskStateChangedEventData
    */
   constructor(TaskID, ProgramID, Status) {
@@ -14,7 +13,8 @@ export class OcaTaskStateChangedEventData {
      */
     this.TaskID = TaskID;
     /**
-     * Library volume identifier of Program running in the task at the time of the change, or null
+     * Library volume identifier of Program running in the task at the time of
+     * the change, or null
      * @type OcaLibVolIdentifier
      */
     this.ProgramID = ProgramID;

package/src/types/OcaTaskStatus.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaTaskState, IOcaTaskState } from './OcaTaskState';
+import { IOcaTaskState, OcaTaskState } from './OcaTaskState';
 
 export declare interface IOcaTaskStatus {
   /**
@@ -26,15 +25,17 @@ 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.
+   * 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.
    *
-   *  - 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.
    *
    * @class OcaTaskStatus
    */

package/src/types/OcaTaskStatus.js

@@ -4,15 +4,17 @@
 
 export class OcaTaskStatus {
   /**
-   * Status of an OcaTask: task state plus a nonspecific blob named Parameter which the application can use, or not.
+   * 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.
    *
-   *  - 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.
    *
    * @class OcaTaskStatus
    */

package/src/types/OcaTimeMode.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Time mode of  **OcaTask** agent.
+ * Time mode of **OcaTask** agent.
  * @class OcaTimeMode
  */
 export class OcaTimeMode {

package/src/types/OcaTimeMode.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Time mode of  **OcaTask** agent.
+ * Time mode of **OcaTask** agent.
  * @class OcaTimeMode
  */
 export class OcaTimeMode extends Enum({

package/src/types/OcaTimePTP.d.ts

@@ -4,7 +4,8 @@
 
 export declare interface IOcaTimePTP {
   /**
-   * TRUE if and only if time value is negative. Absolute times are always positive.
+   * TRUE if and only if time value is negative. Absolute times are always
+   * positive.
    * @type boolean
    */
   Negative: boolean;
@@ -24,13 +25,17 @@ export declare interface IOcaTimePTP {
 
 export declare class OcaTimePTP implements IOcaTimePTP {
   /**
-   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit integer seconds - 32 bit integer nanoseconds PLUS a boolean sign (positive=TRUE) field. Absolute times are always positive. Relative times may be positive or negative.
+   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit
+   * integer seconds - 32 bit integer nanoseconds PLUS a boolean sign
+   * (positive=TRUE) field. Absolute times are always positive. Relative times
+   * may be positive or negative.
    * @class OcaTimePTP
    */
   constructor(Negative: boolean, Seconds: number | BigInt, Nanoseconds: number);
 
   /**
-   * TRUE if and only if time value is negative. Absolute times are always positive.
+   * TRUE if and only if time value is negative. Absolute times are always
+   * positive.
    * @type boolean
    */
   Negative: boolean;

package/src/types/OcaTimePTP.js

@@ -4,12 +4,16 @@
 
 export class OcaTimePTP {
   /**
-   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit integer seconds - 32 bit integer nanoseconds PLUS a boolean sign (positive=TRUE) field. Absolute times are always positive. Relative times may be positive or negative.
+   * An absolute or relative PTP time. Format is standard PTP format: - 48 bit
+   * integer seconds - 32 bit integer nanoseconds PLUS a boolean sign
+   * (positive=TRUE) field. Absolute times are always positive. Relative times
+   * may be positive or negative.
    * @class OcaTimePTP
    */
   constructor(Negative, Seconds, Nanoseconds) {
     /**
-     * TRUE if and only if time value is negative. Absolute times are always positive.
+     * TRUE if and only if time value is negative. Absolute times are always
+     * positive.
      * @type boolean
      */
     this.Negative = Negative;

package/src/types/OcaTransferFunction.js

@@ -10,17 +10,17 @@ export class OcaTransferFunction {
   constructor(Frequency, Amplitude, Phase) {
     /**
      * Frequencies
-     * @type Array
+     * @type number[]
      */
     this.Frequency = Frequency;
     /**
      * Amplitude (not in dB)
-     * @type Array
+     * @type number[]
      */
     this.Amplitude = Amplitude;
     /**
      * Phase in radians.
-     * @type Array
+     * @type number[]
      */
     this.Phase = Phase;
   }

package/src/types/OcaUnitOfMeasure.d.ts

@@ -2,7 +2,11 @@
  * This file has been generated.
  */
 /**
- * Enumeration of units of measure that can be used in OCA classes. Only SI (base or derived) units are specified, so that internal calculations will not need to convert. If conversion is needed it should only be done in user interfaces. The datatype of a reading expressed in one of these units of measure is FLOAT.
+ * Enumeration of units of measure that can be used in OCA classes. Only SI
+ * (base or derived) units are specified, so that internal calculations will not
+ * need to convert. If conversion is needed it should only be done in user
+ * interfaces. The datatype of a reading expressed in one of these units of
+ * measure is FLOAT.
  * @class OcaUnitOfMeasure
  */
 export class OcaUnitOfMeasure {

package/src/types/OcaUnitOfMeasure.js

@@ -4,7 +4,11 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration of units of measure that can be used in OCA classes. Only SI (base or derived) units are specified, so that internal calculations will not need to convert. If conversion is needed it should only be done in user interfaces. The datatype of a reading expressed in one of these units of measure is FLOAT.
+ * Enumeration of units of measure that can be used in OCA classes. Only SI
+ * (base or derived) units are specified, so that internal calculations will not
+ * need to convert. If conversion is needed it should only be done in user
+ * interfaces. The datatype of a reading expressed in one of these units of
+ * measure is FLOAT.
  * @class OcaUnitOfMeasure
  */
 export class OcaUnitOfMeasure extends Enum({

package/src/types/OcaVersion.d.ts

@@ -1,8 +1,7 @@
 /*
  * This file has been generated.
  */
-
-import { OcaComponent, IOcaComponent } from './OcaComponent';
+import { IOcaComponent, OcaComponent } from './OcaComponent';
 
 export declare interface IOcaVersion {
   /**
@@ -18,7 +17,8 @@ export declare interface IOcaVersion {
   Minor: number;
 
   /**
-   * The build number. May be 0 if it is not used (e.g. for a hardware component).
+   * The build number. May be 0 if it is not used (e.g. for a hardware
+   * component).
    * @type number
    */
   Build: number;
@@ -32,7 +32,8 @@ export declare interface IOcaVersion {
 
 export declare class OcaVersion implements IOcaVersion {
   /**
-   * Representation of a version number of a (hardware/software) component of a device in the form of Major.Minor.Build (e.g. 1.0.123).
+   * Representation of a version number of a (hardware/software) component of a
+   * device in the form of Major.Minor.Build (e.g. 1.0.123).
    * @class OcaVersion
    */
   constructor(
@@ -55,7 +56,8 @@ export declare class OcaVersion implements IOcaVersion {
   Minor: number;
 
   /**
-   * The build number. May be 0 if it is not used (e.g. for a hardware component).
+   * The build number. May be 0 if it is not used (e.g. for a hardware
+   * component).
    * @type number
    */
   Build: number;

package/src/types/OcaVersion.js

@@ -4,7 +4,8 @@
 
 export class OcaVersion {
   /**
-   * Representation of a version number of a (hardware/software) component of a device in the form of Major.Minor.Build (e.g. 1.0.123).
+   * Representation of a version number of a (hardware/software) component of a
+   * device in the form of Major.Minor.Build (e.g. 1.0.123).
    * @class OcaVersion
    */
   constructor(Major, Minor, Build, Component) {
@@ -19,7 +20,8 @@ export class OcaVersion {
      */
     this.Minor = Minor;
     /**
-     * The build number. May be 0 if it is not used (e.g. for a hardware component).
+     * The build number. May be 0 if it is not used (e.g. for a hardware
+     * component).
      * @type number
      */
     this.Build = Build;