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,27 +1,34 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { OcaAgent } from './OcaAgent';
3
- import { Arguments } from '../arguments';
4
-
5
- import { PropertyEvent } from '../property_event';
6
- import { IOcaProperty } from '../../types/OcaProperty';
1
+ import { IOcaProperty, OcaProperty } from '../../types/OcaProperty';
7
2
  import { IOcaRamperCommand } from '../../types/OcaRamperCommand';
8
- import { IOcaRamperInterpolationLaw } from '../../types/OcaRamperInterpolationLaw';
9
- import { IOcaTimeMode } from '../../types/OcaTimeMode';
10
- import { OcaProperty } from '../../types/OcaProperty';
11
- import { OcaRamperInterpolationLaw } from '../../types/OcaRamperInterpolationLaw';
3
+ import {
4
+ IOcaRamperInterpolationLaw,
5
+ OcaRamperInterpolationLaw,
6
+ } from '../../types/OcaRamperInterpolationLaw';
12
7
  import { OcaRamperState } from '../../types/OcaRamperState';
13
- import { OcaTimeMode } from '../../types/OcaTimeMode';
8
+ import { IOcaTimeMode, OcaTimeMode } from '../../types/OcaTimeMode';
9
+ import { Arguments } from '../arguments';
10
+ import { PropertyEvent } from '../property_event';
11
+ import { RemoteDevice } from '../remote_device';
12
+ import { OcaAgent } from './OcaAgent';
14
13
 
15
14
  /**
16
- * Agent that gradually changes a property setting from one value to another. Works on a scalar numeric or boolean property of a specified object. Does not work for array, list, map, struct, or string properties. Contains timer features to allow ramps to start immediately or at any time in the future. This is a weakly typed class. All ramping parameters are specified as a **OcaFloat64** numbers.
17
- *
18
- * - For unsigned integer targets, the ramping parameters are coerced to **OcaUint64** before comparing.
15
+ * Agent that gradually changes a property setting from one value to another.
16
+ * Works on a scalar numeric or boolean property of a specified object. Does not
17
+ * work for array, list, map, struct, or string properties. Contains timer
18
+ * features to allow ramps to start immediately or at any time in the future.
19
+ * This is a weakly typed class. All ramping parameters are specified as a
20
+ * **OcaFloat64** numbers.
19
21
  *
22
+ * - For unsigned integer targets, the ramping parameters are coerced to
23
+ * **OcaUint64** before comparing.
20
24
  *
21
- * - For signed integer targets, the ramping parameters are coerced to **OcaInt64** before comparing.
25
+ * - For signed integer targets, the ramping parameters are coerced to
26
+ * **OcaInt64** before comparing.
22
27
  *
28
+ * - For boolean values, the the ramping parameters are coerced to
29
+ * **OcaUint8.** True is assigned the value One, False is assigned the value
30
+ * Zero.
23
31
  *
24
- * - For boolean values, the the ramping parameters are coerced to **OcaUint8.** True is assigned the value One, False is assigned the value Zero.
25
32
  *
26
33
  * @extends OcaAgent
27
34
  * @class OcaRamper
@@ -65,17 +72,19 @@ export declare class OcaRamper extends OcaAgent {
65
72
  constructor(objectNumber: number, device: RemoteDevice);
66
73
 
67
74
  /**
68
- * Executes the given ramper command. The return value indicates whether the command was successfully executed.
75
+ * Executes the given ramper command. The return value indicates whether the
76
+ * command was successfully executed.
69
77
  *
70
78
  * @method OcaRamper#Control
71
- * @param {OcaRamperCommand} Command
79
+ * @param {IOcaRamperCommand} Command
72
80
  *
73
81
  * @returns {Promise<void>}
74
82
  */
75
83
  Control(Command: IOcaRamperCommand): Promise<void>;
76
84
 
77
85
  /**
78
- * Gets current state of ramper. The return value indicates whether the state was successfully retrieved.
86
+ * Gets current state of ramper. The return value indicates whether the state
87
+ * was successfully retrieved.
79
88
  *
80
89
  * @method OcaRamper#GetState
81
90
  * @returns {Promise<OcaRamperState>}
@@ -84,7 +93,8 @@ export declare class OcaRamper extends OcaAgent {
84
93
  GetState(): Promise<OcaRamperState>;
85
94
 
86
95
  /**
87
- * Gets definition of ramped property. The return value indicates whether the object number was successfully retrieved.
96
+ * Gets definition of ramped property. The return value indicates whether the
97
+ * object number was successfully retrieved.
88
98
  *
89
99
  * @method OcaRamper#GetRampedProperty
90
100
  * @returns {Promise<OcaProperty>}
@@ -93,17 +103,19 @@ export declare class OcaRamper extends OcaAgent {
93
103
  GetRampedProperty(): Promise<OcaProperty>;
94
104
 
95
105
  /**
96
- * Defines property to be ramped. The return value indicates whether the definition was successful.
106
+ * Defines property to be ramped. The return value indicates whether the
107
+ * definition was successful.
97
108
  *
98
109
  * @method OcaRamper#SetRampedProperty
99
- * @param {OcaProperty} property
110
+ * @param {IOcaProperty} property
100
111
  *
101
112
  * @returns {Promise<void>}
102
113
  */
103
114
  SetRampedProperty(property: IOcaProperty): Promise<void>;
104
115
 
105
116
  /**
106
- * Gets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully retrieved.
117
+ * Gets ramper time mode (absolute or relative). The return value indicates
118
+ * whether the time mode was successfully retrieved.
107
119
  *
108
120
  * @method OcaRamper#GetTimeMode
109
121
  * @returns {Promise<OcaTimeMode>}
@@ -112,17 +124,19 @@ export declare class OcaRamper extends OcaAgent {
112
124
  GetTimeMode(): Promise<OcaTimeMode>;
113
125
 
114
126
  /**
115
- * Sets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully set.
127
+ * Sets ramper time mode (absolute or relative). The return value indicates
128
+ * whether the time mode was successfully set.
116
129
  *
117
130
  * @method OcaRamper#SetTimeMode
118
- * @param {OcaTimeMode} TimeMode
131
+ * @param {IOcaTimeMode} TimeMode
119
132
  *
120
133
  * @returns {Promise<void>}
121
134
  */
122
135
  SetTimeMode(TimeMode: IOcaTimeMode): Promise<void>;
123
136
 
124
137
  /**
125
- * Gets ramp start time. The return value indicates whether the start time was successfully retrieved.
138
+ * Gets ramp start time. The return value indicates whether the start time was
139
+ * successfully retrieved.
126
140
  *
127
141
  * @method OcaRamper#GetStartTime
128
142
  * @returns {Promise<number|BigInt>}
@@ -131,7 +145,8 @@ export declare class OcaRamper extends OcaAgent {
131
145
  GetStartTime(): Promise<number | BigInt>;
132
146
 
133
147
  /**
134
- * Sets ramper start time. The return value indicates whether the start time was successfully set.
148
+ * Sets ramper start time. The return value indicates whether the start time
149
+ * was successfully set.
135
150
  *
136
151
  * @method OcaRamper#SetStartTime
137
152
  * @param {number|BigInt} TimeMode
@@ -141,7 +156,8 @@ export declare class OcaRamper extends OcaAgent {
141
156
  SetStartTime(TimeMode: number | BigInt): Promise<void>;
142
157
 
143
158
  /**
144
- * Gets ramp duration. The return value indicates whether the duration was successfully retrieved.
159
+ * Gets ramp duration. The return value indicates whether the duration was
160
+ * successfully retrieved.
145
161
  * The return values of this method are
146
162
  *
147
163
  * - Duration of type ``number``
@@ -154,7 +170,8 @@ export declare class OcaRamper extends OcaAgent {
154
170
  GetDuration(): Promise<Arguments<[number, number, number]>>;
155
171
 
156
172
  /**
157
- * Sets ramp duration. The return value indicates whether the duration was successfully set.
173
+ * Sets ramp duration. The return value indicates whether the duration was
174
+ * successfully set.
158
175
  *
159
176
  * @method OcaRamper#SetDuration
160
177
  * @param {number} Duration
@@ -164,7 +181,8 @@ export declare class OcaRamper extends OcaAgent {
164
181
  SetDuration(Duration: number): Promise<void>;
165
182
 
166
183
  /**
167
- * Retrieves interpolation law setting. The return value indicates whether the setting was successfully retrieved.
184
+ * Retrieves interpolation law setting. The return value indicates whether the
185
+ * setting was successfully retrieved.
168
186
  *
169
187
  * @method OcaRamper#GetInterpolationLaw
170
188
  * @returns {Promise<OcaRamperInterpolationLaw>}
@@ -173,17 +191,19 @@ export declare class OcaRamper extends OcaAgent {
173
191
  GetInterpolationLaw(): Promise<OcaRamperInterpolationLaw>;
174
192
 
175
193
  /**
176
- * Sets ramp interpolation law. The return value indicates whether the law was successfully set.
194
+ * Sets ramp interpolation law. The return value indicates whether the law was
195
+ * successfully set.
177
196
  *
178
197
  * @method OcaRamper#SetInterpolationLaw
179
- * @param {OcaRamperInterpolationLaw} law
198
+ * @param {IOcaRamperInterpolationLaw} law
180
199
  *
181
200
  * @returns {Promise<void>}
182
201
  */
183
202
  SetInterpolationLaw(law: IOcaRamperInterpolationLaw): Promise<void>;
184
203
 
185
204
  /**
186
- * Retrieves ramp goal value. The return value indicates whether the duration was successfully retrieved.
205
+ * Retrieves ramp goal value. The return value indicates whether the duration
206
+ * was successfully retrieved.
187
207
  *
188
208
  * @method OcaRamper#GetGoal
189
209
  * @returns {Promise<number>}
@@ -192,7 +212,8 @@ export declare class OcaRamper extends OcaAgent {
192
212
  GetGoal(): Promise<number>;
193
213
 
194
214
  /**
195
- * Sets ramp goal value. The return value indicates whether the duration was successfully set.
215
+ * Sets ramp goal value. The return value indicates whether the duration was
216
+ * successfully set.
196
217
  *
197
218
  * @method OcaRamper#SetGoal
198
219
  * @param {number} goal
@@ -1,5 +1,3 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { OcaAgent } from './OcaAgent.js';
3
1
  import { OcaFloat32 } from '../../OCP1/OcaFloat32.js';
4
2
  import { OcaFloat64 } from '../../OCP1/OcaFloat64.js';
5
3
  import { OcaProperty } from '../../OCP1/OcaProperty.js';
@@ -8,17 +6,27 @@ import { OcaRamperInterpolationLaw } from '../../OCP1/OcaRamperInterpolationLaw.
8
6
  import { OcaRamperState } from '../../OCP1/OcaRamperState.js';
9
7
  import { OcaTimeMode } from '../../OCP1/OcaTimeMode.js';
10
8
  import { OcaUint64 } from '../../OCP1/OcaUint64.js';
9
+ import { make_control_class } from '../make_control_class.js';
10
+ import { OcaAgent } from './OcaAgent.js';
11
11
 
12
12
  /**
13
- * Agent that gradually changes a property setting from one value to another. Works on a scalar numeric or boolean property of a specified object. Does not work for array, list, map, struct, or string properties. Contains timer features to allow ramps to start immediately or at any time in the future. This is a weakly typed class. All ramping parameters are specified as a **OcaFloat64** numbers.
14
- *
15
- * - For unsigned integer targets, the ramping parameters are coerced to **OcaUint64** before comparing.
13
+ * Agent that gradually changes a property setting from one value to another.
14
+ * Works on a scalar numeric or boolean property of a specified object. Does not
15
+ * work for array, list, map, struct, or string properties. Contains timer
16
+ * features to allow ramps to start immediately or at any time in the future.
17
+ * This is a weakly typed class. All ramping parameters are specified as a
18
+ * **OcaFloat64** numbers.
16
19
  *
20
+ * - For unsigned integer targets, the ramping parameters are coerced to
21
+ * **OcaUint64** before comparing.
17
22
  *
18
- * - For signed integer targets, the ramping parameters are coerced to **OcaInt64** before comparing.
23
+ * - For signed integer targets, the ramping parameters are coerced to
24
+ * **OcaInt64** before comparing.
19
25
  *
26
+ * - For boolean values, the the ramping parameters are coerced to
27
+ * **OcaUint8.** True is assigned the value One, False is assigned the value
28
+ * Zero.
20
29
  *
21
- * - For boolean values, the the ramping parameters are coerced to **OcaUint8.** True is assigned the value One, False is assigned the value Zero.
22
30
  *
23
31
  * @extends OcaAgent
24
32
  * @class OcaRamper
@@ -58,59 +66,67 @@ export const OcaRamper = make_control_class(
58
66
  );
59
67
 
60
68
  /**
61
- * Executes the given ramper command. The return value indicates whether the command was successfully executed.
69
+ * Executes the given ramper command. The return value indicates whether the
70
+ * command was successfully executed.
62
71
  *
63
72
  * @method OcaRamper#Control
64
- * @param {OcaRamperCommand} Command
73
+ * @param {IOcaRamperCommand} Command
65
74
  *
66
75
  * @returns {Promise<void>}
67
76
  */
68
77
  /**
69
- * Gets current state of ramper. The return value indicates whether the state was successfully retrieved.
78
+ * Gets current state of ramper. The return value indicates whether the state
79
+ * was successfully retrieved.
70
80
  *
71
81
  * @method OcaRamper#GetState
72
82
  * @returns {Promise<OcaRamperState>}
73
83
  * A promise which resolves to a single value of type :class:`OcaRamperState`.
74
84
  */
75
85
  /**
76
- * Gets definition of ramped property. The return value indicates whether the object number was successfully retrieved.
86
+ * Gets definition of ramped property. The return value indicates whether the
87
+ * object number was successfully retrieved.
77
88
  *
78
89
  * @method OcaRamper#GetRampedProperty
79
90
  * @returns {Promise<OcaProperty>}
80
91
  * A promise which resolves to a single value of type :class:`OcaProperty`.
81
92
  */
82
93
  /**
83
- * Defines property to be ramped. The return value indicates whether the definition was successful.
94
+ * Defines property to be ramped. The return value indicates whether the
95
+ * definition was successful.
84
96
  *
85
97
  * @method OcaRamper#SetRampedProperty
86
- * @param {OcaProperty} property
98
+ * @param {IOcaProperty} property
87
99
  *
88
100
  * @returns {Promise<void>}
89
101
  */
90
102
  /**
91
- * Gets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully retrieved.
103
+ * Gets ramper time mode (absolute or relative). The return value indicates
104
+ * whether the time mode was successfully retrieved.
92
105
  *
93
106
  * @method OcaRamper#GetTimeMode
94
107
  * @returns {Promise<OcaTimeMode>}
95
108
  * A promise which resolves to a single value of type :class:`OcaTimeMode`.
96
109
  */
97
110
  /**
98
- * Sets ramper time mode (absolute or relative). The return value indicates whether the time mode was successfully set.
111
+ * Sets ramper time mode (absolute or relative). The return value indicates
112
+ * whether the time mode was successfully set.
99
113
  *
100
114
  * @method OcaRamper#SetTimeMode
101
- * @param {OcaTimeMode} TimeMode
115
+ * @param {IOcaTimeMode} TimeMode
102
116
  *
103
117
  * @returns {Promise<void>}
104
118
  */
105
119
  /**
106
- * Gets ramp start time. The return value indicates whether the start time was successfully retrieved.
120
+ * Gets ramp start time. The return value indicates whether the start time was
121
+ * successfully retrieved.
107
122
  *
108
123
  * @method OcaRamper#GetStartTime
109
124
  * @returns {Promise<number|BigInt>}
110
125
  * A promise which resolves to a single value of type ``number|BigInt``.
111
126
  */
112
127
  /**
113
- * Sets ramper start time. The return value indicates whether the start time was successfully set.
128
+ * Sets ramper start time. The return value indicates whether the start time was
129
+ * successfully set.
114
130
  *
115
131
  * @method OcaRamper#SetStartTime
116
132
  * @param {number|BigInt} TimeMode
@@ -118,7 +134,8 @@ export const OcaRamper = make_control_class(
118
134
  * @returns {Promise<void>}
119
135
  */
120
136
  /**
121
- * Gets ramp duration. The return value indicates whether the duration was successfully retrieved.
137
+ * Gets ramp duration. The return value indicates whether the duration was
138
+ * successfully retrieved.
122
139
  * The return values of this method are
123
140
  *
124
141
  * - Duration of type ``number``
@@ -129,7 +146,8 @@ export const OcaRamper = make_control_class(
129
146
  * @returns {Promise<Arguments<number,number,number>>}
130
147
  */
131
148
  /**
132
- * Sets ramp duration. The return value indicates whether the duration was successfully set.
149
+ * Sets ramp duration. The return value indicates whether the duration was
150
+ * successfully set.
133
151
  *
134
152
  * @method OcaRamper#SetDuration
135
153
  * @param {number} Duration
@@ -137,29 +155,33 @@ export const OcaRamper = make_control_class(
137
155
  * @returns {Promise<void>}
138
156
  */
139
157
  /**
140
- * Retrieves interpolation law setting. The return value indicates whether the setting was successfully retrieved.
158
+ * Retrieves interpolation law setting. The return value indicates whether the
159
+ * setting was successfully retrieved.
141
160
  *
142
161
  * @method OcaRamper#GetInterpolationLaw
143
162
  * @returns {Promise<OcaRamperInterpolationLaw>}
144
163
  * A promise which resolves to a single value of type :class:`OcaRamperInterpolationLaw`.
145
164
  */
146
165
  /**
147
- * Sets ramp interpolation law. The return value indicates whether the law was successfully set.
166
+ * Sets ramp interpolation law. The return value indicates whether the law was
167
+ * successfully set.
148
168
  *
149
169
  * @method OcaRamper#SetInterpolationLaw
150
- * @param {OcaRamperInterpolationLaw} law
170
+ * @param {IOcaRamperInterpolationLaw} law
151
171
  *
152
172
  * @returns {Promise<void>}
153
173
  */
154
174
  /**
155
- * Retrieves ramp goal value. The return value indicates whether the duration was successfully retrieved.
175
+ * Retrieves ramp goal value. The return value indicates whether the duration
176
+ * was successfully retrieved.
156
177
  *
157
178
  * @method OcaRamper#GetGoal
158
179
  * @returns {Promise<number>}
159
180
  * A promise which resolves to a single value of type ``number``.
160
181
  */
161
182
  /**
162
- * Sets ramp goal value. The return value indicates whether the duration was successfully set.
183
+ * Sets ramp goal value. The return value indicates whether the duration was
184
+ * successfully set.
163
185
  *
164
186
  * @method OcaRamper#SetGoal
165
187
  * @param {number} goal
@@ -167,53 +189,52 @@ export const OcaRamper = make_control_class(
167
189
  * @returns {Promise<void>}
168
190
  */
169
191
  /**
170
- * This event is emitted when the property State changes in the remote object.
192
+ * This event is emitted when the property ``State`` changes in the remote object.
171
193
  * The property ``State`` is described in the AES70 standard as follows.
172
194
  * {Ready, Ramping, Paused, Completed, Disabled} Readonly.
173
195
  *
174
196
  * @member {PropertyEvent<OcaRamperState>} OcaRamper#OnStateChanged
175
197
  */
176
198
  /**
177
- * This event is emitted when the property RampedProperty changes in the remote object.
199
+ * This event is emitted when the property ``RampedProperty`` changes in the remote object.
178
200
  * The property ``RampedProperty`` is described in the AES70 standard as follows.
179
201
  * Identification of the property being ramped.
180
202
  *
181
203
  * @member {PropertyEvent<OcaProperty>} OcaRamper#OnRampedPropertyChanged
182
204
  */
183
205
  /**
184
- * This event is emitted when the property TimeMode changes in the remote object.
206
+ * This event is emitted when the property ``TimeMode`` changes in the remote object.
185
207
  * The property ``TimeMode`` is described in the AES70 standard as follows.
186
208
  * Absolute or Relative time.
187
209
  *
188
210
  * @member {PropertyEvent<OcaTimeMode>} OcaRamper#OnTimeModeChanged
189
211
  */
190
212
  /**
191
- * This event is emitted when the property StartTime changes in the remote object.
213
+ * This event is emitted when the property ``StartTime`` changes in the remote object.
192
214
  * The property ``StartTime`` is described in the AES70 standard as follows.
193
- * Time at which to start ramp. If <b>TimeMode=Relative</b>, the actual
194
- * event start time equals the value of <b>StartTime</b> plus the
195
- * absolute time that <b>StartTime</b> was most recently set. If
196
- * <b>TimeMode=Absolute</b>, the actual event start time equals the value
197
- * of <b>StartTime</b>
215
+ * Time at which to start ramp. If **TimeMode=Relative**, the actual event start
216
+ * time equals the value of **StartTime** plus the absolute time that
217
+ * **StartTime** was most recently set. If **TimeMode=Absolute**, the actual
218
+ * event start time equals the value of **StartTime**
198
219
  *
199
220
  * @member {PropertyEvent<number|BigInt>} OcaRamper#OnStartTimeChanged
200
221
  */
201
222
  /**
202
- * This event is emitted when the property Duration changes in the remote object.
223
+ * This event is emitted when the property ``Duration`` changes in the remote object.
203
224
  * The property ``Duration`` is described in the AES70 standard as follows.
204
225
  * Duration of ramp period.
205
226
  *
206
227
  * @member {PropertyEvent<number>} OcaRamper#OnDurationChanged
207
228
  */
208
229
  /**
209
- * This event is emitted when the property InterpolationLaw changes in the remote object.
230
+ * This event is emitted when the property ``InterpolationLaw`` changes in the remote object.
210
231
  * The property ``InterpolationLaw`` is described in the AES70 standard as follows.
211
232
  * Ramper interpolation law
212
233
  *
213
234
  * @member {PropertyEvent<OcaRamperInterpolationLaw>} OcaRamper#OnInterpolationLawChanged
214
235
  */
215
236
  /**
216
- * This event is emitted when the property Goal changes in the remote object.
237
+ * This event is emitted when the property ``Goal`` changes in the remote object.
217
238
  * The property ``Goal`` is described in the AES70 standard as follows.
218
239
  * Final value of ramp. Datatype is target property's datatype.
219
240
  *
@@ -1,29 +1,29 @@
1
- import { RemoteDevice } from '../remote_device';
2
- import { ObjectBase } from '../object_base';
3
- import { Event } from '../event';
4
-
5
- import { PropertyEvent } from '../property_event';
6
1
  import { OcaClassIdentification } from '../../types/OcaClassIdentification';
2
+ import { Event } from '../event';
3
+ import { ObjectBase } from '../object_base';
4
+ import { RemoteDevice } from '../remote_device';
7
5
 
8
6
  /**
9
- * The abstract root class of which all OCA classes derive. It offers basic OCA functionality such as locking an object and generalized data access.
7
+ * The abstract root class of which all OCA classes derive. It offers basic OCA
8
+ * functionality such as locking an object and generalized data access.
10
9
  * @extends ObjectBase
11
10
  * @class OcaRoot
12
11
  */
13
12
  export declare class OcaRoot extends ObjectBase {
14
13
  /**
15
- * General event that is emitted when a property changes. In each setter method (of derived classes) this event must be raised with the proper derived event data structure.
16
- * @member OcaRoot#OnPropertyChanged {Event}
17
14
  * General event that is emitted when a property changes. In each setter
18
15
  * method (of derived classes) this event must be raised with the proper
19
16
  * derived event data structure.
17
+ * @member OcaRoot#OnPropertyChanged {Event}
20
18
  */
21
19
  OnPropertyChanged: Event;
22
20
 
23
21
  constructor(objectNumber: number, device: RemoteDevice);
24
22
 
25
23
  /**
26
- * Gets the class identification, a structure that contains the ClassID and ClassVersion. The return value indicates whether the property was successfully retrieved.
24
+ * Gets the class identification, a structure that contains the ClassID and
25
+ * ClassVersion. The return value indicates whether the property was
26
+ * successfully retrieved.
27
27
  *
28
28
  * @method OcaRoot#GetClassIdentification
29
29
  * @returns {Promise<OcaClassIdentification>}
@@ -32,7 +32,8 @@ export declare class OcaRoot extends ObjectBase {
32
32
  GetClassIdentification(): Promise<OcaClassIdentification>;
33
33
 
34
34
  /**
35
- * Gets the value of the Lockable property. The return value indicates whether the property was successfully retrieved.
35
+ * Gets the value of the Lockable property. The return value indicates whether
36
+ * the property was successfully retrieved.
36
37
  *
37
38
  * @method OcaRoot#GetLockable
38
39
  * @returns {Promise<boolean>}
@@ -41,7 +42,12 @@ export declare class OcaRoot extends ObjectBase {
41
42
  GetLockable(): Promise<boolean>;
42
43
 
43
44
  /**
44
- * Locks the object totally, so that it can only be accessed for reading or writing by the lockholder. If the device is read-only locked (by a prior call to LockReadonly()) when Lock() is called by the same lockholder, the lock state is upgraded to total. If the call is from a session other than the lockholder's, the call fails. The return value indicates whether the operation succeeded.
45
+ * Locks the object totally, so that it can only be accessed for reading or
46
+ * writing by the lockholder. If the device is read-only locked (by a prior
47
+ * call to LockReadonly()) when Lock() is called by the same lockholder, the
48
+ * lock state is upgraded to total. If the call is from a session other than
49
+ * the lockholder's, the call fails. The return value indicates whether the
50
+ * operation succeeded.
45
51
  *
46
52
  * @method OcaRoot#LockTotal
47
53
  * @returns {Promise<void>}
@@ -49,7 +55,9 @@ export declare class OcaRoot extends ObjectBase {
49
55
  LockTotal(): Promise<void>;
50
56
 
51
57
  /**
52
- * Unlocks the object so that it can be freely accessed again. This method can only succeed if it is called by the lockholder. The return value indicates whether the operation succeeded.
58
+ * Unlocks the object so that it can be freely accessed again. This method can
59
+ * only succeed if it is called by the lockholder. The return value indicates
60
+ * whether the operation succeeded.
53
61
  *
54
62
  * @method OcaRoot#Unlock
55
63
  * @returns {Promise<void>}
@@ -57,7 +65,8 @@ export declare class OcaRoot extends ObjectBase {
57
65
  Unlock(): Promise<void>;
58
66
 
59
67
  /**
60
- * Returns value of Role property. The return value indicates whether the operation succeeded.
68
+ * Returns value of Role property. The return value indicates whether the
69
+ * operation succeeded.
61
70
  *
62
71
  * @method OcaRoot#GetRole
63
72
  * @returns {Promise<string>}
@@ -66,7 +75,12 @@ export declare class OcaRoot extends ObjectBase {
66
75
  GetRole(): Promise<string>;
67
76
 
68
77
  /**
69
- * Locks the object so that its properties may only be modified by the lockholder, but others can still retrieve property values. If the device is already locked (by a prior call to Lock() or LockReadonly()) when LockReadonly() is called by the same lockholder, the lock state is set to read-only. If the call is from a session other than the lockholder's, the call fails. The return value indicates whether the operation succeeded.
78
+ * Locks the object so that its properties may only be modified by the
79
+ * lockholder, but others can still retrieve property values. If the device is
80
+ * already locked (by a prior call to Lock() or LockReadonly()) when
81
+ * LockReadonly() is called by the same lockholder, the lock state is set to
82
+ * read-only. If the call is from a session other than the lockholder's, the
83
+ * call fails. The return value indicates whether the operation succeeded.
70
84
  *
71
85
  * @method OcaRoot#LockReadonly
72
86
  * @returns {Promise<void>}
@@ -1,16 +1,16 @@
1
- import { make_control_class } from '../make_control_class.js';
2
- import { ObjectBase } from '../object_base.js';
3
1
  import { OcaBoolean } from '../../OCP1/OcaBoolean.js';
4
2
  import { OcaClassIdentification } from '../../OCP1/OcaClassIdentification.js';
5
- import { OcaPropertyChangeType } from '../../OCP1/OcaPropertyChangeType.js';
6
- import { OcaPropertyID } from '../../OCP1/OcaPropertyID.js';
3
+ import { OcaPropertyChangedEventData } from '../../OCP1/OcaPropertyChangedEventData.js';
7
4
  import { OcaString } from '../../OCP1/OcaString.js';
8
5
  import { OcaUint16 } from '../../OCP1/OcaUint16.js';
9
6
  import { OcaUint32 } from '../../OCP1/OcaUint32.js';
10
7
  import { String16 } from '../../OCP1/String16.js';
11
- import { RestWithOffset } from '../../OCP1/RestWithOffset.js';
8
+ import { make_control_class } from '../make_control_class.js';
9
+ import { ObjectBase } from '../object_base.js';
10
+
12
11
  /**
13
- * The abstract root class of which all OCA classes derive. It offers basic OCA functionality such as locking an object and generalized data access.
12
+ * The abstract root class of which all OCA classes derive. It offers basic OCA
13
+ * functionality such as locking an object and generalized data access.
14
14
  * @extends ObjectBase
15
15
  * @class OcaRoot
16
16
  */
@@ -35,59 +35,67 @@ export const OcaRoot = make_control_class(
35
35
  ['Lockable', [OcaBoolean], 1, 4, true, false, null],
36
36
  ['Role', [OcaString], 1, 5, true, false, null],
37
37
  ],
38
- [
39
- [
40
- 'PropertyChanged',
41
- 1,
42
- 1,
43
- [OcaPropertyID, RestWithOffset(1), OcaPropertyChangeType],
44
- ],
45
- ]
38
+ [['PropertyChanged', 1, 1, [OcaPropertyChangedEventData]]]
46
39
  );
47
40
 
48
41
  /**
49
- * Gets the class identification, a structure that contains the ClassID and ClassVersion. The return value indicates whether the property was successfully retrieved.
42
+ * Gets the class identification, a structure that contains the ClassID and
43
+ * ClassVersion. The return value indicates whether the property was
44
+ * successfully retrieved.
50
45
  *
51
46
  * @method OcaRoot#GetClassIdentification
52
47
  * @returns {Promise<OcaClassIdentification>}
53
48
  * A promise which resolves to a single value of type :class:`OcaClassIdentification`.
54
49
  */
55
50
  /**
56
- * Gets the value of the Lockable property. The return value indicates whether the property was successfully retrieved.
51
+ * Gets the value of the Lockable property. The return value indicates whether
52
+ * the property was successfully retrieved.
57
53
  *
58
54
  * @method OcaRoot#GetLockable
59
55
  * @returns {Promise<boolean>}
60
56
  * A promise which resolves to a single value of type ``boolean``.
61
57
  */
62
58
  /**
63
- * Locks the object totally, so that it can only be accessed for reading or writing by the lockholder. If the device is read-only locked (by a prior call to LockReadonly()) when Lock() is called by the same lockholder, the lock state is upgraded to total. If the call is from a session other than the lockholder's, the call fails. The return value indicates whether the operation succeeded.
59
+ * Locks the object totally, so that it can only be accessed for reading or
60
+ * writing by the lockholder. If the device is read-only locked (by a prior call
61
+ * to LockReadonly()) when Lock() is called by the same lockholder, the lock
62
+ * state is upgraded to total. If the call is from a session other than the
63
+ * lockholder's, the call fails. The return value indicates whether the
64
+ * operation succeeded.
64
65
  *
65
66
  * @method OcaRoot#LockTotal
66
67
  * @returns {Promise<void>}
67
68
  */
68
69
  /**
69
- * Unlocks the object so that it can be freely accessed again. This method can only succeed if it is called by the lockholder. The return value indicates whether the operation succeeded.
70
+ * Unlocks the object so that it can be freely accessed again. This method can
71
+ * only succeed if it is called by the lockholder. The return value indicates
72
+ * whether the operation succeeded.
70
73
  *
71
74
  * @method OcaRoot#Unlock
72
75
  * @returns {Promise<void>}
73
76
  */
74
77
  /**
75
- * Returns value of Role property. The return value indicates whether the operation succeeded.
78
+ * Returns value of Role property. The return value indicates whether the
79
+ * operation succeeded.
76
80
  *
77
81
  * @method OcaRoot#GetRole
78
82
  * @returns {Promise<string>}
79
83
  * A promise which resolves to a single value of type ``string``.
80
84
  */
81
85
  /**
82
- * Locks the object so that its properties may only be modified by the lockholder, but others can still retrieve property values. If the device is already locked (by a prior call to Lock() or LockReadonly()) when LockReadonly() is called by the same lockholder, the lock state is set to read-only. If the call is from a session other than the lockholder's, the call fails. The return value indicates whether the operation succeeded.
86
+ * Locks the object so that its properties may only be modified by the
87
+ * lockholder, but others can still retrieve property values. If the device is
88
+ * already locked (by a prior call to Lock() or LockReadonly()) when
89
+ * LockReadonly() is called by the same lockholder, the lock state is set to
90
+ * read-only. If the call is from a session other than the lockholder's, the
91
+ * call fails. The return value indicates whether the operation succeeded.
83
92
  *
84
93
  * @method OcaRoot#LockReadonly
85
94
  * @returns {Promise<void>}
86
95
  */
87
96
  /**
88
- * General event that is emitted when a property changes. In each setter method (of derived classes) this event must be raised with the proper derived event data structure.
97
+ * General event that is emitted when a property changes. In each setter method
98
+ * (of derived classes) this event must be raised with the proper derived event
99
+ * data structure.
89
100
  * @member OcaRoot#OnPropertyChanged {Event}
90
- * General event that is emitted when a property changes. In each setter
91
- * method (of derived classes) this event must be raised with the proper
92
- * derived event data structure.
93
101
  */