![]() | Download Help (Windows Only) |
February 2018, 372659H-01
Use the NI-FGEN properties to access advanced configuration options for signal generator applications.
© 2008–2018 National Instruments. All rights reserved.
Property | Description | ||
---|---|---|---|
Active Channel |
Specifies the channel used to access all subsequent channel-based properties. You must set this property before setting any channel-based properties. Pass a name that the instrument driver defines or a virtual channel name defined in MAX. Details |
||
Output:Output Mode |
Specifies the output mode the signal generator uses. The output mode you specify determines which VIs and properties you use to configure the waveform the signal generator produces. Details |
||
Output:Output Enabled |
Specifies whether the signal that the signal generator produces appears at the output connector. Details |
||
Output:Digital Gain |
Specifies a factor by which the signal generator digitally multiplies generated data before converting it to an analog signal in the DAC. For a digital gain greater than 1.0, the product of digital gain times the generated data must be inside the range ±1.0, assuming floating point data. If the product exceeds these limits, the signal generator clips the output signal, and an error results. Details |
||
Output:Analog Path |
Specifies the analog signal path. The main path allows the user to configure gain, offset, analog filter status, output impedance, and output enable. Details |
||
Output:Load Impedance |
Specifies the load impedance connected to the analog output of the channel. Details |
||
Output:Output Impedance |
Specifies the output impedance of the signal generator at the output connector. NI signal generators have an output impedance of 50 ohms and an optional 75 ohms on select modules. Details |
||
Output:Terminal Configuration |
Specifies whether to analyze gain and offset values based on single-ended or differential operation. Details |
||
Output:Common Mode Offset |
Specifies the value the signal generator adds to or subtracts from the arbitrary waveform data. This property applies only when set the Terminal Configuration property to Differential. Common-mode offset is applied to the signals generated at each differential output terminal. Details |
||
Output:Channel Delay |
Specifies the delay to apply to the analog output of the channel specified by the Active Channel property. Details |
||
Output:Absolute Delay |
Specifies the sub-Sample Clock delay, in seconds, to apply to the waveform. Use this property to reduce the trigger jitter when synchronizing multiple devices with NI-TClk. This property can also help maintain synchronization repeatability by writing the absolute delay value of a previous measurement to the current session. Details |
||
Output:Filters:Analog Filter Enabled |
Specifies whether the signal generator applies an analog filter to the output signal. Set this property to TRUE to enable the filter. This property is valid in Arbitrary Waveform, Arbitrary Sequence, and Script output modes. You also can use this property in Standard Function and Frequency List output modes for user-defined waveforms. Default Value: FALSE Details |
||
Output:Filters:Digital Filter Enabled |
Specifies whether the signal generator applies a digital filter to the output signal. Set this property to TRUE to use a digital filter. This property is valid in Arbitrary Waveform, Arbitrary Sequence, and Script output modes. You also can use this property in Standard Function and Frequency List output modes for user-defined waveforms. Default Value: FALSE Details |
||
Output:Filters:Digital Filter Interpolation Factor |
Specifies the interpolation factor when the Digital Filter Enabled property is set to TRUE. Details |
||
Output:Filters:Flatness Correction Enabled |
Specify a value of TRUE to enable flatness correction. When flatness correction is enabled, the signal generator applies a flatness correction factor to the generated sine wave to ensure the same output power level at all frequencies. Set this property to FALSE when performing flatness calibration. Details |
||
Output:Data Mask:Analog Data Mask |
Specifies the mask to apply to the analog output data. The masked data is replaced with the data in the Analog Static Value property. Details |
||
Output:Data Mask:Analog Static Value |
Specifies the static value that replaces data masked by the Analog Data Mask property. Details |
||
Output:Data Mask:Digital Data Mask |
Specifies the mask to apply to the output on the digital connector. The masked data is replaced with the data in the Digital Static Value property. Details |
||
Output:Data Mask:Digital Static Value |
Specifies the static value that replaces data masked by the Digital Data Mask property. Details |
||
Output:Advanced:Digital Pattern Enabled |
Specifies whether the signal generator generates a digital pattern corresponding to the output signal. Set this property to TRUE to generate a digital pattern. Details |
||
Output:Advanced:AUX Power Enabled |
Controls the specified auxiliary power pin. Setting this property to TRUE energizes the auxiliary power when the session is committed. When this property is FALSE, the power pin of the connector outputs no power. Default Value: FALSE Details |
||
Output:Advanced:Idle Behavior |
Specifies the behavior of the output during the Idle state. Details |
||
Output:Advanced:Idle Value |
Specifies the value to generate in the Idle state. You must set the Idle Behavior property to Jump To Value to use this property. Details |
||
Output:Advanced:Wait Behavior |
Specifies the behavior of the output while waiting for a Script Trigger or during a wait instruction. Details |
||
Output:Advanced:Wait Value |
Specifies the value to generate while waiting. You must set the Wait Behavior property to Jump To Value to use this property. Details |
||
Arbitrary Waveform:Gain |
Specifies the factor by which the signal generator scales the arbitrary waveform data. When you create arbitrary waveforms, you must first normalize the data points to the range -1.0 to +1.0. Use this property to scale the arbitrary waveform to other ranges. Details |
||
Arbitrary Waveform:Offset |
Specifies the value the signal generator adds to the arbitrary waveform data. When you create arbitrary waveforms, you must first normalize the data points to the range -1.0 to +1.0. Use this property to shift the arbitrary waveform range. Details |
||
Arbitrary Waveform:Arbitrary Waveform Mode:Arbitrary Waveform Handle |
Selects which arbitrary waveform the signal generator produces. You can create multiple arbitrary waveforms using the niFgen Create Waveform VI. Details |
||
Arbitrary Waveform:Arbitrary Waveform Mode:Marker Position |
Specifies the position for a marker to be asserted in the arbitrary waveform. Details |
||
Arbitrary Waveform:Arbitrary Waveform Mode:Repeat Count |
Specifies the number of times to repeat the arbitrary waveform when the Trigger Mode parameter in the niFgen Configure Trigger Mode VI is set to Single or Stepped. Details |
||
Arbitrary Waveform:Arbitrary Sequence Mode:Arbitrary Sequence Handle |
Selects which sequence the signal generator produces. You can create multiple sequences using the niFgen Create Arbitrary Sequence VI. Details |
||
Arbitrary Waveform:Arbitrary Sequence Mode:Max Number of Sequences |
Returns the maximum number of arbitrary sequences the signal generator allows. Details |
||
Arbitrary Waveform:Arbitrary Sequence Mode:Max Sequence Length |
Returns the maximum number of arbitrary waveforms the signal generator allows in a sequence. Details |
||
Arbitrary Waveform:Arbitrary Sequence Mode:Min Sequence Length |
Returns the minimum number of arbitrary waveforms the signal generator allows in a sequence. Typically, this value is constant for the signal generator. Details |
||
Arbitrary Waveform:Arbitrary Sequence Mode:Max Loop Count |
Returns the maximum number of times the signal generator can repeat a waveform in a sequence. Typically, this value is constant for the signal generator. Details |
||
Arbitrary Waveform:Script Mode:Script to Generate |
Specifies which script the signal generator uses. To configure the signal generator to run a particular script, set this property to the name of the script. Details |
||
Arbitrary Waveform:Capabilities:Waveform Quantum |
Returns the quantum value the signal generator allows. The size of each arbitrary waveform must be a multiple of this quantum value. Details |
||
Arbitrary Waveform:Capabilities:Max Number of Waveforms |
Returns the maximum number of arbitrary waveforms that the signal generator allows. On some signal generators, this value may vary with remaining onboard memory. Details |
||
Arbitrary Waveform:Capabilities:Min Waveform Size |
Returns the minimum number of points the signal generator allows in an arbitrary waveform. Typically, this value is constant for the signal generator. Details |
||
Arbitrary Waveform:Capabilities:Max Waveform Size |
Returns the maximum number of points the signal generator allows in an arbitrary waveform. On some signal generators, this value may vary with remaining onboard memory. Details |
||
Arbitrary Waveform:Data Transfer:Data Transfer Block Size |
Specifies the number of samples at a time to download to onboard memory. This property is useful when the total data to be transferred to onboard memory is large. Details |
||
Arbitrary Waveform:Data Transfer:File Transfer Block Size |
Specifies the maximum number of samples to transfer at one time from the device to host memory. This property is used in conjunction with the niFgen Create Waveform From File VI and the niFgen Write Waveform From File VI. Details |
||
Arbitrary Waveform:Data Transfer:Maximum Bandwidth |
Specifies the maximum amount of bus bandwidth to use for data transfers. Details |
||
Arbitrary Waveform:Data Transfer:Direct DMA:Direct DMA Enabled |
Enables the device for Direct DMA writes. Details |
||
Arbitrary Waveform:Data Transfer:Direct DMA:Window Address |
Specifies the window address (beginning of window) of the waveform data source. This window address is specified by your Direct DMA-compatible data source. Details |
||
Arbitrary Waveform:Data Transfer:Direct DMA:Window Size in Bytes |
Specifies the size of the memory window provided by your Direct DMA-compatible data source. Details |
||
Arbitrary Waveform:Data Transfer:Streaming:Streaming Waveform Handle |
Specifies the waveform handle of the waveform used to continuously stream data during generation. Details |
||
Arbitrary Waveform:Data Transfer:Streaming:Streaming Waveform Name |
Specifies the name of the waveform used to continuously stream data during generation. This property defaults to an empty string when no streaming waveform is specified. Use this property in conjunction with the Space Available in Streaming Waveform property. Details |
||
Arbitrary Waveform:Data Transfer:Streaming:Space Available in Streaming Waveform |
Returns the space available in the streaming waveform for writing new data. Use this property in conjunction with the Streaming Waveform Handle property or the Streaming Waveform Name property. Details |
||
Arbitrary Waveform:Data Transfer:Streaming:Streaming Write Timeout |
Specifies the maximum amount of time allowed to complete a streaming write operation. Details |
||
Arbitrary Waveform:Data Transfer:Advanced:Maximum In-Flight Read Requests |
Specifies the maximum number of concurrent PCI Express read requests the signal generator can issue. Details |
||
Arbitrary Waveform:Data Transfer:Advanced:PCI DMA Optimizations Enabled |
Controls whether NI-FGEN allows performance optimizations for DMA transfers. This property is only valid for PCI and PXI SMC-based devices. This property is enabled (TRUE) by default, and NI recommends leaving it enabled. Details |
||
Arbitrary Waveform:Data Transfer:Advanced:Preferred Packet Size |
Specifies the preferred size of the data field in a PCI Express read request packet. Details |
||
Arbitrary Waveform:Onboard Signal Processing:OSP Enabled |
Enables (TRUE) or disables (FALSE) the OSP block of the signal generator. When the OSP block is disabled, all OSP-related properties are disabled and have no effect on the generated signal. Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Rate |
Specifies the rate at which the user-provided waveform data is generated when the OSP Enabled property is set to TRUE. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Data Processing Mode |
Controls the way that data is processed by the OSP block. Details |
||
Arbitrary Waveform:Onboard Signal Processing:OSP Mode |
Specifies the generation mode of the OSP, which determines the type of data contained in the output signal. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Carrier Enabled |
Enables (TRUE) or disables (FALSE) generation of the carrier. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Carrier Frequency |
Specifies the frequency of the generated carrier. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Frequency Shift |
Specifies the amount of frequency shift applied to the baseband signal. Details |
||
Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Filter Type |
Specifies the pulse-shaping filter type for the FIR filter. Details |
||
Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Flat:Passband |
Specifies the passband value to use when calculating the FIR filter coefficients. The FIR filter is designed to be flat to passband × I/Q rate. This property is used only when the Filter Type property is set to Flat. Details |
||
Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Raised Cosine:Alpha |
Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. This property is used only when the Filter Type property is set to Raised Cosine. Details |
||
Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Root Raised Cosine:Alpha |
Specifies the alpha value to use when calculating the pulse-shaping FIR filter coefficients. This property is used only when the Filter Type property is set to Root Raised Cosine. Details |
||
Arbitrary Waveform:Onboard Signal Processing:FIR Filter:Gaussian:BT |
Specifies the BT value to use when calculating the pulse-shaping FIR filter coefficients. The BT value is the product of the -3 dB bandwidth and the symbol period. This property is used only when the Filter Type property is set to Gaussian. Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Carrier Phase:Carrier Phase I |
Specifies the I carrier phase, in degrees, at the first point of the generated signal. Default Value: 0.0 Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Carrier Phase:Carrier Phase Q |
Specifies the Q carrier phase, in degrees, at the first point of the generated signal. This property is used only when the Data Processing Mode property is set to Complex. Default Value: -90.0 Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Gain:Pre-filter Gain I |
Specifies the digital gain to apply to the I data stream before any filtering by the OSP block. Valid Values: -2.0 to 2.0 Default Value: 1.0 Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Gain:Pre-filter Gain Q |
Specifies the digital gain to apply to the Q data stream before any filtering by the OSP block. This property is used only when the Data Processing Mode property is set to Complex. Valid Values: -2.0 to 2.0 Default Value: 1.0 Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Offset:Pre-filter Offset I |
Specifies the digital offset to apply to the I data stream. This offset is applied after the prefilter gain and before any filtering. Valid Values: -1.0 to 1.0 Default Value: 0.9 Details |
||
Arbitrary Waveform:Onboard Signal Processing:IQ Signal Adjustments:Offset:Pre-filter Offset Q |
Specifies the digital offset to apply to the Q data stream. This offset is applied after the prefilter gain and before any filtering. This property is only used when the Data Processing Mode property is set to Complex. Valid Values: -1.0 to 1.0 Default Value: 0.0 Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:FIR Filter Enabled |
Specify TRUE to enables the FIR filter. Specify FALSE to disable the FIR filter. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:FIR Interpolation Factor |
Specifies the interpolation factor for the FIR filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the IQ Rate property. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Filter Enabled |
Enables (TRUE) or disables (FALSE) the CIC filter. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Filter Gain |
Specifies the gain applied at the final stage of the CIC filter. This property is commonly used to compensate for attenuation in the FIR filter. If you set the FIR Filter Type to a value other than Custom, NI-FGEN calculates the CIC gain to achieve unity gain between the FIR and CIC filters. Setting this property overrides the value set by NI-FGEN. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:CIC Interpolation Factor |
Specifies the interpolation factor for the CIC filter. If you do not set this value, NI-FGEN calculates the appropriate value based on the value of the IQ Rate property. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:Compensate for Filter Group Delay |
Adjusts for OSP filter group delay when aligning analog outputs and events in OSP mode. If you set this property to TRUE, event outputs align more closely with the analog output. The analog output also aligns more closely between two devices synchronized using NI-TClk. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:OSP Overflow Error Reporting |
Configures error reporting when the OSP block detects an overflow in any of its stages. Overflows lead to waveform clipping. Details |
||
Arbitrary Waveform:Onboard Signal Processing:Advanced:OSP Overflow Status |
Returns a bit field of the overflow status in any stage of the OSP block. This property is functional regardless of the value for the OSP Overflow Error Reporting property. Set this property to 0 to clear the current OSP overflow status. Details |
||
Arbitrary Waveform:Peer-to-Peer:P2P Enabled |
Specifies whether the signal generator reads data from the peer-to-peer endpoint (TRUE) instead of reading it from the onboard memory. This property is endpoint based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Destination Channels |
Specifies which channels are written to by a peer-to-peer endpoint. If multiple channels are specified, data is deinterleaved to each channel. Channels are configured using the niFgen Configure Channels VI. This property is endpoint based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Endpoint Size |
Returns the size, in samples per channel, of the peer-to-peer endpoint. This property is endpoint-based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Space Available In Endpoint |
Returns the current space available in the endpoint in samples per channel. You can use this property when priming the endpoint with initial data through the niFgen Write P2P Endpoint I16 VI to determine how many samples you can write. You also can use this property to characterize the performance and measure the latency of the peer-to-peer stream as data moves across the bus. This property is endpoint-based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Most Space Available In Endpoint |
Returns the largest number of samples per channel available in the endpoint since this property was last read. This property can be used to determine how much endpoint space to use as a buffer against PCI Express bus traffic latencies by reading the property and keeping track of the largest value returned. This property is endpoint-based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Endpoint Count |
Returns the number of peer-to-peer FIFO endpoints supported by the device. Details |
||
Arbitrary Waveform:Peer-to-Peer:Data Transfer Permission Interval |
Specifies the interval, in samples per channel, at which the signal generator issues credits to allow the writer peer to transfer data over the bus into the configured endpoint. Refer to the Flow Control topic in the NI Signal Generators Help for more information. This property is coerced up by NI-FGEN to the nearest 128-byte boundary. This property is endpoint-based. Details |
||
Arbitrary Waveform:Peer-to-Peer:Data Transfer Permission Initial Credits |
Specifies the initial amount of data, in samples per channel, that the writer peer is allowed to transfer over the bus into the configured endpoint when the peer-to-peer data stream is enabled. If you do not set this property and the endpoint is empty, credits equal to the full size of the endpoint are issued to the writer peer. If data has been written to the endpoint using the niFgen Write P2P Endpoint I16 VI prior to enabling the stream, credits equal to the remaining space available in the endpoint are issued to the writer peer. This property is coerced up by NI-FGEN to 8-byte boundaries. Details |
||
Arbitrary Waveform:Peer-to-Peer:Manual:Manual Configuration Enabled |
Enables (TRUE) or disables (FALSE) manual configuration for a peer-to-peer endpoint. Enabling this property disables automatic NI-P2P stream manager flow control and Done Notifications. Details |
||
Arbitrary Waveform:Peer-to-Peer:Manual:Configuration:Data Transfer Permission Address |
Indicates the address in the writer peer to which the signal generator sends data transfer permission credits. This property is endpoint-based.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Configuration:Data Transfer Permission Address Type |
Specifies the type of address for the Data Transfer Permission Address property. This property is endpoint-based.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Configuration:Endpoint Window Address |
Returns the signal generator address where endpoint data is sent by the writer peer. The type of this address is specified by the Endpoint Window Address Type property. This property is endpoint-based.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Configuration:Endpoint Window Address Type |
Specifies the type of the Endpoint Window Address property. This property is endpoint-based.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Configuration:Endpoint Window Size |
Returns the size, in bytes, of the endpoint window. The endpoint window is also described by the Endpoint Window Address property and the Endpoint Window Address Type property. This property is endpoint-based.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Notification:Done Notification Address |
Returns the signal generator address to which the writer peer sends the Done Notification Value. This property is endpoint-based. Refer to the Stopping a Peer-to-Peer Generation topic in the NI Signal Generators Help for more information about using Done Notifications.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Notification:Done Notification Address Type |
Specifies the address type of the Done Notification Address property. This property is endpoint-based. Refer to the Stopping a Peer-to-Peer Generation topic in the NI Signal Generators Help for more information about using Done Notifications.
|
||
Arbitrary Waveform:Peer-to-Peer:Manual:Notification:Done Notification Value |
Returns the value the writer peer writes to the address specified by the Done Notification Address property. This property is endpoint-based. Refer to the Stopping a Peer-to-Peer Generation topic in the NI Signal Generators Help for more information about using Done Notifications.
|
||
Standard Function:Waveform |
Specifies which standard waveform the signal generator produces. Use this property only when the Output Mode property is set to NIFGEN_VAL_OUTPUT_FUNC. Details |
||
Standard Function:Amplitude |
Controls the amplitude of the standard waveform that the signal generator produces. This value is the amplitude at the output terminal. Details |
||
Standard Function:DC Offset |
Controls the DC offset of the standard waveform that the signal generator produces. Details |
||
Standard Function:Start Phase |
Controls horizontal offset of the standard waveform the signal generator produces. Specify this property in degrees of one waveform cycle. Details |
||
Standard Function:Duty Cycle High |
Specifies the duty cycle of the square wave the signal generator is producing. Specify this property as a percentage of the time the square wave is high in a cycle. Units: Percentage of time the waveform is high Default Value: 50% Details |
||
Standard Function:Sync Duty Cycle High |
Specifies the duty cycle of the square wave the signal generator produces on the SYNC OUT connector. Specify this property as a percentage of the time the square wave is high in each cycle. Units: Percentage of time the waveform is high Default Value: 50% Details |
||
Standard Function:Sync Out Output Terminal |
Specifies the terminal at which to export the SYNC OUT signal. This property is not supported for all devices. 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. Details |
||
Standard Function:Standard Function Mode:Frequency |
Controls the frequency of the standard waveform that the signal generator produces. Units: hertz (Hz) Default Value: None Details |
||
Standard Function:Standard Function Mode:Buffer Size |
Contains the number of samples used in the standard function waveform buffer. Details |
||
Standard Function:Standard Function Mode:Maximum Buffer Size |
Sets the maximum number of samples that can be used in the standard function waveform buffer. Increasing this value may increase the quality of the waveform but may also increase the amount of time required to change the waveform while running. Details |
||
Standard Function:Frequency List Mode:Frequency List Handle |
Sets which frequency list the signal generator produces. You create a frequency list using the niFgen Create Frequency List VI. The niFgen Create Frequency List VI returns a handle that you use to identify the list. Details |
||
Standard Function:Frequency List Mode:Maximum Number Of Frequency Lists |
Returns the maximum number of frequency lists that the signal generator allows. Details |
||
Standard Function:Frequency List Mode:Maximum Frequency List Length |
Returns the maximum number of steps that can be in a frequency list. Details |
||
Standard Function:Frequency List Mode:Minimum Frequency List Length |
Returns the minimum number of frequency lists that the signal generator allows. Details |
||
Standard Function:Frequency List Mode:Frequency List Duration Quantum |
Returns the quantum that all durations must be a multiple of in a frequency list. Details |
||
Standard Function:Frequency List Mode:Maximum Frequency List Duration |
Returns the maximum duration, in seconds, of any one step in the frequency list. Details |
||
Standard Function:Frequency List Mode:Minimum Frequency List Duration |
Returns the minimum duration, in seconds, of any one step in a frequency list. Details |
||
Clocks:Reference Clock:Source |
Specifies the Reference Clock source used by the signal generator. Details |
||
Clocks:Reference Clock:Frequency |
Specifies the Reference Clock frequency. The signal generator uses the Reference Clock to derive frequencies and sample rates when generating output. Details |
||
Clocks:Reference Clock:Export Output Terminal |
Specifies the terminal at which to export the Reference Clock. 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. Details |
||
Clocks:Reference Clock:Onboard Reference Clock:Export Output Terminal |
Specifies the terminal at which to export the onboard Reference Clock. 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. Details |
||
Clocks:Sample Clock:Rate |
Specifies the rate, in samples per second, at which the signal generator generates the points in arbitrary waveforms. Details |
||
Clocks:Sample Clock:Mode |
Specifies the Sample Clock mode for the signal generator. Details |
||
Clocks:Sample Clock:Source |
Specifies the Sample Clock source. Details |
||
Clocks:Sample Clock:Export Output Terminal |
Specifies the terminal at which to export the Sample Clock. If you specify a divisor with the Exported Sample Clock Divisor property, the Sample Clock exported with this property is the value of the Sample Clock after it is divided-down. 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. Details |
||
Clocks:Sample Clock:Exported Sample Clock Divisor |
Specifies the factor by which to divide the update (Sample) Clock before it is exported. Details |
||
Clocks:Sample Clock Timebase:Rate |
Specifies the Sample Clock Timebase rate. This property applies only to external Sample Clock timebases. Details |
||
Clocks:Sample Clock Timebase:Source |
Specifies the Sample Clock Timebase source. Details |
||
Clocks:Sample Clock Timebase:Export Output Terminal |
Specifies the terminal at which to export the Sample Clock Timebase. 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. Details |
||
Clocks:Sample Clock Timebase:Exported Sample Clock Timebase Divisor |
Specifies the factor by which to divide the device clock (Sample Clock timebase) before it is exported. Details |
||
Clocks:Advanced:External Sample Clock Multiplier |
Specifies a multiplication factor to use to obtain a desired sample rate from an external Sample Clock. Details |
||
Clocks:Advanced:Sample Clock Absolute Delay |
Specifies the delay in seconds to apply to an external Sample Clock. This property is useful when trying to align the output of two devices. Details |
||
Clocks:Advanced:External Clock Delay Binary Value |
Specifies the external clock delay binary value. Details |
||
Clocks:Advanced:Oscillator Phase DAC Value |
Specifies the oscillator phase DAC value. Details |
||
Events:Marker:Output Terminal |
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. Details |
||
Events:Marker:Output Behavior |
Specifies the output behavior for the Marker Event. Details |
||
Events:Marker:Pulse:Polarity |
Specifies the output polarity of the Marker Event. Details |
||
Events:Marker:Pulse:Width Units |
Specifies the pulse width units of the Marker Event. Details |
||
Events:Marker:Pulse:Width Value |
Specifies the pulse width value of the Marker Event. Set the units for the values with the Marker Event Pulse Width Units property. Details |
||
Events:Marker:Toggle:Initial State |
Specifies the initial state of the Marker Event. Details |
||
Events:Marker:Advanced:Delay Units |
Specifies the units used for the Marker Event Delay Value property. Details |
||
Events:Marker:Advanced:Delay Value |
Specifies the amount of delay applied to a Marker Event with respect to the analog output of the signal generator. Details |
||
Events:Marker:Advanced:Latched Status |
Specifies the latched status of the specified Marker Event. Set this property to FALSE to clear the latched status of the Marker Event. Details |
||
Events:Marker:Advanced:All Marker Events Latched Status |
Returns a bit field of the latched status of all Marker Events. Set this property to 0 to clear the latched status of all Marker Events. Details |
||
Events:Marker:Advanced:Live Status |
Returns TRUE if the status of the specified Marker Event is live, and FALSE otherwise. Details |
||
Events:Marker:Advanced:All Marker Events Live Status |
Returns a bit field of the live status of all Marker Events. Details |
||
Events:Data Marker:Output Terminal |
Specifies the destination terminal for the Data 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. Details |
||
Events:Data Marker:Data Bit Number |
Specifies the bit number to assign to the Data Marker Event. Details |
||
Events:Data Marker:Level:Active Level |
Specifies the output polarity of the Data Marker Event. Refer to Data Marker Events topic for more information about Data Marker Event polarity. Details |
||
Events:Ready For Start:Output Terminal |
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. Details |
||
Events:Ready For Start:Level:Active Level |
Specifies the output polarity of the Ready for Start Event. Details |
||
Events:Ready For Start:Advanced:Live Status |
Returns TRUE if the status of the specified Ready for Start Event is live, and FALSE otherwise. Details |
||
Events:Started:Output Terminal |
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. Details |
||
Events:Started:Output Behavior |
Specifies the output behavior for the Started Event. Details |
||
Events:Started:Pulse:Polarity |
Specifies the output polarity of the Started Event. Details |
||
Events:Started:Pulse:Width Units |
Specifies the pulse width units for the Started Event. Details |
||
Events:Started:Pulse:Width Value |
Specifies the pulse width value for the Started Event. Details |
||
Events:Started:Level:Active Level |
Specifies the output polarity of the Started Event. Details |
||
Events:Started:Advanced:Delay Units |
Specifies the units used for the Started Event Delay Value property. Details |
||
Events:Started:Advanced:Delay Value |
Specifies the amount of delay applied to a Started Event with respect to the analog output of the signal generator. Details |
||
Events:Started:Advanced:Latched Status |
Returns the latched status of the specified Started Event. Details |
||
Events:Done:Output Terminal |
Specifies the destination terminal for the Done 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. Details |
||
Events:Done:Output Behavior |
Specifies the output behavior for the Done Event. Details |
||
Events:Done:Pulse:Polarity |
Specifies the output polarity of the Done Event. Details |
||
Events:Done:Pulse:Width Units |
Specifies the pulse width units for the Done Event. Details |
||
Events:Done:Pulse:Width Value |
Specifies the pulse width for the Done Event. Details |
||
Events:Done:Level:Active Level |
Specifies the output polarity of the Done Event. Details |
||
Events:Done:Advanced:Delay Units |
Specifies the units used for the Done Event Delay Value property. Details |
||
Events:Done:Advanced:Delay Value |
Specifies the amount of delay applied to a Done Event with respect to the analog output of the signal generator. Details |
||
Events:Done:Advanced:Latched Status |
Returns the latched status of the specified Done Event. Details |
||
Triggers:Trigger Mode |
Controls the trigger mode. Details |
||
Triggers:Start:Trigger Type |
Specifies the type of Start Trigger you want to use. Details |
||
Triggers:Start:Output Terminal |
Specifies the destination terminal for exporting the Start Trigger. 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. Details |
||
Triggers:Start:Digital Edge:Source |
Specifies the source terminal for the Start Trigger. This property is used only when the Start Trigger Type property is set to Digital Edge. Details |
||
Triggers:Start:Digital Edge:Edge |
Specifies the active edge for the Start Trigger. This property is used only when the Start Trigger Type property is set to Digital Edge. Details |
||
Triggers:Start:P2P Endpoint Fullness:Level |
Specifies the number of samples the endpoint needs to receive before the signal generator starts generation. This property applies only when the Start Trigger Type property is set to P2P Endpoint Fullness. Refer to the Flow Control topic in the NI Signal Generators Help for more information about peer-to-peer operations. This property is coerced down to 8-byte boundaries. Details |
||
Triggers:Script:Trigger Type |
Specifies the Script trigger type. Depending upon the value of this property, additional properties may be needed to fully configure the trigger. Details |
||
Triggers:Script:Output Terminal |
Specifies the output terminal for the exported Script Trigger. Details |
||
Triggers:Script:Digital Edge:Source |
Specifies the source terminal for the Script Trigger. This property is used when the Script Trigger Type property is set to Digital Edge. Details |
||
Triggers:Script:Digital Edge:Edge |
Specifies the active edge for the Script Trigger. This property is used when the Script Trigger Type property is set to Digital Edge. Details |
||
Triggers:Script:Digital Level:Source |
Specifies the source terminal for the Script Trigger. This property is used when the Script Trigger Type property is set to Digital Level. Details |
||
Triggers:Script:Digital Level:Active Level |
Specifies the active level for the Script Trigger. This property is used when the Script Trigger Type property is set to Digital Level. Details |
||
Instrument:Bus Type |
Returns the bus type of the signal generator. Details |
||
Instrument:Memory Size |
Returns the amount of memory in bytes on the signal generator. Details |
||
Instrument:Serial Number |
Returns the serial number of the signal generator. Details |
||
Instrument:Marker Events Count |
Returns the number of markers supported by the device. Use this property when the Output Mode property is set to NIFGEN_VAL_OUTPUT_SCRIPT. Details |
||
Instrument:Data Marker Events Count |
Returns the number of Data Marker Events supported by the device. Details |
||
Instrument:Script Triggers Count |
Returns the number of Script Triggers supported by the device. Use this property when the Output Mode property is set to NIFGEN_VAL_OUTPUT_SCRIPT. Details |
||
Instrument:FPGA Bitfile Path |
Gets the absolute file path to the bitfile loaded on the FPGA. Details |
||
Instrument:Calibration:Cal ADC Input |
Specifies the input of the calibration ADC. The ADC can take a reading from several inputs: the analog output, a 2.5 V reference, and ground. The latter two inputs are used to calibrate the ADC itself. Details |
||
Instrument:Calibration:Gain DAC Value |
Specifies the value programmed to the Gain DAC. The value should be treated as an unsigned, right-justified number. Details |
||
Instrument:Calibration:Offset DAC Value |
Specifies the value programmed to the Offset DAC. The value should be treated as an unsigned, right-justified number. Details |
||
Instrument:Calibration:Oscillator Freq DAC Value |
Specifies the value programmed to the Oscillator DAC. The value should be treated as an unsigned, right-justified number. Details |
||
Instrument:Calibration:Pre-Amplifier Attenuation |
Specifies the amount of preamplifier attenuation to apply to the signal, in dB. Details |
||
Instrument:Calibration:Post-Amplifier Attenuation |
Specifies the amount of post-amplifier attenuation to apply to the signal, in dB. Details |
||
Instrument:Inherent IVI Attributes:User Options:Range Check |
Specifies whether to validate property values and VI parameters. Set this property to TRUE to enable range-checking. Details |
||
Instrument:Inherent IVI Attributes:User Options:Query Instrument Status |
Specifies whether NI-FGEN retains instrument status after each operation. Set this property to TRUE to query the instrument status. Details |
||
Instrument:Inherent IVI Attributes:User Options:Cache |
Specifies whether to cache the value of properties. Details |
||
Instrument:Inherent IVI Attributes:User Options:Simulate |
Specifies whether or not to simulate NI-FGEN I/O operations. Set this property to TRUE to enable simulation. Details |
||
Instrument:Inherent IVI Attributes:User Options:Record Value Coercions |
Specifies whether the IVI engine keeps a list of the value coercions it makes for ViInt32 and ViReal64 properties. Set this property to TRUE to record the coercions. Use the niFgen Initialize With Options VI to override this value. Details |
||
Instrument:Inherent IVI Attributes:User Options:Interchange Check |
Specifies whether to perform interchangeability checking and log interchangeability warnings when you call VIs. Set this property to TRUE to enable interchangeability checking. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Description |
Contains a brief description of the specific driver. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Driver Prefix |
Contains the prefix for NI-FGEN. The name of each user-callable VI in NI-FGEN starts with this prefix. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Driver Vendor |
Contains the name of the vendor that supplies NI-FGEN. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Revision |
Contains additional version information about NI-FGEN. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Class Specification Major Version |
Returns the major version number of the class specification with which NI-FGEN is compliant. Details |
||
Instrument:Inherent IVI Attributes:Driver Identification:Class Specification Minor Version |
Returns the minor version number of the class specification with which NI-FGEN is compliant. Details |
||
Instrument:Inherent IVI Attributes:Driver Capabilities:Supported Instrument Models |
Returns a model code of the instrument. For drivers that support more than one device, this property contains a comma-separated list of supported instrument models. Details |
||
Instrument:Inherent IVI Attributes:Driver Capabilities:Class Group Capabilities |
Returns a comma-separated list of class-extension groups that NI-FGEN implements. Details |
||
Instrument:Inherent IVI Attributes:Driver Capabilities:Channel Count |
Returns the number of channels that NI-FGEN supports. For each property for which IVI_VAL_MULTI_CHANNEL is set, the IVI engine maintains a separate cache value for each channel. Details |
||
Instrument:Inherent IVI Attributes:Instrument Identification:Manufacturer |
Returns the name of the instrument manufacturer you are currently using. Details |
||
Instrument:Inherent IVI Attributes:Instrument Identification:Model |
Returns the model number or name of the instrument that you are currently using. Details |
||
Instrument:Inherent IVI Attributes:Instrument Identification:Firmware Revision |
Returns the firmware revision information for the instrument you are currently using. Details |
||
Instrument:Inherent IVI Attributes:Instrument Identification:Module Revision |
Returns the revision letter of the module you are using. Details |
||
Instrument:Inherent IVI Attributes:Advanced Session Information:Logical Name |
Returns the logical name you specified when opening the current IVI session. Details |
||
Instrument:Inherent IVI Attributes:Advanced Session Information:Resource Descriptor |
Returns the resource descriptor NI-FGEN uses to identify the physical device. Details |
||
Instrument:5401/5411/5431:Filter Correction Frequency |
Specifies the filter correction frequency of the analog filter. This property can correct for the ripples in the analog filter frequency response at the frequency specified. Details |
||
Instrument:5401/5411/5431:Trigger Source |
Specifies which trigger source the signal generator uses. After you call the niFgen Initiate Generation VI, the signal generator waits for the trigger you specify in this parameter. After it receives a trigger, the signal generator produces the number of cycles you specify in the Repeat Count property. The value you select for this property is also the source for the trigger in the other trigger modes as specified by the Trigger Mode property. Details |
||
Instrument:5401/5411/5431:Synchronization Source |
Specifies the source of the synchronization signal to use. Details |
||
Instrument:5401/5411/5431:Video Waveform Type |
Specifies the waveform type the NI 5431 generates. Setting this property ensures the oscillator crystal is set to the proper frequency. Details |
||
Instrument:Obsolete:Major Version |
Returns the major version number of NI-FGEN. Details |
||
Instrument:Obsolete:Minor Version |
Returns the minor version number of NI-FGEN. Details |
||
Instrument:Obsolete:Error Elaboration |
Contains an optional string with additional information concerning the primary error condition. Details |
||
Instrument:Obsolete:Primary Error |
Describes the first error that occurred since the last call to the niFgen Error Message VI on the session. Details |
||
Instrument:Obsolete:Secondary Error |
Provides an optional code with additional information concerning the primary error condition. The error and warning values can be status codes defined by IVI, VISA, class drivers, or specific drivers. Zero indicates no additional information. Details |
||
Instrument:Obsolete:Operation Mode |
Specifies how the signal generator produces waveforms. NI signal generators currently support only one value: NIFGEN_VAL_OPERATE_CONTINUOUS. To control trigger mode, set the Trigger Mode property. Details |
||
Instrument:Obsolete:Ref Clock Source |
Controls the Reference Clock source the signal generator uses. Details |
||
Instrument:Obsolete:Update Clock Source |
Controls the Update Clock source. Details |
||
Instrument:Obsolete:Actual Arb Sample Rate |
Returns the actual sample rate value of the signal generator after any coercion or rounding. Details |
||
Instrument:Obsolete:DAQmx Task |
Returns the NI-DAQmx task pointer. Details |
Helpful
Not Helpful