3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD - Instructions Controlling Generation of Documents

The structure of ICGD:
- Header
- Definition of data tables
If there is not any data tables to be plotted on the drawing sheet or
not any separate listings to be printed, ICGD is very simple (only
header definition):

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Header

h1; h2; h3;

h1, a string of characters specifying the name of the drawing sheet object
(note the extension .sh). If this string is left empty then ICGD generates
only files to be printed.
h2, an empty field. Must be present so that this ICGD definition is
compatible with older versions.
h3, a label for the ICGD. Used to identify this ICGD in selection lists from
which a user is selecting one ICGD.
2

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables

Data tables contain a set of instructions for each data table that is to
be generated from the m-file. There can be several data tables in
one icgd, e.g. bom, cut list, weld list.
The structure of one instruction set:
Control block
Fields from catalog parts
Plot title columns (not for tables to be printed)
Print header fields (not for tables to be plotted)
Print columns (not for tables to be plotted)
Selection rules
Sorting rules
Summing rules
Paragraph title

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Control block

c1; c2; c3; c4;

c1, the extension for the file to which the data table is to be
generated. Several tables can be stored to the same file.
c2, the name of the drawing sheet to which this table will be
plotted. If empty and field c3 is also empty then table will be
plotted to the same drawing sheet as the drawing.
c3, the pathname to a printer spool directory. If empty then the
table will be plotted.
c4, the name of the format control object that is used to generate a
print file of this table.

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Fields from Catalog part

Lists all reference abbreviations for data fields that are to be
inserted into this table. The m-file is expanded to contain the fields
defined here.
The structure is: f1; f2; ....;;
The end of the list is indicated by an empty field.

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Plot title columns

Defines columns of title records that are plotted at the beginning of
the table. If the data table is to be printed then this section must be
omitted.
ptc1, the name of the column. To get this column plotted the
associated table in the drawing sheet should have a column where
ptc1 is referenced. An empty string indicates the end of columns.
ptc2, a string of characters specifying the value string for "ptc1".
ptc3, a number specifying the ordinal number of title record to
which this column belongs to. Columns that are to appear on the
same line (record) should be defined consecutively. Four title lines
are available, numbered 0-3.

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Print header field

Field definitions that are to be printed at the beginning of the report. If
the data table is to be plotted then this section must be omitted.
Values are read from
*.pm\docu\*.h-file
The structure of a print header field:
3 phf1, a name for the field. The associated format control file
must contain a page-relative header field that has the same
name as that given here.
3 phf2, is user allowed to edit the text (1 = allow edit, 0 = no edit).
3 phf3, C-print format that controls how the strings result from
the data requests are combined to form the printed output. This
format must contain as many occurrences of "%s" as there are
data requests.
7

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Data request

Data requests consists of a variable number of data requests each
having the following structure:

r1; r2; r3;

r1, a string of characters (max. 3) identifying the target of the
request. This can be a reference to named strings found in the
header file of the document, or it can be a reference to system
parameters such as date, time, etc. An empty string indicates the
end of data requests (the rest of the fields must be omitted).
r2, a number specifying the type of the target data
r3, a format string specifying how the target data is to be
processed to convert it to desired representation.
8

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Data request

Target data
>= 0 Target data represents a numeric quantity and this field
specifies the quantity type of the value (NS, LENGTH ...).
-1 Target data is not converted but used as such (string).
Field r3 is ignored
-2 Target data is time in seconds measured from 1.1.1970 and its
date part is to be converted as specified in 'r3'.
0 mm/dd/yy
1 dd.mm.yy
3 dd-mm-yy
-3 Target data is time in seconds measured from 1.1.1970 and its
time part is to be converted as specified in 'r3'.
0 hh:mm
1 hh:mm:ss
9

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

ICGD Data Tables / Data request

Target data
For example PM's "mot" tag can be converted to human
understood format using the following data requests:
mot; -2;0; /* output date as dd/mm/yy */
mot; -3;0; /* output time as hh:mm */

10

S O F T W A R E

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Print columns

Defines the contents of columns that appear on a printed list.

Definition of a print column:

Columns
pc1, the name of the column. The associated format control
file must contain an element having this name.
pc2, controls how the strings resulting from the data requests
are combined to form the output for this column. This string
must contain as many occurrences of "%s" as there are data
requests.
Data requests
11

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Selection rules

Defines which objects of the m-file are included in this table. If no
rules are given then all entries in the m-file are included.
The definition of a selection rule is:
ser1; ser2; ser3;
ser1, the field from an m-file record that is used as an argument in
this rule.
ser2, the lower limit for the selection argument.
ser3, the upper limit for the selection argument.
The rule is satisfied by entries where the specified field has a
value that is greater or equal to ser2 and less than ser3.

12

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Selection rules

ptn; 0; zzzzz;
/*select entries having partnumber*/
obt; 1; 2;
/* select equipments (obt 1=equipment)*/
vpo; 0; zzzzzz; /* select all objects with vpo tag */
pid; #; zzzzzz; /* select all objects having pid*/
sor; 0; 0020;
/* select objects with sor tag value from 0 to 19*/
Note, the value 20 is not included!
If ser2 begins with character '!' then the rule is reversed i.e. rule is
true if value is less than ser2 or greater or equal than ser3.
vpo; !0; zzzzzz; /* select objects without vpo tag*/

13

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Sorting rules

The order in which the entries are output. Each rule defines one key
field. The primary key is defined first.
A sort rule is defined:
so1; so2;
so1, the field from an m-file record that is used as the sort key.
so2, the type of the argument and order of sort
0 - sort numbers into ascending order
1 - sort numbers into descending order
2 - sort character strings into ascending order;
3 - sort character strings into descending order
vpo; 2;

/* sort by vpo tag into ascending order*/

14

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Summing rules

Fields that must be equal in consecutive entries (in sorted order)
before they can be combined into one entry.
When entries are combined the following fields are summed: length,
quantity and area.
The structure of a summing rule is: f1; f2; ...;;

The end of summing rules is indicated by an empty field name.

15

3 D

P L A N T

D E S I G N

A N D

E N G I N E E R I N G

S O F T W A R E

ICGD Data Tables / Paragraph title

A table can be divided into paragraphs when the output records of
the table are generated. A paragraph contains entries in which the
primary sort key has the same value. Each paragraph is preceded by
an output record containing one field - title. For example in the bill of
material of an iso a paragraph could contain all parts that belong to
one spool.
The structure of a paragraph is: pt1; pt2;
pt1, the name of the output field. An empty string indicates that
paragraphs are not used.
pt2, the value of the primary sort key is output to the requested
column. The format must contain one occurrence of "%s". This
field must be present even if field pt1 is empty.

16