![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
This class is a CurveComponent that keeps a set of Points More...
Public Member Functions | |
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... | |
![]() | |
static static string | GetLastError () |
This class is a CurveComponent that keeps a set of Points
|
strong |
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
topCon | Link to the parent TopCon object. This is needed to fetch the parameters from it. |
initialAapPointList | Reference to a AAPPointList (currently the contained data are not used, but instead cleared. |
CH.Regatron.HPPS.TFE.AAPCurveComponent.AAPCurveComponent | ( | ReDev.TopCon | myTopCon | ) |
This is the simple constructor for this class.
myTopCon | Link to the parent TopCon object. This is needed to fetch the parameters from it. |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.AddCurvePoint | ( | Double | newXValue, |
Double | newYValue | ||
) |
This is a convenience method to immediately add new CurvePoints to this object.
newXValue | Value for this curvePoint (depending on the set curveComponentType for X-axis) |
newYValue | Value for this curvePoint (depending on the set curveComponentType for Y-axis) |
AAPInputFilterKoefficients CH.Regatron.HPPS.TFE.AAPCurveComponent.GetAapFilter | ( | ) |
This method returns the value of the AAPInputFilterCoeffiicents of this object.
AAPCurvePointList CH.Regatron.HPPS.TFE.AAPCurveComponent.GetCurvePointList | ( | ) |
This method returns the AAPCurvePointList of this AAPCurveComponent.
CurveComponent.CurveComponentType CH.Regatron.HPPS.TFE.AAPCurveComponent.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).
Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetInputScaling | ( | ) |
This method returns the value of the InputScaling
Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetMaximumXValue | ( | ) |
This method returns the maximum X value of all curve points in this curve component.
Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetMaximumYValue | ( | ) |
This method returns the maximum Y value of all curve points in this curve component.
void CH.Regatron.HPPS.TFE.AAPCurveComponent.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.
newXCurveComponentType | Type of the independent curveComponent ( = X -axis) e.g. voltage for current = f ( voltage) |
newYCurveComponentType | Type of the dependent curveComponent ( = Y -axis) e.g. current for current = f (voltage) |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.ResetMainFunctionParameters | ( | ) |
This method updates the standard values (Amplitude, Offset) in the curveContainer with values from the given curvePoints.
void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetAapFilter | ( | AAPCurveComponent.AAPInputFilterKoefficients | newFilterCoefficients | ) |
This method allows to set the AAPFilter from the enum AAPInputFilterKoefficients.
newFilterCoefficients | enum item to be used. |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.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".
newFilterCoefficientsInt | UInt32 that mirrors an item in the AAPInputFilterKoefficients enum. |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetCurvePointList | ( | AAPCurvePointList | pointList | ) |
This method takes a AAPCurvePointList as parameter and uses it as.
pointList |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetIndependentCurveComponentType | ( | CurveComponent.CurveComponentType | newCcType | ) |
This method allows to set the type of the independent variable. The parameter must be of the CurveComponentType enumeration type.
newCcType | CurveComponentType ( in general related to V, C, P) |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetInputScalingRelative | ( | Double | newInputScaling | ) |
This method is the setter for the input scaling physical size.
newInputScaling |
void CH.Regatron.HPPS.TFE.AAPCurveComponent.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.
newInputScaling | New value of InputScaling in Percent [12.5% ... 999.9%] |
override String CH.Regatron.HPPS.TFE.AAPCurveComponent.ToString | ( | ) |
This method dumps the point list of this curve.
override void CH.Regatron.HPPS.TFE.AAPCurveComponent.UpdateCurveContainerFromObject | ( | TFE.CurveContainer | cc | ) |
This method updates the values in the curveContainer given as parameter with the properties of this object
cc | The curveContainer to be filled with the values of this object. |
override void CH.Regatron.HPPS.TFE.AAPCurveComponent.UpdateObjectFromCurveContainer | ( | TFE.CurveContainer | cc | ) |
This method uses the curveContainer (given as parameter) to read AAPCurveData and related settings from it.
cc | CurveContainer to be used for analysis and as base for this object. |