TopCon API  1.1.0
.Net API to control TopCon devices
CH.Regatron.HPPS.TFE.CurveFactory Class Reference

More...

Inheritance diagram for CH.Regatron.HPPS.TFE.CurveFactory:
Inheritance graph

Public Member Functions

string GetLastError ()
 Get the last exception message. More...
 

Static Public Member Functions

static TFECurve CreateTfeCurveFromCurveComponents (ReDev.TopCon topCon, UInt32 curveNumber, String curveName, DateTime creationDate, CurveComponent voltageComponent, CurveComponent currentComponent, CurveComponent powerComponent, Boolean generalEnable)
 This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents, at least 1 must be non-null and the generalEnable parameter. More...
 
static TFECurve CreateTfeCurveFromCurveComponents (ReDev.TopCon topCon, UInt32 curveNumber, String curveName, CurveComponent voltageComponent, CurveComponent currentComponent, CurveComponent powerComponent, Boolean generalEnable)
 This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents (at least 1 must be non-null) and the generalEnable parameter. This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents, at least 1 must be non-null and the generalEnable parameter. More...
 
static TFECurve CreateTfeCurveFromVoltageCurveComponents (ReDev.TopCon myTopCon, UInt32 curveNumber, String curveName, CurveComponent voltageComponent)
 This function creates a TFECurve with a single voltage curveContainer from a set of data: curveNumber, curveName, U curveComponents. More...
 
static TFECurve CreateTfeCurveFromActualCurveComponents (ReDev.TopCon myTopCon, UInt32 curveNumber, String curveName, CurveComponent currentComponent)
 This function creates a TFECurve with a single CURRENT curveContainer from a set of data: curveNumber, curveName, I curveComponents. More...
 
static ReTFE.TFECurve CreateTfeCurveFromPowerCurveComponents (ReDev.TopCon myTopCon, UInt32 curveNumber, String curveName, CurveComponent powerComponent)
 This function creates a TFECurve with a single POWER curveContainer from a set of data: curveNumber, curveName, P curveComponents. More...
 
static TFECurve CreateCustomSasCurve (ReDev.TopCon myTopCon, UInt32 newCurveNumber, String newCurveName, RegaSAS.CustomSASCurveComponent customSasComponent, Boolean generalEnable)
 This factory method allows to create a CUSTOM SASCurve from various 'ingredients: More...
 
static CurveContainer CreateCalculatedSasCurveAsCurveContainer (ReDev.TopCon topCon, UInt32 newCurveNumber, String newCurveName, Double openCircuitVoltage, Double shortcutCurrent, RegaSAS.SolarArrayTechnologyModel technologyModel)
 This method is the preferred way to create a CALCULATED SASCurve if it is ought to be brought to the TopCon device. The result of this method is a curveContainer (filled with the data of the calculated SASCurve) that can directly be sent to the TopCon flash. More...
 
static CurveContainer CreateCalculatedSasCurveAsCurveContainer (ReDev.TopCon topCon, UInt32 newCurveNumber, String newCurveName, RegaSAS.MPPData myMpp, RegaSAS.SolarArrayTechnologyModel technologyModel)
 This method is a convenience wrapper for the creation of a CALCULATED SASCurve. The result of this method is a curveContainer (filled with the data of the calculated SASCurve) that can directly be sent to the TopCon flash. More...
 
static TFECurve CreateCalculatedSasCurve (ReDev.TopCon topCon, UInt32 newCurveNumber, String newCurveName)
 

Detailed Description

Member Function Documentation

◆ CreateCalculatedSasCurve()

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateCalculatedSasCurve ( ReDev.TopCon  topCon,
UInt32  newCurveNumber,
String  newCurveName 
)
static

Parameters
topConReference to the parent TopCon object.
newCurveNumber
newCurveName
Returns

◆ CreateCalculatedSasCurveAsCurveContainer() [1/2]

static CurveContainer CH.Regatron.HPPS.TFE.CurveFactory.CreateCalculatedSasCurveAsCurveContainer ( ReDev.TopCon  topCon,
UInt32  newCurveNumber,
String  newCurveName,
Double  openCircuitVoltage,
Double  shortcutCurrent,
RegaSAS.SolarArrayTechnologyModel  technologyModel 
)
static

This method is the preferred way to create a CALCULATED SASCurve if it is ought to be brought to the TopCon device. The result of this method is a curveContainer (filled with the data of the calculated SASCurve) that can directly be sent to the TopCon flash.

Parameters
topConReference to the parent TopCon object.
newCurveNumberInteger number [1...999] to be used as index number for storing the curve in the TopCon flash.
newCurveNameName of the new curve [max length: 31 characters].
openCircuitVoltageOpen circuit voltage [Volts]
shortcutCurrentShortcut current [Amps]
technologyModel

Technology model [object derived from SolarArrayTechnologyModel].

Returns
The return value is an object that holds the content of the CALCULATED SASCurve.

◆ CreateCalculatedSasCurveAsCurveContainer() [2/2]

static CurveContainer CH.Regatron.HPPS.TFE.CurveFactory.CreateCalculatedSasCurveAsCurveContainer ( ReDev.TopCon  topCon,
UInt32  newCurveNumber,
String  newCurveName,
RegaSAS.MPPData  myMpp,
RegaSAS.SolarArrayTechnologyModel  technologyModel 
)
static

This method is a convenience wrapper for the creation of a CALCULATED SASCurve. The result of this method is a curveContainer (filled with the data of the calculated SASCurve) that can directly be sent to the TopCon flash.

Parameters
topConReference to the parent TopCon object.
newCurveNumberInteger number [1...999] to be used as index number for storing the curve in the TopCon flash.
newCurveNameName of the new curve [max length: 31 characters].
myMppThis is the definition of the MPP of this curve.
technologyModelTechnology model [object derived from SolarArrayTechnologyModel].
Returns
The return value is an object that holds the content of the CALCULATED SASCurve

◆ CreateCustomSasCurve()

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateCustomSasCurve ( ReDev.TopCon  myTopCon,
UInt32  newCurveNumber,
String  newCurveName,
RegaSAS.CustomSASCurveComponent  customSasComponent,
Boolean  generalEnable 
)
static

This factory method allows to create a CUSTOM SASCurve from various 'ingredients:

Parameters
myTopConReference to the parent TopCon object.
newCurveNumberInteger number [1...999] to be used as index number for storing the curve in the TopCon flash.
newCurveNameName of the new curve [max length: 31 characters].
customSasComponentA CustomSASCurveComponent that contains all data being needed to create a Custom SASDCurve.
generalEnableSelector to define if this curve is active or not. [true, false].
Returns
Curve representation that mirrors the data given.

◆ CreateTfeCurveFromActualCurveComponents()

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateTfeCurveFromActualCurveComponents ( ReDev.TopCon  myTopCon,
UInt32  curveNumber,
String  curveName,
CurveComponent  currentComponent 
)
static

This function creates a TFECurve with a single CURRENT curveContainer from a set of data: curveNumber, curveName, I curveComponents.

Parameters
myTopConReference to the parent TopCon object.
curveNumberUnsigned integer to identify the curve in the TopCon [1...999].
curveNameString with the (non-identifying) name of the curve [max. length: 31 characters].
currentComponentCurveComponent to define the operation of the current controller.
Returns
This factory function creates the matching curve.

◆ CreateTfeCurveFromCurveComponents() [1/2]

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateTfeCurveFromCurveComponents ( ReDev.TopCon  topCon,
UInt32  curveNumber,
String  curveName,
CurveComponent  voltageComponent,
CurveComponent  currentComponent,
CurveComponent  powerComponent,
Boolean  generalEnable 
)
static

This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents (at least 1 must be non-null) and the generalEnable parameter. This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents, at least 1 must be non-null and the generalEnable parameter.

Parameters
topConReference to the parent TopCon object.
curveNumberUnsigned integer to identify the curve in the TopCon [1...999].
curveNameString with the (non-identifying) name of the curve [max. length: 31 characters].
voltageComponentCurveComponent to define the operation of the voltage controller may be null.
currentComponentCurveComponent to define the operation of the voltage controller may be null.
powerComponentCurveComponent to define the operation of the voltage controller may be null.
generalEnableDefines if the curve is activated true or not false.
Returns
This factory function creates the matching curve.

◆ CreateTfeCurveFromCurveComponents() [2/2]

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateTfeCurveFromCurveComponents ( ReDev.TopCon  topCon,
UInt32  curveNumber,
String  curveName,
DateTime  creationDate,
CurveComponent  voltageComponent,
CurveComponent  currentComponent,
CurveComponent  powerComponent,
Boolean  generalEnable 
)
static

This function creates a TFECurve from a set of data:
curveNumber, curveName, U, I, P curveComponents, at least 1 must be non-null and the generalEnable parameter.

Parameters
topCon

Reference to the parent TopCon object.

Parameters
curveNumber

Unsigned integer to identify the curve in the TopCon [1...999].

Parameters
curveNameString with the non-identifying name of the curve [max. length: 31 characters].
creationDateThe creation DateTime of this curve.
voltageComponentCurveComponent to define the operation of the voltage controller may be null.
currentComponentCurveComponent to define the operation of the voltage controller may be null.
powerComponentCurveComponent to define the operation of the voltage controller may be null.
generalEnableDefines if the curve is activated true or not false.
Returns
This factory function creates the matching curve.

◆ CreateTfeCurveFromPowerCurveComponents()

static ReTFE.TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateTfeCurveFromPowerCurveComponents ( ReDev.TopCon  myTopCon,
UInt32  curveNumber,
String  curveName,
CurveComponent  powerComponent 
)
static

This function creates a TFECurve with a single POWER curveContainer from a set of data: curveNumber, curveName, P curveComponents.

Parameters
myTopConReference to the parent TopCon object.
curveNumberUnsigned integer to identify the curve in the TopCon [1...999].
curveNameString with the (non-identifying) name of the curve [max. length: 31 characters].
powerComponentCurveComponent to define the operation of the power controller.
Returns
This factory function creates the matching curve.

◆ CreateTfeCurveFromVoltageCurveComponents()

static TFECurve CH.Regatron.HPPS.TFE.CurveFactory.CreateTfeCurveFromVoltageCurveComponents ( ReDev.TopCon  myTopCon,
UInt32  curveNumber,
String  curveName,
CurveComponent  voltageComponent 
)
static

This function creates a TFECurve with a single voltage curveContainer from a set of data: curveNumber, curveName, U curveComponents.

Parameters
myTopConReference to the parent TopCon object.
curveNumberUnsigned integer to identify the curve in the TopCon [1...999].
curveNameString with the (non-identifying) name of the curve [max. length: 31 characters].
voltageComponentCurveComponent to define the operation of the voltage controller.
Returns
This factory function creates the matching curve.

◆ GetLastError()

string CH.Regatron.HPPS.TFE.CurveFactory.GetLastError ( )

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.