aes70/src/controller/ControlClasses/OcaPolarity.js

A controller library for the AES70 protocol.

import { OcaPolarityState } from '../../OCP1/OcaPolarityState.js';
import { make_control_class } from '../make_control_class.js';
import { OcaActuator } from './OcaActuator.js';

/**
 * Signal inverter
 * @extends OcaActuator
 * @class OcaPolarity
 */
export const OcaPolarity = make_control_class(
  'OcaPolarity',
  4,
  '\u0001\u0001\u0001\u0003',
  2,
  OcaActuator,
  [
    ['GetState', 4, 1, [], [OcaPolarityState]],
    ['SetState', 4, 2, [OcaPolarityState], []],
  ],
  [['State', [OcaPolarityState], 4, 1, false, false, null]],
  []
);

/**
 * Gets the current inverter state. The return value indicates whether the state
 * was successfully retrieved.
 *
 * @method OcaPolarity#GetState
 * @returns {Promise<OcaPolarityState>}
 *   A promise which resolves to a single value of type :class:`OcaPolarityState`.
 */
/**
 * Sets the inversion state (i.e. value of the State property). The return value
 * indicates whether the state was successfully set.
 *
 * @method OcaPolarity#SetState
 * @param {IOcaPolarityState} state
 *
 * @returns {Promise<void>}
 */
/**
 * This event is emitted when the property ``State`` changes in the remote object.
 * The property ``State`` is described in the AES70 standard as follows.
 * Current state of the inverter - {noninverted, inverted].
 *
 * @member {PropertyEvent<OcaPolarityState>} OcaPolarity#OnStateChanged
 */