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

Class representing sinusodial curves (sinus curve). Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency (minimum configuration). More...

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

Public Member Functions

 SineCurveComponent ()
 Standard constructor (parameterless) for Sinus curves. More...
 
 SineCurveComponent (Double newAmplitude, Double newOffset, Double newFrequency)
 This is a convenience constructor for a sinusodial curve. More...
 
override String ToString ()
 This method returns a short representation of the internal values (attached to the result of the matching method of the base class.) More...
 
override void UpdateObjectFromCurveContainer (CurveContainer curveContainer)
 This method updates the properties of this object with values from the curveContainer More...
 
override void UpdateCurveContainerFromObject (CurveContainer curveContainer)
 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.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

Class representing sinusodial curves (sinus curve). Use convenience constructor or use setter methods to set Amplitude, Offset, Frequency (minimum configuration).

Constructor & Destructor Documentation

◆ SineCurveComponent() [1/2]

CH.Regatron.HPPS.TFE.SineCurveComponent.SineCurveComponent ( )

Standard constructor (parameterless) for Sinus curves.

◆ SineCurveComponent() [2/2]

CH.Regatron.HPPS.TFE.SineCurveComponent.SineCurveComponent ( Double  newAmplitude,
Double  newOffset,
Double  newFrequency 
)

This is a convenience constructor for a sinusodial curve.

Parameters
newAmplitudeAmplitude of the curve [V].
newOffsetOffset of the curve [V].
newFrequencyFrequency of the curve [1/s].

Member Function Documentation

◆ ToString()

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

This method returns a short representation of the internal values (attached to the result of the matching method of the base class.)

Returns
String representing the internal values of the base class(es) object and that of this one.

◆ UpdateCurveContainerFromObject()

override void CH.Regatron.HPPS.TFE.SineCurveComponent.UpdateCurveContainerFromObject ( CurveContainer  curveContainer)

This method updates the values in the curveContainer given as parameter with the properties of this object

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

◆ UpdateObjectFromCurveContainer()

override void CH.Regatron.HPPS.TFE.SineCurveComponent.UpdateObjectFromCurveContainer ( CurveContainer  curveContainer)

This method updates the properties of this object with values from the curveContainer

Parameters
curveContainerThe curveContainer with the values that have to be used as data source.