aes70/src/types/OcaGrouperStatusChangeEventData.d.ts

A controller library for the AES70 protocol.

/*
 * This file has been generated.
 */
import {
  IOcaGrouperStatusChangeType,
  OcaGrouperStatusChangeType,
} from './OcaGrouperStatusChangeType';

export declare interface IOcaGrouperStatusChangeEventData {
  /**
   * Index of relevant group, or zero if event is non-group-specific.
   * @type number
   */
  groupIndex: number;

  /**
   * Index of citizen within given grouper, or zero if event is
   * non-citizen-specific.
   * @type number
   */
  citizenIndex: number;

  /**
   * Type of change.
   * @type OcaGrouperStatusChangeType
   */
  changeType: IOcaGrouperStatusChangeType;
}

export declare class OcaGrouperStatusChangeEventData
  implements IOcaGrouperStatusChangeEventData {
  /**
   * Class that defines the event data parameter for the **StatusChange** event
   * defined in **OcaGrouper**.
   * @class OcaGrouperStatusChangeEventData
   */
  constructor(
    groupIndex: number,
    citizenIndex: number,
    changeType: OcaGrouperStatusChangeType
  );

  /**
   * Index of relevant group, or zero if event is non-group-specific.
   * @type number
   */
  groupIndex: number;

  /**
   * Index of citizen within given grouper, or zero if event is
   * non-citizen-specific.
   * @type number
   */
  citizenIndex: number;

  /**
   * Type of change.
   * @type OcaGrouperStatusChangeType
   */
  changeType: OcaGrouperStatusChangeType;
}