aes70 1.3.7 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/Changelog +18 -0
- package/dist/AES70.es5.js +1 -1
- package/package.json +1 -1
- package/src/OCP1/OcaBlockMember.js +1 -1
- package/src/OCP1/OcaClassAuthorityID.js +1 -1
- package/src/OCP1/OcaClassIdentification.js +1 -1
- package/src/OCP1/OcaDBr.js +1 -1
- package/src/OCP1/OcaDelayValue.js +1 -1
- package/src/OCP1/OcaEvent.js +1 -1
- package/src/OCP1/OcaEventID.js +1 -1
- package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
- package/src/OCP1/OcaGrouperCitizen.js +1 -1
- package/src/OCP1/OcaGrouperEnrollment.js +1 -1
- package/src/OCP1/OcaGrouperGroup.js +1 -1
- package/src/OCP1/OcaGrouperStatusChangeEventData.js +1 -3
- package/src/OCP1/OcaImpedance.js +1 -1
- package/src/OCP1/OcaLibParamSetAssignment.js +1 -1
- package/src/OCP1/OcaLibVol.js +1 -1
- package/src/OCP1/OcaLibVolChangedEventData.js +1 -3
- package/src/OCP1/OcaLibVolData_ParamSet.js +1 -1
- package/src/OCP1/OcaLibVolIdentifier.js +1 -1
- package/src/OCP1/OcaLibVolMetadata.js +1 -1
- package/src/OCP1/OcaLibVolType.js +1 -1
- package/src/OCP1/OcaLibraryIdentifier.js +1 -1
- package/src/OCP1/OcaManagerDescriptor.js +1 -1
- package/src/OCP1/OcaMediaClockRate.js +1 -1
- package/src/OCP1/OcaMediaCoding.js +1 -1
- package/src/OCP1/OcaMediaConnection.js +1 -1
- package/src/OCP1/OcaMediaConnectorElement.js +2 -2
- package/src/OCP1/OcaMediaConnectorStatus.js +1 -1
- package/src/OCP1/OcaMediaConnectorStatusChangedEventData.js +1 -3
- package/src/OCP1/OcaMediaSinkConnector.js +1 -1
- package/src/OCP1/OcaMediaSinkConnectorChangedEventData.js +1 -3
- package/src/OCP1/OcaMediaSourceConnector.js +1 -1
- package/src/OCP1/OcaMediaSourceConnectorChangedEventData.js +1 -3
- package/src/OCP1/OcaMethod.js +1 -1
- package/src/OCP1/OcaMethodID.js +1 -1
- package/src/OCP1/OcaModelDescription.js +1 -1
- package/src/OCP1/OcaModelGUID.js +1 -1
- package/src/OCP1/OcaNetworkStatistics.js +1 -1
- package/src/OCP1/OcaNetworkSystemInterfaceDescriptor.js +1 -1
- package/src/OCP1/OcaNetworkSystemInterfaceID.js +1 -1
- package/src/OCP1/OcaOPath.js +1 -1
- package/src/OCP1/OcaObjectIdentification.js +1 -1
- package/src/OCP1/OcaObjectListEventData.js +1 -3
- package/src/OCP1/OcaObjectSearchResult.js +1 -1
- package/src/OCP1/OcaObservationEventData.js +1 -3
- package/src/OCP1/OcaObservationListEventData.js +1 -3
- package/src/OCP1/OcaParameterMask.js +3 -0
- package/src/OCP1/OcaPilotToneDetectorSpec.js +1 -1
- package/src/OCP1/OcaPort.js +1 -1
- package/src/OCP1/OcaPortID.js +1 -1
- package/src/OCP1/OcaPositionDescriptor.js +3 -3
- package/src/OCP1/OcaPositionDescriptorFieldFlags.js +3 -0
- package/src/OCP1/OcaProperty.js +1 -1
- package/src/OCP1/OcaPropertyDescriptor.js +1 -1
- package/src/OCP1/OcaPropertyID.js +1 -1
- package/src/OCP1/OcaProtoObjectIdentification.js +1 -1
- package/src/OCP1/OcaProtoPort.js +1 -1
- package/src/OCP1/OcaProtoPortID.js +1 -1
- package/src/OCP1/OcaProtoSignalPath.js +1 -1
- package/src/OCP1/OcaSignalPath.js +1 -1
- package/src/OCP1/OcaStream.js +1 -1
- package/src/OCP1/OcaStreamConnectorIdentification.js +1 -1
- package/src/OCP1/OcaTask.js +1 -1
- package/src/OCP1/OcaTaskStateChangedEventData.js +1 -1
- package/src/OCP1/OcaTaskStatus.js +1 -1
- package/src/OCP1/OcaTimePTP.js +1 -1
- package/src/OCP1/OcaTransferFunction.js +1 -1
- package/src/OCP1/OcaVersion.js +1 -1
- package/src/controller/ControlClasses/OcaActuator.d.ts +3 -1
- package/src/controller/ControlClasses/OcaActuator.js +3 -1
- package/src/controller/ControlClasses/OcaAgent.d.ts +10 -7
- package/src/controller/ControlClasses/OcaAgent.js +12 -8
- package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +35 -21
- package/src/controller/ControlClasses/OcaApplicationNetwork.js +43 -32
- package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +14 -8
- package/src/controller/ControlClasses/OcaAudioLevelSensor.js +13 -9
- package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +3 -2
- package/src/controller/ControlClasses/OcaAudioProcessingManager.js +3 -2
- package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +11 -8
- package/src/controller/ControlClasses/OcaBitstringActuator.js +13 -9
- package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +7 -5
- package/src/controller/ControlClasses/OcaBitstringSensor.js +9 -6
- package/src/controller/ControlClasses/OcaBlock.d.ts +88 -74
- package/src/controller/ControlClasses/OcaBlock.js +80 -63
- package/src/controller/ControlClasses/OcaBlockFactory.d.ts +73 -29
- package/src/controller/ControlClasses/OcaBlockFactory.js +69 -42
- package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +5 -4
- package/src/controller/ControlClasses/OcaBooleanActuator.js +6 -4
- package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +3 -3
- package/src/controller/ControlClasses/OcaBooleanSensor.js +4 -3
- package/src/controller/ControlClasses/OcaCodingManager.d.ts +10 -7
- package/src/controller/ControlClasses/OcaCodingManager.js +17 -13
- package/src/controller/ControlClasses/OcaControlNetwork.d.ts +4 -5
- package/src/controller/ControlClasses/OcaControlNetwork.js +5 -6
- package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaCurrentSensor.js +4 -3
- package/src/controller/ControlClasses/OcaDelay.d.ts +6 -5
- package/src/controller/ControlClasses/OcaDelay.js +6 -4
- package/src/controller/ControlClasses/OcaDelayExtended.d.ts +18 -15
- package/src/controller/ControlClasses/OcaDelayExtended.js +17 -12
- package/src/controller/ControlClasses/OcaDeviceManager.d.ts +56 -31
- package/src/controller/ControlClasses/OcaDeviceManager.js +75 -51
- package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +33 -16
- package/src/controller/ControlClasses/OcaDeviceTimeManager.js +36 -18
- package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +6 -3
- package/src/controller/ControlClasses/OcaDiagnosticManager.js +8 -5
- package/src/controller/ControlClasses/OcaDynamics.d.ts +89 -61
- package/src/controller/ControlClasses/OcaDynamics.js +101 -79
- package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +77 -30
- package/src/controller/ControlClasses/OcaDynamicsCurve.js +85 -37
- package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +30 -22
- package/src/controller/ControlClasses/OcaDynamicsDetector.js +36 -24
- package/src/controller/ControlClasses/OcaEventHandler.d.ts +8 -6
- package/src/controller/ControlClasses/OcaEventHandler.js +9 -6
- package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +13 -9
- package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +15 -12
- package/src/controller/ControlClasses/OcaFilterClassical.d.ts +43 -30
- package/src/controller/ControlClasses/OcaFilterClassical.js +40 -31
- package/src/controller/ControlClasses/OcaFilterFIR.d.ts +12 -8
- package/src/controller/ControlClasses/OcaFilterFIR.js +19 -14
- package/src/controller/ControlClasses/OcaFilterParametric.d.ts +34 -25
- package/src/controller/ControlClasses/OcaFilterParametric.js +39 -33
- package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +6 -6
- package/src/controller/ControlClasses/OcaFilterPolynomial.js +11 -10
- package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +71 -21
- package/src/controller/ControlClasses/OcaFirmwareManager.js +71 -22
- package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaFloat32Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaFloat32Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaFloat64Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaFloat64Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaFrequencyActuator.js +6 -4
- package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaFrequencySensor.js +4 -3
- package/src/controller/ControlClasses/OcaGain.d.ts +6 -5
- package/src/controller/ControlClasses/OcaGain.js +6 -4
- package/src/controller/ControlClasses/OcaGainSensor.d.ts +6 -5
- package/src/controller/ControlClasses/OcaGainSensor.js +6 -4
- package/src/controller/ControlClasses/OcaGrouper.d.ts +138 -58
- package/src/controller/ControlClasses/OcaGrouper.js +139 -61
- package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +9 -10
- package/src/controller/ControlClasses/OcaIdentificationActuator.js +10 -10
- package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +6 -4
- package/src/controller/ControlClasses/OcaIdentificationSensor.js +5 -3
- package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +8 -8
- package/src/controller/ControlClasses/OcaImpedanceSensor.js +7 -6
- package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaInt16Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaInt16Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaInt32Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaInt32Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaInt64Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaInt64Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaInt8Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaInt8Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaLevelSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaLevelSensor.js +4 -3
- package/src/controller/ControlClasses/OcaLibrary.d.ts +50 -25
- package/src/controller/ControlClasses/OcaLibrary.js +54 -26
- package/src/controller/ControlClasses/OcaLibraryManager.d.ts +22 -16
- package/src/controller/ControlClasses/OcaLibraryManager.js +22 -17
- package/src/controller/ControlClasses/OcaManager.d.ts +4 -1
- package/src/controller/ControlClasses/OcaManager.js +4 -1
- package/src/controller/ControlClasses/OcaMatrix.d.ts +69 -20
- package/src/controller/ControlClasses/OcaMatrix.js +86 -38
- package/src/controller/ControlClasses/OcaMediaClock.d.ts +33 -19
- package/src/controller/ControlClasses/OcaMediaClock.js +30 -19
- package/src/controller/ControlClasses/OcaMediaClock3.d.ts +37 -22
- package/src/controller/ControlClasses/OcaMediaClock3.js +39 -27
- package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +15 -9
- package/src/controller/ControlClasses/OcaMediaClockManager.js +28 -23
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +106 -74
- package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +121 -111
- package/src/controller/ControlClasses/OcaMute.d.ts +7 -7
- package/src/controller/ControlClasses/OcaMute.js +7 -5
- package/src/controller/ControlClasses/OcaNetwork.d.ts +38 -20
- package/src/controller/ControlClasses/OcaNetwork.js +58 -42
- package/src/controller/ControlClasses/OcaNetworkManager.d.ts +20 -9
- package/src/controller/ControlClasses/OcaNetworkManager.js +33 -23
- package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts +43 -19
- package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +67 -44
- package/src/controller/ControlClasses/OcaNumericObserver.d.ts +77 -38
- package/src/controller/ControlClasses/OcaNumericObserver.js +95 -59
- package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +96 -45
- package/src/controller/ControlClasses/OcaNumericObserverList.js +129 -80
- package/src/controller/ControlClasses/OcaPanBalance.d.ts +10 -7
- package/src/controller/ControlClasses/OcaPanBalance.js +14 -11
- package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +31 -18
- package/src/controller/ControlClasses/OcaPhysicalPosition.js +43 -18
- package/src/controller/ControlClasses/OcaPolarity.d.ts +10 -7
- package/src/controller/ControlClasses/OcaPolarity.js +7 -5
- package/src/controller/ControlClasses/OcaPowerManager.d.ts +20 -14
- package/src/controller/ControlClasses/OcaPowerManager.js +27 -21
- package/src/controller/ControlClasses/OcaPowerSupply.d.ts +24 -15
- package/src/controller/ControlClasses/OcaPowerSupply.js +31 -23
- package/src/controller/ControlClasses/OcaRamper.d.ts +55 -34
- package/src/controller/ControlClasses/OcaRamper.js +58 -37
- package/src/controller/ControlClasses/OcaRoot.d.ts +28 -14
- package/src/controller/ControlClasses/OcaRoot.js +32 -24
- package/src/controller/ControlClasses/OcaSecurityManager.d.ts +29 -13
- package/src/controller/ControlClasses/OcaSecurityManager.js +31 -14
- package/src/controller/ControlClasses/OcaSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaSensor.js +6 -5
- package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +48 -38
- package/src/controller/ControlClasses/OcaSignalGenerator.js +57 -46
- package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -1
- package/src/controller/ControlClasses/OcaSignalInput.js +4 -1
- package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -1
- package/src/controller/ControlClasses/OcaSignalOutput.js +4 -1
- package/src/controller/ControlClasses/OcaStreamConnector.d.ts +59 -24
- package/src/controller/ControlClasses/OcaStreamConnector.js +80 -48
- package/src/controller/ControlClasses/OcaStreamNetwork.d.ts +100 -27
- package/src/controller/ControlClasses/OcaStreamNetwork.js +124 -54
- package/src/controller/ControlClasses/OcaStringActuator.d.ts +5 -4
- package/src/controller/ControlClasses/OcaStringActuator.js +7 -5
- package/src/controller/ControlClasses/OcaStringSensor.d.ts +7 -5
- package/src/controller/ControlClasses/OcaStringSensor.js +10 -7
- package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +73 -46
- package/src/controller/ControlClasses/OcaSubscriptionManager.js +78 -51
- package/src/controller/ControlClasses/OcaSummingPoint.d.ts +2 -1
- package/src/controller/ControlClasses/OcaSummingPoint.js +2 -1
- package/src/controller/ControlClasses/OcaSwitch.d.ts +23 -15
- package/src/controller/ControlClasses/OcaSwitch.js +31 -23
- package/src/controller/ControlClasses/OcaTaskManager.d.ts +47 -38
- package/src/controller/ControlClasses/OcaTaskManager.js +48 -37
- package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaTemperatureActuator.js +6 -4
- package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaTemperatureSensor.js +4 -3
- package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +4 -3
- package/src/controller/ControlClasses/OcaTimeSource.d.ts +38 -22
- package/src/controller/ControlClasses/OcaTimeSource.js +41 -27
- package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaUint16Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaUint16Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaUint32Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaUint32Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaUint64Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaUint64Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +6 -5
- package/src/controller/ControlClasses/OcaUint8Actuator.js +6 -4
- package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaUint8Sensor.js +4 -3
- package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +4 -4
- package/src/controller/ControlClasses/OcaVoltageSensor.js +4 -3
- package/src/controller/ControlClasses/OcaWorker.d.ts +38 -28
- package/src/controller/ControlClasses/OcaWorker.js +50 -40
- package/src/controller/abstract_udp_connection.js +215 -0
- package/src/controller/client_connection.d.ts +1 -1
- package/src/controller/node_udp.js +140 -0
- package/src/controller/property_event.js +1 -1
- package/src/controller/udp_connection.js +5 -270
- package/src/index.browser.js +2 -0
- package/src/index.js +2 -0
- package/src/types/OcaBlockMember.d.ts +1 -2
- package/src/types/OcaClassAuthorityID.d.ts +14 -3
- package/src/types/OcaClassAuthorityID.js +8 -2
- package/src/types/OcaClassIdentification.d.ts +4 -3
- package/src/types/OcaClassIdentification.js +2 -2
- package/src/types/OcaComponent.d.ts +3 -1
- package/src/types/OcaComponent.js +3 -1
- package/src/types/OcaDBr.d.ts +6 -4
- package/src/types/OcaDBr.js +3 -2
- package/src/types/OcaDelayValue.d.ts +1 -2
- package/src/types/OcaDeviceState.d.ts +4 -1
- package/src/types/OcaDeviceState.js +4 -1
- package/src/types/OcaDynamicsFunction.d.ts +2 -1
- package/src/types/OcaDynamicsFunction.js +2 -1
- package/src/types/OcaEvent.d.ts +3 -3
- package/src/types/OcaEvent.js +2 -1
- package/src/types/OcaEventID.d.ts +3 -1
- package/src/types/OcaEventID.js +3 -1
- package/src/types/OcaGlobalTypeIdentifier.d.ts +10 -4
- package/src/types/OcaGlobalTypeIdentifier.js +5 -2
- package/src/types/OcaGrouperCitizen.d.ts +7 -5
- package/src/types/OcaGrouperCitizen.js +4 -2
- package/src/types/OcaGrouperEnrollment.d.ts +8 -4
- package/src/types/OcaGrouperEnrollment.js +4 -2
- package/src/types/OcaGrouperGroup.d.ts +4 -2
- package/src/types/OcaGrouperGroup.js +2 -1
- package/src/types/OcaGrouperMode.d.ts +1 -1
- package/src/types/OcaGrouperMode.js +1 -1
- package/src/types/OcaGrouperStatusChangeEventData.d.ts +7 -19
- package/src/types/OcaGrouperStatusChangeEventData.js +5 -8
- package/src/types/OcaGrouperStatusChangeType.d.ts +2 -1
- package/src/types/OcaGrouperStatusChangeType.js +2 -1
- package/src/types/OcaLevelDetectionLaw.d.ts +2 -1
- package/src/types/OcaLevelDetectionLaw.js +2 -1
- package/src/types/OcaLibParamSetAssignment.d.ts +3 -3
- package/src/types/OcaLibParamSetAssignment.js +2 -1
- package/src/types/OcaLibVol.d.ts +3 -3
- package/src/types/OcaLibVol.js +3 -2
- package/src/types/OcaLibVolChangedEventData.d.ts +4 -21
- package/src/types/OcaLibVolChangedEventData.js +3 -7
- package/src/types/OcaLibVolData_ParamSet.d.ts +13 -3
- package/src/types/OcaLibVolData_ParamSet.js +11 -3
- package/src/types/OcaLibVolMetadata.d.ts +4 -5
- package/src/types/OcaLibVolMetadata.js +1 -1
- package/src/types/OcaLibVolType.d.ts +12 -4
- package/src/types/OcaLibVolType.js +6 -2
- package/src/types/OcaLibraryIdentifier.d.ts +3 -3
- package/src/types/OcaLibraryIdentifier.js +2 -1
- package/src/types/OcaManagerDefaultObjectNumbers.d.ts +58 -116
- package/src/types/OcaManagerDefaultObjectNumbers.js +2 -2
- package/src/types/OcaManagerDescriptor.d.ts +4 -0
- package/src/types/OcaManagerDescriptor.js +2 -0
- package/src/types/OcaMediaClockRate.d.ts +12 -6
- package/src/types/OcaMediaClockRate.js +6 -3
- package/src/types/OcaMediaCoding.d.ts +4 -2
- package/src/types/OcaMediaCoding.js +2 -1
- package/src/types/OcaMediaConnection.d.ts +21 -8
- package/src/types/OcaMediaConnection.js +18 -5
- package/src/types/OcaMediaConnectorStatus.d.ts +5 -4
- package/src/types/OcaMediaConnectorStatus.js +2 -1
- package/src/types/OcaMediaConnectorStatusChangedEventData.d.ts +2 -17
- package/src/types/OcaMediaConnectorStatusChangedEventData.js +1 -7
- package/src/types/OcaMediaSinkConnector.d.ts +43 -15
- package/src/types/OcaMediaSinkConnector.js +23 -7
- package/src/types/OcaMediaSinkConnectorChangedEventData.d.ts +20 -30
- package/src/types/OcaMediaSinkConnectorChangedEventData.js +8 -11
- package/src/types/OcaMediaSourceConnector.d.ts +33 -13
- package/src/types/OcaMediaSourceConnector.js +17 -7
- package/src/types/OcaMediaSourceConnectorChangedEventData.d.ts +20 -30
- package/src/types/OcaMediaSourceConnectorChangedEventData.js +8 -11
- package/src/types/OcaMethod.d.ts +8 -5
- package/src/types/OcaMethod.js +5 -2
- package/src/types/OcaMethodID.d.ts +3 -1
- package/src/types/OcaMethodID.js +3 -1
- package/src/types/OcaModelGUID.d.ts +4 -2
- package/src/types/OcaModelGUID.js +5 -4
- package/src/types/OcaNetworkMediaSourceOrSink.d.ts +2 -1
- package/src/types/OcaNetworkMediaSourceOrSink.js +2 -1
- package/src/types/OcaNetworkSystemInterfaceDescriptor.d.ts +2 -1
- package/src/types/OcaNetworkSystemInterfaceDescriptor.js +3 -2
- package/src/types/OcaNetworkSystemInterfaceID.d.ts +2 -1
- package/src/types/OcaNetworkSystemInterfaceID.js +3 -2
- package/src/types/OcaNotificationDeliveryMode.d.ts +2 -1
- package/src/types/OcaNotificationDeliveryMode.js +2 -1
- package/src/types/OcaOPath.d.ts +2 -1
- package/src/types/OcaOPath.js +2 -1
- package/src/types/OcaObjectIdentification.d.ts +3 -3
- package/src/types/OcaObjectIdentification.js +2 -1
- package/src/types/OcaObjectListEventData.d.ts +3 -16
- package/src/types/OcaObjectListEventData.js +4 -8
- package/src/types/OcaObjectSearchResult.d.ts +5 -3
- package/src/types/OcaObjectSearchResult.js +4 -1
- package/src/types/OcaObjectSearchResultFlags.d.ts +1 -1
- package/src/types/OcaObjectSearchResultFlags.js +1 -1
- package/src/types/OcaObservationEventData.d.ts +8 -16
- package/src/types/OcaObservationEventData.js +8 -7
- package/src/types/OcaObservationListEventData.d.ts +8 -16
- package/src/types/OcaObservationListEventData.js +9 -8
- package/src/types/OcaParameterMask.d.ts +13 -0
- package/src/types/OcaParameterMask.js +11 -0
- package/src/types/OcaPilotToneDetectorSpec.d.ts +1 -2
- package/src/types/OcaPort.d.ts +3 -3
- package/src/types/OcaPort.js +2 -1
- package/src/types/OcaPortID.d.ts +4 -3
- package/src/types/OcaPortID.js +3 -1
- package/src/types/OcaPositionCoordinateSystem.d.ts +2 -1
- package/src/types/OcaPositionCoordinateSystem.js +2 -1
- package/src/types/OcaPositionDescriptor.d.ts +21 -20
- package/src/types/OcaPositionDescriptor.js +12 -14
- package/src/types/OcaPositionDescriptorFieldFlags.d.ts +13 -0
- package/src/types/OcaPositionDescriptorFieldFlags.js +11 -0
- package/src/types/OcaPowerState.d.ts +2 -1
- package/src/types/OcaPowerState.js +2 -1
- package/src/types/OcaPresentationUnit.d.ts +8 -1
- package/src/types/OcaPresentationUnit.js +8 -1
- package/src/types/OcaProperty.d.ts +3 -3
- package/src/types/OcaProperty.js +2 -1
- package/src/types/OcaPropertyDescriptor.d.ts +9 -9
- package/src/types/OcaPropertyDescriptor.js +4 -3
- package/src/types/OcaPropertyID.d.ts +3 -1
- package/src/types/OcaPropertyID.js +3 -1
- package/src/types/OcaProtoObjectIdentification.d.ts +3 -3
- package/src/types/OcaProtoObjectIdentification.js +2 -1
- package/src/types/OcaProtoPort.d.ts +9 -5
- package/src/types/OcaProtoPort.js +5 -2
- package/src/types/OcaProtoPortID.d.ts +4 -3
- package/src/types/OcaProtoPortID.js +3 -1
- package/src/types/OcaProtoSignalPath.d.ts +1 -2
- package/src/types/OcaRamperCommand.d.ts +1 -1
- package/src/types/OcaRamperCommand.js +1 -1
- package/src/types/OcaRamperState.d.ts +15 -10
- package/src/types/OcaRamperState.js +15 -10
- package/src/types/OcaSensorReadingState.d.ts +2 -1
- package/src/types/OcaSensorReadingState.js +2 -1
- package/src/types/OcaSignalPath.d.ts +1 -2
- package/src/types/OcaStream.d.ts +23 -10
- package/src/types/OcaStream.js +17 -5
- package/src/types/OcaStreamConnectorIdentification.d.ts +17 -7
- package/src/types/OcaStreamConnectorIdentification.js +15 -6
- package/src/types/OcaSubscriptionManagerState.d.ts +1 -1
- package/src/types/OcaSubscriptionManagerState.js +1 -1
- package/src/types/OcaTask.d.ts +27 -13
- package/src/types/OcaTask.js +14 -6
- package/src/types/OcaTaskManagerState.d.ts +13 -9
- package/src/types/OcaTaskManagerState.js +13 -9
- package/src/types/OcaTaskState.d.ts +3 -1
- package/src/types/OcaTaskState.js +3 -1
- package/src/types/OcaTaskStateChangedEventData.d.ts +6 -6
- package/src/types/OcaTaskStateChangedEventData.js +2 -2
- package/src/types/OcaTaskStatus.d.ts +6 -5
- package/src/types/OcaTaskStatus.js +5 -3
- package/src/types/OcaTimeMode.d.ts +1 -1
- package/src/types/OcaTimeMode.js +1 -1
- package/src/types/OcaTimePTP.d.ts +8 -3
- package/src/types/OcaTimePTP.js +6 -2
- package/src/types/OcaTransferFunction.js +3 -3
- package/src/types/OcaUnitOfMeasure.d.ts +5 -1
- package/src/types/OcaUnitOfMeasure.js +5 -1
- package/src/types/OcaVersion.d.ts +7 -5
- package/src/types/OcaVersion.js +4 -2
|
@@ -1,33 +1,57 @@
|
|
|
1
|
-
import { make_control_class } from '../make_control_class.js';
|
|
2
|
-
import { OcaAgent } from './OcaAgent.js';
|
|
3
1
|
import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
|
|
4
|
-
import { OcaEvent } from '../../OCP1/OcaEvent.js';
|
|
5
2
|
import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
|
|
6
3
|
import { OcaFloat64 } from '../../OCP1/OcaFloat64.js';
|
|
4
|
+
import { OcaObservationEventData } from '../../OCP1/OcaObservationEventData.js';
|
|
7
5
|
import { OcaObserverState } from '../../OCP1/OcaObserverState.js';
|
|
8
6
|
import { OcaProperty } from '../../OCP1/OcaProperty.js';
|
|
9
7
|
import { OcaRelationalOperator } from '../../OCP1/OcaRelationalOperator.js';
|
|
8
|
+
import { make_control_class } from '../make_control_class.js';
|
|
9
|
+
import { OcaAgent } from './OcaAgent.js';
|
|
10
10
|
|
|
11
11
|
/**
|
|
12
|
-
* Observer of a scalar numeric or boolean property ("target property") of a
|
|
12
|
+
* Observer of a scalar numeric or boolean property ("target property") of a
|
|
13
|
+
* specified object. Does not work for array, list, map, struct, or string
|
|
14
|
+
* properties. **OcaNumericObserver** emits an **Observation** event under
|
|
15
|
+
* certain conditions. There are three kinds of conditions:
|
|
13
16
|
*
|
|
14
|
-
* -
|
|
17
|
+
* - **Numeric comparison**. The target property value meets a certain
|
|
18
|
+
* comparison condition. A selection of comparison operators is available.
|
|
19
|
+
* Such observations are called "asynchronous observations".
|
|
15
20
|
*
|
|
21
|
+
* - **Timer expiry**. The value of the** Period** property, if nonzero, is a
|
|
22
|
+
* the time interval for the recurrent timed emission of **Observation**
|
|
23
|
+
* events. Such events ("periodic observations") are emitted regardless of
|
|
24
|
+
* the target property's value.
|
|
16
25
|
*
|
|
17
|
-
* -
|
|
26
|
+
* - **Combination of (1) and (2)**. If a numeric comparison and a nonzero
|
|
27
|
+
* period are both specified, then the **Observation** event is emitted when
|
|
28
|
+
* the timer expires **and** the numeric comparison is true. Such
|
|
29
|
+
* observations are called "conditional-periodic observations".
|
|
18
30
|
*
|
|
19
31
|
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
32
|
+
* This is a weakly typed class. Its threshold is specified as an **OcaFloat64**
|
|
33
|
+
* number.
|
|
22
34
|
*
|
|
23
|
-
* - For unsigned integer targets, the threshold and target are both coerced to
|
|
35
|
+
* - For unsigned integer targets, the threshold and target are both coerced to
|
|
36
|
+
* **OcaUint64** before comparing.
|
|
24
37
|
*
|
|
38
|
+
* - For signed integer targets, the threshold and target are both coerced to
|
|
39
|
+
* **OcaInt64** before comparing.
|
|
25
40
|
*
|
|
26
|
-
* - For
|
|
41
|
+
* - For boolean values, the threshold hreshold and target are both coerced to
|
|
42
|
+
* **OcaUint8**, True is assigned the value One, False is assigned the value
|
|
43
|
+
* Zero.
|
|
27
44
|
*
|
|
28
45
|
*
|
|
29
|
-
*
|
|
30
|
-
*
|
|
46
|
+
* Note that this coercion may result in rounding errors if the observed
|
|
47
|
+
* datatype is of type OcaUint64 or OcaUint64. An **OcaNumericObserver**
|
|
48
|
+
* instance and the property it observes are bound at the time the
|
|
49
|
+
* **OcaNumericObserver** instance is constructed. For static devices,
|
|
50
|
+
* construction will occur during manufacture, or possibly during a subsequent
|
|
51
|
+
* hardware configuration step. For reconfigurable devices, construction might
|
|
52
|
+
* be done by online controllers as part of device configuration sessions. This
|
|
53
|
+
* class is normally used for monitoring readings of sensor readings, but may be
|
|
54
|
+
* used equally well for watching workers' parameter settings.
|
|
31
55
|
* @extends OcaAgent
|
|
32
56
|
* @class OcaNumericObserver
|
|
33
57
|
*/
|
|
@@ -62,47 +86,55 @@ export const OcaNumericObserver = make_control_class(
|
|
|
62
86
|
['Hysteresis', [OcaFloat64], 3, 6, false, false, null],
|
|
63
87
|
['Period', [OcaFloat32], 3, 7, false, false, null],
|
|
64
88
|
],
|
|
65
|
-
[['Observation', 3, 1, [
|
|
89
|
+
[['Observation', 3, 1, [OcaObservationEventData]]]
|
|
66
90
|
);
|
|
67
91
|
|
|
68
92
|
/**
|
|
69
|
-
* Gets the value of the observed property that was reported by the most
|
|
93
|
+
* Gets the value of the observed property that was reported by the most
|
|
94
|
+
* recently emitted Observation event. If the numeric observer has never emitted
|
|
95
|
+
* an Observation event, returns the IEEE not-a-number value. The return status
|
|
96
|
+
* indicates whether the value has been successfully returned.
|
|
70
97
|
*
|
|
71
98
|
* @method OcaNumericObserver#GetLastObservation
|
|
72
99
|
* @returns {Promise<number>}
|
|
73
100
|
* A promise which resolves to a single value of type ``number``.
|
|
74
101
|
*/
|
|
75
102
|
/**
|
|
76
|
-
* Gets the observer's state. The return value indicates whether the state was
|
|
103
|
+
* Gets the observer's state. The return value indicates whether the state was
|
|
104
|
+
* successfully retrieved.
|
|
77
105
|
*
|
|
78
106
|
* @method OcaNumericObserver#GetState
|
|
79
107
|
* @returns {Promise<OcaObserverState>}
|
|
80
108
|
* A promise which resolves to a single value of type :class:`OcaObserverState`.
|
|
81
109
|
*/
|
|
82
110
|
/**
|
|
83
|
-
* Gets the identification of the property that the observer observes. The
|
|
111
|
+
* Gets the identification of the property that the observer observes. The
|
|
112
|
+
* return value indicates whether the identification was successfully retrieved.
|
|
84
113
|
*
|
|
85
114
|
* @method OcaNumericObserver#GetObservedProperty
|
|
86
115
|
* @returns {Promise<OcaProperty>}
|
|
87
116
|
* A promise which resolves to a single value of type :class:`OcaProperty`.
|
|
88
117
|
*/
|
|
89
118
|
/**
|
|
90
|
-
* Sets the identification of the property that the observer observes. The
|
|
119
|
+
* Sets the identification of the property that the observer observes. The
|
|
120
|
+
* return value indicates whether the identification was successfully set.
|
|
91
121
|
*
|
|
92
122
|
* @method OcaNumericObserver#SetObservedProperty
|
|
93
|
-
* @param {
|
|
123
|
+
* @param {IOcaProperty} property
|
|
94
124
|
*
|
|
95
125
|
* @returns {Promise<void>}
|
|
96
126
|
*/
|
|
97
127
|
/**
|
|
98
|
-
* Gets the value of the
|
|
128
|
+
* Gets the value of the **Threshold** property. The return value indicates
|
|
129
|
+
* whether the threshold value was successfully retrieved.
|
|
99
130
|
*
|
|
100
131
|
* @method OcaNumericObserver#GetThreshold
|
|
101
132
|
* @returns {Promise<number>}
|
|
102
133
|
* A promise which resolves to a single value of type ``number``.
|
|
103
134
|
*/
|
|
104
135
|
/**
|
|
105
|
-
* Sets the value of the
|
|
136
|
+
* Sets the value of the **Threshold** property. The return value indicates
|
|
137
|
+
* whether the threshold value was successfully set.
|
|
106
138
|
*
|
|
107
139
|
* @method OcaNumericObserver#SetThreshold
|
|
108
140
|
* @param {number} Threshold
|
|
@@ -110,29 +142,33 @@ export const OcaNumericObserver = make_control_class(
|
|
|
110
142
|
* @returns {Promise<void>}
|
|
111
143
|
*/
|
|
112
144
|
/**
|
|
113
|
-
* Gets the value of the
|
|
145
|
+
* Gets the value of the **Operator** property. The return value indicates
|
|
146
|
+
* whether the property was successfully retrieved.
|
|
114
147
|
*
|
|
115
148
|
* @method OcaNumericObserver#GetOperator
|
|
116
149
|
* @returns {Promise<OcaRelationalOperator>}
|
|
117
150
|
* A promise which resolves to a single value of type :class:`OcaRelationalOperator`.
|
|
118
151
|
*/
|
|
119
152
|
/**
|
|
120
|
-
* Sets the value of the
|
|
153
|
+
* Sets the value of the **Operator** property. The return value indicates
|
|
154
|
+
* whether the operator was successfully set.
|
|
121
155
|
*
|
|
122
156
|
* @method OcaNumericObserver#SetOperator
|
|
123
|
-
* @param {
|
|
157
|
+
* @param {IOcaRelationalOperator} operator
|
|
124
158
|
*
|
|
125
159
|
* @returns {Promise<void>}
|
|
126
160
|
*/
|
|
127
161
|
/**
|
|
128
|
-
* Gets the value of the
|
|
162
|
+
* Gets the value of the **TwoWay** property. The return value indicates whether
|
|
163
|
+
* the property was successfully retrieved.
|
|
129
164
|
*
|
|
130
165
|
* @method OcaNumericObserver#GetTwoWay
|
|
131
166
|
* @returns {Promise<boolean>}
|
|
132
167
|
* A promise which resolves to a single value of type ``boolean``.
|
|
133
168
|
*/
|
|
134
169
|
/**
|
|
135
|
-
* Sets the value of the
|
|
170
|
+
* Sets the value of the **TwoWay** property. The return value indicates whether
|
|
171
|
+
* the property was successfully set.
|
|
136
172
|
*
|
|
137
173
|
* @method OcaNumericObserver#SetTwoWay
|
|
138
174
|
* @param {boolean} twoWay
|
|
@@ -140,14 +176,16 @@ export const OcaNumericObserver = make_control_class(
|
|
|
140
176
|
* @returns {Promise<void>}
|
|
141
177
|
*/
|
|
142
178
|
/**
|
|
143
|
-
* Gets the value of the
|
|
179
|
+
* Gets the value of the **Hysteresis** property. The return value indicates
|
|
180
|
+
* whether the property was successfully retrieved.
|
|
144
181
|
*
|
|
145
182
|
* @method OcaNumericObserver#GetHysteresis
|
|
146
183
|
* @returns {Promise<number>}
|
|
147
184
|
* A promise which resolves to a single value of type ``number``.
|
|
148
185
|
*/
|
|
149
186
|
/**
|
|
150
|
-
* Sets the value of the
|
|
187
|
+
* Sets the value of the **Hysteresis** property. The return value indicates
|
|
188
|
+
* whether the property was successfully set.
|
|
151
189
|
*
|
|
152
190
|
* @method OcaNumericObserver#SetHysteresis
|
|
153
191
|
* @param {number} hysteresis
|
|
@@ -155,14 +193,16 @@ export const OcaNumericObserver = make_control_class(
|
|
|
155
193
|
* @returns {Promise<void>}
|
|
156
194
|
*/
|
|
157
195
|
/**
|
|
158
|
-
* Gets the value of the
|
|
196
|
+
* Gets the value of the **Period** property. The return value indicates whether
|
|
197
|
+
* the property was successfully retrieved.
|
|
159
198
|
*
|
|
160
199
|
* @method OcaNumericObserver#GetPeriod
|
|
161
200
|
* @returns {Promise<number>}
|
|
162
201
|
* A promise which resolves to a single value of type ``number``.
|
|
163
202
|
*/
|
|
164
203
|
/**
|
|
165
|
-
* Sets the value of the
|
|
204
|
+
* Sets the value of the **Period** property. The return value indicates whether
|
|
205
|
+
* the property was successfully set.
|
|
166
206
|
*
|
|
167
207
|
* @method OcaNumericObserver#SetPeriod
|
|
168
208
|
* @param {number} period
|
|
@@ -170,72 +210,68 @@ export const OcaNumericObserver = make_control_class(
|
|
|
170
210
|
* @returns {Promise<void>}
|
|
171
211
|
*/
|
|
172
212
|
/**
|
|
173
|
-
* Event emitted to signal an asynchronous, periodic, or conditional-periodic
|
|
213
|
+
* Event emitted to signal an asynchronous, periodic, or conditional-periodic
|
|
214
|
+
* observation.
|
|
174
215
|
* @member OcaNumericObserver#OnObservation {Event}
|
|
175
|
-
* Event emitted to signal an asynchronous, periodic, or
|
|
176
|
-
* conditional-periodic observation.
|
|
177
216
|
*/
|
|
178
217
|
/**
|
|
179
|
-
* This event is emitted when the property State changes in the remote object.
|
|
218
|
+
* This event is emitted when the property ``State`` changes in the remote object.
|
|
180
219
|
* The property ``State`` is described in the AES70 standard as follows.
|
|
181
220
|
* State: triggered, not triggered
|
|
182
221
|
*
|
|
183
222
|
* @member {PropertyEvent<OcaObserverState>} OcaNumericObserver#OnStateChanged
|
|
184
223
|
*/
|
|
185
224
|
/**
|
|
186
|
-
* This event is emitted when the property ObservedProperty changes in the remote object.
|
|
225
|
+
* This event is emitted when the property ``ObservedProperty`` changes in the remote object.
|
|
187
226
|
* The property ``ObservedProperty`` is described in the AES70 standard as follows.
|
|
188
227
|
* Identification of the property being observed.
|
|
189
228
|
*
|
|
190
229
|
* @member {PropertyEvent<OcaProperty>} OcaNumericObserver#OnObservedPropertyChanged
|
|
191
230
|
*/
|
|
192
231
|
/**
|
|
193
|
-
* This event is emitted when the property Threshold changes in the remote object.
|
|
232
|
+
* This event is emitted when the property ``Threshold`` changes in the remote object.
|
|
194
233
|
* The property ``Threshold`` is described in the AES70 standard as follows.
|
|
195
|
-
* Comparison value for raising the
|
|
234
|
+
* Comparison value for raising the **Triggered** event.
|
|
196
235
|
*
|
|
197
236
|
* @member {PropertyEvent<number>} OcaNumericObserver#OnThresholdChanged
|
|
198
237
|
*/
|
|
199
238
|
/**
|
|
200
|
-
* This event is emitted when the property Operator changes in the remote object.
|
|
239
|
+
* This event is emitted when the property ``Operator`` changes in the remote object.
|
|
201
240
|
* The property ``Operator`` is described in the AES70 standard as follows.
|
|
202
|
-
* Relational operator used when comparing the value of the observed
|
|
203
|
-
*
|
|
241
|
+
* Relational operator used when comparing the value of the observed property to
|
|
242
|
+
* the threshold value.
|
|
204
243
|
*
|
|
205
244
|
* @member {PropertyEvent<OcaRelationalOperator>} OcaNumericObserver#OnOperatorChanged
|
|
206
245
|
*/
|
|
207
246
|
/**
|
|
208
|
-
* This event is emitted when the property TwoWay changes in the remote object.
|
|
247
|
+
* This event is emitted when the property ``TwoWay`` changes in the remote object.
|
|
209
248
|
* The property ``TwoWay`` is described in the AES70 standard as follows.
|
|
210
|
-
* True to emit a
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
214
|
-
*
|
|
215
|
-
*
|
|
216
|
-
* <u>Equality</u>; inequality when <b>Operator </b>is set to
|
|
217
|
-
* <u>Inequality</u>).
|
|
249
|
+
* True to emit a **Triggered** event upon crossing the threshold in either
|
|
250
|
+
* direction; false to emit only upon crossing in the primary direction (i.e.
|
|
251
|
+
* rising when **Operator** is set to GreaterThan or GreaterThanOrEqual; falling
|
|
252
|
+
* when **Operator** is set to LessThan**** or LessThanOrEqual; equality when
|
|
253
|
+
* **Operator** is set to Equality; inequality when **Operator** is set to
|
|
254
|
+
* Inequality).
|
|
218
255
|
*
|
|
219
256
|
* @member {PropertyEvent<boolean>} OcaNumericObserver#OnTwoWayChanged
|
|
220
257
|
*/
|
|
221
258
|
/**
|
|
222
|
-
* This event is emitted when the property Hysteresis changes in the remote object.
|
|
259
|
+
* This event is emitted when the property ``Hysteresis`` changes in the remote object.
|
|
223
260
|
* The property ``Hysteresis`` is described in the AES70 standard as follows.
|
|
224
|
-
* Hysteresis that is used when observing the property value. This
|
|
225
|
-
*
|
|
226
|
-
*
|
|
227
|
-
*
|
|
228
|
-
*
|
|
229
|
-
*
|
|
230
|
-
* is 'Inequality'.
|
|
261
|
+
* Hysteresis that is used when observing the property value. This indicates
|
|
262
|
+
* which amount must be added/subtracted from the **Threshold** value to raise
|
|
263
|
+
* or re-enable the **Triggered** event of this **OcaObserver** object. The
|
|
264
|
+
* rules for hysteresis handling depend upon the configured **Operator** and
|
|
265
|
+
* **TwoWay** properties. The **Hysteresis** property is ignored if the
|
|
266
|
+
* **Operator** property is 'Inequality'.
|
|
231
267
|
*
|
|
232
268
|
* @member {PropertyEvent<number>} OcaNumericObserver#OnHysteresisChanged
|
|
233
269
|
*/
|
|
234
270
|
/**
|
|
235
|
-
* This event is emitted when the property Period changes in the remote object.
|
|
271
|
+
* This event is emitted when the property ``Period`` changes in the remote object.
|
|
236
272
|
* The property ``Period`` is described in the AES70 standard as follows.
|
|
237
|
-
* Repetition period or zero. If nonzero, the observer will retrieve the
|
|
238
|
-
*
|
|
273
|
+
* Repetition period or zero. If nonzero, the observer will retrieve the value
|
|
274
|
+
* and emit
|
|
239
275
|
*
|
|
240
276
|
* @member {PropertyEvent<number>} OcaNumericObserver#OnPeriodChanged
|
|
241
277
|
*/
|
|
@@ -1,52 +1,76 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { OcaObserverState } from '../../types/OcaObserverState';
|
|
2
|
+
import { IOcaProperty, OcaProperty } from '../../types/OcaProperty';
|
|
3
|
+
import {
|
|
4
|
+
IOcaRelationalOperator,
|
|
5
|
+
OcaRelationalOperator,
|
|
6
|
+
} from '../../types/OcaRelationalOperator';
|
|
3
7
|
import { Event } from '../event';
|
|
4
|
-
|
|
5
8
|
import { PropertyEvent } from '../property_event';
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import { OcaObserverState } from '../../types/OcaObserverState';
|
|
9
|
-
import { OcaProperty } from '../../types/OcaProperty';
|
|
10
|
-
import { OcaRelationalOperator } from '../../types/OcaRelationalOperator';
|
|
9
|
+
import { RemoteDevice } from '../remote_device';
|
|
10
|
+
import { OcaAgent } from './OcaAgent';
|
|
11
11
|
|
|
12
12
|
/**
|
|
13
|
-
* Observer of a scalar numeric or boolean property ("target property") of a set
|
|
13
|
+
* Observer of a scalar numeric or boolean property ("target property") of a set
|
|
14
|
+
* of specified objects. This class is a subclass of **OcaNumericObserver**, and
|
|
15
|
+
* differs from that class only in that it observes a set of properties rather
|
|
16
|
+
* than a single property. Does not work for array, list, map, struct, or string
|
|
17
|
+
* properties. **OcaNumericObserverList** emits an **Observation** event under
|
|
18
|
+
* certain conditions. There are three kinds of conditions:
|
|
14
19
|
*
|
|
15
|
-
* -
|
|
20
|
+
* - **Numeric comparison**. A target property value meets a certain comparison
|
|
21
|
+
* condition. A selection of comparison operators is available. Such
|
|
22
|
+
* observations are called "asynchronous observations".
|
|
16
23
|
*
|
|
24
|
+
* - **Timer expiry**. The value of the** Period** property, if nonzero, is a
|
|
25
|
+
* the time interval for the recurrent timed emission of **Observation**
|
|
26
|
+
* events. Such events ("periodic observations") are emitted regardless of
|
|
27
|
+
* the target property's value.
|
|
17
28
|
*
|
|
18
|
-
* -
|
|
29
|
+
* - **Combination of (1) and (2)**. If a numeric comparison and a nonzero
|
|
30
|
+
* period are both specified, then the **Observation** event is emitted when
|
|
31
|
+
* the timer expires **and** the numeric comparison is true for at least one
|
|
32
|
+
* of the observed properties. Such observations are called
|
|
33
|
+
* "conditional-periodic observations".
|
|
19
34
|
*
|
|
20
35
|
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
36
|
+
* This is a weakly typed class. Its threshold is specified as an **OcaFloat64**
|
|
37
|
+
* number.
|
|
23
38
|
*
|
|
24
|
-
* - For unsigned integer targets, the threshold and target are both coerced to
|
|
39
|
+
* - For unsigned integer targets, the threshold and target are both coerced to
|
|
40
|
+
* **OcaUint64** before comparing.
|
|
25
41
|
*
|
|
42
|
+
* - For signed integer targets, the threshold and target are both coerced to
|
|
43
|
+
* **OcaInt64** before comparing.
|
|
26
44
|
*
|
|
27
|
-
* - For
|
|
45
|
+
* - For boolean values, the threshold hreshold and target are both coerced to
|
|
46
|
+
* **OcaUint8**, True is assigned the value One, False is assigned the value
|
|
47
|
+
* Zero.
|
|
28
48
|
*
|
|
29
49
|
*
|
|
30
|
-
*
|
|
31
|
-
*
|
|
50
|
+
* Note that this coercion may result in rounding errors if the observed
|
|
51
|
+
* datatype is of type OcaUint64 or OcaUint64. An **OcaNumericObserver**
|
|
52
|
+
* instance and the property it observes are bound at the time the
|
|
53
|
+
* **OcaNumericObserver** instance is constructed. For static devices,
|
|
54
|
+
* construction will occur during manufacture, or possibly during a subsequent
|
|
55
|
+
* hardware configuration step. For reconfigurable devices, construction might
|
|
56
|
+
* be done by online controllers as part of device configuration sessions. This
|
|
57
|
+
* class is normally used for monitoring readings of sensor readings, but may be
|
|
58
|
+
* used equally well for watching workers' parameter settings.
|
|
32
59
|
* @extends OcaAgent
|
|
33
60
|
* @class OcaNumericObserverList
|
|
34
61
|
*/
|
|
35
62
|
export declare class OcaNumericObserverList extends OcaAgent {
|
|
36
63
|
/**
|
|
37
|
-
* Event emitted to signal an asynchronous, periodic, or conditional-periodic
|
|
38
|
-
*
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
*
|
|
42
|
-
*
|
|
43
|
-
* list is determined by the order of values set by
|
|
44
|
-
* SetObservedProperties, and is the same as the order of values returned
|
|
45
|
-
* by GetLastObservation, and the same as the order of object
|
|
64
|
+
* Event emitted to signal an asynchronous, periodic, or conditional-periodic
|
|
65
|
+
* observation. This event returns the complete list of values being observed,
|
|
66
|
+
* regardless of which one(s) may have triggered it in the first place. The
|
|
67
|
+
* order of values in the returned list is determined by the order of values
|
|
68
|
+
* set by SetObservedProperties, and is the same as the order of values
|
|
69
|
+
* returned by GetLastObservation, and the same as the order of object
|
|
46
70
|
* identifications returned by GetObservedProperties.
|
|
71
|
+
* @member OcaNumericObserverList#OnObservation {Event}
|
|
47
72
|
*/
|
|
48
73
|
OnObservation: Event;
|
|
49
|
-
|
|
50
74
|
/**
|
|
51
75
|
* This event is emitted whenever State changes.
|
|
52
76
|
*/
|
|
@@ -85,7 +109,14 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
85
109
|
constructor(objectNumber: number, device: RemoteDevice);
|
|
86
110
|
|
|
87
111
|
/**
|
|
88
|
-
* Gets the values of the observed property that were reported by the most
|
|
112
|
+
* Gets the values of the observed property that were reported by the most
|
|
113
|
+
* recently emitted Observation event. If the numeric observer has never
|
|
114
|
+
* emitted an Observation event, returns a list of IEEE not-a-number values.
|
|
115
|
+
* The order of values in the returned list is determined by the order of
|
|
116
|
+
* values set by SetObservedProperties, and is the same as the order of values
|
|
117
|
+
* returned by the Observation event, and the same as the order of object
|
|
118
|
+
* identifications returned by GetObservedProperties. The return status
|
|
119
|
+
* indicates whether the value has been successfully returned.
|
|
89
120
|
*
|
|
90
121
|
* @method OcaNumericObserverList#GetLastObservation
|
|
91
122
|
* @returns {Promise<number[]>}
|
|
@@ -94,7 +125,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
94
125
|
GetLastObservation(): Promise<number[]>;
|
|
95
126
|
|
|
96
127
|
/**
|
|
97
|
-
* Gets the observer's state. The return value indicates whether the state was
|
|
128
|
+
* Gets the observer's state. The return value indicates whether the state was
|
|
129
|
+
* successfully retrieved.
|
|
98
130
|
*
|
|
99
131
|
* @method OcaNumericObserverList#GetState
|
|
100
132
|
* @returns {Promise<OcaObserverState>}
|
|
@@ -103,26 +135,36 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
103
135
|
GetState(): Promise<OcaObserverState>;
|
|
104
136
|
|
|
105
137
|
/**
|
|
106
|
-
* Gets the identifications of the properties that the observer observes. The
|
|
138
|
+
* Gets the identifications of the properties that the observer observes. The
|
|
139
|
+
* order of property identifications in the returned list is determined by the
|
|
140
|
+
* order of property identifications set by SetObservedProperties, and is the
|
|
141
|
+
* same as the order of values returned by GetLastObservation and the
|
|
142
|
+
* Observation event. The return value indicates whether the identifications
|
|
143
|
+
* were successfully retrieved.
|
|
107
144
|
*
|
|
108
145
|
* @method OcaNumericObserverList#GetObservedProperties
|
|
109
146
|
* @returns {Promise<OcaProperty[]>}
|
|
110
|
-
* A promise which resolves to a single value of type
|
|
147
|
+
* A promise which resolves to a single value of type :class:`OcaProperty[]`.
|
|
111
148
|
*/
|
|
112
149
|
GetObservedProperties(): Promise<OcaProperty[]>;
|
|
113
150
|
|
|
114
151
|
/**
|
|
115
|
-
* Sets the identifications of the properties that the observer observes. The
|
|
152
|
+
* Sets the identifications of the properties that the observer observes. The
|
|
153
|
+
* order of property identifications supplied determines the order of property
|
|
154
|
+
* identifications returned by GetObservedProperties and the order of values
|
|
155
|
+
* returned by GetLastObservation and the Observation event. The return value
|
|
156
|
+
* indicates whether the identifications were successfully set.
|
|
116
157
|
*
|
|
117
158
|
* @method OcaNumericObserverList#SetObservedProperties
|
|
118
|
-
* @param {
|
|
159
|
+
* @param {IOcaProperty[]} property
|
|
119
160
|
*
|
|
120
161
|
* @returns {Promise<void>}
|
|
121
162
|
*/
|
|
122
163
|
SetObservedProperties(property: IOcaProperty[]): Promise<void>;
|
|
123
164
|
|
|
124
165
|
/**
|
|
125
|
-
* Gets the value of the
|
|
166
|
+
* Gets the value of the **Threshold** property. The return value indicates
|
|
167
|
+
* whether the threshold value was successfully retrieved.
|
|
126
168
|
*
|
|
127
169
|
* @method OcaNumericObserverList#GetThreshold
|
|
128
170
|
* @returns {Promise<number>}
|
|
@@ -131,7 +173,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
131
173
|
GetThreshold(): Promise<number>;
|
|
132
174
|
|
|
133
175
|
/**
|
|
134
|
-
* Sets the value of the
|
|
176
|
+
* Sets the value of the **Threshold** property. The return value indicates
|
|
177
|
+
* whether the threshold value was successfully set.
|
|
135
178
|
*
|
|
136
179
|
* @method OcaNumericObserverList#SetThreshold
|
|
137
180
|
* @param {number} Threshold
|
|
@@ -141,7 +184,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
141
184
|
SetThreshold(Threshold: number): Promise<void>;
|
|
142
185
|
|
|
143
186
|
/**
|
|
144
|
-
* Gets the value of the
|
|
187
|
+
* Gets the value of the **Operator** property. The return value indicates
|
|
188
|
+
* whether the property was successfully retrieved.
|
|
145
189
|
*
|
|
146
190
|
* @method OcaNumericObserverList#GetOperator
|
|
147
191
|
* @returns {Promise<OcaRelationalOperator>}
|
|
@@ -150,17 +194,19 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
150
194
|
GetOperator(): Promise<OcaRelationalOperator>;
|
|
151
195
|
|
|
152
196
|
/**
|
|
153
|
-
* Sets the value of the
|
|
197
|
+
* Sets the value of the **Operator** property. The return value indicates
|
|
198
|
+
* whether the operator was successfully set.
|
|
154
199
|
*
|
|
155
200
|
* @method OcaNumericObserverList#SetOperator
|
|
156
|
-
* @param {
|
|
201
|
+
* @param {IOcaRelationalOperator} operator
|
|
157
202
|
*
|
|
158
203
|
* @returns {Promise<void>}
|
|
159
204
|
*/
|
|
160
|
-
SetOperator(
|
|
205
|
+
SetOperator(operator: IOcaRelationalOperator): Promise<void>;
|
|
161
206
|
|
|
162
207
|
/**
|
|
163
|
-
* Gets the value of the
|
|
208
|
+
* Gets the value of the **TwoWay** property. The return value indicates
|
|
209
|
+
* whether the property was successfully retrieved.
|
|
164
210
|
*
|
|
165
211
|
* @method OcaNumericObserverList#GetTwoWay
|
|
166
212
|
* @returns {Promise<boolean>}
|
|
@@ -169,7 +215,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
169
215
|
GetTwoWay(): Promise<boolean>;
|
|
170
216
|
|
|
171
217
|
/**
|
|
172
|
-
* Sets the value of the
|
|
218
|
+
* Sets the value of the **TwoWay** property. The return value indicates
|
|
219
|
+
* whether the property was successfully set.
|
|
173
220
|
*
|
|
174
221
|
* @method OcaNumericObserverList#SetTwoWay
|
|
175
222
|
* @param {boolean} twoWay
|
|
@@ -179,7 +226,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
179
226
|
SetTwoWay(twoWay: boolean): Promise<void>;
|
|
180
227
|
|
|
181
228
|
/**
|
|
182
|
-
* Gets the value of the
|
|
229
|
+
* Gets the value of the **Hysteresis** property. The return value indicates
|
|
230
|
+
* whether the property was successfully retrieved.
|
|
183
231
|
*
|
|
184
232
|
* @method OcaNumericObserverList#GetHysteresis
|
|
185
233
|
* @returns {Promise<number>}
|
|
@@ -188,7 +236,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
188
236
|
GetHysteresis(): Promise<number>;
|
|
189
237
|
|
|
190
238
|
/**
|
|
191
|
-
* Sets the value of the
|
|
239
|
+
* Sets the value of the **Hysteresis** property. The return value indicates
|
|
240
|
+
* whether the property was successfully set.
|
|
192
241
|
*
|
|
193
242
|
* @method OcaNumericObserverList#SetHysteresis
|
|
194
243
|
* @param {number} hysteresis
|
|
@@ -198,7 +247,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
198
247
|
SetHysteresis(hysteresis: number): Promise<void>;
|
|
199
248
|
|
|
200
249
|
/**
|
|
201
|
-
* Gets the value of the
|
|
250
|
+
* Gets the value of the **Period** property. The return value indicates
|
|
251
|
+
* whether the property was successfully retrieved.
|
|
202
252
|
*
|
|
203
253
|
* @method OcaNumericObserverList#GetPeriod
|
|
204
254
|
* @returns {Promise<number>}
|
|
@@ -207,7 +257,8 @@ export declare class OcaNumericObserverList extends OcaAgent {
|
|
|
207
257
|
GetPeriod(): Promise<number>;
|
|
208
258
|
|
|
209
259
|
/**
|
|
210
|
-
* Sets the value of the
|
|
260
|
+
* Sets the value of the **Period** property. The return value indicates
|
|
261
|
+
* whether the property was successfully set.
|
|
211
262
|
*
|
|
212
263
|
* @method OcaNumericObserverList#SetPeriod
|
|
213
264
|
* @param {number} period
|