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

This class is a CurveComponent that keeps a set of Points More...

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

Public Types

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...
 

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...
 
- Public Member Functions inherited from CH.Regatron.HPPS.TFE.CurveComponent
static static string GetLastError ()
 

Detailed Description

This class is a CurveComponent that keeps a set of Points

Member Enumeration Documentation

◆ AAPInputFilterKoefficients

Enumerator
NO_FILTER 

0

FILTER_1600Hz 

1

FILTER_800Hz 

2

FILTER_400Hz 

3

FILTER_200Hz 

4

FILTER_100Hz 

5

FILTER_50Hz 

6

FILTER_25Hz 

7

FILTER_12_4Hz 

8

FILTER_6_2Hz 

9

FILTER_3_1Hz 

100

FILTER_1_6Hz 

11

FILTER_0_8Hz 

12

FILTER_0_4Hz 

13

FILTER_0_2Hz 

14

FILTER_0_1Hz 

15

Constructor & Destructor Documentation

◆ AAPCurveComponent() [1/2]

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

Parameters
topConLink to the parent TopCon object. This is needed to fetch the parameters from it.
initialAapPointListReference to a AAPPointList (currently the contained data are not used, but instead cleared.

◆ AAPCurveComponent() [2/2]

CH.Regatron.HPPS.TFE.AAPCurveComponent.AAPCurveComponent ( ReDev.TopCon  myTopCon)

This is the simple constructor for this class.

Parameters
myTopConLink to the parent TopCon object. This is needed to fetch the parameters from it.

Member Function Documentation

◆ AddCurvePoint()

void CH.Regatron.HPPS.TFE.AAPCurveComponent.AddCurvePoint ( Double  newXValue,
Double  newYValue 
)

This is a convenience method to immediately add new CurvePoints to this object.

Parameters
newXValueValue for this curvePoint (depending on the set curveComponentType for X-axis)
newYValueValue for this curvePoint (depending on the set curveComponentType for Y-axis)

◆ GetAapFilter()

AAPInputFilterKoefficients CH.Regatron.HPPS.TFE.AAPCurveComponent.GetAapFilter ( )

This method returns the value of the AAPInputFilterCoeffiicents of this object.

Returns
The AAPFilterCoefficients [ enum: "AAPInputFilterCoefficients"

◆ GetCurvePointList()

AAPCurvePointList CH.Regatron.HPPS.TFE.AAPCurveComponent.GetCurvePointList ( )

This method returns the AAPCurvePointList of this AAPCurveComponent.

Returns

◆ GetIndependentCurveComponentType()

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).

Returns
The independent (x axis) curveComponentType previously set for this curveComponent.

◆ GetInputScaling()

Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetInputScaling ( )

This method returns the value of the InputScaling

Returns
The value of the input scaling as Double value.

◆ GetMaximumXValue()

Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetMaximumXValue ( )

This method returns the maximum X value of all curve points in this curve component.

Returns
A double number representing the value of the highest X value of all curve points in this curvePointList. (The user is responsable for the correct interpretation (e.g. if it is a voltage, current or power value).

◆ GetMaximumYValue()

Double CH.Regatron.HPPS.TFE.AAPCurveComponent.GetMaximumYValue ( )

This method returns the maximum Y value of all curve points in this curve component.

Returns
A double number representing the value of the highest Y value of all curve points in this curvePointList. (The user is responsable for the correct interpretation (e.g. if it is a voltage, current or power value).

◆ PrepareAddingCurvePoints()

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.

Parameters
newXCurveComponentTypeType of the independent curveComponent ( = X -axis)
e.g. voltage for current = f ( voltage)
newYCurveComponentTypeType of the dependent curveComponent ( = Y -axis)
e.g. current for current = f (voltage)

◆ ResetMainFunctionParameters()

void CH.Regatron.HPPS.TFE.AAPCurveComponent.ResetMainFunctionParameters ( )

This method updates the standard values (Amplitude, Offset) in the curveContainer with values from the given curvePoints.

◆ SetAapFilter() [1/2]

void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetAapFilter ( AAPCurveComponent.AAPInputFilterKoefficients  newFilterCoefficients)

This method allows to set the AAPFilter from the enum AAPInputFilterKoefficients.

Parameters
newFilterCoefficientsenum item to be used.

◆ SetAapFilter() [2/2]

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".

Parameters
newFilterCoefficientsIntUInt32 that mirrors an item in the AAPInputFilterKoefficients enum.

◆ SetCurvePointList()

void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetCurvePointList ( AAPCurvePointList  pointList)

This method takes a AAPCurvePointList as parameter and uses it as.

Parameters
pointList

◆ SetIndependentCurveComponentType()

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.

Parameters
newCcTypeCurveComponentType ( in general related to V, C, P)

◆ SetInputScalingRelative()

void CH.Regatron.HPPS.TFE.AAPCurveComponent.SetInputScalingRelative ( Double  newInputScaling)

This method is the setter for the input scaling physical size.

Parameters
newInputScaling

◆ SetInputScalingRelativeInPercent()

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.

Parameters
newInputScalingNew value of InputScaling in Percent [12.5% ... 999.9%]

◆ ToString()

override String CH.Regatron.HPPS.TFE.AAPCurveComponent.ToString ( )

This method dumps the point list of this curve.

Returns
A string representation of this AAPCurveComponent (Format: 'Points == [ (...,....) (...,...) ]' followed by the ToString of the base class");

◆ UpdateCurveContainerFromObject()

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

Parameters
ccThe curveContainer to be filled with the values of this object.

◆ UpdateObjectFromCurveContainer()

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.

Parameters
ccCurveContainer to be used for analysis and as base for this object.