aes70 1.6.1 → 2.0.0

package/src/types/OcaCounterNotifierFilterParameters.js

@@ -0,0 +1,37 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCounterNotifierFilterParameters {
+  /**
+   * Filter parameters for **OcaCountersetNotifier**.
+   * @class OcaCounterNotifierFilterParameters
+   */
+  constructor(Threshold, Operator, Period, CountDelta) {
+    /**
+     * Threshold comparison value. If **Operator** is zero, no threshold test is
+     * performed. See description of class **OcaCounterNotifier**.
+     * @type number|BigInt
+     */
+    this.Threshold = Threshold;
+    /**
+     * Type of threshold comparison. See description of class
+     * **OcaCounterNotifier**.
+     * @type OcaRelationalOperator
+     */
+    this.Operator = Operator;
+    /**
+     * Period for periodic updates, in seconds. Zero value means no periodic
+     * updates. See description of class **OcaCounterNotifier.**
+     * @type number
+     */
+    this.Period = Period;
+    /**
+     * 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
+     */
+    this.CountDelta = CountDelta;
+  }
+}

package/src/types/OcaCounterSet.d.ts

@@ -0,0 +1,38 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaCounter, OcaCounter } from './OcaCounter';
+
+export declare interface IOcaCounterSet {
+  /**
+   * Nonvolatile, unique identifier of this Counterset within this Device.
+   * @type Uint8Array
+   */
+  ID: Uint8Array;
+
+  /**
+   * List of Counters in this Counterset.
+   * @type OcaCounter[]
+   */
+  Counters: IOcaCounter[];
+}
+
+export declare class OcaCounterSet implements IOcaCounterSet {
+  /**
+   * A set of Counters
+   * @class OcaCounterSet
+   */
+  constructor(ID: Uint8Array, Counters: OcaCounter[]);
+
+  /**
+   * Nonvolatile, unique identifier of this Counterset within this Device.
+   * @type Uint8Array
+   */
+  ID: Uint8Array;
+
+  /**
+   * List of Counters in this Counterset.
+   * @type OcaCounter[]
+   */
+  Counters: OcaCounter[];
+}

package/src/types/OcaCounterSet.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCounterSet {
+  /**
+   * A set of Counters
+   * @class OcaCounterSet
+   */
+  constructor(ID, Counters) {
+    /**
+     * Nonvolatile, unique identifier of this Counterset within this Device.
+     * @type Uint8Array
+     */
+    this.ID = ID;
+    /**
+     * List of Counters in this Counterset.
+     * @type OcaCounter[]
+     */
+    this.Counters = Counters;
+  }
+}

package/src/types/OcaCounterUpdate.d.ts

@@ -0,0 +1,54 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaCounterUpdate {
+  /**
+   * Identifies Counterset within Device.
+   * @type Uint8Array
+   */
+  CounterSetID: Uint8Array;
+
+  /**
+   * Identifies Counter within Counterset.
+   * @type number
+   */
+  CounterID: number;
+
+  /**
+   * The Counter's value.
+   * @type number|BigInt
+   */
+  Value: number | BigInt;
+}
+
+export declare class OcaCounterUpdate implements IOcaCounterUpdate {
+  /**
+   * Descriptor of a Counter update, used by **OcaCounterNotifier**, in its
+   * **CounterUpdate()** event and its **GetLastUpdate()** method.
+   * @class OcaCounterUpdate
+   */
+  constructor(
+    CounterSetID: Uint8Array,
+    CounterID: number,
+    Value: number | BigInt
+  );
+
+  /**
+   * Identifies Counterset within Device.
+   * @type Uint8Array
+   */
+  CounterSetID: Uint8Array;
+
+  /**
+   * Identifies Counter within Counterset.
+   * @type number
+   */
+  CounterID: number;
+
+  /**
+   * The Counter's value.
+   * @type number|BigInt
+   */
+  Value: number | BigInt;
+}

package/src/types/OcaCounterUpdate.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCounterUpdate {
+  /**
+   * Descriptor of a Counter update, used by **OcaCounterNotifier**, in its
+   * **CounterUpdate()** event and its **GetLastUpdate()** method.
+   * @class OcaCounterUpdate
+   */
+  constructor(CounterSetID, CounterID, Value) {
+    /**
+     * Identifies Counterset within Device.
+     * @type Uint8Array
+     */
+    this.CounterSetID = CounterSetID;
+    /**
+     * Identifies Counter within Counterset.
+     * @type number
+     */
+    this.CounterID = CounterID;
+    /**
+     * The Counter's value.
+     * @type number|BigInt
+     */
+    this.Value = Value;
+  }
+}

package/src/types/OcaCounterUpdateEventData.d.ts

@@ -0,0 +1,27 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaCounterUpdate, OcaCounterUpdate } from './OcaCounterUpdate';
+
+export declare interface IOcaCounterUpdateEventData {
+  /**
+   * List of counter-update descriptors
+   * @type OcaCounterUpdate[]
+   */
+  Updates: IOcaCounterUpdate[];
+}
+
+export declare class OcaCounterUpdateEventData
+  implements IOcaCounterUpdateEventData {
+  /**
+   * Notification data supplied by **OcaCounterNotifier.CounterUpdate()** event
+   * @class OcaCounterUpdateEventData
+   */
+  constructor(Updates: OcaCounterUpdate[]);
+
+  /**
+   * List of counter-update descriptors
+   * @type OcaCounterUpdate[]
+   */
+  Updates: OcaCounterUpdate[];
+}

package/src/types/OcaCounterUpdateEventData.js

@@ -0,0 +1,17 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaCounterUpdateEventData {
+  /**
+   * Notification data supplied by **OcaCounterNotifier.CounterUpdate()** event
+   * @class OcaCounterUpdateEventData
+   */
+  constructor(Updates) {
+    /**
+     * List of counter-update descriptors
+     * @type OcaCounterUpdate[]
+     */
+    this.Updates = Updates;
+  }
+}

package/src/types/OcaDatasetSearchResult.d.ts

@@ -0,0 +1,51 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaBlockMember, OcaBlockMember } from './OcaBlockMember';
+
+export declare interface IOcaDatasetSearchResult {
+  /**
+   * Member descriptor of Dataset Object
+   * @type OcaBlockMember
+   */
+  Object: IOcaBlockMember;
+
+  /**
+   * Dataset name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Dataset type
+   * @type string
+   */
+  Type: string;
+}
+
+export declare class OcaDatasetSearchResult implements IOcaDatasetSearchResult {
+  /**
+   * Result of Dataset search via the **FindDatasets(...)** and
+   * **FindDatasetsRecursive(...)** methods of **OcaBlock**.
+   * @class OcaDatasetSearchResult
+   */
+  constructor(Object: OcaBlockMember, Name: string, Type: string);
+
+  /**
+   * Member descriptor of Dataset Object
+   * @type OcaBlockMember
+   */
+  Object: OcaBlockMember;
+
+  /**
+   * Dataset name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Dataset type
+   * @type string
+   */
+  Type: string;
+}

package/src/types/OcaDatasetSearchResult.js

@@ -0,0 +1,28 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaDatasetSearchResult {
+  /**
+   * Result of Dataset search via the **FindDatasets(...)** and
+   * **FindDatasetsRecursive(...)** methods of **OcaBlock**.
+   * @class OcaDatasetSearchResult
+   */
+  constructor(Object, Name, Type) {
+    /**
+     * Member descriptor of Dataset Object
+     * @type OcaBlockMember
+     */
+    this.Object = Object;
+    /**
+     * Dataset name
+     * @type string
+     */
+    this.Name = Name;
+    /**
+     * Dataset type
+     * @type string
+     */
+    this.Type = Type;
+  }
+}

package/src/types/OcaDelayUnit.d.ts

@@ -2,7 +2,8 @@
  * This file has been generated.
  */
 /**
- * Enumeration of types of delay units that are available in OCA.
+ * Enumeration of types of delay units that are available in AES70. This
+ * enumeration is **deprecated** in AES70-2022.
  * @class OcaDelayUnit
  */
 export class OcaDelayUnit {

package/src/types/OcaDelayUnit.js

@@ -4,7 +4,8 @@
 import { Enum } from './Enum.js';
 
 /**
- * Enumeration of types of delay units that are available in OCA.
+ * Enumeration of types of delay units that are available in AES70. This
+ * enumeration is **deprecated** in AES70-2022.
  * @class OcaDelayUnit
  */
 export class OcaDelayUnit extends Enum({

package/src/types/OcaDelayValue.d.ts

@@ -19,7 +19,8 @@ export declare interface IOcaDelayValue {
 
 export declare class OcaDelayValue implements IOcaDelayValue {
   /**
-   * Multifield descriptor that defines a delay value element.
+   * Multifield descriptor that defines a delay value element. This datatype is
+   * **deprecated** in AES70-2022.
    * @class OcaDelayValue
    */
   constructor(DelayValue: number, DelayUnit: OcaDelayUnit);

package/src/types/OcaDelayValue.js

@@ -4,7 +4,8 @@
 
 export class OcaDelayValue {
   /**
-   * Multifield descriptor that defines a delay value element.
+   * Multifield descriptor that defines a delay value element. This datatype is
+   * **deprecated** in AES70-2022.
    * @class OcaDelayValue
    */
   constructor(DelayValue, DelayUnit) {

package/src/types/OcaDeviceGenericState.d.ts

@@ -0,0 +1,62 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Generic device states
+ * @class OcaDeviceGenericState
+ */
+export class OcaDeviceGenericState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static NormalOperation: OcaDeviceGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Initializaing: OcaDeviceGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Updating: OcaDeviceGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``3``.
+   */
+  static Fault: OcaDeviceGenericState;
+  /**
+   * Singleton object corresponding to the entry with value ``128``.
+   */
+  static ExpansionBase: OcaDeviceGenericState;
+
+  /**
+   * 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 IOcaDeviceGenericState =
+  | OcaDeviceGenericState
+  | 'NormalOperation'
+  | 'Initializaing'
+  | 'Updating'
+  | 'Fault'
+  | 'ExpansionBase'
+  | 0
+  | 1
+  | 2
+  | 3
+  | 128;

package/src/types/OcaDeviceGenericState.js

@@ -0,0 +1,52 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Generic device states
+ * @class OcaDeviceGenericState
+ */
+export class OcaDeviceGenericState extends Enum({
+  NormalOperation: 0,
+  Initializaing: 1,
+  Updating: 2,
+  Fault: 3,
+  ExpansionBase: 128,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaDeviceGenericState}
+ * @member NormalOperation
+ * @memberof OcaDeviceGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaDeviceGenericState}
+ * @member Initializaing
+ * @memberof OcaDeviceGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaDeviceGenericState}
+ * @member Updating
+ * @memberof OcaDeviceGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``3``.
+ * @type {OcaDeviceGenericState}
+ * @member Fault
+ * @memberof OcaDeviceGenericState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``128``.
+ * @type {OcaDeviceGenericState}
+ * @member ExpansionBase
+ * @memberof OcaDeviceGenericState
+ * @static
+ */

package/src/types/OcaDeviceOperationalState.d.ts

@@ -0,0 +1,42 @@
+/*
+ * This file has been generated.
+ */
+import {
+  IOcaDeviceGenericState,
+  OcaDeviceGenericState,
+} from './OcaDeviceGenericState';
+
+export declare interface IOcaDeviceOperationalState {
+  /**
+   * Generic device state
+   * @type OcaDeviceGenericState
+   */
+  Generic: IOcaDeviceGenericState;
+
+  /**
+   * Device-specific state details (optional)
+   * @type Uint8Array
+   */
+  Details: Uint8Array;
+}
+
+export declare class OcaDeviceOperationalState
+  implements IOcaDeviceOperationalState {
+  /**
+   * Operating state of device: generic state + device-specific details
+   * @class OcaDeviceOperationalState
+   */
+  constructor(Generic: OcaDeviceGenericState, Details: Uint8Array);
+
+  /**
+   * Generic device state
+   * @type OcaDeviceGenericState
+   */
+  Generic: OcaDeviceGenericState;
+
+  /**
+   * Device-specific state details (optional)
+   * @type Uint8Array
+   */
+  Details: Uint8Array;
+}

package/src/types/OcaDeviceOperationalState.js

@@ -0,0 +1,22 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaDeviceOperationalState {
+  /**
+   * Operating state of device: generic state + device-specific details
+   * @class OcaDeviceOperationalState
+   */
+  constructor(Generic, Details) {
+    /**
+     * Generic device state
+     * @type OcaDeviceGenericState
+     */
+    this.Generic = Generic;
+    /**
+     * Device-specific state details (optional)
+     * @type Uint8Array
+     */
+    this.Details = Details;
+  }
+}

package/src/types/OcaDeviceState.d.ts

@@ -2,8 +2,8 @@
  * This file has been generated.
  */
 /**
- * Bitset defining bit flags that indicate the device states CAP devices can be
- * in. The state is returned by the device's Device Manager on request. Any
+ * Bitset defining bit flags that indicate the device states AES70 devices can
+ * be in. The state is returned by the device's Device Manager on request. Any
  * combination of the flags may be returned, unless specified otherwise for the
  * specific flag. The value 0x0000 indicates the device is fully operational.
  * @enum {number}

package/src/types/OcaDeviceState.js

@@ -2,8 +2,8 @@
  * This file has been generated.
  */
 /**
- * Bitset defining bit flags that indicate the device states CAP devices can be
- * in. The state is returned by the device's Device Manager on request. Any
+ * Bitset defining bit flags that indicate the device states AES70 devices can
+ * be in. The state is returned by the device's Device Manager on request. Any
  * combination of the flags may be returned, unless specified otherwise for the
  * specific flag. The value 0x0000 indicates the device is fully operational.
  * @enum {number}

package/src/types/OcaExecutableType.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Types of executable - program or commandset
+ * @class OcaExecutableType
+ */
+export class OcaExecutableType {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static Undefined: OcaExecutableType;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static Program: OcaExecutableType;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static Commandset: OcaExecutableType;
+
+  /**
+   * 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 IOcaExecutableType =
+  | OcaExecutableType
+  | 'Undefined'
+  | 'Program'
+  | 'Commandset'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaExecutableType.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Types of executable - program or commandset
+ * @class OcaExecutableType
+ */
+export class OcaExecutableType extends Enum({
+  Undefined: 0,
+  Program: 1,
+  Commandset: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaExecutableType}
+ * @member Undefined
+ * @memberof OcaExecutableType
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaExecutableType}
+ * @member Program
+ * @memberof OcaExecutableType
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaExecutableType}
+ * @member Commandset
+ * @memberof OcaExecutableType
+ * @static
+ */