PSC Code Manual

stair/util.lsp [src]

Utility functions for stairs

Functions

Function signature Description
Public
(add-stair-stringer inc-list container side str-lay flg-lay) Add a stair stringer outline to CONTAINER
(get-stn-desc-by-sku sku) Returns the material list entry for a STN with SKU
(stair-block-qt-takeoff blockdef) Returns a list of QT quantities in BLOCKDEF
(stair-dim-format h/v dimobj) Formats a stair dimension
(stair-dir ascend z-position) Return the stair direction (either +1 or -1) based on ASCEND and Z-POSITION.
(stair-guard-assembly location) Returns the assembly name of the guard rail at LOCATION.
(stair-hr-assembly) Returns the assembly name of the HG return for this stair.
(stair-qt-takeoff ename) Returns a Quiet Tread takeoff for the stair object referred to by ENAME
(stair-rail-assembly side) Returns the assembly name of the stair rail on SIDE of this stair.
(stair-slope) Returns the nosing line in slope-intercept form.
(stair-stn-p) Returns T when this stair has STN
Private
(stair-guard--num loc) Returns the number of a guard rail

(add-stair-stringer inc-list container side str-lay flg-lay)

Add a stair stringer outline to CONTAINER

INC-LIST is the stringer properties list. SIDE is a string starting with l, r, i, or
o. STR-LAY and FLG-LAY are the layers on which to draw the stringer outline and flange
lines, respectively.

VARS:
(INC-LIST LIST)
(CONTAINER VLA-OBJECT)
(SIDE STR)
(STR-LAY STR)
(FLG-LAY STR)

WITH-DATA

(get-stn-desc-by-sku sku)

Returns the material list entry for a STN with SKU

(stair-block-qt-takeoff blockdef)

Returns a list of QT quantities in BLOCKDEF

VARS:
(BLOCKDEF VLA-OBJECT)

(stair-dim-format h/v dimobj)

Formats a stair dimension

DIMOBJ is the dimension object. H/V is either the symbol 'h or 'v. 'h means to format as a
run dimension and 'v means to format it as a rise dimension.

VARS:
(H/V SYM (MEMBER H/V '(H V)))
(DIMOBJ VLA-OBJECT)

(stair-dir ascend z-position)

Return the stair direction (either +1 or -1) based on ASCEND and Z-POSITION.

VARS:
(ASCEND STR (MEMBER ASCEND '("Left" "Right")))
(Z-POSITION STR (MEMBER Z-POSITION '("Near" "Far")))

TESTS:
(= (STAIR-DIR "Left" "Near") 1)
(= (STAIR-DIR "Right" "Far") 1)
(= (STAIR-DIR "Left" "Far") -1)
(= (STAIR-DIR "Right" "Near") -1)

(stair-guard-assembly location)

Returns the assembly name of the guard rail at LOCATION.

LOCATION should be one of the following strings:

- "ibot" (inside bottom)
- "obot" (outside bottom)
- "itop" (inside top)
- "otop" (outside top)
- "btwn" (between stairs)

WITH-DATA

VARS:
(LOCATION STR (MEMBER LOCATION '("ibot" "obot" "itop" "otop" "btwn")))
(NUMBER STR)
(LEVEL STR)

(stair-hr-assembly)

Returns the assembly name of the HG return for this stair.

WITH-DATA

VARS:
(ASSEMBLY STR (WCMATCH ASSEMBLY "*S*"))

(stair-qt-takeoff ename)

Returns a Quiet Tread takeoff for the stair object referred to by ENAME

(stair-rail-assembly side)

Returns the assembly name of the stair rail on SIDE of this stair.

WITH-DATA

VARS:
(SIDE STR (MEMBER SIDE '("i" "o" "l" "r")))
(NUMBER STR)
(LEVEL STR)

(stair-slope)

Returns the nosing line in slope-intercept form.

WITH-DATA

(stair-stn-p)

Returns T when this stair has STN

WITH-DATA

(stair-guard--num loc)

Returns the number of a guard rail

This function calculates the -N at the end of a stair guard rail's sequence number based
on location LOC. See stair-guard-assembly for format of LOC.

If there is no guard rail at LOC, returns nil. If there is only one guard rail on the
flight, returns 0, indicating numbers are unnecessary.

WITH-DATA

VARS:
(LOC STR (MEMBER LOC '("ibot" "obot" "itop" "otop" "btwn")))