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

Classes

class  AAPCurve_IU
 this class denotes the AAPCurve of the IU type (only the current controller has a special role, it works as 'current = f ( voltage)' controller) More...
 
class  AAPCurveComponent
 This class is a CurveComponent that keeps a set of Points More...
 
class  AAPCurvePoint
 This class represents the AAP curve points. More...
 
class  AAPCurvePointList
 This class is a special CurvePointList with a maximum capacity of 64 points.
It is intended to use this CurvePointList for the initialization of all AAP and SASCurves.
It is not recommended for use with userDefinedCurves. More...
 
class  CurveComponent
 This class is a collector class to build a common base for all curveComponents. A CurveComponent is a rule system (set of configuration settings) for one of the three controllers built into the TopCon device (U, I, P controller).
Example of a complex rule system for being executed by the current controller and (at the same time) the voltage controller. The power controller is not affected by those two 'rules'.
Example:
a) The current controller should follow a rectangle pattern with a 30% duty cycle.
b) The voltage controller should follow a sinus pattern with 10 Hz frequency and an offset of 15Volts.
Therefore the curve that is to be defined must consist of two CurveComponents, one of type VOLTAGEComponent and the other of type CURRENTComponent. The not used power controller remains undefined.
More...
 
class  CurveContainer
 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...
 
class  CurveFactory
 
class  CurveList
 This class implements the CurveList that resides inside of the TopCon device (physically in the TopCon or in the virtual correspondant). More...
 
class  CurvePoint
 This class defines objects of the data type "CurvePoints". They consist of general (x,y) - coordinate pairs.
More...
 
class  CurvePointList
 This class covers a set of points and is used in all AAP based curves. It is declared 'abstract' so that it cannot be implemented, instead use the derived classes (e.g. AAPCurvePointList, UserDefinedCurvePointList) More...
 
class  FunctionAapData
 
class  FunctionBlock
 
class  FunctionEngine
 This class implements the FunctionEngine that resides inside of the TopCon device (physically in the TopCon or in the virtual correspondant). It is derived from the CurveList as it contains the More...
 
class  LinesCurveComponent
 This is a wrapper class to cover all aspects that Rectangle and Triangle curve have in common.
Do not use this, instead instantiate objects of the following classes: More...
 
class  RectangleCurveComponent
 A rectangle curve is a time-based (non-sinus) curve with a rectangle pattern. Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency, Symmetry (minimum configuration). More...
 
class  SineCurveComponent
 Class representing sinusodial curves (sinus curve). Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency (minimum configuration). More...
 
class  StandardTimeBasedCurveComponent
 This class is the base class for Sinus, Rectangle and Triangle curves. It should never be instantiated directly. More...
 
class  TFECurve
 This class is the container that represents a curve. It can hold SeqNumber, SeqName and so on. Thus it is prepared to be stored in the TopCon SequenceHeaderFile.
Or it is just a container to keep the U, I and P curveComponents. More...
 
class  TimeBasedCurveComponent
 
class  TriangleCurveComponent
 A triangle curve is a time-based curve with a triangle pattern.
Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency, Symmetry (minimum configuration). More...
 
class  UserDefinedCurveComponent
 This class implements all components that handle the use-defined time-based curve components. More...
 
class  UserDefinedCurvePoint
 Objects of this class contain data of points in a user defined curve. They consist of two-tupel of the format: (U/I/P-value, deltaTime). Prior to the use, the static function prepareUse has to be called to correctly initialize the use. More...
 
class  UserDefinedCurvePointList
 This class is a special CurvePointList with a maximum capacity of 1000 points.
It should be used with userDefinedCurves.
It is not recommended to use this CurvePointList for the initialization of all AAP and SASCurves. More...
 

Enumerations

enum  GeneralCurveType {
  GeneralCurveType.SIMPLE_VOLTAGE_SINUS, GeneralCurveType.SIMPLE_VOLTAGE_RECTANGLE, GeneralCurveType.SIMPLE_VOLTAGE_TRIANGLE, GeneralCurveType.SIMPLE_VOLTAGE_USERDEF,
  GeneralCurveType.SIMPLE_VOLTAGE_AAP, GeneralCurveType.SIMPLE_CURRENT_SINUS, GeneralCurveType.SIMPLE_CURRENT_RECTANGLE, GeneralCurveType.SIMPLE_CURRENT_TRIANGLE,
  GeneralCurveType.SIMPLE_CURRENT_USERDEF, GeneralCurveType.SIMPLE_CURRENT_AAP, GeneralCurveType.SIMPLE_POWER_SINUS, GeneralCurveType.SIMPLE_POWER_RECTANGLE,
  GeneralCurveType.SIMPLE_POWER_TRIANGLE, GeneralCurveType.SIMPLE_POWER_USERDEF, GeneralCurveType.SIMPLE_POWER_AAP, GeneralCurveType.MULTI_U_I,
  GeneralCurveType.MULTI_U_P, GeneralCurveType.MULTI_I_P, GeneralCurveType.MULTI_U_I_P, GeneralCurveType.SIMPLE_CUSTOM_SAS,
  GeneralCurveType.SIMPLE_CALCULATED_SAS, GeneralCurveType.UNKNOWN
}
 This enum is used to identify and define the curveType.
SIMPLE_.... = only one curve component is used (voltage XOR current XOR power)
...._VOLTAGE_
...._CURRENT_
...._POWER_ ... = this curve component is used
..._SINUS = curve component with sinusodial shape ...RECTANGLE_ ... ..._TRIANGLE_ ... = curve shape ... AAP ... MULTI_... = curve with voltage (=U), current(=I) and/or power (=P) component set SIMPLE_CUSTOM_SAS = point based SASCurve ( MPP calculations based on amplitude and inputScaling) SIMPLE_CALCULATED_SAS = parameter based SASCurve (incl. MPP calcluations based on irradiance and temperature) UNKNOWN = type not identifyable (--> ERROR) More...
 

Enumeration Type Documentation

◆ GeneralCurveType

This enum is used to identify and define the curveType.
SIMPLE_.... = only one curve component is used (voltage XOR current XOR power)
...._VOLTAGE_
...._CURRENT_
...._POWER_ ... = this curve component is used
..._SINUS = curve component with sinusodial shape ...RECTANGLE_ ... ..._TRIANGLE_ ... = curve shape ... AAP ... MULTI_... = curve with voltage (=U), current(=I) and/or power (=P) component set SIMPLE_CUSTOM_SAS = point based SASCurve ( MPP calculations based on amplitude and inputScaling) SIMPLE_CALCULATED_SAS = parameter based SASCurve (incl. MPP calcluations based on irradiance and temperature) UNKNOWN = type not identifyable (--> ERROR)

Enumerator
SIMPLE_VOLTAGE_SINUS 
  </summary> 
SIMPLE_VOLTAGE_RECTANGLE 
</summary> 
SIMPLE_VOLTAGE_TRIANGLE 
</summary> 
SIMPLE_VOLTAGE_USERDEF 
</summary> 
SIMPLE_VOLTAGE_AAP 
</summary> 
SIMPLE_CURRENT_SINUS 
</summary> 
SIMPLE_CURRENT_RECTANGLE 
</summary> 
SIMPLE_CURRENT_TRIANGLE 
</summary> 
SIMPLE_CURRENT_USERDEF 
</summary> 
SIMPLE_CURRENT_AAP 

standard AAP curve uses only CURRENT block, the others not set

SIMPLE_POWER_SINUS 
</summary> 
SIMPLE_POWER_RECTANGLE 
</summary> 
SIMPLE_POWER_TRIANGLE 
</summary> 
SIMPLE_POWER_USERDEF 
</summary> 
SIMPLE_POWER_AAP 
</summary> 
MULTI_U_I 

Kurve hat genau 2 Kenngroessenbloecke gesetzt

MULTI_U_P 
</summary> 
MULTI_I_P 
</summary> 
MULTI_U_I_P 

Kurve hat genau 3 Kenngroessenbloecke gesetzt

SIMPLE_CUSTOM_SAS 

standard custom SASCurve (no voltage block, no power block)

SIMPLE_CALCULATED_SAS 

standard calculated SASCurve (no voltage block, no power block)

UNKNOWN 

falls was schieflaeuft, geht i.d.R. in Exception