Table Of Contents

IviPwrMeter Read Channel [CH] (G Dataflow)

Version:
    Last Modified: October 24, 2017

    Initiates a measurement, waits until the power meter has returned to the Idle state, and returns the result of the measurement on the specified channel.

    After this node executes, the Reading parameter contains an actual reading on the channel specified by the Channel parameter. If the specified channel is not enabled for measurement, this node returns the Channel Not Enabled (0xBFFA2001) error. The Reading result is in the same unit as the value of the Units property.

    After this node executes, the Reading parameter may contain a value indicating that an out-of-range condition occurred. If an out-of-range condition occurs, the Result parameter contains an IEEE defined -Inf (Negative Infinity) or +Inf (Positive Infinity) value and the node returns the Under Range (0x3FFA2001) or Over Range (0x3FFA2002) warning. Test if the measurement value is out of range with the IviPwrMeter Query Result Range Type node.

    connector_pane_image
    datatype_icon

    reading

    The data read from the power meter.

    datatype_icon

    maximum time (5000 ms)

    Pass the maximum length of time in which to allow the read operation to complete. Express this value in milliseconds. If the operation does not complete within this time interval, the VI returns the IVIPWRMETER_ERROR_MAX_TIME_EXCEEDED (0xBFFA2020) error code. When this occurs, you can call IviPwrMeter Abort.vi to cancel the read operation and return the instrument to the Idle state. Defined Values: IVIPWRMETER_VAL_MAX_TIME_INFINITE (-1) - Wait indefinitely for a timeout. IVIPWRMETER_VAL_MAX_TIME_IMMEDIATE (0) - Do not wait for a timeout. Default Value: 5000 ms Notes: (1) The Maximum Time parameter affects only this VI. It has no effect on other timeout parameters or properties.

    datatype_icon

    channel name ("")

    The name of the channel from which to read the measurement. Pass the virtual channel name that you assign to the instrument in the Action 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 Value: ""

    datatype_icon

    instrument handle out

    Instrument handle that you obtain from IviPwrMeter Initialize or IviPwrMeter Initialize With Options. 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.
    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

    instrument handle

    Instrument handle that you obtain from IviPwrMeter Initialize or IviPwrMeter Initialize With Options. The handle identifies a particular instrument session.

    Default: None

    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