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

This class is an optimized transport container of one curve's raw data. Use it if no internal components of the curve are to be used on the PC side (e.g. if only loading curve data from one TopCon, storing them on the PC and storing them on other TopCon devices. More...

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

Public Types

enum  FuncGenerytorType : int { FuncGenerytorType.Voltage = 0, FuncGenerytorType.Current = 1, FuncGenerytorType.Power = 2 }
 

Public Member Functions

String GetCurveName ()
 This method returns the curve name being stored in this curveContainer. More...
 
void SetCurveName (String newCurveName)
 This method sets the name of the curve in this container. More...
 
void SetCurveNumber (UInt32 newCurveNumber)
 This method alllows to set the number of this CurveContainer to a different value. Thus it allows to modify the CurveContainer in a way that the curve is written to a different place on the target TopCon device. More...
 
UInt32 GetCurveNumber ()
 This method returns the curve number being stored in this curveContainer. More...
 
DateTime GetCreationDateTime ()
 This method returns the cretion date / Time of the curve in this CurveContainer. More...
 
void SetCreationDateTime (DateTime newCreationDate)
 This method sets the creation date of this curve (in this curve container) to a new value. More...
 
Boolean GetGeneralEnable ()
 This method returns the value of the GeneralEnable bit in this curveContainer More...
 
bool CreateSasCalculatedCurveIuEn50530VocIsc (TC.SASTechnologyParamsEN50530 sasTechnologyParamsEn50530, uint cellTechnologyType, String name, double nominalIrradiance, double nominalTemperature, double openCircuitVoltage, double shortCircuitCurrent, ref Int32 error)
 
bool LoadFuncGenData ()
 
void SetGeneralEnable (Boolean booGenEnable)
 This method sets or resets the GeneralEnable Bit in the CurveContainer. More...
 
String GetCurveVersionAsString ()
 This method returns information about the curves version. Valid examples are:
0 - deprecated (Basic curve )
1 - deprecated
2 - TFE curves (incl. AAP) this is commonly used by TopControl 3 - SAS-Function (Commonly used by SASControl,
Extension 1 = MPP values only with Calculated SASCurves
Extension 2 = Ext.1 + MPP can be set for CustomSASCurves, too.) More...
 
bool SaveFuncGenData (UInt32 sequenceNummer)
 
FunctionAapData GetFunctionAapDataForFunctionBlock (FuncGenerytorType funcGenerytorType, int index)
 
FunctionBlock GetFunctionBlock (FuncGenerytorType funcGenerytorType)
 Get a FunctionBlock if extist, otherwiese null. More...
 
FunctionAapData GetLastFunctionAapDataForFunctionBlock (FuncGenerytorType funcGenerytorType)
 Get the last item from the collectionif extist, otherwiese null. More...
 
Boolean ContainsVoltageComponent ()
 This method determines if this CurveContainer is using a voltage curveComponent. More...
 
Boolean ContainsCurrentComponent ()
 This method determines if this CurveContainer is using a current curveComponent. More...
 
Boolean ContainsPowerComponent ()
 This method determines if this CurveContainer is using a power curveComponent. More...
 
CurveComponent.CurveComponentBaseFunctionType GetCurveComponentBaseFunctionType (CurveComponent.CurveComponentType curveComponentType)
 This method determines the base function type of this curveComponent.
All custom curves are considered to be AAP curve components as the SAS curve components are based on the AAP mechanism. More...
 
CurveComponent.CurveComponentType GetAapIndependentXAxisCurveComponentType (CurveComponent.CurveComponentType curveCompType)
 This method determines the INDEPENDENT (x axis) part of an AAP curveComponent in this curveContainer. More...
 
GeneralCurveType DetermineCurveType ()
 This function determines the CurveType in this urveContainer More...
 
void UpdateFromTfeCurve (TFECurve curve)
 Use this function as general method to update a curveContainer from a given TFE curve. More...
 
String ToString (Boolean addNewLines)
 This method returns the curveContainer. More...
 
String ToStringVoltageContainer (Boolean addNewLines)
 Return only the voltage part of this curveContainer container as ToString function. More...
 
String ToStringCurrentContainer (Boolean addNewLines)
 Return only the current part of this curveContainer container as ToString function. More...
 
String ToStringPowerContainer (Boolean addNewLines)
 Return only the power part of this curveContainer container as ToString function. More...
 
string GetLastError ()
 Get the last exception message. More...
 

Properties

string FunctionSequencerHeaderSequenceName [get]
 

Detailed Description

This class is an optimized transport container of one curve's raw data. Use it if no internal components of the curve are to be used on the PC side (e.g. if only loading curve data from one TopCon, storing them on the PC and storing them on other TopCon devices.

Member Enumeration Documentation

◆ FuncGenerytorType

Enumerator
Voltage 
  </summary> 
Current 
  </summary> 
Power 
  </summary> 

Member Function Documentation

◆ ContainsCurrentComponent()

Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsCurrentComponent ( )

This method determines if this CurveContainer is using a current curveComponent.

Returns

◆ ContainsPowerComponent()

Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsPowerComponent ( )

This method determines if this CurveContainer is using a power curveComponent.

Returns

◆ ContainsVoltageComponent()

Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsVoltageComponent ( )

This method determines if this CurveContainer is using a voltage curveComponent.

Returns

◆ CreateSasCalculatedCurveIuEn50530VocIsc()

bool CH.Regatron.HPPS.TFE.CurveContainer.CreateSasCalculatedCurveIuEn50530VocIsc ( TC.SASTechnologyParamsEN50530  sasTechnologyParamsEn50530,
uint  cellTechnologyType,
String  name,
double  nominalIrradiance,
double  nominalTemperature,
double  openCircuitVoltage,
double  shortCircuitCurrent,
ref Int32  error 
)

Parameters
sasTechnologyParamsEn50530
cellTechnologyType
name
nominalIrradiance
nominalTemperature
openCircuitVoltage
shortCircuitCurrent
error
Returns

◆ DetermineCurveType()

GeneralCurveType CH.Regatron.HPPS.TFE.CurveContainer.DetermineCurveType ( )

This function determines the CurveType in this urveContainer

Returns
The type of the curve in the CurveContainer:
1 = Sine

◆ GetAapIndependentXAxisCurveComponentType()

CurveComponent.CurveComponentType CH.Regatron.HPPS.TFE.CurveContainer.GetAapIndependentXAxisCurveComponentType ( CurveComponent.CurveComponentType  curveCompType)

This method determines the INDEPENDENT (x axis) part of an AAP curveComponent in this curveContainer.

Parameters
curveCompTypeDetermines the curveComponent to be used (voltage, current or power)
Returns
The curveComponentType of the independent part of that curveComponent.

◆ GetCreationDateTime()

DateTime CH.Regatron.HPPS.TFE.CurveContainer.GetCreationDateTime ( )

This method returns the cretion date / Time of the curve in this CurveContainer.

Returns
DateTime object that is created from the values in the CurveContainer.

◆ GetCurveComponentBaseFunctionType()

CurveComponent.CurveComponentBaseFunctionType CH.Regatron.HPPS.TFE.CurveContainer.GetCurveComponentBaseFunctionType ( CurveComponent.CurveComponentType  curveComponentType)

This method determines the base function type of this curveComponent.
All custom curves are considered to be AAP curve components as the SAS curve components are based on the AAP mechanism.

Parameters
curveComponentTypeSelects the curve component to be checked (VOLTAGE-, CURRENT-, POWERComponent
Returns
The type of the base function of this curveComponent (eg. rectangle, sinus, AAP, ...).

◆ GetCurveName()

String CH.Regatron.HPPS.TFE.CurveContainer.GetCurveName ( )

This method returns the curve name being stored in this curveContainer.

Returns
Name of the curve in this curveContainer.

◆ GetCurveNumber()

UInt32 CH.Regatron.HPPS.TFE.CurveContainer.GetCurveNumber ( )

This method returns the curve number being stored in this curveContainer.

Returns
Number of the curve in this curveContainer.

◆ GetCurveVersionAsString()

String CH.Regatron.HPPS.TFE.CurveContainer.GetCurveVersionAsString ( )

This method returns information about the curves version. Valid examples are:
0 - deprecated (Basic curve )
1 - deprecated
2 - TFE curves (incl. AAP) this is commonly used by TopControl 3 - SAS-Function (Commonly used by SASControl,
Extension 1 = MPP values only with Calculated SASCurves
Extension 2 = Ext.1 + MPP can be set for CustomSASCurves, too.)

Returns
String representing the actual version of this curve.

◆ GetFunctionAapDataForFunctionBlock()

FunctionAapData CH.Regatron.HPPS.TFE.CurveContainer.GetFunctionAapDataForFunctionBlock ( FuncGenerytorType  funcGenerytorType,
int  index 
)

Parameters
funcGenerytorType
index
Returns

◆ GetFunctionBlock()

FunctionBlock CH.Regatron.HPPS.TFE.CurveContainer.GetFunctionBlock ( FuncGenerytorType  funcGenerytorType)

Get a FunctionBlock if extist, otherwiese null.

Parameters
funcGenerytorType
Returns

◆ GetGeneralEnable()

Boolean CH.Regatron.HPPS.TFE.CurveContainer.GetGeneralEnable ( )

This method returns the value of the GeneralEnable bit in this curveContainer

Returns
true if the GeneralEnable bit of the curveContainer is 1, false otherwise.

◆ GetLastError()

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

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.

◆ GetLastFunctionAapDataForFunctionBlock()

FunctionAapData CH.Regatron.HPPS.TFE.CurveContainer.GetLastFunctionAapDataForFunctionBlock ( FuncGenerytorType  funcGenerytorType)

Get the last item from the collectionif extist, otherwiese null.

Parameters
funcGenerytorType
Returns

◆ LoadFuncGenData()

bool CH.Regatron.HPPS.TFE.CurveContainer.LoadFuncGenData ( )

Returns

◆ SaveFuncGenData()

bool CH.Regatron.HPPS.TFE.CurveContainer.SaveFuncGenData ( UInt32  sequenceNummer)

Parameters
sequenceNummer
Returns

◆ SetCreationDateTime()

void CH.Regatron.HPPS.TFE.CurveContainer.SetCreationDateTime ( DateTime  newCreationDate)

This method sets the creation date of this curve (in this curve container) to a new value.

Parameters
newCreationDateThe new date to be used with this curve.

◆ SetCurveName()

void CH.Regatron.HPPS.TFE.CurveContainer.SetCurveName ( String  newCurveName)

This method sets the name of the curve in this container.

Parameters
newCurveNameString that is to be used as new curve name.

◆ SetCurveNumber()

void CH.Regatron.HPPS.TFE.CurveContainer.SetCurveNumber ( UInt32  newCurveNumber)

This method alllows to set the number of this CurveContainer to a different value. Thus it allows to modify the CurveContainer in a way that the curve is written to a different place on the target TopCon device.

Parameters
newCurveNumberNumber of the curve to be used when once again accessing the curve (e.g. when storing curve on TopCon).

◆ SetGeneralEnable()

void CH.Regatron.HPPS.TFE.CurveContainer.SetGeneralEnable ( Boolean  booGenEnable)

This method sets or resets the GeneralEnable Bit in the CurveContainer.

Parameters
booGenEnableset to true for enable

◆ ToString()

String CH.Regatron.HPPS.TFE.CurveContainer.ToString ( Boolean  addNewLines)

This method returns the curveContainer.

Parameters
addNewLines
Returns

◆ ToStringCurrentContainer()

String CH.Regatron.HPPS.TFE.CurveContainer.ToStringCurrentContainer ( Boolean  addNewLines)

Return only the current part of this curveContainer container as ToString function.

Parameters
addNewLinesif true, a string representation of the current part is returned
Returns

◆ ToStringPowerContainer()

String CH.Regatron.HPPS.TFE.CurveContainer.ToStringPowerContainer ( Boolean  addNewLines)

Return only the power part of this curveContainer container as ToString function.

Parameters
addNewLinesif true, a string representation of the power part is returned
Returns

◆ ToStringVoltageContainer()

String CH.Regatron.HPPS.TFE.CurveContainer.ToStringVoltageContainer ( Boolean  addNewLines)

Return only the voltage part of this curveContainer container as ToString function.

Parameters
addNewLinesif true, a string representation of the voltage part is returned
Returns

◆ UpdateFromTfeCurve()

void CH.Regatron.HPPS.TFE.CurveContainer.UpdateFromTfeCurve ( TFECurve  curve)

Use this function as general method to update a curveContainer from a given TFE curve.

Parameters
curveThe curve to be used as source for updating the curveContainer.

Property Documentation

◆ FunctionSequencerHeaderSequenceName

string CH.Regatron.HPPS.TFE.CurveContainer.FunctionSequencerHeaderSequenceName
get