Other Modelling Functions
- Last UpdatedNov 27, 2023
- 4 minute read
|
plate_prop_get(Obj) |
|||||
|
To get properties of a shell plate. |
|||||
|
Input Parameters: |
|||||
|
Obj |
Instance of KcsModel. Type, name and part id must be given. This is the shell plate to get data for. |
||||
|
Returned value: |
|||||
|
Properties |
Instance of KcsShPlateProp carrying the data extracted. |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_ObjectNotFound |
Object not found. |
||||
|
kcs_Error |
There was a problem in extracting data from the object. |
||||
|
plate_prop_set(Obj, Prop) |
|||||
|
Sets properties for a shell plate. This function will lock the shell plate. To unlock you must call either "kcs_chm.store" or "kcs_chm.skip". |
|||||
|
Input Parameters: |
|||||
|
Obj |
KcsModel |
Instance of KcsModel. Type, name and part id must be given. This is the shell plate to set data for. |
|||
|
Prop |
KcsShPlateProp |
Instance of KcsShPlateProp carrying the data to set. |
|||
|
Returned value: |
|||||
|
ResProp |
Instance of KcsShPlateProp carrying the updated plate data. |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_ObjectNotFound |
Object not found. |
||||
|
kcs_ObjectLocked |
Object Locked. |
||||
|
kcs_AccessDenied |
Access denied. |
||||
|
kcs_Error |
There was a problem in setting data in the object. |
||||
|
stiffener_split(ObjToSplit, SplittingObj) |
|||||
|
Split a shell profile or a shell stiffener at a given position. This function will lock the whole shell profile. To unlock you must either call "kcs_chm.store" or "kcs_chm.skip". |
|||||
|
Input Parameters: |
|||||
|
ObjToSplit |
Instance of KcsModel. Type and name must be given. This is the shell profile or the shell stiffener to split |
||||
|
SplittingObj |
Instance of KcsModel or KcsPlane3D. This object gives the position for the split. |
||||
|
Returned value: |
|||||
|
none |
|||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_Error |
The split failed: Objects do not exist, no intersection or other error. |
||||
|
stiffener_combine(Stiff1, Stiff2) |
|||||
|
Combines two shell stiffeners into one. This function will lock the whole shell profile. To unlock you must call either "kcs_chm.store" or "kcs_chm.skip". |
|||||
|
Input Parameters: |
|||||
|
Stiff1 |
KcsModel |
Instance of KcsModel. Stiff1 will be combine with Stiff2. |
|||
|
Stiff2 |
KcsModel |
Instance of KcsModel |
|||
|
Returned value: |
|||||
|
ResultStiff |
Instance of KcsModel. If the combine operation succeeded this is the resulting stiffener. |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_Error |
The combine failed: Objects do not exist, the stiffeners are not neighbouring stiffeners or other error. |
||||
|
stiffener_prop_get(Obj) |
|||||
|
To get properties of a shell stiffener. |
|||||
|
Input Parameters: |
|||||
|
Obj |
Instance of KcsModel. Type, name and part id must be given. This is the shell stiffener to get data for. |
||||
|
Returned value: |
|||||
|
Properties |
Instance of KcsShStiffProp carrying the data extracted. |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_ObjectNotFound |
Object not found. |
||||
|
kcs_Error |
There was a problem in extracting data from the object. |
||||
|
stiffener_prop_set(Obj, Prop) |
|||||
|
Sets properties for a shell stiffener. This function will lock the shell stiffener. To unlock you must call either "kcs_chm.store" or kcs_chm.skip". |
|||||
|
Input Parameters: |
|||||
|
Obj |
KcsModel |
Instance of KcsModel. Type, name and part id must be given. This is the shell stiffener to set data for. |
|||
|
Prop |
KcsShStiffProp |
Instance of KcsShStiffProp carrying the data to set. |
|||
|
Returned value: |
|||||
|
ResProp |
Instance of KcsShStiffProp carrying the updated stiffener data. |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_ObjectNotFound |
Object not found. |
||||
|
kcs_ObjectLocked |
Object locked. |
||||
|
kcs_AccessDenied |
Access denied. |
||||
|
kcs_Error |
There was a problem in setting data in the object. |
||||
|
curve_principal_create(CurveName, Plane, MinPt, MaxPt, SurfName) |
|||||
|
Creates a shell curve or a shell seam. The curve/seam is the intersection between a surface and a principal plane. The resulting curve will created and locked on the data bank. Use either "kcs_chm.store" or "kcs_chm.skip" to unlock the curve. |
|||||
|
Input Parameters: |
|||||
|
CurveName |
string |
The name of the curve/seam. If the name is a valid seam name a seam object is created otherwise a hull curve is created. |
|||
|
Plane |
string |
A string describing the principal plane, e.g "X=FR50+200", "Y=LP10", "Z=LP25-100". |
|||
|
MinPt |
KcsPoint3D |
MinPt and MaxPt is the limit box for the curve/seam. MinPt holds the minimum values of the box. |
|||
|
MaxPt |
KcsPoint3D |
MaxPt holds the maximum values of the box limitbox. |
|||
|
SurfName |
string |
Optional parameter. The name of the surface the should be intersected. If SurfName is omitted, the default surface will be used |
|||
|
curve_planar_create(CurveName, Plane, MinPt, MaxPt, SurfName) |
|||||
|
Creates a shell curve or a shell seam. The curve/seam is the intersection between a surface and a plane. The resulting curve will created and locked on the data bank. Use either "kcs_chm.store" or "kcs_chm.skip" to unlock the curve. |
|||||
|
Input Parameters: |
|||||
|
CurveName |
string |
The name of the curve/seam. If the name is a valid seam name a seam object is created otherwise a hull curve is created. |
|||
|
Plane |
KcsPlane3D |
A string describing the principal plane, e.g "X=FR50+200", "Y=LP10", "Z=LP25-100". |
|||
|
MinPt |
KcsPoint3D |
MinPt and MaxPt is the limit box for the curve/seam. MinPt holds the minimum values of the box. |
|||
|
MaxPt |
KcsPoint3D |
MaxPt holds the maximum values of the box limitbox. |
|||
|
SurfName |
string |
Optional parameter. The name of the surface the should be intersected. If SurfName is omitted, the default surface will be used |
|||
|
Returned value: |
|||||
|
Curve |
Instance of KcsModel |
||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input |
||||
|
kcs_Error |
Failed to create the curve. |
||||
|
cpan_hole_create(PanelName, HoleOptions) |
|||||
|
Creates a new hole in a curved panel object. The panel will be locked in the data bank. Use store kcs_chm.store" to store and unlock the panel or "kcs_chm.skip" to discard the changes and unlock the panel. |
|||||
|
Input Parameters: |
|||||
|
PanelName |
string |
The name of the curved panel. |
|||
|
HoleOptions |
KCSPanHoleOptions |
This python object contains all the data that specifies the shape and position of the new hole. Please see this python file for documentation. |
|||
|
Returned value: |
|||||
|
None. |
|||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_Error |
Failed to create the hole. |
||||
|
Examples: |
|||||
|
# Example: kcs_ex_hull_shellstiff.py |
|||||
|
# Example: kcs_ex_hull_shellcurves.py |
|||||
|
# Example: kcs_ex_hull_cpanhole.py |
|||||
|
# Example: kcs_ex_hull_sh_stiff_prop.py |
|||||
|
stiffener_to_profdb(Stiff) |
|||||
|
Transfer a given shell profile to the production data base. |
|||||
|
Input Parameters: |
|||||
|
Stiff |
KcsModel |
Instance of KcsModel. |
|||
|
Returned value: |
|||||
|
None |
|||||
|
Exceptions: |
|||||
|
kcs_ArgumentError |
Invalid input. |
||||
|
kcs_Error |
The transfer failed: Objects do not exist or other error. |
||||
|
ClosestJigPillar(MarClosestJigPillar ClosestJigPillar, int Row, String Column) |
|||||
|
Returns the closest jig pin |
|||||
|
Input Parameters: |
|||||
|
ClosestJigPillar |
MarClosestJigPillar |
||||
|
Returned value: |
|||||
|
Row |
int\double |
row |
|||
|
Column |
string |
column ("A","B", etc) |
|||
|
Exceptions: |
|||||
|
Mar_InvalidSeamName |
Invalid seam name |
||||
|
Mar_InvalidFrameString |
Invalid frame string |
||||
|
Mar_IntersectionNotFound |
Intersection not found |
||||
|
Mar_InvalidPanelName |
Invalid panel name |
||||
|
FramesIntersectingPanel(Frames) |
|||||
|
Returns frames name intersection with panel. |
|||||
|
Input Parameters: |
|||||
|
Frames |
MarFrames |
||||
|
Returned value: |
|||||
|
String [] |
List with frames name intersection with panel. |
||||
|
Exceptions: |
|||||
|
Mar_InvalidPanelName |
Invalid panel name. |
||||
|
Mar_IntersectionNotFound |
Intersection not found. |
||||