Interface Function
- Last UpdatedNov 27, 2023
- 2 minute read
A number of functions with predefined names and parameter list must exist in the script. These functions should never be changed regarding the input parameters and the result values.
|
getNotchName(notchNo): |
||
|
The function returns the name of the notch from the list of notches. |
||
|
Input Parameters: |
||
|
NotchNo |
integer |
Index to notch list. |
|
Returned value: |
||
|
NotchList[NotchNo] |
string |
Notch name. |
|
|
||
|
getNotchSegment(SegNo): |
||
|
The function returns a notch segment from the notch contour. |
||
|
Input Parameters: |
||
|
Segno |
integer |
Notch segment number. |
|
Returned value: |
||
|
NotchData[SegNo] |
reals |
Segment part R,U,V. |
|
|
||
|
setNotchContour(NotchName, NPar, Par1, Par2, Par3, Par4, Par5, Par6, Par7, Par8): |
||
|
The function creates a customer defined notch by creating segments to the NotchData list. The function should define a notch contour in the UV co-ordinate system whose origin will be the reference point of the notch. Up to 8 number of parameters are allowed. The breakpoints of the contour should be defined as a number of segments (R, U, V), where R is equal to 0.0 for a line segment, positive for a counter clock radius and negative for a clockwise radius. The notch code should be implemented with an exception handling mechanism so that a failure to run the code will always be signaled by the return code. |
||
|
Input Parameters: |
||
|
Notchname |
string |
The name of the customer notch. |
|
Npar |
real |
Number of parameters. |
|
Par1 |
real |
Notch parameter 1. |
|
Par2 |
real |
Notch parameter 2. |
|
Par3 |
real |
Notch parameter 3. |
|
Par4 |
real |
Notch parameter 4. |
|
Par5 |
real |
Notch parameter 5. |
|
Par6 |
real |
Notch parameter 6. |
|
Par7 |
real |
Notch parameter 7. |
|
Par8 |
real |
Notch parameter 8. |
|
Returned value: |
||
|
NotchRes |
integer |
Result code. The predefined values should be used. 0 OK 1 Unrecognized notch type 2 Wrong number of parameters 3 Unreasonable parameter values 4 Notch geometry could not be generated |