Table Of Contents

IviFgen Configure Standard Waveform [STD] (G Dataflow)

Version:
    Last Modified: October 24, 2017

    Configures the properties of the function generator that affect standard waveform generation. These properties are the waveform, amplitude, DC offset, frequency, and start phase.

    spd-note-note
    Note  

    This node is part of the IviFgenStdFunc [STD] extension group.

    connector_pane_image
    datatype_icon

    start phase (0.00 Degrees)

    Pass the horizontal offset of the standard waveform you want the the function generator to produce. You specify this property in degrees of one waveform cycle. The driver sets the IviFgen>>Standard Function Output>>Start Phase [STD] property to this value. A start phase of 180 degrees means output generation begins half way through the waveform. A start phase of 360 degrees offsets the output by an entire waveform cycle, which is identical to a start phase of 0 degrees. Units: Degrees of one cycle Default Value: 0.0 Notes: (1) This parameter does not affect function generator behavior when you set the Waveform parameter to IVIFGEN_VAL_WFM_DC.

    datatype_icon

    frequency (1000.0 Hz)

    Pass the frequency of the standard waveform that you want the function generator to produce. The driver sets the IviFgen>>Standard Function Output>>Frequency [STD] property to this value. Units: Hertz (Hz) Default Value: 1000.0 Hz Notes: (1) This parameter does not affect function generator behavior when you set the Waveform parameter to IVIFGEN_VAL_WFM_DC.

    datatype_icon

    dc offset (0.00 V)

    Pass the DC offset of the standard waveform that you want the function generator to produce. This value is the offset at the output terminal. The value is the offset from ground to the center of the waveform you specify with the Waveform parameter. The driver sets the IviFgen>>Standard Function Output>>DC Offset [STD] property to this value. For example, to configure a waveform with an amplitude of 10.00 volts to range from 0.00 volts to +10.00 volts, set the DC Offset to 5.00 volts. Units: Volts (V) Default Value: 0.0

    datatype_icon

    instrument handle

    The instrument handle that you obtain from the IviFgen Initialize or IviFgen Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    datatype_icon

    error in

    Error conditions that occur before this node runs.

    The node responds to this input according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Default: No error

    datatype_icon

    channel name ("CHANNEL1")

    Specifies the virtual channel name that you assign to the instrument in the Configuration Utility. Users who want to achieve interchangeability should use a virtual channel name. The virtual channel name should be sufficiently specific to the test system such that it is unlikely to conflict with a physical channel name. Virtual channel names are aliases for instrument-specific channel strings. The instrument-specific channel strings can differ from one instrument to another. Virtual channel names allow you to use and swap instruments without having to change the channel names in your source code. You assign a virtual channel name to an instrument-specific channel through the Configuration Utility. This control accepts virtual channel names you have assigned to the specific instrument you are using. It also accepts the instrument-specific channel names.

    Default: "CHANNEL1"

    datatype_icon

    waveform (Sine)

    Pass the standard waveform that you want the function generator to produce. The driver sets the IviFgen>>Standard Function Output>>Waveform [STD] property to this value. Valid Values: IVIFGEN_VAL_WFM_SINE - Sinusoid waveform IVIFGEN_VAL_WFM_SQUARE - Square waveform IVIFGEN_VAL_WFM_TRIANGLE - Triangle waveform IVIFGEN_VAL_WFM_RAMP_UP - Positive ramp waveform IVIFGEN_VAL_WFM_RAMP_DOWN - Negative ramp waveform IVIFGEN_VAL_WFM_DC - Constant voltage Default Value: IVIFGEN_VAL_WFM_SINE - Sinusoid waveform

    datatype_icon

    amplitude (1.00 V)

    Pass the amplitude of the standard waveform that you want the function generator to produce. This value is the amplitude at the output terminal. The driver sets the IviFgen>> Standard Function Output>>Amplitude [STD] property to this value. For example, to produce a waveform ranging from -5.00 to +5.00 volts, set the amplitude to 10.00 volts. Units: Volts peak-to-peak (Vpp) Default Value: 1.0V Notes: (1) This parameter does not affect function generator behavior when you set the Waveform parameter to IVIFGEN_VAL_WFM_DC.

    datatype_icon

    instrument handle out

    The instrument handle that you obtain from the IviFgen Initialize or IviFgen Initialize With Options Node. The handle identifies a particular instrument session.

    Default: None

    datatype_icon

    error out

    Error information.

    The node produces this output according to standard error behavior.

    Standard Error Behavior

    Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

    error in does not contain an error error in contains an error
    If no error occurred before the node runs, the node begins execution normally.

    If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

    If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

    Where This Node Can Run:

    Desktop OS: Windows

    FPGA: Not supported

    Web Server: Not supported in VIs that run in a web application


    Recently Viewed Topics