Regatron.G5.Api.System.OutputControl Class Reference

Public Member Functions
Boolean	IsSenseVoltageLimitActive ()
	Check if voltage sense limitation is active.
Boolean	IsSensePowerLimitActive ()
	Check if power sense limitation is active.
ControllerStatus	GetControllerStatus ()
	Get the status of the output controller.
float	GetVoltageControlLowCapacityParameterKp ()
	Get voltage controller parameter Kp (low capacity mode).
void	SetVoltageControlLowCapacityParameterKp (float kp)
	Set voltage controller parameter Kp (low capacity mode).
float	GetVoltageControlLowCapacityParameterTn ()
	Get voltage controller parameter Tn [s] (low capacity mode).
void	SetVoltageControlLowCapacityParameterTn (float tn)
	Set voltage controller parameter Tn [s] (low capacity mode).
float	GetVoltageControlHighCapacityParameterKp ()
	Get voltage controller parameter Kp (high capacity mode).
void	SetVoltageControlHighCapacityParameterKp (float kp)
	Set voltage controller parameter Kp (high capacity mode).
float	GetVoltageControlHighCapacityParameterTn ()
	Get voltage controller parameter Tn [s] (high capacity mode).
void	SetVoltageControlHighCapacityParameterTn (float tn)
	Set voltage controller parameter Tn [s] (high capacity mode).
float	GetCurrentControlParameterKp ()
	Get current controller parameter Kp.
void	SetCurrentControlParameterKp (float kp)
	Set current controller parameter Kp.
float	GetCurrentControlParameterTn ()
	Get current controller parameter Tn [s].
void	SetCurrentControlParameterTn (float tn)
	Set current controller parameter Tn [s].
float	GetPowerControlVoltageFilterParameterKp ()
	Get power controller voltage filter parameter Kp.
void	SetPowerControlVoltageFilterParameterKp (float kp)
	Set power controller voltage filter parameter Kp.
float	GetPowerControlVoltageFilterCutOffFrequency ()
	Get power controller voltage filter cut off frequency [Hz].
void	SetPowerControlVoltageFilterCutOffFrequency (float frequency)
	Set power controller voltage filter cut off frequency [Hz].
float	GetPowerControlCurrentFilterParameterKp ()
	Get power controller current filter parameter Kp.
void	SetPowerControlCurrentFilterParameterKp (float kp)
	Set power controller current filter parameter Kp.
float	GetPowerControlCurrentFilterCutOffFrequency ()
	Get power controller currnt filter cut off frequency [Hz].
void	SetPowerControlCurrentFilterCutOffFrequency (float frequency)
	Set power controller currnt filter cut off frequency [Hz].

Member Function Documentation

GetControllerStatus()

ControllerStatus Regatron.G5.Api.System.OutputControl.GetControllerStatus ( )

inline

Get the status of the output controller.

Returns

Returns the actual status of the output controller.

Exceptions

G5ApiException

GetCurrentControlParameterKp()

float Regatron.G5.Api.System.OutputControl.GetCurrentControlParameterKp ( )

inline

Get current controller parameter Kp.

Returns

Returns the value of the current controller parameter Kp.

Exceptions

G5ApiException

GetCurrentControlParameterTn()

float Regatron.G5.Api.System.OutputControl.GetCurrentControlParameterTn ( )

inline

Get current controller parameter Tn [s].

Returns

Returns the value of the current controller parameter Tn [s].

Exceptions

G5ApiException

GetPowerControlCurrentFilterCutOffFrequency()

float Regatron.G5.Api.System.OutputControl.GetPowerControlCurrentFilterCutOffFrequency ( )

inline

Get power controller currnt filter cut off frequency [Hz].

Returns

Returns the value of the power controller current filter cut off frequency [Hz].

Exceptions

G5ApiException

GetPowerControlCurrentFilterParameterKp()

float Regatron.G5.Api.System.OutputControl.GetPowerControlCurrentFilterParameterKp ( )

inline

Get power controller current filter parameter Kp.

Returns

Returns the value of the power controller current filter parameter Kp.

Exceptions

G5ApiException

GetPowerControlVoltageFilterCutOffFrequency()

float Regatron.G5.Api.System.OutputControl.GetPowerControlVoltageFilterCutOffFrequency ( )

inline

Get power controller voltage filter cut off frequency [Hz].

Returns

Returns the value of the power controller voltage filter cut off frequency [Hz].

Exceptions

G5ApiException

GetPowerControlVoltageFilterParameterKp()

float Regatron.G5.Api.System.OutputControl.GetPowerControlVoltageFilterParameterKp ( )

inline

Get power controller voltage filter parameter Kp.

Returns

Returns the value of the power controller voltage filter parameter Kp.

Exceptions

G5ApiException

GetVoltageControlHighCapacityParameterKp()

float Regatron.G5.Api.System.OutputControl.GetVoltageControlHighCapacityParameterKp ( )

inline

Get voltage controller parameter Kp (high capacity mode).

Returns

Returns the value of the voltage controller parameter Kp if high capacity mode is enabled.

Exceptions

G5ApiException

GetVoltageControlHighCapacityParameterTn()

float Regatron.G5.Api.System.OutputControl.GetVoltageControlHighCapacityParameterTn ( )

inline

Get voltage controller parameter Tn [s] (high capacity mode).

Returns

Returns the value of the voltage controller parameter Tn [s] if high capacity mode is enabled.

Exceptions

G5ApiException

GetVoltageControlLowCapacityParameterKp()

float Regatron.G5.Api.System.OutputControl.GetVoltageControlLowCapacityParameterKp ( )

inline

Get voltage controller parameter Kp (low capacity mode).

Returns

Returns the value of the voltage controller parameter Kp if high capacity mode is disabled.

Exceptions

G5ApiException

GetVoltageControlLowCapacityParameterTn()

float Regatron.G5.Api.System.OutputControl.GetVoltageControlLowCapacityParameterTn ( )

inline

Get voltage controller parameter Tn [s] (low capacity mode).

Returns

Returns the value of the voltage controller parameter Tn [s] if high capacity mode is disabled.

Exceptions

G5ApiException

IsSensePowerLimitActive()

Boolean Regatron.G5.Api.System.OutputControl.IsSensePowerLimitActive ( )

inline

Check if power sense limitation is active.

Returns

Returns true if the power sense limitation is active.

Exceptions

G5ApiException

IsSenseVoltageLimitActive()

Boolean Regatron.G5.Api.System.OutputControl.IsSenseVoltageLimitActive ( )

inline

Check if voltage sense limitation is active.

Returns

Returns true if the voltage sense limitation is active.

Exceptions

G5ApiException

SetCurrentControlParameterKp()

void Regatron.G5.Api.System.OutputControl.SetCurrentControlParameterKp ( float kp )

inline

Set current controller parameter Kp.

Exceptions

G5ApiException

SetCurrentControlParameterTn()

void Regatron.G5.Api.System.OutputControl.SetCurrentControlParameterTn ( float tn )

inline

Set current controller parameter Tn [s].

Exceptions

G5ApiException

SetPowerControlCurrentFilterCutOffFrequency()

void Regatron.G5.Api.System.OutputControl.SetPowerControlCurrentFilterCutOffFrequency ( float frequency )

inline

Set power controller currnt filter cut off frequency [Hz].

Exceptions

G5ApiException

SetPowerControlCurrentFilterParameterKp()

void Regatron.G5.Api.System.OutputControl.SetPowerControlCurrentFilterParameterKp ( float kp )

inline

Set power controller current filter parameter Kp.

Exceptions

G5ApiException

SetPowerControlVoltageFilterCutOffFrequency()

void Regatron.G5.Api.System.OutputControl.SetPowerControlVoltageFilterCutOffFrequency ( float frequency )

inline

Set power controller voltage filter cut off frequency [Hz].

Exceptions

G5ApiException

SetPowerControlVoltageFilterParameterKp()

void Regatron.G5.Api.System.OutputControl.SetPowerControlVoltageFilterParameterKp ( float kp )

inline

Set power controller voltage filter parameter Kp.

Exceptions

G5ApiException

SetVoltageControlHighCapacityParameterKp()

void Regatron.G5.Api.System.OutputControl.SetVoltageControlHighCapacityParameterKp ( float kp )

inline

Set voltage controller parameter Kp (high capacity mode).

Exceptions

G5ApiException

SetVoltageControlHighCapacityParameterTn()

void Regatron.G5.Api.System.OutputControl.SetVoltageControlHighCapacityParameterTn ( float tn )

inline

Set voltage controller parameter Tn [s] (high capacity mode).

Exceptions

G5ApiException

SetVoltageControlLowCapacityParameterKp()

void Regatron.G5.Api.System.OutputControl.SetVoltageControlLowCapacityParameterKp ( float kp )

inline

Set voltage controller parameter Kp (low capacity mode).

Exceptions

G5ApiException

SetVoltageControlLowCapacityParameterTn()

void Regatron.G5.Api.System.OutputControl.SetVoltageControlLowCapacityParameterTn ( float tn )

inline

Set voltage controller parameter Tn [s] (low capacity mode).

Exceptions

G5ApiException