Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 1.42 KB

rep_caps.rst

File metadata and controls

50 lines (29 loc) · 1.42 KB
Raw
.. py:module:: niscope
    :noindex:


.. py:currentmodule:: niscope.Session

Repeated Capabilities

Repeated capabilities attributes are used to set the channel_string parameter to the underlying driver function call. This can be the actual function based on the :py:class:`Session` method being called, or it can be the appropriate Get/Set Attribute function, such as niScope_SetAttributeViInt32().

Repeated capabilities attributes use the indexing operator [] to indicate the repeated capabilities. The parameter can be a string, list, tuple, or slice (range). Each element of those can be a string or an integer. If it is a string, you can indicate a range using the same format as the driver: '0-2' or '0:2'

Some repeated capabilities use a prefix before the number and this is optional

channels

.. py:attribute:: niscope.Session.channels[]

    .. code:: python

        session.channels['0-2'].channel_enabled = True

    passes a string of :python:`'0, 1, 2'` to the set attribute function.

instruments

.. py:attribute:: niscope.Session.instruments[]

    .. code:: python

        session.instruments['0-2'].channel_enabled = True

    passes a string of :python:`'0, 1, 2'` to the set attribute function.