![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
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...
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] |
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.
|
strong |
Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsCurrentComponent | ( | ) |
This method determines if this CurveContainer is using a current curveComponent.
Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsPowerComponent | ( | ) |
This method determines if this CurveContainer is using a power curveComponent.
Boolean CH.Regatron.HPPS.TFE.CurveContainer.ContainsVoltageComponent | ( | ) |
This method determines if this CurveContainer is using a voltage curveComponent.
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 | ||
) |
sasTechnologyParamsEn50530 | |
cellTechnologyType | |
name | |
nominalIrradiance | |
nominalTemperature | |
openCircuitVoltage | |
shortCircuitCurrent | |
error |
GeneralCurveType CH.Regatron.HPPS.TFE.CurveContainer.DetermineCurveType | ( | ) |
This function determines the CurveType in this urveContainer
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.
curveCompType | Determines the curveComponent to be used (voltage, current or power) |
DateTime CH.Regatron.HPPS.TFE.CurveContainer.GetCreationDateTime | ( | ) |
This method returns the cretion date / Time of the curve in this CurveContainer.
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.
curveComponentType | Selects the curve component to be checked (VOLTAGE-, CURRENT-, POWERComponent |
String CH.Regatron.HPPS.TFE.CurveContainer.GetCurveName | ( | ) |
This method returns the curve name being stored in this curveContainer.
UInt32 CH.Regatron.HPPS.TFE.CurveContainer.GetCurveNumber | ( | ) |
This method returns the curve number being stored in this curveContainer.
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.)
FunctionAapData CH.Regatron.HPPS.TFE.CurveContainer.GetFunctionAapDataForFunctionBlock | ( | FuncGenerytorType | funcGenerytorType, |
int | index | ||
) |
funcGenerytorType | |
index |
FunctionBlock CH.Regatron.HPPS.TFE.CurveContainer.GetFunctionBlock | ( | FuncGenerytorType | funcGenerytorType | ) |
Boolean CH.Regatron.HPPS.TFE.CurveContainer.GetGeneralEnable | ( | ) |
This method returns the value of the GeneralEnable bit in this curveContainer
string CH.Regatron.HPPS.TFE.CurveContainer.GetLastError | ( | ) |
FunctionAapData CH.Regatron.HPPS.TFE.CurveContainer.GetLastFunctionAapDataForFunctionBlock | ( | FuncGenerytorType | funcGenerytorType | ) |
Get the last item from the collectionif extist, otherwiese null.
funcGenerytorType |
bool CH.Regatron.HPPS.TFE.CurveContainer.LoadFuncGenData | ( | ) |
bool CH.Regatron.HPPS.TFE.CurveContainer.SaveFuncGenData | ( | UInt32 | sequenceNummer | ) |
sequenceNummer |
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.
newCreationDate | The new date to be used with this curve. |
void CH.Regatron.HPPS.TFE.CurveContainer.SetCurveName | ( | String | newCurveName | ) |
This method sets the name of the curve in this container.
newCurveName | String that is to be used as new curve name. |
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.
newCurveNumber | Number of the curve to be used when once again accessing the curve (e.g. when storing curve on TopCon). |
void CH.Regatron.HPPS.TFE.CurveContainer.SetGeneralEnable | ( | Boolean | booGenEnable | ) |
This method sets or resets the GeneralEnable Bit in the CurveContainer.
booGenEnable | set to true for enable |
String CH.Regatron.HPPS.TFE.CurveContainer.ToString | ( | Boolean | addNewLines | ) |
This method returns the curveContainer.
addNewLines |
String CH.Regatron.HPPS.TFE.CurveContainer.ToStringCurrentContainer | ( | Boolean | addNewLines | ) |
Return only the current part of this curveContainer container as ToString function.
addNewLines | if true, a string representation of the current part is returned |
String CH.Regatron.HPPS.TFE.CurveContainer.ToStringPowerContainer | ( | Boolean | addNewLines | ) |
Return only the power part of this curveContainer container as ToString function.
addNewLines | if true, a string representation of the power part is returned |
String CH.Regatron.HPPS.TFE.CurveContainer.ToStringVoltageContainer | ( | Boolean | addNewLines | ) |
Return only the voltage part of this curveContainer container as ToString function.
addNewLines | if true, a string representation of the voltage part is returned |
void CH.Regatron.HPPS.TFE.CurveContainer.UpdateFromTfeCurve | ( | TFECurve | curve | ) |
Use this function as general method to update a curveContainer from a given TFE curve.
curve | The curve to be used as source for updating the curveContainer. |
|
get |