Global Variables Used by the Patchworks System

The following variables can be set within the PIN file to specify the files to be read in and other startup parameters. Do not alter these variables in the Patchworks console after the program has started.

Name

Type

Description

blocks

String

The name of the file containing the block attributes. This file name (and all others file names) is relative to the location of the PIN file.

curves

String

The name of the file containing the curve descriptions.

features

String

The name of the file containing the feature attributes.

products

String

The name of the file containing the product attributes.

tracknames

String

The name of the file containing the track names.

treatments

String

The name of the file containing the treatment descriptions.

accounts

String

The name of the file containing the account descriptions.

vertices

String

The name of the file containing the road network vertices.

segments

String

The name of the file containing the road network segments.

destination

String

The name of the file containing the road network destinations.

linkages

String

The name of the file containing the road network linkages.

block_shape

String

The name of the shapefile or coverage containing the block polygons.

block_key

String

The name of the column in the block polygon file that is used to form the relational join to the block values.

useBlockCache

boolean

A boolean value (true/false) to indicate if block polygons should be read into memory to improve display performance. Use of the block cache will increase memory consumption. You may set this value to false to reduce memory consumption. The default value is false.

blockAccountPrefix

String

A string value that will be prepended on to the account columns in the block table. A prefix is required so that account columns do not have the same names as attribute columns. The default value is "Account.". You may include a trailing '.' in the prefix so that reports will add another hierarchical grouping level.

background_color

Color

This value specifies the colour displayed in the background of the map viewer. The default value is Color.white.

httpd_port

int

The port to be used to communicate results from the report writer. The default value is 8081.

The following variables are set by the Patchworks model and can be used from within the PIN file or within the Patchworks console. Do not alter the value of these variables.

Name

Type

Description

reportWriter

Object reference

A reference to the main ReportWriter. You may add custom reports using this reference.

blockData

Object reference

A reference to the main block attribute table. This is a dynamic structure that is updated by the simulation model.

control

Object reference

An object reference to the Control object. The Control object contains methods that control the operation of the simulation model. Most of the methods in the Control object are available from the Patchworks GUI.

layers

Object reference

An object reference to the LayerList object that contains the main map legend. You may use this object reference to add additional layers to the map display.