aes70/src/controller/ControlClasses/OcaFilterClassical.js

A controller library for the AES70 protocol.

import { OcaClassicalFilterShape } from '../../OCP1/OcaClassicalFilterShape.js';
import { OcaFilterPassband } from '../../OCP1/OcaFilterPassband.js';
import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
import { OcaParameterMask } from '../../OCP1/OcaParameterMask.js';
import { OcaUint16 } from '../../OCP1/OcaUint16.js';
import { make_control_class } from '../make_control_class.js';
import { OcaActuator } from './OcaActuator.js';

/**
 * Classical analog-style filter - highpass, lowpass, bandpass, etc., with shape
 * characteristics such as Butterworth, Chebyshev, Bessel, and Linkwitz-Riley.
 * @extends OcaActuator
 * @class OcaFilterClassical
 */
export const OcaFilterClassical = make_control_class(
  'OcaFilterClassical',
  4,
  '\u0001\u0001\u0001\t',
  3,
  OcaActuator,
  [
    ['GetFrequency', 4, 1, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
    ['SetFrequency', 4, 2, [OcaFloat32], []],
    ['GetPassband', 4, 3, [], [OcaFilterPassband]],
    ['SetPassband', 4, 4, [OcaFilterPassband], []],
    ['GetShape', 4, 5, [], [OcaClassicalFilterShape]],
    ['SetShape', 4, 6, [OcaClassicalFilterShape], []],
    ['GetOrder', 4, 7, [], [OcaUint16, OcaUint16, OcaUint16]],
    ['SetOrder', 4, 8, [OcaUint16], []],
    ['GetParameter', 4, 9, [], [OcaFloat32, OcaFloat32, OcaFloat32]],
    ['SetParameter', 4, 10, [OcaFloat32], []],
    [
      'SetMultiple',
      4,
      11,
      [
        OcaParameterMask,
        OcaFloat32,
        OcaFilterPassband,
        OcaClassicalFilterShape,
        OcaUint16,
        OcaFloat32,
      ],
      [],
    ],
  ],
  [
    ['Frequency', [OcaFloat32], 4, 1, false, false, null],
    ['Passband', [OcaFilterPassband], 4, 2, false, false, null],
    ['Shape', [OcaClassicalFilterShape], 4, 3, false, false, null],
    ['Order', [OcaUint16], 4, 4, false, false, null],
    ['Parameter', [OcaFloat32], 4, 5, false, false, null],
  ],
  []
);

/**
 * Gets the value and limits of the **Frequency** property.
 * The return values of this method are
 *
 * - Frequency of type ``number``
 * - minFrequency of type ``number``
 * - maxFrequency of type ``number``
 *
 * @method OcaFilterClassical#GetFrequency
 * @returns {Promise<Arguments<number,number,number>>}
 */
/**
 * Sets the value of the **Frequency** property.
 *
 * @method OcaFilterClassical#SetFrequency
 * @param {number} frequency
 *
 * @returns {Promise<void>}
 */
/**
 * Gets the value of the **Passband** property.
 *
 * @method OcaFilterClassical#GetPassband
 * @returns {Promise<OcaFilterPassband>}
 *   A promise which resolves to a single value of type :class:`OcaFilterPassband`.
 */
/**
 * Sets the value of the **Passband** property.
 *
 * @method OcaFilterClassical#SetPassband
 * @param {IOcaFilterPassband} Passband
 *
 * @returns {Promise<void>}
 */
/**
 * Gets the value of the **Shape** property.
 *
 * @method OcaFilterClassical#GetShape
 * @returns {Promise<OcaClassicalFilterShape>}
 *   A promise which resolves to a single value of type :class:`OcaClassicalFilterShape`.
 */
/**
 * Sets the value of the **Shape** property.
 *
 * @method OcaFilterClassical#SetShape
 * @param {IOcaClassicalFilterShape} Shape
 *
 * @returns {Promise<void>}
 */
/**
 * Gets the value and limits of the **Order** property.
 * The return values of this method are
 *
 * - Order of type ``number``
 * - minOrder of type ``number``
 * - maxOrder of type ``number``
 *
 * @method OcaFilterClassical#GetOrder
 * @returns {Promise<Arguments<number,number,number>>}
 */
/**
 * Sets the value of the **Order** property.
 *
 * @method OcaFilterClassical#SetOrder
 * @param {number} Order
 *
 * @returns {Promise<void>}
 */
/**
 * Gets the value and limits of the **Parameter** property.
 * The return values of this method are
 *
 * - Parameter of type ``number``
 * - minParameter of type ``number``
 * - maxParameter of type ``number``
 *
 * @method OcaFilterClassical#GetParameter
 * @returns {Promise<Arguments<number,number,number>>}
 */
/**
 * Sets the value of the **Parameter** property.
 *
 * @method OcaFilterClassical#SetParameter
 * @param {number} Parameter
 *
 * @returns {Promise<void>}
 */
/**
 * Sets some or all filter parameters. The action of this method shall be atomic
 * - if any of the changes fails, **none** of the changes shall be made.
 *
 * @method OcaFilterClassical#SetMultiple
 * @param {IOcaParameterMask} Mask
 * @param {number} Frequency
 * @param {IOcaFilterPassband} Passband
 * @param {IOcaClassicalFilterShape} Shape
 * @param {number} Order
 * @param {number} Parameter
 *
 * @returns {Promise<void>}
 */
/**
 * This event is emitted when the property ``Frequency`` changes in the remote object.
 * The property ``Frequency`` is described in the AES70 standard as follows.
 * The frequency of the filter.
 *
 * @member {PropertyEvent<number>} OcaFilterClassical#OnFrequencyChanged
 */
/**
 * This event is emitted when the property ``Passband`` changes in the remote object.
 * The property ``Passband`` is described in the AES70 standard as follows.
 * Lowpass, highpass, bandpass, bandreject
 *
 * @member {PropertyEvent<OcaFilterPassband>} OcaFilterClassical#OnPassbandChanged
 */
/**
 * This event is emitted when the property ``Shape`` changes in the remote object.
 * The property ``Shape`` is described in the AES70 standard as follows.
 * Shape family - Butterworth, Bessell, etc.
 *
 * @member {PropertyEvent<OcaClassicalFilterShape>} OcaFilterClassical#OnShapeChanged
 */
/**
 * This event is emitted when the property ``Order`` changes in the remote object.
 * The property ``Order`` is described in the AES70 standard as follows.
 * Filter order
 *
 * @member {PropertyEvent<number>} OcaFilterClassical#OnOrderChanged
 */
/**
 * This event is emitted when the property ``Parameter`` changes in the remote object.
 * The property ``Parameter`` is described in the AES70 standard as follows.
 * Ripple or other filter parameter, depending on shape. Not used by some
 * shapes.
 *
 * @member {PropertyEvent<number>} OcaFilterClassical#OnParameterChanged
 */