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

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

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

Public Member Functions

 AAPCurve_IU (ReDev.TopCon topCon, UInt32 curveNumber, String curveName, DateTime creationDate, AAPCurveComponent aapCurveComponent, Boolean generalEnable)
 This is a constructor that takes the I = f(U) curveComponent and creates a IU curve from that. More...
 
- Public Member Functions inherited from CH.Regatron.HPPS.TFE.TFECurve
 TFECurve (ReDev.TopCon topCon, UInt32 curveNumber, String curveName, DateTime creationDate, CurveComponent uComponent, CurveComponent iComponent, CurveComponent pComponent, Boolean generalEnable)
 Standard constructor holding three curveComponents (incl. null) More...
 
 TFECurve (ReDev.TopCon topCon, UInt32 curveNumber, String curveName, DateTime creationDate)
 Standard constructor holding three dummyComponents.
Caution: At least one curveComponent MUST be set to create a valid curve. More...
 
 TFECurve (ReDev.TopCon topCon, CurveContainer curveContainer)
 Standard constructor taking the base data from the given CurveContainer 2nd parameter), it updates the TFECurveComponents in the TFECurve. More...
 
StartTrigger_Type GetStartTriggerType ()
 This method returns the StartTrigger of this TFECurve. More...
 
void SetStartTriggerType (StartTrigger_Type startTrigger)
 This method allows to set the start trigger. (cf. StartTrigger_Type for further explanations). More...
 
EndAction_Type GetEndActionType ()
 This method returns the EndAction of this TFECurve. More...
 
void SetEndActionType (EndAction_Type endAction)
 This method allows to set the EndAction. (cf. EndAction_Type for further explanations). More...
 
UInt32 GetDelayIn50MicroSeconds ()
 This method returns the delay between two executions of the defined TFECurve. More...
 
Double GetDelayInSeconds ()
 This method returns the delay between two executions of the defined TFECurve. More...
 
void SetDelayInSeconds (Double delayInSeconds)
 This sets the delay between two succeding executions of the TFECurve. More...
 
void SetDelayInUnits (UInt32 delayInUnits)
 This method sets the delay between the repetitions of the TFECurve (rf. TopControl: FunctionSequence "Delay between repeats"). More...
 
UInt32 GetNumberOfRepetitions ()
 This method returns the number of repetitions of this TFECurve. More...
 
void SetNumberOfRepetitions (UInt32 repetitions)
 This method allows to set the number of repetitions to be excecuted on this TFECurve. More...
 
UInt32 GetSequenceNumber ()
 This is the getter that returns the (optional) SequenceNumber of this curve. More...
 
void SetSequenceNumber (UInt32 sequenceNumber)
 This method sets the number of this curve [1...999] More...
 
String GetSequenceName ()
 This method returns the sequence name of this curve. More...
 
void SetSequenceName (String sequenceName)
 This is the standard setter for the Sequence Name. More...
 
DateTime GetSequenceDateTime ()
 This is the standard getter method for the creation DataTime data. More...
 
void SetSequenceDateTime (DateTime sequenceDateTime)
 This is the standard setter for the creation date/time of this sequence. More...
 
void SetSequenceDateTime (Int32 year, Int32 month, Int32 day, Int32 hour, Int32 minute, Int32 second)
 This is the standard setter for the creation date/time of this sequence.
(throws (Argument)Exception if parameters cannot be evaluated to a valid date) More...
 
Boolean IsComponentVoltageUsed ()
 This method decides if the voltage controller has a non-standard task, hence if a curveComponent is assigned to the voltage controller. More...
 
CurveComponent GetCurveComponentVoltage ()
 This is the standard getter method for the voltage curveComponent. More...
 
void SetAapCurveComponent (AAPCurveComponent newCurveComponent)
 This is the standard setter for a curveComponent - the type is determined by the AAP curve (implicitely contained in the AAP definition). More...
 
void SetCurveComponentVoltage (TimeBasedCurveComponent newVoltageCurveComponent)
 This is the standard setter for the voltage curveComponent More...
 
Boolean IsComponentCurrentUsed ()
 This method decides if the current controller has a non-standard task, hence if a curveComponent is assigned to the current controller. More...
 
CurveComponent GetCurveComponentCurrent ()
 This is the standard getter method for the currentcurveComponent. More...
 
void SetCurveComponentCurrent (TimeBasedCurveComponent timeBasedCurveComponent)
 This is the standard setter for the current curveComponent More...
 
SASCurveComponent GetSasCurveComponent ()
 This method returns the SASCurveComponent if this object is a SASCurve (= CUSTOM or CALCULATED SASCurve). More...
 
Boolean IsComponentPowerUsed ()
 This method decides if the power controller has a non-standard task, hence if a curveComponent is assigned to the power controller. More...
 
CurveComponent GetCurveComponentPower ()
 This is the standard getter method for the power curveComponent. More...
 
void SetCurveComponent_Power (TimeBasedCurveComponent newPowerCurveComponent)
 This is the standard setter for the power curveComponent More...
 
void SetGeneralEnable (Boolean newEnable)
 This method sets the General Enable flag of the function. More...
 
Boolean GetGeneralEnable ()
 Standard Getter for the GeneralEnable flag. More...
 
void UpdateFromCurveContainer (CurveContainer myCc)
 This method takes a CurveContainer (Transport object to read curves from the Topcon) and uses the contained data to fill the various properties of this TFECurve. More...
 
GeneralCurveType DetermineCurveTypeOfThisTfeCurve ()
 This function determines the type in the curve More...
 
new String ToString ()
 This writes done a short summary representation of this TFECurve object. More...
 
void CreateCurveObjectsFromCurveContainer (TFE.CurveContainer cc)
 This method initiates the conversion of the data from a curveContainer (transport object for curve data from the TopCon to the PC) into the matching object tree. More...
 
- Public Member Functions inherited from CH.Regatron.HPPS.IExceptionMessenger
string GetLastError ()
 Tell the last exception message More...
 

Additional Inherited Members

- Public Types inherited from CH.Regatron.HPPS.TFE.TFECurve
enum  EndAction_Type { EndAction_Type.OUTPUT_VOLTAGE_OFF = 0, EndAction_Type.USE_LAST_PRESET_VALUES = 1, EndAction_Type.USE_PRESET_ofACTIVE_INTERFACE = 2 }
 This enumeration defines the action after a TFECurve has finished its work. More...
 
enum  StartTrigger_Type { StartTrigger_Type.ON_VOLTAGE_ON = 0, StartTrigger_Type.MANUAL_TRIGGER = 1, StartTrigger_Type.HIGH_ON_X105_PIN19 = 2 }
 This enumeration defines when this TFECurve should start its operation. More...
 
- Static Public Attributes inherited from CH.Regatron.HPPS.TFE.TFECurve
const UInt32 MinimumSequenceNumber = 1
 This number is the lower border of the range of numbers that can be assigned to this container.
More...
 
const UInt32 MaximunSequenceNumber = 999
 This number is the upper border of the range of numbers that can be assigned to this container. More...
 

Detailed Description

this class denotes the AAPCurve of the IU type (only the current controller has a special role, it works as 'current = f ( voltage)' controller)

Constructor & Destructor Documentation

◆ AAPCurve_IU()

CH.Regatron.HPPS.TFE.AAPCurve_IU.AAPCurve_IU ( ReDev.TopCon  topCon,
UInt32  curveNumber,
String  curveName,
DateTime  creationDate,
AAPCurveComponent  aapCurveComponent,
Boolean  generalEnable 
)

This is a constructor that takes the I = f(U) curveComponent and creates a IU curve from that.

Parameters
topConReference to the parent TopCon object.
curveNumberNumber of the curve [1...999]
curveNameName of the curve (length: [1...31] characters)
creationDateDate of the creation of this curve (commonly: DateTime.Now )
aapCurveComponentThe AAP CurveComponent to be used as current curveComponent.
generalEnableBoolean value, representing the GeneralEnable flag.