![]() |
TopCon API
1.1.0
.Net API to control TopCon devices
|
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...
Public Types | |
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... | |
Public Member Functions | |
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... | |
![]() | |
string | GetLastError () |
Tell the last exception message More... | |
Static Public Attributes | |
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... | |
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.
|
strong |
This enumeration defines the action after a TFECurve has finished its work.
Enumerator | |
---|---|
OUTPUT_VOLTAGE_OFF | at the end of the TFE curve execution, switch off the power stage (Voltage OFF) |
USE_LAST_PRESET_VALUES | the last values of the curve components are used as preset values |
USE_PRESET_ofACTIVE_INTERFACE | the preset values of the active interface are used |
|
strong |
This enumeration defines when this TFECurve should start its operation.
Enumerator | |
---|---|
ON_VOLTAGE_ON | start if voltage is switched on |
MANUAL_TRIGGER | wait for manual action (e.g. in TopControl) |
HIGH_ON_X105_PIN19 | wait for a positive edge transition on Pin 19 on X105 |
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)
topCon | TopCon object where the curve is to be found |
curveNumber | The curveNumber of this curve [1...999] |
curveName | The name of this curve [1..31 characters] |
creationDate | The creation DateTime of this curve. |
uComponent | The CurveComponent that determines the voltage controller behaviour. Component gets attribute that it works as voltage component. |
iComponent | The CurveComponent that determines the current controller behaviour. Component gets attribute that it works as current component. |
pComponent | The CurveComponent that determines the power controller behaviour. Component gets attribute that it works as power component. |
generalEnable | This is the main switch if this curve is enabled (cf. TopControl). If no CurveComponent is given (== 3x null given), then this flag is set to false to indicate that this is no active TFECurve. |
CH.Regatron.HPPS.TFE.TFECurve.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.
CH.Regatron.HPPS.TFE.TFECurve.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.
topCon | TopCon object where the curve is to be found |
curveContainer | CurveContainer that transports the curve data from the TopCon device |
void CH.Regatron.HPPS.TFE.TFECurve.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.
cc | The curveContainer with the curve data. |
GeneralCurveType CH.Regatron.HPPS.TFE.TFECurve.DetermineCurveTypeOfThisTfeCurve | ( | ) |
This function determines the type in the curve
CurveComponent CH.Regatron.HPPS.TFE.TFECurve.GetCurveComponentCurrent | ( | ) |
This is the standard getter method for the currentcurveComponent.
CurveComponent CH.Regatron.HPPS.TFE.TFECurve.GetCurveComponentPower | ( | ) |
This is the standard getter method for the power curveComponent.
CurveComponent CH.Regatron.HPPS.TFE.TFECurve.GetCurveComponentVoltage | ( | ) |
This is the standard getter method for the voltage curveComponent.
UInt32 CH.Regatron.HPPS.TFE.TFECurve.GetDelayIn50MicroSeconds | ( | ) |
This method returns the delay between two executions of the defined TFECurve.
Double CH.Regatron.HPPS.TFE.TFECurve.GetDelayInSeconds | ( | ) |
This method returns the delay between two executions of the defined TFECurve.
EndAction_Type CH.Regatron.HPPS.TFE.TFECurve.GetEndActionType | ( | ) |
Boolean CH.Regatron.HPPS.TFE.TFECurve.GetGeneralEnable | ( | ) |
Standard Getter for the GeneralEnable flag.
UInt32 CH.Regatron.HPPS.TFE.TFECurve.GetNumberOfRepetitions | ( | ) |
SASCurveComponent CH.Regatron.HPPS.TFE.TFECurve.GetSasCurveComponent | ( | ) |
This method returns the SASCurveComponent if this object is a SASCurve (= CUSTOM or CALCULATED SASCurve).
DateTime CH.Regatron.HPPS.TFE.TFECurve.GetSequenceDateTime | ( | ) |
This is the standard getter method for the creation DataTime data.
String CH.Regatron.HPPS.TFE.TFECurve.GetSequenceName | ( | ) |
This method returns the sequence name of this curve.
UInt32 CH.Regatron.HPPS.TFE.TFECurve.GetSequenceNumber | ( | ) |
This is the getter that returns the (optional) SequenceNumber of this curve.
StartTrigger_Type CH.Regatron.HPPS.TFE.TFECurve.GetStartTriggerType | ( | ) |
This method returns the StartTrigger of this TFECurve.
Boolean CH.Regatron.HPPS.TFE.TFECurve.IsComponentCurrentUsed | ( | ) |
This method decides if the current controller has a non-standard task, hence if a curveComponent is assigned to the current controller.
Boolean CH.Regatron.HPPS.TFE.TFECurve.IsComponentPowerUsed | ( | ) |
This method decides if the power controller has a non-standard task, hence if a curveComponent is assigned to the power controller.
Boolean CH.Regatron.HPPS.TFE.TFECurve.IsComponentVoltageUsed | ( | ) |
This method decides if the voltage controller has a non-standard task, hence if a curveComponent is assigned to the voltage controller.
void CH.Regatron.HPPS.TFE.TFECurve.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).
newCurveComponent | An AAP curveComponent to be used for the controller. The type is implicitly defined inside of the AAP component. |
void CH.Regatron.HPPS.TFE.TFECurve.SetCurveComponent_Power | ( | TimeBasedCurveComponent | newPowerCurveComponent | ) |
This is the standard setter for the power curveComponent
newPowerCurveComponent | A curveComponent to be used for the power controller. |
void CH.Regatron.HPPS.TFE.TFECurve.SetCurveComponentCurrent | ( | TimeBasedCurveComponent | timeBasedCurveComponent | ) |
This is the standard setter for the current curveComponent
timeBasedCurveComponent | A curveComponent to be used for the current controller. |
void CH.Regatron.HPPS.TFE.TFECurve.SetCurveComponentVoltage | ( | TimeBasedCurveComponent | newVoltageCurveComponent | ) |
This is the standard setter for the voltage curveComponent
newVoltageCurveComponent | A curveComponent to be used for the voltage controller. |
void CH.Regatron.HPPS.TFE.TFECurve.SetDelayInSeconds | ( | Double | delayInSeconds | ) |
This sets the delay between two succeding executions of the TFECurve.
delayInSeconds | Delay [0...214 748s, internally rounded to base unit 50us] |
void CH.Regatron.HPPS.TFE.TFECurve.SetDelayInUnits | ( | UInt32 | delayInUnits | ) |
This method sets the delay between the repetitions of the TFECurve (rf. TopControl: FunctionSequence "Delay between repeats").
delayInUnits | Delay in base units 50us, range: [0...4294967295] |
void CH.Regatron.HPPS.TFE.TFECurve.SetEndActionType | ( | EndAction_Type | endAction | ) |
This method allows to set the EndAction. (cf. EndAction_Type for further explanations).
endAction | The EndAction to be used [EndAction_Type] |
void CH.Regatron.HPPS.TFE.TFECurve.SetGeneralEnable | ( | Boolean | newEnable | ) |
This method sets the General Enable flag of the function.
newEnable | true to activate general enable, false to disable. |
void CH.Regatron.HPPS.TFE.TFECurve.SetNumberOfRepetitions | ( | UInt32 | repetitions | ) |
This method allows to set the number of repetitions to be excecuted on this TFECurve.
repetitions | Number of repetitions [0...2^32-1] |
void CH.Regatron.HPPS.TFE.TFECurve.SetSequenceDateTime | ( | DateTime | sequenceDateTime | ) |
This is the standard setter for the creation date/time of this sequence.
sequenceDateTime | The dateTime information of the creation of this function. |
void CH.Regatron.HPPS.TFE.TFECurve.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)
year | Year of the creation date [2000 ... 2099] |
month | Month of the creation date [1....12] |
day | Day of the creation date [1 ... 31] |
hour | Hour of the creation date [0 ... 23] |
minute | Minute of the creation date [0...59] |
second | Second of the creation date [0...59] |
void CH.Regatron.HPPS.TFE.TFECurve.SetSequenceName | ( | String | sequenceName | ) |
This is the standard setter for the Sequence Name.
sequenceName | SequenceName (max. length: 32 characters) |
void CH.Regatron.HPPS.TFE.TFECurve.SetSequenceNumber | ( | UInt32 | sequenceNumber | ) |
This method sets the number of this curve [1...999]
sequenceNumber | new Number to be assigned to this curve. |
void CH.Regatron.HPPS.TFE.TFECurve.SetStartTriggerType | ( | StartTrigger_Type | startTrigger | ) |
This method allows to set the start trigger. (cf. StartTrigger_Type for further explanations).
startTrigger | Start trigger to be used [StartTrigger_Type] |
new String CH.Regatron.HPPS.TFE.TFECurve.ToString | ( | ) |
This writes done a short summary representation of this TFECurve object.
void CH.Regatron.HPPS.TFE.TFECurve.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.
myCc | CurveContainer object with data to be used. |
|
static |
This number is the upper border of the range of numbers that can be assigned to this container.
|
static |
This number is the lower border of the range of numbers that can be assigned to this container.