pete
/
psc
1
0
Fork 0
Code Releases Activity

Build docs

Browse Source 
- fix doc bug with pipe-bend-lines
master
Pete Ley 2 months ago
parent 6ea130ae83
commit 1161da6703
9 changed files with 137 additions and 27 deletions
Show Stats Download Patch File Download Diff File

52
docs/code-manual/fab-guard.html
Unescape View File

@ -0,0 +1,52 @@
<!doctype html>
<html>
<head>
<title>fab/guard.lsp | PSC Code Manual</title>
<link rel="stylesheet" href="style.css" />
</head>
<body>
<h1><a href="./index.html">PSC Code Manual</a></h1>
<div id="content">
<h2>fab/guard.lsp <a href="../../fab/guard.lsp">[src]</a></h2>
<pre class="fulldoc">Functions for guard fab drawings</pre>
<table>
<thead>
<h3>Functions</h3>
<th>Function signature</th>
<th>Description</th>
</thead>
<tbody>
<tr>
<td class="funcsig"><a href="fab-guard.html#fab-combine-guards">(<span class="funcname">fab-combine-guards</span> guards)</a></td>
<td>Uses <a href="fab-util.html#fab-combine-like-data">fab-combine-like-data</a> to combine GUARDS</td>
</tr>
<tr>
<td class="funcsig"><a href="fab-guard.html#make-guard-fabs">(<span class="funcname">make-guard-fabs</span> guards)</a></td>
<td>Create all fab drawings for GUARDS</td>
</tr>
</tbody>
</table>
<section>
<h3 id="fab-combine-guards" class="funcsig">(<span class="funcname">fab-combine-guards</span> guards)</h3>
<pre class="fulldoc">Uses <a href="fab-util.html#fab-combine-like-data">fab-combine-like-data</a> to combine GUARDS</pre>
</section>
<section>
<h3 id="make-guard-fabs" class="funcsig">(<span class="funcname">make-guard-fabs</span> guards)</h3>
<pre class="fulldoc">Create all fab drawings for GUARDS
Essentially a composition of <a href="fab-util.html#make-generic-fab">make-generic-fab</a> and <a href="fab-guard.html#fab-combine-guards">fab-combine-guards</a></pre>
</section>
</div>
</body>
</html>

15
docs/code-manual/fab-util.html
Unescape View File

@ -49,6 +49,11 @@
<td>Prompts the user to choose a material description via dialog and returns it</td>
</tr>
<tr>
<td class="funcsig"><a href="fab-util.html#hardware-galv-desc">(<span class="funcname">hardware-galv-desc</span> desc)</a></td>
<td>Returns a hardware description that accounts for galvanization</td>
</tr>
<tr>
<td class="funcsig"><a href="fab-util.html#make-fab-dwgs">(<span class="funcname">make-fab-dwgs</span> types enames)</a></td>
<td>Makes all the TYPES of fab drawings using data from ENAMES</td>
@ -121,6 +126,14 @@ Similarity is based on equivalence of the values of all keys in KEYS.</pre>
<pre class="fulldoc">Prompts the user to choose a material description via dialog and returns it</pre>
</section>
<section>
<h3 id="hardware-galv-desc" class="funcsig">(<span class="funcname">hardware-galv-desc</span> desc)</h3>
<pre class="fulldoc">Returns a hardware description that accounts for galvanization
VARS:
(DESC STR)</pre>
</section>
<section>
<h3 id="make-fab-dwgs" class="funcsig">(<span class="funcname">make-fab-dwgs</span> types enames)</h3>
<pre class="fulldoc">Makes all the TYPES of fab drawings using data from ENAMES</pre>
@ -134,7 +147,7 @@ DATA is the data list of properties and ENT-TYPE is either 'stair or 'land.
VARS:
(DATA LIST)
(ENT-TYPE SYM (MEMBER ENT-TYPE '(STAIR LAND)))</pre>
(ENT-TYPE SYM (MEMBER ENT-TYPE '(STAIR LAND GUARD)))</pre>
</section>
<section>

2
docs/code-manual/files.json
View File

File diff suppressed because one or more lines are too long

39
docs/code-manual/index.html
Unescape View File

@ -73,6 +73,11 @@
<td>Support functions for FABDATA</td>
</tr>
<tr>
<td><a href="./fab-guard.html">fab/guard.lsp</a></td>
<td>Functions for guard fab drawings</td>
</tr>
<tr>
<td><a href="./fab-handrail-return.html">fab/handrail-return.lsp</a></td>
<td>Functions for handrail return fab drawings</td>
@ -353,7 +358,7 @@
<table>
<thead>
<h3>Public Functions A-Z (709 documented)</h3>
<h3>Public Functions A-Z (713 documented)</h3>
<th>Function Signature</th>
<th>Description</th>
</thead>
@ -1872,6 +1877,13 @@
<tr>
<td class="funcsig"><a href="fab-guard.html#fab-combine-guards">(<span class="funcname">fab-combine-guards</span> guards)</a></td>
<td>Uses <a href="fab-util.html#fab-combine-like-data">fab-combine-like-data</a> to combine GUARDS</td>
</tr>
<tr>
<td class="funcsig"><a href="fab-land.html#fab-combine-lands">(<span class="funcname">fab-combine-lands</span> lands)</a></td>
<td>Uses <a href="fab-util.html#fab-combine-like-data">fab-combine-like-data</a> to combine LANDS</td>
@ -2246,6 +2258,13 @@
<tr>
<td class="funcsig"><a href="fab-util.html#hardware-galv-desc">(<span class="funcname">hardware-galv-desc</span> desc)</a></td>
<td>Returns a hardware description that accounts for galvanization</td>
</tr>
<tr>
<td class="funcsig"><a href="util-xdata.html#has-duplicate-keys-p">(<span class="funcname">has-duplicate-keys-p</span> data)</a></td>
<td>Returns T if any keys in data list DATA are repeated</td>
@ -2623,6 +2642,13 @@
<tr>
<td class="funcsig"><a href="fab-guard.html#make-guard-fabs">(<span class="funcname">make-guard-fabs</span> guards)</a></td>
<td>Create all fab drawings for GUARDS</td>
</tr>
<tr>
<td class="funcsig"><a href="fab-handrail-return.html#make-handrail-return-fab">(<span class="funcname">make-handrail-return-fab</span> finish returns)</a></td>
<td>Uses <a href="rail-util.html#make-rail-fab-common">make-rail-fab-common</a> to create a handrail return spreadsheet</td>
@ -2736,6 +2762,8 @@
<tr>
<td class="funcsig"><a href="stair-details.html#material-func">(<span class="funcname">material-func</span> num)</a></td>
<td>If a material function for detail NUM exists, calls it and returns its value</td>
@ -3871,8 +3899,6 @@
@ -3981,6 +4007,13 @@
<tr>
<td class="funcsig"><a href="stair-details.html#tc-bolt-desc">(<span class="funcname">tc-bolt-desc</span> desc)</a></td>
<td>Returns the proper TC bolt description, taking into account finish</td>
</tr>
<tr>
<td class="funcsig"><a href="util-test.html#test-build">(<span class="funcname">test-build</span>)</a></td>
<td>Bootstraps test build process and opens a new blank drawing to carry it out.</td>

13
docs/code-manual/stair-details.html
Unescape View File

@ -164,6 +164,11 @@ directory, arranged by series.</pre>
<td>Returns can spacing as a list of X offsets from end of stringer</td>
</tr>
<tr>
<td class="funcsig"><a href="stair-details.html#tc-bolt-desc">(<span class="funcname">tc-bolt-desc</span> desc)</a></td>
<td>Returns the proper TC bolt description, taking into account finish</td>
</tr>
<tr>
<td class="funcsig"><a href="stair-details.html#top-chkr-haunch-material">(<span class="funcname">top-chkr-haunch-material</span>)</a></td>
<td>Returns the material list for a top checker plate haunch</td>
@ -456,6 +461,14 @@ VARS:
WITH-DATA</pre>
</section>
<section>
<h3 id="tc-bolt-desc" class="funcsig">(<span class="funcname">tc-bolt-desc</span> desc)</h3>
<pre class="fulldoc">Returns the proper TC bolt description, taking into account finish
VARS:
(DESC STR)</pre>
</section>
<section>
<h3 id="top-chkr-haunch-material" class="funcsig">(<span class="funcname">top-chkr-haunch-material</span>)</h3>
<pre class="fulldoc">Returns the material list for a top checker plate haunch

2
docs/code-manual/stair-util.html
Unescape View File

@ -128,7 +128,7 @@ DIMOBJ is the dimension object. H/V is either the symbol 'h or 'v. 'h means to f
run dimension and 'v means to format it as a rise dimension.
VARS:
(H/V SYMBOL (MEMBER H/V '(H V)))
(H/V SYM (MEMBER H/V '(H V)))
(DIMOBJ VLA-OBJECT)</pre>
</section>

4
docs/code-manual/util-geometry.html
Unescape View File

@ -367,8 +367,8 @@ VARS:
<h3 id="pipe-bend-lines" class="funcsig">(<span class="funcname">pipe-bend-lines</span> segments-lst)</h3>
<pre class="fulldoc">Returns the bend lines for a PSC pipe with segments SEGMENTS-LST
Each element to SEGMENTS-LST should be a string. Assumes 1.66OD pipe, centerline radius of
2.83" and k value of 0.18.</pre>
Each element to SEGMENTS-LST should be a real number. Assumes 1.66OD pipe, centerline
radius of 2.83" and k value of 0.18.</pre>
</section>
<section>

33
docs/code-manual/util-object-table.html
Unescape View File

@ -128,6 +128,11 @@ operations.</pre>
<td>Change the last row to be a simple sum of weight column if necessary</td>
</tr>
<tr>
<td class="funcsig"><a href="util-object-table.html#mat-table--set-weight-column">(<span class="funcname">mat-table--set-weight-column</span> table row)</a></td>
<td>Does necessary formatting and sets the weight column</td>
</tr>
<tr>
<td class="funcsig"><a href="util-object-table.html#mat-table--update-marks">(<span class="funcname">mat-table--update-marks</span> table +- n row)</a></td>
<td>Update fab mark numbers in TABLE and callouts</td>
@ -173,11 +178,6 @@ operations.</pre>
<td>Performs all necessary fixes on TABLE</td>
</tr>
<tr>
<td class="funcsig"><a href="util-object-table.html#table--fix-row-height">(<span class="funcname">table--fix-row-height</span> table row orig-ht)</a></td>
<td>Constrains the row height to multiples of table base row height</td>
</tr>
<tr>
<td class="funcsig"><a href="util-object-table.html#table--format-column-name">(<span class="funcname">table--format-column-name</span> name)</a></td>
<td>Returns NAME as lowercase with spaces replaced by underscores</td>
@ -391,6 +391,8 @@ VARS:
<h3 id="mat-table--calc-weight-formula" class="funcsig">(<span class="funcname">mat-table--calc-weight-formula</span> table row)</h3>
<pre class="fulldoc">Returns the weight formula for a material description
For qty, weight, and length columns, if they are required and a null value is present, set the column to a default value. For weight and length, the default is 0. For qty, the default is 1 (Misc Material) or the number of assemblies (Material).
VARS:
(TABLE VLA-OBJECT (TABLE-P TABLE))
(ROW INT)</pre>
@ -404,6 +406,15 @@ VARS:
(TABLE VLA-OBJECT (TABLE-P TABLE))</pre>
</section>
<section>
<h3 id="mat-table--set-weight-column" class="funcsig">(<span class="funcname">mat-table--set-weight-column</span> table row)</h3>
<pre class="fulldoc">Does necessary formatting and sets the weight column
VARS:
(TABLE VLA-OBJECT (TABLE-P TABLE))
(ROW INT)</pre>
</section>
<section>
<h3 id="mat-table--update-marks" class="funcsig">(<span class="funcname">mat-table--update-marks</span> table +- n row)</h3>
<pre class="fulldoc">Update fab mark numbers in TABLE and callouts
@ -493,18 +504,6 @@ VARS:
(TABLE VLA-OBJECT (TABLE-P TABLE))</pre>
</section>
<section>
<h3 id="table--fix-row-height" class="funcsig">(<span class="funcname">table--fix-row-height</span> table row orig-ht)</h3>
<pre class="fulldoc">Constrains the row height to multiples of table base row height
If ROW height has changed from ORIG-HT, calls <a href="util-object-table.html#--shift-tables-maybe">--shift-tables-maybe</a>
VARS:
(TABLE VLA-OBJECT (TABLE-P TABLE))
(ROW INT)
(ORIG-HT REAL)</pre>
</section>
<section>
<h3 id="table--format-column-name" class="funcsig">(<span class="funcname">table--format-column-name</span> name)</h3>
<pre class="fulldoc">Returns NAME as lowercase with spaces replaced by underscores

4
util/geometry.lsp
Unescape View File

@ -84,8 +84,8 @@ bending."
(defun-q pipe-bend-lines (segments-lst / segment ret radius k)
"Returns the bend lines for a PSC pipe with segments SEGMENTS-LST
Each element to SEGMENTS-LST should be a string. Assumes 1.66OD pipe, centerline radius of
2.83\" and k value of 0.18."
Each element to SEGMENTS-LST should be a real number. Assumes 1.66OD pipe, centerline
radius of 2.83\" and k value of 0.18."
(setq radius 2.83
k 0.18)
(if (/= (rem (length segments-lst) 2) 0)

Write Preview
Loading…
Cancel
Save