Skip to content

NI FGEN Event Attributes

Palash Khare edited this page Jun 3, 2021 · 2 revisions

Event Attributes

NIFGEN_ATTRIBUTE_MARKER_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150312 ViString R/W N/A None niFgen_ExportSignal

Description

Specifies the destination terminal for the Marker event.

For a list of the terminals available on your device, refer to the Routes topic for your device or the Device Routes tab in MAX.

NIFGEN_ATTRIBUTE_MARKER_EVENT_OUTPUT_BEHAVIOR

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150342 ViInt32 R/W N/A None None

Description

Specifies the output behavior for the Marker event.

Defined Values

NIFGEN_VAL_PULSE Triggers a pulse for a specified period of time.
NIFGEN_VAL_LEVEL Changes to high or low while the event is active, depending on the active state you specify.

NIFGEN_ATTRIBUTE_MARKER_EVENT_PULSE_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150313 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Marker event.

Defined Values

NIFGEN_VAL_ACTIVE_HIGH The Marker event level is high at the marker position.
NIFGEN_VAL_ACTIVE_LOW The Marker event level is low at the marker position.

NIFGEN_ATTRIBUTE_MARKER_EVENT_PULSE_WIDTH_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150341 ViInt32 R/W N/A None None

Description

Specifies the pulse width units of the Marker event.

Defined Values

NIFGEN_VAL_SAMPLE_CLOCK_PERIODS Specifies the pulse width in Sample clock periods.
NIFGEN_VAL_SECONDS Specifies the pulse width in seconds.

NIFGEN_ATTRIBUTE_MARKER_EVENT_PULSE_WIDTH

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150340 ViReal64 R/W N/A None None

Description

Specifies the pulse width value of the Marker event.

NIFGEN_ATTRIBUTE_MARKER_EVENT_TOGGLE_INITIAL_STATE

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150343 ViInt32 R/W N/A None None

Description

Toggles the Initial state of the Marker event.

Defined Values

NIFGEN_VAL_HIGH Sets the initial state of the Marker event to high.
NIFGEN_VAL_LOW Sets the initial state of the Marker event to low.

NIFGEN_ATTRIBUTE_MARKER_EVENT_DELAY_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150355 ViInt32 R/W N/A None None

Description

Specifies the units applied to the value of the NIFGEN_ATTRIBUTE_MARKER_EVENT_DELAY attribute.

Defined Values

NIFGEN_VAL_SECONDS The delay is specified in seconds and then coerced up by NI-FGEN to the nearest Sample clock period.
NIFGEN_VAL_SAMPLE_CLOCK_PERIODS The delay is specified in Sample clock periods and then coerced up by NI-FGEN to the nearest Sample clock period.

Default Value: NIFGEN_VAL_SECONDS

NIFGEN_ATTRIBUTE_MARKER_EVENT_DELAY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150354 ViReal64 R/W N/A None None

Description

Specifies the amount of delay applied to a Marker event with respect to the analog output of the signal generator. A positive delay value indicates that the Marker event occurs after the analog data, while a negative delay value indicates that the Marker event precedes the analog data. The default value is zero, which aligns the Marker event with the analog output signal.

You can specify the units of the delay value by setting the NIFGEN_ATTRIBUTE_MARKER_EVENT_DELAY_UNITS attribute.

NIFGEN_ATTRIBUTE_MARKER_EVENT_LATCHED_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150350 ViBoolean R/W N/A None None

Description

Specifies the latched status of the specified Marker event.

Set this attribute to VI_FALSE to clear the latched status of the Marker event.

Defined Values

VI_TRUE The specified Marker event has been active.
VI_FALSE The specified Marker event has not been active.

NIFGEN_ATTRIBUTE_ALL_MARKER_EVENTS_LATCHED_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150349 ViInt32 R/W N/A None None

Description

Returns a bit field of the latched status of all Marker events. Set this attribute to 0 to clear the latched status of all Marker events.

Defined Values:

Marker 0 0x0
Marker 1 0x1
Marker 2 0x2
Marker 3 0x4

NIFGEN_ATTRIBUTE_MARKER_EVENT_LIVE_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150345 ViBoolean RO N/A None None

Description

Returns the live status of the specified Marker event.

Defined Values

VI_TRUE The specified Marker event is live.
VI_FALSE The specified Marker event is not live.

NIFGEN_ATTRIBUTE_ALL_MARKER_EVENTS_LIVE_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150344 ViInt32 RO N/A None None

Description

Returns a bit field of the live status of all Marker events.

Defined Values:

Marker 0 0x0
Marker 1 0x1
Marker 2 0x2
Marker 3 0x4

NIFGEN_ATTRIBUTE_DATA_MARKER_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150339 ViString R/W N/A None niFgen_ExportSignal

Description

Specifies the destination terminal for the Data Marker event. For a list of the destination terminals available on your device, refer to the Routes topic for your device or the the Device Routes tab in MAX.

NIFGEN_ATTRIBUTE_DATA_MARKER_EVENT_DATA_BIT_NUMBER

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150337 ViInt32 R/W N/A None None

Description

Specifies the bit number to assign to the Data Marker event.

NIFGEN_ATTRIBUTE_DATA_MARKER_EVENT_LEVEL_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150338 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Data Marker event. Refer to Data Marker Events for more information about Data Marker event polarity.

Defined Values

NIFGEN_VAL_ACTIVE_HIGH When the data bit is 1 (high), the Data Marker event level is high.
NIFGEN_VAL_ACTIVE_LOW When the data bit is 1 (high), the Data Marker event level is low.

NIFGEN_ATTRIBUTE_READY_FOR_START_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150310 ViString R/W N/A None niFgen_ExportSignal

Description

Specifies the destination terminal for the Ready for Start event. For a list of the terminals available on your device, refer to the Routes topic for your device or the Device Routes tab in MAX.

NIFGEN_ATTRIBUTE_READY_FOR_START_EVENT_LEVEL_ACTIVE_LEVEL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150311 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Ready for Start event.

Defined Values:

NIFGEN_VAL_ACTIVE_HIGH When the operation is ready to start, the Ready for Start event level is high.
NIFGEN_VAL_ACTIVE_LOW When the operation is ready to start, the Ready for Start event level is low.

NIFGEN_ATTRIBUTE_READY_FOR_START_EVENT_LIVE_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150348 ViBoolean RO N/A None None

Description

Returns the live status of the specified Ready For Start event.

Defined Values

VI_TRUE The specified Ready for Start event is live.
VI_FALSE The specified Ready for Start event is not live.

NIFGEN_ATTRIBUTE_STARTED_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150314 ViString R/W N/A None niFgen_ExportSignal

Description

Specifies the destination terminal for the Started event. For a list of the terminals available on your device, refer to the Routes topic for your device or the Device Routes tab in MAX.

NIFGEN_ATTRIBUTE_STARTED_EVENT_OUTPUT_BEHAVIOR

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150331 ViInt32 R/W N/A None None

Description

Specifies the output behavior for the Started event.

Defined Values

NIFGEN_VAL_PULSE Triggers a pulse for a specified period of time.
NIFGEN_VAL_LEVEL Shifts high or low while the event is active, depending on the active state you specify.

NIFGEN_ATTRIBUTE_STARTED_EVENT_PULSE_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150318 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Started event.

Defined Values

NIFGEN_VAL_ACTIVE_HIGH When the operation has started, the Started event level is high.
NIFGEN_VAL_ACTIVE_LOW When the operation has started, the Started event level is low.

NIFGEN_ATTRIBUTE_STARTED_EVENT_PULSE_WIDTH_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150333 ViInt32 R/W N/A None None

Description

Specifies the pulse width units for the Started event.

Defined Values:

NIFGEN_VAL_SAMPLE_CLOCK_PERIODS Specifies the pulse width in Sample clock periods.
NIFGEN_VAL_SECONDS Specifies the pulse width in seconds.

NIFGEN_ATTRIBUTE_STARTED_EVENT_PULSE_WIDTH

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150335 ViReal64 R/W N/A None None

Description

Specifies the pulse width value for the Started event.

NIFGEN_ATTRIBUTE_STARTED_EVENT_LEVEL_ACTIVE_LEVEL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150316 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Started event.

Defined Values:

NIFGEN_VAL_ACTIVE_HIGH When the operation has started, the Started event level is high.
NIFGEN_VAL_ACTIVE_LOW When the operation has started, the Started event level is low.

NIFGEN_ATTRIBUTE_STARTED_EVENT_DELAY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150356 ViReal64 R/W N/A None None

Description

Specifies the amount of delay applied to a Started event with respect to the analog output of the signal generator. A positive delay value specifies that the Started event occurs after the analog data, and a negative delay value specifies that the Started event occurs before the analog data. The default value is zero, which aligns the Started event with the analog output.

You can specify the units of the delay value by setting the NIFGEN_ATTRIBUTE_STARTED_EVENT_DELAY_UNITS attribute.

NIFGEN_ATTRIBUTE_STARTED_EVENT_DELAY_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150357 ViInt32 R/W N/A None None

Description

Specifies the units used for the NIFGEN_ATTRIBUTE_STARTED_EVENT_DELAY attribute.

Defined Values

NIFGEN_VAL_SECONDS Delay is specified in seconds and then coerced up by NI-FGEN to the nearest Sample clock period.
NIFGEN_VAL_SAMPLE_CLOCK_PERIODS Delay is specified in Sample clock periods and then coerced up by NI-FGEN to the nearest Sample clock period.

Default Value: NIFGEN_VAL_SECONDS

NIFGEN_ATTRIBUTE_STARTED_EVENT_LATCHED_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150352 ViBoolean RO N/A None None

Description

Returns the latched status of the Started event.

Defined Values

VI_TRUE The specified Started event has been active.
VI_FALSE The specified Started event has not been active.

NIFGEN_ATTRIBUTE_DONE_EVENT_OUTPUT_BEHAVIOR

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150332 ViInt32 R/W N/A None None

Description

Specifies the output behavior for the Done event.

Defined Values

NIFGEN_VAL_PULSE Triggers a pulse for a specified period of time.
NIFGEN_VAL_LEVEL Changes to high or low while the event is active, depending on the active state you specify.

NIFGEN_ATTRIBUTE_DONE_EVENT_OUTPUT_TERMINAL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150315 ViString R/W N/A None None

Description

Specifies the destination terminal for the Done event. For a list of the destination terminals available on your device, refer to the Routes topic for your device or the Device Routes tab in MAX.

NIFGEN_ATTRIBUTE_DONE_EVENT_PULSE_POLARITY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150319 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Done event.

Defined Values

NIFGEN_VAL_ACTIVE_HIGH When the operation is done, the Done event polarity is high.
NIFGEN_VAL_ACTIVE_LOW When the operation is done, the Done event polarity is low.

NIFGEN_ATTRIBUTE_DONE_EVENT_PULSE_WIDTH_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150334 ViInt32 R/W N/A None None

Description

Specifies the pulse width units for the Done event.

Defined Values

NIFGEN_VAL_SAMPLE_CLOCK_PERIODS Specifies the pulse width in Sample clock periods.
NIFGEN_VAL_SECONDS Specifies the pulse width in seconds.

NIFGEN_ATTRIBUTE_DONE_EVENT_PULSE_WIDTH

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150336 ViReal64 R/W N/A None None

Description

Specifies the pulse width for the Done event.

NIFGEN_ATTRIBUTE_DONE_EVENT_LEVEL_ACTIVE_LEVEL

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150317 ViInt32 R/W N/A None None

Description

Specifies the output polarity of the Done event.

Defined Values:

NIFGEN_VAL_ACTIVE_HIGH When the operation is complete, the Done event level is high.
NIFGEN_VAL_ACTIVE_LOW When the operation is complete, the Done event level is low.

NIFGEN_ATTRIBUTE_DONE_EVENT_DELAY

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150358 ViReal64 R/W N/A None None

Description

Specifies the amount of delay applied to a Done event with respect to the analog output of the signal generator.

A positive delay value indicates that the Done event occurs after the analog data, while a negative delay value indicates that the Done event occurs before the analog data. A value of zero aligns the Done event with the analog output. A value of zero aligns the Done event with the analog output signal.

You can specify the units of the delay value by setting the NIFGEN_ATTRIBUTE_DONE_EVENT_DELAY_UNITS attribute.

Default Value: 0

NIFGEN_ATTRIBUTE_DONE_EVENT_DELAY_UNITS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150359 ViInt32 R/W N/A None None

Description

Specifies the units applied to the value of the NIFGEN_ATTRIBUTE_DONE_EVENT_DELAY attribute.

Defined Values

NIFGEN_VAL_SECONDS The delay is specified in seconds and then coerced up by NI-FGEN to the nearest Sample clock period.
NIFGEN_VAL_SAMPLE_CLOCK_PERIODS The delay is specified in Sample clock periods and then coerced up by NI-FGEN to the nearest Sample clock period.

Default Value: NIFGEN_VAL_SECONDS

NIFGEN_ATTRIBUTE_DONE_EVENT_LATCHED_STATUS

Specific Attribute

Numeric Value Data
type
Access Applies to Coercion High Level Functions
1150351 ViBoolean RO N/A None None

Description

Returns the latched status of the specified Done event.

Defined Values

VI_TRUE The specified Done event is latched.
VI_FALSE The specified Done event is not latched.

Table of Contents

Internal Development

Creating and Setting Up a gRPC Server

Server Security Support

Creating a gRPC Client

gRPC Client Examples

Session Utilities API Reference

Driver Documentation

gRPC API Differences From C API

Sharing Driver Sessions Between Clients

C API Docs
NI-DAQmx
NI-DCPOWER
NI-DIGITAL PATTERN DRIVER
NI-DMM
NI-FGEN
NI-FPGA
NI-RFmx Bluetooth
NI-RFmx NR
NI-RFmx WCDMA
NI-RFmx GSM
NI-RFmx CDMA2k
NI-RFmx Instr
NI-RFmx LTE
NI-RFmx SpecAn
NI-RFmx TD-SCDMA
NI-RFmx WLAN
NI-RFSA
NI-RFSG
NI-SCOPE
NI-SWITCH
NI-TCLK
NI-XNET
Clone this wiki locally