TopCon API  1.1.0
.Net API to control TopCon devices
CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent Class Reference

This is the main component (used as current functionBlock that makes up calculated SASCurve). More...

Inheritance diagram for CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent:
Inheritance graph

Public Member Functions

 CalculatedSASCurveComponent (ReDev.TopCon myTopCon)
 This is the simple constructor for this curve component. It implements the CURRENT component when using CALCULATED SASCurves. More...
 
 CalculatedSASCurveComponent (ReDev.TopCon myTopCon, TFE.AAPCurvePointList pointList, SolarArrayTechnologyModel techModel, MPPData mpp)
 This is the full constructor for this curve component. It implements the CURRENT component when using CALCULATED SASCurves. More...
 
SolarArrayTechnologyModel GetTechnologyModel ()
 This method returns the TechnologyModel set with this CalculatedSASCurve curveComponent. More...
 
Boolean IsTechnologyModelOfType_CSi ()
 This method checks if the TechnologyModel of this object is of type CSi_TechnologyModel (crystalline silicon). More...
 
Boolean IsTechnologyModelOfType_TF ()
 This method checks if the TechnologyModel of this object is of type TF_TechnologyModel (ThinFilm). More...
 
Boolean IsTechnologyModelOfType_UserDefined ()
 This method checks if the TechnologyModel of this object is of type UserDefined_TechnologyModel. More...
 
override void UpdateObjectFromCurveContainer (TFE.CurveContainer cc)
 This method updates the member variables inside of this object from the curveContainer given. More...
 
override String ToString ()
 This method returns a string with the representation of the Calculated SAS Curve in a short repesentation. More...
 
string GetLastError ()
 Get the last exception message. More...
 
- Public Member Functions inherited from CH.Regatron.HPPS.SolarArraySimulation.SASCurveComponent
static static SASCurveComponent (ReDev.TopCon myTopCon)
 This value is inherited to the SetMPPVoltage() method in CUSTOMSASCurveComponent (not to the CALCULATED ...one ) More...
 
 SASCurveComponent (ReDev.TopCon myTopCon, TFE.AAPCurvePointList pointList)
 This is the constructor for the SASCurveComponent object. It takes a predefined AAPCurvePointList as argument. Bot properties MPPvoltage and MPPCurrent are initialized with 0.0 [V] resp. [A]. More...
 
 SASCurveComponent (ReDev.TopCon myTopCon, TFE.AAPCurvePointList pointList, Double newMppVoltage, Double newMppCurrent)
 This is the standard constructor for the SASCurveComponent object. More...
 
Double GetMppVoltage ()
 The standard getter for the MPP voltage part of the MPP More...
 
Double GetMppCurrent ()
 Standard getter: this function returns the current value of the MPP of this curve. More...
 
MPPData GetMppData ()
 This method returns an MPPData object, that is created from the data in this SASCurveComponent. The user can access the contained values (MPP voltage, current, powre) with the related commands, this method returns one single object that contains that data (convenience function if an MPPData object is needed). More...
 
override void UpdateObjectFromCurveContainer (TFE.CurveContainer cc)
 This method reads the MPP voltage and MPP current from the curveContainer (given as parameter) and updates the internal properties. More...
 
override void UpdateCurveContainerFromObject (TFE.CurveContainer cc)
 This method is used to update a given curveContainer from the data in this object. More...
 
override String ToString ()
 This returns a String representing the MPP, format: "MPP: [1.23V | 4.56A ]" More...
 
- Public Member Functions inherited from CH.Regatron.HPPS.TFE.AAPCurveComponent
 AAPCurveComponent (ReDev.TopCon topCon, AAPCurvePointList initialAapPointList)
 CURRENTLY NOT RECOMMENDED TO BE USED!
This is the standard constructor for this class. It needs an AAPCurvePointList as argument.
copying of initialAAPCurvePointList is currently not implemented! Please More...
 
 AAPCurveComponent (ReDev.TopCon myTopCon)
 This is the simple constructor for this class. More...
 
void SetCurvePointList (AAPCurvePointList pointList)
 This method takes a AAPCurvePointList as parameter and uses it as. More...
 
AAPCurvePointList GetCurvePointList ()
 This method returns the AAPCurvePointList of this AAPCurveComponent. More...
 
void SetAapFilter (AAPCurveComponent.AAPInputFilterKoefficients newFilterCoefficients)
 This method allows to set the AAPFilter from the enum AAPInputFilterKoefficients. More...
 
void SetAapFilter (UInt32 newFilterCoefficientsInt)
 (use not recommended!)
This method allows to set the AAPFilter from an Integer. Better programming practice is to use the prepared enum "AAPInputFilterKoefficients". More...
 
AAPInputFilterKoefficients GetAapFilter ()
 This method returns the value of the AAPInputFilterCoeffiicents of this object. More...
 
void PrepareAddingCurvePoints (TFE.CurveComponent.CurveComponentType newXCurveComponentType, TFE.CurveComponent.CurveComponentType newYCurveComponentType)
 This method is needed to prepare the PointList for becoming a voltage, current or power curvePoint (changes the settings of the transformation between the true values and the internal representation).
Caution: It is currently possible to add curvePoints of a different type as this object is really used. The programmer is in charge to avoid this situation. More...
 
void AddCurvePoint (Double newXValue, Double newYValue)
 This is a convenience method to immediately add new CurvePoints to this object. More...
 
void SetInputScalingRelative (Double newInputScaling)
 This method is the setter for the input scaling physical size. More...
 
void SetInputScalingRelativeInPercent (Double newInputScaling)
 This method is the setter for the input scaling physical size. This is the method that takes a parameter a percentage value. More...
 
Double GetInputScaling ()
 This method returns the value of the InputScaling More...
 
Double GetMaximumXValue ()
 This method returns the maximum X value of all curve points in this curve component. More...
 
Double GetMaximumYValue ()
 This method returns the maximum Y value of all curve points in this curve component. More...
 
void ResetMainFunctionParameters ()
 This method updates the standard values (Amplitude, Offset) in the curveContainer with values from the given curvePoints. More...
 
void SetIndependentCurveComponentType (CurveComponent.CurveComponentType newCcType)
 This method allows to set the type of the independent variable. The parameter must be of the CurveComponentType enumeration type. More...
 
CurveComponent.CurveComponentType GetIndependentCurveComponentType ()
 This method returns the independent CurveComponentType of this curve component.
(Example: Standard SASCurve is an enhanced curve Current = func( Voltage) – the Voltage is the independent variable, the current is dependent of the voltage value (relation is the SAS characteristics). More...
 
override String ToString ()
 This method dumps the point list of this curve. More...
 
override void UpdateObjectFromCurveContainer (TFE.CurveContainer cc)
 This method uses the curveContainer (given as parameter) to read AAPCurveData and related settings from it. More...
 
override void UpdateCurveContainerFromObject (TFE.CurveContainer cc)
 This method updates the values in the curveContainer given as parameter with the properties of this object More...
 
- Public Member Functions inherited from CH.Regatron.HPPS.TFE.CurveComponent
static static string GetLastError ()
 

Additional Inherited Members

- Public Types inherited from CH.Regatron.HPPS.TFE.AAPCurveComponent
enum  AAPInputFilterKoefficients : uint {
  AAPInputFilterKoefficients.NO_FILTER = 0, AAPInputFilterKoefficients.FILTER_1600Hz = 1, AAPInputFilterKoefficients.FILTER_800Hz = 2, AAPInputFilterKoefficients.FILTER_400Hz = 3,
  AAPInputFilterKoefficients.FILTER_200Hz = 4, AAPInputFilterKoefficients.FILTER_100Hz = 5, AAPInputFilterKoefficients.FILTER_50Hz = 6, AAPInputFilterKoefficients.FILTER_25Hz = 7,
  AAPInputFilterKoefficients.FILTER_12_4Hz = 8, AAPInputFilterKoefficients.FILTER_6_2Hz = 9, AAPInputFilterKoefficients.FILTER_3_1Hz = 10, AAPInputFilterKoefficients.FILTER_1_6Hz = 11,
  AAPInputFilterKoefficients.FILTER_0_8Hz = 12, AAPInputFilterKoefficients.FILTER_0_4Hz = 13, AAPInputFilterKoefficients.FILTER_0_2Hz = 14, AAPInputFilterKoefficients.FILTER_0_1Hz = 15
}
 
- Public Types inherited from CH.Regatron.HPPS.TFE.CurveComponent
enum  CurveComponentType { CurveComponentType.VOLTAGEComponent = 0, CurveComponentType.CURRENTComponent = 1, CurveComponentType.POWERComponent = 2, CurveComponentType.INVALID = 99 }
 This list allows to identify/notify which component is to be used when data has to be drawn from a CurveContainer. The CurveComponentType is set while adding the curveComponent to the TFECurve. Therefore the CCType is commonly not set when the CC is not linked to a TFECurve. More...
 
enum  CurveComponentBaseFunctionType {
  CurveComponentBaseFunctionType.SINUS = 0, CurveComponentBaseFunctionType.RECTANGLE = 1, CurveComponentBaseFunctionType.TRIANGLE = 2, CurveComponentBaseFunctionType.USERDEFINED = 3,
  CurveComponentBaseFunctionType.AAP = 4, CurveComponentBaseFunctionType.UNKNOWN = 100
}
 This enumeration contains the identifiers for the type of the BASE FUNCTION of the curve component.
There exist several time-based functions (like sinus or rectangle, ...) or the user can choose the Area Application Processing feature, hence a function of the form x = f(y) with x, y voltage, current or power. More...
 

Detailed Description

This is the main component (used as current functionBlock that makes up calculated SASCurve).

Constructor & Destructor Documentation

◆ CalculatedSASCurveComponent() [1/2]

CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.CalculatedSASCurveComponent ( ReDev.TopCon  myTopCon)

This is the simple constructor for this curve component. It implements the CURRENT component when using CALCULATED SASCurves.

Parameters
myTopConReference to the parent TopCon object.

◆ CalculatedSASCurveComponent() [2/2]

CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.CalculatedSASCurveComponent ( ReDev.TopCon  myTopCon,
TFE.AAPCurvePointList  pointList,
SolarArrayTechnologyModel  techModel,
MPPData  mpp 
)

This is the full constructor for this curve component. It implements the CURRENT component when using CALCULATED SASCurves.

Parameters
myTopConReference to the parent TopCon object.
techModelThe technology model to be used for calculating the shape of the curve.
pointListThe list of points that are determined from the given parameters.
mpp
Exceptions
System.ArgumentException

Member Function Documentation

◆ GetLastError()

string CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.GetLastError ( )

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.

◆ GetTechnologyModel()

SolarArrayTechnologyModel CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.GetTechnologyModel ( )

This method returns the TechnologyModel set with this CalculatedSASCurve curveComponent.

Returns
An object of type SolarArrayTechnologyModel (a derivative of that).
Exceptions
System.NullReferenceException


◆ IsTechnologyModelOfType_CSi()

Boolean CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.IsTechnologyModelOfType_CSi ( )

This method checks if the TechnologyModel of this object is of type CSi_TechnologyModel (crystalline silicon).

Returns
true, if the technology model is CSi_TechnologyModel, otherwise false

◆ IsTechnologyModelOfType_TF()

Boolean CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.IsTechnologyModelOfType_TF ( )

This method checks if the TechnologyModel of this object is of type TF_TechnologyModel (ThinFilm).

Returns
true, if the technology model of this object is TF_TechnologyModel, otherwise false

◆ IsTechnologyModelOfType_UserDefined()

Boolean CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.IsTechnologyModelOfType_UserDefined ( )

This method checks if the TechnologyModel of this object is of type UserDefined_TechnologyModel.

Returns
true, if the technology model isUserDefined_TechnologyModel, otherwise false

◆ ToString()

override String CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.ToString ( )

This method returns a string with the representation of the Calculated SAS Curve in a short repesentation.

Returns
A string including the complete description of this CALCULATED SASCurveComponent.

◆ UpdateObjectFromCurveContainer()

override void CH.Regatron.HPPS.SolarArraySimulation.CalculatedSASCurveComponent.UpdateObjectFromCurveContainer ( TFE.CurveContainer  cc)

This method updates the member variables inside of this object from the curveContainer given.

Parameters
ccThe curveContainer that serves as source of new data.
Exceptions
CH.Regatron.HPPS.Device.TopConException