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.
Files changed (433) hide show
  1. package/Changelog +18 -0
  2. package/dist/AES70.es5.js +1 -1
  3. package/package.json +1 -1
  4. package/src/OCP1/OcaBlockMember.js +1 -1
  5. package/src/OCP1/OcaClassAuthorityID.js +1 -1
  6. package/src/OCP1/OcaClassIdentification.js +1 -1
  7. package/src/OCP1/OcaDBr.js +1 -1
  8. package/src/OCP1/OcaDelayValue.js +1 -1
  9. package/src/OCP1/OcaEvent.js +1 -1
  10. package/src/OCP1/OcaEventID.js +1 -1
  11. package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
  12. package/src/OCP1/OcaGrouperCitizen.js +1 -1
  13. package/src/OCP1/OcaGrouperEnrollment.js +1 -1
  14. package/src/OCP1/OcaGrouperGroup.js +1 -1
  15. package/src/OCP1/OcaGrouperStatusChangeEventData.js +1 -3
  16. package/src/OCP1/OcaImpedance.js +1 -1
  17. package/src/OCP1/OcaLibParamSetAssignment.js +1 -1
  18. package/src/OCP1/OcaLibVol.js +1 -1
  19. package/src/OCP1/OcaLibVolChangedEventData.js +1 -3
  20. package/src/OCP1/OcaLibVolData_ParamSet.js +1 -1
  21. package/src/OCP1/OcaLibVolIdentifier.js +1 -1
  22. package/src/OCP1/OcaLibVolMetadata.js +1 -1
  23. package/src/OCP1/OcaLibVolType.js +1 -1
  24. package/src/OCP1/OcaLibraryIdentifier.js +1 -1
  25. package/src/OCP1/OcaManagerDescriptor.js +1 -1
  26. package/src/OCP1/OcaMediaClockRate.js +1 -1
  27. package/src/OCP1/OcaMediaCoding.js +1 -1
  28. package/src/OCP1/OcaMediaConnection.js +1 -1
  29. package/src/OCP1/OcaMediaConnectorElement.js +2 -2
  30. package/src/OCP1/OcaMediaConnectorStatus.js +1 -1
  31. package/src/OCP1/OcaMediaConnectorStatusChangedEventData.js +1 -3
  32. package/src/OCP1/OcaMediaSinkConnector.js +1 -1
  33. package/src/OCP1/OcaMediaSinkConnectorChangedEventData.js +1 -3
  34. package/src/OCP1/OcaMediaSourceConnector.js +1 -1
  35. package/src/OCP1/OcaMediaSourceConnectorChangedEventData.js +1 -3
  36. package/src/OCP1/OcaMethod.js +1 -1
  37. package/src/OCP1/OcaMethodID.js +1 -1
  38. package/src/OCP1/OcaModelDescription.js +1 -1
  39. package/src/OCP1/OcaModelGUID.js +1 -1
  40. package/src/OCP1/OcaNetworkStatistics.js +1 -1
  41. package/src/OCP1/OcaNetworkSystemInterfaceDescriptor.js +1 -1
  42. package/src/OCP1/OcaNetworkSystemInterfaceID.js +1 -1
  43. package/src/OCP1/OcaOPath.js +1 -1
  44. package/src/OCP1/OcaObjectIdentification.js +1 -1
  45. package/src/OCP1/OcaObjectListEventData.js +1 -3
  46. package/src/OCP1/OcaObjectSearchResult.js +1 -1
  47. package/src/OCP1/OcaObservationEventData.js +1 -3
  48. package/src/OCP1/OcaObservationListEventData.js +1 -3
  49. package/src/OCP1/OcaParameterMask.js +3 -0
  50. package/src/OCP1/OcaPilotToneDetectorSpec.js +1 -1
  51. package/src/OCP1/OcaPort.js +1 -1
  52. package/src/OCP1/OcaPortID.js +1 -1
  53. package/src/OCP1/OcaPositionDescriptor.js +3 -3
  54. package/src/OCP1/OcaPositionDescriptorFieldFlags.js +3 -0
  55. package/src/OCP1/OcaProperty.js +1 -1
  56. package/src/OCP1/OcaPropertyDescriptor.js +1 -1
  57. package/src/OCP1/OcaPropertyID.js +1 -1
  58. package/src/OCP1/OcaProtoObjectIdentification.js +1 -1
  59. package/src/OCP1/OcaProtoPort.js +1 -1
  60. package/src/OCP1/OcaProtoPortID.js +1 -1
  61. package/src/OCP1/OcaProtoSignalPath.js +1 -1
  62. package/src/OCP1/OcaSignalPath.js +1 -1
  63. package/src/OCP1/OcaStream.js +1 -1
  64. package/src/OCP1/OcaStreamConnectorIdentification.js +1 -1
  65. package/src/OCP1/OcaTask.js +1 -1
  66. package/src/OCP1/OcaTaskStateChangedEventData.js +1 -1
  67. package/src/OCP1/OcaTaskStatus.js +1 -1
  68. package/src/OCP1/OcaTimePTP.js +1 -1
  69. package/src/OCP1/OcaTransferFunction.js +1 -1
  70. package/src/OCP1/OcaVersion.js +1 -1
  71. package/src/controller/ControlClasses/OcaActuator.d.ts +3 -1
  72. package/src/controller/ControlClasses/OcaActuator.js +3 -1
  73. package/src/controller/ControlClasses/OcaAgent.d.ts +10 -7
  74. package/src/controller/ControlClasses/OcaAgent.js +12 -8
  75. package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +35 -21
  76. package/src/controller/ControlClasses/OcaApplicationNetwork.js +43 -32
  77. package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +14 -8
  78. package/src/controller/ControlClasses/OcaAudioLevelSensor.js +13 -9
  79. package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +3 -2
  80. package/src/controller/ControlClasses/OcaAudioProcessingManager.js +3 -2
  81. package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +11 -8
  82. package/src/controller/ControlClasses/OcaBitstringActuator.js +13 -9
  83. package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +7 -5
  84. package/src/controller/ControlClasses/OcaBitstringSensor.js +9 -6
  85. package/src/controller/ControlClasses/OcaBlock.d.ts +88 -74
  86. package/src/controller/ControlClasses/OcaBlock.js +80 -63
  87. package/src/controller/ControlClasses/OcaBlockFactory.d.ts +73 -29
  88. package/src/controller/ControlClasses/OcaBlockFactory.js +69 -42
  89. package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +5 -4
  90. package/src/controller/ControlClasses/OcaBooleanActuator.js +6 -4
  91. package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +3 -3
  92. package/src/controller/ControlClasses/OcaBooleanSensor.js +4 -3
  93. package/src/controller/ControlClasses/OcaCodingManager.d.ts +10 -7
  94. package/src/controller/ControlClasses/OcaCodingManager.js +17 -13
  95. package/src/controller/ControlClasses/OcaControlNetwork.d.ts +4 -5
  96. package/src/controller/ControlClasses/OcaControlNetwork.js +5 -6
  97. package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +4 -4
  98. package/src/controller/ControlClasses/OcaCurrentSensor.js +4 -3
  99. package/src/controller/ControlClasses/OcaDelay.d.ts +6 -5
  100. package/src/controller/ControlClasses/OcaDelay.js +6 -4
  101. package/src/controller/ControlClasses/OcaDelayExtended.d.ts +18 -15
  102. package/src/controller/ControlClasses/OcaDelayExtended.js +17 -12
  103. package/src/controller/ControlClasses/OcaDeviceManager.d.ts +56 -31
  104. package/src/controller/ControlClasses/OcaDeviceManager.js +75 -51
  105. package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +33 -16
  106. package/src/controller/ControlClasses/OcaDeviceTimeManager.js +36 -18
  107. package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +6 -3
  108. package/src/controller/ControlClasses/OcaDiagnosticManager.js +8 -5
  109. package/src/controller/ControlClasses/OcaDynamics.d.ts +89 -61
  110. package/src/controller/ControlClasses/OcaDynamics.js +101 -79
  111. package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +77 -30
  112. package/src/controller/ControlClasses/OcaDynamicsCurve.js +85 -37
  113. package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +30 -22
  114. package/src/controller/ControlClasses/OcaDynamicsDetector.js +36 -24
  115. package/src/controller/ControlClasses/OcaEventHandler.d.ts +8 -6
  116. package/src/controller/ControlClasses/OcaEventHandler.js +9 -6
  117. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +13 -9
  118. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +15 -12
  119. package/src/controller/ControlClasses/OcaFilterClassical.d.ts +43 -30
  120. package/src/controller/ControlClasses/OcaFilterClassical.js +40 -31
  121. package/src/controller/ControlClasses/OcaFilterFIR.d.ts +12 -8
  122. package/src/controller/ControlClasses/OcaFilterFIR.js +19 -14
  123. package/src/controller/ControlClasses/OcaFilterParametric.d.ts +34 -25
  124. package/src/controller/ControlClasses/OcaFilterParametric.js +39 -33
  125. package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +6 -6
  126. package/src/controller/ControlClasses/OcaFilterPolynomial.js +11 -10
  127. package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +71 -21
  128. package/src/controller/ControlClasses/OcaFirmwareManager.js +71 -22
  129. package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +6 -5
  130. package/src/controller/ControlClasses/OcaFloat32Actuator.js +6 -4
  131. package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +4 -4
  132. package/src/controller/ControlClasses/OcaFloat32Sensor.js +4 -3
  133. package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +6 -5
  134. package/src/controller/ControlClasses/OcaFloat64Actuator.js +6 -4
  135. package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +4 -4
  136. package/src/controller/ControlClasses/OcaFloat64Sensor.js +4 -3
  137. package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +6 -5
  138. package/src/controller/ControlClasses/OcaFrequencyActuator.js +6 -4
  139. package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +4 -4
  140. package/src/controller/ControlClasses/OcaFrequencySensor.js +4 -3
  141. package/src/controller/ControlClasses/OcaGain.d.ts +6 -5
  142. package/src/controller/ControlClasses/OcaGain.js +6 -4
  143. package/src/controller/ControlClasses/OcaGainSensor.d.ts +6 -5
  144. package/src/controller/ControlClasses/OcaGainSensor.js +6 -4
  145. package/src/controller/ControlClasses/OcaGrouper.d.ts +138 -58
  146. package/src/controller/ControlClasses/OcaGrouper.js +139 -61
  147. package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +9 -10
  148. package/src/controller/ControlClasses/OcaIdentificationActuator.js +10 -10
  149. package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +6 -4
  150. package/src/controller/ControlClasses/OcaIdentificationSensor.js +5 -3
  151. package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +8 -8
  152. package/src/controller/ControlClasses/OcaImpedanceSensor.js +7 -6
  153. package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +6 -5
  154. package/src/controller/ControlClasses/OcaInt16Actuator.js +6 -4
  155. package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +4 -4
  156. package/src/controller/ControlClasses/OcaInt16Sensor.js +4 -3
  157. package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +6 -5
  158. package/src/controller/ControlClasses/OcaInt32Actuator.js +6 -4
  159. package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +4 -4
  160. package/src/controller/ControlClasses/OcaInt32Sensor.js +4 -3
  161. package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +6 -5
  162. package/src/controller/ControlClasses/OcaInt64Actuator.js +6 -4
  163. package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +4 -4
  164. package/src/controller/ControlClasses/OcaInt64Sensor.js +4 -3
  165. package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +6 -5
  166. package/src/controller/ControlClasses/OcaInt8Actuator.js +6 -4
  167. package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +4 -4
  168. package/src/controller/ControlClasses/OcaInt8Sensor.js +4 -3
  169. package/src/controller/ControlClasses/OcaLevelSensor.d.ts +4 -4
  170. package/src/controller/ControlClasses/OcaLevelSensor.js +4 -3
  171. package/src/controller/ControlClasses/OcaLibrary.d.ts +50 -25
  172. package/src/controller/ControlClasses/OcaLibrary.js +54 -26
  173. package/src/controller/ControlClasses/OcaLibraryManager.d.ts +22 -16
  174. package/src/controller/ControlClasses/OcaLibraryManager.js +22 -17
  175. package/src/controller/ControlClasses/OcaManager.d.ts +4 -1
  176. package/src/controller/ControlClasses/OcaManager.js +4 -1
  177. package/src/controller/ControlClasses/OcaMatrix.d.ts +69 -20
  178. package/src/controller/ControlClasses/OcaMatrix.js +86 -38
  179. package/src/controller/ControlClasses/OcaMediaClock.d.ts +33 -19
  180. package/src/controller/ControlClasses/OcaMediaClock.js +30 -19
  181. package/src/controller/ControlClasses/OcaMediaClock3.d.ts +37 -22
  182. package/src/controller/ControlClasses/OcaMediaClock3.js +39 -27
  183. package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +15 -9
  184. package/src/controller/ControlClasses/OcaMediaClockManager.js +28 -23
  185. package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +106 -74
  186. package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +121 -111
  187. package/src/controller/ControlClasses/OcaMute.d.ts +7 -7
  188. package/src/controller/ControlClasses/OcaMute.js +7 -5
  189. package/src/controller/ControlClasses/OcaNetwork.d.ts +38 -20
  190. package/src/controller/ControlClasses/OcaNetwork.js +58 -42
  191. package/src/controller/ControlClasses/OcaNetworkManager.d.ts +20 -9
  192. package/src/controller/ControlClasses/OcaNetworkManager.js +33 -23
  193. package/src/controller/ControlClasses/OcaNetworkSignalChannel.d.ts +43 -19
  194. package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +67 -44
  195. package/src/controller/ControlClasses/OcaNumericObserver.d.ts +77 -38
  196. package/src/controller/ControlClasses/OcaNumericObserver.js +95 -59
  197. package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +96 -45
  198. package/src/controller/ControlClasses/OcaNumericObserverList.js +129 -80
  199. package/src/controller/ControlClasses/OcaPanBalance.d.ts +10 -7
  200. package/src/controller/ControlClasses/OcaPanBalance.js +14 -11
  201. package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +31 -18
  202. package/src/controller/ControlClasses/OcaPhysicalPosition.js +43 -18
  203. package/src/controller/ControlClasses/OcaPolarity.d.ts +10 -7
  204. package/src/controller/ControlClasses/OcaPolarity.js +7 -5
  205. package/src/controller/ControlClasses/OcaPowerManager.d.ts +20 -14
  206. package/src/controller/ControlClasses/OcaPowerManager.js +27 -21
  207. package/src/controller/ControlClasses/OcaPowerSupply.d.ts +24 -15
  208. package/src/controller/ControlClasses/OcaPowerSupply.js +31 -23
  209. package/src/controller/ControlClasses/OcaRamper.d.ts +55 -34
  210. package/src/controller/ControlClasses/OcaRamper.js +58 -37
  211. package/src/controller/ControlClasses/OcaRoot.d.ts +28 -14
  212. package/src/controller/ControlClasses/OcaRoot.js +32 -24
  213. package/src/controller/ControlClasses/OcaSecurityManager.d.ts +29 -13
  214. package/src/controller/ControlClasses/OcaSecurityManager.js +31 -14
  215. package/src/controller/ControlClasses/OcaSensor.d.ts +4 -4
  216. package/src/controller/ControlClasses/OcaSensor.js +6 -5
  217. package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +48 -38
  218. package/src/controller/ControlClasses/OcaSignalGenerator.js +57 -46
  219. package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -1
  220. package/src/controller/ControlClasses/OcaSignalInput.js +4 -1
  221. package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -1
  222. package/src/controller/ControlClasses/OcaSignalOutput.js +4 -1
  223. package/src/controller/ControlClasses/OcaStreamConnector.d.ts +59 -24
  224. package/src/controller/ControlClasses/OcaStreamConnector.js +80 -48
  225. package/src/controller/ControlClasses/OcaStreamNetwork.d.ts +100 -27
  226. package/src/controller/ControlClasses/OcaStreamNetwork.js +124 -54
  227. package/src/controller/ControlClasses/OcaStringActuator.d.ts +5 -4
  228. package/src/controller/ControlClasses/OcaStringActuator.js +7 -5
  229. package/src/controller/ControlClasses/OcaStringSensor.d.ts +7 -5
  230. package/src/controller/ControlClasses/OcaStringSensor.js +10 -7
  231. package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +73 -46
  232. package/src/controller/ControlClasses/OcaSubscriptionManager.js +78 -51
  233. package/src/controller/ControlClasses/OcaSummingPoint.d.ts +2 -1
  234. package/src/controller/ControlClasses/OcaSummingPoint.js +2 -1
  235. package/src/controller/ControlClasses/OcaSwitch.d.ts +23 -15
  236. package/src/controller/ControlClasses/OcaSwitch.js +31 -23
  237. package/src/controller/ControlClasses/OcaTaskManager.d.ts +47 -38
  238. package/src/controller/ControlClasses/OcaTaskManager.js +48 -37
  239. package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +6 -5
  240. package/src/controller/ControlClasses/OcaTemperatureActuator.js +6 -4
  241. package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +4 -4
  242. package/src/controller/ControlClasses/OcaTemperatureSensor.js +4 -3
  243. package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +4 -4
  244. package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +4 -3
  245. package/src/controller/ControlClasses/OcaTimeSource.d.ts +38 -22
  246. package/src/controller/ControlClasses/OcaTimeSource.js +41 -27
  247. package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +6 -5
  248. package/src/controller/ControlClasses/OcaUint16Actuator.js +6 -4
  249. package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +4 -4
  250. package/src/controller/ControlClasses/OcaUint16Sensor.js +4 -3
  251. package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +6 -5
  252. package/src/controller/ControlClasses/OcaUint32Actuator.js +6 -4
  253. package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +4 -4
  254. package/src/controller/ControlClasses/OcaUint32Sensor.js +4 -3
  255. package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +6 -5
  256. package/src/controller/ControlClasses/OcaUint64Actuator.js +6 -4
  257. package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +4 -4
  258. package/src/controller/ControlClasses/OcaUint64Sensor.js +4 -3
  259. package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +6 -5
  260. package/src/controller/ControlClasses/OcaUint8Actuator.js +6 -4
  261. package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +4 -4
  262. package/src/controller/ControlClasses/OcaUint8Sensor.js +4 -3
  263. package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +4 -4
  264. package/src/controller/ControlClasses/OcaVoltageSensor.js +4 -3
  265. package/src/controller/ControlClasses/OcaWorker.d.ts +38 -28
  266. package/src/controller/ControlClasses/OcaWorker.js +50 -40
  267. package/src/controller/abstract_udp_connection.js +215 -0
  268. package/src/controller/client_connection.d.ts +1 -1
  269. package/src/controller/node_udp.js +140 -0
  270. package/src/controller/property_event.js +1 -1
  271. package/src/controller/udp_connection.js +5 -270
  272. package/src/index.browser.js +2 -0
  273. package/src/index.js +2 -0
  274. package/src/types/OcaBlockMember.d.ts +1 -2
  275. package/src/types/OcaClassAuthorityID.d.ts +14 -3
  276. package/src/types/OcaClassAuthorityID.js +8 -2
  277. package/src/types/OcaClassIdentification.d.ts +4 -3
  278. package/src/types/OcaClassIdentification.js +2 -2
  279. package/src/types/OcaComponent.d.ts +3 -1
  280. package/src/types/OcaComponent.js +3 -1
  281. package/src/types/OcaDBr.d.ts +6 -4
  282. package/src/types/OcaDBr.js +3 -2
  283. package/src/types/OcaDelayValue.d.ts +1 -2
  284. package/src/types/OcaDeviceState.d.ts +4 -1
  285. package/src/types/OcaDeviceState.js +4 -1
  286. package/src/types/OcaDynamicsFunction.d.ts +2 -1
  287. package/src/types/OcaDynamicsFunction.js +2 -1
  288. package/src/types/OcaEvent.d.ts +3 -3
  289. package/src/types/OcaEvent.js +2 -1
  290. package/src/types/OcaEventID.d.ts +3 -1
  291. package/src/types/OcaEventID.js +3 -1
  292. package/src/types/OcaGlobalTypeIdentifier.d.ts +10 -4
  293. package/src/types/OcaGlobalTypeIdentifier.js +5 -2
  294. package/src/types/OcaGrouperCitizen.d.ts +7 -5
  295. package/src/types/OcaGrouperCitizen.js +4 -2
  296. package/src/types/OcaGrouperEnrollment.d.ts +8 -4
  297. package/src/types/OcaGrouperEnrollment.js +4 -2
  298. package/src/types/OcaGrouperGroup.d.ts +4 -2
  299. package/src/types/OcaGrouperGroup.js +2 -1
  300. package/src/types/OcaGrouperMode.d.ts +1 -1
  301. package/src/types/OcaGrouperMode.js +1 -1
  302. package/src/types/OcaGrouperStatusChangeEventData.d.ts +7 -19
  303. package/src/types/OcaGrouperStatusChangeEventData.js +5 -8
  304. package/src/types/OcaGrouperStatusChangeType.d.ts +2 -1
  305. package/src/types/OcaGrouperStatusChangeType.js +2 -1
  306. package/src/types/OcaLevelDetectionLaw.d.ts +2 -1
  307. package/src/types/OcaLevelDetectionLaw.js +2 -1
  308. package/src/types/OcaLibParamSetAssignment.d.ts +3 -3
  309. package/src/types/OcaLibParamSetAssignment.js +2 -1
  310. package/src/types/OcaLibVol.d.ts +3 -3
  311. package/src/types/OcaLibVol.js +3 -2
  312. package/src/types/OcaLibVolChangedEventData.d.ts +4 -21
  313. package/src/types/OcaLibVolChangedEventData.js +3 -7
  314. package/src/types/OcaLibVolData_ParamSet.d.ts +13 -3
  315. package/src/types/OcaLibVolData_ParamSet.js +11 -3
  316. package/src/types/OcaLibVolMetadata.d.ts +4 -5
  317. package/src/types/OcaLibVolMetadata.js +1 -1
  318. package/src/types/OcaLibVolType.d.ts +12 -4
  319. package/src/types/OcaLibVolType.js +6 -2
  320. package/src/types/OcaLibraryIdentifier.d.ts +3 -3
  321. package/src/types/OcaLibraryIdentifier.js +2 -1
  322. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +58 -116
  323. package/src/types/OcaManagerDefaultObjectNumbers.js +2 -2
  324. package/src/types/OcaManagerDescriptor.d.ts +4 -0
  325. package/src/types/OcaManagerDescriptor.js +2 -0
  326. package/src/types/OcaMediaClockRate.d.ts +12 -6
  327. package/src/types/OcaMediaClockRate.js +6 -3
  328. package/src/types/OcaMediaCoding.d.ts +4 -2
  329. package/src/types/OcaMediaCoding.js +2 -1
  330. package/src/types/OcaMediaConnection.d.ts +21 -8
  331. package/src/types/OcaMediaConnection.js +18 -5
  332. package/src/types/OcaMediaConnectorStatus.d.ts +5 -4
  333. package/src/types/OcaMediaConnectorStatus.js +2 -1
  334. package/src/types/OcaMediaConnectorStatusChangedEventData.d.ts +2 -17
  335. package/src/types/OcaMediaConnectorStatusChangedEventData.js +1 -7
  336. package/src/types/OcaMediaSinkConnector.d.ts +43 -15
  337. package/src/types/OcaMediaSinkConnector.js +23 -7
  338. package/src/types/OcaMediaSinkConnectorChangedEventData.d.ts +20 -30
  339. package/src/types/OcaMediaSinkConnectorChangedEventData.js +8 -11
  340. package/src/types/OcaMediaSourceConnector.d.ts +33 -13
  341. package/src/types/OcaMediaSourceConnector.js +17 -7
  342. package/src/types/OcaMediaSourceConnectorChangedEventData.d.ts +20 -30
  343. package/src/types/OcaMediaSourceConnectorChangedEventData.js +8 -11
  344. package/src/types/OcaMethod.d.ts +8 -5
  345. package/src/types/OcaMethod.js +5 -2
  346. package/src/types/OcaMethodID.d.ts +3 -1
  347. package/src/types/OcaMethodID.js +3 -1
  348. package/src/types/OcaModelGUID.d.ts +4 -2
  349. package/src/types/OcaModelGUID.js +5 -4
  350. package/src/types/OcaNetworkMediaSourceOrSink.d.ts +2 -1
  351. package/src/types/OcaNetworkMediaSourceOrSink.js +2 -1
  352. package/src/types/OcaNetworkSystemInterfaceDescriptor.d.ts +2 -1
  353. package/src/types/OcaNetworkSystemInterfaceDescriptor.js +3 -2
  354. package/src/types/OcaNetworkSystemInterfaceID.d.ts +2 -1
  355. package/src/types/OcaNetworkSystemInterfaceID.js +3 -2
  356. package/src/types/OcaNotificationDeliveryMode.d.ts +2 -1
  357. package/src/types/OcaNotificationDeliveryMode.js +2 -1
  358. package/src/types/OcaOPath.d.ts +2 -1
  359. package/src/types/OcaOPath.js +2 -1
  360. package/src/types/OcaObjectIdentification.d.ts +3 -3
  361. package/src/types/OcaObjectIdentification.js +2 -1
  362. package/src/types/OcaObjectListEventData.d.ts +3 -16
  363. package/src/types/OcaObjectListEventData.js +4 -8
  364. package/src/types/OcaObjectSearchResult.d.ts +5 -3
  365. package/src/types/OcaObjectSearchResult.js +4 -1
  366. package/src/types/OcaObjectSearchResultFlags.d.ts +1 -1
  367. package/src/types/OcaObjectSearchResultFlags.js +1 -1
  368. package/src/types/OcaObservationEventData.d.ts +8 -16
  369. package/src/types/OcaObservationEventData.js +8 -7
  370. package/src/types/OcaObservationListEventData.d.ts +8 -16
  371. package/src/types/OcaObservationListEventData.js +9 -8
  372. package/src/types/OcaParameterMask.d.ts +13 -0
  373. package/src/types/OcaParameterMask.js +11 -0
  374. package/src/types/OcaPilotToneDetectorSpec.d.ts +1 -2
  375. package/src/types/OcaPort.d.ts +3 -3
  376. package/src/types/OcaPort.js +2 -1
  377. package/src/types/OcaPortID.d.ts +4 -3
  378. package/src/types/OcaPortID.js +3 -1
  379. package/src/types/OcaPositionCoordinateSystem.d.ts +2 -1
  380. package/src/types/OcaPositionCoordinateSystem.js +2 -1
  381. package/src/types/OcaPositionDescriptor.d.ts +21 -20
  382. package/src/types/OcaPositionDescriptor.js +12 -14
  383. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +13 -0
  384. package/src/types/OcaPositionDescriptorFieldFlags.js +11 -0
  385. package/src/types/OcaPowerState.d.ts +2 -1
  386. package/src/types/OcaPowerState.js +2 -1
  387. package/src/types/OcaPresentationUnit.d.ts +8 -1
  388. package/src/types/OcaPresentationUnit.js +8 -1
  389. package/src/types/OcaProperty.d.ts +3 -3
  390. package/src/types/OcaProperty.js +2 -1
  391. package/src/types/OcaPropertyDescriptor.d.ts +9 -9
  392. package/src/types/OcaPropertyDescriptor.js +4 -3
  393. package/src/types/OcaPropertyID.d.ts +3 -1
  394. package/src/types/OcaPropertyID.js +3 -1
  395. package/src/types/OcaProtoObjectIdentification.d.ts +3 -3
  396. package/src/types/OcaProtoObjectIdentification.js +2 -1
  397. package/src/types/OcaProtoPort.d.ts +9 -5
  398. package/src/types/OcaProtoPort.js +5 -2
  399. package/src/types/OcaProtoPortID.d.ts +4 -3
  400. package/src/types/OcaProtoPortID.js +3 -1
  401. package/src/types/OcaProtoSignalPath.d.ts +1 -2
  402. package/src/types/OcaRamperCommand.d.ts +1 -1
  403. package/src/types/OcaRamperCommand.js +1 -1
  404. package/src/types/OcaRamperState.d.ts +15 -10
  405. package/src/types/OcaRamperState.js +15 -10
  406. package/src/types/OcaSensorReadingState.d.ts +2 -1
  407. package/src/types/OcaSensorReadingState.js +2 -1
  408. package/src/types/OcaSignalPath.d.ts +1 -2
  409. package/src/types/OcaStream.d.ts +23 -10
  410. package/src/types/OcaStream.js +17 -5
  411. package/src/types/OcaStreamConnectorIdentification.d.ts +17 -7
  412. package/src/types/OcaStreamConnectorIdentification.js +15 -6
  413. package/src/types/OcaSubscriptionManagerState.d.ts +1 -1
  414. package/src/types/OcaSubscriptionManagerState.js +1 -1
  415. package/src/types/OcaTask.d.ts +27 -13
  416. package/src/types/OcaTask.js +14 -6
  417. package/src/types/OcaTaskManagerState.d.ts +13 -9
  418. package/src/types/OcaTaskManagerState.js +13 -9
  419. package/src/types/OcaTaskState.d.ts +3 -1
  420. package/src/types/OcaTaskState.js +3 -1
  421. package/src/types/OcaTaskStateChangedEventData.d.ts +6 -6
  422. package/src/types/OcaTaskStateChangedEventData.js +2 -2
  423. package/src/types/OcaTaskStatus.d.ts +6 -5
  424. package/src/types/OcaTaskStatus.js +5 -3
  425. package/src/types/OcaTimeMode.d.ts +1 -1
  426. package/src/types/OcaTimeMode.js +1 -1
  427. package/src/types/OcaTimePTP.d.ts +8 -3
  428. package/src/types/OcaTimePTP.js +6 -2
  429. package/src/types/OcaTransferFunction.js +3 -3
  430. package/src/types/OcaUnitOfMeasure.d.ts +5 -1
  431. package/src/types/OcaUnitOfMeasure.js +5 -1
  432. package/src/types/OcaVersion.d.ts +7 -5
  433. 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 specified object. Does not work for array, list, map, struct, or string properties. **OcaNumericObserver** emits an **Observation** event under certain conditions. There are three kinds of conditions:
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
- * - **Numeric comparison** . The target property value meets a certain comparison condition. A selection of comparison operators is available. Such observations are called "asynchronous observations".
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
- * - **Timer expiry** . The value of the **Period** property, if nonzero, is a the time interval for the recurrent timed emission of **Observation** events. Such events ("periodic observations") are emitted regardless of the target property's value.
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
- * - **Combination of (1) and (2)** . If a numeric comparison and a nonzero period are both specified, then the **Observation** event is emitted when the timer expires **and** the numeric comparison is true. Such observations are called "conditional-periodic observations".
21
- * This is a weakly typed class. Its threshold is specified as an **OcaFloat64** number.
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 **OcaUint64** before comparing.
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 signed integer targets, the threshold and target are both coerced to **OcaInt64** before comparing.
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
- * - For boolean values, the threshold hreshold and target are both coerced to **OcaUint8** , True is assigned the value One, False is assigned the value Zero.
30
- * Note that this coercion may result in rounding errors if the observed datatype is of type OcaUint64 or OcaUint64. An **OcaNumericObserver** instance and the property it observes are bound at the time the **OcaNumericObserver** instance is constructed. For static devices, construction will occur during manufacture, or possibly during a subsequent hardware configuration step. For reconfigurable devices, construction might be done by online controllers as part of device configuration sessions. This class is normally used for monitoring readings of sensor readings, but may be used equally well for watching workers' parameter settings.
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, [OcaEvent, OcaFloat64]]]
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 recently emitted Observation event. If the numeric observer has never emitted an Observation event, returns the IEEE not-a-number value. The return status indicates whether the value has been successfully returned.
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 successfully retrieved.
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 return value indicates whether the identification was successfully retrieved.
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 return value indicates whether the identification was successfully set.
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 {OcaProperty} property
123
+ * @param {IOcaProperty} property
94
124
  *
95
125
  * @returns {Promise<void>}
96
126
  */
97
127
  /**
98
- * Gets the value of the **Threshold** property. The return value indicates whether the threshold value was successfully retrieved.
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 **Threshold** property. The return value indicates whether the threshold value was successfully set.
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 **Operator** property. The return value indicates whether the property was successfully retrieved.
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 **Operator** property. The return value indicates whether the operator was successfully set.
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 {OcaRelationalOperator} _operator
157
+ * @param {IOcaRelationalOperator} operator
124
158
  *
125
159
  * @returns {Promise<void>}
126
160
  */
127
161
  /**
128
- * Gets the value of the **TwoWay** property. The return value indicates whether the property was successfully retrieved.
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 **TwoWay** property. The return value indicates whether the property was successfully set.
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 **Hysteresis** property. The return value indicates whether the property was successfully retrieved.
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 **Hysteresis** property. The return value indicates whether the property was successfully set.
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 **Period** property. The return value indicates whether the property was successfully retrieved.
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 **Period** property. The return value indicates whether the property was successfully set.
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 observation.
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 <b>Triggered </b>event.
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
- * property to the threshold value.
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 <b>Triggered </b>event upon crossing the threshold in
211
- * either direction; false to emit only upon crossing in the primary
212
- * direction (i.e. rising when <b>Operator </b>is set to
213
- * <u>GreaterThan</u> or <u>GreaterThanOrEqual</u>; falling when
214
- * <b>Operator </b>is set to <u>LessThan</u><b> </b>or
215
- * <u>LessThanOrEqual</u>; equality when <b>Operator </b>is set to
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
- * indicates which amount must be added/subtracted from the <b>Threshold
226
- * </b>value to raise or re-enable the <b>Triggered </b>event of this
227
- * <b>OcaObserver </b>object. The rules for hysteresis handling depend
228
- * upon the configured <b>Operator </b>and <b>TwoWay </b>properties. The
229
- * <b>Hysteresis </b>property is ignored if the <b>Operator </b>property
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
- * value and emit
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 { RemoteDevice } from '../remote_device';
2
- import { OcaAgent } from './OcaAgent';
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 { IOcaProperty } from '../../types/OcaProperty';
7
- import { IOcaRelationalOperator } from '../../types/OcaRelationalOperator';
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 of specified objects. This class is a subclass of **OcaNumericObserver** , and differs from that class only in that it observes a set of properties rather than a single property. Does not work for array, list, map, struct, or string properties. **OcaNumericObserverList** emits an **Observation** event under certain conditions. There are three kinds of conditions:
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
- * - **Numeric comparison** . A target property value meets a certain comparison condition. A selection of comparison operators is available. Such observations are called "asynchronous observations".
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
- * - **Timer expiry** . The value of the **Period** property, if nonzero, is a the time interval for the recurrent timed emission of **Observation** events. Such events ("periodic observations") are emitted regardless of the target property's value.
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
- * - **Combination of (1) and (2)** . If a numeric comparison and a nonzero period are both specified, then the **Observation** event is emitted when the timer expires **and** the numeric comparison is true for at least one of the observed properties. Such observations are called "conditional-periodic observations".
22
- * This is a weakly typed class. Its threshold is specified as an **OcaFloat64** number.
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 **OcaUint64** before comparing.
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 signed integer targets, the threshold and target are both coerced to **OcaInt64** before comparing.
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
- * - For boolean values, the threshold hreshold and target are both coerced to **OcaUint8** , True is assigned the value One, False is assigned the value Zero.
31
- * Note that this coercion may result in rounding errors if the observed datatype is of type OcaUint64 or OcaUint64. An **OcaNumericObserver** instance and the property it observes are bound at the time the **OcaNumericObserver** instance is constructed. For static devices, construction will occur during manufacture, or possibly during a subsequent hardware configuration step. For reconfigurable devices, construction might be done by online controllers as part of device configuration sessions. This class is normally used for monitoring readings of sensor readings, but may be used equally well for watching workers' parameter settings.
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 observation. This event returns the complete list of values being observed, regardless of which one(s) may have triggered it in the first place. The order of values in the returned list is determined by the order of values set by SetObservedProperties, and is the same as the order of values returned by GetLastObservation, and the same as the order of object identifications returned by GetObservedProperties.
38
- * @member OcaNumericObserverList#OnObservation {Event}
39
- * Event emitted to signal an asynchronous, periodic, or
40
- * conditional-periodic observation. This event returns the complete list
41
- * of values being observed, regardless of which one(s) may have
42
- * triggered it in the first place. The order of values in the returned
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 recently emitted Observation event. If the numeric observer has never emitted an Observation event, returns a list of IEEE not-a-number values. The order of values in the returned list is determined by the order of values set by SetObservedProperties, and is the same as the order of values returned by the Observation event, and the same as the order of object identifications returned by GetObservedProperties. The return status indicates whether the value has been successfully returned.
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 successfully retrieved.
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 order of property identifications in the returned list is determined by the order of property identifications set by SetObservedProperties, and is the same as the order of values returned by GetLastObservation and the Observation event. The return value indicates whether the identifications were successfully retrieved.
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 ``OcaProperty[]``.
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 order of property identifications supplied determines the order of property identifications returned by GetObservedProperties and the order of values returned by GetLastObservation and the Observation event. The return value indicates whether the identifications were successfully set.
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 {OcaProperty[]} property
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 **Threshold** property. The return value indicates whether the threshold value was successfully retrieved.
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 **Threshold** property. The return value indicates whether the threshold value was successfully set.
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 **Operator** property. The return value indicates whether the property was successfully retrieved.
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 **Operator** property. The return value indicates whether the operator was successfully set.
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 {OcaRelationalOperator} _operator
201
+ * @param {IOcaRelationalOperator} operator
157
202
  *
158
203
  * @returns {Promise<void>}
159
204
  */
160
- SetOperator(_operator: IOcaRelationalOperator): Promise<void>;
205
+ SetOperator(operator: IOcaRelationalOperator): Promise<void>;
161
206
 
162
207
  /**
163
- * Gets the value of the **TwoWay** property. The return value indicates whether the property was successfully retrieved.
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 **TwoWay** property. The return value indicates whether the property was successfully set.
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 **Hysteresis** property. The return value indicates whether the property was successfully retrieved.
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 **Hysteresis** property. The return value indicates whether the property was successfully set.
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 **Period** property. The return value indicates whether the property was successfully retrieved.
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 **Period** property. The return value indicates whether the property was successfully set.
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