aes70 1.6.1 → 2.0.0

package/src/types/OcaApplicationNetworkCommand.js

@@ -11,9 +11,6 @@ export class OcaApplicationNetworkCommand extends Enum({
   None: 0,
   Prepare: 1,
   Start: 2,
-  Pause: 3,
-  Stop: 4,
-  Reset: 5,
 }) {}
 
 /**
@@ -37,24 +34,3 @@ export class OcaApplicationNetworkCommand extends Enum({
  * @memberof OcaApplicationNetworkCommand
  * @static
  */
-/**
- * Singleton object corresponding to the entry with value ``3``.
- * @type {OcaApplicationNetworkCommand}
- * @member Pause
- * @memberof OcaApplicationNetworkCommand
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``4``.
- * @type {OcaApplicationNetworkCommand}
- * @member Stop
- * @memberof OcaApplicationNetworkCommand
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``5``.
- * @type {OcaApplicationNetworkCommand}
- * @member Reset
- * @memberof OcaApplicationNetworkCommand
- * @static
- */

package/src/types/OcaApplicationNetworkState.d.ts

@@ -18,30 +18,6 @@ export class OcaApplicationNetworkState {
    * Singleton object corresponding to the entry with value ``2``.
    */
   static Readying: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``3``.
-   */
-  static Ready: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``4``.
-   */
-  static Running: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``5``.
-   */
-  static Paused: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``6``.
-   */
-  static Stopping: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``7``.
-   */
-  static Stopped: OcaApplicationNetworkState;
-  /**
-   * Singleton object corresponding to the entry with value ``8``.
-   */
-  static Fault: OcaApplicationNetworkState;
 
   /**
    * Returns the numeric value of this enum entry.
@@ -69,18 +45,6 @@ export type IOcaApplicationNetworkState =
   | 'Unknown'
   | 'NotReady'
   | 'Readying'
-  | 'Ready'
-  | 'Running'
-  | 'Paused'
-  | 'Stopping'
-  | 'Stopped'
-  | 'Fault'
   | 0
   | 1
-  | 2
-  | 3
-  | 4
-  | 5
-  | 6
-  | 7
-  | 8;
+  | 2;

package/src/types/OcaApplicationNetworkState.js

@@ -11,12 +11,6 @@ export class OcaApplicationNetworkState extends Enum({
   Unknown: 0,
   NotReady: 1,
   Readying: 2,
-  Ready: 3,
-  Running: 4,
-  Paused: 5,
-  Stopping: 6,
-  Stopped: 7,
-  Fault: 8,
 }) {}
 
 /**
@@ -40,45 +34,3 @@ export class OcaApplicationNetworkState extends Enum({
  * @memberof OcaApplicationNetworkState
  * @static
  */
-/**
- * Singleton object corresponding to the entry with value ``3``.
- * @type {OcaApplicationNetworkState}
- * @member Ready
- * @memberof OcaApplicationNetworkState
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``4``.
- * @type {OcaApplicationNetworkState}
- * @member Running
- * @memberof OcaApplicationNetworkState
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``5``.
- * @type {OcaApplicationNetworkState}
- * @member Paused
- * @memberof OcaApplicationNetworkState
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``6``.
- * @type {OcaApplicationNetworkState}
- * @member Stopping
- * @memberof OcaApplicationNetworkState
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``7``.
- * @type {OcaApplicationNetworkState}
- * @member Stopped
- * @memberof OcaApplicationNetworkState
- * @static
- */
-/**
- * Singleton object corresponding to the entry with value ``8``.
- * @type {OcaApplicationNetworkState}
- * @member Fault
- * @memberof OcaApplicationNetworkState
- * @static
- */

package/src/types/OcaBlockConfigurability.d.ts

@@ -0,0 +1,26 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset that defines a Block's Configurability.
+ * @enum {number}
+ * @readonly
+ */
+export declare const OcaBlockConfigurability: {
+  /**
+   * Entry with value ``1``.
+   */
+  ActionObjects: number;
+
+  /**
+   * Entry with value ``2``.
+   */
+  SignalPaths: number;
+
+  /**
+   * Entry with value ``4``.
+   */
+  DatasetObjects: number;
+};
+
+export declare type IOcaBlockConfigurability = number;

package/src/types/OcaBlockConfigurability.js

@@ -0,0 +1,35 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Bitset that defines a Block's Configurability.
+ * @enum {number}
+ * @readonly
+ */
+export const OcaBlockConfigurability = {
+  ActionObjects: 1,
+  SignalPaths: 2,
+  DatasetObjects: 4,
+};
+
+/**
+ * Entry with value ``1``.
+ * @type {number}
+ * @member ActionObjects
+ * @memberof OcaBlockConfigurability
+ * @static
+ */
+/**
+ * Entry with value ``2``.
+ * @type {number}
+ * @member SignalPaths
+ * @memberof OcaBlockConfigurability
+ * @static
+ */
+/**
+ * Entry with value ``4``.
+ * @type {number}
+ * @member DatasetObjects
+ * @memberof OcaBlockConfigurability
+ * @static
+ */

package/src/types/OcaClassicalFilterShape.d.ts

@@ -2,7 +2,7 @@
  * This file has been generated.
  */
 /**
- * Enumeration of classicalr filter types that can be used by OCA objects.
+ * Enumeration of classical filter shapes
  * @class OcaClassicalFilterShape
  */
 export class OcaClassicalFilterShape {

package/src/types/OcaClassicalFilterShape.js

@@ -4,7 +4,7 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration of classicalr filter types that can be used by OCA objects.
+ * Enumeration of classical filter shapes
  * @class OcaClassicalFilterShape
  */
 export class OcaClassicalFilterShape extends Enum({

package/src/types/OcaCommand.d.ts

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaMethod, OcaMethod } from './OcaMethod';
+
+export declare interface IOcaCommand {
+  /**
+   * Method identification (ONo & ID) of method the command invokes. **nb**
+   * Datatype corrected to **OcaMethod** in AES70-2024.
+   * @type OcaMethod
+   */
+  Method: IOcaMethod;
+
+  /**
+   * Command parameters, if any. Format is method-specific. **nb** Datatype
+   * changed from **OcaList<OcaBlob>** to **OcaList<OcaLongBlob>** in
+   * AES70-2024.
+   * @type Uint8Array[]
+   */
+  Parameters: Uint8Array[];
+}
+
+export declare class OcaCommand implements IOcaCommand {
+  /**
+   * A member of a CommandSet. See the datatype **OcaCommandSet**.
+   * @class OcaCommand
+   */
+  constructor(Method: OcaMethod, Parameters: Uint8Array[]);
+
+  /**
+   * Method identification (ONo & ID) of method the command invokes. **nb**
+   * Datatype corrected to **OcaMethod** in AES70-2024.
+   * @type OcaMethod
+   */
+  Method: OcaMethod;
+
+  /**
+   * Command parameters, if any. Format is method-specific. **nb** Datatype
+   * changed from **OcaList<OcaBlob>** to **OcaList<OcaLongBlob>** in
+   * AES70-2024.
+   * @type Uint8Array[]
+   */
+  Parameters: Uint8Array[];
+}

package/src/types/OcaCommand.js

@@ -0,0 +1,25 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCommand {
+  /**
+   * A member of a CommandSet. See the datatype **OcaCommandSet**.
+   * @class OcaCommand
+   */
+  constructor(Method, Parameters) {
+    /**
+     * Method identification (ONo & ID) of method the command invokes. **nb**
+     * Datatype corrected to **OcaMethod** in AES70-2024.
+     * @type OcaMethod
+     */
+    this.Method = Method;
+    /**
+     * Command parameters, if any. Format is method-specific. **nb** Datatype
+     * changed from **OcaList<OcaBlob>** to **OcaList<OcaLongBlob>** in
+     * AES70-2024.
+     * @type Uint8Array[]
+     */
+    this.Parameters = Parameters;
+  }
+}

package/src/types/OcaCommandResult.d.ts

@@ -0,0 +1,42 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaStatus, OcaStatus } from './OcaStatus';
+
+export declare interface IOcaCommandResult {
+  /**
+   * Status code returned by command method. **nb** This field replaces the
+   * previous field **EndState** as of AES70-2024.
+   * @type OcaStatus
+   */
+  Status: IOcaStatus;
+
+  /**
+   * Command-specific return info - may be null. **nb** Datatype changed from
+   * **OcaBlob** to **OcaList<OcaLongBlob>** in AES70-2024.
+   * @type Uint8Array[]
+   */
+  Data: Uint8Array[];
+}
+
+export declare class OcaCommandResult implements IOcaCommandResult {
+  /**
+   * Execution result of a Command in a Commandset.
+   * @class OcaCommandResult
+   */
+  constructor(Status: OcaStatus, Data: Uint8Array[]);
+
+  /**
+   * Status code returned by command method. **nb** This field replaces the
+   * previous field **EndState** as of AES70-2024.
+   * @type OcaStatus
+   */
+  Status: OcaStatus;
+
+  /**
+   * Command-specific return info - may be null. **nb** Datatype changed from
+   * **OcaBlob** to **OcaList<OcaLongBlob>** in AES70-2024.
+   * @type Uint8Array[]
+   */
+  Data: Uint8Array[];
+}

package/src/types/OcaCommandResult.js

@@ -0,0 +1,24 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCommandResult {
+  /**
+   * Execution result of a Command in a Commandset.
+   * @class OcaCommandResult
+   */
+  constructor(Status, Data) {
+    /**
+     * Status code returned by command method. **nb** This field replaces the
+     * previous field **EndState** as of AES70-2024.
+     * @type OcaStatus
+     */
+    this.Status = Status;
+    /**
+     * Command-specific return info - may be null. **nb** Datatype changed from
+     * **OcaBlob** to **OcaList<OcaLongBlob>** in AES70-2024.
+     * @type Uint8Array[]
+     */
+    this.Data = Data;
+  }
+}

package/src/types/OcaCommandSetResult.d.ts

@@ -0,0 +1,41 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaCommandResult, OcaCommandResult } from './OcaCommandResult';
+import { IOcaGenericEndState, OcaGenericEndState } from './OcaGenericEndState';
+
+export declare interface IOcaCommandSetResult {
+  /**
+   * Completed normally, completed abnormally, aborted, or failed
+   * @type OcaGenericEndState
+   */
+  EndState: IOcaGenericEndState;
+
+  /**
+   * One entry per (successfully or unsuccessfully) executed command. Unexecuted
+   * commands are not in the list.
+   * @type OcaCommandResult[]
+   */
+  CommandResults: IOcaCommandResult[];
+}
+
+export declare class OcaCommandSetResult implements IOcaCommandSetResult {
+  /**
+   * Execution result of a Commandset
+   * @class OcaCommandSetResult
+   */
+  constructor(EndState: OcaGenericEndState, CommandResults: OcaCommandResult[]);
+
+  /**
+   * Completed normally, completed abnormally, aborted, or failed
+   * @type OcaGenericEndState
+   */
+  EndState: OcaGenericEndState;
+
+  /**
+   * One entry per (successfully or unsuccessfully) executed command. Unexecuted
+   * commands are not in the list.
+   * @type OcaCommandResult[]
+   */
+  CommandResults: OcaCommandResult[];
+}

package/src/types/OcaCommandSetResult.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCommandSetResult {
+  /**
+   * Execution result of a Commandset
+   * @class OcaCommandSetResult
+   */
+  constructor(EndState, CommandResults) {
+    /**
+     * Completed normally, completed abnormally, aborted, or failed
+     * @type OcaGenericEndState
+     */
+    this.EndState = EndState;
+    /**
+     * One entry per (successfully or unsuccessfully) executed command.
+     * Unexecuted commands are not in the list.
+     * @type OcaCommandResult[]
+     */
+    this.CommandResults = CommandResults;
+  }
+}

package/src/types/OcaConstructionParameter.d.ts

@@ -0,0 +1,40 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaPropertyID, OcaPropertyID } from './OcaPropertyID';
+
+export declare interface IOcaConstructionParameter {
+  /**
+   * Property ID.
+   * @type OcaPropertyID
+   */
+  ID: IOcaPropertyID;
+
+  /**
+   * Property value.
+   * @type Uint8Array
+   */
+  Value: Uint8Array;
+}
+
+export declare class OcaConstructionParameter
+  implements IOcaConstructionParameter {
+  /**
+   * Construction parameter. Defines the value of a property that will be set at
+   * object construction time.
+   * @class OcaConstructionParameter
+   */
+  constructor(ID: OcaPropertyID, Value: Uint8Array);
+
+  /**
+   * Property ID.
+   * @type OcaPropertyID
+   */
+  ID: OcaPropertyID;
+
+  /**
+   * Property value.
+   * @type Uint8Array
+   */
+  Value: Uint8Array;
+}

package/src/types/OcaConstructionParameter.js

@@ -0,0 +1,23 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaConstructionParameter {
+  /**
+   * Construction parameter. Defines the value of a property that will be set at
+   * object construction time.
+   * @class OcaConstructionParameter
+   */
+  constructor(ID, Value) {
+    /**
+     * Property ID.
+     * @type OcaPropertyID
+     */
+    this.ID = ID;
+    /**
+     * Property value.
+     * @type Uint8Array
+     */
+    this.Value = Value;
+  }
+}

package/src/types/OcaCounter.d.ts

@@ -0,0 +1,81 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaCounter {
+  /**
+   * Counter identifier. Unique within enclosing Counterset.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * The count.
+   * @type number|BigInt
+   */
+  Value: number | BigInt;
+
+  /**
+   * Value that a reset sets in the Counter.
+   * @type number|BigInt
+   */
+  InitialValue: number | BigInt;
+
+  /**
+   * Readonly name of Counter's function in context. Values beginning with "oca"
+   * in any character case shall be reserved for AES use.
+   * @type string
+   */
+  Role: string;
+
+  /**
+   * List of ONos of Notifiers attached to this Counter. May be empty.
+   * @type number[]
+   */
+  Notifiers: number[];
+}
+
+export declare class OcaCounter implements IOcaCounter {
+  /**
+   * A general-purpose Counter. See [AES70-1(Counters and Countersets)].
+   * @class OcaCounter
+   */
+  constructor(
+    ID: number,
+    Value: number | BigInt,
+    InitialValue: number | BigInt,
+    Role: string,
+    Notifiers: number[]
+  );
+
+  /**
+   * Counter identifier. Unique within enclosing Counterset.
+   * @type number
+   */
+  ID: number;
+
+  /**
+   * The count.
+   * @type number|BigInt
+   */
+  Value: number | BigInt;
+
+  /**
+   * Value that a reset sets in the Counter.
+   * @type number|BigInt
+   */
+  InitialValue: number | BigInt;
+
+  /**
+   * Readonly name of Counter's function in context. Values beginning with "oca"
+   * in any character case shall be reserved for AES use.
+   * @type string
+   */
+  Role: string;
+
+  /**
+   * List of ONos of Notifiers attached to this Counter. May be empty.
+   * @type number[]
+   */
+  Notifiers: number[];
+}

package/src/types/OcaCounter.js

@@ -0,0 +1,38 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCounter {
+  /**
+   * A general-purpose Counter. See [AES70-1(Counters and Countersets)].
+   * @class OcaCounter
+   */
+  constructor(ID, Value, InitialValue, Role, Notifiers) {
+    /**
+     * Counter identifier. Unique within enclosing Counterset.
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * The count.
+     * @type number|BigInt
+     */
+    this.Value = Value;
+    /**
+     * Value that a reset sets in the Counter.
+     * @type number|BigInt
+     */
+    this.InitialValue = InitialValue;
+    /**
+     * Readonly name of Counter's function in context. Values beginning with
+     * "oca" in any character case shall be reserved for AES use.
+     * @type string
+     */
+    this.Role = Role;
+    /**
+     * List of ONos of Notifiers attached to this Counter. May be empty.
+     * @type number[]
+     */
+    this.Notifiers = Notifiers;
+  }
+}

package/src/types/OcaCounterNotifierFilterParameters.d.ts

@@ -0,0 +1,81 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaRelationalOperator,
+  OcaRelationalOperator,
+} from './OcaRelationalOperator';
+
+export declare interface IOcaCounterNotifierFilterParameters {
+  /**
+   * Threshold comparison value. If **Operator** is zero, no threshold test is
+   * performed. See description of class **OcaCounterNotifier**.
+   * @type number|BigInt
+   */
+  Threshold: number | BigInt;
+
+  /**
+   * Type of threshold comparison. See description of class
+   * **OcaCounterNotifier**.
+   * @type OcaRelationalOperator
+   */
+  Operator: IOcaRelationalOperator;
+
+  /**
+   * Period for periodic updates, in seconds. Zero value means no periodic
+   * updates. See description of class **OcaCounterNotifier.**
+   * @type number
+   */
+  Period: number;
+
+  /**
+   * Count increment for "every-n-counts" updates. Absolute value, applies when
+   * counter changes by +n or -n. Zero value means no "every-n" notifications.
+   * See description of class **OcaCounterNotifier.**
+   * @type number|BigInt
+   */
+  CountDelta: number | BigInt;
+}
+
+export declare class OcaCounterNotifierFilterParameters
+  implements IOcaCounterNotifierFilterParameters {
+  /**
+   * Filter parameters for **OcaCountersetNotifier**.
+   * @class OcaCounterNotifierFilterParameters
+   */
+  constructor(
+    Threshold: number | BigInt,
+    Operator: OcaRelationalOperator,
+    Period: number,
+    CountDelta: number | BigInt
+  );
+
+  /**
+   * Threshold comparison value. If **Operator** is zero, no threshold test is
+   * performed. See description of class **OcaCounterNotifier**.
+   * @type number|BigInt
+   */
+  Threshold: number | BigInt;
+
+  /**
+   * Type of threshold comparison. See description of class
+   * **OcaCounterNotifier**.
+   * @type OcaRelationalOperator
+   */
+  Operator: OcaRelationalOperator;
+
+  /**
+   * Period for periodic updates, in seconds. Zero value means no periodic
+   * updates. See description of class **OcaCounterNotifier.**
+   * @type number
+   */
+  Period: number;
+
+  /**
+   * Count increment for "every-n-counts" updates. Absolute value, applies when
+   * counter changes by +n or -n. Zero value means no "every-n" notifications.
+   * See description of class **OcaCounterNotifier.**
+   * @type number|BigInt
+   */
+  CountDelta: number | BigInt;
+}