Common Object
- Last UpdatedOct 27, 2023
- 1 minute read
The system uses one object that does all the work to produce Pipe Sketch Drawings, (do not have to use the form and graphics mode to produce a batch of drawings).
The common object is a global instance of a pipeSketches object called !!pipeSketch.
The Key Members:
|
Member |
Type |
Comment |
|---|---|---|
|
!!pipeSketch.createIn |
DBREF |
Must be an existing Registry ‑ REGI element |
|
!!pipeSketch.selectedTemplate |
DBREF |
Must be an existing Drawing ‑ DRWG element. |
|
!!pipeSketch.pipeSpool |
DBREF |
Must the an existing Pipe Spool ‑ PSPOOL element. |
Optional Members
|
Member |
Type |
Comment |
|---|---|---|
|
!!pipeSketch.logFile |
FILE |
The Form or User must write and read this file. |
|
!!pipeSketch..drawingPrefix |
STRING |
Default is ‘DR’. |
|
!!pipeSketch..sheetPrefix |
STRING |
Default is ‘S’. |
Other Members set and used in the background by the system:
|
Member |
Type |
Comment |
|---|---|---|
|
!!pipeSketch..type |
STRING |
Will always be ‘drawing’ or ‘drtmpl’. |
|
!!pipeSketch..pipePieces |
ARRAY |
System records the Pipe Pieces of the Pipe Spool. |
|
!!pipeSketch..drawing |
DBREF |
System records the new drawing. |
|
!!pipeSketch..sheet |
DBREF |
System records the new sheet. |
|
!!pipeSketch..backingSheet |
DBREF |
System records the backing sheet being used. |
|
!!pipeSketch..mtoHeadings |
ARRAY |
Array of strings read from backing sheet MTO table. |
|
!!pipeSketch..logData |
ARRAY |
Array of comment strings that user or form can read) |
An Example
|
!!pipeSketch.createIn = object DBREF (‘/MyRegistry’) |
|
!!pipeSketch.selectedTemplate = object DBREF (‘/MyTemplateDrawing’) |
|
!!pipeSketch.pipeSpool = object DBREF (‘/MyPipeSpool’) |
|
--Then to create the sketch |
|
!!pipeSketch.apply() |