GxSmuSourceAdjustClampUnderLoad

Applies To

GX3116e

Purpose

Adjust the specified channel clamp to match the user’s specified clamp value and returns the actual adjusted clamp value (only while the channel’s output is connected to a load).

Syntax

GxSmuSourceAdjustClampUnderLoad (nHandle, nChannel, nClampType, nSettingsSpeed, dClampValue, pdAdjustedClampValue, pnStatus)

Parameters

Name
Type
Description
nHandle
SHORT
Handle to a GX3116e board.
nChannel
SHORT
Specifies channel number (0-15) is GX3116_CHANNEL_1 to GX3116_CHANNEL_16
nClampType
SHORT
When in constant Voltage mode:
0.      GX3116_CURRENT_CLAMP_SOURCE: the current source clamp value will be adjusted.
1.      GX3116_CURRENT_CLAMP_SINK: the current sink clamp value will be adjusted.
When in constant Current mode:
  • GX3116_VOLTAGE_CLAMP_HIGH: the high voltage clamp value will be adjusted.
  • GX3116_VOLTAGE_CLAMP_LOW: the low voltage clamp value will be adjusted.
nSettingsSpeed
SHORT
Settings Speed:
0.      GX3116_ADJUST_CLAMP_SPEED_FAST: adjustment time fast
1.      GX3116_ADJUST_CLAMP_SPEED_MODERATE: adjustment time moderately.
2.    GX3116_ADJUST_CLAMP_SPEED_SLOW: adjustment time slow
dClampValue
DOUBLE
Returns the actual adjusted clamp value (only while the channel’s output is connected to a load).
pdAdjustedClampValue
PDOUBLE
Returns the actual clamp value that correspond to the user clamp settings.
pnStatus
PSHORT
Returned status: 0 on success, negative number on failure.

Comments

The function adjust in real time when the channel’s output is connected to a load the clamp to match the user’s specified value. The function allows the user to set the adjustment speed to be Fast, Moderate, or Slow. The function returns the actual adjusted clamp value that will matches the specified user clamp value.

Note: by default when setting the clamp values using GxSmuSourceSetConstantVoltage() or GxSmuSourceSetVoltageClamps() APIs, the actual clamp voltage/current under load will always be under the specified value, that is why users; need to call this function in order to have an accurate clamp settings.

Example

The following example does the following:

 

SHORT nStatus;

DOUBLE dAdjustedClampValue;

 

GxSmuSourceSetConstantCurrent (nHandle, GX3116_CHANNEL_1, GX3116_SOURCE_CURRENT_RANGE_512MA, 200.0, 10.0, 0.0, &nStatus);

GxSmuSourceSetOutputStateEx(nHandle, GX3116_CHANNEL_1, GXSMU_SOURCE_OUTPUT_ON, 10.0, &nStatus);

GxSmuSourceAdjustClampUnderLoad(nHandle, GX3116_CHANNEL_1, GX3116_CURRENT_CLAMP_SOURCE, GX3116_ADJUST_CLAMP_SPEED_FAST, 100.0, &dAdjustedClampValue, &nStatus);

 

See Also

GxSmuSourceSetConstantCurrent, GxSmuSourceSetConstantVoltage, GxSmuSourceGetCurrent, GxSmuSourceSetCurrentLimit, GxSmuSourceSetCurrentClamps, GxSmuSourceSetCurrentRange, GxSmuSourceSetMode, GxSmuSourceSetOutputState, GxSmuSourceSetRangeMode, GxSmuSourceSetVoltage, GxSmuSourceSetVoltageLimit,  GxSmuGetErrorString