User Defined Symbol Shapes

ISOGEN
SPOOLGEN

Building
User Defined
Symbol Shapes

Alias Limited Version 1

ALIAS Industrial Software Products March 1996
 User Defined Symbol Shapes

The contents of this publication must not be reproduced in whole or part, by any
means 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
 User Defined Symbol Shapes

Page

Topic No.

Introduction 1

Symbol Keys 2

Creating the binary symbols file 5

symbol file source data - 501 502 & 999 records 7

basic symbol types 14

example input data (Five Examples) 15

spindle identification chart 26

Symbols construction pack 27

Reference Documents 28
 User Defined Symbol Shapes

INTRODUCTION

Users of ISOGENTM and SPOOLGENTM may change the standard plotted

shapes generated by the system - to shapes of their own design.
For example, these are the standard shapes for globe valve and welding neck
flange -

- which could be redefined so they look like this -

This is achieved by the user systematically building new symbol shapes and
storing the data in a User Defined Symbols File. This file is then called in
at run time and any shapes found in it will automatically replace the
standard ones held in the program.
Note. In the remainder of this manual, where used, the term Isometric
program refers to either ISOGEN or SPOOLGEN.
This is because both programs use the same system of User Defined
Symbols - as described throughout this manual.

-1-
 User Defined Symbol Shapes

SYMBOL KEYS

Output graphic shapes are controlled by Symbol keys (SKEY's) - where

each type of component is identified by a unique combination of two or four
character letters or numbers. For example, the Symbol Key for the globe
valve on the previous page is VGFL - while for the welding neck flange it is
FLWN.

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 characters
usually denote the type of component, e.g. VG for globe valve, and the last
two denote the end condition, e.g. FL for Flanged, like this :-
VGFL
type of end
component type
Here are some further SKEY examples :-
VGBW - Globe valve with butt welding ends
VBSC - Ball valve with screwed ends
VGSW - Gate valve with socket weld ends
FLSO - Slip on flange
FLBL - Blind flange

-2-
 User Defined Symbol Shapes

Special End Condition Characters.

When preparing symbol data, where all types of end condition for a
component need to being referred to, for example, a ball valve with any type
of end connection, then the SKEY may be expressed like this - VB**.
Here, the double asterisks are used as wildcard characters which the
isometric program interprets as meaning - all end conditions for that type of
valve.
This short cut method drastically cuts down on the amount of data required
and 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, because
of the nature of their shapes and how they are handled on the isometric are
inherent to the program and cannot be redefined. This restriction applies
mainly to 'pipe based' fittings, such as :-
{ elbows
{ pulled bends
{ tees
{ crosses
This restriction also applies to certain other symbols, for example, all of the
Block shapes and multi-way valves.

Important Note. Before attempting to redefine any symbol shape you must
refer to the Appendix F Section of the ISOGEN Options Manual. There you
will 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 !

-3-
 User Defined Symbol Shapes

Here is an extract from that Appendix F showing two examples - one

symbol shape that may be User defined, and one that may not.
Example 1.
Plotted User
Description Key Isometric Definable
Shape (Yes/No)

Flange - Socket Weld FLSW Y

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

Example 2.
Plotted User
Description Key Isometric Definable
Shape (Yes/No)

Elbow - Butt Weld ELBW N

(90° and 45°)

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

-4-
 User Defined Symbol Shapes

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 used
must exist in this file.
{ In 'compiled' binary' form. This is the form of file the isometric
programs use.
The steps that you must take to create the required binary file and make the
User Defined Symbols System operational are described here.
1) Use your text editor to enter the source data into an ASCII file and
save it with a suitable name - e.g. SYMBOLS.ASC

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

3) Inform the isometric program of the name of your binary Symbols

file - 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 file
against the BINARY-SYMBOLS entry
e.g. BINARY-SYMBOLS SYMBOLS.BIN

Tip. Before step 1) - Draw your new shapes in a 2D drawing system such
as AutoCAD or MicroStation. Construct the shape with the origin point at
X0,Y0 and then use the system's querying and recording facility to obtain all
the 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 the
symbols text file you are building.
This method is particularly beneficial when constructing circles.

-5-
 User Defined Symbol Shapes

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

_______________________________________

Conversion of ISOGEN ASCII fitting file to BINARY

Enter ASCII fitting file name
Hit <RETURN> to exit from program
SYMBOLS.ASC
Enter BINARY fitting file name
Hit <RETURN> to exit from program
SYMBOLS.BIN
Creating BINARY fitting file name
BINARY 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 the
construction of ISOGEN / SPOOLGEN symbol shapes. However, some
companies have built their own systems to provide this facility.
Such programs permit construction of the shapes interactively on a graphics
screen with the output being written to the ASCII symbols file
(SYMBOLS.ASC in the above example). Compilation of this file into the
required binary form then follows the actions listed above using the Alias
Limited supplied program MAKESYM.BAT .

-6-
 User Defined Symbol Shapes

SYMBOL FILE SOURCE DATA -

501 502 & 999 RECORDS

A description of the Symbol File source data requirements is described,

commencing on the next page.

-7-
 User Defined Component Shapes

ASCII file source File data - structure Definition.

This data extract shows the typical layout in the symbol source file. This example

501 V9FL VGFL 99SP 100 0 2 0

502 1 -475 0 2 -475 275
502 2 -475 -275 2 -475 0
502 2 400 275 2 400 -275
502 1 -400 0 2 0 275
502 2 -400 0 1 475 0
999
As shown above, there are only three record types in the User Defined Symbol file

501 Type Record - Outline.

There is only ever one 501 type record for each defined Symbol shape. It is a 14 f
record new old spindle scale orien- flow dimen-
type SKEY SKEY SKEY factor tation arrow sioned

501 V9FL VGFL 99SP 100 0 2 0

pos pos pos pos pos pos pos pos

4 10 15 20 29 37 45 53

502 Type Record - Outline.

There may be many consecutive 502 type records for each defined Symbol shape.
record pen pen
type action x pos y pos action x pos y po

502 1 -475 0 2 -475 275

pos pos pos pos pos pos

4 14 22 30 38 46

-8-
 User Defined Component Shapes

999 Record.
In the case of this record type, there is only one per symbol source file. It
appears 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 functional
type information concerning the Symbol shape.

Field Field
Position Use
1 Record I/D (always 501).
2 New SKEY. Only use if you are creating a new SKEY. If you
are not, leave the field blank.
3 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.
4 Spindle SKEY. Use this field on components that have a
spindle (e.g. valve) - but only if you are allocating a new
spindle 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 you
want to suppress it, enter the word NONE .

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

-9-
 User Defined Component Shapes

Field Field
Position Use
5 Scale Factor. Normally enter a value of 100 - when the shape
will be plotted at the normal scale. Enter a value > 100 to
increase the plotted scale or < 100 to decrease the plotted scale
proportionally.
Note. This scaling field should only be used to scale individual
SKEY components. The preferred method of scaling plotted
shapes generally is by controls in the Drawing Definition File
(DDF).
6 Mirror. This field is used to describe the type of component
that is being defined, in particular, non-symmetrical
components, e.g. Check Valve - SKEY CKFL.
For these types of components, at the plotting stage, the
program creates a flipped version by mirroring the defined
data. (This method of operation saves you from having to
build both non-flipped and flipped cases of non-symmetrical
components).
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.
7 Flow Arrow. Used to control the generation of an associated
Flow Arrow that may optionally be plotted alongside certain
component shapes to indicate the fluid flow direction in the
pipeline. 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 the
OPTIONS & ATEXT MANUAL for details.

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

- 10 -
 User Defined Component Shapes

Field Field
Position Use
8 Dimensioning. Used to control the generation of a dimension
across the component on the isometric. This is used only on
certain 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.
9 Spare.
10 Spare.
11 Spare.
12 Spare.
13 Spare.
14 Spare.

- 11 -
 User Defined Component Shapes

502 Record - Detailed Field Information.

This type of record defines the actual Symbol shape. It contains only
numeric data.
Shapes are defined in terms of imaginary Pen Actions - move pen or plot
line - 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 successive
data 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 complex
Symbol shape needing more points than a simple one.
2) Each data line in a 502 record may contain four such point definitions in
grouped 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 always
contains 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 to
define the complete shape.

- 12 -
 User Defined Component Shapes

Field Field
Position Use
1 Record I/D (always 502).
2 Pen Action. Performs a particular pen function based on the
5 specified number..
8 0 - Null. Causes no pen action to take place. Is mainly used
11 as a 'data filler' in field position 14 of lines of data that
(Cols. are to be continued, or in successive fields in the last data
14 line of input at to 'pad out' the completed data to field
38 position 14.
62 1 - Move Pen To. Cause the pen to move to a new x-y
86) position without plotting a line between there and the
previously defined position. This action is used when you
want to move to a new position and start plotting from
there.
2 - Plot Line To. Used to draw a solid line between a
previously defined x-y point and the following new point.
3 - Tee / Tapping Point. Used to specify the tee point on
teed-reducers and tapping-in points on other components
such as flanges and valves etc.
4 - Insulation indication.
5 - Unused
6 - Spindle Attachment Point. Use only on components
having a Spindle definition. e.g. Valves, Pipe Supports,
etc.
3 Absolute x position - expressed in 1/100th millimetres.
6 Absolute y position - expressed in 1/100th millimetres.
9 These two values define where the previously defined pen
12 action takes place.
(Cols
22
46
70
95)

- 13 -
 User Defined Component Shapes

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

- 14 -
 User Defined Component Shapes

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 and
to 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 Exit
Point. The Exit Point must be the greater of the two values. Both are
defined as Pen Action 1 - Move Pen To .
{ Components that have a Spindle must have a Spindle Attachment
Point. Although not mandatory, it is recommended that this is input
immediately before the Exit Point.

2) The indicated dimensions in the sketches included with each example are
in mm's - in the input data in the accompanying tables they must be in
100th 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, in
example 1 following there are two such parts - a 'bow tie' and the
centrally placed rectangle. In all the example inputs the data for each of
these separate parts is made to commence on a new line.
This method of data input is optional but where used, the previous line
must be concluded up to the end of the line of data with a series of zero
type records (0 0 0).
This method of input has the advantage of making it easier to examine
the data and it also provides easier editing of the data if subsequently
required.

- 15 -
 User Defined Component Shapes

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 body
section and a spindle. These are combined by the Symbol program into a
single 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 position
with the attachment point at the left hand end.

- 16 -
 User Defined Symbol Shapes

Example 1 - Symbol Dimensions and Reference Points.

Input Data for Example 1.

501 16SP 01SP 100 0 0 0 0
502 1 0 200 2 650 200
502 2 650 0 2 650 200
501 VEFL VGFL 16SP 100 0 2 0 0
502 1 0 200 2 0 400
502 2 0 0 2 0 200
502 1 312 350 2 612 350
502 2 312 350 0 0 0
502 3 462 200 0 1 924 20

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

- 17 -
 User Defined Symbol Shapes

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 is

constructed. 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 this
example is an existing one and so no new shape definition is needed for it.

- 18 -
 User Defined Symbol Shapes

Example 2 - Symbol Dimensions and Reference Points.

Input Data for Example 2.

501 VUFL VGFL 03SP 100 0 2 0 0
502 1 0 250 2 0 450
502 2 0 50 2 0 250
502 1 1000 250 2 1000 50
502 2 1000 450 2 1000 50
502 1 75 350 2 271 350
502 1 730 350 2 925 350
502 1 500 0 2 375 33
502 2 283 375 2 375 467
502 2 717 375 2 750 250
502 2 500 0 0 0 0
502 3 500 250 1 1000 250
Explanatory Notes.
1) This component has the new valve SKEY VUFL (new SKEY) - this is based o
2) The spindle SKEY is an existing one 03SP - hence, other than the nominatio
3) As shown here, it is recommended that when constructed, circles are made from
number of input data points and the appearance of the circle on the isometric.

- 19 -
 User Defined Symbol Shapes

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 required
would be built in a similar way to this one.

- 20 -
 User Defined Symbol Shapes

Example 3 - Symbol Dimensions and Reference Points.

Input Data for Example 3.

501 FLWN 100 3 0 0 0
502 1 0 275 2 0 550
502 2 500 325 2 500 225
502 2 0 0 2 0 275
Explanatory Notes.
1) This component is a replacement for the existing flange SKEY FLWN . In this

- 21 -
 User Defined Symbol Shapes

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 are

constructed.
With angle components only one half is built - the isometric program then
automatically fits the two halves together about the 'tee' point to form the
complete shape.

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

- 22 -
 User Defined Symbol Shapes

Example 4 - Symbol Dimensions and Reference Points.

Input Data for Example 4.

501 VAFL AVFL 09SP 100 0 0 0 0
502 1 0 200 2 0 320
502 2 0 200 1 0 400
502 6 600 200 3 600 200

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

- 23 -
 User Defined Symbol Shapes

Example 5 - Directional Pipe Support.

New Pipe Support shape - SKEY SU20.

Outline shape.

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

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

- 24 -
 User Defined Symbol Shapes

Example 5 - Symbol Dimensions and Reference Points.

Input Data for Example 5.

501 25SP 01SP 100 0 0 0 0
502 1 0 125 2 160 200
502 2 200 125 2 228 250
502 2 396 0 2 424 125
501 SU20 01HG 25SP 100 0 0 0 0
502 1 0 0 6 0 0

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

- 25 -
 User Defined Symbol Shapes

SPINDLE IDENTIFICATION CHART

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

01SP 09SP

02SP 10SP

03SP 11SP

04SP 12SP

05SP (Long) 13SP (Long)

06SP 14SP

07SP 15SP

08SP

- 26 -
 User Defined Symbol Shapes

SYMBOLS CONSTRUCTION PACK

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

{ The batch programs MAKE-SYM.BAT and MAKE-ASC.BAT that

are 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 to
take an existing binary symbol file from a 3rd party User and add
your own Symbols to it).
{ A sample Symbol file in ASCII format. This file contains all the five
examples shown earlier in this manual.

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

- 27 -
 User Defined Symbol Shapes

REFERENCE DOCUMENTS

Two other Documents in the ISOGEN series from Alias Limited containing
Symbol Shape information - and which the User should be aware of are as
follows :-

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)

- 28 -