aes70 1.3.8 → 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 (430) hide show
  1. package/Changelog +14 -1
  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 +11 -7
  268. package/src/controller/client_connection.d.ts +1 -1
  269. package/src/controller/node_udp.js +2 -3
  270. package/src/controller/property_event.js +1 -1
  271. package/src/types/OcaBlockMember.d.ts +1 -2
  272. package/src/types/OcaClassAuthorityID.d.ts +14 -3
  273. package/src/types/OcaClassAuthorityID.js +8 -2
  274. package/src/types/OcaClassIdentification.d.ts +4 -3
  275. package/src/types/OcaClassIdentification.js +2 -2
  276. package/src/types/OcaComponent.d.ts +3 -1
  277. package/src/types/OcaComponent.js +3 -1
  278. package/src/types/OcaDBr.d.ts +6 -4
  279. package/src/types/OcaDBr.js +3 -2
  280. package/src/types/OcaDelayValue.d.ts +1 -2
  281. package/src/types/OcaDeviceState.d.ts +4 -1
  282. package/src/types/OcaDeviceState.js +4 -1
  283. package/src/types/OcaDynamicsFunction.d.ts +2 -1
  284. package/src/types/OcaDynamicsFunction.js +2 -1
  285. package/src/types/OcaEvent.d.ts +3 -3
  286. package/src/types/OcaEvent.js +2 -1
  287. package/src/types/OcaEventID.d.ts +3 -1
  288. package/src/types/OcaEventID.js +3 -1
  289. package/src/types/OcaGlobalTypeIdentifier.d.ts +10 -4
  290. package/src/types/OcaGlobalTypeIdentifier.js +5 -2
  291. package/src/types/OcaGrouperCitizen.d.ts +7 -5
  292. package/src/types/OcaGrouperCitizen.js +4 -2
  293. package/src/types/OcaGrouperEnrollment.d.ts +8 -4
  294. package/src/types/OcaGrouperEnrollment.js +4 -2
  295. package/src/types/OcaGrouperGroup.d.ts +4 -2
  296. package/src/types/OcaGrouperGroup.js +2 -1
  297. package/src/types/OcaGrouperMode.d.ts +1 -1
  298. package/src/types/OcaGrouperMode.js +1 -1
  299. package/src/types/OcaGrouperStatusChangeEventData.d.ts +7 -19
  300. package/src/types/OcaGrouperStatusChangeEventData.js +5 -8
  301. package/src/types/OcaGrouperStatusChangeType.d.ts +2 -1
  302. package/src/types/OcaGrouperStatusChangeType.js +2 -1
  303. package/src/types/OcaLevelDetectionLaw.d.ts +2 -1
  304. package/src/types/OcaLevelDetectionLaw.js +2 -1
  305. package/src/types/OcaLibParamSetAssignment.d.ts +3 -3
  306. package/src/types/OcaLibParamSetAssignment.js +2 -1
  307. package/src/types/OcaLibVol.d.ts +3 -3
  308. package/src/types/OcaLibVol.js +3 -2
  309. package/src/types/OcaLibVolChangedEventData.d.ts +4 -21
  310. package/src/types/OcaLibVolChangedEventData.js +3 -7
  311. package/src/types/OcaLibVolData_ParamSet.d.ts +13 -3
  312. package/src/types/OcaLibVolData_ParamSet.js +11 -3
  313. package/src/types/OcaLibVolMetadata.d.ts +4 -5
  314. package/src/types/OcaLibVolMetadata.js +1 -1
  315. package/src/types/OcaLibVolType.d.ts +12 -4
  316. package/src/types/OcaLibVolType.js +6 -2
  317. package/src/types/OcaLibraryIdentifier.d.ts +3 -3
  318. package/src/types/OcaLibraryIdentifier.js +2 -1
  319. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +58 -116
  320. package/src/types/OcaManagerDefaultObjectNumbers.js +2 -2
  321. package/src/types/OcaManagerDescriptor.d.ts +4 -0
  322. package/src/types/OcaManagerDescriptor.js +2 -0
  323. package/src/types/OcaMediaClockRate.d.ts +12 -6
  324. package/src/types/OcaMediaClockRate.js +6 -3
  325. package/src/types/OcaMediaCoding.d.ts +4 -2
  326. package/src/types/OcaMediaCoding.js +2 -1
  327. package/src/types/OcaMediaConnection.d.ts +21 -8
  328. package/src/types/OcaMediaConnection.js +18 -5
  329. package/src/types/OcaMediaConnectorStatus.d.ts +5 -4
  330. package/src/types/OcaMediaConnectorStatus.js +2 -1
  331. package/src/types/OcaMediaConnectorStatusChangedEventData.d.ts +2 -17
  332. package/src/types/OcaMediaConnectorStatusChangedEventData.js +1 -7
  333. package/src/types/OcaMediaSinkConnector.d.ts +43 -15
  334. package/src/types/OcaMediaSinkConnector.js +23 -7
  335. package/src/types/OcaMediaSinkConnectorChangedEventData.d.ts +20 -30
  336. package/src/types/OcaMediaSinkConnectorChangedEventData.js +8 -11
  337. package/src/types/OcaMediaSourceConnector.d.ts +33 -13
  338. package/src/types/OcaMediaSourceConnector.js +17 -7
  339. package/src/types/OcaMediaSourceConnectorChangedEventData.d.ts +20 -30
  340. package/src/types/OcaMediaSourceConnectorChangedEventData.js +8 -11
  341. package/src/types/OcaMethod.d.ts +8 -5
  342. package/src/types/OcaMethod.js +5 -2
  343. package/src/types/OcaMethodID.d.ts +3 -1
  344. package/src/types/OcaMethodID.js +3 -1
  345. package/src/types/OcaModelGUID.d.ts +4 -2
  346. package/src/types/OcaModelGUID.js +5 -4
  347. package/src/types/OcaNetworkMediaSourceOrSink.d.ts +2 -1
  348. package/src/types/OcaNetworkMediaSourceOrSink.js +2 -1
  349. package/src/types/OcaNetworkSystemInterfaceDescriptor.d.ts +2 -1
  350. package/src/types/OcaNetworkSystemInterfaceDescriptor.js +3 -2
  351. package/src/types/OcaNetworkSystemInterfaceID.d.ts +2 -1
  352. package/src/types/OcaNetworkSystemInterfaceID.js +3 -2
  353. package/src/types/OcaNotificationDeliveryMode.d.ts +2 -1
  354. package/src/types/OcaNotificationDeliveryMode.js +2 -1
  355. package/src/types/OcaOPath.d.ts +2 -1
  356. package/src/types/OcaOPath.js +2 -1
  357. package/src/types/OcaObjectIdentification.d.ts +3 -3
  358. package/src/types/OcaObjectIdentification.js +2 -1
  359. package/src/types/OcaObjectListEventData.d.ts +3 -16
  360. package/src/types/OcaObjectListEventData.js +4 -8
  361. package/src/types/OcaObjectSearchResult.d.ts +5 -3
  362. package/src/types/OcaObjectSearchResult.js +4 -1
  363. package/src/types/OcaObjectSearchResultFlags.d.ts +1 -1
  364. package/src/types/OcaObjectSearchResultFlags.js +1 -1
  365. package/src/types/OcaObservationEventData.d.ts +8 -16
  366. package/src/types/OcaObservationEventData.js +8 -7
  367. package/src/types/OcaObservationListEventData.d.ts +8 -16
  368. package/src/types/OcaObservationListEventData.js +9 -8
  369. package/src/types/OcaParameterMask.d.ts +13 -0
  370. package/src/types/OcaParameterMask.js +11 -0
  371. package/src/types/OcaPilotToneDetectorSpec.d.ts +1 -2
  372. package/src/types/OcaPort.d.ts +3 -3
  373. package/src/types/OcaPort.js +2 -1
  374. package/src/types/OcaPortID.d.ts +4 -3
  375. package/src/types/OcaPortID.js +3 -1
  376. package/src/types/OcaPositionCoordinateSystem.d.ts +2 -1
  377. package/src/types/OcaPositionCoordinateSystem.js +2 -1
  378. package/src/types/OcaPositionDescriptor.d.ts +21 -20
  379. package/src/types/OcaPositionDescriptor.js +12 -14
  380. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +13 -0
  381. package/src/types/OcaPositionDescriptorFieldFlags.js +11 -0
  382. package/src/types/OcaPowerState.d.ts +2 -1
  383. package/src/types/OcaPowerState.js +2 -1
  384. package/src/types/OcaPresentationUnit.d.ts +8 -1
  385. package/src/types/OcaPresentationUnit.js +8 -1
  386. package/src/types/OcaProperty.d.ts +3 -3
  387. package/src/types/OcaProperty.js +2 -1
  388. package/src/types/OcaPropertyDescriptor.d.ts +9 -9
  389. package/src/types/OcaPropertyDescriptor.js +4 -3
  390. package/src/types/OcaPropertyID.d.ts +3 -1
  391. package/src/types/OcaPropertyID.js +3 -1
  392. package/src/types/OcaProtoObjectIdentification.d.ts +3 -3
  393. package/src/types/OcaProtoObjectIdentification.js +2 -1
  394. package/src/types/OcaProtoPort.d.ts +9 -5
  395. package/src/types/OcaProtoPort.js +5 -2
  396. package/src/types/OcaProtoPortID.d.ts +4 -3
  397. package/src/types/OcaProtoPortID.js +3 -1
  398. package/src/types/OcaProtoSignalPath.d.ts +1 -2
  399. package/src/types/OcaRamperCommand.d.ts +1 -1
  400. package/src/types/OcaRamperCommand.js +1 -1
  401. package/src/types/OcaRamperState.d.ts +15 -10
  402. package/src/types/OcaRamperState.js +15 -10
  403. package/src/types/OcaSensorReadingState.d.ts +2 -1
  404. package/src/types/OcaSensorReadingState.js +2 -1
  405. package/src/types/OcaSignalPath.d.ts +1 -2
  406. package/src/types/OcaStream.d.ts +23 -10
  407. package/src/types/OcaStream.js +17 -5
  408. package/src/types/OcaStreamConnectorIdentification.d.ts +17 -7
  409. package/src/types/OcaStreamConnectorIdentification.js +15 -6
  410. package/src/types/OcaSubscriptionManagerState.d.ts +1 -1
  411. package/src/types/OcaSubscriptionManagerState.js +1 -1
  412. package/src/types/OcaTask.d.ts +27 -13
  413. package/src/types/OcaTask.js +14 -6
  414. package/src/types/OcaTaskManagerState.d.ts +13 -9
  415. package/src/types/OcaTaskManagerState.js +13 -9
  416. package/src/types/OcaTaskState.d.ts +3 -1
  417. package/src/types/OcaTaskState.js +3 -1
  418. package/src/types/OcaTaskStateChangedEventData.d.ts +6 -6
  419. package/src/types/OcaTaskStateChangedEventData.js +2 -2
  420. package/src/types/OcaTaskStatus.d.ts +6 -5
  421. package/src/types/OcaTaskStatus.js +5 -3
  422. package/src/types/OcaTimeMode.d.ts +1 -1
  423. package/src/types/OcaTimeMode.js +1 -1
  424. package/src/types/OcaTimePTP.d.ts +8 -3
  425. package/src/types/OcaTimePTP.js +6 -2
  426. package/src/types/OcaTransferFunction.js +3 -3
  427. package/src/types/OcaUnitOfMeasure.d.ts +5 -1
  428. package/src/types/OcaUnitOfMeasure.js +5 -1
  429. package/src/types/OcaVersion.d.ts +7 -5
  430. package/src/types/OcaVersion.js +4 -2
@@ -1,34 +1,61 @@
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';
7
4
  import { OcaList } from '../../OCP1/OcaList.js';
5
+ import { OcaObservationListEventData } from '../../OCP1/OcaObservationListEventData.js';
8
6
  import { OcaObserverState } from '../../OCP1/OcaObserverState.js';
9
7
  import { OcaProperty } from '../../OCP1/OcaProperty.js';
10
8
  import { OcaRelationalOperator } from '../../OCP1/OcaRelationalOperator.js';
9
+ import { make_control_class } from '../make_control_class.js';
10
+ import { OcaAgent } from './OcaAgent.js';
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:
14
- *
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".
16
- *
17
- *
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.
19
- *
20
- *
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.
23
- *
24
- * - For unsigned integer targets, the threshold and target are both coerced to **OcaUint64** before comparing.
25
- *
26
- *
27
- * - For signed integer targets, the threshold and target are both coerced to **OcaInt64** before comparing.
28
- *
29
- *
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.
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:
19
+ *
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".
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.
28
+ *
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".
34
+ *
35
+ *
36
+ * This is a weakly typed class. Its threshold is specified as an **OcaFloat64**
37
+ * number.
38
+ *
39
+ * - For unsigned integer targets, the threshold and target are both coerced to
40
+ * **OcaUint64** before comparing.
41
+ *
42
+ * - For signed integer targets, the threshold and target are both coerced to
43
+ * **OcaInt64** before comparing.
44
+ *
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.
48
+ *
49
+ *
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
  */
@@ -63,47 +90,66 @@ export const OcaNumericObserverList = make_control_class(
63
90
  ['Hysteresis', [OcaFloat64], 3, 6, false, false, null],
64
91
  ['Period', [OcaFloat32], 3, 7, false, false, null],
65
92
  ],
66
- [['Observation', 3, 1, [OcaEvent, OcaList(OcaFloat64)]]]
93
+ [['Observation', 3, 1, [OcaObservationListEventData]]]
67
94
  );
68
95
 
69
96
  /**
70
- * 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.
97
+ * Gets the values of the observed property that were reported by the most
98
+ * recently emitted Observation event. If the numeric observer has never emitted
99
+ * an Observation event, returns a list of IEEE not-a-number values. The order
100
+ * of values in the returned list is determined by the order of values set by
101
+ * SetObservedProperties, and is the same as the order of values returned by the
102
+ * Observation event, and the same as the order of object identifications
103
+ * returned by GetObservedProperties. The return status indicates whether the
104
+ * value has been successfully returned.
71
105
  *
72
106
  * @method OcaNumericObserverList#GetLastObservation
73
107
  * @returns {Promise<number[]>}
74
108
  * A promise which resolves to a single value of type ``number[]``.
75
109
  */
76
110
  /**
77
- * Gets the observer's state. The return value indicates whether the state was successfully retrieved.
111
+ * Gets the observer's state. The return value indicates whether the state was
112
+ * successfully retrieved.
78
113
  *
79
114
  * @method OcaNumericObserverList#GetState
80
115
  * @returns {Promise<OcaObserverState>}
81
116
  * A promise which resolves to a single value of type :class:`OcaObserverState`.
82
117
  */
83
118
  /**
84
- * 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.
119
+ * Gets the identifications of the properties that the observer observes. The
120
+ * order of property identifications in the returned list is determined by the
121
+ * order of property identifications set by SetObservedProperties, and is the
122
+ * same as the order of values returned by GetLastObservation and the
123
+ * Observation event. The return value indicates whether the identifications
124
+ * were successfully retrieved.
85
125
  *
86
126
  * @method OcaNumericObserverList#GetObservedProperties
87
127
  * @returns {Promise<OcaProperty[]>}
88
- * A promise which resolves to a single value of type ``OcaProperty[]``.
128
+ * A promise which resolves to a single value of type :class:`OcaProperty[]`.
89
129
  */
90
130
  /**
91
- * 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.
131
+ * Sets the identifications of the properties that the observer observes. The
132
+ * order of property identifications supplied determines the order of property
133
+ * identifications returned by GetObservedProperties and the order of values
134
+ * returned by GetLastObservation and the Observation event. The return value
135
+ * indicates whether the identifications were successfully set.
92
136
  *
93
137
  * @method OcaNumericObserverList#SetObservedProperties
94
- * @param {OcaProperty[]} property
138
+ * @param {IOcaProperty[]} property
95
139
  *
96
140
  * @returns {Promise<void>}
97
141
  */
98
142
  /**
99
- * Gets the value of the **Threshold** property. The return value indicates whether the threshold value was successfully retrieved.
143
+ * Gets the value of the **Threshold** property. The return value indicates
144
+ * whether the threshold value was successfully retrieved.
100
145
  *
101
146
  * @method OcaNumericObserverList#GetThreshold
102
147
  * @returns {Promise<number>}
103
148
  * A promise which resolves to a single value of type ``number``.
104
149
  */
105
150
  /**
106
- * Sets the value of the **Threshold** property. The return value indicates whether the threshold value was successfully set.
151
+ * Sets the value of the **Threshold** property. The return value indicates
152
+ * whether the threshold value was successfully set.
107
153
  *
108
154
  * @method OcaNumericObserverList#SetThreshold
109
155
  * @param {number} Threshold
@@ -111,29 +157,33 @@ export const OcaNumericObserverList = make_control_class(
111
157
  * @returns {Promise<void>}
112
158
  */
113
159
  /**
114
- * Gets the value of the **Operator** property. The return value indicates whether the property was successfully retrieved.
160
+ * Gets the value of the **Operator** property. The return value indicates
161
+ * whether the property was successfully retrieved.
115
162
  *
116
163
  * @method OcaNumericObserverList#GetOperator
117
164
  * @returns {Promise<OcaRelationalOperator>}
118
165
  * A promise which resolves to a single value of type :class:`OcaRelationalOperator`.
119
166
  */
120
167
  /**
121
- * Sets the value of the **Operator** property. The return value indicates whether the operator was successfully set.
168
+ * Sets the value of the **Operator** property. The return value indicates
169
+ * whether the operator was successfully set.
122
170
  *
123
171
  * @method OcaNumericObserverList#SetOperator
124
- * @param {OcaRelationalOperator} _operator
172
+ * @param {IOcaRelationalOperator} operator
125
173
  *
126
174
  * @returns {Promise<void>}
127
175
  */
128
176
  /**
129
- * Gets the value of the **TwoWay** property. The return value indicates whether the property was successfully retrieved.
177
+ * Gets the value of the **TwoWay** property. The return value indicates whether
178
+ * the property was successfully retrieved.
130
179
  *
131
180
  * @method OcaNumericObserverList#GetTwoWay
132
181
  * @returns {Promise<boolean>}
133
182
  * A promise which resolves to a single value of type ``boolean``.
134
183
  */
135
184
  /**
136
- * Sets the value of the **TwoWay** property. The return value indicates whether the property was successfully set.
185
+ * Sets the value of the **TwoWay** property. The return value indicates whether
186
+ * the property was successfully set.
137
187
  *
138
188
  * @method OcaNumericObserverList#SetTwoWay
139
189
  * @param {boolean} twoWay
@@ -141,14 +191,16 @@ export const OcaNumericObserverList = make_control_class(
141
191
  * @returns {Promise<void>}
142
192
  */
143
193
  /**
144
- * Gets the value of the **Hysteresis** property. The return value indicates whether the property was successfully retrieved.
194
+ * Gets the value of the **Hysteresis** property. The return value indicates
195
+ * whether the property was successfully retrieved.
145
196
  *
146
197
  * @method OcaNumericObserverList#GetHysteresis
147
198
  * @returns {Promise<number>}
148
199
  * A promise which resolves to a single value of type ``number``.
149
200
  */
150
201
  /**
151
- * Sets the value of the **Hysteresis** property. The return value indicates whether the property was successfully set.
202
+ * Sets the value of the **Hysteresis** property. The return value indicates
203
+ * whether the property was successfully set.
152
204
  *
153
205
  * @method OcaNumericObserverList#SetHysteresis
154
206
  * @param {number} hysteresis
@@ -156,14 +208,16 @@ export const OcaNumericObserverList = make_control_class(
156
208
  * @returns {Promise<void>}
157
209
  */
158
210
  /**
159
- * Gets the value of the **Period** property. The return value indicates whether the property was successfully retrieved.
211
+ * Gets the value of the **Period** property. The return value indicates whether
212
+ * the property was successfully retrieved.
160
213
  *
161
214
  * @method OcaNumericObserverList#GetPeriod
162
215
  * @returns {Promise<number>}
163
216
  * A promise which resolves to a single value of type ``number``.
164
217
  */
165
218
  /**
166
- * Sets the value of the **Period** property. The return value indicates whether the property was successfully set.
219
+ * Sets the value of the **Period** property. The return value indicates whether
220
+ * the property was successfully set.
167
221
  *
168
222
  * @method OcaNumericObserverList#SetPeriod
169
223
  * @param {number} period
@@ -171,82 +225,77 @@ export const OcaNumericObserverList = make_control_class(
171
225
  * @returns {Promise<void>}
172
226
  */
173
227
  /**
174
- * 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.
228
+ * Event emitted to signal an asynchronous, periodic, or conditional-periodic
229
+ * observation. This event returns the complete list of values being observed,
230
+ * regardless of which one(s) may have triggered it in the first place. The
231
+ * order of values in the returned list is determined by the order of values set
232
+ * by SetObservedProperties, and is the same as the order of values returned by
233
+ * GetLastObservation, and the same as the order of object identifications
234
+ * returned by GetObservedProperties.
175
235
  * @member OcaNumericObserverList#OnObservation {Event}
176
- * Event emitted to signal an asynchronous, periodic, or
177
- * conditional-periodic observation. This event returns the complete list
178
- * of values being observed, regardless of which one(s) may have
179
- * triggered it in the first place. The order of values in the returned
180
- * list is determined by the order of values set by
181
- * SetObservedProperties, and is the same as the order of values returned
182
- * by GetLastObservation, and the same as the order of object
183
- * identifications returned by GetObservedProperties.
184
236
  */
185
237
  /**
186
- * This event is emitted when the property State changes in the remote object.
238
+ * This event is emitted when the property ``State`` changes in the remote object.
187
239
  * The property ``State`` is described in the AES70 standard as follows.
188
240
  * State: triggered, not triggered
189
241
  *
190
242
  * @member {PropertyEvent<OcaObserverState>} OcaNumericObserverList#OnStateChanged
191
243
  */
192
244
  /**
193
- * This event is emitted when the property ObservedProperties changes in the remote object.
245
+ * This event is emitted when the property ``ObservedProperties`` changes in the remote object.
194
246
  * The property ``ObservedProperties`` is described in the AES70 standard as follows.
195
247
  * List of identifiers of the properties are being observed.
196
248
  *
197
249
  * @member {PropertyEvent<OcaProperty[]>} OcaNumericObserverList#OnObservedPropertiesChanged
198
250
  */
199
251
  /**
200
- * This event is emitted when the property Threshold changes in the remote object.
252
+ * This event is emitted when the property ``Threshold`` changes in the remote object.
201
253
  * The property ``Threshold`` is described in the AES70 standard as follows.
202
- * Comparison value for raising the <b>Triggered </b>event.
254
+ * Comparison value for raising the **Triggered** event.
203
255
  *
204
256
  * @member {PropertyEvent<number>} OcaNumericObserverList#OnThresholdChanged
205
257
  */
206
258
  /**
207
- * This event is emitted when the property Operator changes in the remote object.
259
+ * This event is emitted when the property ``Operator`` changes in the remote object.
208
260
  * The property ``Operator`` is described in the AES70 standard as follows.
209
- * Relational operator used when comparing the value of the observed
210
- * property to the threshold value.
261
+ * Relational operator used when comparing the value of the observed property to
262
+ * the threshold value.
211
263
  *
212
264
  * @member {PropertyEvent<OcaRelationalOperator>} OcaNumericObserverList#OnOperatorChanged
213
265
  */
214
266
  /**
215
- * This event is emitted when the property TwoWay changes in the remote object.
267
+ * This event is emitted when the property ``TwoWay`` changes in the remote object.
216
268
  * The property ``TwoWay`` is described in the AES70 standard as follows.
217
- * True to emit a <b>Triggered </b>event upon crossing the threshold in
218
- * either direction; false to emit only upon crossing in the primary
219
- * direction (i.e. rising when <b>Operator </b>is set to
220
- * <u>GreaterThan</u> or <u>GreaterThanOrEqual</u>; falling when
221
- * <b>Operator </b>is set to <u>LessThan</u><b> </b>or
222
- * <u>LessThanOrEqual</u>; equality when <b>Operator </b>is set to
223
- * <u>Equality</u>; inequality when <b>Operator </b>is set to
224
- * <u>Inequality</u>).
269
+ * True to emit a **Triggered** event upon crossing the threshold in either
270
+ * direction; false to emit only upon crossing in the primary direction (i.e.
271
+ * rising when **Operator** is set to GreaterThan or GreaterThanOrEqual; falling
272
+ * when **Operator** is set to LessThan**** or LessThanOrEqual; equality when
273
+ * **Operator** is set to Equality; inequality when **Operator** is set to
274
+ * Inequality).
225
275
  *
226
276
  * @member {PropertyEvent<boolean>} OcaNumericObserverList#OnTwoWayChanged
227
277
  */
228
278
  /**
229
- * This event is emitted when the property Hysteresis changes in the remote object.
279
+ * This event is emitted when the property ``Hysteresis`` changes in the remote object.
230
280
  * The property ``Hysteresis`` is described in the AES70 standard as follows.
231
- * Hysteresis that is used when observing the property value. This
232
- * indicates which amount must be added/subtracted from the <b>Threshold
233
- * </b>value to raise or re-enable the <b>Triggered </b>event of this
234
- * <b>OcaObserver </b>object. The rules for hysteresis handling depend
235
- * upon the configured <b>Operator </b>and <b>TwoWay </b>properties. The
236
- * <b>Hysteresis </b>property is ignored if the <b>Operator </b>property
237
- * is 'Inequality'. If the State is <b>Not Triggered</b> it changes to
238
- * <b>Triggered </b>if <u>any </u>of the ObservedProperties reaches the
239
- * Threshold. If the State is <b>Triggered </b>it changes to <b>Not
240
- * Triggered</b> only if <u>all </u>of the ObservedProperties no longer
241
- * meet the ‘Threshold including Hysteresis’<b> .</b>
281
+ * Hysteresis that is used when observing the property value. This indicates
282
+ * which amount must be added/subtracted from the **Threshold** value to raise
283
+ * or re-enable the **Triggered** event of this **OcaObserver** object. The
284
+ * rules for hysteresis handling depend upon the configured **Operator** and
285
+ * **TwoWay** properties. The **Hysteresis** property is ignored if the
286
+ * **Operator** property is 'Inequality'. If the State is **Not Triggered** it
287
+ * changes to **Triggered** if any of the ObservedProperties reaches the
288
+ * Threshold. If the State is **Triggered** it changes to **Not Triggered** only
289
+ * if all of the ObservedProperties no longer meet the ‘Threshold including
290
+ * Hysteresis’** .**
242
291
  *
243
292
  * @member {PropertyEvent<number>} OcaNumericObserverList#OnHysteresisChanged
244
293
  */
245
294
  /**
246
- * This event is emitted when the property Period changes in the remote object.
295
+ * This event is emitted when the property ``Period`` changes in the remote object.
247
296
  * The property ``Period`` is described in the AES70 standard as follows.
248
- * Repetition period or zero. If nonzero, the observer will retrieve the
249
- * value and emit
297
+ * Repetition period or zero. If nonzero, the observer will retrieve the value
298
+ * and emit
250
299
  *
251
300
  * @member {PropertyEvent<number>} OcaNumericObserverList#OnPeriodChanged
252
301
  */
@@ -1,8 +1,7 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaActuator } from './OcaActuator';
3
1
  import { Arguments } from '../arguments';
4
-
5
2
  import { PropertyEvent } from '../property_event';
3
+ import { RemoteDevice } from '../remote_device';
4
+ import { OcaActuator } from './OcaActuator';
6
5
 
7
6
  /**
8
7
  * Pan or Balance control.
@@ -23,7 +22,8 @@ export declare class OcaPanBalance extends OcaActuator {
23
22
  constructor(objectNumber: number, device: RemoteDevice);
24
23
 
25
24
  /**
26
- * Gets the value and limits of the Position property. The return value indicates whether the data was successfully retrieved.
25
+ * Gets the value and limits of the Position property. The return value
26
+ * indicates whether the data was successfully retrieved.
27
27
  * The return values of this method are
28
28
  *
29
29
  * - Position of type ``number``
@@ -36,7 +36,8 @@ export declare class OcaPanBalance extends OcaActuator {
36
36
  GetPosition(): Promise<Arguments<[number, number, number]>>;
37
37
 
38
38
  /**
39
- * Sets the value of the Position property. The return value indicates whether the property was successfully set.
39
+ * Sets the value of the Position property. The return value indicates whether
40
+ * the property was successfully set.
40
41
  *
41
42
  * @method OcaPanBalance#SetPosition
42
43
  * @param {number} Position
@@ -46,7 +47,8 @@ export declare class OcaPanBalance extends OcaActuator {
46
47
  SetPosition(Position: number): Promise<void>;
47
48
 
48
49
  /**
49
- * Gets the value and limits of the MidpointGain property. The return value indicates whether the data was successfully retrieved.
50
+ * Gets the value and limits of the MidpointGain property. The return value
51
+ * indicates whether the data was successfully retrieved.
50
52
  * The return values of this method are
51
53
  *
52
54
  * - Gain of type ``number``
@@ -59,7 +61,8 @@ export declare class OcaPanBalance extends OcaActuator {
59
61
  GetMidpointGain(): Promise<Arguments<[number, number, number]>>;
60
62
 
61
63
  /**
62
- * Sets the value of the MidpointGain property. The return value indicates whether the property was successfully set.
64
+ * Sets the value of the MidpointGain property. The return value indicates
65
+ * whether the property was successfully set.
63
66
  *
64
67
  * @method OcaPanBalance#SetMidpointGain
65
68
  * @param {number} Gain
@@ -1,6 +1,6 @@
1
+ import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
1
2
  import { make_control_class } from '../make_control_class.js';
2
3
  import { OcaActuator } from './OcaActuator.js';
3
- import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
4
4
 
5
5
  /**
6
6
  * Pan or Balance control.
@@ -27,7 +27,8 @@ export const OcaPanBalance = make_control_class(
27
27
  );
28
28
 
29
29
  /**
30
- * Gets the value and limits of the Position property. The return value indicates whether the data was successfully retrieved.
30
+ * Gets the value and limits of the Position property. The return value
31
+ * indicates whether the data was successfully retrieved.
31
32
  * The return values of this method are
32
33
  *
33
34
  * - Position of type ``number``
@@ -38,7 +39,8 @@ export const OcaPanBalance = make_control_class(
38
39
  * @returns {Promise<Arguments<number,number,number>>}
39
40
  */
40
41
  /**
41
- * Sets the value of the Position property. The return value indicates whether the property was successfully set.
42
+ * Sets the value of the Position property. The return value indicates whether
43
+ * the property was successfully set.
42
44
  *
43
45
  * @method OcaPanBalance#SetPosition
44
46
  * @param {number} Position
@@ -46,7 +48,8 @@ export const OcaPanBalance = make_control_class(
46
48
  * @returns {Promise<void>}
47
49
  */
48
50
  /**
49
- * Gets the value and limits of the MidpointGain property. The return value indicates whether the data was successfully retrieved.
51
+ * Gets the value and limits of the MidpointGain property. The return value
52
+ * indicates whether the data was successfully retrieved.
50
53
  * The return values of this method are
51
54
  *
52
55
  * - Gain of type ``number``
@@ -57,7 +60,8 @@ export const OcaPanBalance = make_control_class(
57
60
  * @returns {Promise<Arguments<number,number,number>>}
58
61
  */
59
62
  /**
60
- * Sets the value of the MidpointGain property. The return value indicates whether the property was successfully set.
63
+ * Sets the value of the MidpointGain property. The return value indicates
64
+ * whether the property was successfully set.
61
65
  *
62
66
  * @method OcaPanBalance#SetMidpointGain
63
67
  * @param {number} Gain
@@ -65,18 +69,17 @@ export const OcaPanBalance = make_control_class(
65
69
  * @returns {Promise<void>}
66
70
  */
67
71
  /**
68
- * This event is emitted when the property Position changes in the remote object.
72
+ * This event is emitted when the property ``Position`` changes in the remote object.
69
73
  * The property ``Position`` is described in the AES70 standard as follows.
70
- * Pan position. Range = -1.0 to +1.0. -1.0 is 100% left, +1.0 is 100%
71
- * right.
74
+ * Pan position. Range = -1.0 to +1.0. -1.0 is 100% left, +1.0 is 100% right.
72
75
  *
73
76
  * @member {PropertyEvent<number>} OcaPanBalance#OnPositionChanged
74
77
  */
75
78
  /**
76
- * This event is emitted when the property MidpointGain changes in the remote object.
79
+ * This event is emitted when the property ``MidpointGain`` changes in the remote object.
77
80
  * The property ``MidpointGain`` is described in the AES70 standard as follows.
78
- * Midpoint gain. Normally, max=0dB, min=-6dB. May be readonly for
79
- * pan/balance objects with fixed midpoint gains.
81
+ * Midpoint gain. Normally, max=0dB, min=-6dB. May be readonly for pan/balance
82
+ * objects with fixed midpoint gains.
80
83
  *
81
84
  * @member {PropertyEvent<number>} OcaPanBalance#OnMidpointGainChanged
82
85
  */
@@ -1,14 +1,17 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaAgent } from './OcaAgent';
1
+ import { OcaPositionCoordinateSystem } from '../../types/OcaPositionCoordinateSystem';
2
+ import {
3
+ IOcaPositionDescriptor,
4
+ OcaPositionDescriptor,
5
+ } from '../../types/OcaPositionDescriptor';
6
+ import { OcaPositionDescriptorFieldFlags } from '../../types/OcaPositionDescriptorFieldFlags';
3
7
  import { Arguments } from '../arguments';
4
-
5
8
  import { PropertyEvent } from '../property_event';
6
- import { IOcaPositionDescriptor } from '../../types/OcaPositionDescriptor';
7
- import { OcaPositionCoordinateSystem } from '../../types/OcaPositionCoordinateSystem';
8
- import { OcaPositionDescriptor } from '../../types/OcaPositionDescriptor';
9
+ import { RemoteDevice } from '../remote_device';
10
+ import { OcaAgent } from './OcaAgent';
9
11
 
10
12
  /**
11
- * Physical position of device or an element of it. AES70 supports a variety of positional coordinate systems. For details, see AES70-1, section 5.5.9.
13
+ * Physical position of device or an element of it. AES70 supports a variety of
14
+ * positional coordinate systems. For details, see AES70-1, section 5.5.9.
12
15
  * @extends OcaAgent
13
16
  * @class OcaPhysicalPosition
14
17
  */
@@ -21,7 +24,8 @@ export declare class OcaPhysicalPosition extends OcaAgent {
21
24
  constructor(objectNumber: number, device: RemoteDevice);
22
25
 
23
26
  /**
24
- * Retrieves value of property **CoordinateSystem** . Result indicates whether retrieval was successful.
27
+ * Retrieves value of property **CoordinateSystem**. Result indicates whether
28
+ * retrieval was successful.
25
29
  *
26
30
  * @method OcaPhysicalPosition#GetCoordinateSystem
27
31
  * @returns {Promise<OcaPositionCoordinateSystem>}
@@ -30,21 +34,23 @@ export declare class OcaPhysicalPosition extends OcaAgent {
30
34
  GetCoordinateSystem(): Promise<OcaPositionCoordinateSystem>;
31
35
 
32
36
  /**
33
- * Retrieves value of property **PositionDescriptorFieldFlags** . Result indicates whether retrieval was successful.
37
+ * Retrieves value of property **PositionDescriptorFieldFlags**. Result
38
+ * indicates whether retrieval was successful.
34
39
  *
35
40
  * @method OcaPhysicalPosition#GetPositionDescriptorFieldFlags
36
- * @returns {Promise<number>}
37
- * A promise which resolves to a single value of type ``number``.
41
+ * @returns {Promise<OcaPositionDescriptorFieldFlags>}
42
+ * A promise which resolves to a single value of type :class:`OcaPositionDescriptorFieldFlags`.
38
43
  */
39
- GetPositionDescriptorFieldFlags(): Promise<number>;
44
+ GetPositionDescriptorFieldFlags(): Promise<OcaPositionDescriptorFieldFlags>;
40
45
 
41
46
  /**
42
- * Retrieves value of property **PositioinDescriptor** . Result indicates whether retrieval was successful.
47
+ * Retrieves value of property **PositioinDescriptor**. Result indicates
48
+ * whether retrieval was successful.
43
49
  * The return values of this method are
44
50
  *
45
- * - PositionDescriptor of type :class:`OcaPositionDescriptor`
46
- * - minPositionDescriptor of type :class:`OcaPositionDescriptor`
47
- * - maxPositionDescriptor of type :class:`OcaPositionDescriptor`
51
+ * - PositionDescriptor of type ``IOcaPositionDescriptor``
52
+ * - minPositionDescriptor of type ``IOcaPositionDescriptor``
53
+ * - maxPositionDescriptor of type ``IOcaPositionDescriptor``
48
54
  *
49
55
  * @method OcaPhysicalPosition#GetPositionDescriptor
50
56
  * @returns {Promise<Arguments<OcaPositionDescriptor,OcaPositionDescriptor,OcaPositionDescriptor>>}
@@ -56,10 +62,17 @@ export declare class OcaPhysicalPosition extends OcaAgent {
56
62
  >;
57
63
 
58
64
  /**
59
- * Sets value of property **PositionDescriptor** . Result indicates whether setting was successful. The **ParameterError** status is returned if: (a) the **FieldFlags** field of the given **PositionDescriptor** value differs from the object's basic position descriptor as given in its **PositionDescriptorFieldFlags** property, or (b) the given **CoordinateSystem** value conflicts with the object's basic coordinate system as given in its **CoordinateSystem** property. This is an optional method, not implemented for read-only position objects.
65
+ * Sets value of property **PositionDescriptor**. Result indicates whether
66
+ * setting was successful. The **ParameterError** status is returned if: (a)
67
+ * the **FieldFlags** field of the given **PositionDescriptor** value differs
68
+ * from the object's basic position descriptor as given in its
69
+ * **PositionDescriptorFieldFlags** property, or (b) the given
70
+ * **CoordinateSystem** value conflicts with the object's basic coordinate
71
+ * system as given in its **CoordinateSystem** property. This is an optional
72
+ * method, not implemented for read-only position objects.
60
73
  *
61
74
  * @method OcaPhysicalPosition#SetPositionDescriptor
62
- * @param {OcaPositionDescriptor} PositionDescriptor
75
+ * @param {IOcaPositionDescriptor} PositionDescriptor
63
76
  *
64
77
  * @returns {Promise<void>}
65
78
  */