aes70 1.6.1 → 2.0.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 (652) hide show
  1. package/COPYING +7 -7
  2. package/Changelog +9 -0
  3. package/README.md +74 -42
  4. package/dist/AES70.es5.js +24520 -1
  5. package/package.json +3 -3
  6. package/src/OCP1/Arguments.js +3 -0
  7. package/src/OCP1/Enum.js +8 -0
  8. package/src/OCP1/OcaActionObjectSearchResult.js +20 -0
  9. package/src/OCP1/OcaActionObjectSearchResultFlags.js +3 -0
  10. package/src/OCP1/OcaArray1D.js +108 -0
  11. package/src/OCP1/OcaBitstring.js +3 -0
  12. package/src/OCP1/OcaBlob.js +2 -43
  13. package/src/OCP1/OcaBlobFixedLen.js +8 -0
  14. package/src/OCP1/OcaBlockConfigurability.js +3 -0
  15. package/src/OCP1/OcaBoolean.js +3 -0
  16. package/src/OCP1/OcaCommand.js +17 -0
  17. package/src/OCP1/OcaCommandResult.js +17 -0
  18. package/src/OCP1/OcaCommandSetResult.js +17 -0
  19. package/src/OCP1/OcaConstructionParameter.js +16 -0
  20. package/src/OCP1/OcaCounter.js +22 -0
  21. package/src/OCP1/OcaCounterNotifierFilterParameters.js +19 -0
  22. package/src/OCP1/OcaCounterSet.js +17 -0
  23. package/src/OCP1/OcaCounterUpdate.js +18 -0
  24. package/src/OCP1/OcaCounterUpdateEventData.js +15 -0
  25. package/src/OCP1/OcaDatasetSearchResult.js +17 -0
  26. package/src/OCP1/OcaDeviceGenericState.js +4 -0
  27. package/src/OCP1/OcaDeviceOperationalState.js +16 -0
  28. package/src/OCP1/OcaExecutableType.js +4 -0
  29. package/src/OCP1/OcaFloat32.js +3 -0
  30. package/src/OCP1/OcaFloat64.js +3 -0
  31. package/src/OCP1/OcaGenericEndState.js +4 -0
  32. package/src/OCP1/OcaGlobalTypeIdentifier.js +1 -1
  33. package/src/OCP1/OcaGroupException.js +18 -0
  34. package/src/OCP1/OcaIODirection.js +4 -0
  35. package/src/OCP1/OcaIP4AutoconfigMode.js +4 -0
  36. package/src/OCP1/OcaIP4Gateway.js +17 -0
  37. package/src/OCP1/OcaIP4NetworkSettings.js +23 -0
  38. package/src/OCP1/OcaIP6AutoconfigMode.js +4 -0
  39. package/src/OCP1/OcaIP6Gateway.js +17 -0
  40. package/src/OCP1/OcaIP6NetworkSettings.js +24 -0
  41. package/src/OCP1/OcaInt16.js +3 -0
  42. package/src/OCP1/OcaInt32.js +3 -0
  43. package/src/OCP1/OcaInt64.js +3 -0
  44. package/src/OCP1/OcaInt8.js +3 -0
  45. package/src/OCP1/OcaInterval.js +18 -0
  46. package/src/OCP1/OcaIntervalBounds.js +3 -0
  47. package/src/OCP1/OcaJobDisposedEventData.js +18 -0
  48. package/src/OCP1/OcaJobDisposition.js +4 -0
  49. package/src/OCP1/OcaJobQueueItem.js +24 -0
  50. package/src/OCP1/OcaList.js +2 -127
  51. package/src/OCP1/OcaList2D.js +6 -0
  52. package/src/OCP1/OcaList32.js +3 -0
  53. package/src/OCP1/OcaLockState.js +4 -0
  54. package/src/OCP1/OcaLogFilter.js +20 -0
  55. package/src/OCP1/OcaLogRecord.js +21 -0
  56. package/src/OCP1/OcaLongBlob.js +3 -0
  57. package/src/OCP1/OcaManufacturer.js +19 -0
  58. package/src/OCP1/OcaMap.js +3 -0
  59. package/src/OCP1/OcaMatrixCommand.js +19 -0
  60. package/src/OCP1/OcaMatrixCoordinates.js +15 -0
  61. package/src/OCP1/OcaMediaAccessMode.js +4 -0
  62. package/src/OCP1/OcaMediaFrameFormat.js +4 -0
  63. package/src/OCP1/OcaMediaPlayOption.js +4 -0
  64. package/src/OCP1/OcaMediaRecorderPlayerState.js +4 -0
  65. package/src/OCP1/OcaMediaStreamEndpoint.js +40 -0
  66. package/src/OCP1/OcaMediaStreamEndpointCommand.js +4 -0
  67. package/src/OCP1/OcaMediaStreamEndpointState.js +4 -0
  68. package/src/OCP1/OcaMediaStreamEndpointStatus.js +16 -0
  69. package/src/OCP1/OcaMediaStreamMode.js +21 -0
  70. package/src/OCP1/OcaMediaStreamModeCapability.js +29 -0
  71. package/src/OCP1/OcaMediaStreamModeCapabilityDirection.js +3 -0
  72. package/src/OCP1/OcaMediaTrackFunction.js +3 -0
  73. package/src/OCP1/OcaMediaTransportSession.js +30 -0
  74. package/src/OCP1/OcaMediaTransportSessionConnection.js +17 -0
  75. package/src/OCP1/OcaMediaTransportSessionConnectionState.js +15 -0
  76. package/src/OCP1/OcaMediaTransportSessionState.js +4 -0
  77. package/src/OCP1/OcaMediaTransportSessionStatus.js +16 -0
  78. package/src/OCP1/OcaMediaTransportTimingParameters.js +16 -0
  79. package/src/OCP1/OcaMediaVolumePosition.js +16 -0
  80. package/src/OCP1/OcaMediaVolumePositionType.js +4 -0
  81. package/src/OCP1/OcaMultiMap.js +3 -0
  82. package/src/OCP1/OcaNetworkAdvertisingMechanism.js +16 -0
  83. package/src/OCP1/OcaNetworkAdvertisingService.js +4 -0
  84. package/src/OCP1/OcaNetworkInterfaceAssignment.js +23 -0
  85. package/src/OCP1/OcaNetworkInterfaceCommand.js +4 -0
  86. package/src/OCP1/OcaNetworkInterfaceState.js +4 -0
  87. package/src/OCP1/OcaNetworkInterfaceStatus.js +16 -0
  88. package/src/OCP1/OcaObjectSearchResult.js +2 -18
  89. package/src/OCP1/OcaObjectSearchResultFlags.js +5 -3
  90. package/src/OCP1/OcaPort.js +1 -1
  91. package/src/OCP1/OcaPortClockMapEntry.js +16 -0
  92. package/src/OCP1/OcaPortID.js +2 -2
  93. package/src/OCP1/OcaPortIdentification.js +16 -0
  94. package/src/OCP1/OcaPortMode.js +5 -4
  95. package/src/OCP1/OcaPositionDescriptor.js +2 -2
  96. package/src/OCP1/OcaProduct.js +19 -0
  97. package/src/OCP1/OcaProgramResult.js +17 -0
  98. package/src/OCP1/OcaProgramRunMode.js +3 -0
  99. package/src/OCP1/OcaProtoPort.js +2 -2
  100. package/src/OCP1/OcaProtoPortClockMapEntry.js +17 -0
  101. package/src/OCP1/OcaProtoSignalPath.js +2 -2
  102. package/src/OCP1/OcaSamplingRateConverterType.js +4 -0
  103. package/src/OCP1/OcaSecurityType.js +4 -0
  104. package/src/OCP1/OcaSignalPath.js +2 -2
  105. package/src/OCP1/OcaString.js +3 -0
  106. package/src/OCP1/OcaTask.js +4 -3
  107. package/src/OCP1/OcaTaskExecutionTerminatedEventData.js +20 -0
  108. package/src/OCP1/OcaTaskGenericState.js +4 -0
  109. package/src/OCP1/OcaTaskOperationalState.js +17 -0
  110. package/src/OCP1/OcaTaskSchedulerState.js +4 -0
  111. package/src/OCP1/OcaTaskStatusChangedEventData.js +18 -0
  112. package/src/OCP1/OcaTime.js +18 -0
  113. package/src/OCP1/OcaTimeDeliveryMechanism.js +4 -0
  114. package/src/OCP1/OcaTimeDeliveryParameters_StreamEndpoint.js +15 -0
  115. package/src/OCP1/OcaTimePTP.js +2 -15
  116. package/src/OCP1/OcaTypedBlob.js +16 -0
  117. package/src/OCP1/OcaUint16.js +3 -0
  118. package/src/OCP1/OcaUint32.js +3 -0
  119. package/src/OCP1/OcaUint64.js +3 -0
  120. package/src/OCP1/OcaUint8.js +3 -0
  121. package/src/OCP1/OcaVariant.js +92 -0
  122. package/src/OCP1/OcaWhenPhysicalAbsolute.js +16 -0
  123. package/src/OCP1/OcaWhenPhysicalRelative.js +16 -0
  124. package/src/OCP1/RestWithOffset.js +3 -0
  125. package/src/OCP1/String16.js +3 -0
  126. package/src/OCP1/Struct.js +12 -0
  127. package/src/OCP1/Tuple.js +3 -0
  128. package/src/OCP1/createBlobType.js +58 -0
  129. package/src/OCP1/createListType.js +137 -0
  130. package/src/OCP1/createType.js +8 -4
  131. package/src/OCP1/decode_message.js +10 -2
  132. package/src/OCP1/encode_message.js +5 -1
  133. package/src/OCP1/getLengthEncoder.js +23 -0
  134. package/src/OCP1/notification2.js +70 -0
  135. package/src/OCP1/protocol_version.js +4 -0
  136. package/src/connection.js +14 -6
  137. package/src/controller/ControlClasses/OcaActuator.d.ts +3 -3
  138. package/src/controller/ControlClasses/OcaActuator.js +4 -4
  139. package/src/controller/ControlClasses/OcaAgent.d.ts +6 -14
  140. package/src/controller/ControlClasses/OcaAgent.js +8 -18
  141. package/src/controller/ControlClasses/OcaApplicationNetwork.d.ts +9 -17
  142. package/src/controller/ControlClasses/OcaApplicationNetwork.js +11 -32
  143. package/src/controller/ControlClasses/OcaAudioLevelSensor.d.ts +4 -7
  144. package/src/controller/ControlClasses/OcaAudioLevelSensor.js +5 -8
  145. package/src/controller/ControlClasses/OcaAudioProcessingManager.d.ts +1 -1
  146. package/src/controller/ControlClasses/OcaAudioProcessingManager.js +2 -2
  147. package/src/controller/ControlClasses/OcaBasicActuator.d.ts +1 -1
  148. package/src/controller/ControlClasses/OcaBasicActuator.js +2 -2
  149. package/src/controller/ControlClasses/OcaBasicSensor.d.ts +1 -1
  150. package/src/controller/ControlClasses/OcaBasicSensor.js +2 -2
  151. package/src/controller/ControlClasses/OcaBitstringActuator.d.ts +34 -13
  152. package/src/controller/ControlClasses/OcaBitstringActuator.js +35 -18
  153. package/src/controller/ControlClasses/OcaBitstringSensor.d.ts +19 -7
  154. package/src/controller/ControlClasses/OcaBitstringSensor.js +22 -12
  155. package/src/controller/ControlClasses/OcaBlock.d.ts +455 -89
  156. package/src/controller/ControlClasses/OcaBlock.js +477 -103
  157. package/src/controller/ControlClasses/OcaBlockFactoryAgent.d.ts +299 -0
  158. package/src/controller/ControlClasses/OcaBlockFactoryAgent.js +360 -0
  159. package/src/controller/ControlClasses/OcaBooleanActuator.d.ts +2 -4
  160. package/src/controller/ControlClasses/OcaBooleanActuator.js +3 -5
  161. package/src/controller/ControlClasses/OcaBooleanSensor.d.ts +2 -3
  162. package/src/controller/ControlClasses/OcaBooleanSensor.js +3 -4
  163. package/src/controller/ControlClasses/OcaCodingManager.js +1 -1
  164. package/src/controller/ControlClasses/OcaCommandSet.d.ts +89 -0
  165. package/src/controller/ControlClasses/OcaCommandSet.js +94 -0
  166. package/src/controller/ControlClasses/OcaCommandSetAgent.d.ts +31 -0
  167. package/src/controller/ControlClasses/OcaCommandSetAgent.js +38 -0
  168. package/src/controller/ControlClasses/OcaCounterNotifier.d.ts +89 -0
  169. package/src/controller/ControlClasses/OcaCounterNotifier.js +101 -0
  170. package/src/controller/ControlClasses/OcaCurrentSensor.d.ts +2 -3
  171. package/src/controller/ControlClasses/OcaCurrentSensor.js +3 -4
  172. package/src/controller/ControlClasses/OcaDataset.d.ts +223 -0
  173. package/src/controller/ControlClasses/OcaDataset.js +234 -0
  174. package/src/controller/ControlClasses/OcaDatasetWorker.d.ts +31 -0
  175. package/src/controller/ControlClasses/OcaDatasetWorker.js +40 -0
  176. package/src/controller/ControlClasses/OcaDelay.d.ts +2 -4
  177. package/src/controller/ControlClasses/OcaDelay.js +3 -5
  178. package/src/controller/ControlClasses/OcaDelayExtended.d.ts +5 -7
  179. package/src/controller/ControlClasses/OcaDelayExtended.js +6 -8
  180. package/src/controller/ControlClasses/OcaDeviceManager.d.ts +123 -62
  181. package/src/controller/ControlClasses/OcaDeviceManager.js +161 -83
  182. package/src/controller/ControlClasses/OcaDeviceTimeManager.d.ts +43 -25
  183. package/src/controller/ControlClasses/OcaDeviceTimeManager.js +43 -28
  184. package/src/controller/ControlClasses/OcaDiagnosticManager.d.ts +1 -13
  185. package/src/controller/ControlClasses/OcaDiagnosticManager.js +3 -16
  186. package/src/controller/ControlClasses/OcaDynamics.d.ts +38 -63
  187. package/src/controller/ControlClasses/OcaDynamics.js +48 -71
  188. package/src/controller/ControlClasses/OcaDynamicsCurve.d.ts +169 -82
  189. package/src/controller/ControlClasses/OcaDynamicsCurve.js +189 -93
  190. package/src/controller/ControlClasses/OcaDynamicsDetector.d.ts +8 -16
  191. package/src/controller/ControlClasses/OcaDynamicsDetector.js +9 -17
  192. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.d.ts +5 -7
  193. package/src/controller/ControlClasses/OcaFilterArbitraryCurve.js +10 -12
  194. package/src/controller/ControlClasses/OcaFilterClassical.d.ts +15 -26
  195. package/src/controller/ControlClasses/OcaFilterClassical.js +15 -27
  196. package/src/controller/ControlClasses/OcaFilterFIR.d.ts +6 -11
  197. package/src/controller/ControlClasses/OcaFilterFIR.js +12 -18
  198. package/src/controller/ControlClasses/OcaFilterParametric.d.ts +55 -26
  199. package/src/controller/ControlClasses/OcaFilterParametric.js +63 -32
  200. package/src/controller/ControlClasses/OcaFilterPolynomial.d.ts +5 -4
  201. package/src/controller/ControlClasses/OcaFilterPolynomial.js +8 -7
  202. package/src/controller/ControlClasses/OcaFirmwareManager.d.ts +6 -11
  203. package/src/controller/ControlClasses/OcaFirmwareManager.js +5 -11
  204. package/src/controller/ControlClasses/OcaFloat32Actuator.d.ts +3 -5
  205. package/src/controller/ControlClasses/OcaFloat32Actuator.js +4 -6
  206. package/src/controller/ControlClasses/OcaFloat32Sensor.d.ts +2 -3
  207. package/src/controller/ControlClasses/OcaFloat32Sensor.js +3 -4
  208. package/src/controller/ControlClasses/OcaFloat64Actuator.d.ts +3 -5
  209. package/src/controller/ControlClasses/OcaFloat64Actuator.js +4 -6
  210. package/src/controller/ControlClasses/OcaFloat64Sensor.d.ts +2 -3
  211. package/src/controller/ControlClasses/OcaFloat64Sensor.js +3 -4
  212. package/src/controller/ControlClasses/OcaFrequencyActuator.d.ts +2 -4
  213. package/src/controller/ControlClasses/OcaFrequencyActuator.js +3 -5
  214. package/src/controller/ControlClasses/OcaFrequencySensor.d.ts +1 -2
  215. package/src/controller/ControlClasses/OcaFrequencySensor.js +2 -3
  216. package/src/controller/ControlClasses/OcaGain.d.ts +2 -4
  217. package/src/controller/ControlClasses/OcaGain.js +3 -5
  218. package/src/controller/ControlClasses/OcaGainSensor.d.ts +2 -3
  219. package/src/controller/ControlClasses/OcaGainSensor.js +3 -4
  220. package/src/controller/ControlClasses/OcaGroup.d.ts +140 -0
  221. package/src/controller/ControlClasses/OcaGroup.js +156 -0
  222. package/src/controller/ControlClasses/OcaGrouper.d.ts +20 -140
  223. package/src/controller/ControlClasses/OcaGrouper.js +34 -171
  224. package/src/controller/ControlClasses/OcaIdentificationActuator.d.ts +5 -7
  225. package/src/controller/ControlClasses/OcaIdentificationActuator.js +7 -9
  226. package/src/controller/ControlClasses/OcaIdentificationSensor.d.ts +5 -6
  227. package/src/controller/ControlClasses/OcaIdentificationSensor.js +6 -7
  228. package/src/controller/ControlClasses/OcaImpedanceSensor.d.ts +2 -3
  229. package/src/controller/ControlClasses/OcaImpedanceSensor.js +3 -4
  230. package/src/controller/ControlClasses/OcaInt16Actuator.d.ts +3 -5
  231. package/src/controller/ControlClasses/OcaInt16Actuator.js +4 -6
  232. package/src/controller/ControlClasses/OcaInt16Sensor.d.ts +2 -3
  233. package/src/controller/ControlClasses/OcaInt16Sensor.js +3 -4
  234. package/src/controller/ControlClasses/OcaInt32Actuator.d.ts +3 -5
  235. package/src/controller/ControlClasses/OcaInt32Actuator.js +4 -6
  236. package/src/controller/ControlClasses/OcaInt32Sensor.d.ts +2 -3
  237. package/src/controller/ControlClasses/OcaInt32Sensor.js +3 -4
  238. package/src/controller/ControlClasses/OcaInt64Actuator.d.ts +3 -5
  239. package/src/controller/ControlClasses/OcaInt64Actuator.js +4 -6
  240. package/src/controller/ControlClasses/OcaInt64Sensor.d.ts +2 -3
  241. package/src/controller/ControlClasses/OcaInt64Sensor.js +3 -4
  242. package/src/controller/ControlClasses/OcaInt8Actuator.d.ts +3 -5
  243. package/src/controller/ControlClasses/OcaInt8Actuator.js +4 -6
  244. package/src/controller/ControlClasses/OcaInt8Sensor.d.ts +2 -3
  245. package/src/controller/ControlClasses/OcaInt8Sensor.js +3 -4
  246. package/src/controller/ControlClasses/OcaJsonActuator.d.ts +46 -0
  247. package/src/controller/ControlClasses/OcaJsonActuator.js +58 -0
  248. package/src/controller/ControlClasses/OcaJsonSensor.d.ts +51 -0
  249. package/src/controller/ControlClasses/OcaJsonSensor.js +65 -0
  250. package/src/controller/ControlClasses/OcaLevelSensor.d.ts +1 -2
  251. package/src/controller/ControlClasses/OcaLevelSensor.js +2 -3
  252. package/src/controller/ControlClasses/OcaLibraryManager.d.ts +1 -1
  253. package/src/controller/ControlClasses/OcaLibraryManager.js +3 -3
  254. package/src/controller/ControlClasses/OcaLockManager.d.ts +44 -0
  255. package/src/controller/ControlClasses/OcaLockManager.js +53 -0
  256. package/src/controller/ControlClasses/OcaLog.d.ts +128 -0
  257. package/src/controller/ControlClasses/OcaLog.js +142 -0
  258. package/src/controller/ControlClasses/OcaManager.js +1 -1
  259. package/src/controller/ControlClasses/OcaMatrix.d.ts +104 -82
  260. package/src/controller/ControlClasses/OcaMatrix.js +121 -93
  261. package/src/controller/ControlClasses/OcaMediaClock.d.ts +27 -0
  262. package/src/controller/ControlClasses/OcaMediaClock.js +28 -4
  263. package/src/controller/ControlClasses/OcaMediaClock3.d.ts +16 -22
  264. package/src/controller/ControlClasses/OcaMediaClock3.js +22 -29
  265. package/src/controller/ControlClasses/OcaMediaClockManager.d.ts +7 -10
  266. package/src/controller/ControlClasses/OcaMediaClockManager.js +9 -13
  267. package/src/controller/ControlClasses/OcaMediaRecorderPlayer.d.ts +235 -0
  268. package/src/controller/ControlClasses/OcaMediaRecorderPlayer.js +261 -0
  269. package/src/controller/ControlClasses/OcaMediaTransportApplication.d.ts +612 -0
  270. package/src/controller/ControlClasses/OcaMediaTransportApplication.js +704 -0
  271. package/src/controller/ControlClasses/OcaMediaTransportNetwork.d.ts +12 -25
  272. package/src/controller/ControlClasses/OcaMediaTransportNetwork.js +12 -35
  273. package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.d.ts +235 -0
  274. package/src/controller/ControlClasses/OcaMediaTransportSessionAgent.js +249 -0
  275. package/src/controller/ControlClasses/OcaMute.d.ts +2 -4
  276. package/src/controller/ControlClasses/OcaMute.js +3 -5
  277. package/src/controller/ControlClasses/OcaNetwork.js +1 -1
  278. package/src/controller/ControlClasses/OcaNetworkApplication.d.ts +179 -0
  279. package/src/controller/ControlClasses/OcaNetworkApplication.js +202 -0
  280. package/src/controller/ControlClasses/OcaNetworkInterface.d.ts +318 -0
  281. package/src/controller/ControlClasses/OcaNetworkInterface.js +353 -0
  282. package/src/controller/ControlClasses/OcaNetworkManager.d.ts +45 -17
  283. package/src/controller/ControlClasses/OcaNetworkManager.js +59 -22
  284. package/src/controller/ControlClasses/OcaNetworkSignalChannel.js +1 -1
  285. package/src/controller/ControlClasses/OcaNumericObserver.d.ts +24 -40
  286. package/src/controller/ControlClasses/OcaNumericObserver.js +25 -40
  287. package/src/controller/ControlClasses/OcaNumericObserverList.d.ts +20 -33
  288. package/src/controller/ControlClasses/OcaNumericObserverList.js +26 -39
  289. package/src/controller/ControlClasses/OcaPanBalance.d.ts +4 -8
  290. package/src/controller/ControlClasses/OcaPanBalance.js +5 -9
  291. package/src/controller/ControlClasses/OcaPhysicalPosition.d.ts +3 -6
  292. package/src/controller/ControlClasses/OcaPhysicalPosition.js +4 -7
  293. package/src/controller/ControlClasses/OcaPolarity.d.ts +2 -4
  294. package/src/controller/ControlClasses/OcaPolarity.js +3 -5
  295. package/src/controller/ControlClasses/OcaPowerManager.d.ts +30 -14
  296. package/src/controller/ControlClasses/OcaPowerManager.js +32 -17
  297. package/src/controller/ControlClasses/OcaPowerSensor.d.ts +38 -0
  298. package/src/controller/ControlClasses/OcaPowerSensor.js +51 -0
  299. package/src/controller/ControlClasses/OcaPowerSupply.d.ts +8 -16
  300. package/src/controller/ControlClasses/OcaPowerSupply.js +13 -21
  301. package/src/controller/ControlClasses/OcaProgram.d.ts +63 -0
  302. package/src/controller/ControlClasses/OcaProgram.js +82 -0
  303. package/src/controller/ControlClasses/OcaRamper.d.ts +46 -10
  304. package/src/controller/ControlClasses/OcaRamper.js +65 -12
  305. package/src/controller/ControlClasses/OcaRoot.d.ts +69 -24
  306. package/src/controller/ControlClasses/OcaRoot.js +67 -26
  307. package/src/controller/ControlClasses/OcaSamplingRateConverter.d.ts +22 -0
  308. package/src/controller/ControlClasses/OcaSamplingRateConverter.js +28 -0
  309. package/src/controller/ControlClasses/OcaSecurityManager.d.ts +12 -13
  310. package/src/controller/ControlClasses/OcaSecurityManager.js +10 -12
  311. package/src/controller/ControlClasses/OcaSensor.d.ts +1 -2
  312. package/src/controller/ControlClasses/OcaSensor.js +2 -3
  313. package/src/controller/ControlClasses/OcaSignalGenerator.d.ts +21 -39
  314. package/src/controller/ControlClasses/OcaSignalGenerator.js +22 -40
  315. package/src/controller/ControlClasses/OcaSignalInput.d.ts +4 -4
  316. package/src/controller/ControlClasses/OcaSignalInput.js +5 -5
  317. package/src/controller/ControlClasses/OcaSignalOutput.d.ts +4 -4
  318. package/src/controller/ControlClasses/OcaSignalOutput.js +5 -5
  319. package/src/controller/ControlClasses/OcaStateSensor.d.ts +58 -0
  320. package/src/controller/ControlClasses/OcaStateSensor.js +75 -0
  321. package/src/controller/ControlClasses/OcaStreamConnector.js +1 -1
  322. package/src/controller/ControlClasses/OcaStreamNetwork.js +1 -1
  323. package/src/controller/ControlClasses/OcaStringActuator.d.ts +7 -8
  324. package/src/controller/ControlClasses/OcaStringActuator.js +7 -8
  325. package/src/controller/ControlClasses/OcaStringSensor.d.ts +20 -9
  326. package/src/controller/ControlClasses/OcaStringSensor.js +23 -13
  327. package/src/controller/ControlClasses/OcaSubscriptionManager.d.ts +211 -41
  328. package/src/controller/ControlClasses/OcaSubscriptionManager.js +224 -39
  329. package/src/controller/ControlClasses/OcaSummingPoint.d.ts +3 -2
  330. package/src/controller/ControlClasses/OcaSummingPoint.js +4 -3
  331. package/src/controller/ControlClasses/OcaSwitch.d.ts +70 -25
  332. package/src/controller/ControlClasses/OcaSwitch.js +113 -35
  333. package/src/controller/ControlClasses/OcaTaskAgent.d.ts +192 -0
  334. package/src/controller/ControlClasses/OcaTaskAgent.js +212 -0
  335. package/src/controller/ControlClasses/OcaTaskManager.d.ts +4 -6
  336. package/src/controller/ControlClasses/OcaTaskManager.js +7 -9
  337. package/src/controller/ControlClasses/OcaTaskScheduler.d.ts +150 -0
  338. package/src/controller/ControlClasses/OcaTaskScheduler.js +159 -0
  339. package/src/controller/ControlClasses/OcaTemperatureActuator.d.ts +3 -5
  340. package/src/controller/ControlClasses/OcaTemperatureActuator.js +4 -6
  341. package/src/controller/ControlClasses/OcaTemperatureSensor.d.ts +2 -3
  342. package/src/controller/ControlClasses/OcaTemperatureSensor.js +3 -4
  343. package/src/controller/ControlClasses/OcaTimeIntervalSensor.d.ts +1 -2
  344. package/src/controller/ControlClasses/OcaTimeIntervalSensor.js +2 -3
  345. package/src/controller/ControlClasses/OcaTimeSource.d.ts +108 -37
  346. package/src/controller/ControlClasses/OcaTimeSource.js +148 -48
  347. package/src/controller/ControlClasses/OcaUint16Actuator.d.ts +3 -5
  348. package/src/controller/ControlClasses/OcaUint16Actuator.js +4 -6
  349. package/src/controller/ControlClasses/OcaUint16Sensor.d.ts +2 -3
  350. package/src/controller/ControlClasses/OcaUint16Sensor.js +3 -4
  351. package/src/controller/ControlClasses/OcaUint32Actuator.d.ts +3 -5
  352. package/src/controller/ControlClasses/OcaUint32Actuator.js +4 -6
  353. package/src/controller/ControlClasses/OcaUint32Sensor.d.ts +2 -3
  354. package/src/controller/ControlClasses/OcaUint32Sensor.js +3 -4
  355. package/src/controller/ControlClasses/OcaUint64Actuator.d.ts +3 -5
  356. package/src/controller/ControlClasses/OcaUint64Actuator.js +4 -6
  357. package/src/controller/ControlClasses/OcaUint64Sensor.d.ts +2 -3
  358. package/src/controller/ControlClasses/OcaUint64Sensor.js +3 -4
  359. package/src/controller/ControlClasses/OcaUint8Actuator.d.ts +3 -5
  360. package/src/controller/ControlClasses/OcaUint8Actuator.js +4 -6
  361. package/src/controller/ControlClasses/OcaUint8Sensor.d.ts +2 -3
  362. package/src/controller/ControlClasses/OcaUint8Sensor.js +3 -4
  363. package/src/controller/ControlClasses/OcaVoltageSensor.d.ts +2 -3
  364. package/src/controller/ControlClasses/OcaVoltageSensor.js +3 -4
  365. package/src/controller/ControlClasses/OcaWorker.d.ts +84 -37
  366. package/src/controller/ControlClasses/OcaWorker.js +93 -43
  367. package/src/controller/base_event.js +71 -23
  368. package/src/controller/client_connection.d.ts +26 -0
  369. package/src/controller/client_connection.js +39 -7
  370. package/src/controller/event.js +17 -20
  371. package/src/controller/make_control_class.js +3 -1
  372. package/src/controller/notification_error.d.ts +40 -0
  373. package/src/controller/notification_error.js +62 -0
  374. package/src/controller/observeProperty.js +8 -8
  375. package/src/controller/property_event.js +18 -10
  376. package/src/controller/remote_device.js +137 -49
  377. package/src/controller/tcp_connection.d.ts +8 -6
  378. package/src/index.default.d.ts +1 -0
  379. package/src/index.default.js +1 -0
  380. package/src/types/Enum.js +8 -0
  381. package/src/types/OcaActionObjectSearchResult.d.ts +73 -0
  382. package/src/types/OcaActionObjectSearchResult.js +34 -0
  383. package/src/types/OcaActionObjectSearchResultFlags.d.ts +37 -0
  384. package/src/types/OcaActionObjectSearchResultFlags.js +52 -0
  385. package/src/types/OcaApplicationNetworkCommand.d.ts +1 -19
  386. package/src/types/OcaApplicationNetworkCommand.js +0 -24
  387. package/src/types/OcaApplicationNetworkState.d.ts +1 -37
  388. package/src/types/OcaApplicationNetworkState.js +0 -48
  389. package/src/types/OcaBlockConfigurability.d.ts +26 -0
  390. package/src/types/OcaBlockConfigurability.js +35 -0
  391. package/src/types/OcaClassicalFilterShape.d.ts +1 -1
  392. package/src/types/OcaClassicalFilterShape.js +1 -1
  393. package/src/types/OcaCommand.d.ts +44 -0
  394. package/src/types/OcaCommand.js +25 -0
  395. package/src/types/OcaCommandResult.d.ts +42 -0
  396. package/src/types/OcaCommandResult.js +24 -0
  397. package/src/types/OcaCommandSetResult.d.ts +41 -0
  398. package/src/types/OcaCommandSetResult.js +23 -0
  399. package/src/types/OcaConstructionParameter.d.ts +40 -0
  400. package/src/types/OcaConstructionParameter.js +23 -0
  401. package/src/types/OcaCounter.d.ts +81 -0
  402. package/src/types/OcaCounter.js +38 -0
  403. package/src/types/OcaCounterNotifierFilterParameters.d.ts +81 -0
  404. package/src/types/OcaCounterNotifierFilterParameters.js +37 -0
  405. package/src/types/OcaCounterSet.d.ts +38 -0
  406. package/src/types/OcaCounterSet.js +22 -0
  407. package/src/types/OcaCounterUpdate.d.ts +54 -0
  408. package/src/types/OcaCounterUpdate.js +28 -0
  409. package/src/types/OcaCounterUpdateEventData.d.ts +27 -0
  410. package/src/types/OcaCounterUpdateEventData.js +17 -0
  411. package/src/types/OcaDatasetSearchResult.d.ts +51 -0
  412. package/src/types/OcaDatasetSearchResult.js +28 -0
  413. package/src/types/OcaDelayUnit.d.ts +2 -1
  414. package/src/types/OcaDelayUnit.js +2 -1
  415. package/src/types/OcaDelayValue.d.ts +2 -1
  416. package/src/types/OcaDelayValue.js +2 -1
  417. package/src/types/OcaDeviceGenericState.d.ts +62 -0
  418. package/src/types/OcaDeviceGenericState.js +52 -0
  419. package/src/types/OcaDeviceOperationalState.d.ts +42 -0
  420. package/src/types/OcaDeviceOperationalState.js +22 -0
  421. package/src/types/OcaDeviceState.d.ts +2 -2
  422. package/src/types/OcaDeviceState.js +2 -2
  423. package/src/types/OcaExecutableType.d.ts +50 -0
  424. package/src/types/OcaExecutableType.js +36 -0
  425. package/src/types/OcaGenericEndState.d.ts +56 -0
  426. package/src/types/OcaGenericEndState.js +44 -0
  427. package/src/types/OcaGlobalTypeIdentifier.d.ts +12 -12
  428. package/src/types/OcaGlobalTypeIdentifier.js +8 -7
  429. package/src/types/OcaGroupException.d.ts +53 -0
  430. package/src/types/OcaGroupException.js +28 -0
  431. package/src/types/OcaGrouperCitizen.d.ts +10 -10
  432. package/src/types/OcaGrouperCitizen.js +6 -6
  433. package/src/types/OcaGrouperEnrollment.d.ts +4 -9
  434. package/src/types/OcaGrouperEnrollment.js +3 -5
  435. package/src/types/OcaGrouperGroup.d.ts +9 -9
  436. package/src/types/OcaGrouperGroup.js +5 -5
  437. package/src/types/OcaGrouperMode.d.ts +4 -3
  438. package/src/types/OcaGrouperMode.js +4 -3
  439. package/src/types/OcaGrouperStatusChangeEventData.d.ts +2 -2
  440. package/src/types/OcaGrouperStatusChangeEventData.js +2 -2
  441. package/src/types/OcaGrouperStatusChangeType.d.ts +1 -1
  442. package/src/types/OcaGrouperStatusChangeType.js +1 -1
  443. package/src/types/OcaIODirection.d.ts +39 -0
  444. package/src/types/OcaIODirection.js +28 -0
  445. package/src/types/OcaIP4AutoconfigMode.d.ts +56 -0
  446. package/src/types/OcaIP4AutoconfigMode.js +44 -0
  447. package/src/types/OcaIP4Gateway.d.ts +53 -0
  448. package/src/types/OcaIP4Gateway.js +27 -0
  449. package/src/types/OcaIP4NetworkSettings.d.ts +111 -0
  450. package/src/types/OcaIP4NetworkSettings.js +56 -0
  451. package/src/types/OcaIP6AutoconfigMode.d.ts +56 -0
  452. package/src/types/OcaIP6AutoconfigMode.js +44 -0
  453. package/src/types/OcaIP6Gateway.d.ts +53 -0
  454. package/src/types/OcaIP6Gateway.js +27 -0
  455. package/src/types/OcaIP6NetworkSettings.d.ts +123 -0
  456. package/src/types/OcaIP6NetworkSettings.js +61 -0
  457. package/src/types/OcaInterval.d.ts +8 -0
  458. package/src/types/OcaInterval.js +84 -0
  459. package/src/types/OcaIntervalBounds.d.ts +41 -0
  460. package/src/types/OcaIntervalBounds.js +53 -0
  461. package/src/types/OcaJobDisposedEventData.d.ts +57 -0
  462. package/src/types/OcaJobDisposedEventData.js +28 -0
  463. package/src/types/OcaJobDisposition.d.ts +68 -0
  464. package/src/types/OcaJobDisposition.js +60 -0
  465. package/src/types/OcaJobQueueItem.d.ts +105 -0
  466. package/src/types/OcaJobQueueItem.js +44 -0
  467. package/src/types/OcaLibVolType.d.ts +2 -4
  468. package/src/types/OcaLibVolType.js +1 -2
  469. package/src/types/OcaLockState.d.ts +50 -0
  470. package/src/types/OcaLockState.js +36 -0
  471. package/src/types/OcaLogFilter.d.ts +70 -0
  472. package/src/types/OcaLogFilter.js +33 -0
  473. package/src/types/OcaLogRecord.d.ts +85 -0
  474. package/src/types/OcaLogRecord.js +40 -0
  475. package/src/types/OcaManagerDefaultObjectNumbers.d.ts +7 -0
  476. package/src/types/OcaManagerDefaultObjectNumbers.js +7 -0
  477. package/src/types/OcaManagerDescriptor.d.ts +11 -9
  478. package/src/types/OcaManagerDescriptor.js +6 -5
  479. package/src/types/OcaManufacturer.d.ts +87 -0
  480. package/src/types/OcaManufacturer.js +47 -0
  481. package/src/types/OcaMatrixCommand.d.ts +61 -0
  482. package/src/types/OcaMatrixCommand.js +29 -0
  483. package/src/types/OcaMatrixCoordinates.d.ts +38 -0
  484. package/src/types/OcaMatrixCoordinates.js +23 -0
  485. package/src/types/OcaMediaAccessMode.d.ts +50 -0
  486. package/src/types/OcaMediaAccessMode.js +36 -0
  487. package/src/types/OcaMediaClockAvailability.d.ts +1 -1
  488. package/src/types/OcaMediaClockAvailability.js +1 -1
  489. package/src/types/OcaMediaClockRate.d.ts +7 -7
  490. package/src/types/OcaMediaClockRate.js +4 -4
  491. package/src/types/OcaMediaConnection.d.ts +2 -2
  492. package/src/types/OcaMediaConnection.js +1 -1
  493. package/src/types/OcaMediaFrameFormat.d.ts +74 -0
  494. package/src/types/OcaMediaFrameFormat.js +68 -0
  495. package/src/types/OcaMediaPlayOption.d.ts +50 -0
  496. package/src/types/OcaMediaPlayOption.js +36 -0
  497. package/src/types/OcaMediaRecorderPlayerState.d.ts +62 -0
  498. package/src/types/OcaMediaRecorderPlayerState.js +52 -0
  499. package/src/types/OcaMediaStreamCastMode.d.ts +3 -3
  500. package/src/types/OcaMediaStreamCastMode.js +3 -3
  501. package/src/types/OcaMediaStreamEndpoint.d.ts +238 -0
  502. package/src/types/OcaMediaStreamEndpoint.js +114 -0
  503. package/src/types/OcaMediaStreamEndpointCommand.d.ts +80 -0
  504. package/src/types/OcaMediaStreamEndpointCommand.js +76 -0
  505. package/src/types/OcaMediaStreamEndpointState.d.ts +68 -0
  506. package/src/types/OcaMediaStreamEndpointState.js +60 -0
  507. package/src/types/OcaMediaStreamEndpointStatus.d.ts +44 -0
  508. package/src/types/OcaMediaStreamEndpointStatus.js +23 -0
  509. package/src/types/OcaMediaStreamMode.d.ts +83 -0
  510. package/src/types/OcaMediaStreamMode.js +43 -0
  511. package/src/types/OcaMediaStreamModeCapability.d.ts +167 -0
  512. package/src/types/OcaMediaStreamModeCapability.js +81 -0
  513. package/src/types/OcaMediaStreamModeCapabilityDirection.d.ts +21 -0
  514. package/src/types/OcaMediaStreamModeCapabilityDirection.js +27 -0
  515. package/src/types/OcaMediaTrackFunction.d.ts +27 -0
  516. package/src/types/OcaMediaTrackFunction.js +36 -0
  517. package/src/types/OcaMediaTransportSession.d.ts +119 -0
  518. package/src/types/OcaMediaTransportSession.js +58 -0
  519. package/src/types/OcaMediaTransportSessionConnection.d.ts +63 -0
  520. package/src/types/OcaMediaTransportSessionConnection.js +32 -0
  521. package/src/types/OcaMediaTransportSessionConnectionState.d.ts +47 -0
  522. package/src/types/OcaMediaTransportSessionConnectionState.js +24 -0
  523. package/src/types/OcaMediaTransportSessionState.d.ts +62 -0
  524. package/src/types/OcaMediaTransportSessionState.js +52 -0
  525. package/src/types/OcaMediaTransportSessionStatus.d.ts +43 -0
  526. package/src/types/OcaMediaTransportSessionStatus.js +23 -0
  527. package/src/types/OcaMediaTransportTimingParameters.d.ts +54 -0
  528. package/src/types/OcaMediaTransportTimingParameters.js +31 -0
  529. package/src/types/OcaMediaVolumePosition.d.ts +46 -0
  530. package/src/types/OcaMediaVolumePosition.js +23 -0
  531. package/src/types/OcaMediaVolumePositionType.d.ts +44 -0
  532. package/src/types/OcaMediaVolumePositionType.js +28 -0
  533. package/src/types/OcaModelGUID.d.ts +0 -1
  534. package/src/types/OcaModelGUID.js +0 -1
  535. package/src/types/OcaNetworkAdvertisingMechanism.d.ts +43 -0
  536. package/src/types/OcaNetworkAdvertisingMechanism.js +23 -0
  537. package/src/types/OcaNetworkAdvertisingService.d.ts +56 -0
  538. package/src/types/OcaNetworkAdvertisingService.js +44 -0
  539. package/src/types/OcaNetworkInterfaceAssignment.d.ts +99 -0
  540. package/src/types/OcaNetworkInterfaceAssignment.js +51 -0
  541. package/src/types/OcaNetworkInterfaceCommand.d.ts +50 -0
  542. package/src/types/OcaNetworkInterfaceCommand.js +36 -0
  543. package/src/types/OcaNetworkInterfaceState.d.ts +50 -0
  544. package/src/types/OcaNetworkInterfaceState.js +36 -0
  545. package/src/types/OcaNetworkInterfaceStatus.d.ts +42 -0
  546. package/src/types/OcaNetworkInterfaceStatus.js +22 -0
  547. package/src/types/OcaNotificationDeliveryMode.d.ts +13 -1
  548. package/src/types/OcaNotificationDeliveryMode.js +17 -1
  549. package/src/types/OcaOPath.d.ts +16 -2
  550. package/src/types/OcaOPath.js +8 -1
  551. package/src/types/OcaObjectListEventData.d.ts +2 -2
  552. package/src/types/OcaObjectListEventData.js +2 -2
  553. package/src/types/OcaObjectSearchResult.d.ts +4 -83
  554. package/src/types/OcaObjectSearchResult.js +2 -37
  555. package/src/types/OcaObjectSearchResultFlags.d.ts +4 -33
  556. package/src/types/OcaObjectSearchResultFlags.js +2 -48
  557. package/src/types/OcaObservationEventData.d.ts +2 -2
  558. package/src/types/OcaObservationEventData.js +2 -2
  559. package/src/types/OcaObservationListEventData.d.ts +2 -2
  560. package/src/types/OcaObservationListEventData.js +2 -2
  561. package/src/types/OcaObserverState.d.ts +1 -1
  562. package/src/types/OcaObserverState.js +1 -1
  563. package/src/types/OcaParameterMask.d.ts +81 -1
  564. package/src/types/OcaParameterMask.js +131 -1
  565. package/src/types/OcaPort.d.ts +7 -5
  566. package/src/types/OcaPort.js +4 -3
  567. package/src/types/OcaPortClockMapEntry.d.ts +42 -0
  568. package/src/types/OcaPortClockMapEntry.js +23 -0
  569. package/src/types/OcaPortID.d.ts +12 -10
  570. package/src/types/OcaPortID.js +7 -6
  571. package/src/types/OcaPortIdentification.d.ts +39 -0
  572. package/src/types/OcaPortIdentification.js +23 -0
  573. package/src/types/OcaPortMode.d.ts +4 -36
  574. package/src/types/OcaPortMode.js +2 -25
  575. package/src/types/OcaPositionDescriptor.d.ts +6 -6
  576. package/src/types/OcaPositionDescriptor.js +2 -2
  577. package/src/types/OcaPositionDescriptorFieldFlags.d.ts +33 -3
  578. package/src/types/OcaPositionDescriptorFieldFlags.js +53 -3
  579. package/src/types/OcaPowerSupplyState.d.ts +1 -1
  580. package/src/types/OcaPowerSupplyState.js +1 -1
  581. package/src/types/OcaProduct.d.ts +92 -0
  582. package/src/types/OcaProduct.js +42 -0
  583. package/src/types/OcaProgramResult.d.ts +39 -0
  584. package/src/types/OcaProgramResult.js +22 -0
  585. package/src/types/OcaProgramRunMode.d.ts +24 -0
  586. package/src/types/OcaProgramRunMode.js +30 -0
  587. package/src/types/OcaProperty.d.ts +2 -2
  588. package/src/types/OcaProperty.js +2 -2
  589. package/src/types/OcaProtoObjectIdentification.d.ts +1 -1
  590. package/src/types/OcaProtoObjectIdentification.js +1 -1
  591. package/src/types/OcaProtoPort.d.ts +16 -18
  592. package/src/types/OcaProtoPort.js +6 -8
  593. package/src/types/OcaProtoPortClockMapEntry.d.ts +46 -0
  594. package/src/types/OcaProtoPortClockMapEntry.js +25 -0
  595. package/src/types/OcaProtoSignalPath.d.ts +12 -10
  596. package/src/types/OcaProtoSignalPath.js +7 -6
  597. package/src/types/OcaRamperState.d.ts +19 -18
  598. package/src/types/OcaRamperState.js +19 -18
  599. package/src/types/OcaResetCause.d.ts +7 -1
  600. package/src/types/OcaResetCause.js +8 -0
  601. package/src/types/OcaSamplingRateConverterType.d.ts +50 -0
  602. package/src/types/OcaSamplingRateConverterType.js +36 -0
  603. package/src/types/OcaSecurityType.d.ts +39 -0
  604. package/src/types/OcaSecurityType.js +28 -0
  605. package/src/types/OcaSignalPath.d.ts +10 -10
  606. package/src/types/OcaSignalPath.js +6 -6
  607. package/src/types/OcaStatus.d.ts +19 -1
  608. package/src/types/OcaStatus.js +24 -0
  609. package/src/types/OcaStream.d.ts +2 -2
  610. package/src/types/OcaStream.js +1 -1
  611. package/src/types/OcaTask.d.ts +23 -24
  612. package/src/types/OcaTask.js +7 -7
  613. package/src/types/OcaTaskCommand.d.ts +2 -7
  614. package/src/types/OcaTaskCommand.js +2 -9
  615. package/src/types/OcaTaskExecutionTerminatedEventData.d.ts +64 -0
  616. package/src/types/OcaTaskExecutionTerminatedEventData.js +30 -0
  617. package/src/types/OcaTaskGenericState.d.ts +64 -0
  618. package/src/types/OcaTaskGenericState.js +54 -0
  619. package/src/types/OcaTaskManagerState.d.ts +1 -0
  620. package/src/types/OcaTaskManagerState.js +1 -0
  621. package/src/types/OcaTaskOperationalState.d.ts +43 -0
  622. package/src/types/OcaTaskOperationalState.js +22 -0
  623. package/src/types/OcaTaskSchedulerState.d.ts +63 -0
  624. package/src/types/OcaTaskSchedulerState.js +53 -0
  625. package/src/types/OcaTaskStatus.d.ts +2 -12
  626. package/src/types/OcaTaskStatus.js +2 -12
  627. package/src/types/OcaTaskStatusChangedEventData.d.ts +61 -0
  628. package/src/types/OcaTaskStatusChangedEventData.js +29 -0
  629. package/src/types/OcaTime.d.ts +56 -0
  630. package/src/types/OcaTime.js +32 -0
  631. package/src/types/OcaTimeDeliveryMechanism.d.ts +167 -0
  632. package/src/types/OcaTimeDeliveryMechanism.js +191 -0
  633. package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.d.ts +40 -0
  634. package/src/types/OcaTimeDeliveryParameters_StreamEndpoint.js +24 -0
  635. package/src/types/OcaTimePTP.d.ts +4 -51
  636. package/src/types/OcaTimePTP.js +2 -28
  637. package/src/types/OcaTimeReferenceType.d.ts +7 -13
  638. package/src/types/OcaTimeReferenceType.js +6 -14
  639. package/src/types/OcaTimeSourceAvailability.d.ts +1 -1
  640. package/src/types/OcaTimeSourceAvailability.js +1 -1
  641. package/src/types/OcaTimeSourceSyncStatus.d.ts +1 -1
  642. package/src/types/OcaTimeSourceSyncStatus.js +1 -1
  643. package/src/types/OcaTransferFunction.d.ts +1 -1
  644. package/src/types/OcaTransferFunction.js +1 -1
  645. package/src/types/OcaTypedBlob.d.ts +40 -0
  646. package/src/types/OcaTypedBlob.js +24 -0
  647. package/src/types/OcaVariant.d.ts +19 -0
  648. package/src/types/OcaVariant.js +18 -0
  649. package/src/types/OcaWhenPhysicalAbsolute.d.ts +39 -0
  650. package/src/types/OcaWhenPhysicalAbsolute.js +22 -0
  651. package/src/types/OcaWhenPhysicalRelative.d.ts +39 -0
  652. package/src/types/OcaWhenPhysicalRelative.js +22 -0
@@ -1,29 +1,49 @@
1
+ import { OcaActionObjectSearchResult } from '../../OCP1/OcaActionObjectSearchResult.js';
2
+ import { OcaActionObjectSearchResultFlags } from '../../OCP1/OcaActionObjectSearchResultFlags.js';
3
+ import { OcaBlockConfigurability } from '../../OCP1/OcaBlockConfigurability.js';
1
4
  import { OcaBlockMember } from '../../OCP1/OcaBlockMember.js';
5
+ import { OcaConstructionParameter } from '../../OCP1/OcaConstructionParameter.js';
6
+ import { OcaDatasetSearchResult } from '../../OCP1/OcaDatasetSearchResult.js';
2
7
  import { OcaGlobalTypeIdentifier } from '../../OCP1/OcaGlobalTypeIdentifier.js';
3
8
  import { OcaLibVolData_ParamSet } from '../../OCP1/OcaLibVolData_ParamSet.js';
4
9
  import { OcaLibVolIdentifier } from '../../OCP1/OcaLibVolIdentifier.js';
5
10
  import { OcaList } from '../../OCP1/OcaList.js';
11
+ import { OcaLongBlob } from '../../OCP1/OcaLongBlob.js';
6
12
  import { OcaMap } from '../../OCP1/OcaMap.js';
7
13
  import { OcaObjectIdentification } from '../../OCP1/OcaObjectIdentification.js';
8
- import { OcaObjectSearchResult } from '../../OCP1/OcaObjectSearchResult.js';
9
- import { OcaObjectSearchResultFlags } from '../../OCP1/OcaObjectSearchResultFlags.js';
10
14
  import { OcaSignalPath } from '../../OCP1/OcaSignalPath.js';
11
15
  import { OcaString } from '../../OCP1/OcaString.js';
12
16
  import { OcaStringComparisonType } from '../../OCP1/OcaStringComparisonType.js';
13
17
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
14
18
  import { OcaUint32 } from '../../OCP1/OcaUint32.js';
19
+ import { OcaUint64 } from '../../OCP1/OcaUint64.js';
15
20
  import { String16 } from '../../OCP1/String16.js';
16
21
  import { make_control_class } from '../make_control_class.js';
17
22
  import { OcaWorker } from './OcaWorker.js';
18
23
 
19
24
  /**
20
- * A block is an object with three aspects: - It can contain other blocks. - It
21
- * can contain workers. - It can contain agents. - It can contain data networks.
22
- * - It can contain application networks. - It has a signal flow topology. We
23
- * refer to an object inside a block as a **member** of that block. We refer to
24
- * the block which contains an object as the object's **container.1** Normally,
25
- * a block contains a set of members that together function as a processing unit
26
- * -- for example, a crossover channel or mixer strip.
25
+ * Collection object for hierarchical structuring of Control Object populations.
26
+ * The term **Block **means an instance of **OcaBlock**. A Block may contain
27
+ * **Action Objects** and/or **Dataset Objects**, where: An Action Object is
28
+ * defined as one of:
29
+ *
30
+ * - Worker object;
31
+ *
32
+ * - Agent object;
33
+ *
34
+ * - Network Interface object;
35
+ *
36
+ * - Network Application object.
37
+ *
38
+ *
39
+ * A Dataset Object is defined an instance of **OcaDataset** or of a subclass of
40
+ * **OcaDataset**. The term **Block Member** (or just **Member **in context)
41
+ * means an object contained in a Block - either an Action Object or a Dataset
42
+ * Object. The Block that contains an object is termed the object's **Owner**. A
43
+ * Block may define a **Signal Flow** that represents internal signal flows
44
+ * among its Members. Typically, a Block contains a set of Members that together
45
+ * function as a processing unit -- for example, a crossover channel or mixer
46
+ * strip.
27
47
  * @extends OcaWorker
28
48
  * @class OcaBlock
29
49
  */
@@ -31,14 +51,42 @@ export const OcaBlock = make_control_class(
31
51
  'OcaBlock',
32
52
  3,
33
53
  '\u0001\u0001\u0003',
34
- 2,
54
+ 3,
35
55
  OcaWorker,
36
56
  [
37
57
  ['GetType', 3, 1, [], [OcaUint32]],
38
- ['ConstructMemberUsingFactory', 3, 3, [OcaUint32], [OcaUint32]],
58
+ [
59
+ 'ConstructActionObject',
60
+ 3,
61
+ 2,
62
+ [String16, OcaList(OcaConstructionParameter)],
63
+ [OcaUint32],
64
+ ],
65
+ [
66
+ 'ConstructBlockUsingFactory',
67
+ 3,
68
+ 3,
69
+ [OcaUint32],
70
+ [OcaUint32],
71
+ ['ConstructMemberUsingFactory'],
72
+ ],
39
73
  ['DeleteMember', 3, 4, [OcaUint32], []],
40
- ['GetMembers', 3, 5, [], [OcaList(OcaObjectIdentification)]],
41
- ['GetMembersRecursive', 3, 6, [], [OcaList(OcaBlockMember)]],
74
+ [
75
+ 'GetActionObjects',
76
+ 3,
77
+ 5,
78
+ [],
79
+ [OcaList(OcaObjectIdentification)],
80
+ ['GetMembers'],
81
+ ],
82
+ [
83
+ 'GetActionObjectsRecursive',
84
+ 3,
85
+ 6,
86
+ [],
87
+ [OcaList(OcaBlockMember)],
88
+ ['GetMembersRecursive'],
89
+ ],
42
90
  ['AddSignalPath', 3, 7, [OcaSignalPath], [OcaUint16]],
43
91
  ['DeleteSignalPath', 3, 8, [OcaUint16], []],
44
92
  ['GetSignalPaths', 3, 9, [], [OcaMap(OcaUint16, OcaSignalPath)]],
@@ -50,52 +98,101 @@ export const OcaBlock = make_control_class(
50
98
  ['GetGlobalType', 3, 15, [], [OcaGlobalTypeIdentifier]],
51
99
  ['GetONoMap', 3, 16, [], [OcaMap(OcaUint32, OcaUint32)]],
52
100
  [
53
- 'FindObjectsByRole',
101
+ 'FindActionObjectsByRole',
54
102
  3,
55
103
  17,
56
104
  [
57
105
  OcaString,
58
106
  OcaStringComparisonType,
59
107
  String16,
60
- OcaObjectSearchResultFlags,
108
+ OcaActionObjectSearchResultFlags,
61
109
  ],
62
- [OcaList(OcaObjectSearchResult)],
110
+ [OcaList(OcaActionObjectSearchResult)],
111
+ ['FindObjectsByRole'],
63
112
  ],
64
113
  [
65
- 'FindObjectsByRoleRecursive',
114
+ 'FindActionObjectsByRoleRecursive',
66
115
  3,
67
116
  18,
68
117
  [
69
118
  OcaString,
70
119
  OcaStringComparisonType,
71
120
  String16,
72
- OcaObjectSearchResultFlags,
121
+ OcaActionObjectSearchResultFlags,
73
122
  ],
74
- [OcaList(OcaObjectSearchResult)],
123
+ [OcaList(OcaActionObjectSearchResult)],
124
+ ['FindObjectsByRoleRecursive'],
75
125
  ],
76
126
  [
77
- 'FindObjectsByLabelRecursive',
127
+ 'FindActionObjectsByLabelRecursive',
78
128
  3,
79
129
  19,
80
130
  [
81
131
  OcaString,
82
132
  OcaStringComparisonType,
83
133
  String16,
84
- OcaObjectSearchResultFlags,
134
+ OcaActionObjectSearchResultFlags,
85
135
  ],
86
- [OcaList(OcaObjectSearchResult)],
136
+ [OcaList(OcaActionObjectSearchResult)],
137
+ ['FindObjectsByLabelRecursive'],
87
138
  ],
88
139
  [
89
- 'FindObjectsByPath',
140
+ 'FindActionObjectsByRolePath',
90
141
  3,
91
142
  20,
92
- [OcaList(OcaString), OcaObjectSearchResultFlags],
93
- [OcaList(OcaObjectSearchResult)],
143
+ [OcaList(OcaString), OcaActionObjectSearchResultFlags],
144
+ [OcaList(OcaActionObjectSearchResult)],
145
+ ['FindObjectsByPath'],
94
146
  ],
147
+ ['GetConfigurability', 3, 21, [], [OcaBlockConfigurability]],
148
+ ['GetMostRecentParamDatasetONo', 3, 22, [], [OcaUint32]],
149
+ ['ApplyParamDataset', 3, 23, [OcaUint32], []],
150
+ ['StoreCurrentParameterData', 3, 24, [OcaUint32], []],
151
+ ['FetchCurrentParameterData', 3, 25, [], [OcaLongBlob]],
152
+ ['ApplyParameterData', 3, 26, [], [OcaLongBlob]],
153
+ [
154
+ 'ConstructDataset',
155
+ 3,
156
+ 27,
157
+ [String16, OcaString, OcaString, OcaUint64, OcaLongBlob],
158
+ [OcaUint32],
159
+ ],
160
+ [
161
+ 'DuplicateDataset',
162
+ 3,
163
+ 28,
164
+ [OcaUint32, OcaUint32, OcaString, OcaUint64],
165
+ [OcaUint32],
166
+ ],
167
+ ['GetDatasetObjects', 3, 29, [], [OcaList(OcaObjectIdentification)]],
168
+ ['GetDatasetObjectsRecursive', 3, 30, [], [OcaList(OcaBlockMember)]],
169
+ [
170
+ 'FindDatasets',
171
+ 3,
172
+ 31,
173
+ [OcaString, OcaStringComparisonType, OcaString, OcaStringComparisonType],
174
+ [OcaList(OcaDatasetSearchResult)],
175
+ ],
176
+ [
177
+ 'FindDatasetsRecursive',
178
+ 3,
179
+ 32,
180
+ [OcaString, OcaStringComparisonType, OcaString, OcaStringComparisonType],
181
+ [OcaList(OcaDatasetSearchResult)],
182
+ ],
183
+ ['GetBlockFactoryONo', 3, 33, [], [OcaUint32]],
95
184
  ],
96
185
  [
97
186
  ['Type', [OcaUint32], 3, 1, true, false, null],
98
- ['Members', [OcaList(OcaObjectIdentification)], 3, 2, false, false, null],
187
+ [
188
+ 'ActionObjects',
189
+ [OcaList(OcaObjectIdentification)],
190
+ 3,
191
+ 2,
192
+ false,
193
+ false,
194
+ ['Members'],
195
+ ],
99
196
  [
100
197
  'SignalPaths',
101
198
  [OcaMap(OcaUint16, OcaSignalPath)],
@@ -105,35 +202,61 @@ export const OcaBlock = make_control_class(
105
202
  false,
106
203
  null,
107
204
  ],
205
+ ['MostRecentParamSetIdentifier', [OcaUint32], 3, 4, false, false, null],
206
+ ['GlobalType', [OcaGlobalTypeIdentifier], 3, 5, true, false, null],
207
+ ['ONoMap', [OcaMap(OcaUint32, OcaUint32)], 3, 6, true, false, null],
108
208
  [
109
- 'MostRecentParamSetIdentifier',
110
- [OcaLibVolIdentifier],
209
+ 'DatasetObjects',
210
+ [OcaList(OcaObjectIdentification)],
111
211
  3,
112
- 4,
212
+ 7,
113
213
  false,
114
214
  false,
115
215
  null,
116
216
  ],
117
- ['GlobalType', [OcaGlobalTypeIdentifier], 3, 5, true, false, null],
118
- ['ONoMap', [OcaMap(OcaUint32, OcaUint32)], 3, 6, true, false, null],
217
+ ['Configurability', [OcaBlockConfigurability], 3, 8, true, false, null],
218
+ ['MostRecentParamDatasetONo', [OcaUint32], 3, 9, false, false, null],
219
+ ['BlockFactoryONo', [OcaUint32], 3, 10, true, false, null],
119
220
  ],
120
221
  []
121
222
  );
122
223
 
123
224
  /**
124
- * Gets the block type. For statically-defined blocks, the block type is a
125
- * Uint32 with a value corresponding to the unique configuration of this block.
126
- * For dynamically-defined blocks, the block type is the object number of the
127
- * block's factory. For the root block, the value of this property is 1.
225
+ * Gets the Block type. For statically-defined Blocks, the Block type shall be a
226
+ * Uint32 with a value corresponding to the unique configuration of this Block .
227
+ * For dynamically-defined Blocks , the Block type shall be the ONo of the
228
+ * Block's Factory. For the Root Block, the value of this property shall be 1.
229
+ * Deprecated in v3 of this class.
128
230
  *
129
231
  * @method OcaBlock#GetType
130
232
  * @returns {Promise<number>}
131
233
  * A promise which resolves to a single value of type ``number``.
132
234
  */
133
235
  /**
134
- * Invokes a factory to construct an instance of the given class, then adds it
135
- * to the block. The return value indicates whether the member was successfully
136
- * created and added.
236
+ * Constructs an Action Object according to the given construction specification
237
+ * and adds it to the Block. Added in version 3 of this class.
238
+ *
239
+ * @method OcaBlock#ConstructActionObject
240
+ * @param {string} ClassID
241
+ * @param {IOcaConstructionParameter[]} ConstructionParameters
242
+ *
243
+ * @returns {Promise<number>}
244
+ * A promise which resolves to a single value of type ``number``.
245
+ */
246
+ /**
247
+ * Invokes a Block Factory (i.e. an **OcaBlockFactoryAgent** instance) to
248
+ * construct an instance of a Block inside this Block.
249
+ *
250
+ * @method OcaBlock#ConstructBlockUsingFactory
251
+ * @param {number} FactoryONo
252
+ *
253
+ * @returns {Promise<number>}
254
+ * A promise which resolves to a single value of type ``number``.
255
+ */
256
+ /**
257
+ * Invokes a Block Factory (i.e. an **OcaBlockFactoryAgent** instance) to
258
+ * construct an instance of a Block inside this Block.
259
+ * An alias for ConstructBlockUsingFactory.
137
260
  *
138
261
  * @method OcaBlock#ConstructMemberUsingFactory
139
262
  * @param {number} FactoryONo
@@ -142,9 +265,8 @@ export const OcaBlock = make_control_class(
142
265
  * A promise which resolves to a single value of type ``number``.
143
266
  */
144
267
  /**
145
- * Removes a member from the block and destroys the object. . Deletes all signal
146
- * paths attached to its ports. The return value indicates whether the member
147
- * was successfully removed and destroyed.
268
+ * Removes a Member from the Block and destroys the object. Deletes all Signal
269
+ * Paths that were attached to the object's Ports.
148
270
  *
149
271
  * @method OcaBlock#DeleteMember
150
272
  * @param {number} ObjectNumber
@@ -152,28 +274,55 @@ export const OcaBlock = make_control_class(
152
274
  * @returns {Promise<void>}
153
275
  */
154
276
  /**
155
- * Gets the list of block members. Does not recurse inner blocks. Each inner
156
- * block is included in the returned list as a single object -- its contents are
157
- * not enumerated. The return value indicates whether the list was successfully
158
- * retrieved.
277
+ * Gets the list of Action Objects in the block. Does not recurse inner Blocks.
278
+ * Each inner Block shall be included in the returned list as a single object --
279
+ * its contents shall not be enumerated. Return data shall not list Dataset
280
+ * Objects. Previously named **GetMembers.**
281
+ *
282
+ * @method OcaBlock#GetActionObjects
283
+ * @returns {Promise<OcaObjectIdentification[]>}
284
+ * A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
285
+ */
286
+ /**
287
+ * Gets the list of Action Objects in the block. Does not recurse inner Blocks.
288
+ * Each inner Block shall be included in the returned list as a single object --
289
+ * its contents shall not be enumerated. Return data shall not list Dataset
290
+ * Objects. Previously named **GetMembers.**
291
+ * An alias for GetActionObjects.
159
292
  *
160
293
  * @method OcaBlock#GetMembers
161
294
  * @returns {Promise<OcaObjectIdentification[]>}
162
295
  * A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
163
296
  */
164
297
  /**
165
- * Gets the list of block members. Recurses inner blocks. Each inner block is
166
- * included in the returned list as a single object, amd its contents are
167
- * enumerated. The return value indicates whether the list was successfully
168
- * retrieved.
298
+ * Get a list of Member Descriptors (see datatype OcaBlockMember) that identify
299
+ * all the Action Objects in this Block and in all contained Blocks. Each
300
+ * contained Block shall be included in the returned list, and its contents
301
+ * shall be enumerated and returned in the list as well. Return data shall not
302
+ * list Dataset Objects. In the event that the size of the returned list exceeds
303
+ * the implementation limit, this method shall return the **OcaStatus** value
304
+ * **BufferOverflow**. Previously named **GetMembersRecursive.**
305
+ *
306
+ * @method OcaBlock#GetActionObjectsRecursive
307
+ * @returns {Promise<OcaBlockMember[]>}
308
+ * A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
309
+ */
310
+ /**
311
+ * Get a list of Member Descriptors (see datatype OcaBlockMember) that identify
312
+ * all the Action Objects in this Block and in all contained Blocks. Each
313
+ * contained Block shall be included in the returned list, and its contents
314
+ * shall be enumerated and returned in the list as well. Return data shall not
315
+ * list Dataset Objects. In the event that the size of the returned list exceeds
316
+ * the implementation limit, this method shall return the **OcaStatus** value
317
+ * **BufferOverflow**. Previously named **GetMembersRecursive.**
318
+ * An alias for GetActionObjectsRecursive.
169
319
  *
170
320
  * @method OcaBlock#GetMembersRecursive
171
321
  * @returns {Promise<OcaBlockMember[]>}
172
322
  * A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
173
323
  */
174
324
  /**
175
- * Adds a signal path to the block. The return value indicates whether the
176
- * signal path was successfully added.
325
+ * Adds a Signal Path to the Block.
177
326
  *
178
327
  * @method OcaBlock#AddSignalPath
179
328
  * @param {IOcaSignalPath} Path
@@ -182,8 +331,7 @@ export const OcaBlock = make_control_class(
182
331
  * A promise which resolves to a single value of type ``number``.
183
332
  */
184
333
  /**
185
- * Deletes a signal path from the block. The return value indicates whether the
186
- * signal path was successfully added.
334
+ * Deletes a Signal Path from the block.
187
335
  *
188
336
  * @method OcaBlock#DeleteSignalPath
189
337
  * @param {number} Index
@@ -191,145 +339,371 @@ export const OcaBlock = make_control_class(
191
339
  * @returns {Promise<void>}
192
340
  */
193
341
  /**
194
- * Gets the map of signal paths in the block. Does not recurse inner blocks. The
195
- * return value indicates whether the list was successfully retrieved.
342
+ * Gets the map of Signal Paths in the Block. Does not recurse inner Blocks.
196
343
  *
197
344
  * @method OcaBlock#GetSignalPaths
198
345
  * @returns {Promise<Map<number, OcaSignalPath>>}
199
346
  * A promise which resolves to a single value of type ``Map<number, OcaSignalPath>``.
200
347
  */
201
348
  /**
202
- * Gets the mapof signal paths in the block. Recurses inner blocks. The return
203
- * value indicates whether the list was successfully retrieved.
349
+ * Gets the map of Signal Paths in the Block and all inner Blocks. In the event
350
+ * that the size of the returned data exceeds the implementation limit, this
351
+ * method shall return the **OcaStatus** value **BufferOverflow**.
204
352
  *
205
353
  * @method OcaBlock#GetSignalPathsRecursive
206
354
  * @returns {Promise<Map<number, OcaSignalPath>>}
207
355
  * A promise which resolves to a single value of type ``Map<number, OcaSignalPath>``.
208
356
  */
209
357
  /**
210
- * Gets the identifier of the paramset most recently applied to this block.
358
+ * Gets the identifier of the ParamSet most recently applied to this Block.
359
+ * **Deprecated** in v3 of this class.
211
360
  *
212
361
  * @method OcaBlock#GetMostRecentParamSetIdentifier
213
362
  * @returns {Promise<OcaLibVolIdentifier>}
214
363
  * A promise which resolves to a single value of type :class:`OcaLibVolIdentifier`.
215
364
  */
216
365
  /**
217
- * Applies the referenced paramset to this block, and sets the
218
- * MostRecentParamSet property. The return value indicates whether the paramset
219
- * was successfully applied.
366
+ * Applies the referenced ParamSet to this block, and sets the
367
+ * **MostRecentParamSetIdentifier** property. **Deprecated** in v3 of this class
368
+ * (OCA 1.5)** -** controllers should use the new **OcaDataset** method of
369
+ * storing ParamSets,
220
370
  *
221
371
  * @method OcaBlock#ApplyParamSet
222
372
  * @returns {Promise<OcaLibVolIdentifier>}
223
373
  * A promise which resolves to a single value of type :class:`OcaLibVolIdentifier`.
224
374
  */
225
375
  /**
226
- * Returns a paramset library volume data block which represents the current
227
- * state of the block -- i.e. a "snapshot".
376
+ * Returns a ParamSet library volume data block which represents the current
377
+ * state of the block -- i.e. a "snapshot". **Deprecated** in v3 of this class
378
+ * (OCA 1.5)** -** controllers should use the new **OcaDataset** method of
379
+ * storing ParamSet, and use normal **OcaDataset** reading procedures for
380
+ * retrieving ParamSets.
228
381
  *
229
382
  * @method OcaBlock#GetCurrentParamSetData
230
383
  * @returns {Promise<OcaLibVolData_ParamSet>}
231
384
  * A promise which resolves to a single value of type :class:`OcaLibVolData_ParamSet`.
232
385
  */
233
386
  /**
234
- * Stores a paramset library volume data block which represents the current
235
- * state of the block ("snapshot") in the given library. **Replaces** the
236
- * library volume at the specified LibVolIdentifier.
387
+ * Stores a ParamSet library volume data block which represents the current
388
+ * state of the block. **Deprecated** in v3 of this class (OCA 1.5)** -**
389
+ * controllers should use the new **OcaDataset** method of storing ParamSets. If
390
+ * using the (current) OcaDataset mechanism, the dataset identified must have
391
+ * been created prior to calling this method.
237
392
  *
238
393
  * @method OcaBlock#StoreCurrentParamSetData
239
- * @param {IOcaLibVolIdentifier} LibVolIdentifier
394
+ * @param {IOcaLibVolIdentifier} Identifier
240
395
  *
241
396
  * @returns {Promise<void>}
242
397
  */
243
398
  /**
244
- * Gets the global blocktype. The return value indicates whether the type was
245
- * successfully retrieved. If this block has no global blocktype, the
246
- * **Authority** field of the returned **GlobalType** parameter will be zero.
247
- * **Added in version 2 of this class.**
399
+ * Gets the Global Blocktype. If this Block has no Global Blocktype, the
400
+ * **Authority** field of the returned **GlobalType** parameter shall be zero.
401
+ * Added in version 2 of this class.
248
402
  *
249
403
  * @method OcaBlock#GetGlobalType
250
404
  * @returns {Promise<OcaGlobalTypeIdentifier>}
251
405
  * A promise which resolves to a single value of type :class:`OcaGlobalTypeIdentifier`.
252
406
  */
253
407
  /**
254
- * Gets the block's ONo map. The return value indicates whether the map was
255
- * successfully retrieved. **Added in version 2 of this class.**
408
+ * Gets the Block's ONo map. Added in version 2 of this class.
256
409
  *
257
410
  * @method OcaBlock#GetONoMap
258
411
  * @returns {Promise<Map<number, number>>}
259
412
  * A promise which resolves to a single value of type ``Map<number, number>``.
260
413
  */
261
414
  /**
262
- * Returns object identifications of all objects in the block that match the
263
- * given Role search string and Class ID. Return value indicates whether the
264
- * method succeeded. **Added in version 2 of this class.**
415
+ * Returns object identifications of all Action Objects in the Block that match
416
+ * the given Role search string and Class ID. Return data shall not list Dataset
417
+ * Objects. Replaces deprecated method **FindMembersByRole**.
418
+ *
419
+ * @method OcaBlock#FindActionObjectsByRole
420
+ * @param {string} SearchName
421
+ * @param {IOcaStringComparisonType} NameComparisonType
422
+ * @param {string} SearchClassID
423
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
424
+ *
425
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
426
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
427
+ */
428
+ /**
429
+ * Returns object identifications of all Action Objects in the Block that match
430
+ * the given Role search string and Class ID. Return data shall not list Dataset
431
+ * Objects. Replaces deprecated method **FindMembersByRole**.
432
+ * An alias for FindActionObjectsByRole.
265
433
  *
266
434
  * @method OcaBlock#FindObjectsByRole
267
435
  * @param {string} SearchName
268
436
  * @param {IOcaStringComparisonType} NameComparisonType
269
437
  * @param {string} SearchClassID
270
- * @param {IOcaObjectSearchResultFlags} ResultFlags
438
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
439
+ *
440
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
441
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
442
+ */
443
+ /**
444
+ * Returns descriptors of all Action Objects that match the given Role search
445
+ * string and Class ID. Searches this Block and all contained Blocks. Return
446
+ * data shall not list Dataset Objects. In the event that the size of the
447
+ * returned data exceeds the implementation limit, this method shall return the
448
+ * **OcaStatus** value **BufferOverflow**.
449
+ *
450
+ * @method OcaBlock#FindActionObjectsByRoleRecursive
451
+ * @param {string} SearchName
452
+ * @param {IOcaStringComparisonType} NameComparisonType
453
+ * @param {string} SearchClassID
454
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
271
455
  *
272
- * @returns {Promise<OcaObjectSearchResult[]>}
273
- * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
456
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
457
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
274
458
  */
275
459
  /**
276
- * Returns block member descriptors of all objects in the block and all
277
- * contained blocks that match the given Role search string and Class ID.
278
- * **Added in version 2 of this class.**
460
+ * Returns descriptors of all Action Objects that match the given Role search
461
+ * string and Class ID. Searches this Block and all contained Blocks. Return
462
+ * data shall not list Dataset Objects. In the event that the size of the
463
+ * returned data exceeds the implementation limit, this method shall return the
464
+ * **OcaStatus** value **BufferOverflow**.
465
+ * An alias for FindActionObjectsByRoleRecursive.
279
466
  *
280
467
  * @method OcaBlock#FindObjectsByRoleRecursive
281
468
  * @param {string} SearchName
282
469
  * @param {IOcaStringComparisonType} NameComparisonType
283
470
  * @param {string} SearchClassID
284
- * @param {IOcaObjectSearchResultFlags} ResultFlags
471
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
472
+ *
473
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
474
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
475
+ */
476
+ /**
477
+ * Returns descriptors of all Action Objects that match the given Label search
478
+ * string and Class ID. Searches this Block and all contained Blocks. Return
479
+ * data shall not list Dataset Objects. In the event that the size of the
480
+ * returned data exceeds the implementation limit, this method shall return the
481
+ * **OcaStatus** value **BufferOverflow**.
482
+ *
483
+ * @method OcaBlock#FindActionObjectsByLabelRecursive
484
+ * @param {string} SearchName
485
+ * @param {IOcaStringComparisonType} NameComparisonType
486
+ * @param {string} SearchClassID
487
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
285
488
  *
286
- * @returns {Promise<OcaObjectSearchResult[]>}
287
- * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
489
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
490
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
288
491
  */
289
492
  /**
290
- * Returns block member descriptors of all objects in the block and all
291
- * contained blocks that match the given Label search string and Class ID.
292
- * **Added in version 2 of this class.**
493
+ * Returns descriptors of all Action Objects that match the given Label search
494
+ * string and Class ID. Searches this Block and all contained Blocks. Return
495
+ * data shall not list Dataset Objects. In the event that the size of the
496
+ * returned data exceeds the implementation limit, this method shall return the
497
+ * **OcaStatus** value **BufferOverflow**.
498
+ * An alias for FindActionObjectsByLabelRecursive.
293
499
  *
294
500
  * @method OcaBlock#FindObjectsByLabelRecursive
295
501
  * @param {string} SearchName
296
502
  * @param {IOcaStringComparisonType} NameComparisonType
297
503
  * @param {string} SearchClassID
298
- * @param {IOcaObjectSearchResultFlags} ResultFlags
504
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
505
+ *
506
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
507
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
508
+ */
509
+ /**
510
+ * Returns descriptors of all Action Objects with the given Role Path. Return
511
+ * data shall not list Dataset Objects.
512
+ *
513
+ * @method OcaBlock#FindActionObjectsByRolePath
514
+ * @param {string[]} SearchPath
515
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
299
516
  *
300
- * @returns {Promise<OcaObjectSearchResult[]>}
301
- * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
517
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
518
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
302
519
  */
303
520
  /**
304
- * Returns object identifications of all objects with the given name path.
305
- * **Added in version 2 of this class.**
521
+ * Returns descriptors of all Action Objects with the given Role Path. Return
522
+ * data shall not list Dataset Objects.
523
+ * An alias for FindActionObjectsByRolePath.
306
524
  *
307
525
  * @method OcaBlock#FindObjectsByPath
308
526
  * @param {string[]} SearchPath
309
- * @param {IOcaObjectSearchResultFlags} ResultFlags
527
+ * @param {IOcaActionObjectSearchResultFlags} ResultFlags
528
+ *
529
+ * @returns {Promise<OcaActionObjectSearchResult[]>}
530
+ * A promise which resolves to a single value of type :class:`OcaActionObjectSearchResult[]`.
531
+ */
532
+ /**
533
+ * Gets the Block's Configurability.
534
+ *
535
+ * @method OcaBlock#GetConfigurability
536
+ * @returns {Promise<IOcaBlockConfigurability>}
537
+ * A promise which resolves to a single value of type ``IOcaBlockConfigurability``.
538
+ */
539
+ /**
540
+ * Gets the ONo of the paramDataset most recently applied to this Block.
541
+ *
542
+ * @method OcaBlock#GetMostRecentParamDatasetONo
543
+ * @returns {Promise<number>}
544
+ * A promise which resolves to a single value of type ``number``.
545
+ */
546
+ /**
547
+ * Applies the**** ParamDataset with the given ONo to this block, and sets the
548
+ * **MostRecentParamDatasetONo** property.
549
+ *
550
+ * @method OcaBlock#ApplyParamDataset
551
+ * @param {number} ONo
552
+ *
553
+ * @returns {Promise<void>}
554
+ */
555
+ /**
556
+ * Stores current parameter values of this Block in the Dataset Object
557
+ * identified by the ONo parameter. The Dataset Object must exist - this method
558
+ * shall not create it.
559
+ *
560
+ * @method OcaBlock#StoreCurrentParameterData
561
+ * @param {number} ONo
562
+ *
563
+ * @returns {Promise<void>}
564
+ */
565
+ /**
566
+ * Returns current parameter values of this Block to the Controller in a single
567
+ * **OcaBlob**. Format of the parameter data shall be implementation-specific
568
+ * and not defined in this standard.
569
+ *
570
+ * @method OcaBlock#FetchCurrentParameterData
571
+ * @returns {Promise<Uint8Array>}
572
+ * A promise which resolves to a single value of type ``Uint8Array``.
573
+ */
574
+ /**
575
+ * Applies the supplied parameter data to the Block. Format of the parameter
576
+ * data shall be implementation-specific and not defined in this standard. The
577
+ * implementation may elect to save the supplied data in a ParamDataset. If so,
578
+ * this method shall set the **MostRecentParamDatasetONo** property to the
579
+ * object number of this ParamDataset. If not, this method shall set
580
+ * **MostRecentParamDatasetONo** to zero.
581
+ *
582
+ * @method OcaBlock#ApplyParameterData
583
+ * @returns {Promise<Uint8Array>}
584
+ * A promise which resolves to a single value of type ``Uint8Array``.
585
+ */
586
+ /**
587
+ * Constructs a Dataset and its Dataset Object.
588
+ *
589
+ * @method OcaBlock#ConstructDataset
590
+ * @param {string} ClassID
591
+ * @param {string} Name
592
+ * @param {string} Type
593
+ * @param {number|BigInt} MaxSize
594
+ * @param {Uint8Array} InitialContents
595
+ *
596
+ * @returns {Promise<number>}
597
+ * A promise which resolves to a single value of type ``number``.
598
+ */
599
+ /**
600
+ * Duplicates a Dataset and its Dataset Object.
601
+ *
602
+ * @method OcaBlock#DuplicateDataset
603
+ * @param {number} OldONo
604
+ * @param {number} TargetBlockONo
605
+ * @param {string} NewName
606
+ * @param {number|BigInt} NewMaxSize
607
+ *
608
+ * @returns {Promise<number>}
609
+ * A promise which resolves to a single value of type ``number``.
610
+ */
611
+ /**
612
+ * Returns identifiers of Dataset Objects in the Block. Shall not recurse inner
613
+ * Blocks. Return data shall not list Action Objects.
614
+ *
615
+ * @method OcaBlock#GetDatasetObjects
616
+ * @returns {Promise<OcaObjectIdentification[]>}
617
+ * A promise which resolves to a single value of type :class:`OcaObjectIdentification[]`.
618
+ */
619
+ /**
620
+ * Returns descriptors of Dataset Objects in the Block and in contained Blocks.
621
+ * Return data shall not list Action Objects. In the event that the size of the
622
+ * returned data exceeds the implementation limit, this method shall return the
623
+ * **OcaStatus** value **BufferOverflow**.
624
+ *
625
+ * @method OcaBlock#GetDatasetObjectsRecursive
626
+ * @returns {Promise<OcaBlockMember[]>}
627
+ * A promise which resolves to a single value of type :class:`OcaBlockMember[]`.
628
+ */
629
+ /**
630
+ * Returns descriptors of all Datasets in the block that match the given search
631
+ * terms. Note: If substring comparison type is selected, null search terms
632
+ * match anything. Return data shall not list Action Objects.
633
+ *
634
+ * @method OcaBlock#FindDatasets
635
+ * @param {string} Name
636
+ * @param {IOcaStringComparisonType} NameComparisonType
637
+ * @param {string} Type
638
+ * @param {IOcaStringComparisonType} TypeComparisonType
639
+ *
640
+ * @returns {Promise<OcaDatasetSearchResult[]>}
641
+ * A promise which resolves to a single value of type :class:`OcaDatasetSearchResult[]`.
642
+ */
643
+ /**
644
+ * Returns descriptors of all Datasets in this Block and all contained Blocks
645
+ * that match the given search terms. Note: If substring comparison type is
646
+ * selected, null search terms match anything. In the event that the size of the
647
+ * returned list exceeds the implementation limit, this method shall return the
648
+ * **OcaStatus** value **BufferOverflow**.
649
+ *
650
+ * @method OcaBlock#FindDatasetsRecursive
651
+ * @param {string} Name
652
+ * @param {IOcaStringComparisonType} NameComparisonType
653
+ * @param {string} Type
654
+ * @param {IOcaStringComparisonType} TypeComparisonType
655
+ *
656
+ * @returns {Promise<OcaDatasetSearchResult[]>}
657
+ * A promise which resolves to a single value of type :class:`OcaDatasetSearchResult[]`.
658
+ */
659
+ /**
660
+ * Gets the value of property **BlockFactoryONo**
661
+ *
662
+ * @method OcaBlock#GetBlockFactoryONo
663
+ * @returns {Promise<number>}
664
+ * A promise which resolves to a single value of type ``number``.
665
+ */
666
+ /**
667
+ * This event is emitted when the property ``ActionObjects`` changes in the remote object.
668
+ * The property ``ActionObjects`` is described in the AES70 standard as follows.
669
+ * List of object identifiers of Action Objects in the block.
310
670
  *
311
- * @returns {Promise<OcaObjectSearchResult[]>}
312
- * A promise which resolves to a single value of type :class:`OcaObjectSearchResult[]`.
671
+ * @member {PropertyEvent<OcaObjectIdentification[]>} OcaBlock#OnActionObjectsChanged
313
672
  */
314
673
  /**
315
- * This event is emitted when the property ``Members`` changes in the remote object.
316
- * The property ``Members`` is described in the AES70 standard as follows.
317
- * List of members in the block.
674
+ * An alias for OnActionObjectsChanged
318
675
  *
319
676
  * @member {PropertyEvent<OcaObjectIdentification[]>} OcaBlock#OnMembersChanged
320
677
  */
321
678
  /**
322
679
  * This event is emitted when the property ``SignalPaths`` changes in the remote object.
323
680
  * The property ``SignalPaths`` is described in the AES70 standard as follows.
324
- * List of signal paths in the block.
681
+ * Map of Signal Paths in the Block. Key is Block-local signal path ID.
325
682
  *
326
683
  * @member {PropertyEvent<Map<number, OcaSignalPath>>} OcaBlock#OnSignalPathsChanged
327
684
  */
328
685
  /**
329
686
  * This event is emitted when the property ``MostRecentParamSetIdentifier`` changes in the remote object.
330
687
  * The property ``MostRecentParamSetIdentifier`` is described in the AES70 standard as follows.
331
- * Library volume identifier of the paramset most recently applied to this
332
- * block.
688
+ * Identifier of the ParamSet most recently applied to this block.
689
+ * **Deprecated** in v3 of this class (OCA 1.5)** -** controllers should use the
690
+ * new **OcaDataset** method of storing ParamSets.
691
+ *
692
+ * @member {PropertyEvent<number>} OcaBlock#OnMostRecentParamSetIdentifierChanged
693
+ */
694
+ /**
695
+ * This event is emitted when the property ``DatasetObjects`` changes in the remote object.
696
+ * The property ``DatasetObjects`` is described in the AES70 standard as follows.
697
+ * List of object identifiers of Dataset Objects in the Block.
698
+ *
699
+ * @member {PropertyEvent<OcaObjectIdentification[]>} OcaBlock#OnDatasetObjectsChanged
700
+ */
701
+ /**
702
+ * This event is emitted when the property ``MostRecentParamDatasetONo`` changes in the remote object.
703
+ * The property ``MostRecentParamDatasetONo`` is described in the AES70 standard as follows.
704
+ * ONo of the paramDataset most recently applied to this Block. A value of zero
705
+ * indicates that there is no current paramDataset. Replaces
706
+ * **MostRecentParamSetIdentifier**. Added in version 3 (OCA 1.5).
333
707
  *
334
- * @member {PropertyEvent<OcaLibVolIdentifier>} OcaBlock#OnMostRecentParamSetIdentifierChanged
708
+ * @member {PropertyEvent<number>} OcaBlock#OnMostRecentParamDatasetONoChanged
335
709
  */