Ticket #6768 (closed: fixed)
Add an output property to StartLiveData pointing to the ongoing MonitorLiveData instance
Reported by: | Russell Taylor | Owned by: | Russell Taylor |
---|---|---|---|
Priority: | major | Milestone: | Release 2.5 |
Component: | Mantid | Keywords: | LiveData |
Cc: | Blocked By: | ||
Blocking: | Tester: | Wenduo Zhou |
Description
I have a need to be able to stop the live data reading in my Step Scan GUI (and, I expect, in other tools in the future). Therefore, I'm going to add an output property (of type AlgorithmProperty) to StartLiveData that passes back the MonitorLiveData that continues once StartLiveData is done. I can then use this to cancel live reading when required.
Change History
comment:2 Changed 8 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:3 Changed 8 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:4 Changed 8 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:5 Changed 8 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:6 Changed 8 years ago by Russell Taylor
- Status changed from accepted to verify
- Resolution set to fixed
Tester:
- Note the new property and that it's used in the unit test
- Check that StartLiveData can be run from the GUI (choose the 'FakeEventDataListener')
- Check it from python with the following commands:
x = StartLiveData('FakeEventDataListener',OutputWorkspace='ws',AccumulationWorkspace='') print x
Note that x is a tuple, where the last element is of type IAlgorithm. This is the new output property.
comment:7 Changed 8 years ago by Wenduo Zhou
- Status changed from verify to verifying
- Tester set to Wenduo Zhou
comment:8 Changed 8 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:9 Changed 8 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:11 Changed 8 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:12 Changed 8 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:13 Changed 8 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:14 Changed 8 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:15 Changed 7 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:16 Changed 7 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:17 Changed 7 years ago by Russell Taylor
Re #6768. Add an output property 'MonitorLiveData' to StartLiveData
that gives back a reference to the algorithm that continues to read live data after StartLiveData completes. Can be used to cancel live data reading programatically.
Changeset: 86060052765f5c5b77173d12f679af9124c5a1ea
comment:18 Changed 7 years ago by Russell Taylor
Re #6768. Expose AlgorithmProperty to python.
This is needed to avoid an error if you try to capture the return value from StartLiveData in python, now that this algorithm has an output property of this type. You can't really do much with it right now, but if needed later we could expose the IAlgorithm::cancel method.
Changeset: d7999558bf215098e52b43778cba01b1f0e6f07b
comment:19 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 7614