G5.Api 1.22.0.121
.Net API to control Regatron G5 devices
Loading...
Searching...
No Matches
Regatron.G5.Api.System.ReferenceValues Class Referencesealed

Public Member Functions

Single GetMinimumVoltage ()
 Get the lower limit of the DC output reference voltage.
 
void SetMinimumVoltage (Single voltage)
 Set the lower limit of the DC output reference voltage.
 
Single GetVoltage ()
 Get the DC output reference voltage.
 
void SetVoltage (Single voltage)
 Set the DC output reference voltage.
 
Single GetMaximumVoltage ()
 Get the upper limit of the DC output reference voltage.
 
void SetMaximumVoltage (Single voltage)
 Set the upper limit of the DC output reference voltage.
 
Single GetMinimumCurrent ()
 Get the lower limit of the DC output reference current.
 
void SetMinimumCurrent (Single current)
 Set the lower limit of the DC output reference current.
 
Single GetCurrent ()
 Get the DC output reference current.
 
void SetCurrent (Single current)
 Set the DC output reference current.
 
Single GetMaximumCurrent ()
 Get the upper limit of the DC output reference current.
 
void SetMaximumCurrent (Single current)
 Set the upper limit of the DC output reference current.
 
Single GetMinimumPower ()
 Get the lower limit of the DC output reference power.
 
void SetMinimumPower (Single power)
 Set the lower limit of the DC output reference power.
 
Single GetPower ()
 Get the DC output reference power.
 
void SetPower (Single power)
 Set the DC output reference power.
 
Single GetMaximumPower ()
 Get the upper limit of the DC output reference power.
 
void SetMaximumPower (Single power)
 Set the upper limit of the DC output reference power.
 
Single GetMinimumLoadResistance ()
 Get the lower limit of the reference load resistance.
 
Single GetLoadResistance ()
 Get the reference load resistance.
 
Boolean SetLoadResistance (Single resistance)
 Set the reference load resistance.
 
Single GetMaximumLoadResistance ()
 Get the upper limit of the reference load resistance.
 
Single GetMinimumInternalResistance ()
 Get the lower limit of the reference internal resistance.
 
Single GetInternalResistance ()
 Get the reference internal resistance.
 
void SetInternalResistance (Single resistance)
 Set the reference internal resistance.
 
Single GetMaximumInternalResistance ()
 Get the upper limit of the reference internal resistance.
 
Single GetMinimumInternalConductance ()
 Get the lower limit of the reference internal conductance.
 
Single GetInternalConductance ()
 Get the reference internal conductance.
 
Boolean SetInternalConductance (Single conductance)
 Set the reference internal conductance.
 
Single GetMaximumInternalConductance ()
 Get the upper limit of the reference internal conductance.
 
ControllerMode GetControllerMode ()
 Get the Output Controller mode.
 
void SetControllerMode (ControllerMode controllerMode)
 Set the output controller mode.
 
EquipmentUnderTestControlMode GetEquipmentUnderTestControlMode ()
 Get the Equipment Under Test control mode.
 
Boolean SetEquipmentUnderTestControlMode (EquipmentUnderTestControlMode mode)
 Set the Equipment Under Test control mode.
 
QuadrantMode GetQuadrantMode ()
 Get the quadrant mode.
 
Boolean SetQuadrantMode (QuadrantMode quadrantMode)
 Set the quadrant mode.
 
Single GetVoltageSlopeLimit ()
 Get the reference voltage slope.
 
void SetVoltageSlopeLimit (Single slope)
 Set the reference voltage slope.
 
Boolean EnableVoltageSlopeLimit ()
 Enable voltage slope limitation.
 
Boolean DisableVoltageSlopeLimit ()
 Disable voltage slope limitation.
 
Boolean IsVoltageSlopeLimitEnabled ()
 Get the status of the voltage slope limitation.
 
Single GetCurrentSlopeLimit ()
 Get the reference current slope.
 
void SetCurrentSlopeLimit (Single slope)
 Get the reference current slope.
 
Boolean EnableCurrentSlopeLimit ()
 Enable current slope limitation.
 
Boolean DisableCurrentSlopeLimit ()
 Disable current slope limitation.
 
Boolean IsCurrentSlopeLimitEnabled ()
 Get the status of the current slope limitation.
 
Single GetPowerSlopeLimit ()
 Get the reference power slope.
 
void SetPowerSlopeLimit (Single slope)
 Set the reference power slope.
 
Boolean EnablePowerSlopeLimit ()
 Enable power slope limitation.
 
Boolean DisablePowerSlopeLimit ()
 Disable power slope limitation.
 
Boolean IsPowerSlopeLimitEnabled ()
 Get the status of the power slope limitation.
 

Member Function Documentation

◆ DisableCurrentSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.DisableCurrentSlopeLimit ( )
inline

Disable current slope limitation.

Returns
Exceptions
G5ApiException

◆ DisablePowerSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.DisablePowerSlopeLimit ( )
inline

Disable power slope limitation.

Returns
Exceptions
G5ApiException

◆ DisableVoltageSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.DisableVoltageSlopeLimit ( )
inline

Disable voltage slope limitation.

Returns
Exceptions
G5ApiException

◆ EnableCurrentSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.EnableCurrentSlopeLimit ( )
inline

Enable current slope limitation.

Returns
Exceptions
G5ApiException

◆ EnablePowerSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.EnablePowerSlopeLimit ( )
inline

Enable power slope limitation.

Returns
Exceptions
G5ApiException

◆ EnableVoltageSlopeLimit()

Boolean Regatron.G5.Api.System.ReferenceValues.EnableVoltageSlopeLimit ( )
inline

Enable voltage slope limitation.

Returns
Exceptions
G5ApiException

◆ GetControllerMode()

ControllerMode Regatron.G5.Api.System.ReferenceValues.GetControllerMode ( )
inline

Get the Output Controller mode.

Returns
Controller mode.
Exceptions
G5ApiException

◆ GetCurrent()

Single Regatron.G5.Api.System.ReferenceValues.GetCurrent ( )
inline

Get the DC output reference current.

Returns
Reference current [A].
Exceptions
G5ApiException

◆ GetCurrentSlopeLimit()

Single Regatron.G5.Api.System.ReferenceValues.GetCurrentSlopeLimit ( )
inline

Get the reference current slope.

Returns
Reference current slope [A/ms].
Exceptions
G5ApiException

◆ GetEquipmentUnderTestControlMode()

EquipmentUnderTestControlMode Regatron.G5.Api.System.ReferenceValues.GetEquipmentUnderTestControlMode ( )
inline

Get the Equipment Under Test control mode.

Returns
EUT control mode.
Exceptions
G5ApiException

◆ GetInternalConductance()

Single Regatron.G5.Api.System.ReferenceValues.GetInternalConductance ( )
inline

Get the reference internal conductance.

Returns
Reference internal conductance [S].
Exceptions
G5ApiException

◆ GetInternalResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetInternalResistance ( )
inline

Get the reference internal resistance.

Returns
Reference internal resistance [Ω].
Exceptions
G5ApiException

◆ GetLoadResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetLoadResistance ( )
inline

Get the reference load resistance.

Returns
Reference load resistance [Ω].
Exceptions
G5ApiException

◆ GetMaximumCurrent()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumCurrent ( )
inline

Get the upper limit of the DC output reference current.

Returns
Current upper limit [A].
Exceptions
G5ApiException

◆ GetMaximumInternalConductance()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumInternalConductance ( )
inline

Get the upper limit of the reference internal conductance.

Returns
Internal conductance upper limit [S].
Exceptions
G5ApiException

◆ GetMaximumInternalResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumInternalResistance ( )
inline

Get the upper limit of the reference internal resistance.

Returns
Internal resistance upper limit [Ω].
Exceptions
G5ApiException

◆ GetMaximumLoadResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumLoadResistance ( )
inline

Get the upper limit of the reference load resistance.

Returns
Load Resistance upper limit [Ω].
Exceptions
G5ApiException

◆ GetMaximumPower()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumPower ( )
inline

Get the upper limit of the DC output reference power.

Returns
Power upper limit [W].
Exceptions
G5ApiException

◆ GetMaximumVoltage()

Single Regatron.G5.Api.System.ReferenceValues.GetMaximumVoltage ( )
inline

Get the upper limit of the DC output reference voltage.

Returns
Voltage upper limit [V].
Exceptions
G5ApiException

◆ GetMinimumCurrent()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumCurrent ( )
inline

Get the lower limit of the DC output reference current.

Returns
Current lower limit [A].
Exceptions
G5ApiException

◆ GetMinimumInternalConductance()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumInternalConductance ( )
inline

Get the lower limit of the reference internal conductance.

Returns
Internal conductance lower limit [S].
Exceptions
G5ApiException

◆ GetMinimumInternalResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumInternalResistance ( )
inline

Get the lower limit of the reference internal resistance.

Returns
Internal resistance lower limit [Ω].
Exceptions
G5ApiException

◆ GetMinimumLoadResistance()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumLoadResistance ( )
inline

Get the lower limit of the reference load resistance.

Returns
Load resistance lower limit [Ω].
Exceptions
G5ApiException

◆ GetMinimumPower()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumPower ( )
inline

Get the lower limit of the DC output reference power.

Returns
Power lower limit [W].
Exceptions
G5ApiException

◆ GetMinimumVoltage()

Single Regatron.G5.Api.System.ReferenceValues.GetMinimumVoltage ( )
inline

Get the lower limit of the DC output reference voltage.

Returns
Voltage lower limit [V].
Exceptions
G5ApiException

◆ GetPower()

Single Regatron.G5.Api.System.ReferenceValues.GetPower ( )
inline

Get the DC output reference power.

Returns
Reference power [W].
Exceptions
G5ApiException

◆ GetPowerSlopeLimit()

Single Regatron.G5.Api.System.ReferenceValues.GetPowerSlopeLimit ( )
inline

Get the reference power slope.

Returns
Reference power slope [W/ms].
Exceptions
G5ApiException

◆ GetQuadrantMode()

QuadrantMode Regatron.G5.Api.System.ReferenceValues.GetQuadrantMode ( )
inline

Get the quadrant mode.

Returns
Quadrant mode.
Exceptions
G5ApiException

◆ GetVoltage()

Single Regatron.G5.Api.System.ReferenceValues.GetVoltage ( )
inline

Get the DC output reference voltage.

Returns
Reference voltage [V].
Exceptions
G5ApiException

◆ GetVoltageSlopeLimit()

Single Regatron.G5.Api.System.ReferenceValues.GetVoltageSlopeLimit ( )
inline

Get the reference voltage slope.

Returns
Reference voltage slope [V/ms].
Exceptions
G5ApiException

◆ IsCurrentSlopeLimitEnabled()

Boolean Regatron.G5.Api.System.ReferenceValues.IsCurrentSlopeLimitEnabled ( )
inline

Get the status of the current slope limitation.

Returns
False: slope limitation is disabled (unlimited delta) True: slope limitation is enabled (limited delta)
Exceptions
G5ApiException

◆ IsPowerSlopeLimitEnabled()

Boolean Regatron.G5.Api.System.ReferenceValues.IsPowerSlopeLimitEnabled ( )
inline

Get the status of the power slope limitation.

Returns
False: slope limitation is disabled (unlimited delta) True: slope limitation is enabled (limited delta)
Exceptions
G5ApiException

◆ IsVoltageSlopeLimitEnabled()

Boolean Regatron.G5.Api.System.ReferenceValues.IsVoltageSlopeLimitEnabled ( )
inline

Get the status of the voltage slope limitation.

Returns
False: slope limitation is disabled (unlimited delta) True: slope limitation is enabled (limited delta)
Exceptions
G5ApiException

◆ SetControllerMode()

void Regatron.G5.Api.System.ReferenceValues.SetControllerMode ( ControllerMode controllerMode)
inline

Set the output controller mode.

Parameters
controllerModeController mode.
Exceptions
G5ApiException

◆ SetCurrent()

void Regatron.G5.Api.System.ReferenceValues.SetCurrent ( Single current)
inline

Set the DC output reference current.

Parameters
currentReference current [A].
Exceptions
G5ApiException

◆ SetCurrentSlopeLimit()

void Regatron.G5.Api.System.ReferenceValues.SetCurrentSlopeLimit ( Single slope)
inline

Get the reference current slope.

Parameters
slopeReference current slope [A/ms].
Exceptions
G5ApiException

◆ SetEquipmentUnderTestControlMode()

Boolean Regatron.G5.Api.System.ReferenceValues.SetEquipmentUnderTestControlMode ( EquipmentUnderTestControlMode mode)
inline

Set the Equipment Under Test control mode.

Parameters
modeEUT control mode.
Returns
Exceptions
G5ApiException

◆ SetInternalConductance()

Boolean Regatron.G5.Api.System.ReferenceValues.SetInternalConductance ( Single conductance)
inline

Set the reference internal conductance.

Parameters
conductanceInternal conductance reference [S].
Returns
Exceptions
G5ApiException

◆ SetInternalResistance()

void Regatron.G5.Api.System.ReferenceValues.SetInternalResistance ( Single resistance)
inline

Set the reference internal resistance.

Parameters
resistanceInternal resistance reference [Ω].
Exceptions
G5ApiException

◆ SetLoadResistance()

Boolean Regatron.G5.Api.System.ReferenceValues.SetLoadResistance ( Single resistance)
inline

Set the reference load resistance.

Parameters
resistanceLoad resistance reference [Ω].
Returns
Exceptions
G5ApiException

◆ SetMaximumCurrent()

void Regatron.G5.Api.System.ReferenceValues.SetMaximumCurrent ( Single current)
inline

Set the upper limit of the DC output reference current.

Parameters
currentCurrent upper limit [A].
Exceptions
G5ApiException

◆ SetMaximumPower()

void Regatron.G5.Api.System.ReferenceValues.SetMaximumPower ( Single power)
inline

Set the upper limit of the DC output reference power.

Parameters
powerPower upper limit [W].
Exceptions
G5ApiException

◆ SetMaximumVoltage()

void Regatron.G5.Api.System.ReferenceValues.SetMaximumVoltage ( Single voltage)
inline

Set the upper limit of the DC output reference voltage.

Parameters
voltageVoltage upper limit [V].
Exceptions
G5ApiException

◆ SetMinimumCurrent()

void Regatron.G5.Api.System.ReferenceValues.SetMinimumCurrent ( Single current)
inline

Set the lower limit of the DC output reference current.

Parameters
currentCurrent lower limit [A].
Exceptions
G5ApiException

◆ SetMinimumPower()

void Regatron.G5.Api.System.ReferenceValues.SetMinimumPower ( Single power)
inline

Set the lower limit of the DC output reference power.

Parameters
powerPower lower limit [W].
Exceptions
G5ApiException

◆ SetMinimumVoltage()

void Regatron.G5.Api.System.ReferenceValues.SetMinimumVoltage ( Single voltage)
inline

Set the lower limit of the DC output reference voltage.

Parameters
voltageVoltage lower limit [V].
Exceptions
G5ApiException

◆ SetPower()

void Regatron.G5.Api.System.ReferenceValues.SetPower ( Single power)
inline

Set the DC output reference power.

Parameters
powerReference power [W].
Exceptions
G5ApiException

◆ SetPowerSlopeLimit()

void Regatron.G5.Api.System.ReferenceValues.SetPowerSlopeLimit ( Single slope)
inline

Set the reference power slope.

Parameters
slopeReference power slope [W/ms].
Exceptions
G5ApiException

◆ SetQuadrantMode()

Boolean Regatron.G5.Api.System.ReferenceValues.SetQuadrantMode ( QuadrantMode quadrantMode)
inline

Set the quadrant mode.

Parameters
quadrantModeQuadrant mode.
Returns
Exceptions
G5ApiException

◆ SetVoltage()

void Regatron.G5.Api.System.ReferenceValues.SetVoltage ( Single voltage)
inline

Set the DC output reference voltage.

Parameters
voltageReference voltage [V].
Exceptions
G5ApiException

◆ SetVoltageSlopeLimit()

void Regatron.G5.Api.System.ReferenceValues.SetVoltageSlopeLimit ( Single slope)
inline

Set the reference voltage slope.

Parameters
slopeReference voltage slope [V/ms].
Exceptions
G5ApiException