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.

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

[NI-FGEN] Add back pulse width properties #2051

Merged
merged 7 commits into from
Apr 26, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,12 @@ All notable changes to this project will be documented in this file.
* #### Removed
* ### `nifgen` (NI-FGEN)
* #### Added
ni-juoca marked this conversation as resolved.
Show resolved Hide resolved
* `started_event_pulse_width` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* `done_event_pulse_width` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* `marker_event_pulse_width` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* `started_event_pulse_width_units` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* `done_event_pulse_width_units` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* `marker_event_pulse_width_units` - [#1873](https://github.com/ni/nimi-python/issues/1873)
* #### Changed
* #### Removed
* ### `nimodinst` (NI-ModInst)
Expand Down
174 changes: 174 additions & 0 deletions docs/nifgen/class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3705,6 +3705,56 @@ done_event_output_terminal
- LabVIEW Property: **Events:Done:Output Terminal**
- C Attribute: **NIFGEN_ATTR_DONE_EVENT_OUTPUT_TERMINAL**

done_event_pulse_width
----------------------

.. py:attribute:: done_event_pulse_width

Specifies the pulse width for the Done Event.

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Done:Pulse:Width Value**
- C Attribute: **NIFGEN_ATTR_DONE_EVENT_PULSE_WIDTH**

done_event_pulse_width_units
----------------------------

.. py:attribute:: done_event_pulse_width_units

Specifies the pulse width units for the Done Event.

The following table lists the characteristics of this property.

+-----------------------+--------------------------------+
| Characteristic | Value |
+=======================+================================+
| Datatype | enums.DoneEventPulseWidthUnits |
+-----------------------+--------------------------------+
| Permissions | read-write |
+-----------------------+--------------------------------+
| Repeated Capabilities | None |
+-----------------------+--------------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Done:Pulse:Width Units**
- C Attribute: **NIFGEN_ATTR_DONE_EVENT_PULSE_WIDTH_UNITS**

driver_setup
------------

Expand Down Expand Up @@ -4746,6 +4796,80 @@ marker_event_output_terminal
- LabVIEW Property: **Events:Marker:Output Terminal**
- C Attribute: **NIFGEN_ATTR_MARKER_EVENT_OUTPUT_TERMINAL**

marker_event_pulse_width
------------------------

.. py:attribute:: marker_event_pulse_width

Specifies the pulse width for the Marker Event.




.. tip:: This property can be set/get on specific markers within your :py:class:`nifgen.Session` instance.
Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: :py:attr:`my_session.markers[ ... ].marker_event_pulse_width`

To set/get on all markers, you can call the property directly on the :py:class:`nifgen.Session`.

Example: :py:attr:`my_session.marker_event_pulse_width`

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | markers |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Marker:Pulse:Width Value**
- C Attribute: **NIFGEN_ATTR_MARKER_EVENT_PULSE_WIDTH**

marker_event_pulse_width_units
------------------------------

.. py:attribute:: marker_event_pulse_width_units

Specifies the pulse width units for the Marker Event.




.. tip:: This property can be set/get on specific markers within your :py:class:`nifgen.Session` instance.
Use Python index notation on the repeated capabilities container markers to specify a subset.

Example: :py:attr:`my_session.markers[ ... ].marker_event_pulse_width_units`

To set/get on all markers, you can call the property directly on the :py:class:`nifgen.Session`.

Example: :py:attr:`my_session.marker_event_pulse_width_units`

The following table lists the characteristics of this property.

+-----------------------+----------------------------------+
| Characteristic | Value |
+=======================+==================================+
| Datatype | enums.MarkerEventPulseWidthUnits |
+-----------------------+----------------------------------+
| Permissions | read-write |
+-----------------------+----------------------------------+
| Repeated Capabilities | markers |
+-----------------------+----------------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Marker:Pulse:Width Units**
- C Attribute: **NIFGEN_ATTR_MARKER_EVENT_PULSE_WIDTH_UNITS**

max_freq_list_duration
----------------------

Expand Down Expand Up @@ -5693,6 +5817,56 @@ started_event_output_terminal
- LabVIEW Property: **Events:Started:Output Terminal**
- C Attribute: **NIFGEN_ATTR_STARTED_EVENT_OUTPUT_TERMINAL**

started_event_pulse_width
-------------------------

.. py:attribute:: started_event_pulse_width

Specifies the pulse width for the Started Event.

The following table lists the characteristics of this property.

+-----------------------+------------+
| Characteristic | Value |
+=======================+============+
| Datatype | float |
+-----------------------+------------+
| Permissions | read-write |
+-----------------------+------------+
| Repeated Capabilities | None |
+-----------------------+------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Started:Pulse:Width Value**
- C Attribute: **NIFGEN_ATTR_STARTED_EVENT_PULSE_WIDTH**

started_event_pulse_width_units
-------------------------------

.. py:attribute:: started_event_pulse_width_units

Specifies the pulse width units for the Started Event.

The following table lists the characteristics of this property.

+-----------------------+-----------------------------------+
| Characteristic | Value |
+=======================+===================================+
| Datatype | enums.StartedEventPulseWidthUnits |
+-----------------------+-----------------------------------+
| Permissions | read-write |
+-----------------------+-----------------------------------+
| Repeated Capabilities | None |
+-----------------------+-----------------------------------+

.. tip::
This property corresponds to the following LabVIEW Property or C Attribute:

- LabVIEW Property: **Events:Started:Pulse:Width Units**
- C Attribute: **NIFGEN_ATTR_STARTED_EVENT_PULSE_WIDTH_UNITS**

start_trigger_type
------------------

Expand Down
75 changes: 75 additions & 0 deletions docs/nifgen/enums.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,31 @@ DataMarkerEventLevelPolarity



DoneEventPulseWidthUnits
------------------------

.. py:class:: DoneEventPulseWidthUnits

.. py:attribute:: DoneEventPulseWidthUnits.SAMPLE_CLOCK_PERIODS



Specifies the pulse width in Sample clock periods.





.. py:attribute:: DoneEventPulseWidthUnits.SECONDS



Specifies the pulse width in seconds.





HardwareState
-------------

Expand Down Expand Up @@ -249,6 +274,31 @@ IdleBehavior



MarkerEventPulseWidthUnits
--------------------------

.. py:class:: MarkerEventPulseWidthUnits

.. py:attribute:: MarkerEventPulseWidthUnits.SAMPLE_CLOCK_PERIODS



Specifies the pulse width in Sample clock periods.





.. py:attribute:: MarkerEventPulseWidthUnits.SECONDS



Specifies the pulse width in seconds.





OutputMode
----------

Expand Down Expand Up @@ -677,6 +727,31 @@ StartTriggerType



StartedEventPulseWidthUnits
---------------------------

.. py:class:: StartedEventPulseWidthUnits

.. py:attribute:: StartedEventPulseWidthUnits.SAMPLE_CLOCK_PERIODS



Specifies the pulse width in Sample clock periods.





.. py:attribute:: StartedEventPulseWidthUnits.SECONDS



Specifies the pulse width in seconds.





TerminalConfiguration
---------------------

Expand Down
33 changes: 33 additions & 0 deletions generated/nifgen/nifgen/enums.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,17 @@ class DataMarkerEventLevelPolarity(Enum):
'''


class DoneEventPulseWidthUnits(Enum):
ni-juoca marked this conversation as resolved.
Show resolved Hide resolved
SAMPLE_CLOCK_PERIODS = 101
r'''
Specifies the pulse width in Sample clock periods.
'''
SECONDS = 102
r'''
Specifies the pulse width in seconds.
'''


class HardwareState(Enum):
IDLE = 0
WAITING_FOR_START_TRIGGER = 100
Expand All @@ -104,6 +115,17 @@ class IdleBehavior(Enum):
'''


class MarkerEventPulseWidthUnits(Enum):
SAMPLE_CLOCK_PERIODS = 101
r'''
Specifies the pulse width in Sample clock periods.
'''
SECONDS = 102
r'''
Specifies the pulse width in seconds.
'''


class OutputMode(Enum):
FUNC = 0
r'''
Expand Down Expand Up @@ -292,6 +314,17 @@ class StartTriggerType(Enum):
'''


class StartedEventPulseWidthUnits(Enum):
SAMPLE_CLOCK_PERIODS = 101
r'''
Specifies the pulse width in Sample clock periods.
'''
SECONDS = 102
r'''
Specifies the pulse width in seconds.
'''


class TerminalConfiguration(Enum):
SINGLE_ENDED = 300
r'''
Expand Down
730 changes: 361 additions & 369 deletions generated/nifgen/nifgen/nifgen_pb2.py

Large diffs are not rendered by default.

Loading
Loading