Macro variables
- Last UpdatedFeb 02, 2023
- 3 minute read
The following variables are available to use in conjunction with the command language. These are useful for writing macros. For example:
General Particulars
General particular variables are available after issuing the DIRECTORY PARTICULARS command
|
#LOA |
Length Overall |
|
#LBP |
Length Between Perpendiculars |
|
#BEAM |
Beam |
|
#DRAFT |
Draft |
|
#DEPTH |
Depth at Midships |
|
#FOK |
Flat of Keel |
|
#ROF |
Rise of Floor |
|
#BR |
Bilge Radius |
|
#ROK |
Rake of Keel |
|
#STNOH |
Stern Overhang |
|
#STMOH |
Stem Overhang |
|
#MAXZ |
Maximum Z point |
|
#MINZ |
Minimum Z point |
|
#SHIPNO |
Ship name |
Current Curve
|
#IDN |
Name of the current curve (for knuckles, tangent, plines, ) |
|
#IDI |
Type of the current curve |
|
#IDP |
Position of the current curve (for sections, waterlines, buttocks, ) |
|
#CVF |
Current curve exists flag (-1=True,0=False) |
|
#CVC |
Number of spans in the current curve |
|
#PTF |
Current points exist flag (-1=True,0=False) |
|
#PTC |
Number of points in current curve |
|
#ID3D |
2D/3D curve flag (-1=3D,0=2D) |
Point information
Point information is available after issuing the COORD/POINT command
|
#PT |
Type of point (P=Ordinary,T=Tangent,K=Knuckle) |
|
#PN |
Index of point |
|
#X |
X coordinate of point |
|
#Y |
Y coordinate of point |
|
#Z |
Z coordinate of point |
|
#AL |
Lower angle assigned to the point |
|
#AU |
Upper angle assigned to the point |
|
#AC |
Angle of the curve at the point |
Interpolation/Intersection information
Interpolation/intersection information is available after issuing the INTERPOLATE command
|
#NIN |
Number of intersections |
|
#INX[] |
Array of X coordinates |
|
#INY[] |
Array of Y coordinates |
|
#INZ[] |
Array of Z coordinates |
|
#NDV |
Number of derivatives (returned by the INTERPOLATE or DERIVATIVE commands) |
|
#DV[] |
Array of derivatives (returned by the INTERPOLATE or DERIVATIVE commands) |
Cursor information
Cursor information is available after issuing the COORD/CURSOR command
|
#U |
U coordinate |
|
#V |
V coordinate |
Curve lists
Curve list information is available after the DIRECTORY command. For example, after issuing the DIRECTORY SECTION command, two macro variables are created; #NSEC, which gives the number of switched on sections, and #SEC[] which is an array of switched on section positions in the current dataset and units. The full list of variables is given below:
|
#NSEC |
Number of switched on sections |
|
#SEC[] |
Array of switched on sections |
|
#NWAT |
Number of switched on waterlines |
|
#WAT[] |
Array of switched on waterlines |
|
#NBUT |
Number of switched on buttocks |
|
#BUT[] |
Array of switched on buttocks |
|
#NKNU |
Number of switched on knuckles |
|
#KNU[] |
Array of switched on knuckles |
|
#NTAN |
Number of switched on tangents |
|
#TAN[] |
Array of switched on tangents |
|
#NPLI |
Number of switched on plines |
|
#PLI[] |
Array of switched on plines |
|
#NDIA |
Number of switched on diagonals |
|
#DIA[] |
Array of switched on diagonals |
|
#NCLI |
Number of switched on clines |
|
#CLI[] |
Array of switched on clines |
|
#NCAM |
Number of switched on cambers |
|
#CAM[] |
Array of switched on cambers |
|
#NSHE |
Number of switched on sheers |
|
#SHE[] |
Array of switched on sheers |
|
#NPAT |
Number of switched on patches |
|
#PAT[] |
Array of switched on patches |
|
#NSAC |
Number of switched on sectional area curves |
|
#SAC[] |
Array of switched on sectional area curves |
|
#NDES |
Number of switched on design data sections |
|
#DES[] |
Array of switched on design data sections |