This class contains the specific methods to configure a solar array simulation.
Other needed methods for automated testing can be found in:
Regatron.G5.Api.System.FunctionGenerator
Regatron.G5.Api.System.FunctionGeneratorBlockConfiguration
Regatron.G5.Api.System.FunctionGeneratorSequenceConfiguration
Regatron.G5.Api.System.FunctionGeneratorSequenceManagement
After configuring a solar array simulation you need to start the simulation with Regatron.G5.Api.System.FunctionGenerator.SetCommand More...

Public Member Functions
void	SetCsiCurveWithMppData (Single umpp, Single impp)
	Set a crystalline-silicon solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device. With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

void	SetCsiCurveWithUocAndIsc (Single uoc, Single isc)
	Set a crystalline-silicon solar cell curve according to EN50530 with the configured Uoc and Isc on the connected device. With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

void	SetThinFilmCurveWithMppData (Single umpp, Single impp)
	Set a thin film solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device. With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

void	SetThinFilmCurveWithUocAndIsc (Single uoc, Single isc)
	Set a thin film curve according to EN50530 with the configured Uoc and Isc on the connected device. With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

void	SetUserDefinedTechnologyCurveWithMppData (SolarArraySimulationCellTechnologyParameters cellTechnologyParameters, Single umpp, Single impp)
	Set an user defined technology parameter solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device. With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

void	SetUserDefinedTechnologyCurveWithUocAndIsc (SolarArraySimulationCellTechnologyParameters cellTechnologyParameters, Single uoc, Single isc)
	Set an user defined technology parameter solar cell according to EN50530 with the configured Uoc and Isc on the connected device. With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

void	SetCustomCurve (IList< Tuple< Single, Single > > curvePoints)
	Set a custom curve without temperature and irradiance lookup tables. The values for mpp voltage, mpp current, short circuit current and open circuit voltage are automatically calculated according to the given curve data points. Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc The data points must comply with the following conditions: 1) The first point must contain the short circuit current thus the voltage-value has to be zero. 2) The last point must contain the open circuit voltage thus the current-value has to be zero. 3) All data points must be sorted in ascending order by their voltage values. 4) Every voltage value is only allowed once.

void	SetCustomCurveArray (Point[] curvePoints)
	This method is only intended for use when no generics are supported by the actual environment. In all other cases Regatron.G5.Api.System.SolarArraySimulation.SetCustomCurve should be used. Set a custom curve without temperature and irradiance lookup tables. The values for mpp voltage, mpp current, short circuit current and open circuit voltage are automatically calculated according to the given curve data points. Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc The data points must comply with the following conditions: 1) The first point must contain the short circuit current thus the voltage-value has to be zero. 2) The last point must contain the open circuit voltage thus the current-value has to be zero. 3) All data points must be sorted in ascending order by their voltage values. 4) Every voltage value is only allowed once. .

void	SetActualIrradiance (Single actualIrradiance, Single rampTime)
	Set the actual irradiance for SAS curve simulation.

void	SetActualTemperature (Single actualTemperature, Single rampTime)
	Set the actual temperature for SAS curve simulation.

Single	GetRemainingTimeOfIrradianceRamp ()
	Get the remaining time of the irradiance transition ramp.

Single	GetRemainingTimeOfTemperatureRamp ()
	Get the remaining time of the temperature transition ramp.

Single	GetActualIrradiance ()
	Get the actual irradiance for SAS curve simulation.

Single	GetActualTemperature ()
	Get the actual temperature for SAS curve simulation.

Single	GetMppVoltage ()
	Get the actual value of the maximum power point voltage under consideration of irradiance and temperature.

Single	GetMppCurrent ()
	Get the actual value of the maximum power point current under consideration of irradiance and temperature.

Single	GetMppPower ()
	Get the actual value of the maximum power point power under consideration of irradiance and temperature.

Single	GetMppTrackingEfficiency ()
	Get the actual value of the maximum power point tracking efficiency on the device.

void	ResetMppTrackingEfficiency ()
	Resets the actual value of the maximum power point tracking efficiency on the device.

Single	GetCalculatedUoc ()
	Get the calculated open circuit voltage (Uoc) of the actual configured curve on the connected device.

Single	GetCalculatedIsc ()
	Get the calculated short circuit current (Isc) of the actual configured curve on the connected device.

Single	GetCalculatedMppVoltage ()
	Get the calculated maximum power point voltage of the actual configured curve on the connected device.

Single	GetCalculatedMppCurrent ()
	Get the calculated maximum power point current of the actual configured curve on the connected device.

SolarArraySimulationCellTechnologyParameters	GetCellTechnologyParameter ()
	Get the cell technology parameter of the actual configured curve on the connected device.

Detailed Description

This class contains the specific methods to configure a solar array simulation.
Other needed methods for automated testing can be found in:
Regatron.G5.Api.System.FunctionGenerator
Regatron.G5.Api.System.FunctionGeneratorBlockConfiguration
Regatron.G5.Api.System.FunctionGeneratorSequenceConfiguration
Regatron.G5.Api.System.FunctionGeneratorSequenceManagement
After configuring a solar array simulation you need to start the simulation with Regatron.G5.Api.System.FunctionGenerator.SetCommand

Member Function Documentation

◆ GetActualIrradiance()

Single Regatron.G5.Api.System.SolarArraySimulation.GetActualIrradiance ( )

inline

Get the actual irradiance for SAS curve simulation.

Returns: Actual irradiance [W/m^2]

Exceptions

G5ApiException

◆ GetActualTemperature()

Single Regatron.G5.Api.System.SolarArraySimulation.GetActualTemperature ( )

inline

Get the actual temperature for SAS curve simulation.

Returns: Actual temperature [°C]

Exceptions

G5ApiException

◆ GetCalculatedIsc()

Single Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc ( )

inline

Get the calculated short circuit current (Isc) of the actual configured curve on the connected device.

Returns: Short circuit current [A]

Exceptions

G5ApiException

◆ GetCalculatedMppCurrent()

Single Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent ( )

inline

Get the calculated maximum power point current of the actual configured curve on the connected device.

Returns: Maximum power point current [A]

Exceptions

G5ApiException

◆ GetCalculatedMppVoltage()

Single Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage ( )

inline

Get the calculated maximum power point voltage of the actual configured curve on the connected device.

Returns: Maximum power point voltage [V]

Exceptions

G5ApiException

◆ GetCalculatedUoc()

Single Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc ( )

inline

Get the calculated open circuit voltage (Uoc) of the actual configured curve on the connected device.

Returns: Open circuit voltage [V]

Exceptions

G5ApiException

◆ GetCellTechnologyParameter()

SolarArraySimulationCellTechnologyParameters Regatron.G5.Api.System.SolarArraySimulation.GetCellTechnologyParameter ( )

inline

Get the cell technology parameter of the actual configured curve on the connected device.

Exceptions

G5ApiException

◆ GetMppCurrent()

Single Regatron.G5.Api.System.SolarArraySimulation.GetMppCurrent ( )

inline

Get the actual value of the maximum power point current under consideration of irradiance and temperature.

Returns: Actual maximum power point current [A]

Exceptions

G5ApiException

◆ GetMppPower()

Single Regatron.G5.Api.System.SolarArraySimulation.GetMppPower ( )

inline

Get the actual value of the maximum power point power under consideration of irradiance and temperature.

Returns: Actual maximum power point power [W]

Exceptions

G5ApiException

◆ GetMppTrackingEfficiency()

Single Regatron.G5.Api.System.SolarArraySimulation.GetMppTrackingEfficiency ( )

inline

Get the actual value of the maximum power point tracking efficiency on the device.

Returns: Actual maximum power point tracking efficiency

Exceptions

G5ApiException

◆ GetMppVoltage()

Single Regatron.G5.Api.System.SolarArraySimulation.GetMppVoltage ( )

inline

Get the actual value of the maximum power point voltage under consideration of irradiance and temperature.

Returns: Actual maximum power point voltage [V]

Exceptions

G5ApiException

◆ GetRemainingTimeOfIrradianceRamp()

Single Regatron.G5.Api.System.SolarArraySimulation.GetRemainingTimeOfIrradianceRamp ( )

inline

Get the remaining time of the irradiance transition ramp.

Returns: Remaining ramp time [s]

Exceptions

G5ApiException

◆ GetRemainingTimeOfTemperatureRamp()

Single Regatron.G5.Api.System.SolarArraySimulation.GetRemainingTimeOfTemperatureRamp ( )

inline

Get the remaining time of the temperature transition ramp.

Returns: Remaining ramp time [s]

Exceptions

G5ApiException

◆ ResetMppTrackingEfficiency()

void Regatron.G5.Api.System.SolarArraySimulation.ResetMppTrackingEfficiency ( )

inline

Resets the actual value of the maximum power point tracking efficiency on the device.

Exceptions

G5ApiException

◆ SetActualIrradiance()

void Regatron.G5.Api.System.SolarArraySimulation.SetActualIrradiance	(	Single	actualIrradiance,
		Single	rampTime )

inline

Set the actual irradiance for SAS curve simulation.

Parameters

actualIrradiance	Actual irradiance [W/m^2]
rampTime	Ramp time to shift from the old value linearly to the new set value [s].

Exceptions

G5ApiException

◆ SetActualTemperature()

void Regatron.G5.Api.System.SolarArraySimulation.SetActualTemperature	(	Single	actualTemperature,
		Single	rampTime )

inline

Set the actual temperature for SAS curve simulation.

Parameters

actualTemperature	Actual temperature [°C]
rampTime	Ramp time to shift from the old value linearly to the new set value [s].

Exceptions

G5ApiException

◆ SetCsiCurveWithMppData()

void Regatron.G5.Api.System.SolarArraySimulation.SetCsiCurveWithMppData	(	Single	umpp,
		Single	impp )

inline

Set a crystalline-silicon solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device.
With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

Parameters

umpp	Maximum power point voltage [V]
impp	Maximum power point current [A]

Exceptions

G5ApiException

◆ SetCsiCurveWithUocAndIsc()

void Regatron.G5.Api.System.SolarArraySimulation.SetCsiCurveWithUocAndIsc	(	Single	uoc,
		Single	isc )

inline

Set a crystalline-silicon solar cell curve according to EN50530 with the configured Uoc and Isc on the connected device.
With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

Parameters

uoc	Open circuit voltage [V]
isc	Short circuit current [A]

Exceptions

G5ApiException

◆ SetCustomCurve()

void Regatron.G5.Api.System.SolarArraySimulation.SetCustomCurve ( IList< Tuple< Single, Single > > curvePoints )

inline

Set a custom curve without temperature and irradiance lookup tables.
The values for mpp voltage, mpp current, short circuit current and open circuit voltage are automatically
calculated according to the given curve data points.
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc
The data points must comply with the following conditions:
1) The first point must contain the short circuit current thus the voltage-value has to be zero.
2) The last point must contain the open circuit voltage thus the current-value has to be zero.
3) All data points must be sorted in ascending order by their voltage values.
4) Every voltage value is only allowed once.

Parameters

curvePoints Data points representing the characteristic voltage-current solar cell curve.
The x-values of the data points have to be in an ascending order and every x-value is only allowed once.

Exceptions

G5ApiException

◆ SetCustomCurveArray()

void Regatron.G5.Api.System.SolarArraySimulation.SetCustomCurveArray ( Point[] curvePoints )

inline

This method is only intended for use when no generics are supported by the actual environment.
In all other cases Regatron.G5.Api.System.SolarArraySimulation.SetCustomCurve should be used.
Set a custom curve without temperature and irradiance lookup tables.
The values for mpp voltage, mpp current, short circuit current and open circuit voltage are automatically
calculated according to the given curve data points.
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc
Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc
The data points must comply with the following conditions:
1) The first point must contain the short circuit current thus the voltage-value has to be zero.
2) The last point must contain the open circuit voltage thus the current-value has to be zero.
3) All data points must be sorted in ascending order by their voltage values.
4) Every voltage value is only allowed once.
.

Parameters

curvePoints Data points representing the characteristic voltage-current solar cell curve.
The x-values of the data points have to be in an ascending order and every x-value is only allowed once.

Exceptions

G5ApiException

◆ SetThinFilmCurveWithMppData()

void Regatron.G5.Api.System.SolarArraySimulation.SetThinFilmCurveWithMppData	(	Single	umpp,
		Single	impp )

inline

Set a thin film solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device.
With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

Parameters

umpp	Maximum power point voltage [V]
impp	Maximum power point current [A]

Exceptions

G5ApiException

◆ SetThinFilmCurveWithUocAndIsc()

void Regatron.G5.Api.System.SolarArraySimulation.SetThinFilmCurveWithUocAndIsc	(	Single	uoc,
		Single	isc )

inline

Set a thin film curve according to EN50530 with the configured Uoc and Isc on the connected device.
With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

Parameters

uoc	Open circuit voltage [V]
isc	Short circuit current [A]

Exceptions

G5ApiException

◆ SetUserDefinedTechnologyCurveWithMppData()

void Regatron.G5.Api.System.SolarArraySimulation.SetUserDefinedTechnologyCurveWithMppData	(	SolarArraySimulationCellTechnologyParameters	cellTechnologyParameters,
		Single	umpp,
		Single	impp )

inline

Set an user defined technology parameter solar cell curve according to EN50530 with the configured Umpp and Impp on the connected device.
With the given Umpp and Impp a curve is approximated. The calculated values for Umpp and Impp can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppVoltage and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedMppCurrent.

Parameters

cellTechnologyParameters	User defined solar cell technology parameters
umpp	Maximum power point voltage [V]
impp	Maximum power point current [A]

Exceptions

G5ApiException

The calculation of a solar array simulation curve using a user defined technology might fail if the technology parameter values differ too much from the defaults defined for cSi or Thin film.
Worst case the method call is blocked internally and will not return.

◆ SetUserDefinedTechnologyCurveWithUocAndIsc()

void Regatron.G5.Api.System.SolarArraySimulation.SetUserDefinedTechnologyCurveWithUocAndIsc	(	SolarArraySimulationCellTechnologyParameters	cellTechnologyParameters,
		Single	uoc,
		Single	isc )

inline

Set an user defined technology parameter solar cell according to EN50530 with the configured Uoc and Isc on the connected device.
With the given Uoc and Isc a curve is approximated. The calculated values for Uoc and Isc can be obtained afterwards with Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedUoc and Regatron.G5.Api.System.SolarArraySimulation.GetCalculatedIsc.

Parameters

cellTechnologyParameters	User defined solar cell technology parameters
uoc	Open circuit voltage [V]
isc	Short circuit current [A]

Exceptions

G5ApiException

The calculation of a solar array simulation curve using a user defined technology might fail if the technology parameter values differ too much from the defaults defined for cSi or Thin film.
Worst case the method call is blocked internally and will not return.

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetActualIrradiance()

◆ GetActualTemperature()

◆ GetCalculatedIsc()

◆ GetCalculatedMppCurrent()

◆ GetCalculatedMppVoltage()

◆ GetCalculatedUoc()

◆ GetCellTechnologyParameter()

◆ GetMppCurrent()

◆ GetMppPower()

◆ GetMppTrackingEfficiency()

◆ GetMppVoltage()

◆ GetRemainingTimeOfIrradianceRamp()

◆ GetRemainingTimeOfTemperatureRamp()

◆ ResetMppTrackingEfficiency()

◆ SetActualIrradiance()

◆ SetActualTemperature()

◆ SetCsiCurveWithMppData()

◆ SetCsiCurveWithUocAndIsc()

◆ SetCustomCurve()

◆ SetCustomCurveArray()

◆ SetThinFilmCurveWithMppData()

◆ SetThinFilmCurveWithUocAndIsc()

◆ SetUserDefinedTechnologyCurveWithMppData()

◆ SetUserDefinedTechnologyCurveWithUocAndIsc()