Regatron.G5.Api.System.Sensing Class Reference

Public Member Functions
Boolean	EnableVoltageSensing ()
	Enable voltage sensing.
Boolean	DisableVoltageSensing ()
	Disable voltage sensing.
Boolean	IsVoltageSensingEnabled ()
	Returns whether the voltage sensing is enabled or not.
Single	GetMaximumVoltageCompensation ()
	Get maximum deviation of the device output voltage from voltage reference.
Boolean	SetMaximumVoltageCompensation (Single maximum)
	Set Maximum deviation of the device output voltage from voltage reference.
Boolean	EnableVoltageDropObservation ()
	Observation of sense voltage drop (difference between output voltage and sense voltage) is enabled.
Boolean	DisableVoltageDropObservation ()
	Observation of sense voltage drop (difference between output voltage and sense voltage) is disabled.
Boolean	IsVoltageDropObservationEnabled ()
	Observation of sense voltage drop (difference between output voltage and sense voltage) is disabled or enabled.
Single	GetVoltageDropObservationMaximumLevel ()
	If the difference between output voltage and sense voltage is larger than this value for the time specified by SenseVoltageDropObservationMaximumDelay, an error will be issued.
Boolean	SetVoltageDropObservationMaximumLevel (Single level)
	If the difference between output voltage and sense voltage is larger than this value for the time specified by SenseVoltageDropObservationMaximumDelay, an error will be issued.
Single	GetVoltageDropObservationMaximumDelay ()
	If the difference between output voltage and sense voltage is larger than the value specified by SenseVoltageDropObservationMaximumLevel for this period of time, an error will be issued.
Boolean	SetVoltageDropObservationMaximumDelay (Single delay)
	If the difference between output voltage and sense voltage is larger than the value specified by SenseVoltageDropObservationMaximumLevel for this period of time, an error will be issued.

Member Function Documentation

DisableVoltageDropObservation()

Boolean Regatron.G5.Api.System.Sensing.DisableVoltageDropObservation ( )

inline

Observation of sense voltage drop (difference between output voltage and sense voltage) is disabled.

Returns

Exceptions

G5ApiException

DisableVoltageSensing()

Boolean Regatron.G5.Api.System.Sensing.DisableVoltageSensing ( )

inline

Disable voltage sensing.

Returns

Exceptions

G5ApiException

EnableVoltageDropObservation()

Boolean Regatron.G5.Api.System.Sensing.EnableVoltageDropObservation ( )

inline

Observation of sense voltage drop (difference between output voltage and sense voltage) is enabled.

Returns

Exceptions

G5ApiException

EnableVoltageSensing()

Boolean Regatron.G5.Api.System.Sensing.EnableVoltageSensing ( )

inline

Enable voltage sensing.

Returns

Exceptions

G5ApiException

GetMaximumVoltageCompensation()

Single Regatron.G5.Api.System.Sensing.GetMaximumVoltageCompensation ( )

inline

Get maximum deviation of the device output voltage from voltage reference.

Returns

Exceptions

G5ApiException

GetVoltageDropObservationMaximumDelay()

Single Regatron.G5.Api.System.Sensing.GetVoltageDropObservationMaximumDelay ( )

inline

If the difference between output voltage and sense voltage is larger than the value specified by SenseVoltageDropObservationMaximumLevel for this period of time, an error will be issued.

Returns

Exceptions

G5ApiException

GetVoltageDropObservationMaximumLevel()

Single Regatron.G5.Api.System.Sensing.GetVoltageDropObservationMaximumLevel ( )

inline

If the difference between output voltage and sense voltage is larger than this value for the time specified by SenseVoltageDropObservationMaximumDelay, an error will be issued.

Returns

Exceptions

G5ApiException

IsVoltageDropObservationEnabled()

Boolean Regatron.G5.Api.System.Sensing.IsVoltageDropObservationEnabled ( )

inline

Observation of sense voltage drop (difference between output voltage and sense voltage) is disabled or enabled.

Returns

Exceptions

G5ApiException

IsVoltageSensingEnabled()

Boolean Regatron.G5.Api.System.Sensing.IsVoltageSensingEnabled ( )

inline

Returns whether the voltage sensing is enabled or not.

Returns

Exceptions

G5ApiException

SetMaximumVoltageCompensation()

Boolean Regatron.G5.Api.System.Sensing.SetMaximumVoltageCompensation ( Single maximum )

inline

Set Maximum deviation of the device output voltage from voltage reference.

Parameters

maximum

Returns

Exceptions

G5ApiException

SetVoltageDropObservationMaximumDelay()

Boolean Regatron.G5.Api.System.Sensing.SetVoltageDropObservationMaximumDelay ( Single delay )

inline

If the difference between output voltage and sense voltage is larger than the value specified by SenseVoltageDropObservationMaximumLevel for this period of time, an error will be issued.

Parameters

delay

Returns

Exceptions

G5ApiException

SetVoltageDropObservationMaximumLevel()

Boolean Regatron.G5.Api.System.Sensing.SetVoltageDropObservationMaximumLevel ( Single level )

inline

If the difference between output voltage and sense voltage is larger than this value for the time specified by SenseVoltageDropObservationMaximumDelay, an error will be issued.

Parameters

level

Returns

Exceptions

G5ApiException