interplot for micro station

InterPlot for MicroStation July 2001

II

Copyright © 2001 Bentley Systems, Inc.

All Rights Reserved

Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains confidential and proprietary information of Bentley Systems and/or third parties which is protected by copyright and trade secret law and may not be provided or otherwise made available without proper authorization.

Although this copyright protects the content of this Help file as the Intellectual Property of Bentley Systems, Bentley Systems grants you, the user, permission to print any topic in this Help file for your personal use while operating the software.

Restricted Rights Legend

Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c) (1) (ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs (c) (1) and (2) of Commercial Computer Software---Restricted Rights at 48 CFR 52.227-19, as applicable.

Unpublished---rights reserved under the copyright laws of the United States.

Bentley Systems, Inc.

Warranties and Liabilities

All warranties given by Bentley Systems about software are set forth in your purchase contract, and nothing stated in, or implied by, this document or its contents shall be considered or deemed a modification or amendment of such warranties.

Bentley Systems believes the information in this publication is accurate as of its publication date. The information and the software discussed in this document are subject to change without notice and is subject to applicable technical product descriptions. Bentley Systems is not responsible for any error that may appear in this document.

The software discussed in this document is furnished under a license and may be used or copied only in accordance with the terms of this license.

Trademarks

Bentley Systems, the "B" Bentley logo, MicroStation, and InterPlot are registered trademarks of Bentley Systems, Incorporated. Digital Print Room is a trademark of Bentley Systems, Incorporated. Microsoft, Windows, Windows NT, and Windows 2000 are registered trademarks of Microsoft Corporation. AutoCAD is a registered trademark of Autodesk. Paint Shop Pro is a trademark of Jasc Software, Inc. Other brands and product names are trademarks of their respective owners.

T A B L E O F C O N T E N T S

Contents

Introduction to InterPlot .................................................................................... 1-1

The Plotting Interfaces ...................................................................................... 2-1

Using Settings Files........................................................................................... 3-1

Plot Resymbolization......................................................................................... 4-1

Managing Resource Files.................................................................................. 5-1

InterPlot Client Configuration........................................................................... 6-1

InterPlot Server and the Server Utilities .......................................................... 7-1

InterPlot Drivers ................................................................................................. 8-1

Using InterPlot with other Windows Applications.......................................... 9-1

C H A P T E R 1 Introduction to InterPlot

InterPlot for MicroStation

What is InterPlot Client?

InterPlot Client is the client component of a network production plotting system (InterPlot). It is designed to submit plots and plot sets to a plot server for printing and/or archiving. These plots and plot sets can consist of MicroStation® design files, AutoCAD® drawing files, Digital Archive data, and many types of raster data.

InterPlot Client includes Organizer, a Windows application that can plot entire drawing sets in a single step. InterPlot Client also provides dialog boxes that run inside MicroStation or AutoCAD, and command line interfaces for unattended batch plotting.

Workflow

A typical InterPlot configuration consists of one or more plot servers and a (typically) larger number of workstations running InterPlot client products. Using InterPlot Client, you can submit plot jobs to the plot server for printing and/or digital archiving.

Note For plot production, use InterPlot Server on the plot server. For plot production and/or digital archiving, use a Digital Print Room product on the plot server.

1-1

What is InterPlot Professional?

InterPlot Professional is a stand-alone production plotting system designed to plot MicroStation design files, AutoCAD drawing files, raster files, and Digital Archive data. In addition, InterPlot Professional can act as a client in a networked environment to submit plots and plot sets to a plot server for printing and/or archiving.

InterPlot Professional automatically selects the most logical means to produce hard copy plots. When you submit a plot or plot set, the software determines whether or not InterPlot Server or a Digital Print Room product is available to drive the chosen plotter. If either product is available, InterPlot Professional submits the plot to the plot server for processing; otherwise, InterPlot Professional processes the plot itself. However, InterPlot Professional is not a server product and cannot accept plot jobs submitted by other computers.

Workflow

The following InterPlot configuration illustrates how InterPlot Professional can be used as a client in a networked environment, offloading plot processing to InterPlot Server or to a Digital Print Room product for printing and/or archiving. The configuration also illustrates how InterPlot Professional can be used as a stand-alone product.

Note For plot production, use InterPlot Server on the plot server. For plot production and/or digital archiving, use a Digital Print Room product on the plot server.

1-2

The Plotting Interfaces

This product is designed to plot AutoCAD drawing files, MicroStation design files, many types of raster files, and DPR files. The following plotting interfaces are available:

InterPlot Organizer

The APLOT Dialog Box (for plotting inside AutoCAD)

The APLOT Command Line

The IPLOT Dialog Box (for plotting inside MicroStation)

The IPLOT Command Line

Using these interfaces, you can plot both inside and outside of AutoCAD and MicroStation. The dialog interface allows you to plot from within the CAD environment, while the command line and Organizer interfaces operate outside the CAD environment.

All five interfaces allow plot resymbolization; the ability to change the appearance of a plot. To make your workflow more efficient, InterPlot Organizer provides you with the ability to create plot sets. Plot sets allow you to replot a set of drawings exactly like they were plotted the first time.

1-3

Upgrading to InterPlot Client/Professional

There are two ways to upgrade to InterPlot Client/Professional 10.0. You can remove the previous version first and then install the new software, or you can leave the previous installation and overwrite it with the new software. Each method affects your current configuration differently.

If you removed a previous version first — The software was installed as if it were being installed for the first time, setting all customizable variables to standard defaults. You must now copy your previously saved configuration files, settings files, and resource files, to the proper directories.

If you overwrote a previous version — The new software was installed in the same location as the previous software with the following differences for the IPLOT component:

Configuration files — The IPLOTSRV.CFG configuration file is now delivered to C:\Program Files\Common Files\InterPlot\iplot\config. IPLOT no longer reads files stored in the \config\project or \config\system directories.

Resource files — Default IPLOT resource files (patterns and line styles) are delivered to \resrc\system. IPLOT no longer reads files stored in the \resrc\project directory. Move your customized IPLOT resource files to the new \resrc\custom directory.

InterPlot now uses MicroStation font and line style resources. For more information see Using MicroStation Resource Files.

Note If you are using Windows NT, you must have administrator privileges to upgrade this product.

1-4

Registering the Product

You can use the InterPlot Client Configure utility to properly register your software. InterPlot products that are not registered properly will produce plots containing watermarks.

To register the software

1 Select Start->Programs->InterPlot Utilities->InterPlot Client Configure.

2 In the InterPlot Client Configure dialog box, click Register.

3 In the InterPlot Client Configure - Register dialog box, click Register Online.

Note The computer name and computer code is displayed on this dialog. You will need this information to properly register your software.

4 From the Bentley Product Registration Page, click Commercial Product Registration.

5 To register a Bentley product, please fill out this form and click the REGISTRATION button when you have answered all the questions.

6 You will receive an email from Bentley Systems containing the license file. Save this file into the c:\Program Files\Common Files\InterPlot\Licensing folder to complete the registration process.

Note The Register dialog box contains a link that displays the filename for the license file.

1-5

General Features

The following is a general summary of new features:

New Product Licensing — Setup no longer requires you to enter a registration number during product installation. This means that InterPlot products will place a watermark on all plots until a license file is obtained from Bentley Systems.

Improved printer validation — All InterPlot client interfaces should come up faster on a slow network.

Plot Preview — Right-click inside the preview window to display the context menu. From the context menu, you can pan, zoom in, zoom out, and perform a window area.

Organizer Reverse Command — New Reverse command in Organizer enables you to reverse the print order.

ProjectWise Integration — InterPlot Organizer can now access files managed in a ProjectWise Datasource.

Feature Table Editors — New IPLOT and APLOT Feature Table Editors for plot resymbolization. The Feature Table editor provides a Windows GUI for writing Feature Tables.

Support for Windows Applications — InterPlot now provides a way for you to plot or archive data from various Windows applications. The InterPlot Client/Professional products include a new InterPlot Organizer Printer Driver for generating files from within Windows applications. These files can be plotted or archived using Organizer. Small-format documents saved in Adobe Acrobat’s Portable Document Format (PDF) can be associated with plot sets.

Indexing/Accounting — The InterPlot pen table language has been enhanced to enable automatic extraction of data from MicroStation and AutoCAD files. This data is written to the accounting file and can also be used as Digital Print Room attribute data (indexing). For more information, see the "How To" section of the InterPlot Reference Help.

1-6

IPLOT Features

New IPLOT features include the following:

Support for Descartes, Raster Manager, and Image Manager.

Plot Preview — right-click inside the preview window to display the context menu. From the context menu, you can pan, zoom in, zoom out, and perform a window area.

New IPLOT Feature Table Editor for plot resymbolization. The Feature Table editor provides a Windows GUI for writing Feature Tables. For more information about Feature Tables, double-click the Plotting MicroStation Data book.

New Pen Table keywords:

text_node_number — returns the text node number of a text node element.

ip_xsize_num — returns the plot xsize in numeric form.

ip_ysize_num — returns the plot ysize in numeric form.

ip_scale_num — returns the plot scale in numeric form.

Better Integration with your CAD products. The InterPlot Client Configure utility enables you to select which MicroStation product to use as the IPLOT print/preview engine. Also, you can select one or more MicroStation products to integrate with the IPLOT dialog interface.

Improved Align X and Align Y behavior. If some plots in a plot set come out rotated 180 degrees from the others, set the value of the IPLOT configuration variable IPLOT_ALIGN_METHOD to "coincident."

More flexible Scale field in the IPLOT Dialog — If you want to enter a scale of 200:1, you can now type in 200.

Improved workspace validation on the plot server. The new IPLOT configuration variable IPLOTSRV_WORKSPACE_VALIDATION enables InterPlot Server a more flexible approach for locating MicroStation user workspace configuration files.

Enhanced integration with ProjectWise document management system via the InterPlot Organizer interface.

1-7

APLOT Features

APLOT features include the following:

Support for AutoCAD R14 and later raster attachments. Plotting of raster attachments is supported for orthogonal plot rotations (0, 90, 180, and 270 degrees). Raster support is limited to the following file formats: BMP, JPEG, TIFF, CALS, PCX, and TGA.

Extensive support for AutoCAD 2000. For more information about AutoCAD 2000 features, double-click the Plotting AutoCAD Data book.

New APARM version/Maximum Filename Length

Long Object Names

Non-Plotting Layers

Non-Rectangular Viewports

Multiple Paper Space Layouts

Layout Plot Settings

Plot Style Resymbolization

Lineweights

ACIS Solids

New Entity Types

Hyperlinks

Plot Preview — Right-click inside the preview window to display the context menu. From the context menu, you can pan, zoom in, zoom out, and perform a window area.

New APLOT Dialog Retain Mode to retain the settings between sessions. For more information about the Dialog Retain mode, see Using the APLOT Dialog section.

New APLOT Pen Table Keywords to return the plot size/scale in numeric form.

ap_xsize_num — returns the plot xsize in numeric form.

ap_ysize_num — returns the plot ysize in numeric form.

ap_scale_num — returns the plot scale in numeric form.

Support for Project Search Paths to locate xrefs, linetype libraries, and other client resource files. For more information about Project Search Paths, see the Project-Based Resource Management section.

APLOT patterns can also be 1-bit raster images. Now you can use the same raster patterns for both APLOT and IPLOT.

1-8

Product Support

There are a variety of ways to get the latest technical information on Bentley products. These include:

Contacting your technical support provider. The main SELECT Support number is 800-778-4277.

Referencing the Frequently Asked Questions (or FAQ) document on the Bentley Web site at www.Bentley.com.

Searching the Online Help delivered with the product (note that some custom installation options will not include the online help).

Checking regularly with the Bentley Web site at selectservices.bentley.com for TechNotes, bulletins, and FAQs.

The electronic mail addresses for Bentley’s Technical Support are as follows:

U.S./Canada/Latin America [email protected]

Europe/Middle East/Africa [email protected]

Asia/Pacific [email protected]

Bentley’s World Wide Web SiteBentley’s World Wide Web Site is a central repository of information relating to Bentley products, services, and promotions.

To access Bentley’s World Wide Web Site, point your web browser to:

http://www.Bentley.com

Bentley SELECT (SM)A flyer on Bentley SELECT is included with MicroStation. With Bentley SELECT, you get e-mail, fax, Internet, and telephone access to premiere support, upgrades and updates, enhancements, utilities, training, technical newsletters, and much more. More information on Bentley SELECT can be found at http://selectservices.bentley.com/.

1-9

InterPlot On-line

For fast, convenient, up-to-the-minute information about Bentley Systems products and services, connect to www.Bentley.com. For InterPlot product information, connect to www.interplot.com.

1-10

Introduction to Plotting MicroStation DataNote Throughout this section the term IPLOT refers to the IPLOT component of InterPlot.

IPLOT is a production plotting solution for MicroStation users. IPLOT allows you to increase your overall plotting throughput and provides the capabilities essential to producing high quality plots from a wide range of devices ..

Client/Server Configurations

This release of InterPlot 10.0 software requires certain configurations for plot processing and plot preview of MicroStation data. The following sections describe the possible configurations for upgrading to InterPlot Client 10.0 and InterPlot Server 10.0.

InterPlot 9.1/10.0 Clients and InterPlot 10.0 Server

InterPlot Client 9.1/10.0 clients can submit plot jobs to a plot server with InterPlot Server 10.0 installed. MicroStation SE or MicroStation/J must be installed on either the client or plot server machine to support this configuration. InterPlot 9.1/10.0 clients are required to have MicroStation SE or MicroStation/J installed in order to support the plot preview feature.

InterPlot 8.0/9.0 Clients and InterPlot 10.0 Server

IPlot Client 8.0 and InterPlot 9.0 clients can submit plot jobs to a plot server with InterPlot Server 10.0 installed. The InterPlot 10.0 plot server is required to have MicroStation SE or MicroStation/J installed to process the incoming plot jobs. InterPlot 8.0/9.0 clients both support the plot preview feature.

InterPlot 9.1/10.0 Clients and InterPlot 8.0/9.0 Server

InterPlot Client 9.1/10.0 clients can submit plot jobs to a plot server with IPlot Server 8.0 or InterPlot Server 9.0 installed. The InterPlot 9.1/10.0 clients are required to have MicroStation SE or MicroStation/J installed to support the plot preview feature.

The IPLOT Plotting Process

Before you begin plotting MicroStation files with InterPlot, you should understand the basic IPLOT plotting process which involves three steps:

1 Creating the plot job

2 Generating the metafile

3 Submitting the plot.

You can use the IPLOT dialog box in the MicroStation environment, the Organizer interface outside of the MicroStation environment, or the IPLOT command line interface at the system prompt to complete these steps.

Creating the Plot Job

The first step in the plotting process is creating the plot job. When you create the plot job, you specify the design file you want to plot. You then specify settings for the plot such as the area of the design file you want to plot and the size, rotation, and orientation of the plotted image. You can specify these settings using the IPLOT dialog box, Organizer, or the command line interface.

IPARM Files

The settings you specify for a MicroStation plot job are saved in an IPARM file. Each step in the plotting process depends on the IPARM file.

IPARM files contain the following information:

Parameters used to create the plot job such as view, size, and rotation.

Design file information. (Each IPARM file is associated with a single design file and its associated reference files.)

Name of the printer to which you are submitting the plot.

Names of associated plot files such as a pen table, color table, or rendering attributes file.

Workspace name.

By default, IPARM files have a .i extension. (The IPARM file extension is defined by the configuration variable IPLOT_IPARM_EXT in the IPLOT.CFG file).

1-11

Generating the Metafile

The second step in the plotting process is generating the metafile.

If a pen table or feature table is attached to the IPARM file, the resulting metafile contains a compiled version of that pen table or feature table. The metafile also contains elements from the master design file, elements from any attached reference files and a copy of the IPARM file.

Submitting the Plot

The final step in producing a plot is to submit the metafile to the plot server. IPLOT submits the plot job based on information stored in the IPARM file to the specified printer.

The plot server receives the plot job and processes the metafile in association with the printer to produce the final plot.

1-12

C H A P T E R 2 The Plotting Interfaces

Introduction to the IPLOT Dialog BoxNote Throughout this section the term IPLOT refers to the IPLOT component of InterPlot.

The IPLOT dialog box is a graphical user interface that allows you to set up and submit plots of design files from the MicroStation environment. The IPLOT dialog box allows you to perform the three steps necessary to plot a drawing. (See Introduction to Plotting MicroStation/IPLOT Data).

Starting the IPLOT Dialog Box1 Access MicroStation and load a design file. (Refer to your MicroStation documentation for information on

loading a design file.)

2 Start IPLOT by selecting IPLOT from the MicroStation File menu.

3 The IPLOT dialog box appears.

The IPLOT Dialog Box

The IPLOT dialog box contains several key-in fields, a graphical representation of the plot area, a status area, and a menu bar that provides access to less frequently used commands.

The IPLOT dialog box allows you to scale, size, and rotate a plot; to select a printer; and to preview and plot a drawing. Right-click inside the preview window to display the context menu. From the context menu, you can pan, zoom in, zoom out, and perform a window area.

With the dialog box commands you can specify parameters and settings, redefine and manipulate the plot area, and specify qualifiers. You can also control the display of levels, classes of elements, and some element attributes. You can also obtain a plot with different display characteristics, and specify queuing options and plot submission options. Additionally, the IPLOT dialog box displays error and status information.

You can customize many aspects of this dialog box, including default values (such as the printer name) and the product’s general behavior. To customize the dialog box, use settings files and configuration variables. You can customize IPLOT on a system-wide basis as well as for an individual user.

Many commands display additional dialog boxes that allow you to specify settings to adjust the plot. You control and operate IPLOT dialog boxes in the same manner as MicroStation dialog boxes.

For settings that require a filename, you can either type the filename or use a file selection dialog box. When you type a filename, you are not required to provide the full directory path. IPLOT searches specific directories determined by configuration variables.

2-1

If you do not remember the name of the file you want, file selection dialog boxes are a useful tool. These dialog boxes provide scroll boxes that list directories and filenames. You can use these scroll boxes to navigate through your directory structures to locate the file you want.

Next to settings fields that require a filename, IPLOT displays a browse button. Browse buttons are labeled with an ellipsis (...). Click the browse button to display a file selection dialog box that allows you to search directories for a specific file.

Note You can obtain detailed help on the IPLOT dialog interface by clicking Help > Help Topics on the IPLOT dialog box.

2-2

Introduction to InterPlot Organizer

InterPlot Organizer is a Windows application for plotting MicroStation design files, AutoCAD drawing files, raster files, and Digital Print Room files.

InterPlot Organizer allows you to work on a group of plots as a single plot set. Organizer gives you full control over plot sets and the plots they contain. You can add, delete, and rearrange plots; view and modify the properties of individual or multiple plots; and preview and print all or some of the plots. You can also control how information about the plots in a set is displayed in the Organizer main window.

Using Organizer, you can plot sets of MicroStation design files, AutoCAD drawing files, raster files, or Digital Print Room files without saving or reusing the plot sets. Or, you can create a plot set for a particular set of files to be replotted periodically (for example, at various milestone dates for a project).

InterPlot Organizer offers you several advantages:

The Organizer interface allows you to work easily with large sets of plots. At the beginning of a project, you can create a plot set file that corresponds to project drawings. As the design progresses, you can easily produce new sets of drawings by using the Organizer dialog box and the original plot set file.

Using InterPlot Organizer is often faster than plotting with the dialog box because you do not have to wait for MicroStation to load the design file or AutoCAD to load the drawing file before you plot.

Organizer allows you to create and edit settings files and to edit configuration files.

2-3

Starting InterPlot OrganizerTo start Organizer, do one of the following:

From Windows NT Explorer, double-click the name of an existing plot set.

From the Start -> Programs -> InterPlot Utilities folder, click the InterPlot Organizer command.

From the command prompt, follow the procedure below.

To Start Organizer from the Command Prompt:

1 Add the bin subdirectory of the product directory to the system path. For example, \Program Files\InterPlot Professional\bin or \Program Files\InterPlot Client\bin.

2 Type the executable filename and one command line argument (optional). The syntax is:

iplotorg.exe <plot_set_filename>

If you started Organizer without specifying a plot set, a Welcome dialog box appears.

The Welcome dialog box contains shortcuts for the two operations that load information into Organizer: creating new plot sets from files you select, and opening an existing plot set.

3 Click the appropriate option from the Welcome to InterPlot Organizer dialog box.

4 Click OK to dismiss the Welcome dialog box and perform the selected operation.

Click Cancel to exit the Welcome dialog box without performing any operation.

Note If you prefer that this dialog box not be displayed the next time you run InterPlot Organizer, click the Don’t display this screen again option before clicking OK.

Obtaining More Information on the Organizer Interface

For additional information about Organizer, click Help Topics from within Organizer.

2-4

Using the Organizer Command Line

InterPlot Client/Professional includes an Organizer command line interface which runs from the command prompt. You can use the command line interface to create, modify, preview, print, and archive plot sets, and to export plots from plot sets. Plot sets can be composed of MicroStation, AutoCAD, IntelliCAD, raster, and digital print room data.

The Organizer command line provides the following commands:

Create Creates plot set files.

Modify Modifies plot set files.

Export Exports plots from a plot set file as PARM files.

Preview Displays plots on the screen before printing.

Print Prints a plot set.

Archive Archives a plot set file without printing.

An Organizer command line has the following syntax:iplotorg <command> <-qualifiers> plotset_file

Note On Windows 98 you are limited in the number of characters per command line. To work around this limitation, you should:

Use Organizer’s command file mechanism for specifying command line options.

Add the location of Organizer to the system path.

The following list describes each component of the command line:

iplotorg Activates Organizer.

command Represents one of the command line commands (Create, Modify, Export, Preview, Print, Archive).

-qualifiers Represents one or more qualifiers used to control the command. These qualifiers are preceded by a dash. Qualifier values can be filenames, arbitrary character strings, or comma-separated lists of such items enclosed in square brackets. You can place the qualifiers in any order on the command line, but they must follow a command.

plotset_file Represents the name of a plot set (.ips) file.

Qualifier Interaction

In general, if you use a particular qualifier more than once on the same command line, Organizer processes the last occurrence and ignores the others.

The exceptions to this rule are the -add_plot and -attributes qualifiers used with the Create command as follows:

-add_plot Organizer reads and adds each plot to the plot set file.

-attributes Organizer applies each attribute in the order it is listed.

Note Organizer reads the data sections of all settings files specified on the command line. If you specify a settings file with the –add_plot qualifier, the data specific qualifiers in this settings file will override those specified using the –settings qualifier.

Create Command

Use the Create command to create a plot set file. You must specify an extension (.ips) for the plot set filename. Organizer will create the plot set in the current working directory unless you specify a directory in the plot set filename.

Syntax:

iplotorg create <-qualifiers> plotset_file

2-5

You can use the following qualifiers with the Create command:

-add_plot -printer-archive_name -rendering_attributes-attributes -settings-output

-add_plot

Use the -add_plot qualifier to add a plot to a plot set.

Syntax:

-add_plot=input_file

-add_plot[plot_name]=[input_file, settings_file]

plot_name Represents the name to be assigned to the plot. If no plot name is specified, the CAD filename (without extension) is used for the plot name.

input_file Represents the name of the CAD file or PARM file to be added to the plot set.

settings_file Represents the name of the settings file to be used when creating the plot. The common section of the settings file will be ignored.

Note If you do not specify the -add_plot qualifier on the Create command line, the plot set file created will be empty.

Examples:

To create a plot set and add plots:iplotorg create -add_plot=house.dgn -add_plot=car.dgn misc.ips

To use a wildcard (*) to create plots from all the DGN and JPG files in a directory:

iplotorg create -add_plot=c:\temp\*.dgn –add_plot=*.jpg misc.ips

-archive_name

Use the -archive_name qualifier to set the name of the archive in the plot set file.

Syntax:

-archive_name=name

Example:

To specify the name of an archive:iplotorg create -add_plot=house.dgn -archive_name=arctwo misc.ips

-attributes

Use the -attributes qualifier to set plot set attributes in the plot set file. You can specify attributes such as Author, Plot Set ID, Revision, Account, Project ID, Related Web Page, PDF File, and user-defined attributes.

Click here for a list of standard attribute names and keywords.

Syntax:

-attributes=[name1=value1, name2=value2, . . .]

(Where name1 and name2 are user-defined attribute names.)

Example:

To assign plot set attributes:

iplotorg create –add_plot=house.dgn -archive_name=arcone -attributes=[URL=http://www.interplot.com, ProjectID=ab1] house.ips

This command creates a plot set called house.ips, containing the plot house. The name of the archive associated with house.ips is arcone, and the plot set attributes are www.interplot.com (Related Web Page) and ab1 (Project ID).

2-6

-output

Use the -output qualifier to redirect error/informational messages to a log file. This prevents you from having to dismiss a window each time you run the command line.

Syntax:

-output=log_file

(Where log_file is the name of the log file.)

Example:

To redirect error/informational messages to a log file:

iplotorg create –add_plot=house.dgn -output=err.log house.ips

-printer

Use the -printer qualifier to set the destination printer in the plot set file. If you do not specify a destination printer, the printer is set to the most recently used InterPlot printer (or to the system ’s default printer if no recently used InterPlot printer is detected).

Syntax:

-printer=printer_name

Example:

To specify a printer:iplotorg create -add_plot=house.dgn -printer=hp5si house.ips

-rendering_attributes

Use the -rendering_attributes qualifier to attach a rendering attributes file to the plot set file.

Syntax:

-rendering_attributes=rendering_attributes_file

Example:

To attach a rendering attributes file:

iplotorg create –add_plot=lever.jpg -rendering_attributes=screen.ra mech.ips

-settings

Use the -settings qualifier to specify a settings file when creating plots. This settings file applies the data specific sections and the common section to all plots. If you specify an additional settings file with the -add_plot qualifier, the data specific sections in this settings file will override those specified using the -settings qualifier.

Syntax:

-settings=settings_file

Examples:

To specify a settings file:iplotorg create -add_plot=car.dgn -add_plot=house.dgn -settings=common.set misc.ips

This command creates a plot set called misc.ips containing the plots car and house and applies the settings in common.set to both plots.

To specify more than one settings file:iplotorg create -add_plot=[house.dgn, house.set] -settings=two.set misc.ips

This command creates a plot set called misc.ips containing the plot house. Organizer reads both settings files (house.set and two.set) and applies only the data specific section from house.set. The common section and data specific sections are applied from two.set. The data specific section in house.set will override those specified in two.set.

2-7

Modify Command

Use the Modify command to modify a plot set file. You must specify an extension (.ips) for the plot set filename. Organizer will modify the plot set in the current working directory unless you specify a directory in the plot set filename.

Syntax:

iplotorg modify <-qualifiers> plotset_file

You can use the following qualifiers with the Modify command:

-archive_name -printer-attributes -rendering_attributes-output -settings

-archive_name

Use the -archive_name qualifier to set the name of the archive in the plot set file.

Syntax:

-archive_name=name

Example:

To specify the name of an archive:iplotorg modify -archive_name=arctwo misc.ips

-attributes

Use the -attributes qualifier to set plot set attributes in the plot set file. You can specify attributes such as Author, Plot Set ID, Revision, Account, Project ID, Related Web Page, PDF File, and user-defined attributes. Organizer appends any attributes you specify here to the plot set file.

Click here for a list of standard attribute names and keywords.

Syntax:

-attributes=[name1=value1, name2=value2, . . .]

(Where name1 and name2 are user-defined attributes.)

Example:

To assign plot set attributes:iplotorg modify -attributes=[URL=http://www.interplot.com, ProjectID=ab1] house.ips

-output


Syntax:

-output=log_file

(Where log_file is the name of the log file.)

Example:

To redirect error/informational messages to a log file:

iplotorg modify -archive_name=arctwo –output=err.log misc.ips

-printer

Use the -printer qualifier to change the destination printer in the plot set file.

Syntax:

2-8


Example:

To specify a new printer:iplotorg modify -printer=hp5si house.ips

-rendering_attributes

Use the -rendering_attributes qualifier to attach a rendering attributes file to the plot set file.

Syntax:


Example:

To attach a rendering attributes file:iplotorg modify -rendering_attributes=screen.ra mech.ips

-settings

Use the -settings qualifier to specify a settings file to be applied to all plots.

Syntax:


Example:

To specify a settings file:iplotorg modify -settings=common.set misc.ips

Export Command

Use the Export command to export plots to the current working directory. When plots are exported, they are written to the disk as PARM files, using the plot names for the PARM filenames.

You can use the following qualifiers with the Export command:

-output

Syntax:

iplotorg export <-qualifiers> plotset_file

-output


Syntax:

-output=log_file

Example:

To export the plots in a plot set:

iplotorg export –output=err.log house.ips

Preview Command

Use the Preview command to preview a plot set on the screen before you submit it to a printer. When you run this command, a Preview window appears containing the first plot in the plot set.

In the Preview window, use the button to display the next plot, the button to display the previous plot,

and the button to close the Preview window after previewing the last plot.

You can use the following qualifiers with the Preview command:

-output

2-9

Syntax:

iplotorg preview plotset_file

-output


Syntax:

-output=log_file

Example:

To preview the plots in a plot set:

iplotorg preview –output=err.log house.ips

Print Command

Use the Print command to submit a plot set to a printer.

Syntax:

iplotorg print <-qualifiers> plotset_file

You can use the following qualifiers with the Print command:

-copies-collate-delete_plotset-output

-copies

Use the -copies qualifier to request multiple copies of a plot set. The number of copies is not stored in the plot set file.

Syntax:

-copies=n

Example:

To specify a number of copies:iplotorg print -copies=2 house.ips

-collate

Use the -collate qualifier to request that the plot set be collated. If you are only printing one copy of the plot set, this qualifier is ignored. This flag is not stored in the plot set file.

Syntax:

-collate

Example:

To specify that a plot set be collated:iplotorg print -copies=2 -collate house.ips

-delete_plotset

Use the -delete_plotset qualifier to specify that the plot set file be deleted if printing is successful.

Syntax:

2-10

-delete_plotset

Example:

To delete a plot set after printing:iplotorg print -delete_plotset misc.ips

-output


Syntax:

-output=log_file

Example:

To print the plots in a plot set and dismiss the window:

iplotorg print –output=err.log house.ips

Archive Command

Use the Archive command to archive a plot set.

Syntax:

iplotorg archive <-qualifier> plotset_file

You can use the following qualifiers with the Archive command:

-delete_plotset-output

-delete_plotset

Use the -delete_plotset qualifier with the Archive command to specify that the plot set file be deleted if archiving is successful.

Syntax:

-delete_plotset

Example:

To delete a plot set after archiving:iplotorg archive -delete_plotset misc.ips

-output


Syntax:

-output=log_file

Example:

To archive the plots in a plot set and dismiss the window:

iplotorg archive –output=err.log house.ips

Command Files

Organizer also supports the use of command files for specifying command line arguments. To specify a command file, use the following syntax:

iplotorg.exe @command_file

(Where command_file is the name of an ASCII file.)

2-11

No space or tab is allowed between the at sign (@) and the filename. There is no default extension; you must specify the full filename, including any extension. Wildcards can not be used.

All of the command line arguments must be specified in the command file. Command files can not be nested. In the command file, arguments must begin and end on the same line and each must be separated by spaces, tabs, or newline characters.

2-12

Introduction to the IPLOT Command LineNote Throughout this section the term IPLOT refers to the IPLOT component of InterPlot.

In addition to the dialog box that operates inside MicroStation, and the Organizer interface that operates outside of the MicroStation environment, InterPlot Client/Professional includes the IPLOT command line interface that you run from the command prompt. As with Organizer, using the command line, you can resubmit plots submitted from the dialog box and plot design files without displaying them in MicroStation.

The command line interface has several advantages:

The command line allows you to work easily with large sets of IPARM files. At the beginning of a project, you can create a set of IPARM files that correspond to project drawings. As the design progresses, you can easily produce new sets of drawings by using the command line and the original IPARM files.

Plotting with the command line is often faster than plotting with the dialog box because you do not have to wait for MicroStation to load the design file before you plot.

You can create customized plotting utilities by writing shell scripts or batch files that run the command line.

2-13

Using the IPLOT Command Line

To plot with IPLOT, you complete these three steps:

1 Create an IPARM file that describes a design file and how it should be plotted.

2 Generate a metafile containing graphics data representing the design file and its reference files.

3 Submit the metafile to a plot server, where it is actually plotted.

Note If InterPlot Professional is installed, the job plots directly without being submitted to a server.

The IPLOT command line provides the following commands to complete these three steps:

Create

Modify

Show

Generate

Preview

Submit

The Create, Modify, and Show commands allow you to create and display the IPARM file (Step 1). The Generate command generates the metafile (Step 2). The Preview command allows you to view plots on the screen, prior to using the Submit command to submit the plot to the device (Step 3). All six commands use IPARM files.

All commands except Preview and Generate have qualifiers that control the command, typically by setting specific parameters or designating subactions.

IPLOT Command Line Syntax

An IPLOT command line has the following format:

iplot command qualifiers IPARM_file(s)

The following list describes each component:

iplot - accesses the IPLOT command line.

command - represents one of the six commands (Create, Modify, Show, Generate, Preview, or Submit)

qualifiers - represents one or more qualifiers that are used to control the command. These qualifiers are preceded by dashes. All commands except Preview and Generate support qualifiers.

IPARM_file(s) - represents the name of one or more IPARM files used to plot the design file. All commands except Create support multiple IPARM filenames and IPARM filenames containing wildcards. The Create command requires a single IPARM filename.

The command line components can be specified in either upper or lower case and can be abbreviated to the minimum number of characters needed to uniquely identify them. Also, the .i extension for IPARM filenames is optional. For example, the following command lines are equivalent:

iplot modify -units=inches -xsize=10.0 drawing

iplot mod -units=in -x=10.0 drawing.i

iplot MODIFY -UNITS=IN -X=10.0 drawing

Using Qualifiers

Depending on the information it specifies, a qualifier is in one of several formats:

Format Function

-qualifier Specifies an action

-qualifier=value Sets a parameter

-qualifier[logical_names] Specifies an action for one or more reference files

-qualifier[logical_names]=value Sets a parameter for one or more reference files

2-14

Qualifier values can be numbers, filenames, keywords, arbitrary character strings, or comma-separated lists of such items enclosed in square brackets. Unless otherwise specified, IPLOT uses default values for plotting parameters such as the view to be plotted and the plot size.

Qualifier Priority

You can place command qualifiers in any order on the command line. IPLOT does not process qualifiers in the order they are specified. Instead, it processes qualifiers with many side effects before qualifiers with fewer or no side effects.

For example, when you use the -view qualifier, IPLOT recomputes the plot size. Therefore, if -view is specified on the same command line as -xsize or -ysize, IPLOT processes -view first. The following two commands produce the same result:

iplot modify -view=2 -xsize=10.0 drawing

iplot modify -xsize=10.0 -view=2 drawing

Qualifier Interaction

If you specify certain combinations of qualifiers on the same command line, IPLOT ignores one or more qualifiers. In general, if you use a particular qualifier more than once, IPLOT processes the last occurrence and ignores the others. Similarly, if several closely related qualifiers, such as -xsize, -ysize, and -scale, are on the same command line, only the last one is used. For example, the -scale qualifier in the following command is ignored:

iplot modify -scale=1:1 -xsize=24.0 drawing

Several qualifiers are exceptions to this rule:

-attach_ref

-detach_ref

-[no]display

-[no]environment

-[no]fast

-[no]levels

-ref_filename

-settings

If you use one of these qualifiers several times on the same command line, all occurrences are processed in the order that you specified them. The -nolevels and -levels qualifiers provide one useful example. If you want to plot only Levels 1, 3, and 5, you can turn these levels on and turn off all others with a single command line:iplot mod -nolev=[1-63] -lev=[1, 3, 5] drawing

IPLOT Command Line Exit Status

The IPLOT command line returns an exit status of zero(0) to the operating system if it successfully processes the command. If the command fails, the command line returns a non-zero value. Shell scripts and batch files can test the command line exit status to decide whether to continue processing.

If several IPARM files are specified for a command, the IPLOT exit status is determined by the command operation on the last file. For example, consider the following Submit command:

iplot submit drawing1 drawing2 drawing3

If IPLOT cannot submit the metafile associated with drawing3, it returns a non-zero (failure) exit status to the operating system. However, IPLOT returns a 0 to the operating system if it successfully submitted drawing3, even if it could not submit drawing1 or drawing2.

Command Line Examples

The following command line example creates an IPARM file. The -design qualifier specifies the name of the design file to be plotted along with the name of the IPARM file to be created:

2-15

Note If you do not add an extension to the IPARM filename, as in this example, IPLOT adds a .i extension to the filename by default. (The IPARM file extension is defined in the IPLOT.CFG file.)

To view the settings for these and other parameters, use the Show command.

iplot show plan

IPLOT displays the current settings of all plotting parameters under your control. You can change any of the displayed parameters with the Modify command. For example, you can select a different printer and specify a different plot scale.

iplot modify -printer=itp436 -scale=10:1 plan

To see the results of your changes, as well as the effects they had on the plot size, you can use the Show command again and specify only the parameters you want to see.

iplot show -queue -scale -xsize -ysize plan

Note -queue is equivalent to the -printer qualifier.

After the IPARM settings are satisfactory, use the Generate command to generate a metafile.

iplot generate plan

IPLOT creates a metafile that has the same base name as the IPARM file and a .m extension. To submit this metafile to the plot server that is associated with the printer you selected, use the Submit command, specifying the IPARM filename. (The metafile extension is defined in the IPLOT.CFG file.)

iplot submit plan

IPLOT sends the metafile to the plot server, where it is plotted.

The following list contains additional command line examples:

To view the plot scale:iplot show -scale drawing

To set the plot’s X size:iplot modify -xsize=16.0 drawing

To generate metafiles for all IPARM files in the current directory:iplot generate *.i

To view the names of all attached reference files:iplot show -ref_filename[iplot_all] drawing

To turn on a set of levels in the master design file:iplot modify -levels=[1, 5-10, 20-34] drawing

To turn on all levels in a specific reference file:iplot modify -levels[ref1]=[1-63] drawing

To disable the plotting of points and patterns in a set of reference files:iplot modify -nodisplay[ref1,ref2]=[points, pattern] drawing

2-16

IPLOT Commands

This section discusses the IPLOT commands:

Create

Modify

Show

Generate

Preview

Submit

Create and Modify

The Create and Modify commands have similar functions and use the same qualifiers.

The Create command creates a new IPARM file from a design file.

Syntax:

iplot create -design=dgn_filename -qualifiers IPARM_file

If you do not specify an extension for the IPARM filename, the extension defined in the configuration file (by default, .i) is appended to the IPARM filename. If you do not specify a directory in the IPARM filename, IPLOT creates the IPARM file in the directory specified by the configuration file (by default, the current working directory).

The -design qualifier is required. If you do not use any other qualifiers, the IPARM file contains the following default features:

The plot area is the first "on" view. The levels, display settings, and fast/slow settings are derived from this view.

The destination printer is the most recently used printer (or the system default if no previous plots have been made).

The paper size is set to NONE.

The active units is inches.

The plot is maximized to the largest size the printer allows.

The plot data is not rotated and has an origin of (0, 0) inches.

Any specified qualifiers will override these default parameters.

Note You can also specify values by configuring a default settings file or printer specific settings file.

The Modify command modifies one or more existing IPARM files. If several IPARM files are specified, IPLOT applies the changes specified by the qualifiers to each file.

Syntax:

iplot modify -qualifiers IPARM_file(s)

Examples:

iplot create -design=house.dgn -scale=25:1 floorplan

iplot modify -rotation=90 floorplan

Show

The Show command displays the contents of one or more IPARM files. If you do not specify any qualifiers, the names and values of all changeable parameters are displayed. If qualifiers are specified, only their associated names and values are displayed.

Syntax:

iplot show -qualifiers IPARM_file(s)

Example:

iplot show floorplan.i

2-17

Generate

The Generate command creates a metafile from an existing IPARM file and its associated design and reference files. If several IPARM files are specified, IPLOT generates a metafile from each file.

Syntax:

iplot generate IPARM_file(s)

The generated metafile has the same base name as its corresponding IPARM file, but with the extension defined in the configuration file (by default, .m).

An IPARM file contains control information about a plot. In contrast, a metafile contains the actual graphic elements extracted from the design file and its reference files.

The Generate command does not have any associated qualifiers.

Examples:

To generate a metafile for a single IPARM file:iplot generate floorplan

To generate metafiles for all IPARMs in the current directory:iplot generate *.i

Preview

The Preview command allows you to view plots on the screen, prior to submitting them to a printer. When you run the command, a preview window containing the plot appears.

Syntax:

iplot preview IPARM_file(s)

Example:

To preview the file named floorplan.i:

iplot preview floorplan.i

Note You must generate the metafile prior to using the Preview command.

Submit

The Submit command submits a metafile to a plot server based on the information in the specified IPARM file. If several IPARM files are specified, IPLOT sends the corresponding metafile of each file to the plot server.

Note For InterPlot Professional, the Submit command actually plots the job directly to the printer.

Syntax:

iplot submit -qualifiers IPARM_file(s)

Example:

iplot submit floorplan

2-18

IPLOT Create and Modify Qualifiers

The qualifiers for the Create and Modify commands are the same.

The following is a list of qualifiers you can use with the Create and Modify commands:

-align_x -detach_ref -[no]qpr_options

-align_y -[no]display -ref_filename

-area -[no]environment -[no]region

-area_cellnames -[no]fast -[no]rendering_attributes

-area_colors -[no]feature_table -rotation

-area_files -[no]fence -scale

-area_levels -[no]levels -settings

-area_styles -maximize -units

-area_types -mirror -update

-area_weights -origin -view

-attach_ref -paper_size -[no]volume

-center -[no]pen_table -xsize

-color_table -plot_rescale -xysize

-data_rescale -printer -ysize

-design -workspace

Defining the Plot Area

The following qualifiers define the design file or the area of the design file to plot.

-design

Syntax:

-design=dgn_filename

Examples:

iplot create -design=new.dgn drawing

iplot modify -design=new.dgn drawing

When used with the Create command, the -design qualifier identifies the design file that IPLOT uses to create the IPARM file.

When used with the Modify command, the -design qualifier changes the design filename in the IPARM file. You use the -design qualifier with the Modify command to update the IPARM files after you move design files to different directories or move IPARMs to different nodes with different directory structures. You should not use the command Modify -design to specify a different design file.

-view

Syntax:

-view=view_number

-view=saved_view_name

The view_number value must be a number between 1 and 8. The saved_view_name value is the name of a saved view that existed in the design file at the time the IPARM file was created.

Examples:

To create an IPARM file that will plot the contents of View 2:iplot create -design=drawing.dgn -view=2 drawing

To modify the IPARM file to plot View 1:iplot modify -view=1 drawing

The -view qualifier changes the active view in the IPARM file.

The new view affects the plot area differently, depending on the contents of the IPARM file. If the IPARM file

2-19

does not contain a fence, region, or volume specification, the new view completely defines the plot area. If the IPARM contains a fence or region specification, the fence or region is projected onto the front face of the view, and the volume formed by extending its projection from the front face of the view to the back face is the plot area. If the IPARM contains a volume specification, the volume still defines the plot area, but the contents of the volume are plotted based on the rotation of the new view.

Note Because of the way MicroStation stores view information in the design file, IPLOT typically plots a slightly larger area for a given view than MicroStation displays. To rectify the difference, you should specify a fenced region or volume to define the plot area instead of just a view.

The plot size is recomputed to reflect the new plot area. If the computed plot size exceeds the plotter limits, the scale and size are modified to make the plot fit.

The active levels, display on/off settings, and fast/slow settings are also updated to match those of the new view.

-fence/-nofence

Syntax:

-fence=[[x1, y1], [x2, y2], ...]

-fence=[[x1, y1, z1], [x2, y2, z2], ...]

-nofence

The values x, y, and z are working unit values in the design file’s coordinate space.

Examples:

To plot a rectangular area of a 2D design file:iplot modify -fence=[[0,0], [100,80]] plan1

To plot a triangular area of a 2D design file:iplot modify -fence=[[0,0],[100,0],[50,80]] plan2

To plot a rectangle in a view in a 3D design file:iplot modify -fence=[[0,0,0],[100,80,0]] plan3

The -fence qualifier defines a set of points (up to 101 vertices) that is used with the active view to define the plot area. If the design file is 2D, you specify 2D points. If the design file is 3D, you specify 3D points.

For 2D files, IPLOT connects the points to form a polygon that defines the portion of the design to be plotted. If you specify two points, IPLOT interprets them as the two corners of a rectangle with sides that are parallel to those of the active view.

For 3D files, the points are projected to the front face of the active view, and the projected points are connected to form a polygon on the view face. If only two points are specified, IPLOT interprets their projections as the corners of a rectangular polygon on the view face. The volume formed by extending this polygon to the back of the view defines the plot area.

The -fence qualifier clears any region or volume previously stored in the IPARM file.

The -nofence qualifier deletes a previously stored fence or region, indicating that the active view should define the plot area.

The plot size is recomputed to reflect the new plot area. If the computed plot size exceeds the plotter limits, IPLOT modifies the scale and size to make the plot fit.

-region/-noregion

Syntax:

-region=[x1, y1, x2, y2, ...]

-noregion

The values x and y are working unit values in the design file coordinate space.

Examples:

To plot a rectangular portion of a 2D design file:iplot modify -region=[0,0, 100,80] drawing

To plot a triangular portion of a 2D design file:

2-20

iplot modify -region=[0,0, 100,0, 50,80] drawing

The -region qualifier defines a set of points (up to 101 vertices) that define the plot area for a 2D design file. This qualifier does not apply to 3D design files.

If you specify more than two points, IPLOT connects the points to form a polygon defining the portion of the design file to be plotted. If you specify two points, IPLOT interprets them as the two corners of a rectangle in the design files coordinate space. In any case, the contents of the resulting polygon or rectangle are plotted according to the rotation defined by the active view.

The -region qualifier clears any fence previously stored in the IPARM file.

The -noregion qualifier deletes a previously stored region or fence, indicating that the active view should define the plot area.

The plot size is recomputed to reflect the new plot area. If the computed size exceeds the plotter limits, IPLOT modifies the scale and size to make the plot fit.

Note For 2D design files, the -region and -fence qualifiers are functionally equivalent unless you specify only two points and the active view is a rotated view.

-volume/-novolume

Syntax:

-volume=[x1,y1,z1, x2,y2,z2]

-novolume

The values x, y, and z are working unit values in the design file coordinate space.

Example:

To plot the contents of a cube in the design file:iplot modify -volume=[0,0,0, 10,10,10] drawing

The -volume qualifier specifies the two corners of a cubic volume that defines the plot area. The contents of this volume are plotted according to the rotation defined by the active view. This qualifier applies only to 3D design files. Also, the -volume qualifier clears any fence previously stored in the IPARM file.

The -novolume qualifier clears any volume previously stored in the IPARM file, indicating that the active view should define the plot area.

IPLOT recomputes the plot size to reflect the new plot area. If the computed plot size exceeds the plotter limits, the scale and size are modified to make the plot fit.

-area

Syntax:

-area = area_method

Valid area_method keywords are shape, all_shapes, fit, and fit_all.

Example:

iplot modify -area=fit_all drawing

The area qualifiers allow you to specify the plot area indirectly by describing elements whose actual coordinates or ranges define the plot area.

The area keyword determines which of the automatic methods you should use to determine the plot area.

The valid -area values are:

all_shapes locates all matching shapes and creates an IPARM for each one. The fences in the IPARMs correspond to the vertices of the shapes. The IPARMs are created in the form iparm#.i. For example, if three matching shapes were found in the plot area during an all_shapes operation, then IPARMs named test.i, test1.i, and test2.i would be created. Generally, this qualifier is accompanied by other qualifiers to select shapes with certain color, weight, style, level, or file attributes. You can find descriptions of these qualifiers at the end of this section. The IPLOT_SHAPE_LIMIT configuration variable limits the number of IPARMs that an all_shapes operation can create. The default value of IPLOT_SHAPE_LIMIT is 50.

2-21

Note If you use the all_shapes qualifier in a Modify command, then no additional IPARMs are created.

shape locates the first matching shape and uses its vertices as the plot fence for the IPARM. Generally, this qualifier is accompanied by other qualifiers to select a shape with certain color, weight, style, level, or file attributes.

fit makes the plot area a region or volume that encloses the ranges of all selected elements. This qualifier examines only master file elements unless the area_files qualifier is present.

fit_all makes the plot area a region or volume that encloses the ranges of all selected elements. This qualifier examines the master file and all of the attached reference files unless the area_files qualifier is present.

Note The following qualifiers define the elements considered in the automatic plot area determination: -area_levels, -area_colors, -area_weights, -area_styles, -area_types, -area_files, and -area_cellnames.

The following qualifiers define the elements considered in the automatic plot area determination and should occur only once in a given command line. If they are specified more than once, then only the last occurrence of the qualifier will be used. Also, the qualifiers must be used with one of the automatic plot area methods (area=fit, area=fit_all, area=shape, area=all_shapes).

-area_levels The area_levels values can be any integers between 1 and 64 inclusive.

-area_colors The area_colors values can be any integers between 0 and 255 inclusive.

-area_weights The area_weights values can be any integers between 0 and 31 inclusive.

-area_styles The area_styles values can be any integers between 0 and 7 inclusive.

-area_types The area_types values can be any integers between 1 and 128 inclusive.

Note -area_types is ignored if -area is set to shape or all_shapes, since the shape modes imply scanning for Type 6 shape elements only.

Qualifiers with numerical values will accept either a single integer or a list of integers. The following represents proper syntax for qualifiers with numerical values:-area_levels=42-area_types=[2, 17]-area_weights=[0-15, 17, 19-31]

-area_files The strings given for area_files should be either actual design filenames (without directory names), logical names (IPLOT_ALL, IPLOT_R1, etc.), or reference file logical names. Wild cards are permitted for design filenames. If you give invalid strings, IPLOT silently ignores them.

-area_cellnames The strings given for area_cellnames should be valid cellnames. Wild cards are permitted. If you give invalid strings, IPLOT ignores them.

The area_files and area_cellnames qualifiers define which files and cells are considered in the automatic plot area determination. If area_cellnames is not present, then IPLOT considers all cells. If area_cellnames is present, then only cells with the specified names are considered. To include other types, use -area_types.

Note When area_types and area_cellnames are used in the same command line, then area_types automatically includes Type 2 and Type 35 cells.

If area_files is not present and -area is fit_all, all_shapes, or shape, then IPLOT scans the master file and all reference files. If area_files is not present and area is fit, then only the master file is considered. If area_files is present, then IPLOT scans the listed files. If area is shape, then scanning will end as soon as a matching shape is found.

The following represents proper syntax for the area_files and area_cellnames qualifiers:

-area_files="BORDER*.DGN"

-area_files=[FILE1.DGN, BORDER, IPLOT_R7]

-area_cellnames=DOOR

-area_cellnames=[DOOR, CHAIR, SHOWER]

Examples:

To create an IPARM with either a volume or region (depending on the dimension of the master file) that encompasses all of the graphical elements in all of the files:

2-22

iplot cre -des=a.dgn -area=fit_all -maximize car

To create an IPARM with either a volume or region which encompasses all of the line elements found in the reference file with the logical name ref1. iplot cre -des=a.dgn -area=fit -area_types=3 -area_files=[ref1] -maximize car

To create an IPARM with a fence whose vertices are the same as the first shape on a specified level in the master file:iplot cre -des=a.dgn -area=shape -area_level=6 -area_files=[iplot_master] -maximize car

To create up to 50 (default) IPARMs, each containing a fence that corresponds to a shape element with color 250.iplot cre -des=a.dgn -area=all_shapes -area_colors=250 -maximize car

Selecting the Printer and Paper Size

Use the following qualifier to select the printer you want to use for the plot.

-printer

Note -queue is equivalent to the -printer qualifier.

Syntax:


Example:

To select a new printer:iplot modify -printer=v8936 drawing

The -printer qualifier changes the printer name in the IPARM file.

When changing the printer, IPLOT maintains the current paper size on the new printer. If the paper size is unavailable, paper size is set to NONE.

If the new printer's limits are smaller than the previous printer's, the origin and plot size (if necessary) are reduced to make the plot fit.

If the printer has an associated settings file, IPLOT processes the contents of the settings file.

-paper_size

Use the following qualifier to select the paper size (form) you want to use for the plot.

Syntax:

-paper_size=paper_size

Example:

To select a paper size:iplot modify -paper_size="c size sheet" drawing

The -paper_size qualifier changes the paper size in the IPARM file. The paper size changes the maximum length and width of the plot. For some devices, the paper size controls which paper tray or paper roll is used for the plot. Also, the special paper size None indicates to use the default paper size of the printer. For InterPlot device drivers, the default is often the device limits. For Microsoft or vendor-supplied drivers, the document defaults size is used.

Adjusting the Plot Size

Use the following qualifiers to specify and adjust the size of the plot.

-units

Syntax:

-units=unit_keyword

Valid unit keywords are inches (in), feet (ft), meters (m), centimeters (cm), and millimeters (mm).

Example:

2-23

To set the active units to millimeters:iplot modify -units=mm drawing

The -units qualifier sets the active units of measure for any subsequent -scale, -xsize, -ysize, -xysize, and -origin qualifiers. The active units also control how the size, scale, and origin are displayed by the Show command.

-maximize

Syntax:

-maximize

Example:

To specify that the drawing be maximized:iplot modify -maximize drawing

The -maximize qualifier increases the plot size to the largest size allowed by the device. This command maintains the current aspect ratio so that the plot size does not increase along one axis by a greater amount than the other axis. The plot origin resets to 0,0.

-scale

Syntax:

-scale=design_units:plotter_units

Both design_units and plotter_units are numbers greater than zero.

Example:

To specify that a scale of 1 inch on the plot equals 100 miles in the design when mile is the design unit:iplot modify -scale=100:1 map

The -scale qualifier defines the plot scale--the relationship between the design units in the design file and physical units of measure on the plot. For example, if the design units are feet and the active units specified by the -units qualifier are inches, a scale of 1:0.25 specifies that 1/4 inch on the plot represents 1 foot in the design.

IPLOT computes the plot size based on the plot area and the new scale. If the computed plot size exceeds plotter limits, IPLOT rejects the scale.

-xsize

Syntax:

-xsize=x_size

The value x_size is a number greater than zero.

Example:

To set the X plot size to 44.5 inches:iplot modify -xsize=44.5 drawing

The -xsize qualifier sets the size of the plot along the plotter’s X axis. The size is interpreted in the active units.

IPLOT uses the new X size to compute the Y size while maintaining the current aspect ratio of the plot. If the computed plot size exceeds the plotter’s limits, IPLOT reduces the plot size to make the plot fit within the limits. Also, IPLOT recomputes the plot scale based on the plot area and the new plot size.

-ysize

Syntax:

-ysize=y_size

The value y_size is a number greater than zero.

Example:

To set the Y plot size to 36 inches:iplot modify -ysize=36 drawing

2-24

The -ysize qualifier sets the size of the plot along the plotter’s Y axis. The size is interpreted in the active units.

IPLOT uses the new Y size to compute the X size while maintaining the current aspect ratio of the plot. If the computed plot size exceeds the plotter’s limits, IPLOT reduces the plot size to make the plot fit within the limits.

IPLOT also recomputes the plot scale based on the plot area and the new plot size (same as X size).

-xysize

Syntax:

-xysize=x_size,y_size

The values x_size and y_size are numbers greater than zero.

Example:

To create an 11.0 x 8.5 plot regardless of the plot area’s shape:iplot modify -xysize=11,8.5 drawing

The -xysize qualifier sets the size of the plot along both the plotter’s X and Y axes. The size is interpreted in the active units.

Using the -xysize qualifier usually results in a disproportionately scaled (distorted) plot and changes the plot rescale values. Circles in the design file plot as ovals, and squares in the design file plot as rectangles.

Note If the -xysize qualifier results in a disproportionate scale, raster data in the design file will not be disproportionately scaled.

If the x_size value exceeds the plotter’s X limit, IPLOT reduces the x_size value to the X limit; if the y_size value exceeds the plotter’s Y limit, IPLOT reduces the y_size value to the Y limit. The plot rescale updates to reflect the new X and Y sizes.

Note Be careful when using the -xysize qualifier to plot to roll feed plotters. In particular, do not use the technique of specifying extremely large values to maximize the plot size. Doing so will extend the X plot size to the full length of the roll, resulting in large amounts of wasted paper.

-plot_rescale

Syntax:

-plot_rescale=x_rescale,y_rescale

The values x_rescale and y_rescale are numbers greater than zero.

Examples:

To stretch a plot slightly along the plotter’s X axis:iplot modify -plot_rescale=1.1,1 drawing

To reset the plot to a proportionately scaled (undistorted) state:iplot modify -plot_rescale=1,1 -data_rescale=1,1 drawing

Note The -plot_rescale qualifier has no effect on raster data in the design file.

Plot rescaling is typically used to compensate for old or non-standard plotters or to distort the plot slightly to use all of the available plot media. When you use this qualifier, IPLOT recomputes the X and Y plot sizes. If the computed plot size exceeds the plotter’s limits, IPLOT rejects the plot rescale.

Note The plot rescale factors are applied after any plot rotation is performed. If you do not rotate the plot, -plot_rescale behaves identically to -data_rescale.

-data_rescale

Syntax:

-data_rescale=x_rescale,y_rescale

The values x_rescale and y_rescale are numbers greater than zero.

Examples:

To stretch a plot by a factor of two along the active view’s X axis, even if the plot is rotated:iplot modify -data_rescale=2,1 drawing

To reset the plot to a proportionately scaled (undistorted) state:

2-25

iplot modify -data_rescale=1,1 -plot_rescale=1,1 drawing

Note The -data_rescale qualifier has no effect on raster data in the design file.

Data rescaling is typically used to expand data that is compressed along one axis (in the design file) to its normal size for plotting.

IPLOT recomputes the X and Y plot sizes. If the computed plot size exceeds the plotter’s limits, IPLOT rejects the data rescale.

Note The -data_rescale factors are applied before any plot rotation is performed. If you do not rotate the plot, -data_rescale behaves identically to -plot_rescale.

Adjusting the Plot Placement

Use the following qualifiers to adjust the placement of the plotted data on the page.

-align_x

Syntax:

-align_x

Example:

To align a plot with the X axis:iplot modify -align_x drawing

The -align_x qualifier calculates the rotation angle that aligns the longest side of the plot area with the printer’s X axis.

-align_y

Syntax:

-align_y

Example:

To align a plot with the Y axis:iplot modify -align_y drawing

The -align_y qualifier calculates the rotation angle that aligns the longest side of the plot area with the printer’s Y axis.

-rotation

Syntax:

-rotation=degrees

The value degrees is a number between 0 and 360.

Example:

To rotate a plot 90 degrees counter-clockwise:iplot modify -rotation=90 drawing

The -rotation qualifier rotates the plot by the specified number of degrees. When you use this qualifier, IPLOT recomputes the plot size. If the computed plot size exceeds the plotter’s limits, IPLOT modifies the size and scale values.

IPLOT supports rotation values of 0, 90, 180, and 270 degrees for raster reference files (type 90) and supports rotations of 0 and 90 for embedded raster files (type 87/88).

-origin

Syntax:

-origin=x_origin,y_origin

The values x_origin and y_origin are numbers greater than zero.

Example:

To shift the lower-left corner of the plot up two inches and to the right three inches from its default location:

2-26

iplot modify -origin=3,2 drawing

The -origin qualifier sets the plot origin. The plot origin is the position of the lower left corner of the plot relative to the lower left corner of the plotter’s imaging area. The origin is interpreted in the active units.

If the specified origin shifts the plot off the media, IPLOT adjusts the origin to keep the plot on the media. For example, if the plotter limits are 11.0 x 8.0 inches and the current plot size is 10.0 x 7.0 inches and you specify an origin of 5.0, 3.0, IPLOT adjusts the origin to 1.0, 1.0.

Note Most plotters cannot plot on the entire media. Typically, there are small margins along each side of the media that are unusable. The portion of the media that is usable is known as the imaging area. The plot origin is an offset from the lower left corner of the imaging area, not from the corner of the actual media.

-center

Syntax:

-center

Example:

iplot modify -center drawing

The -center qualifier sets the plot origin to the values that center the plot within the plotter’s imaging area. If the plotter is a roll-feed device (with paper size set to NONE), the plot is centered along the plotter’s short axis only.

The effect of the -center qualifier is not permanent. Any changes to the IPARM that affect the plot size leave the origin unchanged, and the plot is no longer centered.

-mirror

Syntax:

-mirror=keyword

Valid mirror keywords are x, y, both, and off.

Examples:

To mirror the plot horizontally about the plotter’s Y axis:

iplot modify -mirror=y drawing

To mirror the plot vertically about the plotter’s X axis:iplot modify -mirror=x drawing

To disable mirroring:iplot modify -mirror=off drawing

The -mirror keyword produces a mirror image of the plot along the plotter’s X or Y axes or both.

Mirroring the plot does not change the size or position of the plot on the media.

Note To maintain compatibility with previous versions of IPLOT, the following forms of -mirror are also supported.

-mirror=on (identical to mirror=x)

-nomirror (identical to mirror=off)

Changing the Plot Display

Use the following qualifiers to specify the design file elements that should appear on the plot and how those elements are plotted.

-display/-nodisplay

Syntax:

-display=[keyword(s)]

-display[logical_name(s)]=[keyword(s)]

-nodisplay=[keyword(s)]

-nodisplay[logical_name(s)]=[keyword(s)]

The value logical_name(s) is a single reference file logical name or a comma-separated list of logical names.

2-27

Examples:

To plot all filled elements in the master file as outlines:iplot modify -nodisplay=area_fill drawing

To prevent a pair of reference files from plotting:iplot modify -nodisplay[ref1, ref2]=file drawing

To enable the plotting of text nodes in the master file and all reference files:iplot modify -display[iplot_all]=text_nodes drawing

The -display qualifier allows you to plot classes of elements or element attributes in specified files. The -nodisplay variable disables the plotting of those classes of elements or attributes. The elements or element attributes changed by the qualifier are controlled by a keyword. Refer to the following table for a list of keywords and descriptions of how they work with -display and -nodisplay.

Keyword Used with -display Used with -nodisplay

area_fill Plots filled elements, text, and arcs with width as filled polygons.

Plots filled elements, text, and lines and arcs with width as outlines.

camera Plots any perspective information associated with the active view (3D files only).

Does not plot perspective information associated with the active view (3D files only).

construction Plots construction elements. Does not plot construction elements.

dimension Plots dimension elements. Does not plot dimension elements.

enter_data Plots data field markers. Does not plot data field markers.

file Plots specified design file or reference file.

Does not plot specified file or reference file.

level_symbology Plots elements with the symbology in the level symbology table.

Plots elements with their defined symbology.

line_styles Plots user-defined line styles. Does not plot user-defined line styles.

pattern Plots pattern elements. Does not plot pattern elements.

points Plots point elements. Does not plot point elements.

ref_boundaries Plots reference file clip boundaries. Does not plot reference file clip boundaries.

tags Plots element tags. Does not plot element tags.

text_nodes Plots text node crosses and numbers. Does not plot text node crosses and numbers.

weight Plots weighted elements with their defined weight.

Plots weighted elements at weight 0.

width Plots lines and arcs with width in their defined width.

Plots lines and arcs as vectors.

If you do not specify a logical name, the changes apply only to the master file. If you specify logical names, the changes apply to the specified reference files. If you use iplot_all as the logical name, the changes apply to the master file and all reference files.

-fast/-nofast

Syntax:

-fast=[keyword(s)]

-fast[logical_name(s)]=[keyword(s)]

-nofast=[keyword(s)]

-nofast[logical_name(s)]=[keyword(s)]


Examples:

To specify fast curves and fonts for the master file:iplot modify -fast=[curve, font] drawing

2-28

To specify normal representations of cells and curves in all files:iplot modify -nofast[iplot_all]=[cell, curve] drawing

The -fast keyword selects the "fast" representation of the designated elements in specified files. The -nofast keyword selects the "slow" (normal) representation.

The fast representation of an element is a crude representation that plots faster than the normal representation. For example, a fast cell is plotted as a rectangle.

The following table shows how each keyword works with -fast and -nofast:

Keyword Used with -fast Used with -nofast

cell Cells are represented by rectangles.

Cells plot normally.

font Text plots with the fast font. Text plots with the defined font.

text Text does not plot. Text plots.

curve Curves represented by line strings.

Actual curves plot.

ref_clipping Reference files are clipped to the minimum bounding rectangles of their boundaries.

Reference files are clipped to their defined boundaries.

If you do not specify a logical name, the changes apply only to the master file. If you specify logical names, the changes apply to the specified reference files. If you specify iplot_all as the logical name, the changes apply to the master file and all reference files.

-levels/-nolevels

Syntax:

-levels=[levels]

-levels[logical_name(s)]=[levels]

-nolevels=[levels]

-nolevels[logical_name(s)]=[levels]

The value logical_name(s) is a single reference file logical name or a comma-separated list of logical names. The value levels is a single level number between 1 and 63, a pair of level numbers separated by a hyphen, or a comma separated list of single level numbers and/or pairs.

Examples:

To turn on a single level in the master file:

iplot modify -level=10 mstr

To turn on a set of levels in the master file:

iplot modify -levels=[1,5-10,30-63] mstr

To turn on a set of levels in a reference file:iplot modify -levels[ref1]=[1,5-10,30-63] ref1

To turn on all levels in all files:iplot modify -levels[iplot_all]=[1-63] house

The -levels qualifier turns on a set of levels in specified files. The -nolevels keyword turns off a set of levels. If you specify only a single level number, the brackets enclosing the number can be omitted.

If you do not specify a logical name, IPLOT turns the levels on or off in the master file. If you specify logical names, the levels are modified in the specified reference files. If iplot_all is specified as the logical name, the levels are modified in the master file and all reference files.

Using Reference Files

Use the following qualifiers to plot reference files with the design file.

-ref_filename

Syntax:

2-29

-ref_filename[logical_name]=dgn_filename

The value logical_name is the logical name of the reference file whose filename is to be changed.

Example:

To change the filename of the reference file with the logical name border:iplot modify -ref_filename[border]=newname.dgn drawing

The -ref_filename qualifier changes the filename of a reference file having a specified logical name.

Note Use the -ref_filename qualifier to update IPARM files after you move reference files to different directories or IPARMs to different nodes with different directory structures. Use the Show command to view the logical names and filenames of all reference files that are attached to the IPARM.

iplot show -ref_filename[iplot_all] drawing

-attach_ref

Syntax:

-attach_ref[logical_name]= dgn_filename

-attach_ref[logical_name]=[ dgn_filename, saved_view_name, scale_ratio, attach_point]

Value Definition

logical_name The logical name to be assigned to the new reference file.

dgn_filename The name of the reference file to be attached.

saved_view_name The name of a saved view in the reference file that defines the reference file’s orientation and attachment point.

scale_ratio A pair of floating point numbers separated by a colon that define the scale relationship between the master design file and the reference file. The first number represents the master file; the second represents the reference file.

attach_point The attachment point in the master file. If the master file is 2D, specify an XY coordinate in working units; if the master file is 3D, specify an XYZ coordinate.

Examples:

To attach a coincident reference file:iplot mod -attach_ref[hvac]=b100hvac.dgn bldg

To attach a reference file to a 2D master file using a saved view:iplot mod -attach_ref[bor]=[bor.dgn,top,1:1,0,0] car

To attach a reference file to a 3D master file using a saved view, scaling the reference file up by a factor of 2:iplot mod -attach_ref[bor]=[bor.dgn,top,2:1,0,0,0] car

The -attach_ref qualifier attaches a reference file to the IPARM file (not to the design file).

The simple form of -attach_ref performs a "coincident" attachment. The reference file is not rotated or scaled with respect to the master file, and their origins are coincident.

The complex form of -attach_ref performs a saved view attachment. The saved view defines the reference file’s rotation, origin (the center of the saved view is mapped to the specified master file attachment point), clipping boundary (the extents of the view), and levels. This form of -attach_ref also requires a scale ratio defining how the reference file should be scaled relative to the master file.

-detach_ref

Syntax:

-detach_ref[logical_name(s)]


Example:

To detach the reference file with logical names ref1 and ref2:iplot modify -detach[ref1, ref2] drawing

To detach all reference files:

2-30

iplot modify -detach[iplot_all] drawing

The -detach_ref qualifier permanently detaches one or more reference files from the IPARM.

Note Use the Show command to view the logical names and filenames of all reference files that are attached to the IPARM.

iplot show -ref_filename[iplot_all] drawing

Attaching Associated Files

Use the following qualifiers to attach associated files that change the plot’s appearance.

-color_table

Syntax:

-color_table=color_table_file

Example:

To create an IPARM file to plot the sample gray shades:iplot cre -des=256color.dgn -color_table=gshade.ctb grays

The -color_table qualifier reads a color table and stores it in the IPARM file. The color table is placed in the metafile created by the Generate command and is used by the InterPlot Server software on the plot server.

Note InterPlot delivers several IPLOT color tables in the MISC subdirectory of the shared component. The default location of the IPLOT shared component is c:\ Program Files\ Common Files\ InterPlot\ IPLOT.

The color table BW.CTB defines a white background color and colors 0 - 254 as solid black. Use it when you do not want any colors or gray shades on your plot.

The color table GSHADE.CTB defines Color 0 as white and Colors 1 - 254 as decreasing darker gray shades. Its main use is to provide sample gray shades that can be used for screening elements. To plot the gray shades, plot the design file 256 COLOR.DGN (also delivered in the IPLOT MISC subdirectory), with the GSHADE.CTB color table.

-pen_table/-nopen_table

Syntax:

-pen_table=pen_table_file

-nopen_table

Examples:

To attach a pen table to all IPARM files in the current directory:

iplot modify -pen_table=screen.pen *.i

To detach a pen table from an IPARM file:iplot mod -nopen_table house

iplot modify -pen_table=none house

The -pen_table qualifier attaches a pen table to the IPARM file. A compiled version of the pen table is placed in the metafile created by the Generate command and is used during plot processing to change the appearance of selected elements.

If a feature table is attached to the IPARM file, it is detached when you use this qualifier. You can attach a pen table or a feature table, but not both, to an IPARM file.

The -nopen_table qualifier detaches a pen table from an IPARM file. Using -pen_table with none as the filename also detaches the pen table.

-feature_table/-nofeature_table

Syntax:

-feature_table=feature_table_file

-nofeature_table

Examples:

To attach a feature table to all IPARM files in the current directory:

2-31

iplot modify -feature_table=fill.ftb *.i

To detach a feature table from an IPARM file:iplot modify -nofeature_table drawing

iplot modify -feature_table=none drawing

The -feature_table qualifier attaches a feature table to the IPARM file. (For more information on feature tables, see the "Using Feature Tables" section of the InterPlot Reference Help.) A compiled version of the feature table is placed in the metafile created by the Generate command. It is used during plot processing to change the appearance of selected elements.

If a pen table is attached to the IPARM file, it is detached when you use this qualifier. You can attach a pen table or a feature table, but not both, to an IPARM file.

The -nofeature_table qualifier detaches a feature table from the IPARM file. Using -feature_table with none as the filename also detaches the feature table.

-rendering_attributes/-norendering_attributes

Syntax:


-norendering_attributes

Example:

To attach a rendering attributes file:iplot mod -rendering_attributes=hp.ra house

The -rendering_attributes qualifier attaches a rendering attributes file to the IPARM file. The rendering attributes file is sent to the server node along with the metafile by the Submit command.

The -norendering_attributes qualifier detaches a rendering attributes file from the IPARM file. Using -rendering_attributes with none as the filename also detaches the file.

Note Rendering attributes allow you to control certain plotter-specific settings that affect the appearance of the plot. Be sure the rendering attributes file is compatible with the plotter that is serviced by the printer referenced in the IPARM file. You can view and edit rendering attributes files with the InterPlot Utilities > Graphical Attribute Editor in the InterPlot Utilities group. You can access additional online help inside the utility.

Other Qualifiers

The following qualifiers are also available for the Create and Modify commands.

-settings

Syntax:


Example:

To execute a project-specific settings file:

iplot modify -settings=hvac.set building

The settings file qualifier processes the qualifiers in a settings file prior to the remaining command line qualifiers.

-environment/-noenvironment

Syntax:

-environment=[variable_definition(s)]

-noenvironment=[name(s)]

The value variable_definition(s) is an environment variable definition or a comma-separated list of definitions. A definition can take one of two forms:

1 name=value

2 name

The value name(s) is an environment variable name or a comma-separated list of names. The value is an arbitrary string.

2-32

Examples:

To store a pair of variable definitions:iplot modify -environment=[dept=civil, account=123] drawing

To store a value containing blanks or special characters:

iplot modify -environment=[name="John Doe"] drawing

To change a previously stored variable definition:iplot modify -environment=[account=12500] drawing

To remove a pair of variable definitions:iplot modify -noenvironment=[name, account] drawing

The -environment qualifier stores environment variable names or names and values in the IPARM file. The Submit command transfers these names and values to the plot processing stage. If you are using InterPlot Server accounting, these names and values are also stored there.

If an environment variable name is stored without a value in the IPARM file, the Submit command obtains the variable’s value from the operating system’s environment when it submits the plot.

The -noenvironment qualifier removes one or more environment variable definitions from the IPARM file.

Note Environment variable names must start with a letter, may contain only letters, numbers, and underscores, and may not contain blanks.

If the value being assigned to a variable contains blanks or characters that have special meaning to the operating system’s command interpreter, you should enclose the value in quotation marks.

To temporarily define environment variables for a single plot request, use the environment qualifier with the Submit command. Variables defined with the Submit command are not stored in the IPARM file.

-workspace

Syntax:

-workspace=workspace_name

Example:

To associate an IPARM file with a specific workspace:iplot modify -workspace=civil drawing

Specifies a workspace name that IPLOT references to access MicroStation font resource files. The workspace name is stored in the IPARM file. This workspace name determines which font and line style resource files to use when plotting the metafile.

-qpr_options/-noqpr_options

Syntax:

-qpr_options=[qpr_options]

-noqpr_options

Example:

To clear any previously stored options:

iplot modify -noqpr_options drawing

The -qpr_options qualifier stores a set of qpr options in the IPARM file, replacing (not augmenting) any previously stored options.

IPLOT does not validate or interpret the qpr options. The Submit command simply passes the options directly to the queuing system.

The following list contains the qpr options you can use with this qualifier.

-d name=value This option defines an environment variable name and value to be used by the server.

-e tag=file This option allows you to associate a tag with a filename. The tag and the file are placed in the server’s environment to be used for producing the plot.

-l message This option logs messages in the destination printer accounting file; accounting must be enabled for the destination printer.

2-33

-n num-copies* This option prints the specified number of copies.

-R {remove files} This option deletes the original files after the submission process is complete.

-p priority This option assigns a priority; priority must be an integer from 1-99, where a value of 99 defines the highest priority and a value of 1 defines the lowest priority.

Note PCs running Windows 98 cannot use the -p priority option.

* It is recommended that you use the Copies field in the Submit Options dialog box instead of using the -n qpr option.

The -noqpr_options qualifier removes any qpr options stored in the IPARM file.

To temporarily specify qpr options for a single plot request, use the -qpr_options qualifier with the Submit command. The qpr options specified with the Submit command are not stored in the IPARM file.

IPLOT automatically uses the following qpr options when it submits plot requests.

q queue_name

t data_type

r request_name

o options

Note Do not specify these qpr options, because doing so will cause the plot request to fail.

-update

Syntax:

-update

Example:

To update an IPARM with current data from the master file and attached reference files:

iplot modify -update drawing

The -update qualifier can affect the following values:

Master Design File

global origin

view extents

view rotation

view scale

working units

display on/off

settings

levels on/off

level symbology

list of attached reference files

list of raster reference files

display update sequence

Attached Reference Files

file name

logical name

file number

display and fast flags

levels on/off

reference file scaling/rotation

reference file origin

reference file description

2-34

reference file level symbology

clip fence

if the file is displayed or not displayed

IPLOT generated full path name

Non-state information like pen table, workspace, printer, paper size, mirroring, and rotation are not changed. Size and scale are changed if the underlying state information requires that they be changed. Settings files are not re-applied as a part of update.

2-35

IPLOT Show Qualifiers

The following list contains the qualifiers you can use with the Show command:

-color_table -origin -region

-data_rescale -paper_size -rendering_attributes

-design -pen_table -rotation

-[no]display -plot_rescale -scale

-environment -printer -units

-[no]fast -workspace -view

-feature_table -qpr_options -volume

-fence -queue -xsize

-[no]levels -ras_filename -xysize

-mirror -ref_filename -ysize

Note The -nodisplay, -nofast, and -nolevels qualifiers show which settings are turned off.

You can specify reference file logical names with the -[no]display, -[no]fast, and -[no]levels qualifiers to display the settings for specific reference files. If no logical name is specified, then the master file settings are displayed. The logical name IPLOT_ALL can be used to display the settings for the master file and all of the reference files.

For -ref_filename, one or more reference file logical names must be specified. The logical name IPLOT_ALL can be used to display the names of all reference files. You can use wildcards (*, ?) in the logical names.

Examples:

To show all IPARM information:iplot show mytest.i

To show an attached pen table:iplot show -pen_table houseplan.i

To show the levels for all files:iplot show -levels[iplot_all] drawing.i

2-36

IPLOT Submit Qualifiers

You can use the following qualifiers with the Submit command:

-copies

-delete_iparm

-delete_metafile

-[no]environment

-[no]qpr_options

-copies

Syntax:

-copies=number

Example:

To produce 5 copies of a plot:iplot submit -copies=5 drawing

The -copies qualifier requests multiple copies of the plot. The number of copies is not stored in the IPARM file.

-delete_iparm

Syntax:

-delete_iparm

Example:

To delete the IPARM file and the metafile after the plot is submitted:iplot submit -delete_iparm -delete_metafile drawing

The -delete_iparm qualifier specifies that the IPARM file should be deleted if the submission succeeds.

Note Specifying -delete_iparm without also specifying -delete_metafile is not recommended. A metafile is of little use without its corresponding IPARM file.

-delete_metafile

Syntax:

-delete_metafile

Example:

To delete the metafile after the plot is submitted:iplot submit -delete_metafile drawing

The -delete_metafile qualifier specifies that the metafile is to be deleted if the submission succeeds.

-environment/-noenvironment

Syntax:

-environment=[variable_definition(s)]

-noenvironment=[name(s)]

The value variable_definition(s) is an environment variable definition or comma-separated list of definitions. A definition can take one of two forms:

1 name=value

2 name

The value name(s) is an environment variable name or a comma-separated list of names. The value is an arbitrary string.

Examples:

To specify a pair of variable definitions:iplot submit -environment=[dept=civil, account=12] drawing

To specify a value containing blanks or special characters:

2-37

iplot submit -environment=[name="John Doe"] drawing

The -environment qualifier defines one or more environment variables to be transferred to the plot server, which stores them in the accounting record for the plot (if accounting is enabled on the plot server). These definitions are sent to the plot server along with any definitions stored in the IPARM file.

Additionally, you can use the -environment qualifier to archivea drawing (with or without printing) and to set plot attributes. To archive and print a drawing, you must define the environment variable ArchiveName=archive, where archive is the name of the digital archive. The target printer must be serviced by a Digital Print Room machine that contains a digital archive. To archive a drawing without printing, you must specify the environment variable definition ArchiveOnly=TRUE on the same command line with ArchiveName. To set plot attributes, you must specify the attribute keyword and value. For multiple attributes, use a comma-separated list. See the table following the examples for a list of attributes.

Examples:

To archive and print a drawing, type in:

iplot submit -environment=[archivename=archiveA] map

To archive without printing a drawing, type in:

iplot submit -environment=[archivename=archiveA, archiveonly=true] map

To set plot attributes, type in:

aplot submit -environment=[URL=http://www.interplot.com, Author=ab]

This sets the Related Web Page attribute to www.interplot.com and sets the Author attribute to ab.

The following table lists the attribute variable keywords, names, and descriptions.

Keyword Name Description

PlotSetID Plot Set ID Defines additional design information.

ProjectID Project ID Defines additional project information.

Account Account Defines the account.

Revision Revision Defines the revision number.

Author Author Defines the author.

URL Related Web Page Specifies a place holder for a user specific WWW link.

If an environment variable name is specified without a value, the Submit command obtains the variable’s value from the operating system’s environment.

The -noenvironment qualifier causes the Submit command to ignore one or more of the variable definitions stored in the IPARM file.

Note Environment variable names must start with a letter, may contain only letters, numbers, and underscores, and may not contain blanks.

If the value assigned to a variable contains blanks or characters that have special meaning to the operating system’s command interpreter, enclose the value in quotation marks.

To permanently store environment variables in the IPARM, use the -environment qualifier with the Modify command.

-qpr_options/-noqpr_options

Syntax:

-qpr_options=[qpr_options]

-noqpr_options

Example:

To clear any previously stored options:

iplot modify -noqpr_options drawing

The -qpr_options qualifier specifies a set of qpr options to be used with the plot request. These queuing system options override (not augment) any queuing system options stored in the IPARM file.

IPLOT does not validate or interpret the qpr options. The Submit command simply passes the options directly

2-38

to the queuing system.

The following list contains the qpr options you can use with this qualifier.

-d name=value This option defines an environment variable name and value to be used by the server.

-e tag=file This option allows you to associate a tag with a filename. The tag and the file are placed in the server’s environment to be used for producing the plot.

-l message This option logs messages in the destination printer accounting file; accounting must be enabled for the destination printer.

-n num-copies* This option prints the specified number of copies.

-R {remove files} This option deletes the original files after the submission process is complete.

-p priority This option assigns a priority; priority must be an integer from 1-99, where a value of 99 defines the highest priority and a value of 1 defines the lowest priority.

Note PCs running Windows 98 cannot use the -p priority option.

* It is recommended that you use the Copies field in the Submit Options dialog box instead of using the -n qpr option.

The -noqpr_options qualifier removes any qpr options stored in the IPARM file.

To temporarily specify qpr options for a single plot request, use the -qpr_options qualifier with the Submit command. The qpr options specified with the Submit command are not stored in the IPARM file.

IPLOT automatically uses the following qpr options when it submits plot requests.

q queue_name

t data_type

r request_name

o options

Note Do not specify these qpr options, because doing so will cause the plot request to fail.

Submit Examples

To submit the metafile associated with an IPARM file:iplot submit design

To request two copies of the plot:iplot submit -copies=2 design

To submit metafiles for all IPARM files in the current directory:iplot submit *.i

2-39


2-40

C H A P T E R 3 Using Setting Files

What are Settings Files?

Settings files provide an easy and flexible way of defining default plotting values for your plots and plot sets.

You can use settings files to:

Store plotting parameters so that they can be easily reused. For example, if you always plot at a particular size with a specific color table and pen table, then those qualifiers (along with their values) can be placed into a default settings file that InterPlot automatically reads.

Establish settings that pertain to the entire plot set, such as printer name.

Enforce drawing standards. By using settings files you can force on/off particular levels or display parameters, use particular scales, or pen tables.

Eliminate typographical errors. Less typing and file selection is required in specifying the plotting parameters when you use settings files.

Group together plotting parameters so that you can apply them to a specific plot or plot set.

Assist novice users. Settings files can reduce the need to navigate through dialog boxes entirely. For most cases settings files get you closer to "one button plotting."

Settings files consist of settings that apply to an entire plot set (Common Settings) and settings that apply to individual plots within the plot set (Plot Level Settings).

Common Settings

Common settings apply to all plots in the plot set. Common settings include printer name, archive name, rendering attributes filename, and plot set attributes (Plot Set ID, Project ID, Author, Account, Revision, Related Web Page, PDF file, and user-defined attributes). These settings are stored as a separate section (Common section) in the settings file. You can specify common settings in default settings files, printer settings files, and manually-applied settings files, but you cannot specify a printer name in a printer settings file.

Plot Level Settings

Unlike common settings that apply to all plots in the plot set, plot level settings apply to individual plots within the plot set. You can create sections for specific data types (APLOT, IPLOT, raster, digital archive) in a settings file. The settings in these sections apply to plots of the specific data type. For example, you might specify an x-size of 34 inches for all APLOT data, and a rotation of 90 degrees for all IPLOT data.

3-1

Types of Settings Files

InterPlot Client and InterPlot Professional provide support for three types of settings files:

Default Settings Files

Printer Settings Files

Manually-applied Settings Files

InterPlot automatically applies default and printer settings files, but you must take additional steps to use manually-applied settings files. Each of the InterPlot plotting interfaces provides a method for manually applying a settings file.

Default Settings Files

Introduction

With InterPlot, you can create a default settings file which stores plot parameters that will be applied automatically each time you create plots using the dialog, Organizer, or command line interfaces. By default, you must name the settings file IPLOT.SET and put it in one of three directories:

Your home directory (which allows "per user" defaults on machines with shared user accounts)

The directory containing the drawing file or design file (which allows the same settings to be used for all of the files in the given directory)

The SETTINGS subdirectory of the product directory (which allows "per machine" defaults)

Both the name of the default settings file and the directory locations can be changed, as described below.

Changing the Name of the Default Settings File

If you want to name the default settings file something other than IPLOT.SET, you can change it. The default settings file name is defined by the configuration variable IP_DEFAULT_SETTINGS. (Use Organizer’s Edit -> Configuration -> Common feature or the configure utility located on the InterPlot Utilities program folder to change the value of the configuration variable IP_DEFAULT_SETTINGS.)

Changing the Settings File Search Path

The directory locations for default and printer settings files can be changed. InterPlot searches the directories specified by the configuration variable IP_SETTINGS_PATH for default and printer settings files. Once it finds the first occurrence of the settings file, InterPlot does not search any of the remaining directories for the file. To specify a list of directories in the settings file search path, you must separate each directory with a semicolon. You can edit the configuration variable IP_SETTINGS_PATH using the same methods described above for editing default settings files.

Applying Multiple Settings

By default, InterPlot finds the first occurrence of a default or printer settings file and does not search any of the remaining directories in the settings file search path. You can change this behavior and search multiple levels of default and printer settings files.

The configuration variable IP_APPLY_ALL_SETTINGS allows you to set up multiple levels of default settings files. For example, some users may want to have company-wide default settings files which can be overridden on a per-user or per-site basis. To do this, you can set the configuration variable IP_APPLY_ALL_SETTINGS to TRUE. When this configuration variable is set to TRUE, all of the default settings files found in the search path are read and applied. The default value for this configuration variable is FALSE.

Printer Settings Files

When you select a printer, InterPlot searches for a printer settings file, which defines the parameters related to a specific printer.

For example, suppose that you have a printer named COLOR that connects to a color plotter and a printer named MONO that connects to a monochrome plotter. You can create a printer settings file for each printer and use the color table qualifier to specify a different color table for each printer.

InterPlot searches for a printer settings file with the same name as the printer and with a .SET extension appended to it. Using the previous example, InterPlot looks for a printer settings file named COLOR.SET when you use the color printer.

3-2

The following table lists examples of various types of printers along with their associated settings file.

For this type of printer Use this settings file name

\\SERVER\HPDJET (Remote Windows NT) HPDJET.SET

HP2500 (Local printer) HP2500.SET

InterPlot searches for printer settings files exactly as it does for default settings files. Once InterPlot finds the first occurrence of PRINTER_NAME.SET, it does not search any of the remaining directories for the file, unless the configuration variable IP_APPLY_ALL_SETTINGS is set to TRUE. When this configuration variable is set to TRUE, all of the printer settings files found in the search path are read and applied. The default value for this configuration variable is FALSE.

Note A printer settings file can contain any setting except for printer name.

Manually-applied Settings Files

Although InterPlot uses settings files automatically, you can manually load specific settings files by using Organizer, the dialog box, or the command line. By manually applying settings files, you can store groups of commonly used qualifiers (along with their values) in a file and then reference them on demand. This method of referencing settings files is helpful when a group of plotting parameters is used only for a specific project or on an occasional basis.

The configuration variable IP_APPLY_ALL_SETTINGS does not apply to manually-applied settings files.

Note When you name a settings files that you want to load manually, use a name other than the name specified with the IP_DEFAULT_SETTINGS configuration variable. InterPlot automatically searches for and loads the filename specified with this variable.

3-3

Creating and Editing Settings Files

The InterPlot Organizer interface, which is a standard component of both InterPlot Client and InterPlot Professional, contains a settings file editor that enables you to create and edit settings files.

Using Organizer to Create Settings Files

To create a settings file:

1 From the Organizer menu bar, select Edit -> Settings File -> Create.

2 On the Create Settings File dialog box, select a section from the Sections to create list, and then click the Create Section button.

This removes the section entry from the Sections to create list and adds it to the Sections created list.

Note Only data type support that is installed will display in this dialog box. The Common section enables you to specify common settings. Common settings include printer name, archive name, rendering attributes filename, and plot set attributes.

3 Click the Edit Section button to access the properties sheet.

4 From the Create Settings property sheet, specify the settings you want.

To get help on a specific item, click at the top of the Create Settings property sheet, and drop it on the item you want help on.

5 To exit the Create Settings property sheet, click OK.

6 To add additional sections, repeat steps 2-5. (This step is optional.)

7 To remove a section from the settings file, select the section from the Sections created list and click the Delete Section button. (This step is optional.)

This removes the section entry from the Sections created list and adds it to the Sections to create list.

8 To save the settings file, click Save As. Specify the name of the settings file, and then click Save.

9 To exit the Create Settings dialog box, click Close.

Note Settings files created or edited with this editor are not saved as text files and are not compatible with InterPlot products prior to version 9.0.

Using Organizer to Edit Settings Files

To edit a settings file:

1 From the Organizer menu bar, select Edit -> Settings File -> Edit.

2 On the Select a Settings File dialog box, select a settings file, and then click Open.

Note If you select an ASCII settings file, a message appears informing you that if you edit and save the ASCII file, it will be written as a binary file. If you choose to edit the ASCII settings file, you must select the data type that you want the qualifiers in the settings file to apply to. Only APLOT and IPLOT data types support ASCII settings files.

Organizer displays the existing sections in the Sections present in file list box.

3-4

3 To edit an existing section, select the section from the Sections present in file list, and then click the Edit Section button. To add an additional section, select the section from the Sections to add list, click the Add Section button, and then click the Edit Section button.

4 On the Modify Settings property sheets, specify the settings you want to change.

To get help on a specific item, click at the top of the Create Settings property sheet, and drop it on the item you want help on.

5 To exit the Modify Settings property sheet, click OK.

6 To remove a section from the settings file, select the section from the Sections present in file list and click the Delete Section button. (This step is optional.)

This removes the section entry from the Sections present in file list and adds it to the Sections to add list.

7 To save the settings file, click Save, and then click Close.

Note Settings files created or edited with this editor are not saved as text files and are not compatible with InterPlot products prior to version 9.0.

Creating Settings Files as Text Files

You can still create settings files as text files and use them with the InterPlot Client/Professional software, but there are some limitations. The limitations are:

All settings in the file apply to either IPLOT or APLOT data. (No support for Common settings or settings files containing multiple data types as with binary settings files.)

If both APLOT and IPLOT components are installed, the qualifiers are interpreted as IPLOT qualifiers, and the APLOT qualifiers are rejected. Both default and/or printer settings files are applied to IPLOT data in Organizer.

ASCII settings files are Text files that contain Create and Modify command line qualifiers. The format of the settings file is one qualifier per line (along with its associated value). The maximum length of any line in a settings file is 1024 characters. The leading dash (-) character is optional when used in a settings file, though the command line interface requires it.

Note You can use any setting in an settings file except for the -settings qualifier. One additional setting you can not use in a printer settings file is -printer.

3-5

Applying Settings Files

You can apply a settings file to a single plot using the dialog box, or you can apply a settings file to one or more plots using the Organizer and command line interfaces. To apply a settings file:

With Organizer, use the Edit -> Settings File -> Apply command to apply a settings file. You can select this command from Organizer’s Edit menu or by right-clicking the selection, then clicking Apply Settings on the shortcut menu. Refer to Organizer’s Help Topics for details on using the Apply Settings command.

With the IPLOT dialog box, use the File -> Select Settings command to apply a settings file. With the APLOT dialog box, select the File command, and then click Select Settings to display the Select Settings File dialog box.

With the command line, you can manually apply a settings file while using the Create or Modify command with the -settings qualifier. The -settings qualifier specifies the name of the settings file. When you use the -settings qualifier, the contents of the referenced settings file are inserted into the beginning of the command line. This enables qualifiers specified on the command line to override those specified in the settings file.

3-6

Settings Files Priorities

To ensure that you have an opportunity to override any settings file defaults, InterPlot always processes settings files and any specified qualifiers in a particular order.

The following priority issues are applicable to the dialog, Organizer, and command line interfaces:

Any plotting parameters specified in the dialog, Organizer, or in the command line interface after a settings file has been loaded always override any duplicate or mutually exclusive qualifiers that may have appeared in the loaded settings file. Mutually exclusive qualifiers are qualifiers that are not intended to be specified together, because using one of them would alter the value of the other. For example, Xsize and Scale are mutually exclusive qualifiers. If the loaded settings file contained Xsize, and Scale was then specified, InterPlot would use the Scale value.

When the configuration variable IP_APPLY_ALL_SETTINGS is set to TRUE, all of the default and printer settings files found in the search path will be read and applied. Mutually exclusive qualifiers that may appear in subsequent default or printer settings files override the same qualifiers that appear in previous default or printer settings files. When this variable is set to FALSE, only the first occurrence of a default and printer settings file will be read and applied; InterPlot does not search any of the remaining directories for the file. The default value for this configuration variable is FALSE.

If both a default and printer settings file exist, duplicate or mutually exclusive parameters in the printer settings file override those in the default settings file. This situation could occur if a default settings file (defined by the IP_DEFAULT_SETTINGS configuration file variable) is used and contains a reference to a printer that has a printer settings file associated with it.

The following priority issues are applicable only to the command line:

If you use a qualifier and a settings file that contain the same or mutually exclusive qualifiers in the same command line, then the value of the qualifier from the settings file is ignored.

If you use the -settings qualifier with the Create or Modify commands and a default or printer settings file exists, any qualifiers in the file referenced by the -settings qualifier will override any duplicate or mutually exclusive qualifiers that InterPlot read from the default or printer settings file.

3-7

Upgrade Issues

When you upgrade to InterPlot Client or InterPlot Professional from IPLOT 8 or APLOT Professional, all files that are not configuration files will be overwritten with the new versions. The configuration files will remain, but will be modified. In the case of IPLOT 8, the setup program will open the old IPLOT.CFG file and retrieve the values for the default settings file and the settings file search path.

The default values for these configuration variables are:

IPLOT_DEFAULT_SETTINGS=iplot.set

IPLOT_SETTINGS_PATH=$HOME;$IPLOT_MASTER_DIR;$IPLOT_PRODUCT_DIR\SETTINGS

These values will be written to the configuration file IP.CFG, which is located in the CONFIG subdirectory of the InterPlot Client or InterPlot Professional product directory. This means that IP_DEFAULT_SETTINGS will be IPLOT.SET for this computer.

For example, suppose IPLOT 8 was installed in C:\Program Files\IPLOT, and the user had edited IPLOT.CFG as follows:

IPLOT_SETTINGS_PATH=c:\joe;n:\site;$IPLOT_PRODUCT_DIR\settings

IPLOT_DEFAULT_SETTINGS=iplot.set

After installing InterPlot Client or InterPlot Professional, the IP.CFG would contain the following settings:

IP_SETTINGS_PATH=c:\joe;n:\site;\Program Files\iplot\settings;$HOME;$IPLOT_MASTER_DIR; $APLOT_MASTER_DIR;$IP_PRODUCT_DIR\settings

IP_DEFAULT_SETTINGS=iplot.set

If APLOT Professional is the only installed component, then similar changes will be done for APLOT. In this case, IP_DEFAULT_SETTINGS will be set to APLOT.SET.

If a system has both APLOT and IPLOT installed, IPLOT.SET will be the default settings file. The setup program will then delete obsolete settings file configuration variables and their descriptions from both IPLOT.CFG and APLOT.CFG, and put them into the IP.CFG file.

3-8

C H A P T E R 4 Plot Resymbolization

What are Pen Tables?Note Throughout this section the term IPLOT refers to the IPLOT component of InterPlot.

By default, design files and reference files are plotted as they display on the screen. Pen tables enable you to alter the appearance of a design file when it is plotted. For example, you might want to highlight the elements on a particular level by assigning them a width, color, or line style that stands out. Changing the appearance of elements on a plot is called resymbolization. Some common uses for resymbolization include the following:

Highlighting specific elements by changing their color, width, or line style.

Substituting the current date for a specified text string.

Controlling the order in which elements are plotted.

Obtaining consistent colors on various plotters with the use of color tables and libraries.

Defining custom line styles.

Area-filling closed elements with a specified color or pattern.

Omitting specific elements from the plot.

4-1

Using IPLOT Pen Tables

Pen tables enable you to alter the appearance of a design file when it is plotted. For example, an architect may want to change the color and line width of a particular area of a floor plan to highlight a specific area. Another user might want to area-fill polygons on the plot and assign priorities to the various elements to control the order in which they are plotted. For example, text can be assigned a higher priority than filled polygons, ensuring that the text is always visible.

How a Pen Table Works

The pen table resymbolizes elements from the design file as they are processed by the metafile interpreter. A pen table modifies an element’s attributes if it meets certain criteria. For example, you can write a pen table that checks the element to see if it is on a particular level and resymbolizes the element’s display attributes if it is on the specified level.

If level symbology is enabled for the design or reference file you are plotting, IPLOT applies the level symbology before executing the pen table. The pen table overrides any other display attributes enabled for the file. For example, elements filled by the pen table always plot filled, even if the area_fill display attribute is disabled.

The following pen tables demonstrate two techniques commonly used in resymbolizing a design file. The first method involves searching for a specific text string element in the file and replacing it with another string. In this specific case, the design file’s actual name and the current date replace the text strings $DGNFILENAME$ and mmddyy, respectively. Thus, the design file used to generate the plot and the date the plot was created are used to label the plot.

Example 1:

! NAME! txtsubst.pen!! DESCRIPTION! Pen table to substitute the design filename and ! the current date for the strings ! $DGNFILENAME$ and mmddyy, respectively.!! HISTORY! 01/20/93 (INGR) Initial creation.!! If the current element is a text element, see if ! it contains one of the special place-holder ! strings. If it does, substitute an ! automatically-generated string for it.if (type == text) then if (characters == ’$DGNFILENAME$’) then characters = ip_design else if (characters == ’mmddyy’) then characters = date endifendif

The second method involves de-emphasizing or screening certain elements by plotting them in a light gray color. The following pen table highlights the drawing sheet, text, and furniture on level 15 by screening all other elements.

Example 2:

! NAME! screen.pen!! DESCRIPTION! This pen table demonstrates screening.!! HISTORY! 01/20/93 (INGR) Initial creation.!! Highlight all text, the sheet border (Level 1), ! and furniture (Level 15) by plotting it in pure

4-2

! black on top of all other elements. Screen ! (de-emphasize) all other elements by plotting! them with a gray dither (halftone) pattern.!if ((level .in. 1, 15) || (type == text)) then color = (0, 0, 0) ; R=0, G=0, B=0 is pure priority = 100 ; blackelse color = (200, 200, 200) ; R=200, G=200, B=200 is weight = 4 ; light gray priority = 10 endif

4-3

IPLOT Pen Table Language

A pen table is composed of statements. Statements consist of combinations of keywords, constants, operators, and expressions. None of the pen table components are case sensitive.

Statements and Keywords

Pen tables contain two types of statements and keywords: assignment and comparison. The type of statement depends on the type of keyword it contains. For example, a statement that contains a comparison keyword is a comparison statement.

Comparison statements test a single element attribute against a specified condition. If the attribute meets that condition, then assignment statements modify elements by changing the element’s attributes.

The pen table language includes a set of predefined keywords. These keywords are grouped into assignment keywords and comparison keywords because they are either used to assign new attributes to an element or to compare an element’s existing attributes to values specified in the pen table.

The data type of a keyword depends on how it is used within a statement in the pen table. If a keyword is assigned a new value, its data type might be a string or an integer. When used in an expression, however, its data type might be limited to an integer.

If you change an element’s attribute early in the pen table, then that attribute is evaluated later in the table by its new value instead of its original value. In other words, if you change an element’s style at the beginning of the pen table with an assignment keyword, then the element’s style is later evaluated with a comparison keyword with the new style. The color of an element can be set using an integer, string, or RGB value but can only be compared to the integer value.

Data Types

Each pen table keyword requires a value. You can use six types of data to specify a value: working units, integers, real numbers, strings, RGB colors, and line style definitions.

Working Units — MicroStation working units. Refer to your MicroStation documentation for information on working units.

Integers — An integer is a series of one or more digits that can be preceded by a minus sign.

Examples:

7

144

-32

Real Numbers — A real number is a series of one or more digits that can include a decimal point. Real numbers can be preceded by a minus sign.

Examples:

3.14

0.5

.75

-12.

180.0

Strings — A string constant is a sequence of zero or more characters enclosed in quotes. You can use either single or double quotes, but the opening and closing quote must be the same type.

Examples:

’$DGNFILENAME$’"green, medium forest"

RGB Colors — An RGB data type represents a color. It is specified as a triplet of integers in the range 0 to 255. The integers represent red, green, and blue intensities, respectively. You can specify white as (255,255,255) and black as (0,0,0).

Examples:

(255, 0, 0) red

4-4

(0, 255, 0) green

(0, 0, 255) blue

(255, 255, 0) yellow

(255, 0, 255) magenta

(0, 255, 255) cyan

(200, 200, 200) light gray

(100, 100, 100) dark gray

Line style definitions — Line style definitions are defined by pairs of on/off transitions in the following format:

(on_transition, off_transition,...)

You can specify any number of on/off transitions as long as, for every on transition, there is a corresponding off transition. The transitions can be integer or real values and specify a distance in user-defined units. For example, if you specify in the pen table that the units are millimeters (mm), the line style definition 3, 1.5, 5, 1.5 indicates a dash 3 mm long, a space of 1.5 mm, a 5 mm dash followed by a 1.5 mm space.

Example:

(1.5, 1, 1.5, 0.5)

Constants

Several constants are defined for the various data types to make writing and understanding pen tables easier. The classes of constants described in the following section have been defined for use with specific keywords.

Boolean Constants — Constants have been defined as true and false for use with keywords such as area_fill, ignore, flash, and the properties keywords. The Boolean constants are:

true or .true. false or .false.

Note Either form of the constant (for example, true or .true.) can be used.

Element Constants — The element constants can be used in comparison expressions with the type keyword. The element constants are:

arc line

assoc_dim line_string

bspline_curve multiline

bspline_surface shape

cell shared_cell

complex_shape solid

connected_string surface

curve text

ellipse text_node

Units Constants — The units constants can be used for setting the units keyword to specify the dimension for distance keywords such as thickness, weight_base, weight_delta, and line style. The constants can be used in their long or abbreviated form.

centimeters (cm)

millimeters (mm)

meters

inches

feet (ft)

Line Joint/Endcap Constants — The midline_joint and endcap keywords can be assigned a value using the following constants:

butt

circle

Class Constants — The class constants enable you to modify or compare against the class keyword.

primary

4-5

pattern_component

construction

dimension

primary_rule

linear_pattern

construction_rule

Properties Constants — The properties constants are used with the properties keyword to determine if bits in the properties word of the element are set.

attributes

hole

locked

modified

new_element

nonplanar

nonsnappable

screen_relative

Operators and Expressions

The pen table language provides five types of operators and expressions. These operators and expressions enable you to compare values of keywords with other keywords and constant expressions, to test for membership in a list, and to build arithmetic expressions. These operators are categorized as relational operators, logical operators, arithmetic operators, list operators, and the string concatenation operator.

Relational Operators

Relational operators provide a way to test two values to determine if they are equal or not, or if one is less than or greater than the other. All of the relational operators require two operands. A relational expression takes the following form:

operand1 relational_operator operand2

With one exception, only operands of the same data type can be compared with one another. If one operand is an integer and the other operand is a real number, the integer value is converted to a real number before the comparison is made.

Wildcards can be used in string comparisons of equality or inequality. For example, the string "ELEC*" matches any string that begins with the characters ELEC. Similarly, "*PLUMB*" matches any string that contains the substring PLUMB. The following characters have a special meaning in comparisons with string keywords:

Character Function

* matches zero or more occurrences of any character

? matches exactly one occurrence of any character

\ indicates that the next character is to be treated as an actual character and not as a special character. In other words, it disables the special meaning of the asterisk (*) and question mark (?) characters.

The result of a relational expression is a value of true if the condition is satisfied and false if the condition is not satisfied. The following list describes the relational operators, as well as some example relational expressions:

Operator Result

.EQ. , EQ , or == true if operand1 and operand2 are equal

.NE. , NE , or <> true if operand1 and operand2 are not equal

.GE. , GE , or >= true if operand1 is greater than or equal to operand2

.LE. , LE , or <= true if operand1 is less than or equal to operand2

.GT. , GT , or > true only if operand1 is greater than operand2

.LT. , LT , or < true only if operand1 is less than operand2

Examples:

4-6

(color == 5)

(level .NE. 7)

(cellname == "PLAN*")

(thickness > 0.5)

Logical Expressions

Logical expressions are compound relational expressions formed by combining simple relational expressions with logical operators. The logical_and operator (AND, .AND. or &&) and the logical_or operator (OR, .OR. or ||) are both binary operators. Both operands must be simple relational expressions or logical expressions that evaluate to true or false. The logical_not operator (.NOT.) requires only a single operand. The following list contains descriptions of each of the logical operators and some example logical expressions.

Operator Result

.AND. , AND , or && Evaluates to true if and only if both operands are true. Otherwise it evaluates to false.

.OR. , OR , or || Evaluates to true if either operand is true. Evaluates to false if and only if both operands are false.

.NOT. or NOT Evaluates to true if the single operand is false. Evaluates to false if the operand is true.

Examples:

((type == line) || (type == line_string))

((level .eq. 15) .AND. (type .ne. text))

(.NOT.(color == 5))

Arithmetic Expressions

The pen table language also has the standard arithmetic operators that enable you to create arithmetic expressions. All these operators are binary (except minus which is both binary and unary) and take integers and real numbers as operands. If an integer operand and a real number operand are used in the same expression, the integer is first converted to a real number and then the operation is performed. The result of an arithmetic expression is either an integer, if all the operands are integers, or a real number if any one of the operands is a real. The following are the arithmetic operators and some examples of arithmetic expressions.

- Negative operator

+ Addition operator

- Subtraction operator

* Multiplication operator

/ Division operator

Examples:

-10

thickness * 2

color + 1

(size + 1.0)/2

List Expressions

List expressions are used to determine if a string or number is in a specified list. For example, if you wanted to change the color of every element on levels 15, 23, and 45 to red, you could use the .in. (in the list of) operator and the list expression shown below.

if (level .IN. 15, 23, 45) then color = "red" endif

There is also the .NI. (not in the list of) operator for determining if a value is not in the list.

Although integers and real numbers can exist together within a list, you cannot mix numbers and strings. Also, both operands of a list operator must be the same type. A keyword whose value is a string, such as cellname, can also be included in a list of strings.

A consecutive range of numbers can be indicated with the following notation.

4-7

number1 - number2

This construct specifies that if number1 and number2 are both integers, all integers in the range of number1 to number2 are part of the list. If either number is a real, any number greater than or equal to number1 and less than or equal to number2 is included in the list. The expressions below are examples of valid list expressions.

Examples:

type .IN. cell, text_node, connected_string, complex_shape

level .NI. 5-10, 16, 48-53

color .IN. 1, 8, 12, 30-39

String Concatenation Operator

The string concatenation operator (+) enables strings to be added together to form a single string. The operator is the same as the arithmetic addition operator, but strings and numbers cannot be used together within a single expression using the ’+’ operator.

Examples:

Expression Result

’A’ + ’B’ + ’C’ + ’D’ ’ABCD’

"A" + "Z" + "1" ’AZ1’

’Con’ + "cat" ’Concat’

Operator Precedence

You can combine all of the operators described above to form complex expressions. In some cases, different results can be obtained depending on the order of evaluation of the expression. For example, the expression

color + 3 * 5

is ambiguous. It could be interpreted as

(color + 3) * 5

OR

color + (3 * 5)

To resolve this ambiguity, each operator has a relative precedence. When there are no parentheses to directly indicate the order of evaluation, operators with a higher precedence are evaluated before an operator of lower precedence. Operators of the same precedence are evaluated from left to right. The following list contains operators in order of precedence from highest to lowest. Operators of the same precedence are listed on the same line.

.NOT. NOT

/ *

+ -

.IN. IN .NI. NI

.EQ. EQ == .NE. NE <> .GE. GE > = .LE. LE< = .GT. GT> .LT. LT<

.OR. OR || .AND. AND &&

It is generally a good practice to use parentheses with expressions that can be ambiguous instead of depending on precedence rules. Parentheses also make the pen table program easier to understand.

Statements

A pen table program is made up of a series of statements. The different types of statements provided by the pen table language use the supported keywords, expressions, and operators which enable you to resymbolize your design file. There is also a Stop statement that enables you to terminate the processing of an element in the pen table.

Comments

The most basic statement of the pen table language is the comment. This comment begins with the ’#’, ’!’, or ’;’ character and continues to the end of the current line. Comments are used to improve a pen table’s readability and to document its operation. They do not impact the operation of the pen table. Below are examples of valid

4-8

comments within a pen table.

# This is a sample commentcolor = "red" ; This is also a comment

Assignment Statements

Assignment statements in the pen table are used to modify an element’s attributes. The assignment statement has the form

keyword = expression

where keyword is any of the keywords listed in Assignment Keywords. The data type of the expression must be compatible with the data type of the keyword. For example, assigning a string constant to an integer keyword is illegal. The following examples are legal assignment statements:

Examples:

ignore = .true.

area_fill = false

midline_joint = miter

style = "dotted"

thickness = weight * 0.05

If-Then-Else-Endif Statements

If-then-else-endif statements are used in pen tables to determine if an element has certain attributes and to control program flow based on the results. The following are example syntaxes:

if (expression) then 1 or more statementsendif

OR

if (expression) then 1 or more statementselse 1 or more statementsendif

OR

if(expression) then 1 or more statementselse if (expression) then 1 or more statementselse if ...else 1 or more statementsendif

The expression portion of an if statement must evaluate to an integer and is typically true or false. Any nonzero value is considered true. If the expression evaluates to false, or zero, the else portion of the statement, if present, is executed. The following pen table segment makes use of the if-then-else-endif construct.

Example:

if (level == 23) then style = (1, 0.5) color = "green"else if (level == 45) then style = (1.0, 0.25, 0.5, 0.25) area_fill = true color = "blue, sky"else style = 0 color = (0, 0, 0)endif

4-9

Switch Statements

The switch statement is similar to the if-then-else-endif statement in that it enables you to control the flow of the pen table program based on an element’s attributes. The syntax for the switch statement is as follows:

switch (expression) case value1 ? 1 or more statements case value2 ? 1 or more statements ... default ? 1 or more statementsendswitch

The switch expression is evaluated and successively compared against the values associated with the case keyword. The values (for example, value1, value2, and so forth) must be constants, constant expressions, or a numeric range. If the expression and a value are equivalent or if the expression is in the range of the value, the statements following the case statement up to the next case are executed. The optional default case is executed if the expression does not match any of the case values. The following are two examples of the switch statement:

Example 1:

switch (level) case 20 ? color = "blue" thickness = 0.25 case 30-40 ? color = "red" thickness = 0.3endswitch

Example 2:

switch (weight) case 0-5 ? thickness = 0.25 case 6-10 ? thickness = 0.5 default ? thickness = 0.75endswitch

Stop

The stop statement is used to improve the speed of pen table execution by enabling the system to avoid unnecessary comparisons. When the stop statement is executed, the pen table stops processing the current element as if IPLOT reached the end of the pen table. Any modifications to the element before the stop statement are performed.

Example:

if (type == ellipse) then color = 4 stopendif

4-10

IPLOT PENCK Utility

The penck utility allows you to check a pen table for syntax errors before generating a metafile. The syntax for ths utility is:

penck pen_table

If there are any syntax errors, penck will output an error message identifying each error and the line number where the error occurred.

4-11

IPLOT Comparison Keywords

The following keyword descriptions include a brief description of the keyword function, the types of elements the keyword affects (if applicable), the valid data type(s) (if applicable), and an example of how to use the keyword.

angle envr_value size

area_fill file style

cellname font tag_character

characters font_name tag_display

class header_type tag_integer

cls_end_width ip_scale_num tag_real

cls_name ip_xsize_num text_node_number

cls_origin_width ip_ysize_num type

cls_scale level weight

cls_shift_distance lname width

cls_shift_fraction nested_cellname

color properties

angle

The angle keyword specifies the angle for element types cell, text node, ellipse, arc, and text. For other element types, the angle value is 0.0.

Data Type: real number in the range of 0.0 to 360.0

Example:

!! Change the color of text elements rotated 90! degrees.!if ((type == text) and (angle == 90.0)) then color = 2endif

area_fill

The area_fill keyword checks to see if the current element is filled.

Data Type: constant (true or false)

Example:

!! Change the fill color of all filled elements.! Do not alter elements that are not filled.!if (area_fill == true) then fill_color = 10endif

cellname

The cellname keyword specifies the name of the cell if the current element is a cell header or a component of a cell. For components nested within one or more cells, the cellname keyword specifies the name of the outermost cell unless the component is a nested cell header. In this case, the cellname keyword is the name of the nested cell. If the current element is not a cell header or is not a component of a cell, the value for cellname is "NO_CELL". Wildcards can be used in string comparisons of equality or inequality.

Note To find the name of the innermost cell name, use the nested_cellname keyword.

Data Type: string containing up to 6 characters

Example:

!

4-12

! Change the color of all components of the cell! named "border."!if (cellname == "border") then color = (200,200,200)endif

characters

The characters keyword specifies the string contained in the element if the current element is a text element. Wildcards can be used in string comparisons of equality or inequality.

Data Type: string

Example 1:

!!Highlight any text strings that contain the string!’School’ or ’Hospital’.!if ((type == text) and (characters ==’*School*’)) then color = (0,0,255)else if ((type == text) and (characters ==’*Hospital*’)) then color = (255,0,0)endif

Example 2:

!!Removes the text "preliminary" if it appears in!"border" file.!if ((lname=="border") and (characters=="preliminary"))then ignore_element=trueendif

class

The class keyword specifies the class type of the current element. For example, the class of the current element might be used in a pen table to determine if the current element is part of a dimension or pattern.

Data Type: integer in the range from 0 to 6, or one of the following constants:

0 primary

1 pattern_component

2 construction

3 dimension

4 primary_rule

5 linear_pattern

6 construction_rule

Example:

!!Do not plot pattern and dimension class elements.!if ((class == pattern_component) or (class == dimension)) then ignore_element = true endif

cls_end_width

The cls_end_width keyword tests the ending width, in master design file units, of the MicroStation custom line style associated with the current element. If the current element does not have an associated custom line style, the cls_end_width is 0.0.

Data Type: real number

4-13

Example:

!! Change the color of all elements using a ! MicroStation custom line style whose ending ! width is greater than 2 master design units.!if (cls_end_width > 2.0) then color = 5endif

cls_name

The cls_name keyword tests the name of the MicroStation custom line style associated with the current element. For elements without an associated custom line style, the cls_name is "NONE."

Data Type: string

Example:

!! Change the color of all elements using the style. ! Assign the "origin" custom line style to all! other elements.!if (cls_name == ’{ Diamond }’) then color = 2else cls_name = "origin"endif

cls_origin_width

The cls_origin_width keyword tests the starting width, in master design file units, of the MicroStation custom line style associated with the current element. If the current element does not have an associated custom line style, the cls_origin_width is 0.0.


Example:

!! Change the color of all elements using a ! MicroStation custom line style whose starting! width is greater than 2 master design units.! ! if (cls_origin_width > 2.0) then color = 5endif

cls_scale

The cls_scale keyword tests the scale factor applied to the MicroStation custom line style associated with the current element. If the current element does not have an associated custom line style, the cls_scale is 1.0.


Example:

!! Change the color of all elements using a ! MicroStation custom line style whose scale! is 2.!if (cls_scale == 2.0) then color = 5endif

cls_shift_distance

4-14

The cls_shift_distance keyword tests the shift distance, in master design file units, applied to the MicroStation custom line style associated with the current element. If the current element does not have an associated custom line style, the cls_shift_distance is 0.0.


Example:

!! Change the color of all elements using a ! MicroStation custom line style whose shift ! distance is 0.5 master design units.!if (cls_shift_distance == 0.5) then color = 5endif

cls_shift_fraction

The cls_shift_fraction keyword tests the shift fraction applied to the MicroStation custom line style associated with the current element. If the current element does not have an associated custom line style, the cls_shift_fraction is 0.0.


Example:

!! Change the color of all elements using a ! MicroStation custom line style whose shift! fraction is 0.25 as shown by MicroStation’s ! Line Style dialog.!if (cls_shift_fraction == 0.25) then color = 5endif

color

The color keyword indicates the color index of the current element.

Data Type: integer in the range from 0 to 255

Example:

!! Area fill shapes with a color index of 1.!if ((color == 1) and (type == shape)) then area_fill = trueendif

envr_value

The envr_value keyword is used to compare the value of an IPARM environment variable which is chosen by setting the envr_variable assignment keyword. If the variable has not been set or is not a valid variable, envr_value is set to a zero-length string.

Data Type: string

Example:

!!Get the value of the IPARM environment variable !ARCHITECT. Find text element with characters !equal to "$Architect$" and change the text value!to "Designed by <name>" if ARCHITECT is equal to !"Owner1" or "Owner2." Otherwise, change the text!value to a blank string.!envr_variable = "ARCHITECT"

4-15

if((type ==text)and(characters == "$ARCHITECT$")) then if (envr_value .IN. "Owner1", "Owner2") then characters = "Designed by " + envr_value else characters = "" endifendif

file

The file keyword specifies the file attachment number for the file being processed. Typically, the master file is attachment number 0. Generating a metafile from the command line prints the filename and its attachment number for each reference file.


Example:

!! If the current element is in the master file! (index of 0), change its color to 2.!if (file == 0) then color = 2endif

font

For text and text nodes, the font keyword contains the font number for the current element. For elements other than text and text nodes, the font number is zero.


Example:

!! Do not plot text elements that use font 10.!if ((type == text) and (font == 10)) then ignore_element = trueendif

font_name

For text and text nodes, the font_name contains the font name for the current element. For elements other than text and text nodes, the font name is "NO_FONT_NAME."

Data Type: String

Example:

!! Change the color of all text elements! using the "architectural" font.if ((type == text) and (font_name == ’architectural’)) then color = ’gray’endif

header_type

The header_type keyword determines the outermost complex header type for elements that are components of a complex element. It also determines the type of elements such as multilines and associative dimensions that are logically composed of simpler elements. If the current element is not part of a complex element, the value of the header_type keyword is the same as the element’s type.

Data Type: integers that correspond to valid element types or one of the following constants:

assoc_dim (type 33)

cell (type 2)

complex_shape (type 14)

connected_string (type 12)

4-16

multiline (type 36)

shared_cell (type 35)

solid (type 19)

surface (type 18)

text_node (type 7)

Example 1:

!! If the current element is a component of a cell,! change its weight to 2.!if (header_type == cell) then weight = 2endif

Example 2:

! Change the weight of the! lines in a dimension element,! leaving the text unchanged.if (header_type == assoc_dim) then if (type == line) then weight = 3 endifendif

ip_scale_num

The ip_scale_num keyword gets the IPARM scale as a number.


Example:

!! Plot line thickness based on the IPARM scale.!if (ip_scale_num > 250) then !large drawing use thick lines thickness = (weight +1) * .02else !small drawing use thinner lines thickness = (weight +1) * .01endif

ip_xsize_num

The ip_xsize_num keyword gets the IPARM xsize as a number.


Example:

!! Plot line thickness based on the IPARM xsize.!if (ip_xsize_num > 17) then !large drawing use thick lines thickness = (weight +1) * .02else !small drawing use thinner lines thickness = (weight +1) * .01endif

ip_ysize_num

The ip_ysize_num keyword gets the IPARM ysize as a number.


4-17

Example:

!! Plot line thickness based on the IPARM ysize.!if (ip_ysize_num > 17) then !large drawing use thick lines thickness = (weight +1) * .02else !small drawing use thinner lines thickness = (weight +1) * .01endif

level

The level keyword contains the level number of the current element.

Data Type: integer in the range from 1 - 63

Example:

!! Set the color of the element based on its level.!if (level == 1) then color = 1else if (level == 2) then color = 2endif

lname

If the current element is in a reference file, the lname keyword contains the logical name of the reference file. If the current element is in the master file, the lname keyword evaluates to an empty string (""). Wildcards can be used in string comparisons of equality or inequality.

Data Type: string

Example:

!! Change the weight of all elements in the! reference file with the logical name of! "border" to be a weight of 2. Elements in! the master file and other reference! files will not be changed.!if (lname == ’border’) then weight = 2endif

nested_cellname

If the current element is a cell header or a component of a cell, the nested_cellname keyword specifies the name of the cell. For components nested within one or more cells, the nested_cellname keyword specifies the name of the innermost cell. If the current element is not a cell header or is not a component of a cell, the value for the nested_cellname keyword is "NO_CELL". Wildcards can be used in string comparisons of equality or inequality.

Note To find the name of the outermost cell name, use the cellname keyword.

Data Type: string that contains up to 6 characters

Example:

!! Change the weight of all components of the nested! cell named "FRAME."!if (nested_cellname == ’FRAME’) then weight = 3

4-18

endif

properties

The properties keyword provides two methods for determining if bits in the properties word of the element are set. For example, the following two relational expressions are equivalent:

if(hole == true) then if(properties == hole) then

. .

. .

. .

endif endif

Data Type: one of the following constants:

attributes

hole

locked

modified

new_element

nonplanar

nonsnappable

screen_relative

Example:

!! Do not plot any element with the screen_relative! bit set in the properties word.!if (properties == screen_relative) then ignore_element=trueendif

size

For text elements, the size keyword is the height of the text string. For all other elements, the size is the largest of the X, Y, or Z range of the element.

Data Type: working units

Example:

! ! ! Change the color of text elements whose height is! greater than 4 subunits.!if ((type == text) and (size > 0:4:0)) then color = 3endif

style

The style keyword contains the value of the current element’s line style. If the style has been set earlier in the pen table by the style keyword, then style will evaluate to the new style instead of the original style of the element. Also, if a named style or transitions have been used to set the style of an element, the style comparison keyword will not reflect this. It will evaluate to the current style index.


Example:

! ! ! Change the color of any element not on level 1

4-19

! that has a line style of 7.!if ((level<>1) and (style == 7)) then color = 2endif

tag keywords

The tag keywords check the tag data attached to the current element. If tag data is not attached to the current element, the TAG_CHARACTER keyword evaluates to "NO_TAG_CHARACTER", while TAG_INTEGER and TAG_REAL evaluate to NO_TAG_NUM.

The following are brief descriptions, data types, and examples of the tag keywords.

Tag_display checks to see if a particular type of tag is displayed.

Tag_character tests the actual tag’s value.

Tag_integer tests the actual tag’s value.

Tag_real tests the actual tag’s value.

Note Note The tag_character, tag_integer, and tag_real comparison keywords must be used with the tag_set and tag_name assignment keywords.

Data Types:

tag_character string

tag_display constant (true or false)

tag_integer integer

tag_real real number

Example:

!! Assuming the design file uses two tag sets, ! "Home address" and "Work address," each! containing a character tag named "City," ! change the color of all elements whose tags! specify a home address of "Huntsville" or a ! work address of "Madison."!! Start by looking for "City" tags belonging to ! the "Home address" tag set.! tag_set = ’Home address’tag_name = ’City’if (tag_char == ’Huntsville’) then color = 4endif! Now look for tags in the "Work address" ! tag set. Note that the tag name is still "City".tag_set = ’Work address’if (tag_char == ’Madison’) then color = 4endif

text_node_number

The text_node_number comparison keyword can be used to test against the text node number of a text node complex element.

Data Type: integer

Example 1:

! ! ! Change the color of text associated with a specific! text node number.

4-20

! ! if (text_node_number eq 46) then color = 3endif

Example 2:!!This pen table sets a plot sheet attribute !based on the characters stored in a text node element !in the design file. This sheet attribute can be used !as Digital Print Room attribute date.

if (text_node_number eq 10) then envr_variable = "Author" envr_value = envr_value + " " + characters

else if (text_node_number eq 11) then envr_variable = "Title" envr_value = envr_value + " " + charactersendif

type

The type keyword determines the element type of the current element.

Data Type: integers that correspond to valid element types, or one of the following constants:

arc (type 16) line (type 3)

assoc_dim(type 33) line_string (type 4)

bspline_curve (type 27) multiline(type 36)

bspline_surface(type 24) shape (type 6)

cell (type 2) shared_cell (type 35)

complex_shape (type 14) solid (type 19)

connected_string (type 12) surface (type 18)

curve (type 11) text (type 17)

ellipse (type 15) text_node (type 7)

Example:

! ! ! Change the color of lines, linestrings, and curves! on level 1! ! if ((type in 3,4,11) and (level == 1)) then color = 1endif

Note To test for multiline and associative dimensioning elements, use header_type instead of type.

weight

The weight keyword contains the value of the current element’s line weight.


Example:

! ! ! Set color of element based upon its weight! ! units = inchesif (weight == 0) then color = 1

4-21

else if (weight == 1) then color = 2else if (weight == 2) then color = 3else if (weight == 3) then color = 4else if (weight == 4) then color = 5else if (weight == 5) then color = 6endif

width

The width keyword is valid only for 2D lines, linestrings, ellipses, arcs, and connected strings. All other elements and 3D elements have a width value of 0. The width value is extracted from the element’s Z low range field and specifies the element’s line width in working units as opposed to a weight value.

Data Type: working units

Example:

!! Change the color of lines, linestrings, connected! strings, arcs, and ellipses based on their width.!units = inchesif (type .in. 3,4,12,15,16) then if (width == 0:0:050) then color = 1 else if (width == 0:0:100) then color = 2 else if (width == 0:0:150) then color = (30,50,100) else if (width == 0:0:200) then color = (100,0,0) else if (width > 0:0:300) then color = (0,0,0) endifendif

4-22

IPLOT Assignment Keywords

The following keyword descriptions include a brief description of the keyword function, the types of elements the keyword affects (if applicable), the valid data type(s) (if applicable), and an example of how to use the keyword.

area_fill envr_value screen_relative

boundary_color envr_variable size

boundary_display fill_color style

case_sensitive font tag_name

characters font_name tag_set

class ignore_element thickness

cls_end_width ip_logical_index translucent

cls_name level translucent_fill

cls_origin_width midline_joint units

cls_scale pattern weight

cls_shift_distance pattern_color weight_base

cls_shift_fraction pen weight_delta

color priority

endcap scale

area_fill

For plotters that support polygon fill, the area_fill keyword plots closed elements as filled when set to true. Setting the assignment keywords fill_color or pattern implies setting area_fill to true. The area_fill keyword can be used to plot elements that would otherwise plot filled as outlines. Any closed element (except text) can be controlled with this keyword including closed b-spline curves, complex shapes, ellipses, and shapes.

Syntax:

area_fill = true

area_fill = false

Example:

!! Area fill all shapes.!if (type == shape) then area_fill = trueendif

boundary_color

The boundary_color keyword is used to specify the boundary color of an area or pattern-filled polygon. Boundary_color only affects filled elements with boundary_display set to true.

Syntax:

boundary_color = integer

(where integer is a color index in the range from 0 to 255)

boundary_color = "string"

(where string is a name from a color library)

boundary_color = (R,G,B)

(where RGB is in the range of 0 to 255)

Example:

!! Set boundary_color and boundary_display for! shapes on level 7.!

4-23

if ((type == shape) and (level == 7)) then area_fill = true color = ’blue’ boundary_display = true boundary_color = ’red’endif

boundary_display

For elements that are filled in MicroStation or with the area_fill keyword in the pen table, the boundary_display keyword specifies whether the boundary of a filled polygon is plotted. The boundary_display keyword has no effect on elements that are not filled.

Note Setting boundary_display to true for filled text may produce undesirable results.

Syntax:

boundary_display = true

boundary_display = false

Example:

!! Set boundary_color and boundary_display for! shapes on level 7.!if ((type == shape) and (level == 7)) then area_fill = true color = ’blue’ boundary_display = true boundary_color = ’red’endif

case_sensitive

The case_sensitive keyword determines whether the case of letters is important in string comparisons made using the characters comparison keyword. The default value is false.

Syntax:

case_sensitive = true

case_sensitive = false

Example:!!Replace text, attrib, or mtext entity having!characters "TITLE" with all-caps title, and!replace "Title" with first letter caps title.!case_sensitive = trueif (characters == "TITLE") then characters = "FIRST FLOOR DESIGN"else if (characters == "Title") then characters = "First Floor Design"endif

characters

The characters keyword enables you to replace the string in a text element with a new string. By putting text elements in your design file to act as place holders, you can later substitute these strings with useful information such as the date the file was plotted or the design file name. If the new string is shorter than the original string, it is padded with blanks. If the new string is longer, the original string expands to accommodate the extra characters.

In addition to any arbitrary string, the envr_value keyword or any of the following keywords can be used to substitute a string in the current text element. Most of these keywords represent values from the IPARM file and you can use them to label a plot.

Some keywords require the ip_logical_index keyword to be set before being used.

4-24

Keyword Value

am_pm Time of day: am or pm. (Example: AM)

date Date the metafile was generated. (Example: 05-APR-1996)

day_abbreviation Three-character abbreviation of day. (Example: Fri)

day_name Full name of day. (Example: Friday)

day_number Day in numeric format. (Example: 05)

dgnspec File specification of the master design file. (Example: C:\MYPROJ\E1.DGN)

hour Hour number the metafile was generated. (Example: 11)

hour_12 Hour number based on a 12 hour cycle. (Example: 05)

hour_24 Hour number based on a 24 hour cycle. (Example: 17)

ip_color_table Color table. (Example: C:\IPLOT\MISC\COLOR.CTB)

ip_data_rescale Data rescale value. (Example: 1.00000,3.00000)

ip_data_rescale_x X value of the data rescale. (Example: 1.00000)

ip_data_rescale_y Y value of data rescale. (Example: 3.00000)

ip_design Design filename. (Example: C:\MYPROJ\PLAN.DGN)

ip_display Display flags for the file attachment indicated by the keyword ip_logical_index. (Example: [CONSTRUCTION, DIMENSION, ENTER_DATA])

ip_environment Environment variables stored in the IPARM file. (Example: [PROJECT=civil,REV_NUM=3.45,USER_ID])

ip_fast The fast display attributes for the file specified by the ip_logical_index keyword. (Example: [CELL,FONT,REF_CLIPPING,TEXT])

ip_feature_table The name of the attached feature table. If no feature table is associated with the job, the keyword value is NONE. (Example: C:\PROJ\SECTION.FTB)

ip_fence List of fence points in the IPARM file. If you have not defined a fence, the value of this keyword is NONE. (Example: [[10,10,5],[15,20,6],[20,10,5]])

ip_levels List of levels that are set "on" in the file specified by the ip_logical_index keyword. (Example: [1-5,7,9,54-64])

ip_mirror Mirror settings stored in the IPARM file. Valid values are X, Y, BOTH, or OFF. (Example: BOTH)

ip_nodisplay List of the view display attributes that

4-25

are disabled for the file specified by the ip_logical_index keyword. (Example: [CAMERA,POINTS,WIDTH])

ip_nofast List of fast view display attributes that are disabled for the file specified by the ip_logical_index keyword. (Example: [CELL,FONT,TEXT])

ip_origin X and Y origin in the units specified by the ip_units keyword. (Example: 1.500000,2.000000)

ip_origin_x X origin in the units specified by ip_units. (Example: 1.500000)

ip_origin_y Y origin in the units specified by ip_units. (Example: 5.000000)

ip_pen_table Name of the pen table associated with the plot job. If no pen table is attached, the value for this keyword is NONE. (Example: C:\PROJ\E5.PEN)

ip_plot_rescale X and Y plot rescale values from the IPARM file. (Example: 3.000000,2.000000)

ip_plot_rescale_x X plot rescale value from the IPARM file. (Example: 3.000000)

ip_plot_rescale_y Y plot rescale value from the IPARM file. (Example: 2.000000)

ip_qpr_options List of qpr options stored in the IPARM file. qpr options specified as submit qualifiers but not stored in the IPARM file are not listed. (Example: [-me])

ip_queue Queue name stored in the IPARM file. (Example: hp4mv)

ip_ref_filename Full file specification for the file specified by the ip_logical_index. (Example: C:\PROJ\FLOOR.DGN)

ip_region The region specified in the IPARM file. (Example: [100,100,150,200])

ip_rendering_attributes The name of the rendering attributes file associated with the plot job. If no rendering attributes are specified, the value for this keyword is NONE. (Example: C:\REND\HPSI.RA)

ip_rotation The rotation of the plot specified as an angle in degrees in the range from 0 to 360. (Example: 45.000000)

ip_scale The plot scale specified as a ratio of design units to plotter units. (Example: 4.000000:1.000000)

ip_short_design Master file name without the directory name. (Example: FLOOR27.DGN)

ip_short_color_table Color table name without directory. (Example: COLORS.TBL)

ip_short_pen_table Pen table name without directory. (Example: STANDARD.PEN)

ip_short_feature_table Feature table name without directory. (Example: DECATUR.FTB)

4-26

ip_short_rendering_attributes Rendering attributes filename without directory. (Example: DITHER.RA)

ip_short_ref_filename Filename without directory for the file specified by the ip_logical_index. (Example: FLOOR.DGN)

ip_short_scale The plot scale specified without trailing zeroes. (Example: 1:8)

ip_units Units specified for values such as size and origin. (Example: inches)

ip_view Either the view name or number. (Example: 2)

ip_volume X, Y, and Z coordinates of the plot volume diagonal. (Example: [1000,1000,0,2000,2000,0])

ip_workspace The workspace name or "NONE" if there is no workspace. (Example: siteplan)

ip_xsize X size of the plot in units specified by ip_units. (Example: 34.000000)

ip_xysize X and Y size of the plot in the units specified by ip_units. (Example: 34.000000, 44.000000)

ip_ysize Y size of the plot in the units specified by ip_units. (Example: 75.000000)

long_date Date in long character format. (Example: Friday, April 05, 1996)

long_time Time the metafile was generated in long time format. (Example: 11:59:17 PM)

minute Minute the metafile was generated. (Example: 59)

month_abbreviation Three-character abbreviation of month. (Example: Apr)

month_name Full name of month. (Example: April)

month_number Number of month. (Example: 04)

page_number Sequence number of the plot in the document set while in Organizer. (Example: 1)

plot_name The name of the plot name inside Organizer. (Example: border)

second Second number. (Example: 17)

short_date Date in numeric format. (Example: 04/05/96)

short_time Time in short time format. (Example: 11:59)

short_year Year in two digit format. (Example: 96)

sytime System date and time metafile was generated. (Example: 5-APR-1996 09:47)

time Time of metafile generation. (Example: 09:47)

total_pages Total number of plots in the document set while in Organizer. (Example: 5)

username Username of user who generated the

4-27

metafile. (Example: jdoe)

year Year the metafile was generated in four digit format. (Example: 1996)

Syntax:

characters = "string"

(where string is any valid string or a keyword described in the previous table)

Example 1:

!! Change "preliminary" to "final" for text on! level 10.! if (characters == "preliminary" and type==text and level==10) then characters = "final"endif

Example 2:

if (characters == "PAGE") then

characters = PAGE_NUMBER + "of" + TOTAL_PAGES

endif

Example 3:

!! Replace the string "Project Number" with ! the actual project number stored in! the PROJECT_NUM environment variable.!if (characters == "Project Number") then envr_variable = "PROJECT_NUM" characters = envr_valueendif

Example 4:

! Substitute the queue name from the iparm file for! the text string "$$queue$$."!if ((type == text) and (characters == ’$$queue$$’)) then characters = ip_queueendif!if (characters == ’4th reference filename’) then ip_logical_index = ’ref4’ characters = ip_ref_filenameendif

class

The class keyword changes the class of an element. The element will not plot if the new class has been disabled in the IPARM file or by the equivalent MicroStation display flag.

Syntax:

class = integer

(where integer is in the range from 0 to 6)

class = constant

(where constant is one of the following:

0 construction

1 construction_rule

2 dimension

4-28

3 linear_pattern

4 pattern_component

5 primary

6 primary_rule)

Example:

!! Change construction class elements on level 5! to primary class elements.! ! if ((class == construction) and (level == 5)) then class = primaryendif

cls_end_width

The cls_end_width keyword sets the ending width, in master design file units, of the MicroStation custom line style associated with the current element. When the same value is specified for both cls_origin_width and cls_end_width, the width of the line style’s "dash strokes" narrow or widen uniformly. When different values are specified for these two keywords, the dash strokes taper from the start to the end of the element.

Width is an optional property of each dash stroke in a MicroStation custom line style. This keyword has no effect on line style dash strokes that do not have width as a property.

Syntax:

cls_end_width = real number

Example:

!! Change the width of the wide strokes in ! the "{ Wide Dash }" line style to 2 master! design units.! ! if (cls_name == ’{ Wide Dash }’) then cls_origin_width = 2.0 cls_end_width = 2.0endif

cls_name

The cls_name keyword assigns a MicroStation custom line style to the current element. The line style resource file used on the plot server must contain the line style.

Syntax:

cls_name = string

Example:

!! Assign the "{ Diamond }" custom line ! style to all elements using line code 3.! if (style == 3) then cls_name = ’{ Diamond }’endif

cls_origin_width

The cls_origin_width keyword sets the starting width, in master design file units, of the MicroStation custom line style associated with the current element. When the same value is specified for both cls_origin_width and cls_end_width, the width of the line style’s "dash strokes" narrow or widen uniformly. When different values are specified for these two keywords, the dash strokes taper from the start to the end of the element.

Width is an optional property of each dash stroke in a MicroStation custom line style. This keyword has no

4-29

effect on line style dash strokes that do not have width as a property.

Syntax:

cls_origin_width = real number

Example:

!! Change the width of the wide strokes ! in the "{ Wide Dash }" line style to 2 master! design units.!if (cls_name == ’{ Wide Dash }’) then cls_origin_width = 2.0 cls_end_width = 2.0endif

cls_scale

The cls_scale keyword scales the MicroStation custom line style associated with the current element.

Syntax:

cls_scale = real number

Example:

!! Scale all linestyles by 1/2. ! if (cls_name .ne. ’none’) then cls_scale = 0.5endif

cls_shift_distance

The cls_shift_distance keyword shifts the MicroStation custom line style associated with the current element. The shift distance is specified in master design file units.

Syntax:

cls_shift_distance = real number

Example:

!! Shift the linestyle origin by 1 master! design unit.! if (cls_name == ’{Batten}’) then cls_shift_distance = 1.0endif

cls_shift_fraction

The cls_shift_fraction keyword shifts the MicroStation custom line style associated with the current element.

Syntax:

cls_shift_fraction = real number

Example:

!! Shift the custom linestyle by 1/2 of the ! pattern length.! if (cls_name .ne. ’none’) then cls_shift_fraction = 0.5endif

4-30

color

The color keyword changes the current element’s color for nonfilled elements. Assigning a value to color also changes the boundary color, fill color, and pattern foreground color for closed polygons if these values have not been specifically set with the boundary_color, fill_color, and pattern_color keywords.

Note If a named color or RGB color is used, the color that is used for the color comparison keyword will not be changed. Specifying named colors in a pen table sets the Rendering mode for InterPlot drivers to Full color all. For information on Rendering Attributes, select Help > Attributes in the Graphical Attribute Editor.

Syntax:

color = integer


color = "string"

(where string is a color name from a color library)

color = (R,G,B)


Example:

!! Change color of lines, strings, and curves using! the various methods for defining color.!if (type == line) then color = 1 ! Set the color to be index ! value 1. else if (type == line_string) then color = ’blue’ ! Set the color to be ! library color ’blue.’else if (type == curve) then color = (0,0,255) ! Set the color to be RGB ! value 0,0,255.endif

endcap

The endcap keyword controls the display of end points of nonclosed elements. Endcap has the following display options:

butt—a rectangle with no extension (the default).

extend—also rectangular, but extended one-half the line width past the end of the line or curve.

circle—a semicircle with a radius one-half the line width.

Syntax:

endcap = endcap_type

(where endcap_type is butt, extend, circle)

Example:

!! Specify the endcap type based on the element! type.!if (type == line) then endcap = buttelse if (type == line_string) then endcap = extendelse if (type == arc) then endcap = circleendif

envr_value

4-31

The envr_value assignment keyword sets the current envr_variable to the specified string. This envr_variable = value pair is then written to the accounting file and can also be used as Digital Print Room attribute data.

Syntax:

envr_value=string

Example 1:!!This pen table sets a plot sheet attribute !based on the characters stored in text elements !in the design file. The criteria to determine which !text contains the appropriate characters is !based on MicroSation tags.

tag_set=’dpr’tag_name=’sheet’if ((type eq text) and (tag_character eq ’drawingno’)) then envr_variable = "Drawingno" envr_value = characterselse if ((type eq text) and (tag_character eq ’title’)) then envr_variable = "Title" envr_value = characterselse if ((type eq text) and (tag_character eq ’sheetno’)) then envr_variable = "Sheetno" envr_value = charactersendif

Example 2:!!This pen table sets a plot sheet attribute !based on the characters stored in text elements !in the design file. The criteria to determine which !text contains the appropriate characters is !based on level.

if ((type eq text) and (level eq 2)) then envr_variable = "Account" envr_value = characterselse if ((type eq text) and (level eq 4)) then envr_variable = "Project" envr_value = characterselse if ((type eq text) and (level eq 6)) then envr_variable = "Revision" envr_value = charactersendif

envr_variable

The envr_variable assignment keyword selects the IPARM environment variable you want to use in the pen table. The Comparison keyword envr_value can be used to check the value of the variable.

Syntax:

envr_variable = string

Example:

!!If SKIP_TEXT is defined (as anything, e.g. !"iplot mod MY_IPARM -environment = [SKIP_TEXT=1]") !in the IPARM environment, ignore text and !text_node elements.!envr_variable = "SKIP_TEXT"if (envr_value <> "") then if (type .IN. text, text_node) then

4-32

ignore = true endifendif

fill_color

The fill_color keyword sets the fill color for area filled polygons. It also specifies the background color for patterned elements. Using this keyword automatically enables area_fill. The default fill color for an element is its element color. The pattern background is transparent by default.

Syntax:

fill_color = integer


fill_color = "string"


fill_color = (R,G,B)


Example:

!! Define fill color for shapes, complex shapes,! and ellipses.!if (type == shape) then fill_color = 5else if (type == complex_shape) then fill_color = ’blue’else if (type == ellipse) then fill_color = (0,0,255)endif

font

The font keyword sets the font number for text elements.

Syntax:

font = integer


Example:

!! Change font for certain text strings.!if ((type == text) and (font == 1)) then font = 2else if ((type == text) and (font == 3)) then font = 7endif

font_name

The font_name keyword sets the font name for text elements.

Syntax:

font_name = string

(where string is the font name in the symbology resource file.)

Example:

!! Change font name for certain text strings.!if ((type == text) and (font == 1)) then

4-33

font_name = "Architectural"else if ((type == text) and (font == 3)) then font_name = "FONT060" endif

ignore_element

The ignore_element keyword determines if the element is plotted. If this keyword is set to true, the current element is not plotted.

Syntax:

ignore_element = true

ignore_element = false

Example:

!! Do not plot text elements on level 63.!if ((type == text) and (level == 63)) then ignore_element = trueendif

ip_logical_index

The ip_logical_index keyword must be set before using the keywords ip_display, ip_nodisplay, ip_fast, ip_nofast, ip_levels, or ip_ref_filename to access reference file information. These keywords indicate display attributes and file specification for the reference file specified by the ip_logical_index keyword.

Syntax:

ip_logical_index = "string"

(where string is a logical name for a reference file or the master file)

Example:

!! Set logical index and retrieve appropriate! reference filename.!if ((type == text) and (characters == ’$$$REFFILENAME1$$$’)) then ip_logical_index = "border" characters = ip_ref_filenameendif

level

The level keyword changes the level for the current element. If the new level has been disabled with the NOLEVELS qualifier or is disabled in MicroStation, the element is not plotted.

Syntax:

level = integer


Example:

!! Move all text to level 63.!if (type == text) then level = 63endif

midline_joint

The midline_joint keyword controls the display of joints for both unfilled and filled elements. If the boundary_display is disabled for a filled element, setting the midline_joint keyword has no effect. The following

4-34

list describes the options for this keyword:

miter—the corresponding edges of two segments extend to their point of intersection (the default).

bevel—similar to miter except the segments are finished with butt end caps.

butt—the end of each segment displays with a rectangular joint.

extend—similar to butt except that each segment is extended by one-half its width.

circle—displays a semicircle at the end of each segment.

Syntax:

midline_joint = midline_joint_type

(where midline_joint_type is butt, bevel, extend, circle, or miter)

Example:

!! Set the midline_joint based on the reference ! file attachment number.!if (file == 0) then ! Test for elements in the midline_joint = butt ! master file.else if (file == 1) then ! Test for elements in the midline_joint = extend ! first reference file.else if(file == 2)then ! Test for elements in the midline_joint = circle ! second reference file.else if(file == 3)then ! Test for elements in the midline_joint = miter ! third reference file.endif

pattern

The pattern keyword specifies a name of a pattern from the pattern library for pattern-filling a closed polygon. Setting the pattern keyword also sets the area_fill keyword to true. By default, the pattern will be plotted with the element color as its foreground color and a transparent background. You can use the pattern_color and fill_color keywords to modify these defaults.

Note The pattern keyword is not valid for vector devices.

Syntax:

pattern = "string"

(where string is the name of a pattern from the pattern library)

Example:

!! Area fill ellipses with the pattern ’stars.’ ! The star pattern plots white with the ! background plotting navy blue.if (type == ellipse) then pattern = ’stars’ pattern_color = ’white’ fill_color = ’blue, navy’endif

pattern_color

The pattern_color keyword specifies the foreground color of pattern filled elements. To have any effect, a pattern must be defined. The pattern background color is set with the fill_color keyword. By default, the element’s color is the pattern color and the pattern background is transparent.

Syntax:

pattern_color = integer


pattern_color = "string"


4-35

pattern_color = (R,G,B)


Example:

!! Area fill ellipses with the pattern ’stars’.! The star pattern plots white with the! background plotting navy blue.if (type == ellipse) then pattern = ’stars’ pattern_color = ’white’ fill_color = ’blue, navy’endif

Note The pattern_color keyword is not valid for vector devices.

pen

The pen keyword selects the pen on a pen plotter. Setting this keyword is equivalent to setting the color of the current element, except that the pen number equals the color number plus 1.

Syntax:

pen = integer


Example:

!! Set pen number based on element’s level.if (level == 1 ) then pen = 1else if (level == 2 ) then pen = 2else if (level == 3 ) then pen = 3endif

priority

The priority keyword modifies the order in which elements are plotted. By default, elements are plotted in the order they appear in the design file. Using the priority keyword, low priority elements are plotted before higher priority elements so that higher priority elements are plotted on top of lower priority elements. This can be useful when plotting area-filled elements. For example, if you want a text string to plot inside a filled polygon, the text must have a higher priority than the polygon so that the text is not covered. The default priority for an element is 0.

Notes The priority keyword is not valid for filled elements plotting to a vector device.

The priority keyword overrides the order implied by MicroStation display update sequences.

Syntax:

priority = integer

(where integer is in the range from -1,000,000 to 1,000,000)

Example:

!! Set priority of elements based on their color.!if (type == shape) then area_fill = true if (color == 1) then priority = 10 else if (type == text) then !Plot text on top of the shapes. priority = 20 endif

4-36

endif

scale

The scale keyword specifies a scale factor that is applied to elements that have a local origin, such as cells (normal and shared), arcs, ellipses, text, and text nodes. Text and text nodes are scaled about their justification point. The default scale is 1.0.

Syntax:

scale = real

(where real is any positive real number)

Example:

!! Scale text by a factor of 1.5.!if (type == text) then scale = 1.5endif

screen_relative

The screen_relative keyword is used to modify the screen_relative bit in the current element’s properties word. MicroStation refers to screen relative as "view independent."

Syntax:

screen_relative = true

screen_relative = false

Example:

!! If element is a cell named ’LOGO’, set the screen! relative bit in the properties word.!if ((type == cell) and (cellname == ’LOGO’)) then screen_relative = true endif

size

The size keyword is used to modify the size of text and text node elements.

Syntax:

size = working units

Example:

!! Set text size for text elements on level 1.!if ((type == text) and (level == 1)) then size = 0:0:250endif

style

The style keyword modifies the line style of the current element. Specify a new style by assigning the element an index in the range from 0 to 7, which corresponds to one of the predefined MicroStation style types. A user-defined line style can be used by specifying the name of a line style from a line style library or by specifying a series of on and off transitions. Setting the style has no effect on area-filled or pattern-filled elements if the boundary display is not enabled. By default, the boundary display is disabled.

Note If you use a named style or style definition, the line style used with the style comparison keyword does not change.

Syntax:

4-37

style = integer

(where integer is a line style index in the range of 0 to 7)

style = "string"

(where string is a line style name in a line style library)

style = line style definition

(on, off, on, off...)

Example:

!! Set the element’s style based on its color using ! the various methods for defining a line style.!units = mmswitch (color) case 1 ? style = 3 case 2 ? style = ’dashed’ case 3 ? style = (0.5, 0.3, 0.75, 0.3)endswitch

tags

The TAG_SET and TAG_NAME assignment keywords are used to specify tag set and tag name for later use by one of the comparison keywords.

Data Types:

tag_set string

tag_name string

Example:

!! Assuming the design file uses two tag sets, ! "Home address" and "Work address," each! containing a character tag named "City," ! change the color of all elements whose tags! specify a home address of "Huntsville" or a ! work address of "Madison."!! Start by looking for "City" tags belonging to ! the "Home address" tag set.! tag_set = ’Home address’tag_name = ’City’if (tag_char == ’Huntsville’) then color = 4endif! Now look for tags in the "Work address" ! tag set. Note that the tag name is still "City".tag_set = ’Work address’if (tag_char == ’Madison’) then color = 4endif

thickness

The thickness keyword specifies the line width for elements in physical units that are defined by the user instead of as a line weight. The units value stored in the IPARM file is the default for the thickness keyword, but can be modified within the pen table with the units keyword. Specifying a thickness does not change the weight used by the weight comparison keyword.

4-38

Note You must specify the value for the thickness keyword exactly. There is no implied scaling by 1/1000 for integer values as in previous versions of IPLOT.

Syntax:

thickness = positive real number

Example:

!! Set line thickness based on the element’s color.!units = inchesswitch (color) case 1 - 5 ? thickness = 0.125 case 6 - 10 ? thickness = 0.075 default ? thickness = 0.05endswitch

translucent

If the translucent keyword is set to true, the current element is plotted such that any elements beneath it are not completely hidden. The default value for this keyword is false. The translucent keyword only affects non-filled elements and boundaries of filled elements if the boundaries are on.

Note The translucent keyword is not valid for vector devices or devices driven with Microsoft printer drivers.

Syntax:

translucent = true

translucent = false

Example:

!! Plot elements on level 10 with heavily weighted! red lines and allow elements underneath to ! show through.!if (level == 10) then color = "red" weight = 10 translucent = trueendif

translucent_fill

If set to true, the translucent_fill keyword specifies that the fill color for area-filled and pattern-filled elements is translucent. Both the foreground and background colors for pattern_filled elements are translucent. Elements beneath a translucent_filled element are still visible. The default value for this keyword is false. The translucent_fill keyword is not valid with vector devices or devices driven with Microsoft printer drivers.

Syntax:

translucent_fill = true

translucent_fill = false

Example:

!! Set fill color to be translucent.!area_fill = truetranslucent_fill = truefill_color = (255,0,0)

units

4-39

The units keyword is used to specify the dimension for keywords such as thickness and line styles. Always set the units keyword at the beginning of the pen table and only set it once within a pen table. The default value for the keyword is the units value from the IPARM file.

Syntax:

units = units_constant

(where units_constant is one of the following:

centimeters (cm)

millimeters (mm)

meters

inches

feet (ft))

Example:

!! Set line thickness to 0.5 millimeters.!units = mmthickness = 0.5

weight

The weight keyword modifies the line weight of the current element. For filled elements, boundary_display must be enabled for this keyword to affect the element boundary.

Syntax:

weight = integer


Example:

!! Set line weight based on element’s color.!switch (color) case 1-10 ? weight = 2 case 11-20 ? weight = 1 default ? weight = 0endswitch

weight_base/weight_delta

The weight_base and weight_delta keywords map line weights to physical thicknesses on the plot. Using these keywords, you can get consistent line thicknesses across various plotters. The weight_base keyword specifies the line thickness for an element of weight 0. The weight_delta keyword specifies an additional line thickness increment to add for each line weight above 0. Use the following formula to calculate line thickness using the weight_base and weight_delta keywords:

plot thickness = weight_base + (element weight * weight_delta)

For example, if the weight_base is 0.1 cm and weight_delta is 0.05 cm, the following values are used.

Weight Plot Thickness

0 0.10 cm

1 0.15 cm

2 0.20 cm

. .

. .

. .

4-40

31 1.65 cm

Note You must define the weight_base and weight_delta keywords at the beginning of the pen table.

Syntax:

weight_base = positive_real

weight_delta = positive_real

Example:

!! Map element’s line weight to a thickness on ! the plot.! weight 0 = 0.10 mm! weight 1 = 0.15 mm! weight 2 = 0.20 mm! weight 3 = 0.25 mm! .! .! .! weight 31 = 1.65 mmunits = mmweight_base = 0.1weight_delta = 0.05

4-41


4-42

Introducing Feature Tables

Like a pen table, a feature table changes the appearance of specified elements of a plot. Changing the appearance of elements on a plot is called resymbolization. Some common uses for resymbolization include the following:

Highlighting specific elements by changing their color, width, or line style.

Substituting the current date for a specified text string.

Controlling the order in which elements print.

Obtaining consistent colors on various plotters with the use of color tables and libraries.

Defining custom line styles.

Area-filling closed elements with a specified color or pattern.

Omitting specific elements from the plot.

However, a feature table is not a sequence of instructions for testing and modifying elements. Instead, a feature table contains a series of feature descriptions that contain the following three parts:

Name - Identifies the element group.

Definition - Identifies a group of elements sharing a set of characteristics.

Symbology - Describes how those elements should appear on a plot.

How a Feature Table Works

The feature table is compiled on the client node and included in the metafile for execution on the server node. If an element possesses the characteristics listed in one of the feature definition sections, the modifications listed in the corresponding symbology section are made, and no further processing is performed for that element. Otherwise, the element is not modified. The feature table does not modify the original design file or its reference files.

Invoking the IPLOT Feature Table Editor

The IPLOT Feature Table Editor can be invoked the following ways:

Select "IPLOT Feature Table Editor" from the InterPlot Utilities program group.

Within the InterPlot Organizer interface. The General Property page contains a New/Edit button that corresponds to the pen/feature table field. The New/Edit button invokes the IPLOT Feature Table Editor.

From a Command Prompt. Type in "ipfte feature_table_name" and press Enter.

Feature Table Example

Assume that a design file of a map contains elements representing the base map, bodies of water, roads, and railroads with the following characteristics:

Base map elements are on level 1.

Water elements are on level 2.

Road and railroad elements are on level 3.

Road elements have a weight of 0.

Railroad elements have a weight of 1.

You could use the following feature table to resymbolize the map:

IP_FETBL 1.1

name: base mapdef: level .eq. 1sym: ignore_element = .false.

priority = 1area_fill = .true.fill_color = ’green’

name: body of waterdef: level .eq. 2sym: ignore_element = .false.

priority = 2area_fill = .true.fill_color = ’blue’

4-43

pattern = ’waves’pattern_color = ’blue, light’

name: roaddef: level .eq. 3

weight .eq. 0sym: ignore_element = .false.

priority = 4color = ’black’thickness = 0.1

name: railroaddef: level .eq. 3

weight .eq. 1sym: ignore_element = .false.

priority = 3color = ’red’style = ’dashed’thickness = 0.05

Note Although feature tables are ASCII files and displayed as such in the examples in this document, you should create and modify feature tables with the feature table editor.

The map plotted with this feature table has the following appearance:

The base map is area-filled in green (assuming that closed elements such as shapes or complex shapes represent the base map).

All bodies of water are area-filled in blue with a light blue wave pattern.

All roads would be black and 0.1 inches thick.

All railroads would be red and 0.05 inches thick with a dashed line style.

The base map appears at the bottom of the plot. Bodies of water overlay the base map, and railroads would overlay both the base map and the bodies of water. Roads would be plotted on top of the other plotted data.

Each feature defined in a feature table typically corresponds to some physical component of the object represented by the design file. In the previous example, the body of water feature corresponds to lakes and rivers in the map.

Parent Features and Subfeatures

The physical components of an object are often related. Several components may be specialized versions of a common component, or a component may be comprised of several subcomponents. For example, nuts and bolts are specialized types of fasteners and chairs are comprised of cushions, armrests, and legs. Feature tables enable you to describe such relationships by defining subfeatures. A subfeature is a variation or component of another feature known as the parent feature.

A subfeature must possess all characteristics that define its parent, but it must also have some additional characteristics that differentiate it from its parent. For example, reconsider the previous map example. The design file contained roads and railroads on level 3 with roads having a weight of 0 and railroads having a weight of 1. You can consider roads and railroads to be two specialized versions of transportation mechanisms. Because roads and railroads share a common characteristic (both being on level 3) in the design file, you can define a transportation feature, and road and railroad subfeatures in a feature table as follows:

name: transportationdef: level .eq. 3sym: ...

name: transportation.roaddef: weight .eq. 0sym: ...

name: transportation.railroaddef: weight .eq. 1sym: ...

These feature descriptions define transportation, road and railroad features as follows:

Transportation mechanisms reside on level 3 in the design file.

Roads, special types of transportation mechanisms, reside on level 3 and have a weight of 0.

4-44

Railroads, another type of transportation mechanism, reside on level 3 and have a weight of 1.

When defining a subfeature, you need to list only characteristics that differentiate the subfeature from its parent feature.

Defining a feature’s subfeatures enables you to control the subfeatures either individually or collectively. Using the previous feature table descriptions, you can independently symbolize roads and railroads just as if you had defined them as totally independent features.

However, you can also symbolize roads and railroads together by modifying the transportation feature. If you turn off the transportation feature using the feature table editor, both roads and railroads are also turned off. If you specify that roads and railroads inherit the symbology of their parent feature, roads and railroads are modified the same way.

4-45

Creating a Feature Table

Creating a feature table is essentially a two-step process. First, you must define a new feature using the Definition tab inside the Feature Table Editor. Second, after a new feature is defined, you can use the symbology tabs to determine how the elements will look when they are printed.

Defining a New Feature

1 Select Edit – New Feature from the menu. A feature called "New Feature" is added to the features list.

2 To rename the new feature, click the feature and type in the new name, or select Edit – Rename, and type in the new name.

3 On the Definition tab page, click New Condition.

Use the Comparison keyword list to distinguish the new feature from other features in the design file.

When using a list operator (in, not in) in a condition, you must type in the values as a comma-separated list. For example, to change the color of every element on level 15, 23, and 45, type in 15, 23, 45.

For descriptions of all the comparison keywords, refer to the Modifying a Feature’s Definition section.

4 If the new feature is a subfeature, use the list button on the Parent field to display a list of existing features. From the list, select the parent feature for the new feature.

5 Select a valid Relational Operator for the selected comparison keyword.

6 Select or type in the value for the comparison keyword in the Value edit box.

Modifying a Feature’s Definition

1 Select a feature from the features list.

2 Click the Definition tab.

The keywords listed below the Comparison Keyword heading identify the elements in the design and reference files that represent the feature.

3 To add a new condition, click the New Condition button.

4 To remove an existing condition, select the comparison keyword, and then click Remove.

Use the following list of comparison keywords to distinguish a feature from other features in the feature table.

Angle

Specifies an element’s angle. Only cells, text, ellipses, arcs, and text nodes have an associated angle. Real numbers in the range of 0 to 360 are valid.

Area fill

The area fill keyword checks to see if the current element is filled. You can select the value through the scrolling list.

Cell name

Identifies an element’s cell name. If an element is not a cell header and is in a nested cell, its cell name is the name of the outermost cell. Valid values are strings. Wildcards can be used in string comparisons of equality or inequality.

Characters

The characters keyword specifies the string contained in the element if the current element is a text element. Valid values are strings. Wildcards can be used in string comparisons of equality or inequality.

Class

The class keyword specifies the class type of the current element. You can select the value through the scrolling list.

CLS name

Specifies the name of the MicroStation custom line style associated with the current element. Valid values are strings.

Color

The color keyword indicates the color index of the current element. Valid values are integers between 0 and 255.

4-46

Font

For text and text nodes, the font keyword contains the font number for the current element. Valid values are integers between 0 and 255.

Header type

The Header type keyword determines the outermost complex header type for elements that are components of a complex element. You can select the value through the scrolling list.

Level

The level keyword contains the level number of the current element. Valid values are integers between 1 and 63.

Nested cell name

Specifies the name of the innermost cell. Valid values are strings.

Properties

Identifies miscellaneous properties of an element. You can select the value through the scrolling list.

Ref attach no.

Specifies the file attachment number for the file being processed. Typically, the master file is attachment number 0. Valid values are integers between 0 and 255.

Ref log name

Identifies the logical name of the reference file. Valid values are strings. Wildcards can be used in string comparisons of equality or inequality. An "*" matches zero or more occurrences of any character, and a "?" matches exactly one occurrence of any character. The "\" indicates that the next character is to be treated as an actual character and not as a special character. In other words, it disables the special meaning of the asterisk (*) and question mark (?) characters.

Size

For text elements, the size keyword is the height of the text string. For all other elements, the size is the largest of the X, Y, or Z range of the element. Type in the size in working units format, mu:su:pu (master units, subunits, positional units).

Style

The style keyword contains the value of the current element’s line style. You can select the value through the scrolling list.

Tag keywords

The tag keywords check the tag data attached to the current element. Type in a string value for Tag character, an integer value for Tag integer, and a real number for Tag real. For Tag display, you can select the value through the scrolling list.

Text node number

Identifies the text node number of a text node complex element. Valid values are 0 and positive integers.

Type

The type keyword determines the element type of the current element. You can select the value through the scrolling list.

Weight

Identifies an element’s line weight. Valid values are integers between 0 and 31.

Width

Identifies an element’s width. Only 2D lines, linestrings, ellipses, arcs, and connected strings have an associated width. Type in the size in working units format, mu:su:pu (master units, subunits, positional units).

Assigning Line Symbology

The items on the Line symbology page modify the active feature’s symbology. Feature symbology defines how elements look when they are printed.

4-47

The parameters you can set on the Line symbology page include:

Color

Assigns a new color to the current entity. It also specifies the background color for patterned entities. Using this keyword automatically enables area fill. The default fill color for an entity is its entity color. The pattern background is transparent by default.

You can type in a color name, a color index integer between 0 and 255, or RGB values in the format (R,G,B) where R, G, and B are integers between 0 and 255.

Custom line style

Assigns a MicroStation custom line style to the current element. The line style resource file used on the plot server must contain the line style. Valid values are strings.

Custom line style scale

Scales the MicroStation custom line style associated with the current element. Real numbers are valid values.

Endcap

Controls the display of end points of nonclosed elements. Endcap has the following display options:

butt—a rectangle with no extension (the default).

extend—also rectangular, but extended one-half the line width past the end of the line or curve.

circle—a semicircle with a radius one-half the line width.

Midline joint

Controls the display of joints for both unfilled and filled elements. If the boundary display is disabled for a filled element, setting the midline joint keyword has no effect. The following list describes the options for this keyword:

bevel—similar to miter except the segments are finished with butt end caps.

butt—the end of each segment displays with a rectangular joint.

extend—similar to butt except that each segment is extended by one-half its width.

circle—displays a semicircle at the end of each segment.

miter—the corresponding edges of two segments extend to their point of intersection (the default).

Style

Specifies the line style for the feature. Specify a new style by assigning the element an index in the range from 0 to 7, which corresponds to one of the predefined MicroStation style types. A user-defined line style can be used by specifying the name of a line style from a line style library or by specifying a series of on and off transitions (on, off, on, off, …).

Thickness

The thickness keyword specifies the line width for elements in physical units that are defined by the user instead of as a line weight. The units value stored in the IPARM file is the default for the thickness keyword, but can be modified within the feature table with the units keyword. Valid values are positive real numbers.

Translucency

Sets the opaque or translucent attribute for the linear element. If the translucent radio button is set, the current element is plotted such that any elements beneath it are not completely hidden. The translucent keyword only affects non-filled elements and boundaries of filled elements if the boundaries are on.

Weight

Assigns a valid weight to the specified elements. When the line width is set to Weight, type in an integer between 0 and 31.

Assigning Fill Symbology

The items on the Fill symbology page modify the active feature's symbology. Feature symbology defines how elements look when they are printed.

The parameters you can set on the Fill symbology page include:

4-48

Area fill

Plots closed elements as filled when set to true. Setting the assignment keywords Solid fill color or Pattern implies setting Area fill to true. The Area fill keyword can be used to plot elements that would otherwise plot filled as outlines. Any closed element can be controlled with this keyword including closed b-spline curves, complex shapes, ellipses, and shapes.

Boundary color

Specifies the boundary color of an area or pattern-filled polygon. Boundary color only affects filled elements with Boundary display set to true. You can type in a color name, a color index integer between 0 and 255, or RGB values in the format (R,G,B) where R, G, and B are integers between 0 and 255.

Boundary display

Specifies whether the boundary of a filled polygon is plotted. The Boundary display keyword has no effect on elements that are not filled. Setting Boundary display to true for filled text may produce undesirable results. You can select the value through the scrolling list.

Pattern

Specifies a name of a pattern from the pattern library for pattern-filling a closed polygon. Setting the Pattern keyword also sets the Area fill keyword to True. By default, the pattern will be plotted with the element color as its foreground color and a transparent background. Valid values are strings.

Pattern background color

Specifies the background color of pattern filled elements. The pattern background color is also set with the Solid fill color field. By default, the element’s color is the pattern color and the pattern background is transparent. You can type in a color name, a color index integer between 0 and 255, or RGB values in the format (R,G,B) where R, G, and B are integers between 0 and 255.

Pattern foreground color

Specifies the foreground color of pattern filled elements. The pattern background color is set with the Solid fill color keyword. By default, the element’s color is the pattern color and the pattern background is transparent. You can type in a color name, a color index integer between 0 and 255, or RGB values in the format (R,G,B) where R, G, and B are integers between 0 and 255.

Solid fill color

The Solid fill color keyword sets the fill color for area filled polygons. It also specifies the background color for patterned elements. Using this keyword automatically enables Area fill. The default fill color for an element is its element color. The pattern background is transparent by default. You can type in a color name, a color index integer between 0 and 255, or RGB values in the format (R,G,B) where R, G, and B are integers between 0 and 255.

Translucency

Specifies that the Solid fill color for area-filled and pattern-filled elements is translucent. Both the foreground and background colors for pattern-filled elements are translucent. Elements beneath a translucent element are still visible.

Assigning Environment Variables

The Environment page enables you to use environment variables in feature tables to perform text substitution and to extract data from the design file.

InterPlot clients can define environment variables that can be transferred to the plot server during plot submission. These environment variable definitions are sent to the plot server along with any definitions stored in the IPARM file. The values from these environment variables can be used to replace the string in a text element with a new string.

Although you can use the "Set characters to" field to replace a text entity with a new string, you should use the Edit – Character Substitutions command to replace multiple text strings. The Character Substitutions command does not require a separate feature to replace each text string.

You can also use environment variables in a feature table to extract data from a design file. This information is then written to the accounting file and can also be used as Digital Print Room attribute data.

The parameters you can set on the Environment symbology page for text substitution include:

4-49

Environment variable

Specifies the environment variable for the current feature. If you want to replace a text string with the value of this environment variable, type envr_value in the "Set characters to" field.

Set characters to

Replaces the string in a text element with a new string. By putting text elements in your design file to act as place holders, you can later substitute these strings with useful information such as the date the file was plotted or the design file name.

Type in envr_value to set characters to the value of the environment variable specified in the "Environment variable" field.

Variable

Specifies the environment variable you want to create. The text data that is extracted from the design file is associated with this variable. This information is then written to the accounting file and can also be used as Digital Print Room attribute data.

Value

Specifies the environment variable value. Select "characters" to set the environment variable value to the specified text string. Select "envr_value + " " + characters" to allow for string concatenation. Use the string concatenation value when extracting data from multi-line text elements, such as text nodes.

Assigning Other Symbology

The items on the Other symbology page modify the active feature’s symbology. Feature symbology defines how elements look when they are printed.

The parameters you can set on the Other symbology page include:

Font index

Sets the font number for text elements. Valid values are integers between 0 and 255.

Font name

Sets the font name for text elements. Valid values are strings.

Inherit from parent

The Inherit from parent checkbox enables the subfeature to inherit attributes from the parent feature.

Priority

Controls the order in which elements are plotted. By default, elements are plotted in the order they appear in the design file. Using the priority keyword, low priority elements are plotted before higher priority elements so that higher priority elements are plotted on top of lower priority elements. The default priority for an element is 0. Valid values are integers between –1,000,000 and 1,000,000.

Scale

Specifies a scale factor that is applied to elements that have a local origin, such as cells (normal and shared), arcs, ellipses, text, and text nodes. Text and text nodes are scaled about their justification point. The default scale is 1.0. Valid values are positive real numbers.

Size

Changes the size of text and text node elements. Type in the size in working units format, mu:su:pu (master units, subunits, positional units).

View independent

The View independent checkbox controls the rotation of view-independent elements, such as text.

Global Symbology

The Edit – Global Symbology command enables you to set the Weight base, Weight delta, and Units for the feature table.

Units

The Units keyword is used to specify the dimension for keywords such as thickness and line styles. The default

4-50

value for the keyword is the units value from the IPARM file.

Weight base/Weight delta

Weight base and Weight delta keywords map line weight to a physical thickness on the plot. Using these keywords, you can get consistent line thickness across various printers. The Weight base keyword specifies the line thickness for a element of weight 0. The Weight delta keyword specifies an additional line thickness increment to add for each line weight above 0.

For example, if the Weight base is 0.1 cm and Weight delta is 0.05, the following values are used.

Weight Plot Thickness

0 0.10 cm

1 0.15 cm

2 0.20 cm

. .

. .

31 1.65 cm

Priorities

The Edit – Priorities command enables you to set the priority for a feature. By default, elements are plotted in the order they appear in the design file. Priority determines the order in which the selected feature is plotted. Low priority features are plotted before higher priority features, so that higher priority features are plotted on top. Valid priority values range from –1,000,000 to 1,000,000.

If you click the Priority column heading, the feature list will be sorted (alternating between ascending and descending order). If you click the Feature Hierarchy column heading once, the feature list will revert back to it’s original state, a second click inverts the feature list.

4-51

Special Features

The Default Feature

The Default feature enables you to change the symbology of all elements not defined in the other features. The Default feature will always display in the tree, but will not be written to the file if it is empty. The Default feature cannot be deleted, moved, or renamed.

Value Mapping

Value Mapping enables you to map a comparison keyword to a specific assignment keyword. For example, since weight zero lines print as single pixel lines and the thickness varies depending upon the printer resolution, you may want to map line weights to a specific line thickness. Mapping weight to thickness ensures consistent line thickness across a wide range of printer resolutions.

Example:

Weight Thickness

0 .08

1 .16

2 .24

3 .32

4 .40

5 .48

Use the Edit – New Value Mapping command to create a Value Mapping feature. Value Mapping features are added to the top of the feature list. Once a Value Mapping feature is added, you can use the Edit – Modify Value Mapping command to make changes.

Character Substitutions

The Character substitutions command enables you to replace the string in a text element with a new string. By putting text elements in your design file to act as place holders, you can later substitute these strings with useful information such as the date the file was plotted or the design file name.

Use the Edit – Character Substitutions command to add a Character Substitutions feature. A Character Substitutions feature will be added to the top of the feature list. Once a Character Substitutions feature is added, you can double-click it to make changes.

4-52

Other Feature Table Command

Delete Command

The Edit - Delete Feature command enables you to delete the selected feature. If the selected feature contains subfeatures, they will be deleted along with the parent feature.

The Delete feature command can be accessed from the Edit menu, or from the context menu. To access the context menu, right-click on any feature.

Expand and Collapse Commands

The View – Expand and View – Collapse commands enable you to turn on or off the display of subfeatures. Alternately, to view subfeatures, click the PLUS SIGN (+), to hide subfeatures, click the MINUS SIGN (-).

The Expand and Collapse commands can be accessed from the View menu.

Duplicate Command

The Edit - Duplicate command enables you to create a copy of the selected feature. The new feature will be created with a unique name. The new feature name is formed by appending a number to the feature’s original name. If a parent feature contains subfeatures, the subfeatures will also be copied, but will retain their original name.

The new feature’s definition and symbology pages contain the same attributes as the original feature. You should use the Duplicate command to create a similar feature, then make the necessary modifications to the new feature to distinguish it from the other features in the drawing file.

The Duplicate command can be accessed from the Edit menu, or from the context menu. To access the context menu, right-click on any feature.

Move Commands

The Move commands enable you to move a feature up/down in the feature list. You can only reorder normal features. Special features such as Character Substitutions, Value Mapping, and the Default feature cannot be moved.

The Move commands are the arrows located below the features list.

New and Open Commands

The File - New command empties the feature table editor of all features, except the Default feature. This feature enables you to create a new feature table without having to exit the feature table editor.

The File - Open command opens a valid feature table file. The search path variable, IPLOT_FEATURE_TABLE_PATH, controls the starting point for file selection dialog boxes. Use the InterPlot Client Configure utility to set search path variables.

New Feature Command

The Edit - New Feature command creates a new feature that displays in the feature list. The new feature will be placed immediately after the selected feature. If no feature is selected, the new feature is listed last in the list (but above the Default Feature). The new feature will be named "New Feature." To rename the new feature, select the Edit – Rename command, or click the selected feature and type in the new name.

Note A new feature requires at least one condition for the feature definition. Use the New Condition button to add a new condition. You cannot select any other commands until you add the new condition.

Rename Command

The Rename command enables you to change the name of a feature. To rename the new feature, select the Edit – Rename command, or click the selected feature and type in the new name.

Save and Save As Commands

The File - Save command saves the feature table being edited using the filename obtained in the last File - Open execution. If this filename doesn’t exist or is invalid, the command File - Save As will be executed instead.

The Save As command obtains the filename where the current file is to be saved. The Save As command enables you to save the data to a feature table or to a pen table.

Note The search path variable, IPLOT_FEATURE_TABLE_PATH, controls the starting point for file selection

4-53

dialog boxes. Use the InterPlot Client Configure utility to set search path variables.

Toggle Plotting Command

The Edit - Toggle Plotting command enables you to plot or not plot a given feature. Each normal feature in the feature list has a checkbox; a check in this box specifies that the feature will plot.

4-54

Feature Table Lessons

Lesson 1: Creating a Feature Table

In this lesson, you will create a feature table (LEARNDGN.FTB) to change the plot in the following ways:

Highlight all text, the sheet border (level 1), and the furniture (level 15) by plotting it in black and the rest of the building in gray.

Replace the text in the title block with the printer name, the actual file specification of LEARN.DGN, and the date you submitted the plot.

Starting the IPLOT Feature Table Editor

From the desktop, select Start -> Programs -> InterPlot Utilities -> IPLOT Feature Table Editor .

Creating the furniture feature

1 Select Edit – New Feature to create a new feature.

A new feature named "New Feature" is created and added to the Features list.

2 Select Edit – Rename, and then type in "furniture" for the feature name.

3 On the Definition page, click New Condition.

4 From the Comparison Keyword list, select Level.

5 Type 15 in the Value field and press Enter.

Creating the border feature



2 Select Edit – Rename, and then type in "border" for the feature name.


4 From the Comparison Keyword list, select Level.

5 Type 1 in the Value field and press Enter.

Creating the text feature



2 Select Edit – Rename, and then type in "text" for the feature name.


4 From the Comparison Keyword list, select Type.

5 In the Value field select Text (type 17).

Changing feature symbology for furniture

1 From the Features list, select furniture.

2 Select the Line symbology tab, and then type (0,0,0) in the Color field.

A color of (0,0,0) will plot the furniture pure black.

3 Select the Other symbology tab, and then type 100 in the Priority field.

This will give the furniture a high priority so it will plot on top of the other features.

Changing feature symbology for border

1 From the Features list, select border.


A color of (0,0,0) will plot the border pure black.


This will give the border a high priority so it will plot on top of the other features.

Changing feature symbology for text

1 From the Features list, select text.


A color of (0,0,0) will plot the text pure black.

4-55


This will give the text a high priority so it will plot on top of the other features.

Changing feature symbology for the Default Feature

1 From the Features list, select Default Feature.

The Default Feature enables you to change the symbology of all elements not defined in the other features.


A color of (200,200,200) will plot elements gray.

3 In the Line width frame, type in 4 for the Weight.


This will give the Default Feature a low priority so it will plot below the other features.

Creating the Character Substitutions feature

1 Select Edit – Character Substitutions to create a special feature.

2 In the Search String field, type in "substitute the filename here." Be sure to enclose the string in quotes.

3 In the Replace String field, select dgnspec, and then click Set.

4 In the Search String field, type in "substitute the printer name here." Be sure to enclose the string in quotes.

5 In the Replace String field, select ip_queue, and then click Set.

6 In the Search String field, type in "substitute the date here." Be sure to enclose the string in quotes.

7 In the Replace String field, select date, and then click Set.

8 Click OK to dismiss the Character Substitutions dialog.

Saving the Feature Table

1 From the File menu, select Save As.

Save the feature table to your favorite folder and name it LEARNDGN.FTB.

2 Select File Exit, to exit the IPLOT Feature Table Editor.

Lesson 2: Changing the Appearance of a Plot

In this lesson, you will learn how to attach the feature table to the design file, and preview and print the plot using InterPlot Organizer.

Starting InterPlot Organizer

1 From the desktop, select Start -> Programs -> InterPlot Utilities -> InterPlot Organizer .

If Organizer cannot find a printer that is capable of printing the job, an error message displays. For InterPlot Client, you must create at least one printer to a machine that has InterPlot Server installed. For InterPlot Professional, configure at least one printer or connect to a printer on an InterPlot Server node.

2 When the Welcome to InterPlot Organizer dialog box displays, click OK.

Creating Plots

1 From the Create Plots dialog box, click Add.

2 Navigate to the C:\Program Files\InterPlot Client\learn or C:\Program Files\InterPlot Professional\learn folder.

3 Select the file LEARN.DGN, and then click Open.

4 To dismiss the Create Plots dialog box and add the selected file to the current plot set, click OK.

Organizer loads the plot into the main window.

Selecting the Feature Table

1 From Organizer’s main window, double-click learn.

2 From the Learn Properties dialog box, click the General tab.

3 From the General property page, click the Feature table radio button.

4 To locate the feature table named LEARNDGN.FTB, click the Browse button next to the File name edit box. Navigate to the folder you saved the feature table (LEARNDGN.FTB) into.

5 Select LEARNDGN.FTB and click Open.

Maximizing the Plot Size

4-56

1 From the Learn Properties dialog box, click the Area tab.

2 Click Fit to Element Range, and then click OK to dismiss the Fit to Element Range dialog box.

3 From the Learn Properties dialog box, click the Layout tab.

4 To maximize the plot, click Maximize.

5 To dismiss the Learn Properties dialog box, click OK.

Previewing the Plot

1 To preview the plot, select File -> Print Preview.

Notice that the furniture, border, and text is pure black, and the remaining elements are gray. Right-click inside the preview window to access the context menu. Use the Zoom In command to see the text in the title block. Notice that the text strings display the current design file, the current printer, and the current date.

2 In the Preview window, use the button to close the Preview window.

Printing the Plot

1 Select File -> Print.

2 From the Print dialog box, select the printer, and then click OK.

4-57


4-58

C H A P T E R 5 Managing Resource Files

What are Resource Files?

When plotting CAD drawings, InterPlot may access font, line, pattern, and color definitions. These graphical resources are not stored in files sent through the printing system. Rather, InterPlot reads them from local resource files during preview or local printing (InterPlot Professional only). Resource files are accessed on the plot server when offloading plot processing to InterPlot Server or a Digital Print Room product.

There are two categories of resource files associated with IPLOT:

General resource files

color libraries

MicroStation/IPLOT resource files

MicroStation symbology resource files (FONT.RSC, LSTYLE.RSC)

IPLOT pattern libraries

IPLOT line style libraries

5-1

Color Libraries

You can use color libraries to change element color. Color libraries are a collection of color descriptions associated with a printer on the plot server. Each description includes a name and an RGB definition.

For example:

IP_CLRLB

type=RGB

aquamarine = 0.733333, 0.866667, 0.666670

aquamarine, medium = 0.666667, 0.933333, 0.866667

black = 0.000000, 0.000000, 0.000000

blue = 0.000000, 0.000000, 1.000000

The first line, IP_CLRLB, indicates it is a color library. The second line indicates that the colors in the library are defined by red, green, and blue intensities. Each remaining line defines a single color description consisting of a name and an RGB definition.

The syntax for the color definition section is:

color_name = red_value, green_value, blue_value

A color name is a string of characters (31 or fewer) that may contain blanks. The first character in a color name must be alphabetic but can be followed by any displayable ASCII characters except single or double quotation marks.

The numbers following the equal sign (=) are red, green, and blue intensities that define the color. Each intensity value is a real number between 0.0 and 1.0, where 0.0 is the lowest intensity, and 1.0 is full or highest intensity. A color value denotes the intensity of the component in the color model specified in the header.

To use these named colors, you must create a pen table that assigns the color names to the appropriate elements. For example, the following IPLOT pen table assigns colors to elements on levels 1 through 5:

if (level .eq. 1) then color = ’aquamarine’ else if (level .eq. 2) then color = ’black’else if (level .eq. 3) then color = ’blue’else if (level .eq. 4) then color = ’blue, cadet’else if (level .eq. 5) then color = ’blue, cornflower’endif

Matching Colors

The colors on a plot rarely match the colors on the workstation screen. Likewise, the colors produced by one plotter rarely match those produced by another. The usual solution to this problem involves using several MicroStation color tables, one for screen display and one for each type of color plotter. Before a plot is submitted to a particular plotter, the metafile should be regenerated to ensure that it contains that plotter’s color table.

IPLOT uses color libraries, pen tables, and feature tables to simplify the task of obtaining consistent colors across different plotters. Each InterPlot device driver includes a color library tailored to its specific plotter. All drivers’ color libraries contain the same color names, but the colors are defined differently for each driver to compensate for how the different plotters produce the same color.

You must use a pen table or feature table to use the colors defined in color libraries. Instead of assigning a color index to an element, you assign a color name to an element. When the element is plotted, that color name’s RGB definition is extracted from the appropriate driver’s color library and used for the plot. A metafile produced using color names instead of color indices does not need to be regenerated before it is plotted on a different device. Each time the metafile is plotted to a different device, the correct RGB intensities for that device are used automatically.

Customizing a Color Library

5-2

The color libraries delivered with each device driver contain 67 standard colors. You may want to add, modify, or delete colors from these libraries. Use the clib utility to edit color libraries.

When you add or delete colors from one plotter’s color library, you should also add or delete those colors from all other plotters’ color libraries. Otherwise, a metafile with colors that look fine on one plotter may not plot correctly on another; if an element is assigned a color with a name not defined in the current plotter’s color library, the element is plotted in black.

The Clib Utility

You can edit color libraries with the clib utility. The clib utility invokes Notepad to enable you to edit the color library associated with the printer.

C:\win32app\ingr\ipshare\ipserver\bin\clib printer_name

5-3

Using IPLOT Resource Files

InterPlot reads two types of configuration files: MicroStation workspace user configuration files (*.UCF), and a server configuration file (IPLOTSRV.CFG). Font resources are accessed through UCF files. Pattern and line style resources can be accessed through either IPLOTSRV.CFG or UCF files.

MicroStation Font Resources

InterPlot references MicroStation workspaces to access MicroStation font resource files. If different users in your organization require different resources, you must create a MicroStation workspace for each project or discipline to reference the appropriate font resource files.

IPLOT Pattern and Line Style Resources

InterPlot includes a set of standard IPLOT pattern and line style resource files used when plotting MicroStation data and a configuration file (IPLOTSRV.CFG) that designates them as defaults.

If your entire organization uses the same pattern and/or line style resources, you can edit InterPlot’s configuration file to designate your pattern and line style resource files as defaults. If different users work on different projects or in different disciplines that require custom resources, you must create a MicroStation workspace for each project or discipline and add the pattern and line style IPLOTSRV.CFG variables to the user configuration file (*.UCF).

Default IPLOT Resource Files

InterPlot delivers the following IPLOT resource files in the RESRC\SYSTEM directory of the IPLOT component of InterPlot. By default, this directory is C:\Program Files\Common Files\InterPlot\IPLOT.

PAT100.PLB, PAT300.PLB, PAT400.PLB, PAT600.PLB — IPLOT pattern libraries that contain patterns you can assign to filled elements with pen tables or feature tables.

An IPLOT line style library that contains line styles you can assign to elements with pen tables or feature tables.

You do not need to take any action to use these resource files. InterPlot uses them automatically.

5-4

IPLOT Pattern Libraries

IPLOT pattern libraries are collections of area fill patterns. Each pattern has a name, size, rotation, and graphical definition. The graphical definition is a 1-bit raster image. To create a pattern, you draw the pattern with a raster editor like Paint Shop Pro™, create a 1-bit raster image, and store the raster image in a pattern library using the plib utility.

Separate patterns need to be drawn for each unique plotter resolution. For example, for a 300 dpi plotter, you should make the raster file pattern size 300x300 pixels, then use the plib utility to add it to the pattern library. If the foreground/background colors do not plot correctly, invert the colors using your raster editor and save the file again, then add it to the pattern library. For more information about pattern libraries, read the server configuration file (IPLOTSRV.CFG) in the InterPlot Client Configure utility.

Note The IPLOT pattern library is not valid with vector devices.

You must use a pen table or feature table to plot elements with the patterns stored in pattern libraries. When you assign a pattern to an element, you can also define its foreground and background colors. For example, the following pen table fills all shaped elements on Level 1 with a blue and yellow hatch pattern.

if ((level == 1) && (type == shape)) then area_fill = true pattern = ’hatch’ fill_color = ’blue’ # define pattern # background color pattern_color = ’yellow’ # define pattern # foreground colorendif

MicroStation area patterns are defined in working units, so the patterns plot at varying sizes depending on the plot scale. In contrast, IPLOT patterns always plot at the same size because their sizes are defined in actual units.

PLIB Utility

The plib utility is delivered with IPLOT component of InterPlot. It has a command line interface that enables you to add, copy, modify, and delete patterns from a pattern library.

Syntax:

plib command -qualifier=value pattern_library

You can use plib in an interactive mode by typing plib pattern_library at the system prompt. At the plib prompt, key in the command and qualifier(s).

The following table includes the commands used with the plib utility. You do not need to key in the entire command. The mandatory letters are underscored.

Command Description

create Creates a pattern library.

delete Deletes a pattern.

modify Modifies a pattern qualifier.

show Shows pattern library global information, such as number of patterns in the pattern library, or individual pattern entries.

add Adds a pattern.

copy Copies a pattern.

extract Extracts a pattern from a pattern library, and places it in a raster file.

quit Quits the interactive mode.

The following list describes the qualifiers available with the plib utility:

Qualifier Description

-entry Specifies a pattern name. If you use the -name qualifier to change the name of a pattern, you must use the new pattern name with the -entry qualifier in subsequent commands.

Syntax: plib command -entry=pattern_name pattern_library

5-5

-name Specifies the new name when the name of a pattern is being modified. Must be a string of less than 32 characters.

Syntax: plib command -entry=pattern_name -name=new_name pattern_library

-size Specifies the size of the pattern. The size is measured along the length of the pattern and must be less than four inches. (The default units are centimeters.)

Syntax: plib command -entry=pattern_name -size=nnnn pattern_lib

-rotation Specifies the pattern rotation in degrees where nnn is between 0 and 360.-

Syntax: plib command -entry=pattern_name -rotation=nnn pattern_lib

-origin Specifies the pattern origin in the current units of measure.

Syntax: plib command -entry=pattern_name -origin=[n,n] pattern_library

-description Describes the pattern. Use a string of fewer than 256 characters.

Syntax: plib command -entry=pattern_name -description="description" pattern_lib

-filename Specifies a raster filename. Use this qualifier when adding a pattern to the library and when extracting a pattern from the library.

Syntax: plib command -entry=pattern_name -filename=tile.tif pattern_lib

-units Specifies the units of measure. Use any of the following values: millimeters (or mm), centimeters (or cm), inches (or in), meters (or m). The default is centimeters.

Syntax: plib command -entry=pattern_name -size=nnnn -units=in pattern_lib

Note Strings must begin with an alphanumeric character and cannot contain spaces, tabs, new lines, or double quotation marks. However, if the string is surrounded by double quotation marks, the string can begin with and contain any character except new lines and double quotation marks.

The following list shows the available qualifiers for each command.

Command Qualifier Optional/Required

create

delete entry required

modify entry required

name optional

size optional

rotation optional

origin optional

description optional

filename optional

units optional

origin optional

show entry optional

units optional

add entry required

name optional

5-6

size optional

rotation optional

origin optional

description optional

filename optional

units optional

origin optional

copy entry required

name required

extract entry required

filename required

Note Qualifiers not listed with commands are ignored.

5-7

IPLOT Line Style Libraries

An IPLOT line style library is an ASCII text file that contains a collection of line style definitions. Each definition includes a name and a series of dash/gap transitions. IPLOT includes the following default line style library:

IP_STYLBUNITS = INsolid = (1.0)dotted = (0.030, 0.03)medium dashed = (0.062, 0.062)long dashed = (0.125, 0.062)dash-dot = (0.125, 0.062, 0.03, 0.062)short dashed = (0.045, 0.045)dash-dot-dot = (0.125, 0.062, 0.03, 0.062, 0.03, 0.062)long dashed-short dashed = (0.0125, 0.045, 0.062, 0.045)

IP_STYLB identifies the file as an IPLOT line style library. The first line of every line style library must contain this identifier.

The second line indicates that the dash/gap transitions in the file are defined in inches. Other valid units include millimeters (mm), centimeters (cm), and meters (m).

Each remaining line defines a line style. The numbers in parentheses define the lengths of the dashes and gaps that represent the style. For example, a line drawn with the long dashed line style would start with a 0.125 inch dash followed by a 0.062 inch gap, and the dash/gap pattern would repeat through the end of the line.

You must use a pen table or feature table to plot design file elements with the styles defined in line style libraries. For example, the following pen table example plots all elements on Level 1 with the dash-dot line style.

if (level == 1) then style = ’dash-dot’endif

MicroStation’s custom line styles are much more flexible and powerful than IPLOT line styles. However, the dashes and gaps in MicroStation’s line styles are defined in working units and will plot at varying lengths depending on the plot scale. In contrast, IPLOT line styles plot the same regardless of the plot scale because they are defined in actual units.

5-8

C H A P T E R 6 InterPlot Client Configuration

Uninstalling the Product

You can use the Uninstall option to remove some or all of the components of this product from your computer.

Note You must have administrator privileges to remove the product.

To remove the software


2 In the InterPlot Client Configure dialog box, click Uninstall.

3 In the InterPlot Client Configure - Uninstall dialog box, check the individual components you want to remove, or click Select All to check all of the components, and then click OK.

Note To remove sub-components of MicroStation or AutoCAD support, click Change Option.

4 In the confirmation box, click Yes to remove the product components or No to cancel the removal process.

6-1


You can use the InterPlot Client Configure utility to properly register your software. InterPlot products that are not registered properly will produce plots containing watermarks.



2 In the InterPlot Client Configure dialog box, click Register.

3 In the InterPlot Client Configure - Register dialog box, click Register Online.






6-2

Integrating with MicroStation or AutoCAD

The Integrate option allows you to integrate the APLOT dialog box with your current AutoCAD environment or the IPLOT dialog box with your current MicroStation environment. You can also use this dialog to determine which MicroStation product to use as the print/preview engine.

You should use Integrate when you install a new version of AutoCAD, or MicroStation after you install this InterPlot product, or when you choose not to integrate with AutoCAD, or MicroStation during the installation process.

To integrate with MicroStation or AutoCAD


2 In the InterPlot Client Configure dialog box, click Integrate.

3 In the InterPlot Client Configure - Integrate dialog box, select the MicroStation or AutoCAD tab.

You can determine which version(s) of MicroStation or AutoCAD you want to integrate with the IPLOT/APLOT dialog interface. If you have multiple versions of MicroStation installed, you can determine which version to use as the print/preview engine.

Note By default, the latest version of MicroStation will be used for the MicroStation print/preview engine.

4 To complete product integration, click OK.

6-3

What are Configuration Files?

Configuration files define configuration variables that control the behavior of the product. Each variable controls some aspect of the product’s behavior, such as where it creates files, where it looks for files, or how it stores filenames.

This product includes five configuration files:

IP.CFG --defines product level/common variables

IPLOT.CFG and IPLOTSRV.CFG --define IPLOT-related variables for plotting MicroStation data

APLOT.CFG and APLOTSRV.CFG --define APLOT-related variables for plotting AutoCAD data

These configuration files control the system-level behavior of the product. A default version of each of these files is delivered with the product. You can customize the product by adding or modifying variable values in any of these files.

To edit these configuration files, use the InterPlot Client Configure utility or the InterPlot Organizer Edit -> Configuration command.

6-4

Configuration File Format

Configuration files are ASCII files. Each line in the configuration file contains a variable definition or a comment. You can also insert blank lines to make the files easier to read. Each variable in the default configuration files includes a comment that describes the behavior it controls.

Variable Definitions

Variable definitions have the following form:

name=value

Name is the name of an InterPlot configuration variable. Depending on the variable, value is a keyword such as true or false, a filename, a directory name, or a list of directory names delimited by semicolons (;). Spaces around the equal sign (=) are optional. Any time a value contains a space, the entire value must be quoted.

In most cases, the name of the variable indicates the type of value it contains or identifies, or the user interface to which it applies. The following list includes several examples:

Variables with names ending in DIR must contain a single directory name.

Variables with names ending in PATH contain a directory name or a list of directory names separated by semicolons (;).

Variable names with IPLOT_DLOG apply only to the IPLOT dialog box.

Variable names with APLOT_DLOG apply only to the APLOT dialog box.

You can use configuration variables to define other configuration variables. If a variable’s value contains the name of a previously-defined variable preceded by a dollar sign ($), InterPlot replaces the variable name and the $ sign with the variable’s value. Defining groups of related variables this way makes it easier to modify the configuration file if your system changes.

Example:

IP_WORK_DIR = $IP_PRODUCT_DIR\wrk

You can also use percent (%) include = filename to reference another configuration file from within a configuration file. For example, for ease of administration, you could use % include to centralize the configuration file on a file server.

Examples:

%include = "c:\users\plotfiles\common.cfg"

%include = \\serv2\plot\site.cfg

Comments

Comments are explanatory text in the configuration file. InterPlot ignores comments when it reads the file. All text to the right of a pound sign (#) is treated as a comment.

Example:

# This is a comment line.

6-5

Common Configuration File

The Common configuration file (IP.CFG) defines variables that control the general behavior of this product. All configuration variable definitions for settings files are defined in this file.

You can access the Common configuration file through the InterPlot Client Configure utility or the InterPlot Organizer Edit -> Configuration command.

6-6

MicroStation Configuration FilesIPLOT MicroStation configuration files define variables that control how MicroStation data is plotted. This product supports two types of IPLOT MicroStation configuration files: Client and Server.

You can access the IPLOT MicroStation configuration files with the InterPlot Client Configure utility or the InterPlot Organizer Edit -> Configuration command.

Client Configuration File

IPLOT.CFG is a configuration file that contains variables used by the IPLOT command line, dialog, and Organizer interfaces.

Server Configuration File

IPLOTSRV.CFG is a configuration file that contains search paths used to locate resource files (IPLOT patterns and line styles) and variables that control how the plot is rendered.

InterPlot uses MicroStation font and line style resources. For more information see Using MicroStation Resource Files.

Note To ensure that your plot previews are displayed as they will plot, the configuration files on the client and server must access the same resources.

6-7

AutoCAD Configuration FilesAutoCAD configuration files define APLOT variables that control how AutoCAD data is plotted. This product supports two types of AutoCAD configuration files: client and server.

You can access the AutoCAD configuration files with the InterPlot Client Configure utility or the InterPlot Organizer Edit -> Configuration command.

Client Configuration File

APLOT.CFG is a configuration file that contains variables used by the APLOT command line, dialog, and Organizer interfaces.

Server Configuration File

APLOTSRV.CFG is a configuration file that contains search paths used to locate resource files and variables that control how the plot is rendered. If InterPlot Server is not installed on this machine, the server configuration file controls the behavior of Print Preview.

6-8

Using MicroStation Resource Files

By default, InterPlot will use the font and line style resources (FONT.RSC and LSTYLE.RSC) referenced by the default MicroStation workspace. If your organization uses customized font or line style resources, InterPlot enables you to specify a custom workspace.

Each InterPlot Client interface provides a method for specifying a workspace.

In InterPlot Organizer, specify the workspace name in the “Workspace” field on the General Property Sheet.

In the IPLOT dialog box, specify the workspace name using the File -> Set Workspace command.

From the IPLOT command line, specify the workspace name on create or modify as follows:

-workspace=<workspace name>

Note See your MicroStation documentation for information about defining workspaces.

If the plot server uses font resources on a remote file server, they must be specified in the MicroStation workspace UCF file using Universal Naming Convention (UNC) file names (that is, no mapped drives). You must also edit the registry on the remote file server which those UNC file names refer to.

6-9


6-10

C H A P T E R 7 InterPlot Server and the Server Utilities

What is InterPlot Server?

InterPlot® Server is the server component of Bentley Systems network production plotting system (InterPlot). It serves as the print engine for the following InterPlot client products: InterPlot Client, InterPlot Professional, IPLOT Client 8.0, and APLOT Professional 1.0. These clients will offload plot processing to InterPlot Server for producing high-quality plots on any Windows-supported plotter or printer.

Workflow

InterPlot Server processes plot jobs from InterPlot client products. Computers with the InterPlot Server software installed are referred to as plot servers. Computers with InterPlot client products installed are referred to as clients. When a plot server receives a plot job from a client, the InterPlot Server software processes and sends the data to a printing device.

The following InterPlot configuration illustrates network plot production.

7-1

What ’s New?

Clients Served by InterPlot Server

InterPlot Server is the print engine for the following products:

InterPlot Client

InterPlot Professional

IPLOT 8.0

APLOT Professional 1.0

New Product Licensing

Setup no longer requires you to enter a registration number during product installation. This means that InterPlot products will place a watermark on all plots until a license file is obtained from Bentley Systems.

Better Intergration with CAD Products

The InterPlot Server Configure utility enables you to select which MicroStation product to use as the IPLOT print engine.

Improved MicroStation Workspace Validation

Improved workspace validation on the plot server. The new IPLOT configuration variable IPLOTSRV_WORKSPACE_VALIDATION enables InterPlot Server a more flexible approach for locating MicroStation user workspace configuration files.

Accounting EnhancementsThe InterPlot pen table language has been enhanced to enable the automatic extraction of data from MicroStation and AutoCAD files. This data is written to the accounting file. For more information, see the "How To" section of the InterPlot Reference Help version 10.0.

The Accounting utility now displays the accounting data in a spreadsheet-like display. You can limit the display of the accounting file to particular fields of interest and export the data to a file suitable for importing into applications like Microsoft Excel.

The Accounting file contains the following additional variables that can be used for billing purposes to more accurately determine the amount of media used: PAPER_LENGTH, PAPER_WIDTH, and PRINTED_AREA.

7-2

Uninstalling the Product

You can use the Uninstall option to remove some or all of the components of this product from your computer.

Note You must have administrator privileges to remove the product.

To remove the software

1 Select Start->Programs->InterPlot Utilities->InterPlot Server Configure.

2 In the InterPlot Server Configure dialog box, click Uninstall.

3 In the InterPlot Server Configure - Uninstall dialog box, check the individual components you want to remove, or click Select All to check all of the components, and then click OK.

4 In the confirmation box, click Yes to remove the product components or No to cancel the removal process.

7-3

Integrating the Product

The Integrate option allows you to integrate InterPlot Server with your installed MicroStation products. You can also use this dialog to determine which MicroStation product (MicroStation 95 or later) to use as the print engine.

To integrate with MicroStation

1 Select Start->Programs->InterPlot Utilities-> InterPlot Server Configure.

2 In the InterPlot Server Configure dialog box, click Integrate.

3 In the InterPlot Server Configure - Integrate dialog box, select the MicroStation product to use as the print engine.

Note By default, the latest version of MicroStation will be used for the MicroStation print engine.

4 To complete product integration, click OK.

7-4


You can use the InterPlot Server Configure utility to properly register your software. InterPlot products that are not registered properly will produce plots containing watermarks.


1 Select Start->Programs->InterPlot Utilities-> InterPlot Server Configure.

2 In the InterPlot Server Configure dialog box, click Register.

3 In the InterPlot Server Configure - Register dialog box, click Register Online.






7-5

What Are Configuration Files?

Configuration files define configuration variables that control the behavior of the product. Each variable controls some aspect of the product’s behavior, such as where it creates files, where it looks for files, or how it stores filenames.

This product includes two configuration files:

IPLOTSRV.CFG --defines IPLOT-related variables for plotting MicroStation data

APLOTSRV.CFG --defines APLOT-related variables for plotting AutoCAD data

These configuration files control the system-level behavior of the product. A default version of each of these files is delivered with the product. You can customize the product by adding or modifying variable values in either of these files.

To edit these configuration files, use the InterPlot Server Configuration utility.

7-6

Configuration File Format

Configuration files are ASCII files. Each line in the configuration file contains a variable definition or a comment. You can also insert blank lines to make the files easier to read. Each variable in the default configuration files includes a comment that describes the behavior it controls.

Variable Definitions

Variable definitions have the following form:

name=value

Name is the name of an InterPlot configuration variable. Depending on the variable, value is a keyword such as true or false, a filename, a directory name, or a list of directory names delimited by semicolons (;). Spaces around the equal sign (=) are optional. Any time a value contains a space, the entire value must be quoted.

In most cases, the name of the variable indicates the type of value it contains or identifies. The following list includes several examples:

Variables with names ending in DIR must contain a single directory name.

Variables with names ending in PATH contain a directory name or a list of directory names separated by semicolons (;).

You can use configuration variables to define other configuration variables. If a variable’s value contains the name of a previously-defined variable preceded by a dollar sign ($), InterPlot replaces the variable name and the $ sign with the variable’s value. Defining groups of related variables this way makes it easier to modify the configuration file if your system changes.

Example:

IPLOTSRV_LINESTYLE_LIB = $IPLOTSRV_PRODUCT_DIR\resrc\system\style.plb

You can also use percent (%) include = filename to reference another configuration file from within a configuration file. For example, for ease of administration, you could use % include to centralize the configuration file on a file server.

Examples:

%include = "c:\users\plotfiles\common.cfg"

%include = \\serv2\plot\site.cfg

Note InterPlot Server configuration files support UNC file names. If you use UNC file names, you may encounter security problems when processing plot jobs from client machines. To correct the problem, you must edit the registry on the machine(s) pointed to by the UNC file names in the InterPlot Server configuration files.

Comments

Comments are explanatory text in the configuration file. InterPlot ignores comments when it reads the file. All text to the right of a pound sign (#) is treated as a comment.

Example:

# This is a comment line.

7-7

MicroStation Configuration File

The MicroStation configuration file defines IPLOT variables that control how MicroStation data is plotted. IPLOTSRV.CFG is a configuration file that contains search paths used to locate resource files and variables that control how the plot is rendered.

Note To ensure that your plots match the plot previews on the client, the configuration files on the server and client must access the same resources.

7-8

C H A P T E R 8 InterPlot Drivers

What’s New?

The following is a summary of new features:

Windows 2000 Compatibility.

Support for the Xerox 8825 printer.

Support for the Océ 9300 and Océ 9400 II printers.

Support for the following DesignJet printers, the HP DesignJet 500, HP DesignJet 800, HP DesignJet 1050, HP DesignJet 1055CM, HP DesignJet 2000CP, HP DesignJet 2500CP, HP DesignJet 3000CP, and the HP DesignJet 3500CP printers.

Updated PCL/5 monochrome and PCL/5 color drivers with a user configurable resolution field.

The Accounting utility now displays the accounting data in a spreadsheet-like display. You can limit the display of the accounting file to particular fields of interest and export the data to a file suitable for importing into applications like Microsoft Excel. The Accounting file also contains the following additional variables that can be used for billing purposes to more accurately determine the amount of media used: PAPER_LENGTH, PAPER_WIDTH, and PRINTED_AREA.

8-1

About the InterPlot Driver Pack

The InterPlot Driver Pack provides a set of printer drivers that support a wide variety of printers. A printer driver is one of the software components involved in the printing process. The driver is the component that configures and formats the data into the language (printer commands) that the printer recognizes.

Some of the drivers in the InterPlot Driver Pack have been written specifically for particular printer models, while others are considered generic drivers that can work with most printers capable of accepting the driver’s printer commands. The various InterPlot Driver Pack drivers support the following printer languages:

HPGL

HPGL/2

HPRTL (Hewlett-Packard Raster Transfer Language)

CPGL

CCRF (CalComp Compressed Raster Format)

Cals/G4

PCL/5

Printers created using InterPlot printer drivers support both Windows applications (such as Microsoft Word and Excel) and InterPlot applications (such as IPLOT and APLOT).

The InterPlot printer drivers provide several methods for changing the appearance of a plot. These methods vary depending on the type of application you are using. Changes can be made to affect all plot jobs or on a per-plot basis. See Changing a Plot’s Characteristics for more information.

Driver setup is performed from within your system’s print facility. Monitoring, as well as manipulation of the plot jobs is also performed from within your system’s print facility. The same Printers folder commands provided for managing native Microsoft drivers are also provided for the InterPlot drivers.

The InterPlot Driver Pack also enables you to have plot labels associated with each job, thus enabling a user defined text string to appear at the bottom of each plot job. Information such as the name of the file, the date the file was printed, and who sent the file, are common uses of plot labels.

In addition to the drivers, the driver pack also includes error logging and accounting utilities. Accounting enables you to generate accounting information for each job the printer processes on the plot server. This information enables system administrators to keep track of printer workloads and can be used, for example, when billing projects/departments and ordering printer supplies based on printer usage. Error logging enables you to maintain error log information for each printer on the plot server, thereby assisting in troubleshooting printing problems.

8-2

System Requirements

The InterPlot Driver Pack requires certain hardware and software components to be able to run properly.

Microsoft Windows NT Server 4.0, Microsoft Windows NT Workstation 4.0, Microsoft Windows 2000 Server, or Microsoft Windows 2000 Professional

An Intel Pentium II processor or later

64 MB of RAM (minimum)

15 MB of available disk space for installation

CD-ROM drive

8-3


You can use the InterPlot Driver Pack Configure utility to properly register your software. InterPlot products that are not registered properly will produce plots containing watermarks.


1 Select Start->Programs->InterPlot Utilities->InterPlot Driver Pack Configure.

2 In the InterPlot Driver Pack Configure dialog box, click Register.

3 In the InterPlot Driver Pack Configure - Register dialog box, click Register Online.






8-4

Specifying Printer Options

InterPlot printer drivers provide various methods to change or specify different printing options. Some or all of these methods can be applied during the printing process.

These methods include:

Device Attributes

Rendering Attributes

Forms Attributes

You must be careful when the same printing option appears in more than one dialog box since the driver applies them in a particular order. Device Attributes are always applied before Rendering Attributes, and Forms Attributes are applied last. For example, if you set Fold to Off in a Rendering Attributes file, and then apply a standard or custom form with Fold set to On; the plot will be folded.

The Device, Rendering, and Forms Attributes dialog boxes do not contain the same printing options. There are some printing options that appear only in the Device Attributes dialog box. Other printing options may appear in both the Device and Rendering Attributes dialog boxes, or in both the Rendering and Forms Attributes dialog boxes.

8-5

Device Attributes

After you install the InterPlot Driver Pack and add a printer, you can access the InterPlot Device Attributes dialog box and identify what media types and sizes you have installed in the various media source locations. You can also establish a default plot label for each printer, and you can set various other attributes depending upon the specific type of printer.

You can also identify what action the InterPlot software should take if a media handling error occurs. For example, a media handling error occurs if a print job requests film media, but film media is not installed in the printer, or if an E-size (34x44 in.) plot is requested but only 22 inch media is installed in the printer.

Device Attributes are always applied before Rendering Attributes, and Form Attributes are applied last. If you specify a plot label in the Device Attributes dialog box, and a different plot label in a Rendering Attributes file, the plot label in the Rendering Attributes file will take precedence.

8-6

Rendering Attributes

When you create a printer, the InterPlot software associates a default set of Rendering Attributes with that printer. The default Rendering Attributes affect each plot request submitted to that printer.

You can modify the default Rendering Attributes for a printer, or you can choose to override the printer’s default Rendering Attributes during plot submission. InterPlot applications use a Rendering Attributes file to override the printer’s default Rendering Attributes, while Windows applications use the Rendering Attributes button on the Advanced Document Properties dialog (Windows NT 4.0/Windows 2000), or the Graphics Property dialog (Windows 98). Rendering Attributes include Rendering options, Media source, Cutting options, Folding options, Media deposit, and other driver specific options.

Rendering Attributes are applied after Device Attributes, but before Forms Attributes. If you specify an attribute (Fold: Off) in a Rendering Attributes file, and the same attribute (Fold: On) in a form, the Forms Attribute will take precedence, causing the plot to be folded.

Rendering Attributes for InterPlot Applications

To override the "default" Rendering Attributes for a printer using the InterPlot command line and dialog submit interfaces, you must create a Rendering Attribute file. Use the Graphical Attribute Editor to create or modify Rendering Attributes files. Use the rendering_attributes qualifier within the submit interfaces to send the Rendering Attributes file along with the plot request.

InterPlot’s Organizer interface offers an additional option within the Print Setup and Print dialog boxes called InterPlot Attributes. You can use this option to specify a desired set of Rendering Attributes to be sent along with a plot set.

Rendering Attributes for Microsoft Applications

Applications that submit print requests using the Windows printing workflow of File -> Print can define default Rendering Attributes using the Document Defaults command for the printer. The Device Control dialog box displays the various Rendering Attributes that you can modify.

Windows applications can override the default Rendering Attributes for the printer by selecting a form which has the desired options defined or by using the Rendering Attributes button on the Advanced Document Properties dialog (Windows NT 4.0/Windows 2000), or the Graphics Property dialog (Windows 98).

8-7

Forms Attributes

You can use the Forms option within the InterPlot Device Attributes dialog box to assign options to existing or custom forms. Those options defined as "Default", on the Forms Attributes dialog, will use the settings specified in the Rendering Attributes file (if submitted), or the default Rendering Attributes for the printer. Options specified with values other than "Default", will override the settings specified in the Rendering Attributes file (if submitted), or the default Rendering Attributes for the printer.

For InterPlot applications, you can use the paper_size qualifier when the IPARM/APARM file is created, to specify an existing or custom form. InterPlot ’s Organizer interface supports the use of the paper_size option within the layout property page.

Windows applications that submit print requests using the Windows printing workflow of File -> Print can select a form with the desired options defined.

Forms Attributes are applied after Device and Rendering Attributes. If you specify an attribute (Fold: Off) in a Rendering Attributes file, and the same attribute (Fold: On) in a form, the forms attribute will take precedence, causing the plot to be folded.

See your Windows NT documentation for creating custom forms.

8-8

Creating Printers on a Server Node

Creating a printer on a Windows NT 4.0/Windows 2000 server node enables both Windows applications and InterPlot applications access to the device that the printer services. This printer can be shared to enable access to clients running Windows NT 4.0, Windows 2000, or Windows 98. These clients can submit plots from InterPlot applications such as IPLOT and APLOT, or Windows applications such as Microsoft® Word and Excel. To connect to a printer on another node, see Connecting to Printers on a Server Node .

8-9

Creating Printers Using an InterPlot Printer Driver

The process of setting up a printer that uses an InterPlot driver is the same as the process used to set up a printer using one of the native Microsoft drivers delivered with the Windows NT operating system.

To create a printer on Windows NT 4.0/Windows 2000

1 On the server node, access the Printers folder. Double-click the Add Printer icon to create a printer.

2 Using the appropriate InterPlot Driver Pack driver for your device, add a new printer to your system. When prompted to "Keep existing driver" or "Replace existing driver", choose "Keep existing driver."

3 Once the printer is created, you can change the default characteristics of your printing device by modifying the Device Attributes. This modification is accomplished by using the InterPlot Device Attributes dialog box. The options on this dialog box vary depending on the type of device you are using.

See Setting Device Attributes for more information about specific Device Attributes.

For details on creating printers, refer to the Windows NT 4.0/Window 2000 on-line help, or visit http://support/microsoft.com/directory.

8-10

Connecting to a Printer from a Windows NT 4.0/Windows 2000 ClientTo print to a shared printer on a server node, you must first connect to it from a client node. Connecting to a printer on a server node enables all applications on the client node access to that printer.

To connect to a printer from a Windows NT 4.0 client

1 From the Printers folder, double-click the Add Printer icon.

2 Select the Network printer server option, and then click Next.

3 Double-click the name of the server node to which you want to connect.

4 If more than one group is listed, select a group to display a list of printer names.

5 Double-click a printer name.

To connect to a printer from a Windows 2000 client

1 From the Printers folder, double-click the Add Printer icon.

2 Select the Network printer option, and then click Next.

3 Type the printer name, or click Next to browse for a printer.

4 Select Yes if you want this to be your default printer, then click Next.

5 Click Finish.

Note: If the printer name that you are looking for is not in this list, verify (on the server node) that the printer is shared.

For more details about connecting to printers, refer to the Windows NT 4.0/Windows 2000 on-line help, or visit http://support.microsoft.com/directory.

8-11


8-12

C H A P T E R 9 Using InterPlot with other Windows Applications

Introduction to Plotting Windows Applications

InterPlot now provides the capability to include small-format documents, such as word processing files and spreadsheets, as well as large-format documents, such as project schedules and drafting data, in your plot sets.

To accommodate both small-format and large-format documents, InterPlot has added the following features:

Attaching a Portable Document Format (PDF) file to plot set as reference information

Creating Organizer compatible format files using the InterPlot Organizer Printer Driver

Attaching a PDF File as Reference Information

PDF is the most suitable Web-publishing format for small-format, text-based Office® documents created from applications such as Microsoft Word® and Microsoft Excel®. You can create PDF files from these applications using Adobe® Acrobat® PDF Writer or Acrobat Distiller. A PDF file can be attached to a plot set as reference information. The archive Web page displays the PDF file as a link.

Creating Organizer Compatible Format Files

Organizer compatible format files (DPR) can be created using the InterPlot Organizer Printer Driver. DPR files can be added directly to a plot set using InterPlot Organizer. DPR is the most suitable Web-publishing format for large-format, multi-sheet graphical documents created from applications such as Microsoft Project®, and Visio Technical®. The new InterPlot Organizer Printer Driver is delivered with InterPlot Client and InterPlot Professional.

9-1

Attaching a PDF File as Reference Information

InterPlot now provides a way to attach a PDF file to a plot set as reference information. This capability allows you to associate data from Office applications with your plot sets, and to make this data available over the Web when viewing a digital archive.

Office applications such as Microsoft Word and Microsoft Excel typically generate multi-page, small-format (A or B size) documents. PDF is the most suitable file format for distributing, viewing, and printing these types of text-based documents over the Web.

You can generate PDF files from Office applications using the tools provided in Adobe Acrobat, such as the Acrobat PDF Writer or Acrobat Distiller. InterPlot Organizer provides a way to attach a PDF file to a plot set. (A plot set can have only one attached PDF file.)

The Plot Set Table of Contents page displays a link to the PDF file. Web viewers can double-click the PDF file link and view or print the file using the Adobe Acrobat Reader.

The following diagram illustrates the process of associating a PDF file with a plot set.

9-2

Attaching a PDF File to a Plot Set

After you create a PDF file from your Office application, you can attach it to a plot set using InterPlot Organizer.

To attach a PDF file to a plot set

1 From InterPlot Organizer, select File -> Attributes.

2 In the Plot Set Attributes dialog box, type the name of the PDF file in the PDF File text box, or click Browse to select the file.

Note Organizer allows only one PDF file to be associated with a plot set.

3 Enter any attributes you want to associate with the plot set.

4 Click OK.

You can also use Organizer’s settings file editor to specify a PDF file in the Common section of a settings file. See InterPlot Organizer Help for more information about creating and editing settings files.

9-3

Creating Organizer Compatible Format Files (DPR)

This release of InterPlot Client/Professional includes a new InterPlot Organizer Printer Driver for creating Organizer compatible format files (DPR) from large-format Windows applications which contain mostly graphical data. After you create a DPR file from your application, you can add it to a plot set and submit it to an archive using InterPlot Organizer.

Applications such as Microsoft Project, and Visio Technical typically produce large vector and raster data. Since PDF files created from these applications are very large, they are unsuitable for archiving and Web distribution. The DPR format, however, is well-suited for handling this large-format hybrid engineering data efficiently.

Notes

This feature is not supported with Windows 98.

DPR files generated using the InterPlot Organizer printer driver can not be handled directly by the InterPlot Web Plot control. You must first submit the DPR files to an archive using InterPlot Organizer.

The following diagram illustrates the process of creating plots from DPR files and submitting them to a digital archive.

9-4

Creating the InterPlot Organizer Printer

Both InterPlot Client and InterPlot Professional products install the new InterPlot Organizer Printer Driver. Creating the InterPlot Organizer printer is much like creating any Windows NT printer. The only exception is that the InterPlot Organizer printer requires a special port that determines the location and file-naming pattern for the DPR files.

In addition to saving the DPR file to disk when printing from Windows applications, the InterPlot Organizer Port Monitor provides a Command Setup dialog box to invoke any command (*.bat) or utility (*.exe) after the DPR file is generated. The Organizer utility command, orgutil.exe, listed in the Command Setup dialog box, enables the port to invoke Organizer and add the DPR file to an existing plot set or to a new plot set.

To create the InterPlot Organizer printer:

1 Select Start -> Settings -> Printers.

2 Double-click Add Printer.

3 Click My Computer, and then click Next.

4 Click Add Port.

5 Select the InterPlot Organizer Port, and then click New Port.

6 Enter a port name, and then click OK.

7 From the Job Storage Definition dialog box, select the output directory for the DPR files.

8 Click Pattern Setup to change the file-naming pattern for the DPR files.

9 Click Command Setup to enter any command or utility that is to be run after the printer driver generates the DPR file.

10 Click OK to dismiss the Job Storage Definition dialog box, then click Close to dismiss the Printer Ports dialog box.

11 Click Next.

12 Select Bentley from the Manufacturers list box, and the InterPlot Organizer Printer Driver from the Printers list box, and then click Next.

13 Select Keep Existing Driver and then click Next.

14 Enter the printer name, and then click Next.

15 Click Shared, if this printer is to be shared over the network, and then click Next.

16 Click Finish.

9-5

Integration with InterPlot Organizer

After you create the InterPlot Organizer printer, you can print large sheet-based engineering drawings to create DPR files. You can drag and drop the DPR files into Organizer, or you can add them to a plot set from the Create Plots option.

The InterPlot Organizer Port Monitor

The InterPlot Organizer Port Monitor provides a configuration option to execute a specified command after the printer driver has generated a DPR file from your Windows application.

You can specify a command to be executed in the Command Setup dialog box. By default, this dialog box displays the Organizer utility command, orgutil.exe, click the Browse button to locate and open another executable (*.exe) or batch file (*.bat).

To execute this command, check the Execute Command check box. Then, when you print from your Windows application using the InterPlot Organizer printer, you can specify further options in the InterPlot Organizer Plot Set Options dialog.

Note When using Windows 2000, you must run dcomcnfg for the orgutil command to work properly. Run dcomcnfg and click the "Default Properties" tab. In the "Default Authentication Level" list box, select Default and then click OK.

There are several ways to configure the plot set options.

If you check the Invoke InterPlot Organizer check box and enter an existing plot set (*.ips) file, InterPlot Organizer is invoked and the DPR file is added to the existing plot set.

If you enter a plot set file without checking the Invoke InterPlot Organizer box, the DPR file is added to the existing plot set without invoking InterPlot Organizer.

9-6

If you check the Invoke InterPlot Organizer check box without entering a plot set file, InterPlot Organizer is invoked and the DPR file is added to a new plot set.

9-7


9-8

Using InterPlot with Descartes, Raster Manager, and Image Manager

InterPlot provides support for Descartes, Image Manager, and Raster Manager for MicroStation SE and MicroStation/J. Raster Manager and Image Manager enable you to control the display of one or more image files within a MicroStation design file. Descartes enables you to view and edit the raster images displayed within the design file. The following chart displays the supported InterPlot workflows.

* Requires Raster Manager 7.11.36.38 or later.

Plotting MicroStation Raster Products with InterPlot

Some setup is required for you to plot MicroStation raster products inside the InterPlot client submit interfaces.

The following steps are recommended for the IPLOT Dialog Interface:

Integrate InterPlot with your MicroStation raster product

Configure IPLOT.CFG for the IPLOT Dialog Interface

Set the resolution in the IPLOTDRV.PLT file (Optional)

The following steps are recommended for InterPlot Organizer and the IPLOT Command Line interfaces:

Integrate InterPlot with your MicroStation raster product

Configure IPLOT.CFG for the IPLOT Command Line and Organizer interfaces

Set the resolution in the IPLOTDRV.PLT file (Optional)

The following sections describe in detail how to complete the above steps.

Integrating InterPlot with your MicroStation Raster Product

The InterPlot Client Configure utility enables you to integrate MicroStation raster products such as Descartes, Raster Manager, or Image Manager with you InterPlot product. You will need to properly integrate InterPlot with the raster product that you are using in order for MicroStation plotting to work properly.

To integrate InterPlot with your raster product

1. Select Start – Programs – InterPlot Utilities – InterPlot Client Configure.

2. Click Integrate.

3. In the MicroStation Raster Support field, select the raster product you are using.

4. Click OK twice, and then click Exit.

Configuring IPLOT.CFG for the IPLOT Dialog Interface

There is an IPLOT configuration variable (IPLOT_DLOG_USE_DIRECT_MODE) that has been added for the IPLOT Dialog interface when plotting raster images from Descartes, Raster Manager, and Image Manager.

By default, this variable is set to AUTO. Auto mode senses if raster images are present and uses the direct mode for plots containing raster. Direct mode or "direct plotting" uses the active MicroStation process to stroke the plot to output a graphics metafile (.dpr). Direct plotting is much faster than the traditional workflow of starting up a separate background process to stroke the plot. If no raster is present, the traditional workflow is followed, creating an IPARM file, generating a metafile, and plotting it in a separate background process.

In most cases, setting this variable to AUTO is appropriate. However, if you are using MicroStation Modeler you may want to set this variable to TRUE, to allow plotting of part assemblies.

9-9

When this variable is set to FALSE, IPLOT works in its traditional mode.

Configuring IPLOT.CFG for the IPLOT Command Line and Organizer Interfaces

The IPLOT Command Line and InterPlot Organizer interfaces can plot raster data associated with MicroStation/J and Raster Manager (version 7.11.36.38 or later). In order to plot raster data from the command line and Organizer interfaces, you can use the InterPlot Client Configure utility to edit the IPLOT.CFG file and set the variable value for IPLOT_LOCAL_STROKE_RASTER to TRUE.

IPLOT_LOCAL_STROKE_RASTER determines how IPLOT processes raster image files. When set to TRUE, IPLOT uses a newer method which relies on the MicroStation graphics engine on the client to read and manipulate image files present in the design file . When set to FALSE, IPLOT uses its older traditional method, which transfers image files to the server for processing by InterPlot Server. The default value is TRUE, meaning that IPLOT works as it does in previous releases.

Use FALSE if you want Type 90 Raster Reference files to plot as they did in previous versions. FALSE is the best setting for I/RAS B and I/RAS C compatibility. Many Raster Manager files will not plot accurately with this setting.

Note Be sure to use the correct workspace name. When you attach a raster file with Raster Manager, Raster Manager updates the MS_RFDIR search path to include the directory where the raster file resides. This is done so that the raster file can be found when you open the master design file. This modified MS_REFDIR is stored inside the user.ucf (user workspace configuration) file. Specifying the correct workspace enables InterPlot to locate the raster files during the plotting process.

Setting the Resolution with the IPLOTDRV.PLT File

By default, all image data is subsampled during the plotting to 150 dots per inch (dpi). This is adequate for color and gray scale images, but not for color line work and scanned monochrome (binary) image data. To adjust the plotting resolution, it is necessary to modify the IPLOTDRV.PLT file. This file resides in the c:\Program Files\Common Files\InterPlot\IPLOT\bin folder. The "pixel_resolution" field gives the raster resolution in dpi. For line art or monochrome data, the resolution should be increased to be equal to the printer resolution.

9-10

Introducing ProjectWise

ProjectWise is a Bentley product that provides Electronic Document Management Systems (EDMS) functionality. ProjectWise provides document storage, document attribution, workflow management, controlled access, and the ability to associate applications with documents and run those applications from ProjectWise.

InterPlot Organizer can access files in a ProjectWise Datasource. Users can store all of their plotting files in a ProjectWise Datasource and then access them using InterPlot Organizer as if they were on the local drive.

One of the benefits for using ProjectWise is to put all of your plotting files in a central location, so that everyone has access to the same data without having to duplicate files and shares on every client machine.

9-11

Integrating Organizer with ProjectWise

There are three steps to properly integrate InterPlot Organizer with ProjectWise. In order to complete these steps, you will need to know the User Name and Password to the ProjectWise Datasource on the ProjectWise Server.

The three steps are to:

Add new Applications on the ProjectWise Server

Make Program Associations on the client

Add an InterPlot Plot Set (IPS) file to the ProjectWise Datasource

Adding New Applications on the ProjectWise Server

Perform the standard installation of ProjectWise on the server machine. Once installed, you will need to add new Applications on the ProjectWise Server.

Add the following Applications:

Add "IP Organizer" with an extension of "ips"

Add "IPLOT Feature" with an extension of "ftb" (required if you want the IPLOT Feature Table editor fully integrated with ProjectWise)

Add "APLOT Feature" with an extension of "aft" (required if you want the APLOT Feature Table editor fully integrated with ProjectWise)

To add a new Application

1 Select Start – Programs – ProjectWise – ProjectWise Administrator.

2 Expand the tree down to the Datasource. To expand the tree, click the PLUS SIGN (+).

3 Click on the Datasource name, and then type in the User Name and Password in the ProjectWise Login window.

4 Right-click on the Applications icon, and then select the New – Applications command.

5 From the New Applications dialog, type in the application name in the Name field and the extension in the File Extensions field, and then click Add.

6 To dismiss the New Applications dialog, click OK.

Making Program Associations on the Client

Perform the standard installation of ProjectWise on the client machine. Afterwards, you will need to use the Program Associations command to associate the application with its corresponding executable.

Make the following Program Associations:

Associate <Product_Directory>\bin\iplotorg.exe with “IP Organizer.”

Associate c:\win32app\ingr\ipshare\bin\ipfte.exe with "IPLOT Feature" (required if you want the IPLOT Feature Table editor fully integrated with ProjectWise)

Associate c:\win32app\ingr\ipshare\bin\apfte.exe with "APLOT Feature" (required if you want the APLOT Feature Table editor fully integrated with ProjectWise)

To make a Program Association

1 Select Start – Programs – ProjectWise – ProjectWise Explorer.

2 Expand the tree for the Datasource. To expand the tree, click the PLUS SIGN (+).

3 Type in the User Name and Password in the ProjectWise Explorer Login window.

4 Select Tools – Program Associations.

5 Expand the tree under IP Organizer and then double-click OPEN.

6 Associate InterPlot Organizer with <Product_Directory>\bin\iplotorg.exe.

7 Expand the tree under the new association.

8 Double-click on Partner Application to set it to YES.

9 Double-click on Arguments and type in a single space. (This fixes a problem with an uninitialized string in ProjectWise.)

Note Be sure to repeat steps 5-9 for the IPLOT and APLOT Feature Table editors if you want them to be fully

9-12

integrated with ProjectWise.

Once the Associations have been made, the Program Associations dialog should look similar to the one shown below.

Adding an InterPlot Plot Set (IPS) file to the ProjectWise Datasource

The final step to properly integrate InterPlot Organizer with ProjectWise is to add an InterPlot Plot Set (IPS) file to the ProjectWise Datasource.

When a plot set file is invoked from a ProjectWise Datasource, InterPlot Organizer exposes the ProjectWise File Open and File Save dialogs. The ProjectWise dialogs allow you to access files being managed by ProjectWise and to save files to a ProjectWise Datasource. If you wish to use InterPlot Organizer’s standard File Open and File Save dialogs, press the Cancel button on the ProjectWise dialogs.

Two ways to add an Plot Set File to a ProjectWise Datasource

Create an empty plot set file with InterPlot Organizer and then drag and drop it into a ProjectWise Datasource. You can also use the InterPlot Organizer command line to create an empty plot set file ( <Product_Directory>\bin\iplotorg.exe create plot_set_name.ips).

Once InterPlot Organizer has invoked a plot set file within ProjectWise, you can use Organizer ’s File New command to create additional plot set files to a ProjectWise Datasource.

9-13

Workflow for Organizer and ProjectWise

The recommended workflow when using InterPlot Organizer with ProjectWise is as follows:

Double-click an InterPlot Plot Set (IPS) file in a ProjectWise Datasource to run Organizer.

Work in Organizer as you normally would, just reference the plotting files from a ProjectWise Datasource instead of your local drive or a shared drive. Plotting files include color tables, pen tables, feature tables, rendering attribute files, project settings files, raster files, design/drawing files, and reference/xref files.

If you create new files such as pen tables or feature tables, be sure to save them to a ProjectWise Datasource and not the local drive or a shared drive.

If a Settings file references ancillary files (such as pen tables or feature tables) that are located in a ProjectWise datasource, be sure to copy out or check out these files to the appropriate folder in the ProjectWise working directory before you apply the Settings file. InterPlot Organizer does not automatically copy out or check out ancillary files referenced in a Settings file.

Exit and Save the Organizer session when you are finished.

Plot Set Files Created Outside of ProjectWise

If an existing plot set file references files on a local drive and you check it into a ProjectWise Datasource, then everyone that uses the plot set must have the same files on their local drive. In addition to having the same files, the files must reside in the same locations.

It is possible to import this type of plot set file and have it work properly, but it is not an automatic process. First, you would need to check in the plot set file and all of the files referenced by it. Once it’s invoked from ProjectWise, you would then have to modify every plot, making sure that each file it references is located in the ProjectWise Datasource.

As stated earlier, one of the benefits for using ProjectWise is to put all of your plotting files in a central location, so that everyone has access to the same data without having to duplicate files and shares on every client machine.

9-14

Accessing Plotting Files from ProjectWise

If you have properly integrated InterPlot Organizer with ProjectWise, you can double-click the InterPlot Plot Set (IPS) file from ProjectWise to invoke InterPlot Organizer. When a plot set file is invoked from a ProjectWise Datasource, InterPlot Organizer displays the ProjectWise File Open and File Save dialogs. The ProjectWise dialogs allow you to access files being managed by ProjectWise and to save files to a ProjectWise Datasource. (If you wish to use InterPlot Organizer’s standard File Open and File Save dialogs, press the Cancel button on the ProjectWise dialogs.)

When referencing files from a ProjectWise Datasource, use InterPlot Organizer’s Browse buttons instead of the key-in fields. Only one file at a time can be selected using the File Open dialogs (this is a limitation of ProjectWise). If you wish to use InterPlot Organizer’s standard File Open and File Save dialogs, press the Cancel button on the ProjectWise dialogs while in InterPlot Organizer.

The following graphic displays the ProjectWise File Open dialog.

By default, InterPlot Plot Set files are checked out from the ProjectWise Datasource, but the user can change this behavior inside ProjectWise Explorer using the Tools – User Settings – Document List – Double Click Action menu item.

All of the files that are referenced in an InterPlot Plot Set file are automatically copied out from the ProjectWise Datasource when the InterPlot Plot set file is invoked from ProjectWise. The files that get checked out or copied out go to an application-defined directory (dmsnnnnn) under the user’s ProjectWise Datasource working directory on the client machine.

9-15

InterPlot Plot Set files that are checked out for editing in InterPlot Organizer will be updated when saved and freed for other users upon exiting. In general, all of the copied out files (design files, pen/feature tables, color tables) will track the InterPlot Plot Set file when the user performs a File Open, File New, or exits InterPlot Organizer.

By default, ProjectWise Explorer does not leave a local copy when the plot set file is freed, therefore the plot set file is deleted from the working directory along with all of the files that were copied out. If the user settings are set to "Leave local copy on free," a copy of the plot set file will remain in the working directory along with all of the files that were copied out.

Another useful user setting in ProjectWise Explorer is "Use up-to-date copy on copy out," provided you are leaving a local copy of all copied out files in the working directory on the client machine. For example, if you double-click a plot set file from ProjectWise to invoke InterPlot Organizer, files that were previously copied out to the working directory on the client machine will not be copied out again if they are up-to-date.

Notes

Two users should not use the same physical working directory (shared drive) for the same ProjectWise Datasource. There could be conflicts of files being removed while they are in use by another user.

The same working directory should not be used for multiple ProjectWise Datasources. ProjectWise uses the same naming convention for all of the directories it creates under the working directory for all Datasources. Using the same working directory for multiple Datasources could result in files being overwritten.

Files from multiple ProjectWise Datasources cannot be referenced in a single plot set file.

The following graphic shows the relationship to files in a ProjectWise Datasource to the files checked out or copied out to the client.

The dms00054 folder on the local drive maps to the "Dave" vault in the Datasource, the dms00068 folder maps to the "dgn" vault, and the dms00069 folder maps to the "pentbls" vault.

Files Not Accessed from the ProjectWise Datasource

There are a few files related to InterPlot Organizer that cannot be put into the ProjectWise Datasource.

These files are:

Product Configuration files (CFG)

InterPlot Organizer’s Default Settings File (IPLOT.SET)

Printer Settings Files (PRINTER_NAME.SET)

9-16

interplot for micro station

Documents