Table Of Contents

Initialize With Options (G Dataflow)

Version:
    Last Modified: August 3, 2017

    Creates a new IVI driver session, opens the session to the specified waveform generator, and sends initialization commands to set the hardware to the necessary state for NI-FGEN operations.

    Optionally sets the initial state of session properties Range Check, Cache, Simulate, Query Instrument Status, and Record Coercions.

    connector_pane_image
    datatype_icon

    option string

    Initial values of certain session properties.

    If you do not specify one of these properties, the default value is used.

    Property Name Property Defined Constant
    Simulate Instrument:Inherent IVI Attributes:User Options:Simulate
    RangeCheck Instrument:Inherent IVI Attributes:User Options:Range Check
    Cache Instrument:Inherent IVI Attributes:User Options:Cache
    QueryInstrStatus Instrument:Inherent IVI Attributes:User Options:Query Instrument Status

    option string Syntax

    option string uses the following syntax: attributeName=value

    where attributeName is the name of the attribute, and value is the value to which the attribute is set.

    To set multiple properties, separate them with a comma.

    If simulation is enabled (Simulate=1), you can specify the waveform generator that you want to simulate by entering the following syntax in option string:

    DriverSetup=Model:< driver model number >;BoardType:< module type >;MemorySize:< size of onboard memory in bytes >

    When you configure multichannel waveform generators, option string specifies which channels to initialize. Valid values include channel ranges (for example, "Channels:0-1") and individual channels (for example, "Channels:1").

    Table 1. option string Syntax Examples
    Waveform Generator Model option string Syntax
    PXI-5404 Simulate=1,DriverSetup=Model:5404;BoardType:PXI
    PCI-5421 Simulate=1,DriverSetup=Model:5421;BoardType:PCI;MemorySize:268435456
    PXIe-5450 Simulate=1,DriverSetup=Model:5450;Channels:0-1;BoardType:PXIe;MemorySize:268435456

    Default: Simulate = False (0), RangeCheck = True (1), Cache = True (1), QueryInstrStatus = True (1)

    datatype_icon

    resource name

    The instrument name. For example, "PXI1Slot3," where "PXI1Slot3" is an instrument name assigned by Measurement & Automation Explorer (MAX).

    You can wire in the name of an IVI logical name or an IVI virtual name configured with the IVI Configuration utility. A logical name identifies a particular virtual instrument. A virtual name identifies a specific instrument and specifies the initial settings for the session.

    All IVI names, such as logical names, are case-sensitive. If you use logical names, driver session names, or virtual names in your program, you must ensure that the name you use matches the name in the IVI Configuration Store file exactly, without any variations in the case of the characters.

    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

    id query

    Boolean value that specifies whether or not to verify that NI-FGEN supports the waveform generator you initialize.

    Circumstances can arise that make sending an ID query to the waveform generator undesirable.

    True The node queries the waveform generator ID and checks that the ID is valid for NI-FGEN.
    False The node initializes the waveform generator without performing an ID query.

    Default: True

    datatype_icon

    reset device

    Boolean value that specifies whether or not to reset the waveform generator during the initialization procedure.

    True The waveform generator resets to a known state.
    False The waveform generator does not reset.

    This input performs the same function as Reset.

    Default: True

    datatype_icon

    session out

    Reference to your instrument session to wire to the next node.

    datatype_icon

    error out

    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


    Recently Viewed Topics