building user defined symbol shapes

User Defined Symbol Shapes

Alias LimitedIndustrial Software Products

SPOOLGEN

Version 1

ISOGEN

March 1996ALIAS

BuildingUser Defined

Symbol Shapes

www.cadfamily.com EMail:[email protected] document is for study only,if tort to your rights,please inform us,we will delete

www.cadfamily.com

The contents of this publication must not be reproduced in whole or part, by anymeans whatsoever without the written consent of ALIAS Limited.

ISOGEN is a trademark of ICI plc

IDFGEN is a trademark of Alias Limited

Copyright © Alias Limited 1996 - All rights reserved



www.cadfamily.com

28Reference Documents

27Symbols construction pack

26spindle identification chart

15example input data (Five Examples)

14basic symbol types

7symbol file source data - 501 502 & 999 records

5Creating the binary symbols file

2Symbol Keys

1Introduction

Page

No.Topic



www.cadfamily.com

INTRODUCTION

Users of ISOGENTM and SPOOLGENTM may change the standard plottedshapes generated by the system - to shapes of their own design.For example, these are the standard shapes for globe valve and welding neckflange -

- which could be redefined so they look like this -

This is achieved by the user systematically building new symbol shapes andstoring the data in a User Defined Symbols File. This file is then called inat run time and any shapes found in it will automatically replace thestandard ones held in the program.

Note. In the remainder of this manual, where used, the term Isometricprogram refers to either ISOGEN or SPOOLGEN. This is because both programs use the same system of User DefinedSymbols - as described throughout this manual.


- 1 -www.cadfamily.com EMail:[email protected] document is for study only,if tort to your rights,please inform us,we will delete

www.cadfamily.com

SYMBOL KEYS

Output graphic shapes are controlled by Symbol keys (SKEY's) - whereeach type of component is identified by a unique combination of two or fourcharacter letters or numbers. For example, the Symbol Key for the globevalve on the previous page is VGFL - while for the welding neck flange it isFLWN.

VGFL FLWN

Symbol Key Structure.Most SKEY's contain four alpha characters, but some only have two, e.g. PL - while others contain a mixture of alpha characters and numbers,e.g. 01HG.Four character SKEY's have two parts where the leading two charactersusually denote the type of component, e.g. VG for globe valve, and the lasttwo denote the end condition, e.g. FL for Flanged, like this :-

VGFL

type of component

endtype

Here are some further SKEY examples :-VGBW - Globe valve with butt welding endsVBSC - Ball valve with screwed endsVGSW - Gate valve with socket weld endsFLSO - Slip on flangeFLBL - Blind flange



www.cadfamily.com

Special End Condition Characters.When preparing symbol data, where all types of end condition for acomponent need to being referred to, for example, a ball valve with any typeof end connection, then the SKEY may be expressed like this - VB**. Here, the double asterisks are used as wildcard characters which theisometric program interprets as meaning - all end conditions for that type ofvalve. This short cut method drastically cuts down on the amount of data requiredand saves you from having to create symbol data in a repetitious manner.

Which Shapes May be Changed.Not all Symbol Shapes may be redefined by the User. Certain ones, becauseof the nature of their shapes and how they are handled on the isometric areinherent to the program and cannot be redefined. This restriction appliesmainly to 'pipe based' fittings, such as :-

{ elbows{ pulled bends{ tees{ crosses

This restriction also applies to certain other symbols, for example, all of theBlock shapes and multi-way valves.

Important Note. Before attempting to redefine any symbol shape you mustrefer to the Appendix F Section of the ISOGEN Options Manual. There youwill find a tabulated list, containing for each symbol :-

{ Description{ SKEY{ basic outline shape { And a flag indicating whether or not that shape is User Definable

Only those symbols containing a Y in this last field may be redefined !



www.cadfamily.com

Here is an extract from that Appendix F showing two examples - onesymbol shape that may be User defined, and one that may not.Example 1.

YFLSWFlange - Socket Weld

UserDefinable(Yes/No)

PlottedIsometric

ShapeKeyDescription

This indicates that a socket weld flange may be User defined.

Example 2.

NELBWElbow - Butt Weld(90° and 45°)

UserDefinable(Yes/No)

PlottedIsometric

ShapeKeyDescription

Alternatively, this shows that a butt welding elbow may not.



www.cadfamily.com

CREATING THE BINARY SYMBOLS FILE

User Defined Symbol data exists in these two forms :-{ As original ASCII source data in an ordinary text file. This is created by

the User with a text editor and all the User defined Symbols to be usedmust exist in this file.

{ In 'compiled' binary' form. This is the form of file the isometricprograms use.

The steps that you must take to create the required binary file and make theUser Defined Symbols System operational are described here.

Inform the isometric program of the name of your binary Symbolsfile - SYMBOLS.BIN - by one of the following methods :-

{ For ISOGEN - set a -103 record in the IDF e.g. -103 /SYMBOLS.BIN

{ For SPOOLGEN - also set a -103 record like that above,but in the files section of the Options File

{ For IDFGEN - enter the filename in the ISOGEN.FLS fileagainst the BINARY-SYMBOLS entry e.g. BINARY-SYMBOLS SYMBOLS.BIN

3)

From this, create a binary version of the file using the programMAKE-SYM.BAT and name it suitably - e.g. SYMBOLS.BIN

2)

Use your text editor to enter the source data into an ASCII file andsave it with a suitable name - e.g. SYMBOLS.ASC

1)

Tip. Before step 1) - Draw your new shapes in a 2D drawing system suchas AutoCAD or MicroStation. Construct the shape with the origin point atX0,Y0 and then use the system's querying and recording facility to obtain allthe X-Y co-ordinate positions of the relevant points on the shape. For example, in AutoCAD set a log file running and use the ID command to'spot' the points. Finally, cut and paste information from the log file into thesymbols text file you are building. This method is particularly beneficial when constructing circles.



www.cadfamily.com

MAKE-SYM.BAT .This batch program, mentioned in step 2 of the previous page, when run tomake a binary Symbol File, operates like this :-

_______________________________________

Conversion of ISOGEN ASCII fitting file to BINARYEnter ASCII fitting file nameHit <RETURN> to exit from program

SYMBOLS.ASCEnter BINARY fitting file nameHit <RETURN> to exit from program

SYMBOLS.BINCreating BINARY fitting file nameBINARY fitting file successfully created

_______________________________________

Notes. 1) The lines in italics above are entered by the User in response to the two

program prompts.2) The associated program MAKE-ASC.BAT operates in an identical

manner.

Creating Symbols data using graphics construction software.Alias Limited do not currently supply an on-screen graphic tool for theconstruction of ISOGEN / SPOOLGEN symbol shapes. However, somecompanies have built their own systems to provide this facility. Such programs permit construction of the shapes interactively on a graphicsscreen with the output being written to the ASCII symbols file(SYMBOLS.ASC in the above example). Compilation of this file into therequired binary form then follows the actions listed above using the AliasLimited supplied program MAKESYM.BAT .



www.cadfamily.com

SYMBOL FILE SOURCE DATA - 501 502 & 999 RECORDS

A description of the Symbol File source data requirements is described,commencing on the next page.



www.cadfamily.com

ASCII file source File data - structure Definition.

This data extract shows the typical layout in the symbol source file. This example is for a new valve with the

501 V9FL VGFL 99SP 100 0 2 0 0 0 0 0 0 0 502 1 -475 0 2 -475 275 2 -400 275 2 -400 -275 0 502 2 -475 -275 2 -475 0 1 475 0 2 475 275 0 502 2 400 275 2 400 -275 2 475 -275 2 475 0 0 502 1 -400 0 2 0 275 2 400 0 2 0 -275 0 502 2 -400 0 1 475 0 0 0 0 0 0 0 0 999As shown above, there are only three record types in the User Defined Symbol file - 501 502 and 999. These are explained belo 501 Type Record - Outline.There is only ever one 501 type record for each defined Symbol shape. It is a 14 field record structured like this :-

flowarrow

orien-tation

dimen-sioned

recordtype SKEY

spindleSKEY

scalefactor

newSKEY

old

501 V9FL VGFL 99SP 100 0 2 0 0 0 0 0 0 0

pos4

pos15

pos20

pos10

pos29

pos53

pos37

pos45

502 Type Record - Outline.There may be many consecutive 502 type records for each defined Symbol shape. Like the 501 it is a 14 field record but is structured differently,recordtype action

penx pos y pos action

penx pos y pos

502 1 -475 0 2 -475 275 2 -400 275 2 -400 -275 0

pos4

pos14

pos22

pos30

pos46

pos38

User Defined Component Shapes


www.cadfamily.com

999 Record.In the case of this record type, there is only one per symbol source file. Itappears on the last line and is used to indicate the end of the file.

501 Record - Detailed Field Information.This record, which is a mixture of text and numeric data contains functionaltype information concerning the Symbol shape.

Spindle SKEY. Use this field on components that have aspindle (e.g. valve) - but only if you are allocating a newspindle SKEY to it. Leave the field blank if :-{ The component does have a spindle but you don't want to

change the standard one.{ The component does not have a spindle.If the main component type normally has a spindle but youwant to suppress it, enter the word NONE .

4

Old SKEY. This is the SKEY you enter if you are :-{ Defining a new shape for an existing SKEY.{ Defining a new shape that has a new SKEY - New SKEY's

must always be equated to an existing (Old) SKEY shape.

3

New SKEY. Only use if you are creating a new SKEY. If youare not, leave the field blank.

2Record I/D (always 501).1

FieldUse

FieldPosition

(Table is continued on the next page ==>)



www.cadfamily.com

Flow Arrow. Used to control the generation of an associatedFlow Arrow that may optionally be plotted alongside certaincomponent shapes to indicate the fluid flow direction in thepipeline. This is used only on in-line component types - e.g.Valves.Enter one of these values :-0 - Obey the Old SKEY setting.1 - Flow arrow Off.2 - Flow arrow On.Note. This setting works in conjunction with O.S. 17 - see theOPTIONS & ATEXT MANUAL for details.

7

Mirror. This field is used to describe the type of componentthat is being defined, in particular, non-symmetricalcomponents, e.g. Check Valve - SKEY CKFL. For these types of components, at the plotting stage, theprogram creates a flipped version by mirroring the defineddata. (This method of operation saves you from having tobuild both non-flipped and flipped cases of non-symmetricalcomponents).Enter one of these values :-0 - Normal value - To signify a regular symmetrical

component. 1 - Use on non-symmetrical 'valve type' components e.g.

check valve - where a mirrored version is needed. 2 - Use on reducers - where a mirrored version is needed. 3 - Use on flanges - where a mirrored version is needed.

6

Scale Factor. Normally enter a value of 100 - when the shapewill be plotted at the normal scale. Enter a value > 100 toincrease the plotted scale or < 100 to decrease the plotted scaleproportionally. Note. This scaling field should only be used to scale individualSKEY components. The preferred method of scaling plottedshapes generally is by controls in the Drawing Definition File(DDF).

5

FieldUse

FieldPosition

(Table is continued on the next page ==>)



www.cadfamily.com

Spare.14Spare.13Spare.12Spare.11Spare.10Spare.9

Dimensioning. Used to control the generation of a dimensionacross the component on the isometric. This is used only oncertain in-line component types - e.g. Valves.Enter one of these values :-0 - To obey the Old SKEY setting.1 - Turn Dimension Off.2 - Turn Dimension On.

8

FieldUse

FieldPosition



www.cadfamily.com

502 Record - Detailed Field Information.This type of record defines the actual Symbol shape. It contains onlynumeric data.Shapes are defined in terms of imaginary Pen Actions - move pen or plotline - at or between defined absolute x-y co-ordinate points. In addition,there are three special functions, namely Null, Tee Point and Spindle Point.Explanatory Notes.1) Each data definition point is comprised of a group of three successivedata fields, in this order :-

{ The required pen action - Move Pen (in up position) or Plot Line{ x position to move to{ y position to move to

It takes several of these points to make a complete shape - a complexSymbol shape needing more points than a simple one.2) Each data line in a 502 record may contain four such point definitions ingrouped formation - in fields 2, 3 & 4 -5, 6 & 7 - 8, 9 and 11, 12 & 13.Position 1 always contains the 502 record identifier and position 14 alwayscontains a null (0) value.3) Whereas there is only ever one 501 record for each define Symbol shape,there may be several 502 records, there being as many as is required todefine the complete shape.



www.cadfamily.com

Absolute x position - expressed in 1/100th millimetres. Absolute y position - expressed in 1/100th millimetres. These two values define where the previously defined penaction takes place.

36912

(Cols22467095)

Pen Action. Performs a particular pen function based on thespecified number.. 0 - Null. Causes no pen action to take place. Is mainly used

as a 'data filler' in field position 14 of lines of data thatare to be continued, or in successive fields in the last dataline of input at to 'pad out' the completed data to fieldposition 14.

1 - Move Pen To. Cause the pen to move to a new x-yposition without plotting a line between there and the previously defined position. This action is used when youwant to move to a new position and start plotting fromthere.

2 - Plot Line To. Used to draw a solid line between apreviously defined x-y point and the following new point.

3 - Tee / Tapping Point. Used to specify the tee point onteed-reducers and tapping-in points on other componentssuch as flanges and valves etc.

4 - Insulation indication.5 - Unused6 - Spindle Attachment Point. Use only on components

having a Spindle definition. e.g. Valves, Pipe Supports,etc.

25811

(Cols.14386286)

Record I/D (always 502).1

FieldUse

FieldPosition



www.cadfamily.com

BASIC SYMBOL TYPES

From a data structure point of view - there are three fundamental Symbol

Shape types :-

1) Normal In-line Components - such as :-

Straight through Valves

Reducers

Flanges

Normal in-line supports

2) Angle Components

Used for Angle Valves and Instruments where the following conditions must

be adhered to :-

P Only half the component shape is defined

P The new shape must be similar to the original angle shape

P The 'tee connection point' must be positioned at the apex of the defined

leg for the attachment of the other half of the component

3) Directional Supports

This type of support is defined as two elements :-

P A support point for the spindle to attach to

P In spindle form for the basic shape



www.cadfamily.com

EXAMPLE INPUT DATA

Input Data Preparation - Basic Information.1) In the 502 type data records, as indicated in the sketch below, each shape

must be defined on an X-Y grid in accordance with these rules :-{ The X0 Y0 origin point must be positioned at the bottom left hand

corner of the shape. All co-ordinates specified will then be above andto the right of this position to ensure that all input values are positive.(Negative co-ordinate values are not permitted).

{ Each shape must commence with an entry point and end with an ExitPoint. The Exit Point must be the greater of the two values. Both aredefined as Pen Action 1 - Move Pen To .

{ Components that have a Spindle must have a Spindle AttachmentPoint. Although not mandatory, it is recommended that this is inputimmediately before the Exit Point.

2) The indicated dimensions in the sketches included with each example arein mm's - in the input data in the accompanying tables they must be in100th mm's. For example, a point at 7.5 mm is input as 750 .

3) Body sections often consist of several elemental parts, for example, inexample 1 following there are two such parts - a 'bow tie' and thecentrally placed rectangle. In all the example inputs the data for each ofthese separate parts is made to commence on a new line.This method of data input is optional but where used, the previous linemust be concluded up to the end of the line of data with a series of zerotype records (0 0 0). This method of input has the advantage of making it easier to examinethe data and it also provides easier editing of the data if subsequentlyrequired.



www.cadfamily.com

Example 1 - Normal In-line Component.New Valve shape - SKEY VEFL - with new spindle

SKEY 16SP . Outline shape.

This type of component is built from two separate parts- a main bodysection and a spindle. These are combined by the Symbol program into asingle shape. In this example the separate symbols look like this :-

Main body. Spindle.Note that as shown here, spindles are always built in a lying down positionwith the attachment point at the left hand end.



www.cadfamily.com

Example 1 - Symbol Dimensions and Reference Points.

Input Data for Example 1. 501 16SP 01SP 100 0 0 0 0 0 0 0 0 0

502 1 0 200 2 650 200 2 650 400 2 500 200 0

502 2 650 0 2 650 200 1 650 200 0 0 0 0

501 VEFL VGFL 16SP 100 0 2 0 0 0 0 0 0 0

502 1 0 200 2 0 400 2 924 0 2 924 400 0

502 2 0 0 2 0 200 0 0 0 0 0 0 0

502 1 312 350 2 612 350 0 2 612 50 2 312 50

502 2 312 350 0 0 0 0 0 0 0 0 0 0

502 3 462 200 0 1 924 200 0 0 0 0 0 0

Explanatory Notes.1) The component has the new valve SKEY VEFL (new SKEY) - this is based on an existing valve 2) The spindle SKEY is a new one 16SP (new SKEY) - this is based on an existing spindle



www.cadfamily.com

Example 2 - Normal In-line Component.New Valve shape - SKEY VUFL - with existing spindle

SKEY 03SP . Part of the main body is a circular shape. Outline shape.

This component is being shown to demonstrate how a circular shape isconstructed. In this example the main body part looks like this :-

Main body. Only the main body part is shown here because the spindle used in thisexample is an existing one and so no new shape definition is needed for it.



www.cadfamily.com


Input Data for Example 2. 501 VUFL VGFL 03SP 100 0 2 0 0 0 0 0 0 0 502 1 0 250 2 0 450 2 75 450 2 75 50 0 502 2 0 50 2 0 250 0 0 0 0 0 0 0 502 1 1000 250 2 1000 50 2 925 50 2 925 450 0 502 2 1000 450 2 1000 50 0 0 0 0 0 0 0 502 1 75 350 2 271 350 1 75 150 2 271 150 0 502 1 730 350 2 925 350 1 730 150 2 925 150 0 502 1 500 0 2 375 33 2 283 125 2 250 250 0 502 2 283 375 2 375 467 2 500 500 2 625 467 0 502 2 717 375 2 750 250 2 717 125 2 625 33 0 502 2 500 0 0 0 0 0 0 0 0 0 0 0 502 3 500 250 1 1000 250 0 0 0 0 0 0 0 Explanatory Notes.1) This component has the new valve SKEY VUFL (new SKEY) - this is based on the existing valve 2) The spindle SKEY is an existing one 03SP - hence, other than the nomination of its 3) As shown here, it is recommended that when constructed, circles are made from 12 points (where points 1 and 12 are

number of input data points and the appearance of the circle on the isometric.



www.cadfamily.com

Example 3 - Normal In-line Component.Replacement Weld Neck flange shape - SKEY FLWN .

Outline shape.

This is a Flange example. Other new flange shapes that may be requiredwould be built in a similar way to this one.



www.cadfamily.com


Input Data for Example 3. 501 FLWN 100 3 0 0 0 0 0 0 0 0

502 1 0 275 2 0 550 2 100 550 2 100 450 0

502 2 500 325 2 500 225 2 100 100 2 100 0 0

502 2 0 0 2 0 275 1 500 275 0 0 0 0

Explanatory Notes.1) This component is a replacement for the existing flange SKEY FLWN . In this case this



www.cadfamily.com

Example 4 - Angle Component.New Angle Valve shape - SKEY VAFL - with existing spindle

SKEY 09SP .

Outline shape.

This component is being shown to demonstrate how angle components areconstructed.With angle components only one half is built - the isometric program thenautomatically fits the two halves together about the 'tee' point to form thecomplete shape.

Main body.Only the main body segment is shown here. The spindle used is an existingone and so no new shape definition is needed for it.



www.cadfamily.com


Input Data for Example 4. 501 VAFL AVFL 09SP 100 0 0 0 0 0 0 0 0 0

502 1 0 200 2 0 320 2 600 200 2 0 80 0

502 2 0 200 1 0 400 2 0 0 0 0 0 0

502 6 600 200 3 600 200 1 600 200 0 0 0 0

Explanatory Notes.1) This component has the new valve SKEY VAFL (new SKEY) - this is based on the existing angle valve 2) The spindle SKEY is an existing one 09SP - hence, other than the nomination of its 3) As shown here, for angle valves, only one half of the body is constructed.



www.cadfamily.com

Example 5 - Directional Pipe Support.New Pipe Support shape - SKEY SU20.

Outline shape.

Like Valves, Directional Pipe Supports are built from two separate parts- amain section and a spindle section. These are combined by the Symbolprogram into a single shape. In this example the two separate parts look likethis :-

Main SpindleSection. Section.

The Main Section is just a point that used to locate the Pipe Support on thepipe - and then like happens on a valve - the Spindle Section is attached to itto complete the shape. On the isometric, the indicated direction of theSupport is controlled from the specified direction of the Spindle in thePiping Data file. That is, the Spindle Section can be made to pivot aroundthe Main Section. .



www.cadfamily.com


Input Data for Example 5. 501 25SP 01SP 100 0 0 0 0 0 0 0 0 0

502 1 0 125 2 160 200 2 160 50 2 0 125 0

502 2 200 125 2 228 250 2 284 0 2 340 250 0

502 2 396 0 2 424 125 2 475 125 1 0 125 0

501 SU20 01HG 25SP 100 0 0 0 0 0 0 0 0 0

502 1 0 0 6 0 0 1 0 0 0 0 0 0

Explanatory Notes.1) This component has the new SKEY SU20 (new SKEY) - this is based on an existing 2) The spindle SKEY is a new one 25SP - this is based on the existing spindle



www.cadfamily.com

SPINDLE IDENTIFICATION CHART

All the standard spindle shapes are shown here so Users may use them ifrequired when building new symbol shapes. For example, you may want to create a valve shape that has a new bodyconstruction, but which is used in conjunction with one of these existingspindles.When required, all the spindle shapes shown here are accessed throughreference to their SKEY's.

08SP

15SP07SP

14SP06SP

(Long)13SP(Long)05SP

12SP04SP

11SP03SP

10SP02SP

09SP01SP

SHAPESKEYSHAPESKEY



www.cadfamily.com

SYMBOLS CONSTRUCTION PACK

To aid Users in the techniques of building their own Symbol shapes, AliasLimited have produced a 'Symbols Construction Pack'.The pack consists of this manual - together with a floppy disk containing thefollowing software and data :-

{ The batch programs MAKE-SYM.BAT and MAKE-ASC.BAT thatare referred to on page 5.

{ The binary symbol file creator program - FITA2B.EXE .{ Software to 'de-compile' a binary Symbol file back into ASCII form -

program FITB2A.EXE . (This program is useful if you want totake an existing binary symbol file from a 3rd party User and addyour own Symbols to it).

{ A sample Symbol file in ASCII format. This file contains all the fiveexamples shown earlier in this manual.

To obtain this pack you should contact your usual ISOGEN / SPOOLGENsupport agency.



www.cadfamily.com

REFERENCE DOCUMENTS

Two other Documents in the ISOGEN series from Alias Limited containingSymbol Shape information - and which the User should be aware of are asfollows :-

SKEY DIMENSIONS - Contains :-1) A list of all SKEY's.2) Fully dimensioned pictures of each standard Symbol.

ISOGEN OPTIONS MANUAL - Appendix F Contains :-Information in chart form showing for each Symbol - Description - SKEY - Plotted Isometric Shape - User Definable (YES/NO)



www.cadfamily.com

building user defined symbol shapes

Documents

welding neck

detailed field

symbol source

main body

defined symbol

spindle attachment

isogen options

user defined