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

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

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

Public Types

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

static static string GetLastError ()
 

Detailed Description

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.

Member Enumeration Documentation

◆ CurveComponentBaseFunctionType

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.

Enumerator
SINUS 

A time-based curve with sinus shape.

A time-based curve with sinus shape.

RECTANGLE 

A time-based curve with rectangle shape.

A time-based curve with rectangle shape.

TRIANGLE 

A time-based curve with triangle shape.

A time-based curve with triangle shape.

USERDEFINED 

A time-based curve with arbitrary (user defined) shape (requires a set of curve points).

A time-based curve with arbitrary (user defined) shape (requires a set of curve points).

AAP 

A free curve with functional relation (like current = function( voltage) ).

A free curve with functional relation (like current = function( voltage) ).

UNKNOWN 

Currently undefined (e.g. during startup).

Currently undefined (e.g. during startup).

◆ CurveComponentType

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.

Enumerator
VOLTAGEComponent 

The voltage component (related to voltage controller).

The voltage component (related to voltage controller).

CURRENTComponent 

The current component (related to current controller).

The current component (related to current controller).

POWERComponent 

The power component (related to power controller).

The power component (related to power controller).

INVALID 

Undefined (e.g. during startup).

Undefined (e.g. during startup).

Member Function Documentation

◆ GetLastError()

static static string CH.Regatron.HPPS.TFE.CurveComponent.GetLastError ( )

Get the last exception message.

Returns

Implements CH.Regatron.HPPS.IExceptionMessenger.