aes70 1.6.2 → 2.0.1

package/src/types/OcaJobQueueItem.js

@@ -0,0 +1,44 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaJobQueueItem {
+  /**
+   * An item of the Job Queue in **OcaTaskAgentManager**.
+   * @class OcaJobQueueItem
+   */
+  constructor(ID, ProgramONo, RunMode, RunParameters, RunWhen, RunWhere) {
+    /**
+     * ID of this queue item.
+     * @type number
+     */
+    this.ID = ID;
+    /**
+     * ONo of Executable to run
+     * @type number
+     */
+    this.ProgramONo = ProgramONo;
+    /**
+     * Run mode
+     * @type IOcaProgramRunMode
+     */
+    this.RunMode = RunMode;
+    /**
+     * Run parameters to use
+     * @type Uint8Array
+     */
+    this.RunParameters = RunParameters;
+    /**
+     * When to run the Task
+     * @type (OcaWhenPhysicalAbsolute | OcaWhenPhysicalRelative)
+     */
+    this.RunWhen = RunWhen;
+    /**
+     * Where to run the Task. Special values are as follows: 0 do not run 1 run
+     * on any available task in the scheduler's task list 2-4095 reserved
+     * 4096-up Value of ONo of OcaTaskAgent to use
+     * @type number
+     */
+    this.RunWhere = RunWhere;
+  }
+}

package/src/types/OcaLibVolType.d.ts

@@ -5,8 +5,7 @@
 export declare interface IOcaLibVolType {
   /**
    * Unique identifier of organization that has authority over this library
-   * volume type. A zero value indicates a standard library volume type defined
-   * by the AES70 standard.
+   * volume type.
    * @type Uint8Array
    */
   Authority: Uint8Array;
@@ -29,8 +28,7 @@ export declare class OcaLibVolType implements IOcaLibVolType {
 
   /**
    * Unique identifier of organization that has authority over this library
-   * volume type. A zero value indicates a standard library volume type defined
-   * by the AES70 standard.
+   * volume type.
    * @type Uint8Array
    */
   Authority: Uint8Array;

package/src/types/OcaLibVolType.js

@@ -10,8 +10,7 @@ export class OcaLibVolType {
   constructor(Authority, ID) {
     /**
      * Unique identifier of organization that has authority over this library
-     * volume type. A zero value indicates a standard library volume type
-     * defined by the AES70 standard.
+     * volume type.
      * @type Uint8Array
      */
     this.Authority = Authority;

package/src/types/OcaLockState.d.ts

@@ -0,0 +1,50 @@
+/*
+ * This file has been generated.
+ */
+/**
+ * Lock state of object
+ * @class OcaLockState
+ */
+export class OcaLockState {
+  /**
+   * Singleton object corresponding to the entry with value ``0``.
+   */
+  static NoLock: OcaLockState;
+  /**
+   * Singleton object corresponding to the entry with value ``1``.
+   */
+  static LockNoWrite: OcaLockState;
+  /**
+   * Singleton object corresponding to the entry with value ``2``.
+   */
+  static LockNoReadWrite: OcaLockState;
+
+  /**
+   * 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 IOcaLockState =
+  | OcaLockState
+  | 'NoLock'
+  | 'LockNoWrite'
+  | 'LockNoReadWrite'
+  | 0
+  | 1
+  | 2;

package/src/types/OcaLockState.js

@@ -0,0 +1,36 @@
+/*
+ * This file has been generated.
+ */
+import { Enum } from './Enum.js';
+
+/**
+ * Lock state of object
+ * @class OcaLockState
+ */
+export class OcaLockState extends Enum({
+  NoLock: 0,
+  LockNoWrite: 1,
+  LockNoReadWrite: 2,
+}) {}
+
+/**
+ * Singleton object corresponding to the entry with value ``0``.
+ * @type {OcaLockState}
+ * @member NoLock
+ * @memberof OcaLockState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``1``.
+ * @type {OcaLockState}
+ * @member LockNoWrite
+ * @memberof OcaLockState
+ * @static
+ */
+/**
+ * Singleton object corresponding to the entry with value ``2``.
+ * @type {OcaLockState}
+ * @member LockNoReadWrite
+ * @memberof OcaLockState
+ * @static
+ */

package/src/types/OcaLogFilter.d.ts

@@ -0,0 +1,70 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaInterval, OcaInterval } from './OcaInterval';
+import { IOcaTime, OcaTime } from './OcaTime';
+
+export declare interface IOcaLogFilter {
+  /**
+   * Application-specific value used for categorizing log records
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Range of severity levels to retrieve
+   * @type OcaInterval<number>
+   */
+  SeverityRange: IOcaInterval<number>;
+
+  /**
+   * ONo of object that generated the log record, or zero to accept log entries
+   * from all objects.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Range of timestamps to be accepted.
+   * @type OcaInterval<OcaTime>
+   */
+  TimestampRange: IOcaInterval<IOcaTime>;
+}
+
+export declare class OcaLogFilter implements IOcaLogFilter {
+  /**
+   * Filter for log entry retrieval.
+   * @class OcaLogFilter
+   */
+  constructor(
+    FunctionalCategory: number,
+    SeverityRange: OcaInterval<number>,
+    EmitterONo: number,
+    TimestampRange: OcaInterval<OcaTime>
+  );
+
+  /**
+   * Application-specific value used for categorizing log records
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Range of severity levels to retrieve
+   * @type OcaInterval<number>
+   */
+  SeverityRange: OcaInterval<number>;
+
+  /**
+   * ONo of object that generated the log record, or zero to accept log entries
+   * from all objects.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Range of timestamps to be accepted.
+   * @type OcaInterval<OcaTime>
+   */
+  TimestampRange: OcaInterval<OcaTime>;
+}

package/src/types/OcaLogFilter.js

@@ -0,0 +1,33 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaLogFilter {
+  /**
+   * Filter for log entry retrieval.
+   * @class OcaLogFilter
+   */
+  constructor(FunctionalCategory, SeverityRange, EmitterONo, TimestampRange) {
+    /**
+     * Application-specific value used for categorizing log records
+     * @type number
+     */
+    this.FunctionalCategory = FunctionalCategory;
+    /**
+     * Range of severity levels to retrieve
+     * @type OcaInterval<number>
+     */
+    this.SeverityRange = SeverityRange;
+    /**
+     * ONo of object that generated the log record, or zero to accept log
+     * entries from all objects.
+     * @type number
+     */
+    this.EmitterONo = EmitterONo;
+    /**
+     * Range of timestamps to be accepted.
+     * @type OcaInterval<OcaTime>
+     */
+    this.TimestampRange = TimestampRange;
+  }
+}

package/src/types/OcaLogRecord.d.ts

@@ -0,0 +1,85 @@
+/*
+ * This file has been generated.
+ */
+import { IOcaTime, OcaTime } from './OcaTime';
+
+export declare interface IOcaLogRecord {
+  /**
+   * Application-specific value used for categorizing log records for selective
+   * retrieval.
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Severity of log record. Recommended values are the same as those for the
+   * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+   * @type number
+   */
+  Severity: number;
+
+  /**
+   * ONo of object that generated the log record.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Date/time the log record was generated.
+   * @type OcaTime
+   */
+  Timestamp: IOcaTime;
+
+  /**
+   * Device- or application- specific content of the log record.
+   * @type Uint8Array
+   */
+  Payload: Uint8Array;
+}
+
+export declare class OcaLogRecord implements IOcaLogRecord {
+  /**
+   * Format of a log record. Payload format is application-specific; header data
+   * is standard.
+   * @class OcaLogRecord
+   */
+  constructor(
+    FunctionalCategory: number,
+    Severity: number,
+    EmitterONo: number,
+    Timestamp: OcaTime,
+    Payload: Uint8Array
+  );
+
+  /**
+   * Application-specific value used for categorizing log records for selective
+   * retrieval.
+   * @type number
+   */
+  FunctionalCategory: number;
+
+  /**
+   * Severity of log record. Recommended values are the same as those for the
+   * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+   * @type number
+   */
+  Severity: number;
+
+  /**
+   * ONo of object that generated the log record.
+   * @type number
+   */
+  EmitterONo: number;
+
+  /**
+   * Date/time the log record was generated.
+   * @type OcaTime
+   */
+  Timestamp: OcaTime;
+
+  /**
+   * Device- or application- specific content of the log record.
+   * @type Uint8Array
+   */
+  Payload: Uint8Array;
+}

package/src/types/OcaLogRecord.js

@@ -0,0 +1,40 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaLogRecord {
+  /**
+   * Format of a log record. Payload format is application-specific; header data
+   * is standard.
+   * @class OcaLogRecord
+   */
+  constructor(FunctionalCategory, Severity, EmitterONo, Timestamp, Payload) {
+    /**
+     * Application-specific value used for categorizing log records for
+     * selective retrieval.
+     * @type number
+     */
+    this.FunctionalCategory = FunctionalCategory;
+    /**
+     * Severity of log record. Recommended values are the same as those for the
+     * Syslog format as specified by [RFC 5424]; see also {Wiki-004}.
+     * @type number
+     */
+    this.Severity = Severity;
+    /**
+     * ONo of object that generated the log record.
+     * @type number
+     */
+    this.EmitterONo = EmitterONo;
+    /**
+     * Date/time the log record was generated.
+     * @type OcaTime
+     */
+    this.Timestamp = Timestamp;
+    /**
+     * Device- or application- specific content of the log record.
+     * @type Uint8Array
+     */
+    this.Payload = Payload;
+  }
+}

package/src/types/OcaManagerDefaultObjectNumbers.d.ts

@@ -97,4 +97,11 @@ export declare const OcaManagerDefaultObjectNumbers: {
    * @static
    */
   DiagnosticManager: number;
+  /**
+   * Object number of the :class:`OcaLockManager`.
+   * @type {number}
+   * @member LockManager
+   * @static
+   */
+  LockManager: number;
 };

package/src/types/OcaManagerDefaultObjectNumbers.js

@@ -97,4 +97,11 @@ export const OcaManagerDefaultObjectNumbers = {
    * @static
    */
   DiagnosticManager: 13,
+  /**
+   * Object number of the :class:`OcaLockManager`.
+   * @type {number}
+   * @member LockManager
+   * @static
+   */
+  LockManager: 14,
 };

package/src/types/OcaManagerDescriptor.d.ts

@@ -4,25 +4,26 @@
 
 export declare interface IOcaManagerDescriptor {
   /**
-   * Object number of this manager instance.
+   * Object number of this Manager instance.
    * @type number
    */
   ObjectNumber: number;
 
   /**
-   * Name of the manager instance.
+   * Name of this Manager instance.
    * @type string
    */
   Name: string;
 
   /**
-   * ClassID of the class from which the manager instance was created.
+   * ClassID of the class from which the Manager instance was constructed.
    * @type string
    */
   ClassID: string;
 
   /**
-   * Version number of the class from which this instance was created.
+   * Version number of the class from which this Manager instance was
+   * constructed.
    * @type number
    */
   ClassVersion: number;
@@ -30,7 +31,7 @@ export declare interface IOcaManagerDescriptor {
 
 export declare class OcaManagerDescriptor implements IOcaManagerDescriptor {
   /**
-   * Structure that describes a manager instance.
+   * Structure that describes a Manager instance.
    * @class OcaManagerDescriptor
    */
   constructor(
@@ -41,25 +42,26 @@ export declare class OcaManagerDescriptor implements IOcaManagerDescriptor {
   );
 
   /**
-   * Object number of this manager instance.
+   * Object number of this Manager instance.
    * @type number
    */
   ObjectNumber: number;
 
   /**
-   * Name of the manager instance.
+   * Name of this Manager instance.
    * @type string
    */
   Name: string;
 
   /**
-   * ClassID of the class from which the manager instance was created.
+   * ClassID of the class from which the Manager instance was constructed.
    * @type string
    */
   ClassID: string;
 
   /**
-   * Version number of the class from which this instance was created.
+   * Version number of the class from which this Manager instance was
+   * constructed.
    * @type number
    */
   ClassVersion: number;

package/src/types/OcaManagerDescriptor.js

@@ -4,27 +4,28 @@
 
 export class OcaManagerDescriptor {
   /**
-   * Structure that describes a manager instance.
+   * Structure that describes a Manager instance.
    * @class OcaManagerDescriptor
    */
   constructor(ObjectNumber, Name, ClassID, ClassVersion) {
     /**
-     * Object number of this manager instance.
+     * Object number of this Manager instance.
      * @type number
      */
     this.ObjectNumber = ObjectNumber;
     /**
-     * Name of the manager instance.
+     * Name of this Manager instance.
      * @type string
      */
     this.Name = Name;
     /**
-     * ClassID of the class from which the manager instance was created.
+     * ClassID of the class from which the Manager instance was constructed.
      * @type string
      */
     this.ClassID = ClassID;
     /**
-     * Version number of the class from which this instance was created.
+     * Version number of the class from which this Manager instance was
+     * constructed.
      * @type number
      */
     this.ClassVersion = ClassVersion;

package/src/types/OcaManufacturer.d.ts

@@ -0,0 +1,87 @@
+/*
+ * This file has been generated.
+ */
+
+export declare interface IOcaManufacturer {
+  /**
+   * Manufacturer's name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is not
+   * specified.
+   * @type Uint8Array
+   */
+  OrganizationID: Uint8Array;
+
+  /**
+   * URL of the manufacturer's website. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  Website: string;
+
+  /**
+   * Contact information for business issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  BusinessContact: string;
+
+  /**
+   * Contact information for technical issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  TechnicalContact: string;
+}
+
+export declare class OcaManufacturer implements IOcaManufacturer {
+  /**
+   * Structure that describes a manufacturer.
+   * @class OcaManufacturer
+   */
+  constructor(
+    Name: string,
+    OrganizationID: Uint8Array,
+    Website: string,
+    BusinessContact: string,
+    TechnicalContact: string
+  );
+
+  /**
+   * Manufacturer's name
+   * @type string
+   */
+  Name: string;
+
+  /**
+   * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is not
+   * specified.
+   * @type Uint8Array
+   */
+  OrganizationID: Uint8Array;
+
+  /**
+   * URL of the manufacturer's website. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  Website: string;
+
+  /**
+   * Contact information for business issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  BusinessContact: string;
+
+  /**
+   * Contact information for technical issues. If none, an empty string shall be
+   * provided.
+   * @type string
+   */
+  TechnicalContact: string;
+}

package/src/types/OcaManufacturer.js

@@ -0,0 +1,47 @@
+/*
+ * This file has been generated.
+ */
+
+export class OcaManufacturer {
+  /**
+   * Structure that describes a manufacturer.
+   * @class OcaManufacturer
+   */
+  constructor(
+    Name,
+    OrganizationID,
+    Website,
+    BusinessContact,
+    TechnicalContact
+  ) {
+    /**
+     * Manufacturer's name
+     * @type string
+     */
+    this.Name = Name;
+    /**
+     * Manufacturer's IEEE OUI or CID, if any. Zero value means OUI or CID is
+     * not specified.
+     * @type Uint8Array
+     */
+    this.OrganizationID = OrganizationID;
+    /**
+     * URL of the manufacturer's website. If none, an empty string shall be
+     * provided.
+     * @type string
+     */
+    this.Website = Website;
+    /**
+     * Contact information for business issues. If none, an empty string shall
+     * be provided.
+     * @type string
+     */
+    this.BusinessContact = BusinessContact;
+    /**
+     * Contact information for technical issues. If none, an empty string shall
+     * be provided.
+     * @type string
+     */
+    this.TechnicalContact = TechnicalContact;
+  }
+}