IviPwrMeter_Initiate
IviPwrMeterBase Capability Group
C Function Prototype
ViStatus IviPwrMeter_Initiate (ViSession vi);
Purpose
This function initiates a measurement on all enabled channels. When this function executes, the power meter leaves the Idle state and takes a measurement on all enabled channels. Use the IviPwrMeter_Fetch or IviPwrMeter_FetchChannel function to obtain the result of the measurements.
Notes:
(1) This function does not check the instrument status. Typically, you call this function only in a sequence of calls to other low-level driver functions. The sequence performs one operation. You use the low-level functions to optimize one or more aspects of interaction with the instrument. If you want to check the instrument status, call the IviPwrMeter_error_query function at the conclusion of the sequence.
(2) This function performs interchangeability checking when the IVIPWRMETER_ATTR_INTERCHANGE_CHECK attribute is set to VI_TRUE. You may use the NI Spy utility to view interchangeability warnings. Alternatively, you may use the IviPwrMeter_GetNextInterchangeWarning function to retrieve interchangeability warnings. For information on interchangeability checking, refer to the online help manual.
(3) The class driver initiates a simulated measurement when this function is called and the IVIPWRMETER_ATTR_SIMULATE attribute is set to VI_TRUE and the IVIPWRMETER_ATTR_USE_SPECIFIC_SIMULATION attribute is set to VI_FALSE. For information on how to configure a simulated measurement, refer to the online help manual.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviPwrMeter_init or IviPwrMeter_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |