sascha/devlib
1
0
Fork 0
mirror of https://github.com/ARM-software/devlib.git synced 2025-11-04 07:51:21 +00:00
Code Issues Releases Wiki Activity

docs/instrumenation: Document teardown behaviour for instrument API

Browse Source
This commit is contained in:
Marc Bonnici
2019-10-03 09:51:24 +01:00
committed by setrofim
parent c73266c3a9
commit 6b72b50c40
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/instrumentation.rst
View File

@@ -168,6 +168,17 @@ Instrument
generated or saved, an empty list will be returned. The format of the generated or saved, an empty list will be returned. The format of the
contents of the raw files is entirely source-dependent. contents of the raw files is entirely source-dependent.
.. note:: This method is not guaranteed to return valid filepaths after the
:meth:`teardown` method has been invoked as the raw files may have
been deleted. Please ensure that copies are created manually
prior to calling :meth:`teardown` if the files are to be retained.
.. method:: Instrument.teardown()
Performs any required clean up of the instrument. This usually includes
removing temporary and raw files (if ``keep_raw`` is set to ``False`` on relevant
instruments), stopping services etc.
.. attribute:: Instrument.sample_rate_hz .. attribute:: Instrument.sample_rate_hz
Sample rate of the instrument in Hz. Assumed to be the same for all channels. Sample rate of the instrument in Hz. Assumed to be the same for all channels.