Class SetupAndCleanupSteps
- Assembly
- NationalInstruments.SemiconductorTestLibrary.TestStandSteps.dll
Defines entry points for semiconductor setup and cleanup steps.
public static class SetupAndCleanupSteps
- Inheritance
-
SetupAndCleanupSteps
- Inherited Members
Methods
- CleanupInstrumentation(ISemiconductorModuleContext, bool, NIInstrumentType)
Closes any open instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset before closing the session (default = False). The sessions will always be closed in parallel. By default, theinstrumentType
input is set to All, which closes sessions for all instrument types in parallel. This can be configured to target a specific instrument type, which can be useful for debugging purposes and/or if there is a need to ensure sessions are closed sequentially (requiring multiple instances of this step). Note that the following types are supported: niDCPower, niDigitalPattern, niRelayDriver, niDAQmx, niDMM, niScope, niFGen, and niSync.
- ResetInstrumentation(ISemiconductorModuleContext, bool, NIInstrumentType)
Resets the instrument sessions for the specified
instrumentType
associated with the pin map by invoking the Reset() method of the supported instrument driver. By default, theinstrumentType
input is set to All, which targets all supported instrument types in parallel. This can be configured to target a specific instrument type, which can be useful for debugging purposes and/or if there is a need to ensure instruments are reset individually or sequentially (requiring multiple instances of this step). Note that the following types are supported: niDCPower, niDigitalPattern, niRelayDriver, niDMM, niScope, niFGen, and niSync. For instrumentation that also have the ResetDevice() method (hard reset), this can optionally be invoked instead of the Reset() method (soft-reset) if theresetDevice
input is set True (default = False): niDCPower, niDigitalPattern, niScope, and niFGen. Refer to the individual instrument driver documentation for more details.
- SetupNIDAQmxAIVoltageTask(ISemiconductorModuleContext, string, double, double, DAQmxTerminalConfiguration)
Initializes an NI DAQmx Analog Input Task associated with the pin map. The value of
taskType
string must match that of the DAQmx task definition within the pin map (default ="AI"). Note that the task will only be configured upon exiting this step, it will not be running.
- SetupNIDAQmxAOFGenVoltageTask(ISemiconductorModuleContext, string, AOFunctionGenerationType, double, double, double, DAQmxTerminalConfiguration)
Initializes an NI DAQmx Analog Output Function Generation Task associated with the pin map. The value of
taskType
string must match that of the DAQmx task definition within the pin map (default ="AOFuncGen"). Note that the task will only be configured upon exiting this step, it will not be running. This type of task is only supported by certain NI DAQmx hardware, such as the 4468.
- SetupNIDAQmxAOVoltageTask(ISemiconductorModuleContext, string, double, double, DAQmxTerminalConfiguration)
Initializes an NI DAQmx Analog Output Task associated with the pin map. The value of
taskType
string must match that of the DAQmx task definition within the pin map (default ="AO"). Note that the task will only be configured upon exiting this step, it will not be running.
- SetupNIDAQmxDITask(ISemiconductorModuleContext, string, ChannelLineGrouping)
Initializes an NI DAQmx Digital Input Task associated with the pin map. The value of
taskType
string must match that of the DAQmx task definition within the pin map (default ="DI"). Note that the task will only be configured upon exiting this step, it will not be running.
- SetupNIDAQmxDOTask(ISemiconductorModuleContext, string, ChannelLineGrouping)
Initializes an NI DAQmx Digital Output Task associated with the pin map. The value of
taskType
string must match that of the DAQmx task definition within the pin map (default ="DO"). Note that the task will only be configured upon exiting this step, it will not be running.
- SetupNIDCPowerInstrumentation(ISemiconductorModuleContext, bool, double, DCPowerMeasureApertureTimeUnits, DCPowerMeasurementWhen, DCPowerMeasurementSense, double, double)
Initializes the NI DCPower instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False). If thesourceDelay
is set to -1 the method will not set the source delay property, and will assume the initialized default value from the driver, which is expected to be the inverse of the power line frequency. If thepowerLineFrequency
is set to -1, the method will attempt to automatically determine the power line frequency and set the power line frequency property for the respective driver sessions. If the power line frequency cannot be determined, the property will not be set and the driver will use the default value of this property (60 Hz). This is currently only supported by systems that use a PXIe-109x chassis or newer.
- SetupNIDMMInstrumentation(ISemiconductorModuleContext, bool, DmmApertureTimeUnits, double, double, double, DMMMeasurementSettings?)
Initializes NI DMM instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False). If thepowerLineFrequency
is set to -1, the method will attempt to automatically determine the power line frequency and set the power line frequency property for the respective driver sessions. If the power line frequency cannot be determined, the property will not be set and the driver will use the default value of this property (60Hz). This is currently only supported by systems that use a PXIe-109x chassis or newer. If theinitialMeasurmentSettings
is specified, all DMM sessions will be configured to the specified measurement function (not configured by default).
- SetupNIDigitalPatternInstrumentation(ISemiconductorModuleContext, bool, string, string)
Initializes an NI Digital Pattern instrument sessions associated with the pin map. It loads in all digital project files associated with the digital project configured for the test program, this includes the: pin map, specifications, patterns, source waveforms, capture waveforms, timing sheets, and levels sheets. No sheets will be applied during this setup step unless specified by the
levelsSheetToApply
and/ortimingSheetToApply
inputs. Otherwise, the program will not assume to know loaded sheet to apply and will expect that the users program will apply the appropriate sheet(s) within a proceeding step. If theresetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False).
- SetupNIFGenInstrumentation(ISemiconductorModuleContext, bool)
Initializes NI FGEN instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False).
- SetupNIRelayModules(ISemiconductorModuleContext, bool, string)
Initializes NI Switch instrument sessions and NI DAQmx tasks associated with relay modules within the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False). If theinitialRelayConfigurationToApply
input is provided, the step will apply the specified relay configuration. Note that the relay configuration must be defined within the pin map, otherwise the step will throw an exception. Supported devices: PXI-2567 and PXIe-6368. This method expects each NI DAQmx task associated with relays in the pin map to have the Task Type set to "DAQmxRelay".
- SetupNIScopeInstrumentation(ISemiconductorModuleContext, bool)
Initializes NI Scope instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False).
- SetupNISyncInstrumentation(ISemiconductorModuleContext, bool)
Initializes the NI Sync instrument sessions associated with the pin map. If the
resetDevice
input is set to True, then the instrument will be reset as the session is initialized (default = False).