Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for repeated capabilities on methods that support independent channels #1589

Merged
merged 11 commits into from
Apr 21, 2021
Merged

Add support for repeated capabilities on methods that support independent channels #1589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d7bf2e8
added try/except for function not found
Apr 14, 2021
e33e02d
refined error message
Apr 14, 2021
af76715
add repeated capabilities
Apr 15, 2021
9d815a0
removed get_channel_names
Apr 15, 2021
67e9d61
fixed reference to create_advanced_sequence_step
Apr 15, 2021
145b308
added new error class;add function to catch errors
Apr 15, 2021
c7db42f
replaced fake function name fred
Apr 15, 2021
e8b954b
add unit test for library too old error
Apr 16, 2021
73ea864
code cleanup
Apr 16, 2021
bb3be96
Merge branch 'function-not-found-exception' into add-repeated-capabil…
Apr 20, 2021
c03243c
Merge branch 'master' into add-repeated-capabilities
ni-erikcrank Apr 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 68 additions & 8 deletions docs/nidcpower/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,11 @@ abort
.. note:: One or more of the referenced methods are not in the Python API for this driver.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


clear_latched_output_cutoff_state
---------------------------------
Expand Down Expand Up @@ -254,6 +259,11 @@ commit



.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


configure_aperture_time
-----------------------
Expand Down Expand Up @@ -505,7 +515,7 @@ create_advanced_sequence_step

Creates a new advanced sequence step in the advanced sequence specified
by the Active advanced sequence. When you create an advanced sequence
step, each property you passed to the :py:meth:`nidcpower.Session._create_advanced_sequence`
step, each property you passed to the :py:meth:`nidcpower.Session.create_advanced_sequence`
method is reset to its default value for that step unless otherwise
specified.

Expand All @@ -524,7 +534,7 @@ create_advanced_sequence_step
`Programming
States <REPLACE_DRIVER_SPECIFIC_URL_1(programmingstates)>`__

:py:meth:`nidcpower.Session._create_advanced_sequence`
:py:meth:`nidcpower.Session.create_advanced_sequence`



Expand All @@ -534,6 +544,11 @@ create_advanced_sequence_step
for more information about supported devices.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


:param set_as_active_step:

Expand Down Expand Up @@ -578,6 +593,11 @@ delete_advanced_sequence
for more information about supported devices.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


:param sequence_name:

Expand Down Expand Up @@ -1126,6 +1146,11 @@ initiate
.. note:: This method will return a Python context manager that will initiate on entering and abort on exit.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


lock
----
Expand Down Expand Up @@ -1325,14 +1350,12 @@ query_latched_output_cutoff_state
.. py:method:: query_latched_output_cutoff_state(output_cutoff_reason)

Discovers if an output cutoff limit was exceeded for the specified reason. When an output cutoff is engaged, the output of the channel(s) is disconnected.
If a limit was exceeded, the state is latched until you clear it with the :py:meth:`nidcpower.Session.clear_latched_output_cutoff_state` method or the :py:meth:`nidcpower.Session.ResetWithChannels` method.
If a limit was exceeded, the state is latched until you clear it with the :py:meth:`nidcpower.Session.clear_latched_output_cutoff_state` method or the :py:meth:`nidcpower.Session.reset` method.

outputCutoffReason specifies the conditions for which an output is disconnected.



.. note:: One or more of the referenced methods are not in the Python API for this driver.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
Expand Down Expand Up @@ -1595,6 +1618,11 @@ reset



.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


reset_device
------------
Expand Down Expand Up @@ -1735,6 +1763,11 @@ send_software_edge_trigger
for more information about supported devices.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


:param trigger:

Expand Down Expand Up @@ -1860,6 +1893,11 @@ wait_for_event
for more information about supported devices.


.. tip:: This method requires repeated capabilities. If called directly on the
nidcpower.Session object, then the method will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling this method on the result.


:param event_id:

Expand Down Expand Up @@ -3642,6 +3680,14 @@ instrument_manufacturer

Contains the name of the manufacturer for the device you are currently using.




.. tip:: This property can use repeated capabilities. If set or get directly on the
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling set/get value on the result.

The following table lists the characteristics of this property.

+----------------+-----------+
Expand All @@ -3651,7 +3697,7 @@ instrument_manufacturer
+----------------+-----------+
| Permissions | read only |
+----------------+-----------+
| Channel Based | No |
| Channel Based | Yes |
+----------------+-----------+
| Resettable | No |
+----------------+-----------+
Expand Down Expand Up @@ -6652,6 +6698,12 @@ self_calibration_persistence

.. note:: This property is not supported by all devices. Refer to Supported Properties by Device for information


.. tip:: This property can use repeated capabilities. If set or get directly on the
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling set/get value on the result.

The following table lists the characteristics of this property.

+----------------+----------------------------------+
Expand All @@ -6661,7 +6713,7 @@ self_calibration_persistence
+----------------+----------------------------------+
| Permissions | read-write |
+----------------+----------------------------------+
| Channel Based | No |
| Channel Based | Yes |
+----------------+----------------------------------+
| Resettable | No |
+----------------+----------------------------------+
Expand Down Expand Up @@ -7134,6 +7186,14 @@ serial_number

Contains the serial number for the device you are currently using.




.. tip:: This property can use repeated capabilities. If set or get directly on the
nidcpower.Session object, then the set/get will use all repeated capabilities in the session.
You can specify a subset of repeated capabilities using the Python index notation on an
nidcpower.Session repeated capabilities container, and calling set/get value on the result.

The following table lists the characteristics of this property.

+----------------+-----------+
Expand All @@ -7143,7 +7203,7 @@ serial_number
+----------------+-----------+
| Permissions | read only |
+----------------+-----------+
| Channel Based | No |
| Channel Based | Yes |
+----------------+-----------+
| Resettable | No |
+----------------+-----------+
Expand Down
Loading