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