Legion SpaceWorks R6.5.

0 User Guide

© 2001–2017 Legion® International Limited. All rights reserved.

Legion SpaceWorks™ R6.5.0 User Guide

No portion of the contents of this publication may be reproduced or transmitted in any form or by any means without the
express written permission of Legion International Limited.

We have done our best to ensure that the material in this publication is both useful and accurate. However, please be
aware that errors may exist in this publication and that Legion International Limited makes no guarantees concerning the
accuracy of the information found here or the use to which it may be put.

® The name “LEGION” is a registered Trade Mark in the United Kingdom, the United States of America, Europe and Hong
Kong for classes 9, 35 and 42.

™The name "SPACEWORKS" is a registered Trade Mark in the European Union for class 9.
Legion SpaceWorks R6.5.0 User Guide

Contents
Contents i

1: Introduction to Legion SpaceWorks 1

About this User Guide 2

Notes, tips and warnings 2

Menu instructions 2

Menu items 2

Left and right-clicking 2

Overview of Legion SpaceWorks 3

Legion Model Builder 3

Legion Simulator 4

Legion Analyser 4

64-bit Version of SpaceWorks 4

2: Installing Legion SpaceWorks 5

Recommended specifications 6

Installing Legion SpaceWorks 7

Quick-start instructions 7

Step-by-step instructions 7

Starting Legion SpaceWorks 9

Licensing 10

Workstation Licences 10

Network Licences 10

Activating a Workstation Licence 10

Activating a Network Licence 12

Network Licences: Using and Finding 14

Checking Licence Details 15

Detaching a Network Licence 16

Returning a Detached Network Licence 17

Checking for updates 19

© 2001–2017 Legion International Ltd i

Legion SpaceWorks R6.5.0 User Guide

3: Legion Concepts 20

Accessible Space 21

Entities and populations 22

Entities 22

Entity Types 22

Supply Types 22

CAD 23

Spatial Objects 24

Activity Objects 24

Analysis Objects 24

Layers 24

Data Profiles 25

Principles of movement in Legion simulations 26

Navigation and ‘minimum cost’ 26

Corners and edges 27

Automated blockage detection 27

Final Destinations 28

Entities React to Temperature, Visibility and Toxicity 28

Showing vehicles in simulations 28

4: Using CAD 30

Preparing a CAD plan 31

Cleaning a CAD plan 31

Checking for Free-standing Objects 32

Importing a CAD plan into the Model Builder (DGN, DWG, DXF) 33

Importing files 33

Exporting CAD files 35

Drawing CAD objects 36

Transferring Entities between floor plans 38

IFC (industry file format) CAD 40

Some notes on IFC terminology 40

Importing IFC CAD 40

ii
Legion SpaceWorks R6.5.0 User Guide

Placing IFC CAD layers into the SpaceWorks model 46

5: Final Destinations 49

What is a Final Destination? 50

Importing Final Destinations 51

Assigning Final Destinations 52

6: Change Logs 53

Viewing a Change Log 54

Exporting the Change Log 55

7: Managing Model Projects 56

Opening the Legion Project Manager 57

Creating a new managed project 58

Adding a model file to a managed project 59

Opening files from within the Legion Project Manager 60

Changing a model file in a managed project 61

Removing a model file from a managed project 62

Checking the location of files in a managed project 63

Adding a new scenario to a project 64

Adding a new file to a scenario 65

Removing files, scenarios and versions from a managed project 66

Adding a new version to a managed project 67

Saving a managed project 68

Refreshing a managed project 69

Exporting Legion Project Manager information 70

8: Model Builder Basics 71

About the Model Builder 72

The Model Builder interface 73

Model Builder Components 74

Workspace 74

Changing the workspace background colour 74

Main Menu Bar 74

© 2001–2017 Legion International Ltd iii

Legion SpaceWorks R6.5.0 User Guide

Toolbars 74

Object Directory 75

Output Bar 77

Status Bar 79

The Layers Directory 79

Arranging windows 79

Moving and Hiding Components 80

Basic Model Builder tasks 82

Starting the Model Builder 82

Opening a new model 82

Saving a model 82

Model File Properties 82

Backups of models 84

Auto-saving your work 84

Auto-recovering backup files 85

Importing a CAD file 87

Closing a model 87

Opening an existing model 87

Setting Model Properties 87

Detecting blockages automatically 88

Panning and zooming 89

Regenerating objects after zooming 90

Saving the current view 90

Checking for errors 90

Viewing Accessible Space 92

Printing a model 92

Exporting a model as an ‘ora’ file 92

Exporting a model for use with FDS 93

Defining Analysis Project Settings 94

Using Help 95

Sending feedback 95
iv
Legion SpaceWorks R6.5.0 User Guide

9: Entity and Supply Types 96

About Entity and Supply Types 97

Creating and editing Entity Types 98

Creating an Entity Type 98

Applying a User-defined Speed Profile 100

Creating an Entity Size Profile 101

Creating a Luggage Size Profile 103

Editing an Entity Type 103

Creating and editing Supply Types 104

Creating a Supply type 104

Editing a Supply Type 105

Exporting and Importing Supply Types 106

Creating Entity Colour Schemes 106

10: Demand—Data and Profiles 108

About Demand Data 109

About Data Profiles 110

A note on Availability Profiles 110

Demand: Origin–Destination Matrices & Arrival Profiles 112

Creating an OD matrix 112

Exporting the current OD Matrix for auditing purposes 113

The Data Template Spreadsheet 115

What happens in the Model Builder after import? 115

The Data Template spreadsheet 117

Entity profiles worksheet 118

Entities worksheet 119

OD matrix worksheet 120

Data profiles worksheet 122

Delay Profiles 127

Gate Control Profiles 129

Gates, Gatelines, Gate Control Profiles and Availability Profiles 132

© 2001–2017 Legion International Ltd v

Legion SpaceWorks R6.5.0 User Guide

Origin Settings worksheet 134

Creating Arrival Patterns using Frequency Based Data 137

Importing a completed template 143

Exporting a Data Template 146

Manually creating and editing Arrival, Availability, Speed and Event Profiles 147

Creating a new Arrival or Event Profile 147

Creating a new Availability Profile 148

Creating a User-defined Speed Profile 148

The Edit Data Profile dialog box 149

Entering data into a graph 150

Changing the graph view 152

Selecting entries in the graph 153

Importing data for a single Arrival or Event Profile 153

Checking and updating imported file properties 154

Cutting, copying and pasting demand data 155

Repeated pasting of data 155

Deleting demand data from a Data Profile (Arrival or Event) 156

Copying a Data Profile (Arrival or Event) 157

Renaming a Data Profile 157

Deleting a Data Profile 157

Modifying Arrival, Availability or Event Profile data 158

Manipulating demand data (Arrival, Availability and Event Profiles) 159

Applying Pulse 159

Applying Pulse to Availability Profiles 160

Applying Spread 160

Applying Interpolation 162

Applying Random Noise 164

Applying Split 165

Scenarios 167

Base Scenario 167

Scenario Manager 167

vi
Legion SpaceWorks R6.5.0 User Guide

General remark on scenarios 169

Exporting models as ‘ora’ files 170

Exporting Model Data 171

11: Spatial Objects–Basics 172

Types of Spatial Object 173

Activity Objects 173

Analysis Objects 174

The form of Spatial Objects 176

How Focal Segments work 176

Drawing and placing Spatial Objects 179

Placing a Focal Segment 179

Drawing Spatial Objects using commands 181

Deleting Spatial Objects 182

The size of Spatial Objects 182

Entities’ scanning ability 182

Visibility-based Analysis Zones 182

Setting the parameters of Spatial Objects 187

Grouping Spatial Objects 188

Target Parameters 188

Refining the drawing of Spatial Objects 189

Using the Grid 189

Using Snaps 189

Selecting Spatial Objects 190

Cutting, copying and pasting Spatial Objects 191

Moving Spatial Objects 192

Changing the shape of Spatial Objects 193

Rotating Spatial Objects 194

Scaling Spatial Objects 195

Trimming Spatial Objects 195

Creating a Rectangular Array 196

© 2001–2017 Legion International Ltd vii

Legion SpaceWorks R6.5.0 User Guide

Creating a Polar Array 197

Mirroring Spatial Objects 198

Measuring distances 198

Copying the geometry of Spatial Objects 199

The Find Tool 200

Editing Spatial Objects 204

Renaming Spatial Objects 205

Object Catalogues and the Object Store 206

12: Layers 207

About layers 208

Types of layer 208

Properties of layers 209

Working with layers 210

Layers Directory 210

Active Layers Toolbar 211

Adding layers 211

Changing the properties of a CAD Layer 211

CAD Layers and Availability Profiles 212

Making layers active 213

Selecting a target for the Partition Layer 213

Duplicating layers 213

Cutting, copying and pasting layers 214

Deleting layers 214

Moving and copying objects to other layers 214

Moving and copying to layers using the Command line 214

Dragging and dropping objects into other layers 215

Layer Views 215

Loading older model files 216

13: Linking and Filtering 217

Linking 218

Linking methods 219

viii
Legion SpaceWorks R6.5.0 User Guide

Link by Percentage Weighting 219

Link by Entity Type 221

Link by Entity Choice 221

Link by Final Destination 222

Link operations 224

Adding a link 224

Adding several links at once 225

Editing a link 226

Deleting links 226

Copying links from another object 226

Copying links to another object 227

‘Stealing' links 228

Inspecting links 229

Filtering 231

Specifying filter settings 231

Creating Named Filters 233

Viewing Links, Target Filters and Final Destinations 234

Specifying how Links, Target Filters and Final Destinations are drawn 234

14: Conditions in Models 236

About Conditions 237

Setting up Conditions 238

Restrictions 240

Creating Condition Objects 241

Exporting Conditions 242

Importing Conditions 243

15: Spatial Objects–in Detail 244

About Spatial Object parameters 245

Comprehensive guide to Spatial Objects 246

Entrances 246

Setting Entrance parameters 246

© 2001–2017 Legion International Ltd ix

Legion SpaceWorks R6.5.0 User Guide

Exits 247

Populated Zones 250

Evacuation Zones 252

Pre-movement settings 254

Evacuation Zone Summary 255

Level Exits and Level Entrances 256

Stairs 259

Escalators 263

Gates 268

Entity Behaviour Modification Options 272

Delay Points 273

Queues 278

Queue Groups 280

Waiting Zones 283

Direction Modifiers 285

Focal Nodes 288

Drift Zones 289

Focal Drift Zones 293

Route Guides 299

Mesoscopic Transition Zone 300

Multipath Zone 303

Creating Group Objects 305

16: Legion Simulator–Basics 311

About the Simulator 312

Starting the Simulator 312

The Simulator interface 313

Simulator components 314

Simulator viewing window 314

Main Menu Bar 314

Toolbars 314

Object Directory 314

x
Legion SpaceWorks R6.5.0 User Guide

Output Bar 315

Status Bar 316

Playback toolbar 316

Timeline 316

Layer Views 316

Arranging windows 316

Moving and Hiding components 316

Playing back a simulation 317

Opening a model for simulation 317

Choosing a rendering engine 317

Setting display preferences 318

Playing a simulation 318

Showing vehicles in the Simulator 319

Specifying the Simulation Seed 320

Recording ‘res’ and ‘avi’ files 321

Logging playback information 321

Panning and zooming 322

Tracking Entities 322

Setting the length of Entity Trails 323

Viewing Entity details 324

Increasing simulation speed 324

Saving the current view 325

Printing views of a simulation 325

Using Help 325

Sending feedback 325

17: Simulator Timeline 326

About the Timeline 327

Timeline components 328

Playback toolbar 328

Time-track 328

© 2001–2017 Legion International Ltd xi

Legion SpaceWorks R6.5.0 User Guide

Time-pointer 329

Tracks and Events 329

Playing and recording using the Timeline 329

Default Tracks and Events 330

Track control icons 330

Changing the position and height of tracks 330

Setting Track properties for Record .AVI and .RES tracks 330

Changing Track properties 334

Deleting tracks 334

Defining Events 335

Record .RES events 335

Record .AVI events 337

Overlapping events 338

Specifying the colour of ranged events 338

Changing event properties 339

Deleting events 339

Moving and docking the Timeline 339

Closing the Timeline 339

19: Maps and Ranges 340

About Maps and Value Ranges 341

Standard maps 342

Cumulative High Density Map 342

Cumulative Max/Mean/Min Density Maps 342

Evacuation Time Map 342

Space Utilisation Map 342

Underground Cumulative High Density (15 mins) Map 343

Underground Cumulative High Density (60 mins) Map 343

Underground Cumulative Mean Density (15 mins) Map 343

Underground Cumulative Mean Density (60 mins) 343

Analysis options for Underground Maps 344

Viewing maps as part of a simulation 345

xii
Legion SpaceWorks R6.5.0 User Guide

Custom Maps 347

Map parameters 347

Value and Colour Ranges 350

Colour Ranges 350

Map Exclusions 352

Creating a custom map 353

Environment Maps 355

Custom ranges 357

Creating a custom Colour Range 357

Creating a custom Value Range 357

Creating a Weighted Value Range 358

Underground Cumulative High Density Entity Colour Scheme 359

Deleting, renaming and copying Colour and Value Ranges 359

Exporting Colour and Value Ranges 359

Importing Colour and Value Ranges 359

Using Alternative Value Ranges 361

Overlapping Zones 362

Setting the map resolution 363

Saving the current view 364

Saving all maps 365

Printing a map 366

Deleting, renaming and copying maps 367

18: Legion Analyser–Basics 368

About the Analyser 369

Basic concept behind the Analyser 369

Analysis questions 370

Legion Viewer files 371

Starting the Analyser 371

The Analyser interface 372

Analyser components 373

© 2001–2017 Legion International Ltd xiii

Legion SpaceWorks R6.5.0 User Guide

Object Directory 373

Toolbars 373

Main Menu Bar 373

Analysis viewing window 373

The Layers window 373

Graph Windows 373

Output Bar 373

Playback toolbar 375

Timeline 375

Status Bar 375

Arranging windows 375

Moving and Hiding components 375

Upgrading Results Files 376

Upgrading Results Per Project 376

The Results Upgrade Tool 376

On-line and off-line analyses 379

Choosing between on-line and off-line analysis 379

On-line analysis 379

Off-line analysis 381

Playing simulations 383

Choosing a rendering engine 383

Setting display preferences 383

Playing a simulation 384

Logging playback information 385

Showing vehicles in the Analyser 386

Simulation Seed 386

Tracking Entities 386

Setting the length of Entity Trails 387

Creating Entity Colour Schemes 388

Viewing Entity details 390

Increasing simulation speed 391

xiv
Legion SpaceWorks R6.5.0 User Guide

Saving the current view 391

Printing a view of an analysis 392

Finding Objects in the simulation 392

Renaming objects in the Analyser 392

Working with Analyser files 393

Auto-saving your work 393

Checking for errors 393

Saving an analysis file (‘ana’) 393

Backups of Analyser files 393

Opening an existing analysis file 394

Ana file properties 394

Changing project files (model and data) 394

Using Help 394

Sending feedback 394

20: Analyses and Graphs 395

About analyses 396

Fundamentals of Legion analyses 396

Analysis metrics 396

Additional Legion metrics 397

Journey Time metrics 397

Analyses: metrics, objects, and outputs 397

Showing or hiding Conditional Analyses and Graphs 399

About Analysis Objects 400

Drawing and placing Analysis Objects 401

Visibility-based Analysis Zones 402

Setting up analyses 407

Deleting, renaming and copying analyses 408

Automated flow-rate analyses for Stair and Escalator objects 408

Journey Time and Generalised Journey Time reports 410

JT and GJT Reports 411

© 2001–2017 Legion International Ltd xv

Legion SpaceWorks R6.5.0 User Guide

GJT: Global Weightings 413

The size of Journey Time files 414

‘GJT Summary’ tab on the Output Bar 415

Generalised Journey Time Zones 416

About graphs 419

Line graph 420

Column graph (histogram) 420

Stacked column graphs (100% and Values) 421

Viewing graphs 421

Saving graphs 422

Purging invalid graphs 423

Customising graphs 424

Changing the Titles of a graph 424

Changing the Fonts settings of a graph 425

Changing the Appearance settings of a graph 425

Creating a new custom graph 425

Changing the Data Series of a graph 426

Loading a graph from a csv file 428

Exporting Legion Viewer files 428

21: Analyser Timeline 430

About the Timeline 431

Playing and recording using the Timeline 431

Default Tracks and Events 433

Analyser Tracks 434

Setting Analyser 'Record .RES' and 'Record .AVI' Track Properties 434

Record .AVI events 436

Adding Tracks to the Timeline 438

Track control icons 438

Status icons 438

Changing the position and height of tracks 438

Duplicating tracks 438

xvi
Legion SpaceWorks R6.5.0 User Guide

Deleting Tracks 439

Track Properties 439

Defining Events 442

Maps track events 442

Graphs track events 445

Screen Camera track events 445

Record .RES track events 448

Adding a Record Entity Positions event 449

Overlapping events 449

Selecting and moving instantaneous events 450

Specifying the colour of ranged events 450

Deleting events 450

Changing event properties 450

Setting the current time 450

Using Time Marks in Off-line simulations 450

Moving and docking the Timeline 451

Closing the Timeline 451

22: Advanced Filtering 452

About advanced filtering 453

Principles of advanced filtering 453

Entering advanced filters 453

The filter control boxes 454

Entering a filter using the control boxes 456

Typing an advanced filter directly 456

23: Desire Plots and Desire-Line Diagrams 458

Creating Desire Plots 459

Starting Desire Line Diagram generation 461

24: Object Catalogues and the Object Store 463

About Object Catalogues and the Object Store 464

The Default Catalogue 464

© 2001–2017 Legion International Ltd xvii

Legion SpaceWorks R6.5.0 User Guide

Creating a Catalogue 464

Making Catalogues Available 465

Adding Objects to a Catalogue 466

Using Stored Objects 467

Removing Stored Objects 469

Importing and Exporting 470

Object Template Catalogue 472

25: Batch Runs 474

Simulator batch runs 475

Defining batch output settings 475

Setting up a Simulator batch run 476

Analyser batch runs 477

Setting up an Analyser batch run 477

Analysing different schemes using multiple Timelines 478

Appendix: SpaceWorks Commands 480

Index 483

xviii
Legion SpaceWorks R6.5.0 User Guide

1: Introduction to Legion SpaceWorks

In this chapter
Legion SpaceWorks Release 6 comprises five main Legion applications: the Model Builder, the
Simulator, the Analyser, the Legion Viewer and Legion 3D. Legion Viewer and Legion 3D have
their own separate user guides. There is also an additional standalone application for users of
SpaceWorks R5 and later: the Results Upgrade Tool. This guide is for Release 6.5.0 (2017).
This section covers the following topics:
● About this User Guide
● Overview of Legion SpaceWorks

© 2001–2017 Legion International Ltd 1

Legion SpaceWorks R6.5.0 User Guide

About this User Guide

This guide is designed to provide additional support to those who have already received train-
ing for Legion SpaceWorks.
The sections are arranged logically to follow the progress of a Legion SpaceWorks project
from early planning to model building, simulation and analysis.

Notes, tips and warnings

Throughout this guide, notes, tips and warnings appear. These are designed to draw your
attention to additional information, time-saving activities and those occasions where an action
may have serious consequences or produce errors.
Look out for the following icons:

Note

Tip

Warning

Menu instructions
The guide uses chevrons in place of wordy instructions on how to select menu options. For
example, the instruction:
1. From the View menu, select Toolbars and then Customise
is written as:
1 Select View > Toolbars > Customise

Menu items
Named menu items within instructions are emphasised in bold, as in the examples above.
When you need to select specific options or enter specific text as part of a procedure, these
are also printed in bold.

Left and right-clicking

The instruction to “click” always refers to clicking with the left-hand mouse button; when you
need to use the right-hand mouse button, instructions always specify to “right-click”.

2
Legion SpaceWorks R6.5.0 User Guide

Overview of Legion SpaceWorks

Legion SpaceWorks comprises five main applications:
● Model Builder
● Simulator
● Analyser
● Legion Viewer
● Legion 3D
In combination, these applications enable you to simulate pedestrian movement within a
defined space, such as a railway station, sports stadium, airport, tall building, piazza, trans-
port node or any place where people gather.
The applications achieve this by simulating the movement of pedestrians in a quantitatively
verifiable manner, taking into account how individuals interact with each other and with the
physical obstacles in their environment.
As a Legion software user, you can perform virtual experiments on the design or operation of
a site and assess the impact of different physical designs or levels of pedestrian demand.
You can study the impact of chance events, such as the closure of an exit or late arrival of a
train and test evacuation routes for speed and safety. The visual nature of Legion
SpaceWorks’s simulations, maps, graphs and videos make it a highly persuasive decision-
making tool.
Designers, operators and owners of sites can use Legion software to optimise the per-
formance of spaces with regard to:
● Capital planning
● Venue design
● Construction phasing
● Operations and operations planning
● Safety and evacuation
● Space utilisation
● Pedestrian experience

For users of SpaceWorks R5 and later who wish to upgrade results files ('res' files) and
Legion Viewer files prepared using earlier releases of the software, there is an additional
standalone 'Results Upgrade Tool'.

Legion Model Builder

Use this application to create an accurate model of the space you want to simulate. In the
Model Builder you can do the following:
● Import architectural drawings (CAD) that define the physical space.
● Import the pedestrian demand imposed on the space.
● Designate areas where activities such as queuing or waiting occur.
● Account for different routes.
● Link operational data to the model.
● Create 'Conditional' or 'Reporting' analyses to interrogate certain areas of a model.
● Export model files for use in the Simulator and Analyser.

© 2001–2017 Legion International Ltd 3

Legion SpaceWorks R6.5.0 User Guide

Legion Simulator
Use this application to run a simulation of how pedestrians move or circulate within the space
defined in the Model Builder. In the Simulator you can:
● Import model files.
● Playback and view the simulation.
● Record appropriate parts of the simulation as a ‘results file’ (‘res’) to be viewed and inter-
rogated in the Analyser.
● Record all or appropriate parts of the simulation as a video file for presentations.

Legion Analyser
Use this application to run a series of analyses on your simulated space. In the Analyser you
can:
● Import results files and model files.
● Play back selected parts of a recorded simulation, or run a new simulation (like in the
Legion Simulator).
● Visualise key metrics in the form of maps.
● Run detailed, specific, analyses and display the results as time series, stacked bars or his-
tograms.
● Export the analysis session as graphs, results files, video, pictures or tables for inclusion
in presentations, reports and spreadsheets.

64-bit Version of SpaceWorks

Legion SpaceWorks is available in standard 32-bit and new 64-bit versions. The new version
will only work if you have a 64-bit operating system but it does offer several advantages over
the 32-bit version.
If you do not have a 64-bit operating system, SpaceWorks 32-bit edition is suitable for many
projects. However, we recommend an upgrade to the 64-bit edition if you are developing mod-
els that place high demand on a computer’s memory resources.
The advantage of the 64-bit edition is that it can use all of the computer's available memory
rather than the more limited method used by 32-bit systems. In this way, the 64-bit version
provides significant benefits when simulating large-scale models with complex logic struc-
tures.
Additionally, the Analyser can process more memory-intensive maps and analyses at the
same time. The memory available to SpaceWorks in this version is limited only by the amount
of memory available in a computer.

To see which type of operating system a machine is using, Select Start > right-click on
Computer > Properties. The type of operating system is listed under 'System'. Please
note that the 32-bit version will run on a 64-bit computer but not vice versa.

4
Legion SpaceWorks R6.5.0 User Guide

2: Installing Legion SpaceWorks

In this chapter
Installing Legion SpaceWorks is a straightforward process. If you are familiar with installation
wizards, follow the instructions in Quick-start instructions. For more detailed instructions, see
Step-by-step instructions.
This section covers the following topics:
● Recommended specifications
● Installing Legion SpaceWorks
● Starting Legion SpaceWorks
● Licensing

© 2001–2017 Legion International Ltd 5

Legion SpaceWorks R6.5.0 User Guide

Recommended specifications
We recommend the following system setup to run Legion SpaceWorks successfully:
● Intel i5, i7, or Xeon processor of at least 3GHz
● At least 4 GB of RAM for 32 bit edition and 16GB for the 64-bit edition
● Dedicated graphics card with at least 512MB memory and full OpenGL support
● 80 GB of spare disk space on a fast (7,200 rpm or above) hard drive (to store several
large results files)
● A high-resolution monitor
● Windows 8 or 7, 64-bit operating system required for 64-bit edition of SpaceWorks
● CAD software (such as AutoCAD or Microstation) to edit CAD files before importing them
● Microsoft Excel 2007 or later to enable data file input SpaceWorks supports all Excel file
formats, including 'xlsx' and 'xlsm')

6
Legion SpaceWorks R6.5.0 User Guide

Installing Legion SpaceWorks

If you are familiar with software installation wizards, follow the steps in “Quick-start instruc-
tions”. For more detailed instructions, see “Step-by-step instructions”.

Quick-start instructions
If you have a previous version of Legion installed, please remove it before installing the new
version.

To install Legion SpaceWorks:

1. Log on to your computer as a user with administrator rights.
2. Insert the Legion SpaceWorks CD into your computer’s CD drive.
The installation wizard should run automatically. If it does not, run setup.exe from the
Legion SpaceWorks CD.
3. Follow the on-screen instructions to install the software.
4. Follow the on- screen instructions for obtaining a licence from Legion International Ltd.
before using the software for the first time.

Step-by-step instructions
The following procedures guide you through the installation procedure in more detail.

Launching the installation wizard

When you insert the Legion SpaceWorks CD, the installation wizard should start automatically.
If it does not, please follow this procedure.

To launch the installation wizard:

Either
1. Select Start > Run > Browse.
2. Display the contents of your CD drive.
3. Double-click setup.exe.
4. Click OK in the ‘Run’ dialog box
or
1. Open Windows Explorer.
2. Display the contents of your CD drive.
3. Double-click setup.exe.

Installing Legion SpaceWorks

Installation is a matter of following the installation wizard’s on-screen prompts.

To install Legion SpaceWorks:

1. If it does not run automatically, launch the installation wizard as described in the pro-
cedure above.
The main installation dialog box is displayed.
2. Click the Next button.
The ‘Licence Agreement’ dialog box is displayed.
3. Read the licence text carefully and if you are an authorised user, select I accept the
terms in the licence agreement and Click the Next button.

© 2001–2017 Legion International Ltd 7

Legion SpaceWorks R6.5.0 User Guide

The ‘Customer Information’ dialog box is displayed.

4. Enter your User Name, Organization and in the Install this application for panel,
select one of these options:
◊ Anyone who uses this computer (all users)
◊ Only for me
5. Click the Next button.
The ‘Destination Folder’ dialog box is displayed.
6. If you are happy with the suggested location for installation, jump to step 7.
In the unlikely event that you want to change the location, click the Change button to dis-
play the ‘Change Current Destination Folder’ dialog box. Navigate to the new destination
and click OK to return to the ‘Destination Folder’ dialog box.
7. Click the Next button.
The ‘Ready to Install’ dialog box is displayed.
8. Click the Install button to start the installation. Depending on the specification of your
computer, installation should only take a few seconds. When the process is complete, the
‘Installation Completion’ dialog box is displayed.
9. Click the Finish button to exit the installation wizard.

8
Legion SpaceWorks R6.5.0 User Guide

Starting Legion SpaceWorks

Now that you have installed Legion SpaceWorks, each of the applications is available from the
Windows Programs menu. As an example, the following procedure shows you how to start the
Legion Model Builder from within Legion SpaceWorks.

To start the Model Builder:

1. Select Start > All Programs > Legion International > Legion SpaceWorks >
Model Builder.
The Model Builder application starts.
When you start a new Legion application for the first time, the Legion Licensing Utility is
launched. See Licensing for full instructions on requesting and loading licences.
When starting a module, SpaceWorks automatically checks to see if any software updates are
available. If there are, this message is displayed:

To download the updated version, click the link, Click here to visit www.legion.com...
To read about the latest version, click the link, Click here to see the release notes...
To stop this message appearing again, click the box labelled Don't tell me at startup
unless...

© 2001–2017 Legion International Ltd 9

Legion SpaceWorks R6.5.0 User Guide

Licensing
Legion SpaceWorks uses a system called 'Sentinel HASP', which can issue two types of
licence: 'workstation licences' and 'network licences'. The type of licence you use depends on
decisions made when purchasing Legion software and services.

Due to security issues, HASP licensing will not work correctly if you are running debugging
software on the same computer. As a consequence, Legion applications will not run and a
'debugger error' message will be displayed. To avoid this, please do not run Legion soft-
ware and debugging software at the same time on the same machine.
The following topics cover the different types of licences and how to install and use them.

Workstation Licences
A workstation licence enables you to run Legion software on a single designated machine. If
you want to use this licence on a different machine, you must contact Legion and request that
we move the licence for you.

Network Licences
A network licence is one that belongs to a pool of licences stored on your computer or on a
server attached to a network. This 'pool' contains a number of licences, each of which enables
an instance of Legion software to be run, as long as your computer is attached to and recog-
nised by the network.
For example, the licence pool may contain three Model Builder licences, four Simulator
licences and two Analyser licences. In such a case, a maximum of three instances of the
Model Builder may be run at the same time. If a member of your team attempts to start up a
fourth instance of the Model Builder, they will receive an error message because the three
licences are already being used (when a network licence is used it is temporarily 'removed'
from the pool).

An 'instance' of usage is registered each time a Legion application is run, whether they are
run on one computer or several. For example, three Model Builder licences would enable
you to open the Model Builder three times on one machine; or two times on one machine
and once on another machine; or one time each on three different machines.
Legion SpaceWorks can be installed on many computers with access to your network and your
pool of licences. When you open a Legion application on one of these machines, the software
will first look for a workstation licence on the machine. If it doesn't find one, it will search the
network for an available licence and, if it finds one, it will then start, meaning the pool of
licences has one licence fewer for as long as the application is running.
When and if you need to use Legion software on a computer that is not connected to the net-
work, you can 'detach' a licence from the available pool and 'attach' it the appropriate com-
puter; see Detaching a Network Licence.

Activating a Workstation Licence

If you are activating a 'workstation licence', follow this procedure. If you close down the
Legion Licensing Utility after you have sent your details to Legion, you will need to start it
again to activate your licence when you receive your Legion licence file.

To activate a workstation licence:

1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.
The following dialog is displayed (it won't contain any licence details the first time you
open it).

10
Legion SpaceWorks R6.5.0 User Guide

2. Click the Export Details button.

The 'Save As' dialog is displayed.
3. Save the suggested file in a convenient location, retaining the default name of 'status.lls'.
4. Email the file as an attachment to [email protected].
Legion will email a licence file (extension '.lic') to you, which you can use to load your
licence or licences.
5. When you receive the 'lic' file, save it in a convenient location.
6. Click the Activate or Update Licence button (you may need to re- open the Legion
Licensing Utility).
7. From the 'Open' dialog, navigate to where the 'lic' file is stored, select it and click Open.
Your licence will load and all licence keys will be entered into the Licensing Utility. Note
that the 'Availability' column indicates that your licences apply to your 'local' machine
only.

© 2001–2017 Legion International Ltd 11

Legion SpaceWorks R6.5.0 User Guide

Activating a Network Licence

If you are activating a 'network licence' (actually a pool of licences, depending on your pur-
chase agreement), follow this procedure. If you close down the Legion Licensing Utility after
you have sent your details to Legion, you will need to start it again to activate your licence
when you receive your Legion licence file.
When activating a network licence, you can choose to store the licence in one of two
places:either on a separate server on the network or on a computer that will also be used to
run Legion SpaceWorks.
In the former case, you only need to install the Licensing Utility on the server (this install pro-
gramme is called Standalone Licence Server.exe and Legion will provide you with access to it
after purchase); if you are storing the licence on a computer for general use, you should
install the whole of Legion SpaceWorks.

If you install on a 'regular' computer, that computer must be connected to the network at
all times for other network users to run SpaceWorks. If you have any doubts, it's probably
best to install the network on a server instead.
This procedure assumes that you have either installed the Legion Licensing Utility on a server
or have installed Legion SpaceWorks on a computer you intend to run SpaceWorks on.

To activate a network licence:

1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.

12
Legion SpaceWorks R6.5.0 User Guide

The Licensing Utility dialog is displayed (it won't contain any licence details the first time
you open it).

2. Click the Export Details button.

The 'Save As' dialog is displayed.
3. Save the file in a convenient location, retaining the default name of 'status.lls'.
4. Email the file as an attachment to [email protected].
Legion will email a licence file (extension '.lic') to you, which you can use to load your
licence or licences.
5. When you receive the 'lic' file, save it in a memorable location.
6. Click the Activate or Update Licence button (you may need to re- open the Legion
Licensing Utility).
7. From the 'Open' dialog, navigate to where the 'lic' file is stored, select it and click Open.
Your licence will load and all licence keys will be entered into the Licensing Utility. Note
that the 'Availability' column indicates that the licences for Legion products are on the 'net-
work' and also available on the current 'local' machine.

© 2001–2017 Legion International Ltd 13

Legion SpaceWorks R6.5.0 User Guide

Network Licences: Using and Finding

Once the pool of network licences has been set up as described in Activating a Network
Licence, anyone with a computer connected to the network should be able to use Legion
SpaceWorks as long as there are licences available for them to use (that is, as long as all the
permissible instances are not already in use).
If for some reason a machine cannot find a network licence, we advise you to follow this pro-
cedure.

You may also need to do this if you are connecting over a VPN.

To find a network licence manually:

1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.
2. Click the Advanced button.
The 'Sentinel HASP Admin Control Center' web page is displayed.
3. From the left-hand menu, select Configuration.
The 'Configuration' page is displayed.

14
Legion SpaceWorks R6.5.0 User Guide

4. From the top menu, select Access to Remote Licence Managers.

5. Uncheck the box labelled 'Broadcast Search for Remote Licenses' and, in the box labelled
'Specify Search Parameters', type the IP address of the computer on which the pool of
licences is stored.
6. Click Submit.
7. Wait for five minutes for your changes to take effect.
8. Close down the web page. Your computer will now find the licence.

Checking Licence Details

Should you need to check your licence details, you can do so using the 'HASP Admin Control
Center' web page, which contains many useful tools and lots of information about your current
licences, features and services.

To check your licence details:

1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.
2. Click the Advanced button.

© 2001–2017 Legion International Ltd 15

Legion SpaceWorks R6.5.0 User Guide

3. The 'Sentinel HASP Admin Control Center' web page is displayed (you need an Internet con-
nection and browser).
The following diagram indicates the most useful features of the web page.

Detaching a Network Licence

When you need to use one of your network licences on a computer that will be disconnected
from your network (for example, if you need to use Legion software on a laptop away from
the office and the network), you need to temporarily move one of the licences from the net-
work to the computer. This process is known as 'detaching'.
There are two stages to this process. The first procedure ('To enable the detaching of licences
on your computer') only needs to be done the first time you need to detach a licence for use
with a particular machine. The second procedure ('To detach a licence') must be done each
subsequent time you want to detach a licence for use).

Both procedures must be completed before disconnecting the computer from the network.

To enable the detaching of licences on your computer:

1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.
2. Click the Advanced button.
The 'Sentinel HASP Admin Control Center' web page is displayed.

16
Legion SpaceWorks R6.5.0 User Guide

3. From the left-hand menu, click Configuration.

4. Click the tab labelled 'Detachable Licences'.
5. Check the option labelled 'Enable Detaching of Licences'.
6. Click Submit to save your changes.
You can now follow the next procedure.

To detach a licence:
1. Select Start > All Programs > Legion International > Legion Licensing Utility.
2. Click the Detach Licence button.
The 'Detach Licence' web page is displayed.
3. Select one or more licences from the 'Application' column.
4. Click Detach to display the expiry date calendar.
5. Find the date on which you would like to return the licence to the network pool and click to
highlight it.
6. Click OK to close the dialog and return to the Licensing Utility. The licences you detached
will now be highlighted with green key icons to show that they are local, rather than net-
work, licences.
You have now detached a licence from the pool and attached it to your local machine. It will
work up until the end of the day you specified when detaching.

Returning a Detached Network Licence

Usually a detached licence will return to the network pool at the end of the day specified when
it was detached (see Detaching a Network Licence). If you want to return it to the pool before
the expiration date, follow this procedure.

To return a licence:
1. Select Start > All Programs > Legion International > Legion Licensing Utility >
Legion Licensing Utility.
2. Click the Return Licence button.
The 'Return Licence' dialog is displayed and lists the detached licences you may wish to
return.

© 2001–2017 Legion International Ltd 17

Legion SpaceWorks R6.5.0 User Guide

3. Select one or more of the licences and click Return to close the dialog and return to the
Licensing Utility.
4. You have now returned the licences to the network and they are highlighted with a yellow
key icon.

18
Legion SpaceWorks R6.5.0 User Guide

Checking for updates

When starting a module (Model Builder, Simulator, Analyser, Legion 3D), SpaceWorks auto-
matically checks to see if any software updates are available. If there are, this message is dis-
played:

● To download the updated version, click the link, Click here to visit www.legion.com...
● To read about the latest version, click the link, Click here to see the release notes...
● To stop this message appearing again, click the box labelled Don't tell me at startup
unless...
You may, however, wish to check for updates manually, in which case:
● Select File > Check for Updates...

© 2001–2017 Legion International Ltd 19

Legion SpaceWorks R6.5.0 User Guide

3: Legion Concepts
In this chapter
To understand how Legion software simulates the circulation of people within the space of a
model, you need to be familiar with some important concepts.
This section covers the following topics:
● Accessible Space
● Entities and populations
● CAD
● Spatial Objects
● Data Profiles
● Principles of movement in Legion simulations
● Final Destinations

20
Legion SpaceWorks R6.5.0 User Guide

Accessible Space
This is the space within a model through which Entities can move: the walkable areas within a
venue, station, building, stadium, etc. It is generated automatically by SpaceWorks when a
model file (‘lgm’) is exported as an ‘ora’ file.
In order to do so, your model must contain at least one origin object and one target object
(the simplest possible model in SpaceWorks would be one that contains a Populated Zone and
an Exit) and your model must be free of errors.
Accessible space is the area within which SpaceWorks calculates auto-navigation and creates
Focal Drift Zones when required. Any area of enclosed CAD in a model that does not include
an origin or target object will be ignored by SpaceWorks when the model is exported.

Auto-navigation automatically works out the shortest routes for Entities to follow on their
journey through a model. It can handle discontinuous accessible space, which means it
can guide Entities to intermediate targets and Final Destinations that exist on different
levels. It can also include or exclude small or free-standing objects from its calculations;
see Checking for Free-standing Objects.
In the model of a station pictured here, the accessible space for each level is shaded in grey.
You can view your model's accessible space at any time in the Model Builder, Simulator and
Analyser.

© 2001–2017 Legion International Ltd 21

Legion SpaceWorks R6.5.0 User Guide

Entities and populations

Entities
The simulated people who use the space modelled in Legion are called Entities.
Entities are displayed as coloured circles whose area approximates the size of an actual ped-
estrian. The sizes of Entities vary according to their distribution and the size of their luggage.
When defining the size of Entites and their luggage you can use the sofware's built-in settings
or create your own 'Size Profiles'.
Entities of both genders are included and you can tweak the ratio of men to women. Whatever
their size, in tight spaces they can temporarily 'flux' in order to squeeze past one another
(although this is not represented visually).

Entity Types
Each Entity in a Legion model belongs to a larger group called an Entity Type. You can dif-
ferentiate Entity Types by name, colour, gender ratio, size, size of luggage, Entity Profile, and
Speed Profile. Entity and Speed Profiles reflect the personal space and speed preferences in
different terrains. Legion SpaceWorks comes with profiles based on statistical analyses of real
people in different cities and sites around the world.
There are several scenarios where creating different Entity Types is useful:
● Varying the Entity or Speed Profile to select the closest match to the walking preferences
of the population being modelled.
● Varying the size of Entities.
● Varying the size of luggage to create an appropriate mix.
● Varying the gender ratio for certain types of event.

Supply Types
A Supply Type is a combination of Entity Types. For example, you may need to populate a
model with a mix of:
● Commuters and tourists.
● Commuters heading for different lines or in different directions.
● Tourists carrying differing sizes of luggage.

22
Legion SpaceWorks R6.5.0 User Guide

CAD
Architectural drawings using CAD (Computer Aided Design) consist of lines, text, numbers,
shapes and other geometrical objects. For the purposes of Legion model building, only the
lines and shapes that are true obstacles to pedestrian movement are strictly relevant.
For example, hatching marks or lettering in a CAD drawing will act as obstacles to Legion Entit-
ies if they are imported into the Model Builder and retained during a simulation. Removing
these extraneous lines and marks (or moving them to a different layer designed to carry such
details purely for presentation purposes) is called 'cleaning' a CAD plan and the resulting plan
is said to have been 'pedestrianised'. CAD that retains the original architectural lines can be
used for presentation purposes after a simulation has been successfully run. This type of CAD
is known as 'Presentation CAD'. For more information on CAD plans, see 4: Using CAD.
Any information in the CAD drawing about the walking surface that would normally be
expressed with lines (for example staircases, escalators or ramps) must be communicated to
Entities using Spatial Objects in place of the original CAD lines.

The types of CAD that can be imported into SpaceWorks fall into two camps: first, 'dxf',
'dwg' and ''dgn' formats; second, the 'ifc' format. 'Ifc' format CAD is more complex and
involved and is treated separately in this guide. See IFC (industry file format) CAD for
more information.

© 2001–2017 Legion International Ltd 23

Legion SpaceWorks R6.5.0 User Guide

Spatial Objects
Spatial Objects are the core of a Legion model's logic. Entities are introduced into models by
Entrances, Populated Zones or Evacuation Zones and receive contextual information from
other Spatial Objects placed within the model. This information is used by the Entities to under-
take activities such as waiting or queuing, or to adapt their walking preferences to changing
contexts (e.g. stairs, escalators or waiting areas).
Within Legion SpaceWorks there are three types of Spatial Object:
● Activity Objects
● CAD Objects
● Analysis Objects
Spatial Objects are discussed at length in 15: Spatial Objects–in Detail , but some brief defin-
itions follow. For CAD Objects see Drawing CAD objects.

Activity Objects
Activity Objects provide origins, targets and final destinations for Entities. They may also
enable Entities to carry out certain activities, such as waiting, queuing and using facilities. As
well as providing structure and rationale for Entities, they can also supplement Legion's auto-
navigation system to correct anomalies, such as unrealistic congestion. Within a model they
sit in an Activity Object Layer.

Analysis Objects
Analysis Objects (Zones, Lines and Poly-lines) are used most widely and powerfully in the Ana-
lyser but they also exist within the Model Builder. In the Analyser, they are used to identify
areas of a simulation that you want to 'interrogate' analytically, using a wide range of met-
rics. These kinds of analyses are known as 'Reporting' analyses'
In the Model Builder, Analysis Objects are used in setting up 'Conditions', which enable you to
model operational measures taken in response to over-crowding or other dynamic events.
These kinds of analyses are known as 'Conditional' analyses'. For an explanation of Condi-
tions, see 14: Conditions in Models and for more information on Analysis Objects within the
Analyser, see About Analysis Objects.

While it is usual to set up 'Reporting' analyses in the Analyser, you can do so in the Model
Builder. When your model is eventually opened in the Analyser, these analyses will
already be there and will not need to be added.

Layers
Layers enable you to manage objects in your model and analysis files. Models can rapidly
become complex and it is helpful to arrange different features of a model into different layers.
This feature enables you to view, or work on, the layer of your choice rather than having to
tackle the whole model at once. For further information about layers, please see 12: Layers.

24
Legion SpaceWorks R6.5.0 User Guide

Data Profiles
In a Legion model, Data Profiles describe the rate, manner and time at which various sim-
ulated activities take place. Entities appear as specified in Arrival Profiles; progress at speeds
defined by a Speed Profile; are delayed at facilities according to Delay Profiles; respond to
scheduled events in line with Event Profiles; and may leave the model through a constrained
exit at a rate dictated by an Exit Profile. Objects within a model may also be ‘turned on' or
'off’ by Availability Profiles.
You can define and import these profiles using the Data Template spreadsheet or you can spe-
cify them at any point within the model building process. Data Profiles are discussed in detail
in 10: Demand—Data and Profiles . They are also central to defining Scenarios, which are
covered in the same section.

© 2001–2017 Legion International Ltd 25

Legion SpaceWorks R6.5.0 User Guide

Principles of movement in Legion simulations

Most movement decisions in Legion SpaceWorks can be made by the Entities themselves as
part of Legion's 'Auto-navigation' system. However, your modelling choices influence, sup-
plement and sometimes override important aspects of Entity decision making. Understanding
the principles governing navigation and the different ways of interacting with them is there-
fore essential to building good quality models.
Because Legion is a true microscopic model, crowd patterns emerge as a result of interactions
between Entities. Your main goal should therefore be to provide appropriate information (no
more or less than is realistic) to the Entities so they can make good quality decisions.

Navigation and ‘minimum cost’

The process by which Legion SpaceWorks calculates and assigns the movements of Entities is
called 'Auto-navigation'. This does not require manual intervention by modellers once a model
is ready to simulate (in rare instances, you may wish to override auto-navigation; see Setting
Model Properties).As long as a model is free of errors and all Entities have been assigned tar-
gets or Final Destinations, auto- navigation will take care of their movement through the
model.
In calculating Entity movements, Legion SpaceWorks uses the concept of 'minimum cost’
(which can also be expressed as ‘maximum utility’) as the cornerstone of pedestrian logic.
Entities attempt to minimise their personal dissatisfaction when choosing their next step. Dis-
satisfaction is caused by physical and psychological factors that degrade the quality of their
journey. The following three factors contribute to an Entity's overall experience of 'dis-
satisfaction':
● Frustration – having to slow down in congested spaces.
● Inconvenience – the degree to which an Entity must divert from its preferred shortest dis-
tance.
● Discomfort – the perceived lack of adequate personal space.
Navigation decisions are made at three levels:
● Strategic – choice of target
● Tactical – route selection and macro-navigation
● Local – micro-navigation
Choice of target is the process of translating an Entity's objectives (such as ’to leave the
venue’, ’to buy a ticket’) into targets (such as ’exit’, ’ticket machine’). In many cases, there
are multiple ways in which an objective can be achieved and you express this relationship by
specifying a Final Destination for an Entity and by adding links to connect Spatial Objects
together as part of an itinerary. This enables Entities to 'understand' which alternatives are
available to them.
To specify how Entities choose between alternative intermediary targets, you can enable one
of four methods of linking. Whichever linking method you opt for, it is important to remember
that the assignment of a target at this stage is a starting point and does not always dictate an
Entity's final choice. Even Final Destinations can be changed en route (by Direction Modifiers).
The four linking methods you can select for Spatial Objects are:
● Link by Percentage Weighting
● Link by Entity Type
● Link by Entity Choice
● Link by Final Destination

26
Legion SpaceWorks R6.5.0 User Guide

Macro-navigation is the process whereby an Entity finds the shortest route from its current
position to its next target. This shortest route takes into account the geometry of the site and
the length of several paths are considered and compared.
An individual trajectory is the result of micro-navigation. Legion Entities have a 'perception
zone' which is adjusted dynamically and is based on instantaneous information and accu-
mulated memories.

Within this perception zone Entities assess information in order to decide their next best-step.
Their decision is influenced by: the type of area they find themselves in (the context); the
Entities and obstacles near them; their walking preferences, which are part of their profile
(their Entity Type); and their general desire to get to their target in the least dissatisfying
way.
Additionally, some Entities designated as ‘congestion avoiders may, in the course of deciding
their next step, decide to change target altogether.
As with any model, the quality of the inputs and assumptions influences the quality of the res-
ults. Where possible we encourage observation and the measurement of comparable cir-
cumstances to 'sense-check' the quality of model assumptions.

Corners and edges

During auto-navigation, Entities may need to go around corners and in this situation they are
given a target point to aim for which is offset from the corner by 50 cm. This is to ensure that
they maintain a realistic distance from the wall. The same distance is offset when Entities
pass near an edge, such as the edge of a bridge or walkway.
This target point is the position about which an Entity will try to centre itself. Please note that
this is the suggested point only and micro-navigation during high or low congestion may cause
Entities to pass further from or nearer to the edge or corner.

Automated blockage detection

For different reasons, models sometimes get blocked and a single time step can take a very
long time to complete. When this happens, the software can appear to freeze and attempts to
pause or stop playback may not be recognised. In this state there is no graceful way to pro-
ceed and you may be tempted to force the software to close down. To get around this, there is
a feature called Automated Blockage Detection (ABD) in the Simulator and Analyser. For more
information, see Detecting blockages automatically.

© 2001–2017 Legion International Ltd 27

Legion SpaceWorks R6.5.0 User Guide

Final Destinations
A Final Destination is the ultimate goal of an Entity’s journey through a model. It is usually an
Exit but can also be a Waiting Zone (in the case of stadium ingress studies, for example). In
the absence of any other routing information, an Entity will proceed through the model to its
Final Destination.
For more detailed information about Final Destinations, see 5: Final Destinations.

Entities React to Temperature, Visibility and Toxicity

Legion Entities can react to fire data and outputs from FDS software. This enables you to filter
by Environment Map data and also to set up conditions related to FDS outputs such as tem-
perature, visibility and toxicity. This means that Entities can change their activities (for
example, their speed or choice of Exit) according to fire-related factors.
For this to work, you need to create Environment Maps using Slice Files or Plot 3D files as
before. Metrics such as temperature from these maps will then be available for use as filters
and with Conditions and Analyses.
You can then introduce spatial objects, for example Direction Modifiers and Drift Zones, that
will simulate an evacuating Entity’s reaction to different conditions, such as:
● Changing route due to high temperatures
● A decrease in speed due to reduced visibility
● An exit, staircase or lift being out of use due to smoke or toxic fumes
Let’s assume you want to create a Drift Zone that causes Entities to slow down when visibility
drops below a certain point. To do so you need to first set up an Environment Map with a vis-
ibility slice file and proceed as follows.

To set up a Drift Zone with an FDS-based filter:

1. Draw and name your Drift Zone.
2. Select Modify speed by, enter 25% in the adjacent box and select Speed decreases.
3. Uncheck the box labelled 'Change direction'.
4. Click on the ‘Entity Filter’ tab.
5. Click Advanced.
6. Enter [ Visibility Map < 10 ] in the main panel.
7. Click OK.
Entities within the Drift Zone will reduce their speed by 25% if visibility at their location is less
than 10 metres.

Direction Modifiers can affect Entities when a Condition is met within a particular area,
such as smoke blocking a route. To set up such a condition, define an Analysis in the Model
Builder that measures the required metric in the area. The condition in the Direction Modi-
fier should be defined as ‘true’ when the Analysis result meets a desired threshold. For
example, visibility < than 10 m.

Showing vehicles in simulations

To display vehicles when playing back a simulation in the Simulator or Analyser, you need to
load the Aimsun XML file when opening new project files. This file contains all vehicle pos-
itions over time and enables Legion SpaceWorks to visualise traffic.
When loading project files, using the ‘Open Project Files’ (Simulator) and ‘New Project Files’
(Analyser) dialog boxes, you can now check the box labelled ‘Load Aimsun simulation result
file’, click the adjacent Browse button and navigate to the appropriate Aimsun XML file.

28
Legion SpaceWorks R6.5.0 User Guide

With vehicle positions loaded, the Simulator and Analyser can display traffic during the sim-
ulation.

© 2001–2017 Legion International Ltd 29

Legion SpaceWorks R6.5.0 User Guide

4: Using CAD
In this chapter
CAD plans are a required input for a Legion SpaceWorks model. This part of the guide
provides detailed information about the different types of CAD and how they are used.
This section covers the following topics:
● Preparing a CAD plan
● Importing a CAD plan into the Model Builder (DGN, DWG, DXF)
● Exporting CAD files
● Transferring Entities between floor plans
● IFC (industry file format) CAD

30
Legion SpaceWorks R6.5.0 User Guide

Preparing a CAD plan

CAD plans typically require editing and restructuring before they are suitable for importing
into the Model Builder; this process is termed 'cleaning' Two main types of CAD are used
within Legion SpaceWorks:
● Presentation CAD
● Simulation CAD
Presentation CAD lines provide useful contextual information about the pedestrian venue but
they are not true obstacles; examples include:
● Text
● Stair flights and landings
● Escalator landings, comb lines and work points
Presentation CAD can also provide useful reference points for object snaps when creating and
placing Activity Objects.
Simulation CAD lines represent objects that are genuine obstacles to pedestrians; examples
include:
● Walls
● Balustrades and railings
● Ticket gates
● Windows
● Door leaves
● Furniture
● Vehicles

Cleaning a CAD plan

An essential part of the CAD cleaning process is to classify CAD lines as either Presentation or
Simulation CAD and to create ‘Presentation’ and ‘Simulation’ layers accordingly.

The more CAD lines that are retained, the longer a simulation may take to run.
The following procedure is recommended for each drawing file that will be used to compile
into single CAD file for import into the Model Builder. At the end of this process you will have
prepared a drawing file that is suitable for importing into the Model Builder. It assumes that
you have access to a standard CAD drawing package.

To clean a CAD plan:

1. Save CAD files with a new name, to preserve the originals.
2. ‘Bind’ any external reference files that may be attached.
3. Orientate drawing files to the CAD programme ‘world coordinate’ system.
4. Explode all objects such as poly-lines, blocks and text.
5. Switch on all layers and delete all unnecessary objects that are neither obstacles nor use-
ful as presentation CAD.
6. Specify the drawing unit type and scale the drawing if required; units such as metres are
preferable in order to minimise the physical size of the Legion model.
7. Delete all 3D coordinate values.
8. Associate object colour properties with layer colours.

© 2001–2017 Legion International Ltd 31

Legion SpaceWorks R6.5.0 User Guide

9. Simplify complex line work as much as possible; for example, ticket gates can be reduced
to simple rectangles, furniture components can be reduced to an outline of the footprint,
etc.
10. Create new layers to contain Presentation CAD and Simulation CAD lines: five or so lay-
ers are usually enough. Assign the colour white to all Simulation CAD layers to prevent
later confusion with Legion's Spatial Objects which are distinguished by standard CAD col-
ours. Move all pertinent objects in your file into the relevant layers.
11. Ensure that Simulation CAD layers only contain lines that represent true obstacles to
Entity movement, such as walls, columns, barriers etc.
12. Purge the drawing file to remove unused items, such as block definitions and layers.
13. If your model consists of multiple floor plans derived from separate CAD files, con-
solidate all related plans into a single CAD file. Orientate and arrange the floor plans in a
logical manner that assists understanding of the venue and makes best use of available
screen area.
14. Once the floor plans have been arranged, move all objects so that the centre of the con-
solidated plans is located at, or close to, the 0,0 CAD origin point.
15. Save the file.

Checking for Free-standing Objects

At any point in the modelling process you can quickly search for and select any CAD rep-
resenting free-standing objects in your model. You may have forgotten to remove these or
you may wish to move them to a particular layer which is excluded from auto-navigation.
Such objects are easy to miss and they may adversely affect Entities' journey through access-
ible space. There are two commands which can identify these objects and move them if you
wish. The commands are 'identifyfreestandingobstacles' and 'movefreestandingobstacles'.
You will not have to type the commands in full.

To check for free-standing objects:

1. Type identify (the command bar will auto-complete the command) and press Enter.
After a moment or two any free-standing obstacles in the model are selected and high-
lighted. The Output Bar indicates how many objects were found.
2. You can now right-click to Cut, Copy or Delete these objects.

Before following the next procedure you may need to create a new CAD layer.

To move free-standing objects to another layer:

1. Type movefree (the command bar will auto-complete the command) and press Enter.
After a moment or two any free-standing obstacles in the model are selected and high-
lighted (they appear composed of dotted lines). The Output Bar indicates how many
objects were found and prompts you to 'Select additional small object CAD to move to a
new layer'.
2. Select any other small object CAD to move if required, or proceed to the next step.
3. Press Enter.
4. From the 'Move to Layer' dialog box, select the CAD layer onto which you would like to
move these objects.
5. Click OK.

32
Legion SpaceWorks R6.5.0 User Guide

Importing a CAD plan into the Model Builder (DGN, DWG,

DXF)
The following file types can be imported:
● ‘dgn’ (Microstation files)
● ‘dwg’ (AutoCAD files)
● ‘dxf’ (Drawing Interchange Format)

Importing files
To do this, you will need to have the Model Builder open.

To import a CAD file:

1. Within the Model Builder, select File > Import CAD.
The ‘Open’ dialog box is displayed.
2. Browse to the CAD file you want to import, select it and click Open.
If there are any types of CAD object that SpaceWorks doesn’t recognise, the ‘Incompatible
CAD Detected’ window is displayed. This lists all incompatible CAD elements by type and
number.
3. Check the contents of the window and click OK to move on.
The ‘Layer Selection’ dialog box is displayed.

This lists all the layers available for import and enables you to select and de-select layers
for inclusion as part of the import and also for inclusion in the eventual simulation. The lay-
ers are also colour-coded:
◊ White layers contain fully supported CAD
◊ Amber layers contain some unsupported CAD
◊ Grey layers contain no supported CAD
◊ Blue layers are empty and contain no CAD at all

© 2001–2017 Legion International Ltd 33

Legion SpaceWorks R6.5.0 User Guide

4. For each layer you want to import, ensure that the ‘Import’ tick box is ticked. To exclude a
layer, untick the box.
5. For each layer you want to import as Simulation CAD, ensure that the ‘Simulation’ tick box
is ticked. To exclude a layer, untick the box.

A layer ticked as ‘Simulation’ will be included in the simulation you eventually run in the
Simulator or Analyser. Take care to tick only those CAD layers that contain genuine
obstacles to Entity movement.
6. For each layer that contains small objects that you would like auto-navigation to ignore
(this saves on memory and permits more accurate pedestrian movement), ensure that the
‘Auto-navigation’ box is unticked.
7. Click OK to continue with the import.
8. To import all CAD lines as black lines, check the box marked Import all CAD in black.
9. Click OK.
The CAD Import progress bar is displayed. When progress is complete, the ‘Drawing Unit-
s/Scale’ dialog box opens.
10. Ensure the Drawing units and Drawing scale settings are correct for the CAD plan being
imported.
11. Check the box marked Adjust model dimensions to fit imported geometry (this
ensures that the Legion model is large enough to contain the obstacles on your imported
plan).
12. Click OK.
The CAD file appears in the Model Builder workspace and the Object Directory and ‘Layers’
dialog box are populated with the new CAD layers and objects.
After importing CAD, make sure that the correct CAD Layer is ‘active’. See Making layers
active.

To save the imported CAD file as an ‘lgm’ file:

1. Select File > Save As.
The ‘Save As’ dialog box is displayed.
2. Select a location and type a name for the model file.
3. Select Model Files (*.lgm) in the Save as type field.
4. Click Save.
Your imported CAD is now saved as an ‘lgm’ file.

34
Legion SpaceWorks R6.5.0 User Guide

Exporting CAD files

As well as importing CAD files, you can also export the CAD elements of a model for viewing
in a CAD application. In cases where you have modified the CAD in the Model Builder, this pro-
cess saves you having to change the original CAD to match the new layout. All the CAD ele-
ments of your model are exported as either a ‘dwg’, ‘dxf’, or 'dgn' file.

To export a CAD file:

1. Within the Model Builder, select File > Export CAD.
The ‘Save As’ dialog box is displayed.
2. Enter a name for the exported file in the File name field.
3. Select either AutoCAD DWG Files (*.dwg), AutoCAD DXF Files (*.dxf), or Micro-
station DGN Files (*.dgn)in the Save as type field.
4. Click Save.

© 2001–2017 Legion International Ltd 35

Legion SpaceWorks R6.5.0 User Guide

Drawing CAD objects

Once you have imported CAD into the Model Builder, you can add CAD objects by using the in-
built CAD tools and commands. You can add CAD lines, rectangles, polygons, circles, ellipses
and arcs to your models.

Press the Esc key at any time to cancel drawing and placing an object.
You can also add CAD objects by typing commands into the Model Builder. Once you have
entered a command, follow the instructions on the Output Bar. Most instructions can be car-
ried out by typing coordinates into the Command bar or clicking into the workspace with the
mouse. All relevant commands are listed below.

Icon Name Command

Create CAD Line line

Create CAD Rectangle rect

Create CAD Polygon pline

Create CAD Circle circle

Create CAD Arc arc

Create CAD Ellipse ellipse

To draw a CAD object:

1. Click on the icon belonging to the CAD object you would like to draw (or type the appro-
priate command).
2. If you are drawing a rectangular object:
◊ Drag your cursor to define the size and shape of the object. When you are happy with
its proportions, click to complete and place the object.
If you are drawing a polygonal object:
◊ Move your cursor to the first vertex of the polygon you are drawing and click your
mouse. Now move the cursor to the next vertex of the polygon and click to place that
point.
◊ Continue for as many points as the polygon contains and to complete the shape, right-
click your mouse and select Finish (Leave Open) to place the object without closing
the gap between the first and last vertices or Close to close the gap, creating a self-
contained shape.
If you are drawing a circle:
◊ Click in the workspace to place the centre point.
◊ Drag the cursor in any direction to define the circle’s radius and click to place the
circle.
If you are drawing an arc:
◊ Click in the workspace at the start point of the arc.
◊ Click in the workspace to place the second point of the arc.

36
Legion SpaceWorks R6.5.0 User Guide

◊ Drag the cursor to define the size and position of the arc and click to place it.
If you are drawing an ellipse:
◊ Click in the workspace to place the first axis of the ellipse.
◊ Click in the workspace to place the second axis of the ellipse.
◊ Drag the cursor to define the size and position of the ellipse and click to place it.

© 2001–2017 Legion International Ltd 37

Legion SpaceWorks R6.5.0 User Guide

Transferring Entities between floor plans

Legion SpaceWorks represents space in two dimensions. However, more often than not, mul-
tiple level venues have different floors which overlap when viewed in plan.To get the best
visual outputs, it is necessary to rearrange the CAD into separate floor plans with a single CAD
layout (file) such that the different floor levels do not overlap. In cases where different floor
levels do not overlap in plan view, it is not necessary to split the CAD into different levels.
The initial task of creating multiple levels within a Legion model involves arranging the
respective floor plans during the CAD preparation stage, as illustrated in the model-ready plan
of the three-level office building shown below.

‘Level’ refers to any continuous part of a CAD plan within a Legion model: this includes
floor areas that may be located at the same physical level, for example inside and outside
the ground floor of a stadium.
Movement between floor-levels is then achieved by an instantaneous transfer of Entities from
one floor plan to another via Stairs, Escalators, or Level Exits/Level Entrance pairs (these
objects are discussed in detail in 15: Spatial Objects–in Detail).
Creating multiple levels is initially a CAD task until the Entity movement between levels is
introduced. Consider the plan of a football stand below.

38
Legion SpaceWorks R6.5.0 User Guide

The back of the stand appears to lie behind the road bordering the stadium grounds. In reality,
the rear section of the stand is directly above the ground-level concourse, which is also an
area of interest for the model. The two levels have been arranged this way for visual pur-
poses.
In terms of modelling, Entities are transferred from one level to another either by Stairs,
Escalators, or Level Exit/Level Entrance pairs. Level Exits and Level Entrances are used here
to describe the technique but Stairs and Escalators have built-in Level Exit/Level Entrance
pairs which are not visible but accomplish the task in a similar manner.
The area circled in red above is shown in detail here. The red boxes are Level
Exits and replicate the identical locations represented in the model by the
green boxes (Level Entrances) in the lower part of the stand. These reflect the
link between the upper and lower levels of the stand.
In a simulation of an evacuation of the stand, Entities leaving the back of the
stand by the red Level Exits would instantaneously re-appear in the identically
sized Level Entrances, in the same relative positions they were in on the upper
level when they were transferred. This facilitates a seamless transfer between
the two levels.
Similarly, when using Stairs or Escalators to transfer people between two
levels, a transition area (or ‘overlap’) is specified for both the lower and upper
components of the Stair or Escalator. This overlap area acts as the equivalent
of a Level Exit/Level Entrance pair and must cover an area common to both
levels.
This is how the software replicates the movement of pedestrians between dif-
ferent levels in a two- dimensional model. As a consequence, the CAD rep-
resenting the transfer area must be included in each related floor plan.
To preserve the integrity of the transfer of Entities from one level to the next,
it is important that these transfer areas are identical in size and reflect the
exact same location in space on both levels. To help achieve this, it is useful
when re-arranging the CAD to place guidelines (in a presentation-only CAD layer) to indicate
the transfer areas common to both levels.

© 2001–2017 Legion International Ltd 39

Legion SpaceWorks R6.5.0 User Guide

IFC (industry file format) CAD

'IFC' is a 3D construction-industry file format for modelling buildings and venues. It is dif-
ferent from the other CAD formats that SpaceWorks handles in that its form is designed to mir-
ror the fabric of a real building, meaning that is uses real-life elements like storeys, walls,
doors, windows, seats, and so on, rather than layers and polygons. IFC files are constructed
hierarchically along the lines of: model → storey → building elements → sub- elements.
Because SpaceWorks is a 2D programme,new import procedures are required to translate IFC
files into 2D CAD for use in Legion models.

Some notes on IFC terminology

Here is a brief guide to some of the terms you will encounter when working with IFC files and
SpaceWorks' 'IFC Import – Layer Organisation' dialogue box:
Storeys–the storeys that comprise a building.
Spaces–arbitrary regions within an IFC model, typically used to represent individual rooms
(but not always used as such). They can span one or more storeys. The original IFC designer
decides if and how spaces are organised.
Zones– arbitrarily represent regions of a model such as public or private areas, parking
areas, gardens and courtyards. As with spaces, the use of zones is at the whim of the
designer.

Most IFC models tend to work with storeys but this is not guaranteed, hence options for
spaces and zones. Within a storey/space/zone, Legion is interested in only those IFC ele-
ment types that represent obstacles or features that pedestrians can interact with. Such
elements comprise:
● Slabs–literally concrete slabs forming a floor or ceiling
● Walls–any kind of wall (standard, partition, dwarf, curtain)
● Windows–we include these because some windows are floor-to-ceiling and are effectively
walls
● Columns–typically any architectural or aesthetic supporting structure
● Doors–any kind of door
● Openings–an opening is a gap in a wall which is not filled by a door or window
● Physical objects–any kind of furniture or structure not specifically captured by other ele-
ment types, which pedestrians would consider an obstacle and/or thing to interact with
● Stair lights–the steps of a stair
● Ramp flights–the slope section of a ramp.
During the import process, you can decide to include or exclude some of these IFC elements.
The procedures for importing IFC CAD and placing it can be found here:
Importing IFC CAD
Placing IFC CAD layers into the SpaceWorks model

Importing IFC CAD

The main tasks involved with importing IFC files are done in the large and detailed 'IFC
Import – Layer Organisation' dialogue box, pictured here. There are five key panels in the dia-
logue:
● File selection
● IFC Content
● Legion Layer Organisation

40
Legion SpaceWorks R6.5.0 User Guide

● Quick Select
● CAD Colour Support
The overall procedure for importing IFC files is broken down into sequential tasks below.

Selecting the IFC CAD file and its contents

This procedure describes how to select your IFC file, check its contents, and select/deselect
content before proceeding.

To select the IFC file:

1. Select File > Import CAD > IFC.
2. In the 'Open' dialogue box, navigate to the IFC file you want to import and click Open.
After a moment's processing while SpaceWorks inspects the file, the IFC Import dialogue
box will be displayed with various settings already selected.
3. If you want to change the IFC file in question, the 'Files selection' panel at the top of the
dialogue enables you to do so. You either can type the location and file name directly into

the long input field, or you can click the Browse button and navigate to an alternative
file. In either case, click Open selected file to load the new file data.
The 'IFC Content' panel to the left of the dialogue contains the tree structure of the selec-
ted IFC file content (all the elements that are useful and relevant to SpaceWorks). In the
first instance, every relevant element is selected for import (as indicated by the white
ticks on green).

© 2001–2017 Legion International Ltd 41

Legion SpaceWorks R6.5.0 User Guide

Just above the tree structure you can read the units, dimensions and offset of the IFC plan.
The tree structure represents the hierarchical structure of IFC files (Storeys → Spaces →
Zones with all their associated elements within these categories). As with other tree struc-
tures in SpaceWorks, you can expand and shrink the branches to see or hide the available
information.
4. Click on items in the tree to select or deselect them for import. The white tick on green
indicates a selected object; a white cross on red indicates an excluded object; and a white
tick on amber indicates a category with a mixture of selected and excluded items.

42
Legion SpaceWorks R6.5.0 User Guide

5. If you would like to exclude any elements by text string, type directly into the field
labelled 'Exclude IFC containing:' and hit Return. The field is not case sensitive and you
can enter partial words. In the screenshot above, 'tank' has been entered to exclude all
elements with this word in their description.

Organising Legion Layers

This procedure describes how to create the CAD layers you will eventually import into
SpaceWorks from the IFC data. Specifically, it describes how to name layers; how to handle
small objects in layers; and how to further include or exclude layers from import, simulation
and auto-navigation. See also Quickly selecting layers below.

To create Legion layers:

1. Select one of the available option buttons adjacent to 'Create layers by:' (depending on
the contents of the IFC file, one or more of these options may be unavailable).
◊ IFC Story
◊ IFC Space
◊ IFC Zone
This step instructs SpaceWorks to create layers based on IFC's storeys, spaces or zones.
Imported layers are automatically named after storeys but if you selected 'IFC Space' or
'IFC Zone' and you would like to name your imported layers by combining storey + space
or zone name, select the option 'Story + Space/Zone name'.
2. Next, you can choose to create 'Individual layers for' specified IFC elements (slabs, walls,
doors, openings, windows, columns, seats, obstacles, stair flights, and ramp flights).
These are represented by the illustrated icons and check boxes (slabs, doors, openings,
seats, stairs and ramps are automatically selected). Check or uncheck elements as
needed. All checked elements will be imported onto their own Legion layer; all unchecked
elements will be imported onto a common Legion layer. Layers created for individual ele-
ments will have the element type appended to their name, e.g. 'Exit Garage – Ground
Level (Doors)'.

© 2001–2017 Legion International Ltd 43

Legion SpaceWorks R6.5.0 User Guide

3. You can now choose whether to create layers for 'Small objects'. Small objects are typ-
ically anything less than 1.7 metres wide, long, or across. Small objects do impede Entit-
ies, so they should be treated as obstacles, but they are excluded from auto-navigation for
reasons of efficiency and performance.
To create layers for small objects, check the box labelled 'Detect small objects, put them
on their own layer'.Layers created for small objects will have the element type appended
to their name, e.g. 'Exit Garage – Ground Level (Small)'.
Any changes and selections you make are reflected in the central list of layers to be impor-
ted:

4. You can now further include or exclude layers from import, simulation and auto-navigation
To do so, check or uncheck one or more of the labelled options:
◊ Import–check this box to import the layer; uncheck to exclude the layer from import.
◊ Simulation–check this box to include the layer in simulations but not necessarily as
part of auto-navigation; uncheck to exclude.
◊ Autonavigation–check this box to include the layer in SpaceWorks' auto-navigation
calculations (when you check this box, 'Simulation' is also checked); uncheck to
exclude.

Key: white layers in the list contain CAD, blue layers are empty, and orange layers do not
contain any IFC Slabs (to hide slabless layers from the list, making it more manageable,
check the box 'Hide layers that don't have slabs'.

CAD Colour Support

This check box enables you to display imported CAD in black or white, depending on whether
you have set your SpaceWorks background workspace as white or black.
1. Check 'Import all CAD in black' or 'Import all CAD in white'.
2. Click Next to proceed with the IFC import.
The geometry data for the layers marked for import will be loaded from the IFC file.
Depending on how complex the data is, this can take a few moments. A progress meter is
displayed:

44
Legion SpaceWorks R6.5.0 User Guide

Eventually the 'Layer Placement in the Legion Model' dialogue box is displayed.
Now go to Placing IFC CAD layers into the SpaceWorks model.

Quickly selecting layers

This 'Quick Select' panel enables you to short-cut the steps described above by making certain
key choices here rather than in the panels above it.

The check boxes and buttons affect the listed layers in the central panel above them and they
can change the contents of this list according to your selections.

When a check-box option appear to be 'greyed-out' (an indeterminate state) it means that
the status and settings of layers in the list above will not be altered during import.
For example, let's assume you want to exclude layers containing 'openings'. These elements
represent gaps in wall which Entities can pass through (like a doorway without doors). If
imported, this CAD will automatically be classed as 'presentation CAD' but you might prefer to
exclude it because there's a chance it would look like an obstruction.
To do so, you should uncheck the box marked 'Import', then type 'opening' into the 'Contains'
field and then click the Contains button. This would exclude all layers with 'Openings' in their
name from eventual imports.

To quickly select layers:

1. For each type of selection you wish to make, check or uncheck one or more of the labelled
options to define how imported layers are used:
◊ Import–check this box to import layers; uncheck to exclude the layers from import.
◊ Simulation–check this box to include layers in simulations but not necessarily as part
of auto-navigation; uncheck to exclude.
◊ Autonavigation–check this box to include layers in SpaceWorks' auto-navigation cal-
culations (when you check this box, 'Simulation' is also checked); uncheck to exclude.
2. Click one of the following buttons to apply the check-box options to:
◊ All–all layers in the file (you may wish to uncheck 'Hide layers that don't have slabs' if
you think you are missing some.
◊ With slabs–apply to all layers containing IFC 'slabs'.
◊ Slabless–apply only those layers without IFC 'slabs'.
◊ Contains:–before clicking this button, enter a text string into the adjacent field to
identify layers to import. This field is not case-sensitive and you don't need to enter
whole words to identify elements or labels. It works in the same way as the 'Exclude
IFC containing:' field described above. When you have entered your text, click Con-
tains.
After each of these actions, the list of selected layers should be updated to reflect your
choices.
3. Continue to make quick selections if you need to refine your layers further.
4. Set 'CAD Colour Support'.
5. Click Next.
The geometry data for the layers marked for import will be loaded from the IFC file.
Depending on how complex the data is, this can take a few moments. A progress meter is
displayed:

© 2001–2017 Legion International Ltd 45

Legion SpaceWorks R6.5.0 User Guide

Eventually the 'Layer Placement in the Legion Model' dialogue box is displayed.
Now go to Placing IFC CAD layers into the SpaceWorks model.

Placing IFC CAD layers into the SpaceWorks model

When you have selected which layers to import into the SpaceWorks model (see Importing
IFC CAD), the next stage is to place them into the workspace. This procedure assumes that
the 'Layer Placement in the Legion Model' dialogue box is displayed.

This dialogue contains a list of all the layers you have decided to import into your SpaceWorks
model. The 'Import', 'Simulation' and 'Autonavigation' options cannot be changed at this
point. The first column indicates the 'Status' of each layer: red 'Pending' means the layer has
not yet been placed; green 'Placed' means the layer has been placed.

To place layers into the SpaceWorks model:

1. Select a drawing style for the CAD you are about to import with your layers:
◊ Draw everything–most detail but can slow down performance.
◊ Draw just walls and columns–basic details (a good compromise for performance
vs detail; this is the pre-selected option).
◊ Draw just the layer bounding boxes–minimal detail but least impact on per-
formance.

46
Legion SpaceWorks R6.5.0 User Guide

2. Select one or more of the listed layers in the dialogue box. You can select one or more lay-
ers using the standard Windows selections methods. When you select a layer, any asso-
ciated IFC elements and small object layers are also selected, to ensure that all related
objects on a layer are correctly aligned on import (this screenshot shows four auto-
matically selected layers).

When you have selected a layer (or layers), they are attached to your cursor and super-
imposed on the workspace, ready for placing (seen here to the right of the dialogue box:

3. Position the floating layer(s) in the workspace and left-click. You may need to move the
dialogue box, or to use the pan and zoom tools to find the best position.
4. Repeat steps 2 and 3 for other layer(s) as required, making sure that you do not overlap
them in the workspace.
5. When you have placed all the layers you need, click Done.
A progress meter is displayed while SpaceWorks imports the layers. If there are any
remaining layers that you haven't placed yet, the following message is displayed:

© 2001–2017 Legion International Ltd 47

Legion SpaceWorks R6.5.0 User Guide

6. Click Yes to continue, or click No to continue placing layers (repeat from step 2).

48
Legion SpaceWorks R6.5.0 User Guide

5: Final Destinations
In this chapter
This section covers the concept and use of ‘Final Destinations’.
This section covers the following topics:
● What is a Final Destination?
● Importing Final Destinations
● Assigning Final Destinations

© 2001–2017 Legion International Ltd 49

Legion SpaceWorks R6.5.0 User Guide

What is a Final Destination?

A Final Destination is the ultimate goal of an Entity’s journey through a model. It is usually an
Exit but can also be a Waiting Zone (in the case of stadium ingress studies, for example). A
'group object' can also function as a Final Destination. In the absence of any other routing
information or links to intermediate objects, an Entity will proceed through the model to its
Final Destination.

An Entity’s Final Destination can be changed by a Direction Modifier.

Final Destinations can be imported into a model using the Data Template spreadsheet, which
can, from the OD matrix, create parameters to be used by Entrances (including Final Destin-
ations).
Final Destinations can also be assigned manually at any stage in the model building process;
basically, any existing Exit or Waiting Zone can be used in a Demand Line as a Final Destin-
ation.
Entities can have intermediate targets, which can be manually placed as links between spatial
objects. Final Destinations are only considered when there are no more intermediate targets
for an Entity to try to reach.
So, if you have an Entrance that links to a Focal Node but also has an Exit as its Final Destin-
ation, all Entities introduced to the model through the Entrance will initially travel to the Focal
Node but once they leave there, assuming there are no further manual links from the Focal
Node to other objects, they will resume their journey to their final destination.
It is not necessary for every Entity to have a Final Destination, as long as they always have
some kind of routing information and are linked at some point to an Exit or a Waiting Zone.
This means that models created before the release of SpaceWorks will work perfectly well,
even though they have no concept of Final Destinations.

If at any point in a simulation an Entity has neither an intermediate target nor a Destin-
ation, an error will be generated and the Entity removed from the model.

50
Legion SpaceWorks R6.5.0 User Guide

Importing Final Destinations

Final Destinations can be introduced to a model when the Data Template spreadsheet is impor-
ted. Preparing this spreadsheet is covered in detail in The Data Template Spreadsheet but
briefly, in order to add Final Destinations to your model in this manner, you must specify a
‘Destination’ for each Arrival Profile or Population Profile defined in the ‘Data Profiles’ sheet.
After creating Profiles from OD matrices, Final Destinations are available in drop-down lists in
the ‘Destination’ column (they are taken from the available destinations listed with an OD mat-
rix).
When the spreadsheet is imported into the Model Builder, ‘pending’ Entrances will be created
for each origin and Final Destinations will be available to add to Entrances’ Demand Lines (see
What happens in the Model Builder after import?).

© 2001–2017 Legion International Ltd 51

Legion SpaceWorks R6.5.0 User Guide

Assigning Final Destinations

Once potential Final Destinations exist in a model, whether introduced by data import or manu-
ally drawn and configured, it is simple to assign them to Entities by setting the parameters of
Entrances, Populated Zones and Evacuation Zones.
For instructions on setting up the parameters of these objects, see Setting Entrance para-
meters, Setting Populated Zone parameters and Setting Evacuation Zone parameters.

52
Legion SpaceWorks R6.5.0 User Guide

6: Change Logs
All SpaceWorks modules automatically keeps track of all changes to files and (if managed by
Legion Project Manager) all projects and save them to a Change Log. Any work you do within a
SpaceWorks module is tracked and recorded in this log, whether the files you are working on
are outside or inside a managed project. The following list contains the actions and events
that are recorded in the change log:
● New document
● Load
● Save
● Save as
● ORA export
● CAD import
● Data Template import
● Data Template restore
● Add object
● Add multiple objects
● Modify object
● Modify multiple objects
● Modify object geometry
● Delete object
● Delete multiple objects
● Undo
● Redo
● Move, scale, rotate – matrix operations
● Clipboard cut and paste? (Excluded. Functionally identical to delete and add)
● Specialised geometry commands?
● Copy geometry
◊ Array
◊ Mirror
◊ Trim

The Legion Project Manager also maintains its own, slightly more limited Change Log.

© 2001–2017 Legion International Ltd 53

Legion SpaceWorks R6.5.0 User Guide

Viewing a Change Log

To view a file's Change Log:
1. From within an open module and an open file, select File > Change Log.
The Change Log dialog box is displayed. This picture shows some very basic, early
changes to a new model.

The left-hand panel contains an expandable tree-structure of events, organised by date.

Click on the crosses to expand entries and highlight individual entries to see more details
on the right-hand pane (as illustrated here).
2. If the log contains more than 100 entries, the four navigation buttons: First 100, Pre-
vious 100 , Next 100 and Last 100 become available. Click these buttons to cycle
through the entries.
3. The right-hand panel contains Export options (see Exporting the Change Log).
4. If the log has become too large and unwieldy, you can clear its contents (if you are the ori-
ginal author/creator of the file to which the log belongs). To do so, click the button, Clear
log contents? When asked to confirm this action, click Yes or No.
5. To close the log, click Close.

54
Legion SpaceWorks R6.5.0 User Guide

Exporting the Change Log

While viewing the Change Log, you can choose to export its data to a spreadsheet. It is advis-
able to do this from time to time as part of your general housekeeping tasks and before you
clear a log that has become too large. This procedure assumes that you have a populated
Change Log already open.

To export tracked changes:

1. From the 'Export' panel of the Change Log, select one of these three options:
◊ Export entire log – this will save the entire log.
◊ Export currently listed items – this will save the items listed in the left-hand tree
(the first or second 100 items, for example).
◊ Export within a specific date range (then select a valid From and a valid To date
from the drop-down calendars).

2. Click the Export button.

3. From the 'Save As' dialog box, choose a location, enter a meaningful name in the 'File
Name' field, and select a file type ('csv' is the default but you can also choose 'txt').
4. Click Save.
5. To view the log, open it using the appropriate application.

© 2001–2017 Legion International Ltd 55

Legion SpaceWorks R6.5.0 User Guide

7: Managing Model Projects

Over the course of a Legion project, a model may require different iterations and data scen-
arios, and may be updated and changed by multiple users. The Legion Project Management
feature enables you to oversee and audit these versions, developments and changes.
Releases since R6.3 contain 'stage one' of this feature, enabling users to create new versions
and providing the means to track changes to all files held within the 'umbrella' of a project.
This section contains all the topics you need to create, manage and track changes to a project.
To manage a project, you must open its files from 'within' Legion project management. Pro-
ject management can be accessed from inside SpaceWorks modules (from File > Project
Management) and also from a standalone Legion Project Management application called the
Legion Project Manager. See the following related topics for more information.
When you are working on files that are within the managed project, any changes and additions
you make to them (like adding new scenarios, or exporting ora files, or recording res files)
are detected by the Legion Project Manager and automatically added to the ongoing managed
project, and reflected in the Manager. You may need to click Refresh to see updated details
(see Refreshing a managed project).

If you open files belonging to a project from 'outside' project management, or if you 'Save
as' files with new names and in different locations that don't exist within project man-
agement, they will not be considered part of the project and they will not be tracked and
included in change logs. However, files can be added to a project at any time.

56
Legion SpaceWorks R6.5.0 User Guide

Opening the Legion Project Manager

Projects can be managed either from within a SpaceWorks module (Model Builder, Simulator,
Analyser, Legion 3D) or by using the standalone Legion Project Manager. In both cases the pro-
cedures, options, buttons and information displayed are identical.

A 'version' of a project is a record of an 'lgm', its associated 'ora' files (one per 'lgm' scen-
ario), any associated 'ana' files (potentially one per 'lgm' scenario), any associated 'res'
files (potentially one per 'lgm' scenario), and any associated 'l3d' files (potentially one per
'lgm' scenario).

To open the Legion Project Manager:

● Click Start > Legion Project Manager.
or
● From inside any SpaceWorks module, select File > Project Management.
The Legion Project Manager dialog box is displayed.

This illustration shows the state of the dialog box after a new project has been opened and a
Legion model file ('lgm') has been added. The left-hand side of the dialog box contains a tree
structure showing all the files and scenarios associated with a project; the right-hand side
shows the properties of the project, including ID, notes, creation date, creator, date of modi-
fications, project file name, status, and various buttons allowing access to SpaceWorks mod-
ules where further work on project files can be carried out.
See also Creating a new managed project.

© 2001–2017 Legion International Ltd 57

Legion SpaceWorks R6.5.0 User Guide

Creating a new managed project

This topic assumes that you have opened the Legion Project Manager dialog box (see 7:
Managing Model Projects).

To create a new project:

1. Click the New Project button.
The 'Save As' dialog box is displayed.
2. Choose a location for the project and enter a project name in the 'File name' field.
3. Click Save.
4. Continue adding files to the project or click Close Project.
See Adding a model file to a managed project.

58
Legion SpaceWorks R6.5.0 User Guide

Adding a model file to a managed project

Once you have created a new project using the Legion Project Manager, you can add a model
file ('lgm') to the project. You can do this in two ways, depending on whether you want to add
a brand new ('pending') 'lgm' at this point or whether you have a pre-existing lgm file to add.

To add a new model file to a project:

1. Open the Legion Project Manager.
2. Click the Open Project button.
3. Locate your project, select it and click Open.
4. Click on the line of the left-hand tree structure labelled 'Version'.
5. Click the Create New File button.
The 'Add a new Legion file' dialog box is displayed, where you can enter the name of a new
'lgm' file.
6. Enter the name of the model file in the 'File name' field and click Save.

To add a pre-existing model file to a project:

1. Open the Legion Project Manager.
2. Click the Open Project button.
3. Locate your project, select it and click Open.
4. Click on the line of the left-hand tree structure labelled 'Version'.
5. Click the Add Existing File button.
The 'Add an existing Legion file' dialog box is displayed.
6. Locate and select the file you want to add to the project and click Open.

© 2001–2017 Legion International Ltd 59

Legion SpaceWorks R6.5.0 User Guide

Opening files from within the Legion Project Manager

When you have added a file as described in Adding a model file to a managed project, you can
open it in the appropriate SpaceWorks module from within the Legion Project Manager. If the
file you added was a pre-existing file, that file will open as expected; if the file you added was
a brand new 'pending' file, this new file will open in SpaceWorks but will be empty and requir-
ing you to populate it and define it. For example, a brand new pending 'lgm' will open with the
name you gave it but you will need to add spatial objects, model settings, data, etc. in the
way you would if you were starting a new model from scratch.
This procedure assumes that you have the Project Manager already open.

To open a file from within the Legion Project Manager:

1. In the left-hand tree structure, click once on the file you would like to open.
2. In the right-hand panel, click the Open with button (the correct module should have been
automatically selected for you but if not, select from the drop-down list adjacent to the but-
ton.
The file will open in the correct module.

60
Legion SpaceWorks R6.5.0 User Guide

Changing a model file in a managed project

Occasionally you may wish to change the model file connected with a project. This can be
done easily. This procedure assumes that you have the Project Manager already open.

To change a model file:

1. In the left-hand tree structure, click once on the file you would like to change.
2. Click the Change file button.
The 'Add an existing Legion file' dialog box is displayed.
3. Locate and select the model file you want to add to the project and click Open.
4. When asked to confirm the change, click Yes.

The project will now contain the new file.

© 2001–2017 Legion International Ltd 61

Legion SpaceWorks R6.5.0 User Guide

Removing a model file from a managed project

You can easily remove a file from a project from within the Legion Project Manager. Files are
not deleted from your system, just removed from the project. This procedure assumes that
you have the Project Manager already open.

To remove a model file:

1. In the left-hand tree structure, click once on the file you would like to remove.
2. Click the Remove file button.
3. When asked to confirm, click Yes.

62
Legion SpaceWorks R6.5.0 User Guide

Checking the location of files in a managed project

While working on and managing a project, you may occasionally need to double-check that a
certain file exists, or locate them independently of the project. You can do this within the
Legion Project Manager by using the 'Show in folder' feature. This procedure assumes that
you have the Legion Project Manager open, with a project displayed. We don't recommend
that you open files directly from their folders. It is always best to use the 'Open with...'
option.

To check the location of a file:

1. From the left-hand tree structure, click once on a project file ('lgm', 'ora', 'res', 'ana',
'l3d') to highlight it.
2. Click the Show in folder button.
3. Windows Explorer (or similar) will be displayed, featuring the highlighted file.

If you open the file from here and work on it, it will be considered to be outside of the pro-
ject and its changes won't be tracked.

© 2001–2017 Legion International Ltd 63

Legion SpaceWorks R6.5.0 User Guide

Adding a new scenario to a project

You can easily add a new scenario to a version of your project within the Legion Project Man-
ager. This procedure assumes that you have the Project Manager already open.

To open a new scenario to a version of your project:

1. In the left-hand tree structure, click once on the version you would like to add a scenario
to.

2. Click the New Scenario button.

3. A new scenario is added to the tree structure.

4. You can change its 'ID' and add 'Notes' on the right-hand side of the Project Manager if you
wish. First, select the scenario in the left-hand tree and then enter text in the relevant
fields.

64
Legion SpaceWorks R6.5.0 User Guide

Adding a new file to a scenario

You can add files (pre-existing or brand new and 'pending') to a scenario within the Legion Pro-
ject Manager. When adding brand new files, you can only add new ana files; when adding pre-
existing files, you can add 'ora', 'res', 'ana', or 'l3d' files as long as they already exist.

To add a new ana file to a scenario:

1. Open the Legion Project Manager.
2. Click the Open Project button.
3. Locate your project, select it and click Open.
4. Click on the scenario to which you would like to add a new ana file.
5. Click the Add New File button.
The 'Add a new Legion file' dialog box is displayed, where you can enter the name of a new
ana file.
6. Enter the name of the ana file in the 'File name' field and click Save.

To add a pre-existing model file to a project:

1. Open the Legion Project Manager.
2. Click the Open Project button.
3. Locate your project, select it and click Open.
4. Click on the scenario to which you would like to add an existing file.
5. Click the Add Existing File button.
The 'Add an existing Legion file' dialog box is displayed.
6. Locate and select the file you want to add ('ora', 'res', 'ana', or 'l3d') to the project and
click Open.

© 2001–2017 Legion International Ltd 65

Legion SpaceWorks R6.5.0 User Guide

Removing files, scenarios and versions from a managed

project
At any point you can remove files, scenarios and versions from a project. This procedure
assumes that you already have the Legion Project Manager open.

When you remove a file from a project, it still remains safely on your hard drive or
wherever it is stored.

To remove a file, scenario or version from a project:

1. In the left-hand tree structure, highlight the item that you would like to remove.
2. Depending on what you have selected, click one of these buttons:
◊ Remove File
◊ Remove Version
◊ Remove Scenario
3. When asked to confirm removal, click Yes.

66
Legion SpaceWorks R6.5.0 User Guide

Adding a new version to a managed project

At any point, you can add a new version of your project to the tree structure of an existing pro-
ject. This enables you to branch out with a different model file, data files, and scenarios and
keep track of any changes. This procedure assumes that you already have the Legion Project
Manager open. You can also add a new 'child' version to an existing version.

To add a new version to a project:

1. In the left-hand tree structure, highlight the project to which you would like to add a new
version.
2. Click the New Version button.
A new version is added to the tree structure.

3. You can change its 'ID' and add 'Notes' on the right-hand side of the Project Manager if you
wish.

To add a child version to an existing version:

1. In the left-hand tree structure, highlight the version to which you would like to add a new
child version.
2. Click the New Version button.
A new child version is added to the tree structure (the name has been changed in the 'ID'
field here).

© 2001–2017 Legion International Ltd 67

Legion SpaceWorks R6.5.0 User Guide

Saving a managed project

After making changes to projects within the Legion Project Manager, it's important to save
your changes. You may be closing a particular project or exiting the application completely.
Either way it's important to save your changes; the manager will prompt you to do so as you
close or exit.

To save a project:
1. Click the Save button.
or
1. If you want to save the project under another name or in another location, click the Save
As button.
2. Enter a name and/or choose a new location for the project.
3. Click Save.

68
Legion SpaceWorks R6.5.0 User Guide

Refreshing a managed project

When you have made changes to files in a project by using the Open with feature and work-
ing on files and scenarios in other SpaceWorks modules, you will need to refresh the project
when you return to the Legion Project Manager. It is good practice to do this as a matter of
routine. When there are changed to be refreshed and displayed, the Refresh button will
appear as available (rather than greyed-out).

While such files are open in Legion modules and being worked upon, it is best not to make
any changes within the Legion Project Manager dialog box. If you do, there will be change-
clashes between Legion files and the dialog box and you will have to abandon changes in
either the Legion files or the Legion Project Manager.

To refresh a project:
1. Open (or return to) the Legion Project Manager.
If there are changes that need to be updated in the Project Manager view, the Refresh but-
ton will be available.
2. Click the Refresh button.
3. Files and scenarios will be updated (and any additions will appear in the tree structure).

© 2001–2017 Legion International Ltd 69

Legion SpaceWorks R6.5.0 User Guide

Exporting Legion Project Manager information

From within the Legion Project Manager, you can export all the information pertaining to
changes within a project to a csv file or a txt file. This is a simplified version of the procedure
described in Exporting the Change Log. This procedure assumes that you have the Legion Pro-
ject Manager open, and a project displayed in the left-hand panel.

To export information about changes:

1. From the left-hand tree structure, select the level and amount of information you would
like to see and ultimately export. Do this by highlighting the project name (this will export
all changes related to the project) or by highlighting a particular file within the model. This
screenshot shows a highlighted 'ana' file. In this case, only changes affecting this high-
lighted file will be exported.

2. In the right-hand panel, click the Export button.

3. From the 'Save As' dialog box, choose a location, enter a meaningful name in the 'File
Name' field, and select a file type ('csv' is the default but you can also choose 'txt').
4. Click Save.
5. To view the log, open it using the appropriate application.

70
Legion SpaceWorks R6.5.0 User Guide

8: Model Builder Basics

In this chapter
This part of the guide introduces you to the Legion Model Builder: its workspace, toolbars,
menus and the basic tasks you need to perform to get your Legion project up and running.
This section covers the following topics:
● About the Model Builder
● The Model Builder interface
● Model Builder Components
● Basic Model Builder tasks

© 2001–2017 Legion International Ltd 71

Legion SpaceWorks R6.5.0 User Guide

About the Model Builder

The Legion Model Builder is where you construct the site or venue you want to simulate for the
ultimate aim of producing analyses about pedestrian usage. It is here where you import CAD,
add Spatial Objects, define linking methods, set up conditions and introduce demand data.
To this end, it enables you to bring together the following elements:
● CAD drawings of the site to be simulated and analysed.
● Data about how many pedestrians are using the site.
● Entities (the types of pedestrian using the site).
● Activity Objects to define the activities of Entities engaging with the site; to introduce oper-
ational route restrictions, designate special routes, or complement Entities' navigation.
● Analysis Objects so that you can create 'Conditional' and 'Reporting' analyses.
This part of the guide concentrates on introducing the Model Builder and some key basic tasks.
Subsequent sections discuss more detailed aspects of model building.

72
Legion SpaceWorks R6.5.0 User Guide

The Model Builder interface

The picture below illustrates the user interface of the Model Builder, with all its major com-
ponents labelled. Although you can customise the appearance of the interface, this illustration
represents a typical layout after installation.

© 2001–2017 Legion International Ltd 73

Legion SpaceWorks R6.5.0 User Guide

Model Builder Components

Workspace
The visual aspects of model building take place in the workspace window. This is where any
imported CAD plans are displayed and where you draw, position and edit Spatial Objects.
Like most Windows-based applications, the Model Builder has a menu bar and a series of tool-
bars containing icons that match the options found on the menus.

Changing the workspace background colour

If you would prefer to work with a white background, you can change the default background
colour. Before doing so, you need to have a model open (see Opening a new model).

To change the background colour:

1. Select Tools > Options. The ‘Options’ dialog box is displayed.
2. Click on Application Settings.
3. Check the box labelled Use a white background.
4. Click OK to change the background colour.

Main Menu Bar

The main menu provides access to all Model Builder functionality. All procedures in this guide
refer to the main menu options and, when appropriate, the equivalent toolbar options.

Toolbars
The Model Builder has several toolbars, which are initially grouped together above the work-
space. The purpose of each icon is explained as specific tasks are described.

Repositioning toolbars and turning toolbars off

In the course of your work, you may wish to move individual toolbars away from their original
positions and either dock them at the bottom and sides of the Model Builder interface or leave
them floating over the workspace.

To reposition a toolbar:
1. Click-and-hold on the vertical dotted line to the left of the toolbar you want to move.
2. Drag it to a suitable position over the workspace and release the mouse button to create a
floating toolbar.
or
Drag it to the bottom or the sides of the Model Builder interface to dock it there.
You can return any toolbar to its original position by clicking and dragging it back into place.
Any changes to your toolbars are lost if you reinstall Legion SpaceWorks.
You can also turn toolbars off to make more space on the interface.

To turn a toolbar off:

1. Select Tools > Customise.
The ‘Customise’ dialog box is displayed.
2. Click on the Toolbars tab.
3. Uncheck any toolbars you want to turn off.
As you uncheck each toolbar, notice that it disappears from the Model Builder interface.
To turn a toolbar back on, repeat the procedure but this time check the relevant box next
to the toolbar’s name.

74
Legion SpaceWorks R6.5.0 User Guide

4. Click Close.

Creating a custom toolbar

There are many ways to customise Legion SpaceWorks’s array of menus and toolbars. This
section shows you how to create a custom toolbar, which can be helpful if you tend to perform
certain tasks and not others. A custom toolbar can also help make a little more space in the
Model Builder interface.

To create a custom toolbar:

1. Select Tools > Customise
The ‘Customise’ dialog box is displayed.
2. Click on the Toolbars tab.
3. Click the New button.
4. Type a name for the new toolbar and click OK.
A new, floating toolbar is created.
5. To add a tool button to the new toolbar, click and drag an existing icon onto the new tool-
bar. A black line appears to guide the placement of the icon.

If you change your mind about an icon, drag it back off the new toolbar to its original loc-
ation.
6. Add as many further icons as you require.

7. When you have added all the icons you need, click Close.
8. Drag the new toolbar into position.
You may now wish to turn off some of the other toolbars; see To turn a toolbar off:.

To restore the contents of all standard toolbars, select Tools > Customise > Toolbars >
Reset All.

Object Directory
The Object Directory lists all the objects and data that you create, input or import while build-
ing your model. The different objects appear on the ‘Objects’ tab, ‘Data’ tab, ‘Scenarios’ tab
and the ‘Imported’ tab. It is useful in several ways:
● It acts as an inventory of objects and data in your model.
● It enables you to make objects visible or invisible, which can be helpful when studying a
complex model.
● It enables you to select any object in your model without having to locate it in the main
window.
● It enables you to quickly view selected objects up close.
● It enables you to move or copy objects to other layers within your model.
● After importing the Data Template spreadsheet, it shows you at a glance which objects
exist in the model and which are ‘pending’ (see What happens in the Model Builder after
import?).
The objects and data are displayed in a tree structure and sorted alphabetically. Click on the
+ and – icons to expand or close branches of the Object Directory.

© 2001–2017 Legion International Ltd 75

Legion SpaceWorks R6.5.0 User Guide

To hide an object in the workspace, click on its adjacent eye icon to display a bar across it.

To show an object again, click the eye icon to remove the bar.

You can also choose to show or hide 'Conditional' analyses in the Object Directory (see
Defining Analysis Project Settings).
When you open a new model the Object Directory will be populated with three default layers:
the Activity Object Layer, the Default Analysis Layer and the CAD Layer. When you add new
objects to the model, they appear in the Object Directory in the relevant active layers.
To create more space, you can choose to ‘Auto Hide’ the Object Directory: just click on the
small ‘push-pin’ icon next to its name. This will hide the directory until you click on its still-vis-
ible name tab. To turn off ‘Auto Hide’, click the push-pin icon again.

76
Legion SpaceWorks R6.5.0 User Guide

The ‘Imported’ tab

This tab contains all the objects (Spatial and Data) that you may have imported from the Data
Template spreadsheet. In contrast to the tree-lists in the other tabs, this tree contains green
ticks, red ticks and red crosses for each branch and for individual objects:
● A green tick indicates that an object exists in the model and if it is at the top level of a
branch it means that all items in that branch exist in the model.
● A red tick indicates that some but not all members of a branch exist in the model.
● A red cross indicates that an object does not exist in the model and if it is at the top level
of a branch it means that none of the items in that branch exist in the model.
For more information on importing the Data Template spreadsheet, see Importing a com-
pleted template.

Viewing by type or layer

The Object Directory enables you to view the contents of your model either by type or by
layer. View by Type lists all the objects and layers within the model in an expandable tree
structure; View by Layer lists only the layers in the model, which you can also expand to show
the objects in each layer.

To view by type or layer:

● Right-click on the Objects tab of the Object Directory and select either View by Type or
View by Layer
The listing in the Object Directory changes accordingly.

Camera Close-up
This feature enables you to zoom in on a single object within your model, which can be very
helpful if you need to isolate one object within a complex model.

To use the Camera Close-up tool:

● In the Object Directory, find the object you want to view, right-click on its name and select
Camera Close-up
The selected object appears in close-up within the Model Builder workspace.

Output Bar
The Output Bar provides feedback on your activities within the Model Builder. It has three
tabs:
● Information
● QA
● Search Results
Each tab of the Output Bar retains its information when you click on another tab.

Information
This portion of the Output Bar displays a history of previous commands and sometimes
prompts you to perform certain steps. It also has a Command Bar into which you can type
certain commands in order perform Model Builder tasks including selecting, placing and edit-
ing objects. For a full list of commands see Appendix: SpaceWorks Commands.
Right-click on the ‘Information’ tab for menu options to Clear or Copy its contents. Copying
the contents of the Output Bar is useful when you want to keep a record of recent actions.

© 2001–2017 Legion International Ltd 77

Legion SpaceWorks R6.5.0 User Guide

Auto-complete commands
When you begin to type a command into the Command bar, it suggests available commands
based on the letters you type. As you type, a pop-up list of commands is displayed, from
which you can select.
For example, typing ‘c’ will pop-up the following list of available commands:

When the correct command is highlighted in the Command bar, press the Enter key to run it.
You may also double-click any command from the list to run it.
If you continue to type, the list will recompose itself, filtering the available commands accord-
ing to the letters you type. For example, typing an ‘o’ after the ‘c’ will reduce the list to the fol-
lowing available commands: ‘copy’, ‘copy geometry’ and ‘copy to layer’.

QA
This stands for Quality Assurance and displays the results when you check your model for
errors during the course of building or just before exporting the model file for simulation. For
further information, see Checking for errors.

Search Results
This tab displays any relevant results when you search for objects using the Find tool. Results
are listed by object and type.

Right-click on one or more listed objects for the options to Edit Properties or Select Object
(s).

78
Legion SpaceWorks R6.5.0 User Guide

To create more space, you can choose to ‘Auto Hide’ the Output Bar: just click on the small
‘push-pin’ icon next to its name. This will hide it until you click on its still-visible name tab. To
turn off ‘Auto Hide’, click the push-pin icon again.

Status Bar
The Status Bar at the bottom of the Model Builder interface displays information regarding
(moving from left to right):
● The status of the application and ‘ToolTips’
● The current position of the cursor (by X and Y coordinates)
● The length of any object being created
● The angle at which the cursor is currently off the X-axis, when drawing or placing an
object in the model
A progress bar provides a visual indication of the progress of QA checks, ‘ora’ file exports and
Generalised Journey Time exports, if applicable.

The Layers Directory

The Legion Model Builder contains layers which make it easier to manage complex models and
analyses. There are four types of layer within the Model Builder:
● CAD Layers.
● Activity Object Layers.
● Partition Layers (used to hold Partition Guides when part of the space needs to be mod-
elled using Focal Drift Zones rather than auto-navigation)
● Conditions Layer (this stores Analysis Objects, which are used to set up Conditions; please
see 14: Conditions in Models).
When you open a new model project, default versions of these layer types are created.
The Layers Directory allows you to add layers, view the properties of existing layers and
change existing layer properties. It is displayed alongside the Model Builder workspace and
can also be displayed by selecting View > Toolbars > Layers. See 12: Layers for further
information.
To create more space, you can choose to ‘Auto Hide’ the Layers Directory: just click on the
small ‘push-pin’ icon next to its name. This will hide it until you click on its still-visible name
tab. To turn off ‘Auto Hide’, click the push-pin icon again.

Arranging windows
In the same way that you can move toolbars around for convenience, you can also resize and
reposition the various windows in the Model Builder interface.

To move a window:
1. Click-and-hold on the horizontal dotted line at the top of the window you want to move.
2. Drag it to a suitable position over the workspace and release the mouse button to create a
floating window.
or
Drag it to the bottom or the sides of the Model Builder and release the mouse button to
dock it there.

To resize a window:
1. Position the cursor on the edge of a window until it changes to a vertical or horizontal
‘grab’ icon.
2. Click and drag the edge of the window to the desired size and release the mouse button.

© 2001–2017 Legion International Ltd 79

Legion SpaceWorks R6.5.0 User Guide

To close a window, click on the X icon in the top right-hand corner of the window.

To reopen a closed window:

1. Right-click in a clear space next to the toolbars.
A menu of available windows (and toolbars) is displayed.

Those with a tick displayed to the left of their name are currently open.
2. Highlight and click the name of the window you want to reopen.
The window opens in the same place it was when you closed it down and with the same
dimensions. Conversely, highlighting and clicking a window which already has a tick dis-
played will close that window.

Moving and Hiding Components

The Object Directory, Layers Directory and Output bar can be moved or hidden to suit your
preferred layout. To move one of these objects, click and drag its title bar to another part of
the workspace. As you drag, you will see the following ‘docking arrows’, which act as a visual
guide, enabling you to place the object at the top, bottom, right or left side of the area high-
lighted in blue.

Arrows also appear at the extreme edges of the user interface, enabling you to place objects
in those locations too. To dock the object, move your cursor over one of the docking arrows
and click.
When dragging objects to the lower portion of the interface, a central blue square becomes
available. If you click this square, the object is docked alongside any existing objects in the
same location, each object residing on its own tabbed page, as illustrated here.

80
Legion SpaceWorks R6.5.0 User Guide

To move tabbed objects, click and drag on their name tabs.

To create more space, you can choose to ‘Auto Hide’ any of these objects: just click on the
small ‘push-pin’ icon next to its name. This will hide it until you click on its still-visible name
tab. To turn off ‘Auto Hide’, click the push-pin icon again

© 2001–2017 Legion International Ltd 81

Legion SpaceWorks R6.5.0 User Guide

Basic Model Builder tasks

The following are a selection of basic tasks to help you get your Legion project up and running
and to continue your introduction to the Model Builder. You can cancel many tasks midway
through by pressing the Esc key. This returns the cursor to its normal ‘cross-hair’ state.

If the cursor ever behaves in an unexpected manner, check the Output Bar to see if there
are any uncompleted tasks or prompts and either finish the task or press Esc.

Starting the Model Builder

This is the basic procedure for starting up the Model Builder. You may of course create your
own shortcuts on the Windows desktop, use icons on the Windows taskbar or, when you have
an existing model, open Windows Explorer and double-click its ‘lgm’ file.

To start the Model Builder:

1. Select Start > All Programs > Legion International > Legion SpaceWorks >
Model Builder.
On your very first startup you will be prompted to select a measurement system: imperial
or metric (this choice will be reflected in all measurements and analytical outputs).
2. Select either Metric or Imperial and click OK.
You can change the measurement system later in Tools > Options > Application Settings >
‘Unit system’.
The Model Builder application starts.

Opening a new model

When you first open the Model Builder, and before you have a model to work with, none of the
model building tools and menus are available. To activate them, you need to open a new or
existing model.

To open a new model:

● Click or select File > New.

An empty model is created and all the modelling tools and menus are now available. Until
you set your model’s properties, import a CAD plan or place objects into the model, the
workspace remains empty.

Saving a model
Now that you have opened a new model, it is a good idea to save it with a meaningful name.

To save a model:

1. Click or select File > Save .

The ‘Save As’ dialog box is displayed.
2. Browse to a suitable location and enter a new name in the File name field.
3. Click the Save button.

Model File Properties

You can save important information about a model file in the ‘Properties’ dialog box, which is
available on the File menu. This feature also provides a historical log of when the model was
saved and by whom. You can also set passwords to protect who can access and change the
file.

To add model file properties:

82
Legion SpaceWorks R6.5.0 User Guide

1. In the Model Builder, select File > Properties.

The ‘Properties’ dialog box is displayed.

2. On the ‘Summary’ tab, enter information into the following fields:

◊ Title
◊ Subject
◊ Author
◊ Keywords
◊ Comments
3. To password protect the file, do one or both of the following (the passwords cannot be
identical):
◊ Type a password in the box labelled 'Password to open' (users will need to enter this to
open the file)
◊ Type a password in the box labelled 'Password to modify' (users will need to enter this
to save the file after changes)
If you don't set these passwords, the file may be opened, edited and saved by any user.
4. To view records of when the file was saved and by whom, click on the History tab.
5. Click OK to close.

© 2001–2017 Legion International Ltd 83

Legion SpaceWorks R6.5.0 User Guide

Backups of models
The first time you save a model file, Legion SpaceWorks automatically creates a backup file
called <filename>.mbk (where <filename> is the name of your model) and saves it in the
same directory as your ‘lgm’ file.
Every subsequent time you save your model, Legion SpaceWorks saves the earlier version of
the model as an ‘mbk’ file and overwrites the previous ‘mbk’ file. This means that when you
save your model for the third time, the ‘mbk’ preserves the second saved version; when you
save for the fourth time, the ‘mbk’ overwrites the second ‘mbk’ file with the third saved ver-
sion and so on.

Remember that each saved ‘mbk’ overwrites the previous backup file.
This means you can restore previous versions of models when needed: change the backup
file’s extension from .mbk to .lgm. and open within the Model Builder in the usual fashion.
In the unlikely event that you want to turn this feature off, you can do so by following this pro-
cedure:

To turn off backups:

1. Select Tools > Options > Application Settings.
2. Uncheck the box labelled Generate backup when saving.
3. Click Apply or OK to save your changes.

Auto-saving your work

The Model Builder has an auto-save and recovery feature that you can configure to save and
recover your work in case of power failures, unintentional exits from the software or system
crashes. It can be found under the Tools > Options menu. Auto-save files have the extension
‘_as’ appended to the end of a regular Legion file name.
When you exit the Model Builder properly (regardless of whether you have saved your work or
not) any Auto-saved backup file for that session is deleted and will not be available for recov-
ery. The ‘mbk’ file will, however, still be available.

To configure Auto-save:
1. Select Tools > Options > Auto-save settings.
The ‘Options’ dialog box is displayed.
2. Tick the Enable Auto-save box.
3. Enter a number of minutes between 1 and 120 in the box labelled Automatically save
every n minutes.
4. Select either:
◊ Overwrite the main file–this will save over your working ‘lgm’ each time auto-save
is activated.
or
◊ Create a recovery file–this will create a recovery file alongside the ‘lgm’ you are
working on, so the ‘lgm’ will remain unchanged unless you explicitly save. If the file
you are working on has never been saved, a recovery file will always be created, pre-
fixed by the word “Unnamed”.
◊ To be able to see the recovery file in your file structure, check Don’t hide the file.
5. To make sure your current ‘lgm’ file is automatically saved when you export it as an ‘ora’
file, check the box labelled Update the current file when a simulation (.ora) file is
exported.

84
Legion SpaceWorks R6.5.0 User Guide

6. To display information about the status of Auto-save in the Output Bar, check Show Auto-
save details (see below for a list of these statuses).
7. Click Apply or OK to save your changes.

Notes on Auto-save
● Unless you check Don’t hide the file auto-saved recovery files are hidden so that they
are not confused with standard Model Builder files.
● Auto-saved backup files are always saved in your ‘My Documents’ folder.
● Auto-saved backup files have the extension ‘.lgm_as’.
● If the file you are working on has never been saved, the backup filename will begin with
“Unnamed”.
● The Output Bar will display the following details about the status of the Auto-save function:
◊ Disabled–not running.
◊ Idle–running but no changes to save yet.
◊ Countdown–minutes and seconds until the next auto-save.
◊ Suspended–temporarily not running due to an ongoing command or operation or open
dialog box.
◊ Pending–will auto-save as soon as the current command or operation is completed or
cancelled.
◊ In progress–performing an auto-save (access to the Model Builder is temporarily sus-
pended during an auto-save).

Auto-recovering backup files

All recovery files generated by the Auto-save function can be recovered and loaded into the
Model Builder. This includes ‘Unnamed’ as well as previously saved and named files but the
process is slightly different for each type of file.

To auto-recover an “Unnamed” recovery file:

1. Select File > Recover Model files.
The ‘Auto-recovery’ dialog box is displayed, listing all the files that can be recovered.

© 2001–2017 Legion International Ltd 85

Legion SpaceWorks R6.5.0 User Guide

2. If you want to see a preview of a model file, double-click on its image. Click OK to close
the preview.
3. To open a model file in the Model Builder, select its name and click OK.
The file is opened with the generic title “Recovered unnamed Auto-save file”.
4. Select File > Save and save the file with a specific name.
With files that you have already saved and named, the recovery process starts as soon as you
try and open the file. The Model Builder looks to see if there are any associated recovery files.
If there are, the ‘Auto-recovery’ dialog box is displayed; if not, the original file is opened in
the normal manner. When displayed, the dialog box always lists the original file first.

To load a named recovery file:

1. To see a preview of a model file, double-click on its image. Click OK to close the preview.
2. To open a model file in the Model Builder, select its name and click OK.
The ‘Auto-recovery Options’ dialog box is displayed.
3. Select one of the following options:
◊ Load the Auto-saved version and Save As a new file.
◊ Load the Auto-saved version and replace the original file.
◊ Do not load the Auto-saved version; delete it.
4. Click OK.
If you chose the first option in step 3, you will need to name and save the recovered file.
The recovery file will then be deleted.
If you chose the second option in step 3, the file will open and will replace the original file;
the recovery file will be deleted.
The third option will delete the recovery file without opening it.

86
Legion SpaceWorks R6.5.0 User Guide

Importing a CAD file

CAD files represent the physical space of the site you are modelling. They are discussed in
detail in 4: Using CAD. To learn how to import a CAD file, see Importing a CAD plan into the
Model Builder (DGN, DWG, DXF).

Closing a model
Follow this procedure to close the model you are working on.

To close a model:
● Select File > Close.
If there are no unsaved changes in the model, it closes automatically. If there are unsaved
changes in the model, you will be prompted to save the model before closing:
◊ Click Yes to save the model.
◊ Click No to close the model without saving.
◊ Click Cancel to leave the model open.

Opening an existing model

When you already have a model or models that you are working on, there are several ways to
open them. You can have more than one model open at the same time.

To open an existing model:

● Select File and then, if your model is in the recent file list , select the appropriate model.
or
● Select File > Open, browse to the appropriate model (‘lgm’) file and click the Open but-
ton.
or
● Open the file in Windows Explorer or from your Desktop.
Your model opens in the Model Builder workspace.
If the model was created in a previous version of the software, you will be prompted to
upgrade the model. Click Yes to upgrade. To retain the upgraded features, make sure you
save the model.

Setting Model Properties

The main purpose of Model Properties is to define the size of your model and the period of
time you are going to simulate. You must define these properties before exporting the model
for use in the Legion Simulator, as a model without these properties cannot be simulated.

In rare circumstances, you may wish to turn off auto-navigation throughout a model; you
can do so on the 'Auto-Navigation' tab.
There is also a slider control which enables you to set the ‘Distance Estimation Error’. This
determines the accuracy with which Entities can estimate distances for the purposes of choos-
ing target objects or avoiding congestion (see step 6).

To set Model Properties:

1. Click or select Data > Model Properties.

The ‘Model Properties’ dialog box is displayed.
2. If your model already contains CAD or Spatial Objects, click the Fit button to size and
centre the model’s dimensions around your plan or objects.
or

© 2001–2017 Legion International Ltd 87

Legion SpaceWorks R6.5.0 User Guide

Enter the Model Dimensions (X size, Y size, X offset, Y offset).

These settings define the size of the model and its centre in relation to the total workspace
area.
3. Enter the duration of the Model Run Time using the format hh:mm:ss (the default setting
is one hour).
4. If you wish, you can enter a Model Start Time. You probably won't need to do this as the
model will take its start time from your imported data template. The Model End Time is
added automatically (this cannot be later than 23 hours, 59 minutes and 59 seconds after
the Start Time).
5. If you do enter a new start time and wish your imported data profiles to reflect the new
time, check the Adjust Data Profiles to match start box.

This adjustment shifts the demand data in relation to the Model Start Time, ensuring that
no data is lost by being outside the time frame of the simulation. This is not obligatory if
you have changed the start time (for instance you may want to omit a period at the start
of the run time in which there is no data).
6. Set the percentage of Distance Estimation Error (0%–20%) by dragging the slider control
to the required level. Note that the default percentage is set at 5%.
7. If your model's CAD contains many long arc shapes, processing them may take longer.
You may like to alter how they are approximated by setting an 'arc tolerance level'. The
higher the tolerance, the less precisely the arcs are drawn. This may increase speed but
reduce accuracy a little. Experiment, if necessary, to find the right balance.
Check the box labelled 'Adjust the accuracy with which arcs are drawn' and adjust the
slider.
8. Switch to the 'Auto-Navigation' for the following steps.
◊ In the unlikely event that you wish to turn off auto-navigation throughout a model,
click the 'Auto-Navigation' tab and uncheck the box labelled Enable auto-navigation.
Recheck the box to enable auto-navigation again.
◊ If you enable auto-navigation and want Entities to aim for the focal point of objects
(rather than aim for the focal segment in general), click the 'Auto-Navigation' tab and
check the box labelled 'Always use focal points for auto-navigation'. This overrides any
target parameters you may have set in individual objects. See Target Parameters for
more information.
◊ 'Enable isovist grid caching' enables the Simulator to calculate and retain a grid of
each Entity's zone of vision. This speeds up simulations but uses a lot or memory. If
you are concerned about running out or memory, uncheck this box.
9. Click OK button to save your settings.

Detecting blockages automatically

For different reasons, models sometimes get blocked and a single time step can take a very
long time to complete. When this happens, the software can appear to freeze and attempts to
pause or stop playback may not be recognised. In this state there is no graceful way to pro-
ceed and you may be tempted to force the software to close down.
To get around this, there is a feature called Automated Blockage Detection (ABD) in the Sim-
ulator and Analyser that automatically detects blockages, according to the delay threshold you
set (in minutes or seconds), and then either pauses or stops playback accordingly. This pro-
cedure assumes you have loaded a model in the Simulator or Analyser.

To turn ABD on (or off):

1. Select Tools > Options.

88
Legion SpaceWorks R6.5.0 User Guide

2. Click on 'Automatic Blockage Detection' to display the relevant panel of the dialog.

3. The feature is always activated at first. If you wish to deactivate it, uncheck the 'Enable'
box and go to step 7.
4. Set the delay threshold you require by entering a numeric value after the label 'If a sim-
ulation step exceeds' and by selecting 'minutes' or 'seconds' from the adjacent drop-down
menu.
5. To define what happens when this delay threshold is reached, select either:
◊ Pause the simulation
◊ Stop the simulation
6. If you would like to interrupt the simulation before the completion of a delayed time step
(because the step is taking too long to complete), check the box labelled 'Interrupt sim-
ulation step if time limit is exceeded'. If you check this box, the 'Pause the simulation'
option in step 5 will be deselected.
7. Click OK.

When ABD is on, and when a delayed time step reaches the specified length of time, the
simulation will either pause or stop as you require. A message dialog will be shown indic-
ating what has happened. The message will include the duration of the time step which
triggered ABD.

Panning and zooming

There are many ways to view different parts of your model by panning and zooming around
the Model Builder workspace. The following table contains the different panning and zooming
icons with their names and how to use them. When you have finished panning or zooming,

© 2001–2017 Legion International Ltd 89

Legion SpaceWorks R6.5.0 User Guide

press the Esc button on your keyboard to return the cursor to its normal state.

Icon Name How to use

Pan Click once then drag the model view in any direction
with the mouse

Mouse Click once and drag the mouse up and down an ima-
Zoom ginary y-axis to zoom in and out

Zoom Click once, draw a box over the area of the model you
Region want to zoom in on and click to complete the area

Zoom Click once to zoom in or out to the full extent of the

Extents model

Zoom Click to zoom in by incremental steps

In

Zoom Click to zoom out by incremental steps

Out

Regenerating objects after zooming

Sometimes, when you zoom in and out of a model, objects with arcs and curves are redrawn
as polygonal shapes because their resolution has changed. This tool enables you to regenerate
all objects in your model so that they are displayed properly at any zoom level.
To regenerate all objects, either type Regenerate in the Command bar (the auto-complete
function will save you from typing the whole word) or select Tools > Regenerate from the
Model Builder menu.

Saving the current view

While you are working on a model, you may wish to capture screenshots of it for use in
presentations or on web pages, etc. You can do so by saving your current view at any time.

To save the current view:

1. Ensure the model currently displays the view you want to save.
2. Select File > Save Current View.
The ‘Save As’ dialog box is displayed.
3. Select a location and type a name for the file.
4. Select BMP Files, JPEG Files or PNG Files in the Save as type field.
5. Click the Save button.

Checking for errors

At any time during the building of a model, you can check your work for errors by using the
QA (Quality Assurance) tool. This tool checks all the objects, Entities and data in your model
for missing data, links, properties, etc. and presents the results in the ‘QA’ tab of the Output
Bar. A QA check is also performed whenever you try to export a model (‘lgm’) file as an ‘ora’
file.

You must fix errors before you attempt to export your model as an ‘ora’ file for sim-
ulation; you should heed warnings but overlooking them will not prevent exporting as an
‘ora’ file.

90
Legion SpaceWorks R6.5.0 User Guide

Results are classified as Information, Warnings or Errors. Right-click on the ‘QA’ tab to change
whether it displays Information, Warnings or Errors.

All ‘ticked’ information types will be displayed. Click alongside each to add or remove the
ticks.

To check your model for errors:

1. Click or select Data > QAModel.

The number of errors or warnings is displayed in the ‘Information’ tab of the Output Bar,
for example:
“QA completed with 4 error(s), no warning(s)”
If errors are found, a message stating Model Contains Errors is displayed.
2. Click the OK button.
The ‘QA’ tab of the Output Bar is displayed and lists all errors, warnings or information.

Where appropriate, these messages are hyperlinked to the objects they refer to. If so,
when you move the cursor over a message, it will change to a ‘pointing hand’. Click one of
these messages to open the ‘Edit Properties’ dialog box of the object containing the error.
This will enable you to fix the problem by changing object properties.

Right-clicking on an object’s name in the Output Bar will also offer you the option to
‘Delete’ the object.
3. Fix any errors.
4. Rerun the QA check to check that you have successfully fixed any errors.

© 2001–2017 Legion International Ltd 91

Legion SpaceWorks R6.5.0 User Guide

Viewing Accessible Space

At any time when using the Model Builder, you can check how the software is calculating the
accessible space within which your Entities will move. Doing so may help you to spot any CAD
errors or issues with the layout of your model before you export it and simulate it.

To view accessible space:

1. Click or select View > Show Accessible Space.

The accessible space is indicated by grey shading. Depending on the size and complexity
of your model, this may take a few moments.
2. To hide the accessible space, repeat step 1.

Printing a model
While you are working on a model, you may wish to print versions of it to show colleagues or
to sketch pedestrian routes, etc. onto it.

To print the model:

1. Ensure the model currently displays the view you want to print.
2. Select File > Print.
The ‘Print’ dialog box is displayed.
3. Specify any printing preferences you may need to change.
4. Select one of the following options:
◊ Fit model to page–prints the full extent of the model.
◊ Maintain current view–prints what you can currently see in the workspace.
5. Click the Print button.
If you want to check how your printout will look before printing the model, use 'Print preview'.

To preview your printout:

1. Ensure the model currently displays the view you want to print.
2. Select File > Print preview.
3. A preview of your printout is displayed.
4. If you are happy with the preview, click the Print button to print the model.
If you want to change the visible contents of the printout, click the eye icons next to visual
objects in the Object Directory to the left of the preview. This will show or hide elements
of your printout.
5. Click the Close button to return to the Model Builder workspace.

Exporting a model as an ‘ora’ file

In order to run a simulation, you must export your model as an ‘ora’ file. This file contains the
minimum data required to run a simulation in the Legion Simulator.
Whenever you export a model (‘lgm’) file as an ‘ora’, the QA check runs automatically. You
must fix any errors because a model containing errors cannot be exported.

To export a model as an ‘ora’ file:

1. Select File > Export ORA.
The ‘Export ORA’ dialog box is displayed.
2. Browse to a suitable location for the file.

92
Legion SpaceWorks R6.5.0 User Guide

The file retains the name of the model you are exporting and Model Output File (*.ora) is
automatically selected as the file type.
3. Tick the boxes of any data scenarios you want to export along with the model file (see
Scenarios for further information).
4. Click OK.

Exporting a model for use with FDS

If you want to use your model file in the FDS (Fire Dynamics Simulator) fire-modelling soft-
ware, you must export your model as an FDS file. The FDS software can produce slice files or
Plot 3D files for use with Environment Maps.
The Export FDS process is handled by a four-page wizard, each page of which is covered in
sequence in the following three procedures (pages three and four are contained in the third
procedure). The whole process creates a file which can be opened by FDS software.

To export a model for use with FDS:

1. Select File > Export FDS.
The FDS Data File Wizard is displayed, open on page 1 of 4.
2. Set File Settings:
◊ Enter a File name and click the browse button to specify a location for the file.

You will need to be able to find these files later when setting up Environment Maps in the
Analyser.
◊ Enter the CHID id for the file (max. 30 characters).
◊ Enter a Title for the file (max. 60 characters).
3. Set General Settings:
◊ Enter a Grid cell size (metres).
◊ Enter a Duration (seconds).
◊ Enter a Number of frames.
◊ Specify a Database to use, or click the browse button and select the appropriate data-
base.
◊ Enter a Default surface (the surface definition must be present in the FDS database).
4. Click Next to move to the ‘Fire Settings’ page of the wizard.

To complete FDS Fire Settings:

1. Select either Simple HRRPUA fire or Custom fire.
2. If you selected Simple HRRPUA fire, enter the correct settings for the following fields:
◊ HRRPUA
◊ TMPWAL
◊ Min X, Min Y and Min Z
◊ Max X, Max Y and Max Z
3. If you selected Custom fire, enter a description of the fire in the large text box at the foot
of the dialog box.
4. Click Next to move to the ‘Outputs’ page of the wizard.
The ‘Outputs’ page of the wizard enables you to set up slice files and Plot 3D files.

To complete FDS Outputs:

© 2001–2017 Legion International Ltd 93

Legion SpaceWorks R6.5.0 User Guide

1. To set up a slice file, click the Add button.

The ‘Add/Edit slice file’ dialog box is displayed:
2. Enter the following information:
◊ Enter the relevant Quantity from the drop-down list.
◊ Enter the Frequency (seconds).
◊ Enter the Height (metres).
◊ Click OK on the ‘Add/Edit slice file’ dialog box.
3. Repeat steps 1 and 2 for any additional slice files you wish to add.
4. If you want to generate Plot 3D files, check the box labelled Generate.
5. Enter a Frequency (seconds).
6. Select values from the drop-down lists for each of the five boxes Quantity 1 to Quantity
5, which contain different components of fire-analyses.
7. Click Next to move onto the ‘Other settings’ page of the wizard.
8. Add Custom information if required.
9. If you want to open the FDS file when the wizard is complete, check the box labelled Open
file on completion. This will open a text file when you click Finish.
10. Click Finish to close the wizard.

Defining Analysis Project Settings

If you are using Analysis Objects and analyses within the Model Builder, you can set the vis-
ibility of 'Conditional' analyses and define 'weightings' for Global Generalised Journey Times.
A 'Conditional' analysis is one that has been created to provide metrical data for Direction
Modifiers using conditions, or other Spatial Objects that use conditions to control their Avail-
ability (see 14: Conditions in Models). A 'Reporting' analysis is one that is used to interrogate
an area of the model: these are usually set up in the Analyser rather than the Model Builder
(see 20: Analyses and Graphs).

The reason you might like to hide analyses associated with conditions is to reduce 'clutter'
and to ensure that you don't confuse these kinds of analyses with more standard 'Report-
ing' analyses. This illustration shows the Object Directory listing both 'Conditional' and
'Reporting' analyses.

To define Project Settings:

1. Select Analysis > Project Settings.
2. To hide 'Conditional' analyses within the Object Directory, in the 'Edit <analysis>' dialog
box and from 'Find' search results, check the box labelled 'Hide conditional analyses'.
3. To view or change the Global Generalised Journey Time Weightings, click on the 'Global
GJT Weightings' tab and follow the instructions in GJT: Global Weightings.
4. Click OK to close Project Settings.

94
Legion SpaceWorks R6.5.0 User Guide

Using Help
You can view this User Guide in online form at any time when using Legion SpaceWorks. If
you don't have a working Internet connection, you will be directed to the PDF version of the
guide, which may be out of date; the online Help is updated more frequently.

To open the online Help:

1. Press the F1 key or select Help > Online Help.
The on-line Help window opens. Navigate by using the main table of contents or the index
or by using the toolbar.
If you want to open the PDF guide instead, select Help > User Guide.

The Help toolbar

This diagram indicates the most useful Help toolbar icons.

To search for terms in the Help, use the 'Search' box in the top right-hand corner. Results will
be displayed in the main Help window.

Context-sensitive Help

Some dialog boxes feature a Help icon . Click this icon to display a small Help window con-
taining information or instructions about that particular portion of the dialog box.

Sending feedback
If you would like to send us feedback about Legion software and your experiences using it,
you can send it directly from the 'Help' menu, providing your machine has a valid and active
email application and connection. As well as reporting any technical issues, you could also
send us questions or suggest new features.

To send feedback:
1. Select Help > Send Feedback
2. The ‘Feedback’ dialog box is displayed.
3. Enter your feedback in the box labelled 'Describe your enhancement request or technical
issue'. If you are reporting a crash or problem, please tell us what happened and the steps
that lead up to it.
4. If you want to attach an example file to help with your report, click the Attach button,
browse to the appropriate file and click the Open button. To remove the file, highlight the
required file and click Remove. Add additional files in the same manner.
5. Click the Send button.

© 2001–2017 Legion International Ltd 95

Legion SpaceWorks R6.5.0 User Guide

9: Entity and Supply Types

In this chapter
This part of the guide builds on the information provided about Entities earlier in “Legion Con-
cepts”.
This section covers the following topics:
● About Entity and Supply Types
● Creating and editing Entity Types
● Creating and editing Supply Types

96
Legion SpaceWorks R6.5.0 User Guide

About Entity and Supply Types

‘Entity Type’ refers to a group of Entities within a Legion simulation that share common prop-
erties. These properties are:
● Name–to distinguish the Entity Type when filtering or creating Supply Types.
● Colour–to distinguish visually between different Entity Types during the playback of sim-
ulations and analysis sessions.
● Gender Ratio–initially 50% male/female but you can change the percentages to suit your
model.
● Entity Size–'System defined' or tailor made 'Entity size Profiles' for male and female Entit-
ies.
● Luggage Size–'No luggage'; 'System random' (none, or pick from small, medium or large
ranges); tailor made 'Luggage size Profile'.
● Speed Profile–the distribution defining the speed at which Entities of a particular type
would move if unimpeded.
A Supply Type is a group consisting of two or more Entity Types. For more information about
Supply Types, see Creating and editing Supply Types.

© 2001–2017 Legion International Ltd 97

Legion SpaceWorks R6.5.0 User Guide

Creating and editing Entity Types

When building a Legion model, you should base your decision to create a new Entity Type on
one or more of the following modelling requirements:
● To find the closest match for the pedestrians being modelled, in terms of preferred walk-
ing speed and size.
● To simulate Entities carrying luggage of a particular size.
● To set the appropriate ratio of male to female Entities.

You can also create Entity Types using the Data Template spreadsheet. See Entities work-
sheet.
The following procedures assume that you have a Legion model open within the Model Builder.

Creating an Entity Type

We recommend that you create your Entity Types in the Legion Data Template (see Entities
worksheet) but you can create them manually in the Model Builder as described here.

To create an Entity Type:

1. Click or select Data > Entity Types. The ‘Edit Entity Type’ dialog box is displayed.
The left hand pane of the dialog box already contains a Default Entity Type, based on para-
meters associated with UK commuters. You could use this type for your model, or proceed
to create your own.
2. Click the New button in the top left-hand corner.
3. Enter a meaningful name for the Entity Type in the highlighted box and press Enter.

4. On the 'Appearance' tab select a colour for the Entity Type from the Colour drop-down
list.
5. For the 'Gender Ratio', leave at 50/50 or enter new percentages for 'Males' and 'Females'
if required.
6. For 'Entity Sizes', select one of:
◊ System defined
◊ Size profiles–if you select this option, choose Size Profiles from the drop-down lists
labelled 'Male' and 'Female' (you may need to create these profiles; see Creating an
Entity Size Profile).
7. Select the Luggage Size option that matches your Entity Type:
◊ No luggage
◊ System random (automatic allocation of none, or small, medium, large ranges)
◊ Size Profile (select a profile from the drop-down list; you may need to create one or
more profiles–see Creating a Luggage Size Profile).
8. Click on the Profile tab of the ‘Edit Entity Type’ dialog box.
9. Select an Entity Profile from the drop-down list.
The different Entity Profiles are:
◊ Asian
◊ Chinese
◊ North American

98
Legion SpaceWorks R6.5.0 User Guide

◊ Southern European
◊ UK (this is the default setting)
If you want to apply a user-defined Speed Profile rather than a system profile, see Creat-
ing a User-defined Speed Profile, otherwise continue to the next step.
10. Choose a Speed Profile from the Speed Profile drop-down menu.
Depending on the Entity Profile, the Speed Profile options are:
● Asian
◊ Asian Commuters
◊ Asian Weekend Passengers
◊ Runners
◊ Stadium Users
◊ Tourists
● Chinese
◊ Chinese Commuters
◊ Chinese Weekend Passengers
◊ Runners
◊ Stadium Users
◊ Tourists
● North American
◊ North American Commuters
◊ Runners
◊ Stadium Users
◊ Tourists

Use the ‘Runners’ speed profile with care. It represents people running when leaving a sta-
dium. We recommend that you use this exclusively for modelling stadia and then only for
a small number of Entities, e.g. 25% of the first 5% of people leaving a stadium.
● Southern European
◊ Runners
◊ Southern European Commuters
◊ Stadium Users
◊ Tourists
● UK
◊ Runners
◊ Stadium Users
◊ Tourists
◊ UK Commuters
11. Click Apply or OK to save the new Entity Type. It is added to the ‘Data’ tab of the Model
Builder Object Directory, under Entity Type.

© 2001–2017 Legion International Ltd 99

Legion SpaceWorks R6.5.0 User Guide

A note on Speed Profiles

An Entity’s preferred speed is rarely its actual speed within a simulation. The latter is a func-
tion of crowding, geometry and context. It would be a mistake to try and ‘program’ an Entity
to walk at a certain speed.

You can also create User-defined Speed Profiles using either the Data Template spread-
sheet (see Entities worksheet) or the Edit Data Profiles dialog (see Creating a User-
defined Speed Profile).

Applying a User-defined Speed Profile

You may wish to create your own Speed Profile if:
● None of the available Speed Profiles applies to your Entity Type.
● You have a reliable data set from independent measurements.
● You are carrying out ‘sensitivity testing’.

To complete this procedure, you need to have imported user-defined Speed Profiles into
your model using the Legion Data Template. You can, however, also create Speed Profiles
in the Edit Data Profile dialog.

To apply a User-defined Speed Profile:

1. Follow the procedure Creating an Entity Type, as far as step 8.
2. Select the option User defined speed profile.
3. Select a Speed Profile from the drop-down list labelled 'Flat ground'. If you are happy for
the software to automatically calculate the speed of Entities going up and down stairs, pro-
ceed to step 5.
4. If you have imported customised Speed Profiles for Entities going up and down stairs,
check the following boxes and choose the correct profiles from the associated drop-down
lists:
◊ Stairs up
◊ Stairs down
5. Click Apply or OK to save the Entity Type.

100
Legion SpaceWorks R6.5.0 User Guide

Creating an Entity Size Profile

As mentioned in Creating an Entity Type, you can use 'System defined' Entity sizes or create
your own Entity Size Profiles. This procedure explains how to do so from within the Model
Builder.

You can also create Entity Size Profiles in the Legion Data Template; see Entity profiles
worksheet for instructions.

To create an Entity Size Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profiles’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Size Profile–Entity.
3. Click the New button in the top left-hand corner. A new Entity Size Profile is displayed,
plotted with data to reflect the system's 'Normal distribution' of 'Width (metres) to 'Per-
centage' of Entities.

4. Enter a name for the new profile in the highlighted name field.
5. If you would rather work in the histogram view, click the option button labelled 'His-
togram' to display an empty graph and proceed to step 8 (to change back to the dis-
tribution layout, click the option 'Normal distribution'.
6. If you wish to change the data, enter new values for 'Width' and 'Deviation' by typing new
values or by clicking the up and down arrows next to each field.
7. If you would like to view this data as a histogram instead, click Convert to histogram.

© 2001–2017 Legion International Ltd 101

Legion SpaceWorks R6.5.0 User Guide

8. In the histogram view you can alter the data by entering values into the cells at the foot of
the graph, or by dragging the columns of the graph up and down.

Allocation of data must equal 100%. You will see a percentage indicator to the left of the
y-axis.
9. If at any point you wish to restart, click the Clear button.
10. For any other Size Profiles you would like to create, repeat from step 3.
11. When you are happy with your profiles, click OK to close the dialog.

102
Legion SpaceWorks R6.5.0 User Guide

Creating a Luggage Size Profile

As mentioned in Creating an Entity Type, you can use 'System defined' Entity sizes or create
your own Entity Size Profiles. This procedure explains how to do so from within the Model
Builder.

You can also create Luggage Size Profiles in the Legion Data Template; see Entity profiles
worksheet for instructions.

To create an Entity Size Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profiles’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Size Profile–Luggage.
3. Click the New button in the top left-hand corner. A new Luggage Size Profile is displayed,
populated with data to reflect the system's 'Normal distribution' of 'Area '(square metres)'
to 'Percentage' of Entities.
4. Enter a name for the new profile in the highlighted name field.
5. If you would rather work in the histogram view, click the option 'Histogram' to display an
empty graph and proceed to step 8.
6. If you wish to change the data, enter new values for 'Area' and 'Deviation'.
7. If you would like to view this data as a histogram instead, click Convert to histogram.
8. In the histogram view you can alter the data by entering values into the cells at the foot of
the graph, or by dragging the columns of the graph up and down.

Allocation of data must equal 100%

9. If at any point you wish to restart, click the Clear button.
10. For any other Luggage Size Profiles you would like to create, repeat from step 3.
11. When you are happy with your profiles, click OK to close the dialog.

Editing an Entity Type

You can change the values and parameters of the Entity Types in your model. Editing an Entity
Type is very similar to creating one.

To edit an Entity Type:

1. Click on the Data tab of the Model Builder Object Directory.
2. Expand the Entity Type folder so that you can see the Entity Type you want to edit.
3. Double-click on the Entity Type (or right-click on it and select Edit Properties). The ‘Edit
Entity Type’ dialog box is displayed.
4. Change the values and parameters of the Entity Type as in the procedure Creating an
Entity Type.

© 2001–2017 Legion International Ltd 103

Legion SpaceWorks R6.5.0 User Guide

Creating and editing Supply Types

A Supply Type is a group consisting of two or more Entity Types, split by percentage. Supply
Types are referenced by Entrances, Populated Zones and Evacuation Zones. Occasionally, Dir-
ection Modifiers also reference Supply Types (see Direction Modifiers).
As an example of a useful Supply Type, you might create one containing 65% commuters and
35% tourists for introducing Entities into a station model during peak hours.

You can also create Supply Types using the Data Template spreadsheet. See Entity pro-
files worksheet.

Creating a Supply type

Creating a Supply Type involves naming the new Supply Type and adding Entity Types to it in
the required proportions. The following procedures assume that you have a Legion model
open within the Model Builder.

To create a Supply Type:

1. Click or select Data > Supply Types. The ‘Edit Supply Type’ dialog box is displayed.
2. Click the New button in the top left-hand corner of the dialog box.
3. Enter a meaningful name for the Supply Type in the highlighted box and press Enter.
In the right-hand pane of the dialog box, a chart is displayed featuring rows of the avail-
able Entity Types in your model and columns representing the composition, in per-
centages, of each as part of the Supply Type.

4. There are two ways to add proportions of Entity Types to your Supply Type: click and drag
a percentage across the chart or enter values into the appropriate data cells at the foot of
each column.

104
Legion SpaceWorks R6.5.0 User Guide

◊ To click and drag a percentage into the chart, double-click anywhere within the row
to the right of the name of an Entity Type. Depending on where you click, this will give
you an initial value represented by a coloured bar. Now drag the coloured bar to the
correct value. If you'd like to drag the bar in increments of 0.01% rather than 1%, hold
down the 'Ctrl' key as you drag.
◊ To type percentage values directly into the chart, click into the data cell at the foot of a
column and enter a percentage.

The overall percentage of the Entity Types must total 100%. A counter beneath the chart
indicates the percentages for your guidance.
5. Click Apply or OK to save the new Supply Type. It is added to the ‘Data’ tab of the Model
Builder Object Directory, under Supply Type. A completed Supply Type will resemble the
following.

Editing a Supply Type

At any time, you can change the contents within the Supply Types in your model. Editing a Sup-
ply Type is very similar to creating one.

To edit a Supply Type:

1. Click on the Data tab of the Model Builder Object Directory.
2. Expand the Supply Type folder so that you can see the Supply Type you want to edit.
3. Double-click on the Supply Type (or right-click on it and select Edit Properties). The ‘Edit
Supply Type’ dialog box is displayed.
4. Change the quantities of the Entity Types within the Supply Type, as described in Creating
a Supply type.

© 2001–2017 Legion International Ltd 105

Legion SpaceWorks R6.5.0 User Guide

Exporting and Importing Supply Types

You can export and import Supply Types from your SpaceWorks model by using the com-
mands ExportST and ImportST. This can be useful when you are working on a model that
was originally built in Legion Studio and therefore does not have a Legion Data Template asso-
ciated with it.
The following procedures assume you have SpaceWorks Model Builder running with a model
loaded.

To export Supply Types:

1. Type ExportST (the command should appear automatically in the Command Line) and
press Enter.
A ‘Save As’ dialog box is displayed.
2. Enter a name for the file, select a format (we recommend 'csv') and choose a location for
it.
3. Click Export.
You can now change the data in the exported file by opening it in a spreadsheet pro-
gramme.

To import Supply Types:

1. Type ImportST (the command should appear automatically in the Command Line) and
press Enter.
An ‘Open’ dialog box is displayed.
2. Select the file you wish to import and click OK.
The Supply Types are imported and should be visible in the Object Directory and the ‘Edit
Supply Type’ dialog box.

Creating Entity Colour Schemes

Although Entity Types are assigned colours during the model building phase of a Legion pro-
ject, you can create additional Colour Schemes, which you can apply to Entities when playing
back a simulation or recording an ‘avi’ file. You can create these by applying advanced filters
to Entity attributes in order to highlight Entities pursuing certain objectives or experiencing
certain conditions.

Creating a bespoke Colour Scheme

This section describes how to create your own Colour Scheme and then how to apply filters to
each colour. The task is broken down into two procedures; the first describes how to create
colours, the second how to make them meaningful by applying filters.

To create the colours for a new Colour Scheme:

1. Select Analysis> Entity Colour Schemes.
2. Click on the Colours tab.
3. For each colour you wish to add to the scheme, click the Add button once.
New colours with default names are added, under the headings Name and Colour.
4. To change the default name of a colour, double-click to select it and type a new name in its
place and press Enter. Repeat this step for as many names as you want to change.
5. To change the default colour, double-click on the colour to display a drop-down palette of
optional colours.
6. Select a colour from the palette and then click outside of the coloured box to apply the new
colour. Repeat this step for as many colours as you want to define.

106
Legion SpaceWorks R6.5.0 User Guide

7. If you want to add extra colours, remove colours or move them up or down in the list, high-
light the relevant colour or colours and click the Add, Remove, Up, or Down buttons.
See the next procedure.

To apply filters to colours:

1. Click on the Filters tab.
2. In the Available Entity colours box, highlight one of the colours you just added. Notice
the four control boxes (plus Add button) beneath the Available Entity colours.

These enable you to define a bespoke filtering criterion to apply to a highlighted colour.
3. Set up a filter by either typing the conditions directly into the space below the control
boxes or by selecting options from their drop-down menus. Reading left to right:
◊ Leave blank or select Not.
◊ Select an activity, metric or information type from the second menu (for example,
Activity, Density, Entity ID, etc.).
◊ Select equals (=), less than (<) or greater than (>).
◊ Depending on your selections so far, select an item from this menu or enter a specific
value if required (for example, a density level).
4. Click Add to verify the logic of your selections and to add them to the list of filters for that
colour.
If your criterion contains a logical error, a message is displayed beneath the list in red, for
example. You must correct any errors for your criterion to be saved.
5. Repeat step 3 to add more criteria to either the same colour or a new colour from your
range.
6. Click Apply to save your changes and OK to exit.
Colour Schemes are listed on the 'Data' tab of the Model Builder's Object Directory.

Please note that using colour schemes when playing back simulations can slow down per-
formance.

© 2001–2017 Legion International Ltd 107

Legion SpaceWorks R6.5.0 User Guide

10: Demand—Data and Profiles

In this chapter
To create an accurate representation of how a space will perform under certain levels of
usage, Legion simulations combine accurately modelled space with appropriately defined
levels of pedestrian demand.
This part of the guide focuses on how to specify demand within a Legion model and how to cre-
ate and modify the associated Data Profiles.
This section covers the following topics:
● About Demand Data
● About Data Profiles
● Demand: Origin–Destination Matrices & Arrival Profiles
● The Data Template Spreadsheet
● Manually creating and editing Arrival, Availability, Speed and Event Profiles
● Modifying Arrival, Availability or Event Profile data
● Manipulating demand data (Arrival, Availability and Event Profiles)
● Scenarios

108
Legion SpaceWorks R6.5.0 User Guide

About Demand Data

Specifying the appropriate levels of demand is key to the legitimacy of a Legion Model.
Demand refers not only to the number of pedestrians in, entering or leaving a site, but also to
the type of pedestrians visiting the site, for example: commuters, tourists, etc. The com-
position of the population of a site is defined using Entity and Supply Types (see About Entity
and Supply Types).
The quantitative component of demand is typically presented in the form of an Origin-Destin-
ation matrix and associated Arrival Profiles. The combination of data describes:
● How many pedestrians occupy the site at the start of the simulation period (if any).
● How many pedestrians enter the site during the period to be modelled.
● When pedestrians enter–this can be aggregated over the entire model period or broken
down into specific intervals.
● The entry points used by the pedestrians.
● The proportion of pedestrians going to various destinations within the site.
Demand Data can be defined and introduced into a Legion model in one of two ways:
● The absolute number of pedestrians on site at the beginning of the modelled period. This is
introduced by using Populated Zones and Evacuation Zones (the number of pedestrians
can be specified in a Population Profile or entered manually when adding a zone. See Data
profiles worksheet for more information).
● The arrival of pedestrians over time, distributed over the duration of the modelled period.
This is introduced using Entrances and associated Arrival Profiles.
Demand Data may not always be complete or available in the correct format. You may need
to manipulate or extrapolate the data to create as complete a data set as possible.
It is advisable to test multiple scenarios during modelling to ensure that the space is tested at
the extremes of its demand limits (see Scenarios for further information). In this way, you
can interpret results in the knowledge that the space is being pushed to a level where any iden-
tified problems (congestion, blockages) can be assumed to be the 'worst case'.

© 2001–2017 Legion International Ltd 109

Legion SpaceWorks R6.5.0 User Guide

About Data Profiles

Data Profiles are discrete sets of data that are used in Legion to simulate various factors cru-
cial to accurate modelling. The following Data Profiles are available within Legion
SpaceWorks:
● Population Profile–a profile used with Populated Zones and Evacuation Zones. Specifies
the number and type of a zone's initial population and the destinations of Entities leaving a
zone.
● Arrival Profile–a profile used with Entrances. Used to model the arrival of pedestrians into
a model over time.
● Availability Profile–a profile used with all Spatial Objects except Entrances, Gates, Pop-
ulated Zones and Evacuation Zones. Required when you wish to. specify when an object is
available for use or not within a simulation. They can also be used with CAD Layers to turn
CAD 'on and off' at certain times in a simulation.
● Delay Profile–a profile used with Delay Points and Gates. Used to model one or more delay
distributions that apply over a period of time.
● Event Profile–a profile used with a Direction Modifier. Enables you to select a specific num-
ber of Entities to respond to events at specific times.
● Exit Profile–a profile used with Exits. Used to control the rate of egress of pedestrians
from a model.
● Gate Control Profile–a profile used with Gates. Used to control whether a Gate is set to
operate in one of these states: In, Out, Free In, Free Out, Free Both, Closed.
● Speed Profile–a profile containing preferred walking speeds for use with Entity Types
● Size Profile (Entity)–a profile (histogram or distribution) that specifies the physical size of
Entities.
● Size Profile (Luggage)–a profile (histogram or distribution) that specifies the physical size
of Entities carrying different sizes of luggage.
Arrival Profiles and Event Profiles are time-function histograms used by Legion models to spe-
cify the arrival of Entities through Entrances and the number of Entities affected by Direction
Modifiers, respectively.
Data Profiles can be created within the Model Builder, using the ‘Edit Data Profile’ dialog box,
or they can be set up in the Data Template spreadsheet and imported using the Data Import
Manager. To learn about the Data Template spreadsheet, see The Data Template
Spreadsheet.
Creating Exit Profiles, Delay Profiles and Availability Profiles using the ‘Edit Data Profile’ dia-
log box is described in relation to the Spatial Objects they are used with. See 15: Spatial
Objects–in Detail . Speed, Size and Luggage Size profiles are described in relation to Entity
Types (see Creating and editing Entity Types).

A note on Availability Profiles

Availability Profiles enable you to turn most Spatial Objects ‘on' or 'off’ at specified times and
for specified periods within the runtime of a simulation. The objects that are not affected by
availability are Entrances, Populated Zones and Evacuation Zones. They can also be applied to
CAD Layers to simulate the arrival and departure of trains and other vehicles (see CAD Layers
and Availability Profiles).
Availability Profiles can be created with the Data Template spreadsheet, or set up manually
using the ‘Edit Data Profile’ dialog box. They look similar to Arrival Profiles except within the
graph you are specifying when object(s) are available (‘On’) and unavailable (‘Off’).

110
Legion SpaceWorks R6.5.0 User Guide

Relevant objects have a parameter tab labelled ‘Availability’ where you can specify that the
object use the time scope of a particular Availability Profile. Availability Profiles can also be
used in conjunction with conditions to make them sensitive to operational schemes or events
like emergencies or evacuations. A condition can be entered on the tab labelled ‘Conditions’.
For Direction Modifiers you can specify either an Event Profile or an Availability Profile in their
‘Timescope’ property. When using an Event Profile, the number of pedestrians specified in the
profile in any given time step are affected by the Direction Modifier. When using an Avail-
ability Profile, all Entities within the Direction Modifier when the profile is set to 'On' will be
affected.

© 2001–2017 Legion International Ltd 111

Legion SpaceWorks R6.5.0 User Guide

Demand: Origin–Destination Matrices & Arrival Profiles

The pedestrian demand on a site is expressed in terms of the flow of pedestrians between all
pairs of origins and destinations (for example, Entrances and Exits or Populated Zones and
Exits). A single origin, like the entrance to a station, may have many possible destinations for
the pedestrians using it (several station exits or platforms) just as one exit or destination may
be ‘targeted’ by several origins.
These demand patterns are typically presented in the form of an Origin-Destination matrix
(OD matrix), which is a table mapping either the absolute number of pedestrians moving
between each of the respective origin and destination pairs, or the percentages thereof.

Demand is also expressed in terms of pedestrians entering a site over time and this is typ-
ically reflected in the form of an Arrival Profile. The Arrival Profile defines the arrival of ped-
estrians distributed along a ‘timeline’.

To define the demand within a Legion model, object pairs from the OD matrix are combined
with Arrival Profiles (each Entrance in the model must have at least one Arrival Profile asso-
ciated with it).
As you will see in Creating Arrival Profiles automatically, SpaceWorks comes with a spread-
sheet template that can generate Arrival Profiles from an OD matrix.

Creating an OD matrix
There are two stages to creating a simple OD matrix:
● Define the origins and destinations
● Input the usage data (percentage or number of pedestrians moving between origins and
destinations)

To define the origins and destinations:

Origins can be Entrances, Populated Zones, Evacuation Zones; destinations can be Exits
and Waiting Zones.
1. Define the names of all origins and destinations in your model. The following illustration is
a diagram of a very simple space with entrances, exits and routes to be modelled. The
Entrances (Origins) and Exits (Destinations) need to be represented in the OD matrix.

112
Legion SpaceWorks R6.5.0 User Guide

2. In a spreadsheet, enter the names of all the origins in the first column beginning at cell A2
and moving through A3, A4, etc.
3. Enter the names of all destinations across the first row beginning at cell B1 and moving
through C1, D1, E1 etc.

The Data Template spreadsheet enables you to associate Entity and Supply Types with ori-
gins. See OD matrix worksheet.
4. Enter the data (percentage or number of pedestrians moving between origins and des-
tinations) in the cells where origins and destinations intersect (if there is no required data
for a particular cell, leave it blank).

If you need to split the quantity of pedestrians arriving through an origin by Entity Type, you
can create multiple rows in the Data Template spreadsheet with the same origin name but
associated with as many different Entity Types as you require, see OD matrix worksheet.

Exporting the current OD Matrix for auditing purposes

Over the course of a project you may need to check the expected inputs of a model with the
actual simulated outputs and the current state of the model. It may be that since the Data
Template was imported many tweaks and changes have been made. These might include
changes to Final Destination assignments, alterations to Arrival Profiles, redistributed ratios
of Entities within Supply Types, etc.
Exporting the current OD Matrix as a spreadsheet gives you the information you need to com-
pare with the original stipulations. This can be done at any time and it provides the product
with an audit trail, should any questions arise later (sometimes handing over a project from
one team to another may prompt an audit of original expectations and the actual current state
of the model).
This procedure assumes that you have a model open in the Model Builder.

© 2001–2017 Legion International Ltd 113

Legion SpaceWorks R6.5.0 User Guide

To export an OD Matrix for auditing:

1. Select Data > Export Current OD Matrix.
2. The 'Export Current OD Matrix' dialog box is displayed.
3. Keep the suggested location or navigate to where you would like to save the exported file.
4. Keep the suggest file name (Model OD Matrix - Model Name.xlsx), or enter a new name in
the 'File name' field if required.
5. Click Save to export the data and save it to the excel file.

This tool is only good for checking currently input model data against expected inputs. Dur-
ing simulation, certain things can change in response to model conditions and objects: for
example, Entities can change their Final Destinations en route when affected by conditions
and Direction Modifiers. Looked at in these terms, the only true OD Matrix for a model is
the one produced by the Analyser (see OD Matrices).

114
Legion SpaceWorks R6.5.0 User Guide

The Data Template Spreadsheet

Legion SpaceWorks comes with an Excel spreadsheet template, which enables you to define
and then import the following into the Model Builder: Speed Profiles, Size Profiles (Entity and
Luggage), Entity Types, Supply Types and Data Profiles, along with information about Final
Destinations (if you’d like more information on these, see 5: Final Destinations).

SpaceWorks supports the recent Excel file formats (xlsx and xlsm).
As well as introducing Entity Types, Supplies and Data Profiles into a model, the template can
provide a list of ‘pending’ origin and destination objects with many of their crucial parameters
already defined in Demand Lines. These objects are described as ‘pending’ because the spatial
objects in question still need to be manually placed in the model.
When drawing and placing new Spatial Objects, you will be able to choose from a list of these
imported pre-defined objects; choosing a pending Entrance means that your new Entrance
object will automatically have the correct Demand Line in place.
You can still create and manipulate all your necessary Data Profiles manually: see Manually
creating and editing Arrival, Availability, Speed and Event Profiles and following topics.

What happens in the Model Builder after import?

Successfully importing the data spreadsheet will affect the Model Builder in these ways:
● All imported data and objects appear on a tab in the Object Directory named ‘Imported’.
Data objects are marked with a tick on a green background, while pending spatial objects
(‘pending’ because they are yet to be placed in the model) are marked with a cross on a
red background. After pending objects are placed, this cross changes to a tick on a green
background.

© 2001–2017 Legion International Ltd 115

Legion SpaceWorks R6.5.0 User Guide

● All Data Objects (non-Spatial Objects) are created and added to the model.
● Spatial Objects (the origins and destinations named in the ‘Data Profiles’ worksheet) are
introduced as pending objects. Pending objects can be selected from a drop-down list
when placing and naming origin and destination objects, so that new objects are given
properties from the spreadsheet.
● Pending origin objects (Entrances, Populated Zones and Evacuation Zones) will already
have defined Demand Lines if the necessary information was included on the Data Profiles
worksheet.

Population Profiles don't appear as Data Objects but their origin objects can be selected
from the 'Name' drop-down list when drawing Evacuation Zones.

116
Legion SpaceWorks R6.5.0 User Guide

.
The Data Template spreadsheet
The template we provide is named ‘Legion Data Template.xls’ and, after you have installed
SpaceWorks, it can be found under the ‘Start’ menu, usually in this location: Start > All Pro-
grams > Legion International > Legion SpaceWorks > Data Template.

Depending on your version of Excel, you may be asked to confirm that you want to run
macros with the spreadsheet or indicate that you 'trust' this document. If you don't allow
the template's macros to run, it will not work properly.
The template comprises five worksheets:
● Entity Profiles
● Entities
● OD matrix
● Data Profiles
● Origin Settings

You may find it helpful to save a copy of the spreadsheet to a location of your choice.
Between them they enable you to: define Entity and Supply Types; specify a colour scheme
for Entities; create bespoke speed profiles; paste in or set up an OD matrix; create all the
data profiles you may need.
The ‘Origin Settings’ sheet contains advanced settings that enable you to take the demand
data associated with an origin and fine tune it further. This might involve creating different
train services, establishing the frequency and pattern of services, or manipulating data by
inputting timetable data.
You can also distribute an Arrival Profile across multiple entrances (suborigins) to simulate
alighters from each carriage.

General icons
There are three special icons, which you can find on the toolbar labelled ‘Add-Ins’ or, depend-
ing on your version of Excel, on a floating toolbar visible when you open the workbook:

– QA Worksheet (click this to check the current worksheet for errors; if errors are dis-
covered, a message is displayed to help you resolve the issue).

© 2001–2017 Legion International Ltd 117

Legion SpaceWorks R6.5.0 User Guide

– QA Template (click this to check the whole of the data template for errors. Note that this
can take more time than checking a single worksheet, depending on the amount of inform-
ation in the template. if errors are discovered, the tabs of affected worksheets are highlighted
in red).
– Restore (click this to restore the spreadsheet to its original format if you accidentally
remove some of its functions by, for example, deleting a formula or cutting and pasting
between cells). If you suspect something is working incorrectly, it is always worth clicking
this icon to see if it solves the problem. This icon has a special function when you use it on the
‘Origin Settings’ sheet (see Adding and restoring Origin Tables).

Available and unavailable cells

While specifying Data Profiles in the spreadsheet, you will notice that certain cells are greyed-
out. This means that, for the Data Profile in question, you don’t need to enter any information
in the greyed-out cells.

Entity profiles worksheet

This optional worksheet enables you to name and define profiles to do with Entities: Speed pro-
files, Size profiles and Luggage size profiles. Size and Luggage profiles come in two forms
labelled 'H' (for histogram) and 'D' (for distribution).When they are imported into the Model
Builder as data objects, they will be represented as histograms or distributions accordingly.
You may not need to create any profiles here because you may be happy to use Legion’s pre-
defined speed, size and luggage profiles.
When you first open the worksheet, you will see a list of empty fields labelled 'Profile type'
and 'Profile name'. Any profiles you create will be available for selection on the next work-
sheet page, ‘Entities’.

All percentages must add up to 100%.

To create a Speed Profile:

1. From a 'Profile type' drop-down list select 'Speed'
2. Enter a name for the profile in the empty cell labelled ‘Profile name’.
3. To create a speed profile histogram, enter percentage values for Entities beneath the
appropriate walking speeds (for example, beneath ‘0.6’ m/s, ‘0.9’ m/s, ‘1.2’ m/s, etc.).
4. Repeat steps 1 to 3 for any additional profiles you would like to create.

To create an Entity size Profile (histogram):

1. From a the 'Profile type' drop-down list select 'Entity size (H)'
2. Enter a name for the profile in the empty cell labelled ‘Name’.
3. To create an Entity size profile histogram, enter percentage values beneath the appro-
priate sizes of Entity (diameter in metres).
4. Repeat steps 1 to 3 for any additional profiles you would like to create.

To create an Entity Size Profile (distribution):

1. From a the 'Profile type' drop-down list select 'Entity size (D)'
2. Enter a name for the profile in the empty cell labelled ‘Name’.
3. To create a distribution of Entity sizes (diameter in metres) , enter values for 'Mean' and
'Standard deviation' in the appropriate cells.
4. Repeat steps 1 to 3 for any additional profiles you would like to create.

To create a Luggage size Profile (histogram):

1. From a the 'Profile type' drop-down list select 'Luggage size (H)'

118
Legion SpaceWorks R6.5.0 User Guide

2. Enter a name for the profile in the empty cell labelled ‘Name’.
3. To create an Luggage size profile histogram, enter percentage values beneath the appro-
priate sizes of Entity size (area in square metres).
4. Repeat steps 1 to 3 for any additional profiles you would like to create.

To create a Luggage Size Profile (distribution):

1. From a the 'Profile type' drop-down list select 'Luggage size (D)'
2. Enter a name for the profile in the empty cell labelled ‘Name’.
3. To create a distribution of Luggage sizes (area in square metres) , enter values for 'Mean'
and 'Standard deviation' in the appropriate cells.
4. Repeat steps 1 to 3 for any additional profiles you would like to create.

Entities worksheet
This worksheet enables you to create Entity Types and organise your Supply Types.

Creating Entity Types with the Data Template spreadsheet

Use the top section of the ‘Entities’ worksheet, labelled ‘Entity Types’. To create an Entity
Type you need to define name; colour; Entity category; Gender ratios; and Size and Speed
Profiles in the same column.

To create an Entity Type:

1. In the cell to the right of the cell labelled ‘Name’, enter a name.
2. In the cell beneath (next to ‘Colour’), either leave the colour as it is or click the 'Fill' icon
on the toolbar and pick a colour from the palette (different versions of Excel may
have different methods for changing the colour of cells).
3. In the cell beneath (next to ‘Category’), select a category from the drop-down list.
4. In the cell beneath (next to 'Gender'), enter a percentage for males (any remaining per-
centage will be female).
5. In the cell beneath (next to ‘Entity size’) select Default to use system settings or Custom
to use an Entity Size Profile.
◊ If you choose Custom, select profiles from the drop-down lists labelled 'Male' and
'Female'.
6. In the cell beneath (next to ‘Speed Profile-Flat Ground’), select a profile from the drop-
down list (look out for profiles you may have created on the ‘Entity profiles’ worksheet).
7. In the cell beneath (next to ‘Luggage’), select a luggage size from the drop-down list (this
includes: None, Small, Medium, Large, Random plus any Luggage size Profiles you created
on the Entity Profiles worksheet).
8. In the cell beneath (next to ‘Flat Ground’), select one of the available profiles from the
drop-down list (this includes built in profiles related to the 'Category' of Entity you chose in
step 3 plus any Entity Speed profiles you created on the 'Entity profiles' worksheet).
9. For the cells labelled 'Up and 'Down' you can choose one of the following options from
their drop-down lists:
◊ Inferred (software will calculate the speed of Entities going up or down stairs.)
◊ Any other profiles you created on the 'Entity profiles' worksheet (
10. Repeat steps 1 to 6 for any further Entity Types you want to create, filling in new cells
and columns as you progress across the worksheet.

© 2001–2017 Legion International Ltd 119

Legion SpaceWorks R6.5.0 User Guide

Creating Supply Types with the Data Template spreadsheet

Use the bottom section of the ‘Entities’ worksheet, labelled ‘Supply Types’. To create a Supply
Type, you need to define its name and add percentage values for the different Entity Types
you want it to contain.

To create a Supply Type:

1. In an empty cell in the column labelled ‘Supply Type name’, type in a name.
The cells to the right of this name belong to columns headed by the names of Entity Types
and are used for specifying the percentage of Entity Types that comprise the Supply Type.
2. Find an Entity Type that you want to add to your Supply Type, and, where its column inter-
sects with the Supply Type row, add a percentage for the Entity Type (for example, enter
50% where ‘Supply Type 1’ and ‘Tourists’ intersect if you need half of your Supply Type to
consist of ‘Tourists’.

Each Supply Type must eventually have a ‘Composition’ of 100% to avoid an error.
3. Repeat step 2 for any further Entity Types you would like to add to your Supply Type.

OD matrix worksheet

In this worksheet you can paste in, or manually create, an OD matrix for your model. For
detailed information about the role of OD matrices and how to prepare them, please see
Demand: Origin–Destination Matrices & Arrival Profiles.
This worksheet also enables you to assign Entity Types/Supplies to origin objects and to cre-
ate simple colour schemes for Entities based on the colour of the destinations they are tar-
geted to.
The following procedure assumes you have an OD matrix that you wish to paste in. The steps
are the same if you are creating a matrix from scratch, you just need to input data manually,
rather than paste it.

Pasting OD matrix data into the spreadsheet

The first thing you need to do is specify whether the pedestrian data you are about to enter is
expressed as percentages or as absolute numbers.

You can reference other workbooks and worksheets if you prefer, rather than paste data;
see Excel documentation.

To paste OD matrix data into the spreadsheet:

1. In the cell labelled ‘Is the OD matrix specified in percentage?’, select Yes or No from the
drop-down list.
If you choose ‘Yes’, the values you enter for each origin must add up to 100%. If you
choose ‘No’, enter the exact number of pedestrians.
2. Paste your column of origins into column B in the spreadsheet, underneath the heading
‘Origins’.
3. Paste the names of the destinations next to the label ‘Destinations’ and across columns E,
F, G and so on.

120
Legion SpaceWorks R6.5.0 User Guide

To specify Entity choice for an OD value, enter c rather than an absolute number or per-
centage. See A note on Entity Choice for more information.

4. Click in the cell beneath (next to ‘Colour’), click the 'Fill' icon on the toolbar and pick
a colour from the palette (different versions of Excel may have different methods for chan-
ging the colour of cells)
5. Paste the appropriate values (numbers or percentages) into the cells where origins and
destinations intersect.
6. In the cell immediately to the right of each origin name, select an Entity or Supply Type
from the drop-down list.

Different Entity Types/Supplies per origin

It is possible to enter more than one row containing the same origin (for example Train N
below) and to associate each row with a different Entity Type or Supply Type. You may need
to do this when different Entity Types or Supply Types leave the same origin and head towards
different destinations
The following example has the same single origin (Train N) represented on two rows: dif-
ferent proportions of passengers will alight from this train and make their way to different des-
tinations: the street exit, train 1, or train 2.

When Arrival Profiles are automatically created on the Data Profiles sheet, they are given the
name of the ‘Origin’; any origin that appears more than once will be automatically numbered
‘...#001’, ‘...#002’, in the usual Legion manner (see Creating Arrival Profiles automatically).

A note on Entity Choice

If you would like Entities to select their own destination rather than prescribe a set percentage
or absolute number, enter the letter c in the cells where origin and destination coincide. This
means that Entities will choose their targets according to their shortest distance.
When this is imported into the Model Builder the Final Destinations of the Demand Line in ques-
tion will display ‘by Entity Choice’ parameters, rather than ‘by Percentage Weighting’.

© 2001–2017 Legion International Ltd 121

Legion SpaceWorks R6.5.0 User Guide

Creating Population Profiles Automatically

Population Profiles enable you to specify how many Entities, and which type of Entities,
occupy Populated Zones or Evacuation Zones at the start of a model's run time. You can cre-
ate them automatically from your OD Matrix by using the Data Template. You can also create
them manually if you need to.

To Create a Population Profile Automatically:

1. On the ‘OD Matrix’ worksheet, enter the relevant ‘Origins’, ‘Destinations’, ‘Entity Types’
and ‘Composition’.
2. On the ‘Data Profiles’ worksheet, click the Create profiles from OD Matrix button.
3. Arrival Profiles are created, with data in the columns marked 'Profile Type', 'Profile
Name', 'Origin Name', 'Supply/Entity Type', 'Destination' and 'Input' (this column will con-
tain the population as an absolute number).
4. To change an Arrival Profile to a Population Profile, simply select ‘Population’ from the
drop-down list labelled ‘Profile type’.

Data profiles worksheet

The fourth worksheet enables you to do several things: generate Arrival Profiles automatically
from your OD matrix; define Population and Arrival Profiles manually; and define any of the
other types of Data Profile you may need in your model (Availability, Event, Exit, Delay, and
Gate Control Profiles).
You can also set the start and end times of your model runtime on this page by entering the
correct hh:mm:ss values in the boxes labelled ‘Model Start Time’ and ‘Model End Time’.

122
Legion SpaceWorks R6.5.0 User Guide

This worksheet also contains a useful ‘Profile options table’, which lists all the data profiles
you can create and the types of information that are necessary or optional. This table contains
helpful ‘Tool Tip’ comments: to see them, hover your cursor over a cell that contains a blue tri-
angle tag.
This screenshot illustrates completed Data Profile settings and a ToolTip comment.

A note on ‘Spread’ values

‘Spread’ takes demand and distributes it uniformly across a specified time period. When you
create Arrival profiles automatically, the ‘Spread’ value is set to cover the model’s runtime.
So, for a model that runs for one hour, and for which only a start time and an end time have
been defined, the Spread value is automatically entered as ‘3600’ (spread is always
expressed in seconds).

Remember that you can have as many different model timelines as you need. All data pro-
files refer to the timeline beneath which they appear.
If you define more time intervals (for example, if you split a model’s runtime into five-minute
intervals), data will be distributed across these individual time intervals according to the
value in the ‘Spread’ column.
If you leave the Spread value blank, the data will be evenly spread across your model runtime
(or within each interval if you have a more detailed timeline). If a spread value exceeds a
time interval, any left-over demand is added to the next interval (unless the interval is the
last in the sequence).

If you leave the ‘Spread’ cell blank for an Arrival Profile, the data within each interval will
be spread uniformly across the interval; if you enter 1, no spread will occur.

Creating Arrival Profiles automatically

The quickest and easiest way to create Arrival Profiles is by generating them automatically
from an OD matrix: this method will only work if you have correctly defined one on the ‘OD
matrix’ worksheet.

To create Arrival Profiles automatically:

1. Click the button labelled ‘Create Profiles from OD matrix’.
Arrival Profiles are generated and the relevant data appears in the columns labelled ‘Pro-
file type’, ‘Profile name’, ‘Origin name’, ‘Supply/Entity Type’. A ‘Spread’ value is auto-
matically defined to span the model’s runtime. If an origin appears more than once, the
profiles will be numbered ‘<origin>#001’, ‘<origin>#002’, etc.
2. To add a range of statistical noise to your data, specify minimum and maximum levels in
each profile’s ‘Noise’ cell, separating them with a comma.

© 2001–2017 Legion International Ltd 123

Legion SpaceWorks R6.5.0 User Guide

For example, if you set minimum and maximum limits of 2 and 5, a cell containing an ini-
tial quantity ‘10’ will ultimately be modified to contain between 5 & 8 (if noise is sub-
tracted) and between 12 and 15 (if noise is added).
3. If you want to change the time over which the data is spread, enter a new value (in
seconds) in the cell labelled ‘Spread’.
4. If your OD matrix was specified in percentages rather than actual number of pedestrians,
you will need to enter actual numbers for each time interval of your model runtime.

If you would like to rename an Arrival Profile after creating it automatically, enter the new
name in the relevant ‘Profile name’ cell.

Creating an Arrival Profile manually

You can also create Arrival Profiles manually by entering the required information into the
worksheet.
In this procedure, if you want to create a pending Entrance after import (with an associated
Demand Line) then you must supply the Origin name, Supply/Entity Type and Destination; if
you just want to import the Arrival Profile, leave these three options blank.

To create an Arrival Profile manually:

1. Enter a start and end time for your profile in columns J and K underneath the heading
‘Time intervals [hh.mm.ss]’
2. In the first cell of a new row, select Arrival Profile from the drop-down list.
3. In the next cell along, enter a name in the column labelled ‘Profile name’.
4. In the next cell along, select an ‘Origin name’ from the drop-down list or type in your own.

You will receive a warning message if you enter origin or destination names that do not
appear in the OD matrix but you can still import the data into the Model Builder.
5. In the next cell along, select a ‘Supply/Entity Type’ from the drop-down list.
6. In the next cell along, select a ‘Destination’ from the drop-down list, or type in your own.
7. To add a range of statistical noise to your data, specify minimum and maximum levels in
each profile’s ‘Noise’ cell, separating them with a comma.
8. If you wish to spread the OD matrix data over the course of the model runtime or over a
specific time, enter a value (in seconds) in the cell labelled ‘Spread’, equivalent to the
runtime of the simulation.
9. Add the total number of demand in the first cell of the profile (column J in our template). If
you want to add precise data linked to specified time intervals, see the next procedure.

Leaving the ‘Spread’ cell blank will spread the data over any defined time intervals.

Defining precise Arrival Profile data

In many cases, especially in the early stages of a project before more accurate survey data is
available, simply spreading the data in the OD matrix between the start and end times of a
model will be sufficient.
For more accurate profiles, possibly including peak demand periods or ‘peaks within peaks’,
you can define precise time intervals and enter values for each.

124
Legion SpaceWorks R6.5.0 User Guide

You can define a single row of time intervals for all your Arrival Profiles or create indi-
vidual rows for particular Entrances.

To define precise Arrival Profile data:

1. Underneath ‘Time intervals [hh.mm.ss]’ on the right-hand side of the Data Profiles work-
sheet, add a row of time intervals for the length of your model’s runtime (for example,
you might need increments of 15 minutes).
2. Under each time interval, enter the numbers of pedestrians entering the model.
3. Ensure you have the correct value in your ‘Spread’ column (see A note on ‘Spread’ values
if you require more information).
4. Repeat steps 1 to 3 for any other rows of time intervals you need to define.

Creating Availability Profiles

Availability Profiles can be used with Spatial Objects to turn them ‘on’ or ‘off’ at specific times
within a simulation. For instance, you may want to keep some ticket windows closed until
peak hour and then make them available during the busy period.
This procedure assumes that your Data Profile page already contains time intervals as
described in step one of To define precise Arrival Profile data:.

To create an Availability Profile:

1. In the first cell of a new row, select Availability Profile from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’.
3. For each time division in which you want an object to be available, click in the cor-
responding cell and type on.
4. For each time division in which you want an object to be unavailable, click in the cor-
responding cell and type off.

You can also create Availability Profiles when generating frequency based arrivals on the
‘Origin Settings’ worksheet; see Creating Availability Profiles (Frequency based settings).
For the relationship between Availability Profiles and Gate Control Profiles, see Gates,
Gatelines, Gate Control Profiles and Availability Profiles.

Creating Event Profiles

Event Profiles are similar in form to Arrival Profiles but, rather than introduce Entities into a
model, they define how many Entities are affected by an event within the simulation and when
they are affected.
To complete an Event Profile, you need to have defined time intervals for your model as
described in step one of To define precise Arrival Profile data:. You can use existing time inter-
vals if you have them, or enter new ones on a fresh row.

To create an Event Profile:

1. In the first cell of a new row, select Event Profile from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’.
3. To add a range of statistical noise to your data, specify minimum and maximum levels in
each profile’s ‘Noise’ cell, separating them with a comma.
4. If you wish to spread your data over the course of the model runtime or over a specific
time, enter a value (in seconds) in the cell labelled ‘Spread’. If you need more information
about the Spread value, see A note on ‘Spread’ values.

© 2001–2017 Legion International Ltd 125

Legion SpaceWorks R6.5.0 User Guide

5. Under each relevant time interval, enter the numbers of Entities you would like to be
affected by the event associated with this Event Profile.

Creating Exit Profiles

Exit Profiles are used to limit the number of Entities leaving the model through an Exit at cer-
tain times within a simulation. You might use an Exit Profile to make sure that only a small
number of Entities are able to leave your model when, for example, there is some congestion
beyond an Exit that is not explicitly simulated by your model.
To complete an Exit Profile, you need to have defined time intervals for your model as
described in step one of To define precise Arrival Profile data:. You can use existing time inter-
vals if you have them, or enter new ones on a fresh row.

To create an Exit Profile:

1. In the first cell of a new row, select Exit Profile from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’.

If you enter 2, this means that two Entities per minute will be allowed to leave through the
Exit for the duration of the time interval.
3. Under each relevant time interval, enter the number of Entities per minute that are
allowed to leave through the Exit at this point.

Creating Delay Profiles

A Delay Profile determines how and when Entities are delayed when they are affected by a
Delay Point. They are used to model temporal elements, such as the time taken to be serviced
at ticket machines or the length of time passengers spend inside a store.
To complete a Delay Profile, you need to have defined time intervals for your model as
described in step one of To define precise Arrival Profile data:. You can use existing time inter-
vals if you have them, or enter new ones on a fresh row.
There are three types of delay you can specify:
● Fixed delay of–enter a fixed delay period, in seconds.
● Wait until–enter the model time up until which you would like Entities to wait, or select a
Condition which defines when their wait is over.
● Variable delay of–enter values in seconds for a Boltzmann Distribution (this requires
you to enter values for min, mean and max values).
You can also define at which time over the course of a simulation these delay periods are
effective. For example, you can create a Delay Profile which delays Entities for 12 seconds but
is only active for a certain ten minute period of the simulation; you can set a profile which
endures throughout the whole length of the simulation, or one that is effective at different peri-
ods of the simulation.

To create a Delay Profile:

1. In the first cell of a new row, select Delay Profile from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’.
3. Under each relevant time interval, enter the type of delay you require at that point in the
model’s runtime. There are three methods ('Wait until' requires either a model time or a
Condition):
◊ To add a Fixed delay, enter a single value in seconds (this will delay affected Entities
by this amount across the time interval).
◊ To instruct affected Entities to Wait until a specific time, enter the time using the
format hh:mm:ss.
◊ To instruct affected Entities to Wait until a pre-defined Condition is met.

126
Legion SpaceWorks R6.5.0 User Guide

◊ To specify a Variable delay, enter three values separated by commas for the min,
mean and max values.

Creating Population Profiles Manually

Population Profiles enable you to specify how many Entities, and which type of Entities,
occupy Populated Zones or Evacuation Zones at the start of a model's run time. You can cre-
ate them automatically from your OD Matrix by using the Data Template. You can also create
them manually on the Data Profiles worksheet.

To Create a Population Profile Manually:

1. On the Data Profiles worksheet, in the first cell of a new row, select Population Profile
from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’
3. In the next cell along, select an ‘Origin name’ from the drop-down list or type in your own.

You will receive a warning message if you enter origin or destination names that do not
appear in the OD matrix but you can still import the data into the Model Builder.
4. In the next cell along, select a ‘Supply/Entity Type’ from the drop-down list.
5. In the next cell along, select a ‘Destination’ from the drop-down list, or type in your own.
6. In the cell that corresponds to the 'Input' column, enter the number of Entities you require
for the population of the Evacuation Zone.

Delay Profiles
A Delay Profile determines how and when Entities are delayed when they are affected by a
Delay Point. They are used to model temporal elements such as the time taken to be serviced
at ticket machines or the length of time passengers spend inside a store.
As well as specifying a delay period, you can also define at which time over the course of a
simulation, this delay period is effective. For example, you can create a Delay Profile which
delays Entities for 12 seconds but is only active for a certain ten minute period of the sim-
ulation.
You can set a profile which endures throughout the whole length of the simulation, or one that
is effective at different periods of the simulation. You can also specify whether a delay is
fixed, whether it applies until a certain simulation time or whether it varies.

To create a Delay Profile (single period of time):

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Delay Profile.

You can also create Delay Profiles using the new Data Template spreadsheet; see Creating
Delay Profiles
3. Click the New button in the top left-hand corner. A new ‘empty’ profile is displayed at the
top of the ‘Delay Profile’ tab.
4. Click the Add button on the right-hand side of the dialog box. A red ‘time block’ appears in
the profile, spanning the whole of the simulation time.
5. Click on the time block to select it. The Delay Settings parameters become available.

To remove a time block from a profile, click on it and then click the Remove button.

© 2001–2017 Legion International Ltd 127

Legion SpaceWorks R6.5.0 User Guide

6. To set a particular duration for the Delay Profile, change the times in the Start and End
boxes.
7. Select the type of delay you want to apply from the three):
◊ Fixed delay of–enter a fixed delay period, in seconds.
◊ Wait until–enter either the model time up to which you would like Entities to be
delayed or select the 'Condition' option and click the Condition button to set up a con-
ditional circumstance like density or count inside.
◊ Variable delay of–enter values in seconds for a Boltzmann Distribution (this requires
you to enter values for min, mean and max values).
The different types of delay are colour coded: ‘Fixed’ is red, ‘Delay until’ green, ‘Variable
delay’ blue.
8. Choose one of the two Action at End Time options to apply at the end time of the delay
profile is reached:
◊ Continue being delayed-if an Entity steps into a Delay Point while this particular
delay is still active, it will be delayed for the full duration assigned to it (for example
12 seconds), even if the delay expires in the meantime.
◊ Stop being delayed-a delayed Entity will not be further delayed beyond the End Time
of this time block.
The following procedure explains how to create a Delay Profile with three different types of
delay and three different time periods.
The Action at End Time options (‘Continue being delayed’ and ‘Stop being delayed’), men-
tioned in step 10, instruct Entities to either wait for the full delay period to stop waiting when
the End Time of the particular delay (time block) is reached.
For example, an Entity may step into a Delay Point which has a fixed delay of 12 seconds as
part of a delay period which is about to expire in 4 seconds. If the option selected is ‘Continue
being delayed’, this Entity will be delayed for the full 12 seconds but if the option is ‘Stop
being delayed’, the Entity will be delayed only for the remaining 4 seconds of the particular
delay’s time period.

To create a Delay Profile (three periods of time):

1. Follow steps 1 to 5 of To create a Delay Profile (single period of time):.
2. Change the End time of the initial time block so that it ends shortly after the simulation
start time. The length of the time block is shortened.
3. Choose one of the two Action at End Time options to apply at the end of this time block.
4. To add a second time period, click the Add button. A second time block is added to the end
of the first period and until you change its start and end times, continues to the end of the
simulation time.
5. Change the Start and End times of this second time block.
6. Click the Wait until option and enter either the model time up to which you would like
Entities to be delayed or select the 'Condition' option and click the Condition button to set
up a conditional circumstance like density or count inside.
7. Repeat steps 3 and 4.
8. Click the Variable delay of option and enter min., mean and maximum values.

Fixed and Variable Delays

These options are best suited to delays related to services, such as ticket gates, ticket
machines or other activities that have a definable service time. A fixed delay is best suited to
a highly regular operation whereas a variable delay is suitable for services where the oper-
ator or customer’s actions influence the delay.

128
Legion SpaceWorks R6.5.0 User Guide

‘Delay until’ Delays

The ‘Delay until’ option is best suited to delays caused by ‘events’, such as the departure of a
train, the opening of a gate, etc. where the time of the event is fixed but the number of Entit-
ies affected by the event is not.

Deleting, renaming and copying Delay Profiles

Use the relevant buttons in the top left-hand corner of the Edit data to delete, rename and
copy Delay Profiles as required. See Copying a Data Profile (Arrival or Event) and subsequent
procedures for further information if required.

Locking Delay Profiles

To prevent accidental changes to a Delay Profile once you have defined it, check the box
labelled 'Lock profile'.

Gate Control Profiles

Gate objects are linked to Gate Control Profiles to determine how they operate over time dur-
ing a simulation. As mentioned in Gates , the Model Builder provides three ready- made
profiles: 'Always Closed', 'Always IN' and 'Always OUT' but you can create your own more
refined Gate Control Profiles in the Legion Data Template or by using the 'Edit Date Profile' dia-
log box.
When you create your own profile, you can define when a Gate is in one of the following
modes during a simulation:
● IN–the Gate allows pedestrians to pass from unpaid to paid areas.
● OUT–the Gate allows pedestrians to pass from paid to unpaid areas.
● FREE IN–the Gate allows pedestrians to pass from unpaid to paid areas without the delay
caused by tickets or smart cards.
● FREE OUT–the Gate allows pedestrians to pass from paid to unpaid areas without the delay
required for tickets or smart cards.
● FREE BOTH–the Gate allows pedestrians to pass in either direction without the delay
required for tickets or smart cards.
● CLOSED–the Gate is shut.
See Creating Gate Control Profiles for instructions on how to create profiles using the Legion
Data Template or the 'Edit Date Profile' dialog box.

The relationship between legacy gatelines from earlier versions of SpaceWorks and Gate
objects (version R6.5.0 onwards) requires that Gate Control Profiles can be created from
Availability Profiles and also that Availability Profiles can be created from Gate Control Pro-
files. See Gates, Gatelines, Gate Control Profiles and Availability Profiles.

Creating Gate Control Profiles

This topic describes how to create a Gate Control Profile by using the Legion Data Template
and the manual method using the 'Edit Data Profiles' dialog. If you need a recap on the tem-
plate, see The Data Template Spreadsheet.
This first procedure assumes that the 'Data profiles' worksheet of the Data Template is open
and already has Model Properties (start and end times) and 'Time intervals' in place, as illus-
trated in Data profiles worksheet.

To create a Gate Control Profile using the Legion Data Template:

1. In the first cell of a new row, select Gate control from the drop-down list.
2. In the next cell along, enter a name in the column labelled ‘Profile name’.

© 2001–2017 Legion International Ltd 129

Legion SpaceWorks R6.5.0 User Guide

3. In each 'Time interval' cell that intersects with your profile's row (these cells are in
columns J, K, L and so forth), type in one of the required states for your Gate:
◊ IN
◊ OUT
◊ FREE IN
◊ FREE OUT
◊ FREE BOTH
◊ CLOSED

The final Time interval cell must be left blank.

4. Save and/or exit the template.

To create a Gate Control Profile using the 'Edit Data Profiles' dialog:

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Gate Control Profile.
3. Click the New button in the top left-hand corner. A new ‘empty’ profile is created and
added to the left-hand column. If you wish, you can rename the profile by highlighting the
given name and entering a new name.
The parameters of the new profile are displayed in the main part of the dialog:

130
Legion SpaceWorks R6.5.0 User Guide

1. Click Add. A new time block is added to the profile. You can edit this to reflect required
time period and mode of operation in the panel labelled 'Gate Mode Settings' in the fol-
lowing steps.
2. For 'Active Period', input Start and End times for the time block.
3. For 'Gate Mode' select the required option from the drop-down menu:
◊ IN–these blocks are coloured green.
◊ OUT–these blocks are coloured red.
◊ FREE IN–these blocks are coloured blue.
◊ FREE OUT–these blocks are coloured purple.
◊ FREE BOTH–these blocks are coloured orange.
◊ CLOSED–these blocks are coloured black.
This screenshot shows a Gate Control Profiles containing each of these time blocks
(modes).

As the interface text states, any time gaps in the profile will be as if the Gate were
CLOSED, so you can leave gaps in the profile's timeline rather than adding CLOSED blocks
if you prefer.
4. Repeat steps 4 to 6 for additional time blocks you would like to add to the profile.
5. If you would like to secure the profile against accidental changes to it, check Lock
profile.
6. Click OK or Apply to save the profile.

© 2001–2017 Legion International Ltd 131

Legion SpaceWorks R6.5.0 User Guide

The relationship between legacy gatelines from earlier versions of SpaceWorks and Gate
objects (version R6.5.0 onwards) requires that Gate Control Profiles can be created from
Availability Profiles and also that Availability Profiles can be created from Gate Control Pro-
files.

Gates, Gatelines, Gate Control Profiles and Availability Profiles

The Gate object was introduced in SpaceWorks R6.5.0 and makes it much easier to draw,
place and define single gates (see Gates for more information). Models from earlier versions
of the software used combinations of objects to create gates in a gateline (typically Delay
Point + Direction Modifier + Focal Node + Route Guide). These objects, with their associated
Delay Profiles and Availability Profiles, simulated the physical character of gates and handled
the way in which Entities used them, how long they took while using them, and how they
moved when gates and gatelines were open, closed, in, out, paying, free, or reversed during
everyday operations.
When using the more recent Gate objects, you may need or wish to recreate and reuse earlier
Availability Profiles, effectively setting their states in line with earlier operational settings
defined using these other objects. To this end you can create Gate Control Profiles from pre-
vious Availability Profiles and their predefined 'On' an 'Off' states. In this way you can use
these 'On' and 'Off' states as the basis for the states of a Gate. For example, you can take the
'On' settings of an Availability Profile and use them to define when a Gate is IN or OUT or
CLOSED, and so on. You can also use an Availability Profile's 'Off' settings in the same way. In
this manner, a new Gate Control Profile can mirror an Availability Profile and the logic of an
earlier model can be maintained.
Similarly, you may need or wish to instruct Entities how to move when Gates are closed or
their direction is reversed from IN to OUT and possibly back again; or when they are closed
during a simulation. In order to enable Direction Modifiers to send Entities away from closed
Gates to open Gates or to instruct them to use more newly available open Gates, you can cre-
ate Availability Profiles (used by DMs) from your Gate Control Profiles.
Both methods are described here.

To Create a Gate Control Profile from one or more Availability Profiles:

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Gate Control Profile.
3. Click the New button in the top left-hand corner. A new ‘empty’ profile is created and
added to the left-hand column. If you wish, you can rename the profile by highlighting the
given name and entering a new name.
4. Right-click on the name of the new profile and select Convert from Availability Profile
(s).
The 'Gate Control Profile from Availability Profile(s)' dialog is displayed.

132
Legion SpaceWorks R6.5.0 User Guide

5. For each 'Gate Mode' that you would like to set in your Gate Control Profile (IN, OUT, FREE
IN, FREE OUT, FREE BOTH, CLOSED), you can now select settings from a previous Avail-
ability Profile to specify when the state is active. As an example, let's set the IN state.
6. In the IN row, double- click in the 'Selection' cell and choose 'Direct' or 'Inverse' ('Not
used' is the default choice and just means that you will ignore this Gate Mode entirely):
◊ Direct–this will use the Availability Profile's 'On' states to define when your Gate is set
to be an IN Gate.
◊ Inverse–this will use the Availability Profile's 'Off' states to define when your Gate is
set to be an IN Gate.
7. Double-click in the 'Availability Profile' cell and choose an Availability Profile from the
drop-down list (if you have none, you will need to import or create at least one).
8. In the 'Pulse Mode' cell, either leave 'As AV Profile' to preserve the profile's original Pulse
settings (and skip to step 10), or double-click and select 'Custom' to add your own value.
9. If you selected 'Custom', double-click in the 'Pulse Duration' cell and enter your own value
(in seconds).
10. Repeat steps 6 to 8 for any more Gate Modes you would like to set. Remember that you
can use the same Availability Profile or different Availability Profiles for each mode.
11. Click OK to save your changes and create your Gate Control Profile(s). Successfully cre-
ated profiles will appear in the Object Directory and in the 'Edit Data Profile' dialog.

To Create one or more Availability Profiles from a Gate Control Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Gate Control Profile.
3. Right-click on the name of the Gate Control Profile you want to use as the basis for cre-
ating the Availability Profile or Profiles and select Convert to Availability Profile(s).
The 'Availability Profile(s) from Gate Control Profile' dialog is displayed.

© 2001–2017 Legion International Ltd 133

Legion SpaceWorks R6.5.0 User Guide

4. For each 'Gate Mode' of the Gate Control Profile (IN, OUT, FREE IN, FREE OUT, FREE
BOTH, CLOSED), you can now create an Availability Profile based on its settings. As an
example, let's use the IN state.
5. In the IN row, double- click in the 'Selection' cell and choose 'Direct' or 'Inverse' ('Not
used' is the default choice and just means that you will ignore this Gate Mode entirely):
◊ Direct–this will use the Gate Control Profile's 'IN' mode to define 'On' periods in the
new Availability Profile.
◊ Inverse–this will use all modes not defined as 'IN' in the Gate Control Profile to define
'Off' periods in the new Availability Profile.
6. Double-click in the 'Availability Profile' cell and enter a name for the new Availability Pro-
file.
7. In the 'Pulse Mode' cell, either leave 'As Gate Profile' to preserve the profile's original
Pulse settings (and skip to step 9), or double-click and select 'Custom' to add your own
value.
8. If you selected 'Custom', double-click in the 'Pulse Duration' cell and enter your own value
(in seconds).
9. Repeat steps 5 to 7 for any more Availability Profiles you would like to create. Each row
you complete in this dialog will create a new Availability Profile based on your settings.
10. Click OK to save your changes and create your Availability Profile(s). Successfully cre-
ated profiles will appear in the Object Directory and in the 'Edit Data Profile' dialog.

Origin Settings worksheet

This optional worksheet is designed to enable you to take the demand data associated with an
origin (Entrance, train, vehicle, etc.) and fine tune it further to create train carriage dis-
tributions, services and sequences (‘continuous’ or ‘periodic’) of any services you may wish to
combine. In many case you will not need to use this sheet but it can be very useful when you
do.
For each origin you choose there is an ‘Origin Table’ comprising two main sections, which you
can use separately or together: ‘Split into suborigins?’ and ‘Frequency based?’.

134
Legion SpaceWorks R6.5.0 User Guide

● Split into suborigins–this section enables you to divide an Arrival Profile into smaller
profiles in order to model, for example, the different carriages of an arriving train. On
import, a pending object will be created for each sub-origin.
● Frequency based–this section enables you to create arrival patterns based on a fre-
quency (5 trains per hour, for example) or to set up a sequence of arrivals for different ser-
vices (three express trains – one stopping service – three express trains, for example).

Adding and restoring Origin Tables

When you first open the spreadsheet, there are already several ‘Origin Tables’ for you to use
but you can add more in the following manner. You can also use this procedure to restore any
tables that have ceased to work properly after copying and pasting data from another source.

To add or restore Origin Tables:

1. Click the Restore icon .

2. In the small dialog box, enter the number of tables you would like to add or restore and
click OK.

If you enter a number lower than the number you already have, say 3, this will restore
three tables only, removing the fourth or fifth, etc. Be certain not to remove tables for
which you have entered required data.
3. The specified number of tables will be added. Any existing data is retained and all func-
tionality is restored to the worksheet.

Origin Settings: Some labels and concepts

● Type ID–a discrete service (like an express service, stopping service or train belonging
to a particular line)
● D(istribution)–the percentage distribution used to divide demand into suborigins (could for
example be carriages in a train)
● Suborigins–Entrances generated by subdividing the initial Arrival Profile (for example,
each car in a train will be imported into the Model Builder as an Entrance)
● Frequency based?–answer ‘Yes’ to this if you want to subdivide the initial Arrival Profile
into pulses according to frequency)
● Service type sequence–the pattern of train services (for example, ‘Express – Express –
Stopping – Express’)
● Continuous or Per Interval–a ‘continuous’ sequence repeats itself across the runtime of
a simulation and across time intervals (without restarting), whereas a ‘per interval’
sequence respects the start of each new time interval and will restart the sequence at the
beginning of each one.
● Arrival frequency–the number of times a service arrives (throughout the whole runtime
or within specific intervals)
● All–this denotes that a value applies for all time intervals or affects all Type IDs or Avail-
ability Profiles.

Splitting an Origin into Suborigins

This procedure describes how to take an origin and divide its demand (one or more Arrival Pro-
files) into smaller Arrival Profiles for use when modelling individual train carriages or
whenever you may need to subdivide arrival demand into smaller groups of data. These sub-
origins will also be imported as pending Entrances in the Model Builder.

To split an Origin into suborigins:

© 2001–2017 Legion International Ltd 135

Legion SpaceWorks R6.5.0 User Guide

1. In the ‘Origin Name’ box, select an origin from the drop-down list.
A list of Arrival Profiles associated with this origin is displayed in the table beneath the Ori-
gin Name.
2. Next to the box labelled ‘Split into suborigins?’ select Yes from the drop-down list.
This makes the relevant ‘Distribution’ cells available for use.
3. In the cells to the right of the label ‘Name’, enter the names of the train carriages or divi-
sions you need (for example, ‘Car 1’, ‘Car 2’ and so on).
4. For each division, enter a percentage value; the total ‘Composition’ must equal 100%, how-
ever.

5. If you want to associate a Type ID created in step 2 with one of your distributions, click in
the cell to the right of the ID and select a Distribution from the drop-down list in the ‘D’
column.

You can apply a distribution to as many Arrival Profiles as you like. For example, you may
have profiles for ‘train3’ and ‘train4’ and you may wish to apply the carriage distribution
defined as ‘D1’ to both of them.
6. Repeat these steps for as many distributions you need, up to a maximum of six.
During import, these settings will create six Arrival Profiles named: ‘train1’, ‘train2’, ‘train1-
car1’, ‘train1-car2’, ‘train2-car2’, ‘train2-car2’ as seen here on the ‘Imported’ tab of the
Object Directory.

136
Legion SpaceWorks R6.5.0 User Guide

Creating Arrival Patterns using Frequency Based Data

You can fine tune your data further by creating pulses of arrival data at specific intervals. For
example, in this way you could take a single Arrival Profile of 1000 Entities and create 10 sep-
arate arrivals (trains) of 100 (depending on any statistical ‘random noise’ you may require).

You do not need to have created suborigins in order to use frequency based data.
You can also create Availability Profiles that are offset from these arrival pulses, so that you
can associate certain events (like boarding or departing) with the arrival times and data.
We’ve broken down the frequency based portion of the worksheet into three topic areas:
Ignoring Type IDs, using Type IDs, and Creating Availability Profiles.

To enable all frequency based functions, you must first select Yes from the drop-down list
next to the cell labelled ‘Frequency based?’.

Ignoring Type IDs

This option only applies when you have not set up any Type IDs because you are dealing with
only one type of train or service.

To create frequency based data:

1. Select Ignore from the drop-down list labelled ‘Use/Ignore type IDs’.
2. Click the ‘Copy time intervals ’ button to add the correct time intervals for the Arrival Pro-
file in question.
3. To specify arrival frequencies:
◊ If you would like the same number of arrivals per interval throughout the simulation,
enter the number in the first cell labelled ‘All’.
or
◊ Enter specific numbers of arrivals per interval in the appropriate cells along the
timeline.
4. To set the minimum time between arrivals:
◊ If you would like the same minimum time between arrivals across all intervals through-
out the simulation, enter the time (in seconds) in the first cell labelled ‘All’.
or
◊ Enter specific minimum times (in seconds) in the appropriate cells along the timeline.
5. If you want arrival times to be randomised within the constraints of the time period, select
Yes from the drop-down list labelled ‘Make arrivals random?’, otherwise leave as No.

If you don’t randomise arrivals, the first arrival will occur at the very start of the time
interval.
6. To add random noise to the amount of Entities in your Arrival Profile, enter ‘Lower’ and
‘Upper’ limit values in the appropriate cells.
As an example, if you set lower and upper limits of 2 and 5, a cell containing an initial
quantity ‘10’ will ultimately be modified to contain between 5 & 8 (if noise is subtracted)
and between 12 and 15 (if noise is added). The demand total is preserved regardless of
noise.
7. To spread the arrival of Entities over a certain period, add a value (in seconds) to the cell
labelled ‘Spread arrivals (sec)’. This ensures that Entities don’t all arrive in one instant-
aneous surge, which may be unrealistic.

© 2001–2017 Legion International Ltd 137

Legion SpaceWorks R6.5.0 User Guide

This spread will override the spread defined on the Data Profiles worksheet.
This portion of the worksheet should now resemble this screenshot.

After import, these settings will create the same six Arrival Profiles mentioned in Splitting an
Origin into Suborigins. However, the data for the suborigins (the train cars) will be divided
into 10 arrival ‘spikes’. This is due to the ‘Arrival frequency’ of ‘10’ per period (in this case the
period is the whole runtime of one hour). This graph illustrates these spikes after import.

138
Legion SpaceWorks R6.5.0 User Guide

Using Type Ids

Choose this option when you have set up Type IDs and you wish to create arrival patterns for
an origin that take different service types into account, along with the order in which they
arrive. Arrival Profiles that have the same Type ID will be allocated the same arrival times on
import. The first step of this procedure describes how to create Type IDs for an Arrival Profile.

To create frequency based data:

1. To associate an Arrival Profile with a particular type of train or service (express or stop-
ping service, for example), enter a name or letter next to the profile in the corresponding
cell labelled ‘Type ID’ (the example illustrated below uses an ID for express trains: ‘T1’,
and one for stopping services: ‘T2’).

2. Select Use from the drop-down list labelled ‘Use/Ignore type IDs’.
3. Click the ‘Copy time intervals’ button to add the correct time intervals for the Arrival Pro-
file in question.
4. From the drop-down list labelled ‘Apply service type sequence?’, select Yes or No. If you
choose No, go to step 8.

‘Continuous’ repeats across the runtime and across time intervals (without restarting);
‘Per interval’ respects the start of each new time interval and will restart at the beginning
of each.
5. From the drop-down list labelled ‘Sequence: Continuous or Per Interval’ choose Continu-
ous or Per Interval. If you choose ‘Continuous’, go to step 7.
6. Having chosen ‘Per Interval’, enter either:
◊ the sequence of Type IDs you wish to apply to all time intervals (enter them into the
cell labelled ‘All’; for example, enter T1,T2).
or
◊ the sequence of Type IDs you require in the appropriate cells along the timeline, for
example T1,T2 in the first interval, T1,T1,T2 in the next interval, and so on.
Using the examples in step 1, this means that a sequence of ‘Express, Stopping Service’
will occur in these time intervals, starting from the beginning in each new interval. Now go
to step 8.
7. Having chosen ‘Continuous’, enter the sequence of Type IDs you require in the cell labelled
‘Continuous sequence (Type ID)’, for example, T1,T2
Using the examples mentioned in Splitting an Origin into Suborigins, this means that a
sequence of ‘Express, Stopping Service’ will recur continuously throughout the model’s
runtime.
8. To specify the frequency of arrivals (across the whole simulation or within individual time
intervals), enter either:

© 2001–2017 Legion International Ltd 139

Legion SpaceWorks R6.5.0 User Guide

This is the number of individual arrivals, not the number of sequences.

◊ A value for ‘Arrival frequency (per period)’ to specify the number of arrivals within
each time interval (enter this in the first cell marked ‘All’)
or
◊ Enter a number of arrivals per individual interval in the appropriate cells along the
timeline.
Notice that the spreadsheet won’t allow you to both: inappropriate data will appear as light
grey. You can remedy this by deleting the data you don’t need.
9. To set the minimum time between arrivals:
◊ If you would like the same minimum time between arrivals across all intervals through-
out the simulation, enter the time (in seconds) in the first cell labelled ‘All’.
or
◊ Enter specific minimum times (in seconds) in the appropriate cells along the timeline.
10. If you want arrival times to be randomised within the constraints of the time period,
select Yes from the drop-down list labelled ‘Random arrival?’

If you don’t randomise arrivals, the first arrival will occur at the very start of the time
interval.
11. To add random noise to the amount of Entities in your Arrival Profile, enter ‘Minimum’
and ‘Maximum’ values in the appropriate cells.
As an example, if you set minimum and maximum limits of 2 and 5, a cell containing an ini-
tial quantity ‘10’ will ultimately be modified to contain between 5 & 8 (if noise is sub-
tracted) and between 12 and 15 (if noise is added). The demand total is preserved
regardless of noise.
12. To spread the arrival of Entities over a certain period, add a value (in seconds) to the cell
labelled ‘Spread arrivals (sec)’. This ensures that Entities don’t all arrive in one instant-
aneous surge, which may be unrealistic.
This portion of the worksheet should now resemble this screenshot.

This spread will override the spread defined on the Data Profiles worksheet.
After import, these setting will create the same six Arrival Profiles mentioned in Splitting an
Origin into Suborigins. However, the data for the suborigins (the train cars) will be divided

140
Legion SpaceWorks R6.5.0 User Guide

into two groups of six arrival ‘spikes’. This is due to the sequence ‘T1,T2’ and the ‘Arrival fre-
quency’ of ‘12’ per period (in this case the period is the whole runtime of one hour). This
graph illustrates these spikes after import.

Creating Availability Profiles (Frequency based settings)

As long as you are using the Frequency based settings on this worksheet, you can opt to cre-
ate Availability Profiles which are offset from the arrival sequences (or ‘spikes’) you are cre-
ating.
Creating Availability Profiles in this manner, so that they are linked to (offset from) arrivals,
means you can then associate these profiles with Direction Modifiers to model events related
to the arrival of trains. Such events may include prompting passengers to board shortly after
a train arrives or instructing them to move from concourse to platform when a train arrival is
announced.
If you have used Type IDs, these Availability Profiles will be offset from each sequenced
arrival; if you have not used Type IDs, the Availability Profiles will be offset from the main
Arrival Profiles linked to each origin. Offsets can be negative as well as positive: an offset of -
5.0 seconds will start the Availability Profile five seconds before the arrival time it is offset
from.
To generate an Availability Profile, you need to name it, define an offset time and set its dur-
ation. This means that, for example you can have an Availability Profile that starts five
seconds after an arrival (an offset value of ‘5.0s’) and which lasts for 60 seconds (a duration
value of ‘60.0s’).

© 2001–2017 Legion International Ltd 141

Legion SpaceWorks R6.5.0 User Guide

When associated with a Direction Modifier in the Model Builder, this profile could be useful for
prompting passengers to start boarding for one minute, five seconds after the arrival of their
train.

To create Availability Profiles:

1. In the box labelled ‘Create availability profile(s)?’, select Yes.
2. If you are ignoring Type IDs, skip to step 4 as you don’t need to select Type IDs.
3. Having chosen to use Type IDs, choose as many IDs as you need from the drop-down lists
in the row labelled ‘Type ID’. This will be dictated by the sequences you have established.
4. Along the row labelled ‘Availability Profile name’, specify the names of the profile(s) you
would like to generate. For profiles connected with boarding and leaving, you may wish to
have two per Type ID, such as ‘t1 board’ and ‘t1 leave’.
5. To set the offset and duration of your Availability Profiles, for each either:
◊ Specify ‘Offset’ and ‘Duration’ in seconds in the cells labelled ‘All’ (this means that all
profiles will use these values for all arrivals).
or
◊ For each individual profile, specify ‘Offset’ and ‘Duration’ in seconds.
A positive offset means the profile will begin after the start of the arrival; a negative off-
set will occur before the start of the arrival. For example, ‘-5.0’ will make an object
become ‘available’ five seconds before start of the arrival.
This portion of the worksheet should now resemble this screenshot.

After import, four Arrival Profiles will be created, named ‘t1 board’, etc.

and they can be viewed in the Edit Data window, along with all data objects. Note that the
start and end times correspond to the offset and duration values specified in the example.

142
Legion SpaceWorks R6.5.0 User Guide

Importing a completed template

Once you have completed as many of the worksheets as you need, and have checked for, and
fixed, any errors, you are ready to import it into the Model Builder using the ‘Data Import Man-
ager’.

You must close the template before attempting to import it.

For a recap on the results of an import, see What happens in the Model Builder after import?.

To import a completed data spreadsheet

1. Select Data > Data Import Manager.

© 2001–2017 Legion International Ltd 143

Legion SpaceWorks R6.5.0 User Guide

2. Click the ‘Browse’ button next to the box labelled ‘File Selection’.
3. From the ‘Open’ dialog box, select the spreadsheet you want to import and click Open.
4. Click the Validate button to check and load the spreadsheet (this may take a minute or
so, depending on the amount of data it contains).
Any errors will be highlighted in red and explained in the ‘Status’ portion of the dialog box.
Fix any errors in the spreadsheet and then import it again by returning to step 2.
5. Click Import.
If the Model Start Time in your spreadsheet is different from the Model Start Time in the
current model, you will receive a warning message with the following prompt: “Would you
like to update any existing data profiles to begin at the new imported start time?”

You may lose data from existing profiles if you import a new Start Time but do not update
existing profiles so that they fall within the new run time.
6. Click Yes to update the existing profiles or No to leave them unchanged.
The data import continues.
7. Any additional warnings generated by the import process will be displayed in the ‘Status’
area of the dialog box. You can either change the spreadsheet in line with the warnings or
choose to proceed regardless.
8. Click OK to finalise the import.

File Selection icons

To the left of the 'File Selection' field, one of the following icons will be visible. This is what
they indicate:

144
Legion SpaceWorks R6.5.0 User Guide

—there are errors in the file (these need to be fixed before import can take place)
—there are warnings associated with the file (the file can still be imported but may be lack-
ing certain information)
—the imported file is good

Updating and Restoring Imported Data

During the course of a project you may need to change the original data source and update the
model or you may also wish to restore the imported data to an earlier state after making
changes within the Model Builder. Both these things are easily done from the Data Import Man-
ager.
The Data Import Manager contains two important items of information below the 'File Selec-
tion' field:
● Last Import–this indicates when the last import activity took place (new file imported,
imported file updated or file restored from cache).
● File last modified–this indicates when the data import file was last modified.
If the 'last modified' date is more recent than the 'Last import' date, this may indicate that the
file needs to be updated. In which case, click the Update button (formerly the 'Validate' but-
ton) and then, if there are no errors, press Import again.

If you want to check the history of data imports, click on the Import History button for a
list of activities.
Every time you import a file, it is cached in the programme's memory and kept until that ver-
sion is updated as described above. If you go on to modify the imported data within the Model
Builder, you can always decide to restore the data from the last validated and imported file.
When a file is available in the cache, the 'Import' button will now be labelled 'Restore'. Click
Restore to return the imported data to the state it was in at the last successful import.

A note on importing Origin Settings data

If you have completed the ‘Origin Settings’ worksheet, you can choose whether or not to
import the original unmodified Arrival Profiles alongside the modified versions related to sub-
origins and sequences.
The default setting imports the original data but if you would prefer not to import the original
Arrival Profiles, select Tools > Options > Data Import Settings and uncheck the box
labelled ‘Import original Arrival Profiles and Origins modified by Origin Settings’.
If, however, you do choose to import the original Arrival Profiles, you can select a further
option that replaces the original profiles with the sum of their subprofiles as specified on the
Origin Settings worksheet. To do so, select Tools > Options > Data Import Settings and
check the box labelled 'Replace each original Arrival Profile with the sum of its subprofiles'.
This option is only available if you have also checked 'Import original Arrival Profiles and Ori-
gins modified by Origin Settings'.

© 2001–2017 Legion International Ltd 145

Legion SpaceWorks R6.5.0 User Guide

Exporting a Data Template

If you have previously imported a Legion Data Template into your model, you will also be able
to export it. This ensures that if you lose the original template, or if it becomes corrupted, you
can extract and save the original data.
If you imported the data template using SpaceWorks EP3 or earlier, you will only be able to
export the data, without the original template functionality (macros, drop- down lists, QA
checks, etc.). If you imported the data template using a later version of SpaceWorks, you will
be able to export the data along with a fully working version of the template.

If you have never imported a Data Template into the model, the option to export will not
be available to use.

To export a Data Template:

1. Select Data > Export Data Template.
A standard Save As dialog is displayed.
2. Choose the location where you would like to save the template.
3. Enter a name in the 'File name' field.
4. Click Save.
5. Open the file in Excel to check the data.

146
Legion SpaceWorks R6.5.0 User Guide

Manually creating and editing Arrival, Availability, Speed

and Event Profiles
As well as the automated procedures described above, you can manually create Arrival, Avail-
ability, Speed and Event Profiles by entering data into your model using any of the following
methods:
● Entering data into a graph (Data Profile histogram).
● Importing data for a single Data Profile.
● Applying Pulse (including Pulse Train).

Bear in mind that Availability profiles simply use OFF and ON as data (in terms of
integers: 0 and 1 respectively).
Once you have created a Data Profile, you can also modify and manipulate it. These topics are
covered towards the end of this part of the guide.

Creating a new Arrival or Event Profile

Before entering or importing data into a Data Profile, you must create a new one.

To create a new Arrival or Event Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profiles’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select which type of Data Profile you
want to create.
3. Click the New button in the top left-hand corner. A new ‘empty’ graph is displayed.

© 2001–2017 Legion International Ltd 147

Legion SpaceWorks R6.5.0 User Guide

4. Type a meaningful name for this profile in the highlighted name box and press Enter. It is
a good idea to name a profile in such a way that it refers to the object within the model
that references it, for example “Entrance Street”.
5. Enter data into the graph using any of the methods described in Entering data into a graph

Creating a new Availability Profile

Before entering or importing data into a Data Profile, you must create a new one. To create an
Availability Profile, you need to designate which cells of the graph's timeline are labelled 'OFF'
and which are labelled 'ON'. 'OFF' represents unavailability, 'ON' represents availability.

To create a new Availability Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profiles’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Availability Profile.
3. Click the New button in the top left-hand corner. A new ‘empty’ graph is displayed.
All the cells are automatically set to 'OFF'.
4. To set periods of availability, locate the cells (time steps) along the X-axis that you would
like to change and double-click on 'OFF' so that it displays 'ON'.
5. Click OK.
You can also enter data into an Availability Profile using the following methods:
Entering data into a graph
Applying Pulse

Creating a User-defined Speed Profile

While we recommend that you create all your data using the Legion Data Template, you can
create customised Speed Profiles using the Edit Data dialog box. To do so, you need the rel-
evant measurements.

To create a User-defined Speed Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profiles’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Speed Profile.
3. Click the New button in the top left-hand corner. A new Speed Profile histogram is dis-
played.

148
Legion SpaceWorks R6.5.0 User Guide

4. Enter a meaningful name in the highlighted 'name' field.

5. Adjust the values in the histogram by clicking on the vertical bars and dragging them
upwards or downwards. If you'd like to drag the bar in increments of 0.01% rather than
1%, hold down the 'Ctrl' key as you drag.
or
Adjust the values by clicking into a data cell at the foot of a column and entering values dir-
ectly. Press 'tab' or click into another cell to apply this data.
If at any point you wish to clear and reset these values, click the Clear button.

When adjusting the values in the histogram, take care to maintain a total of 100%. You
will see a percentage indicator to the left of the y-axis.
6. Click Apply or OK to save the Speed Profile.
Any profiles you create will be available to you when creating Entity Types.

The Edit Data Profile dialog box

The ‘Edit Data Profile’ dialog box has two panes. The left-hand window provides a list of all pre-
viously created or imported Data Profiles. You can change the type of profile displayed by
selecting from the drop-down list on the left.
Using the buttons in the top left-hand corner you can Create, Delete, Rename and Copy Data
Profiles.
The Data Profile pane on the right-hand side is divided into four sections:
● Demand Information–shows the total demand of the current Data Profile and the Selected
Entity Count contained within a range of times you have selected.
● Control Bar–provides controls for adding data, viewing the graph and selecting entries.

© 2001–2017 Legion International Ltd 149

Legion SpaceWorks R6.5.0 User Guide

● Graph View–shows a graphical representation of the demand data, with time specified
along the horizontal axis and Entities per second on the vertical axis.
● Cell View–shows the numerical data associated with the data profile, with each cell rep-
resenting one second in the profile.

Entering data into a graph

There are three ways to enter data into an Arrival, Availability or Event Profile graph:
● Free Draw data into a graph.
● Edit data in a graph’s cells.
● Paste data into a graph.

Free-drawing data
This enables you to enter data directly into a graph by clicking and dragging your cursor along
the X and Y axes.

To Free Draw data in a graph:

1. Ensure that the graph is unlocked (you cannot enter data into a locked graph).

If the graph is locked, the padlock icon above the graph will look like this. If it is

unlocked, it will look like this. Click on the padlock icon to change the state of the
graph from locked to unlocked or vice-versa.

2. Click the Free Draw icon .

3. Click in the graph at the point on the X axis (time interval) where you want to enter data
and on the Y axis (Entities Per Second) at the amount of Entities you want to enter into
your model at this time interval.
For example, if you click the X axis at 00:00:10 and the Y axis at 10 Entities Per Second,
then you have entered 10 Entities into the Arrival or Event Profile at the precise time of
00:00:10.

While you are holding down the left mouse button, a tool-tip displays the time interval and

number of Entities.
4. If you want to add values for many time intervals, click and hold the left mouse button and
move your cursor over the graph. You will see that Entities are added over time as you
move the cursor along the X axis and up and down the Y axis.
Experiment by moving the cursor around the graph. Notice that the graph scrolls hori-
zontally and vertically according to the movement of your cursor.
5. When you are happy with the demand data you have ‘drawn’ into the graph, click the
Apply or OK button to save the Arrival or Event Profile.

The process is slightly different for an Availability Profile as the data only represents ON
or OFF. To add data for an Availablity profile, click in the graph at the point on the X axis
(time interval) where you want to add or change data: for ON, click near the top of the
time interval's column and to specify OFF, click near the bottom of it.

Editing data in a graph’s cells

This allows you to enter data directly into cells whether the graph is locked or not. When you
change the values in a cell, the graph is updated to show these changes.

To edit data in a graph’s cells:

150
Legion SpaceWorks R6.5.0 User Guide

1. Click once into the time interval cell at the foot of the graph into which you want to enter a
number of Entities.
The existing value is highlighted.

2. Enter a value into the cell and press Enter.

The value is displayed in the graph as a vertical bar.
3. Repeat for all other cells that require data.
4. When you are happy with the demand data you have entered into the cells, click the Apply
or OK button to save the Data Profile.

The process is slightly different for an Availability Profile as the data only represents ON
or OFF. To toggle between ON and OFF in cells, just double-click within them.

Pasting data into a graph

You can copy and paste demand data from an external application directly into a data profile.
This data must be formatted as one or two rows or columns.
When using this format, the first row or column defines either the time (when demand is to be
applied to an instant in time) or the start time (when demand is to applied over an interval of
time).
The second row or column specifies the demand (number of Entities) corresponding to each
time interval. The following illustration shows the start times for each interval in the first row
and the associated demand to be applied to each interval in the second row.

Availability Profiles only require 0 and 1, which represent OFF and ON respectively.

To be pasted successfully, the data must incorporate one of these time formats:

If the data contains the time format mm:ss, the Model Builder will assume that it is
hh:mm and will not generate a warning or error. It is vital that all times specified in the
data are contained within your model’s overall run-time.
● hh:mm:ss (hours, minutes and seconds)
● hh:mm (hours and minutes)
● Absolute seconds after midnight (the number of seconds since midnight–00h00m–so that
they are correct for your model’s start time). For example, to specify a demand at 08h00
in seconds, you would specify 28,800 seconds after midnight, which is 8 x 3600 seconds
per hour.

To paste data into an Arrival, Availability or Event Profile:

1. Copy the relevant data to be pasted from the external application.
2. Select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
3. Select the Data Profile (Arrival or Event) into which you want to paste the data (you may
need to create a new one).

© 2001–2017 Legion International Ltd 151

Legion SpaceWorks R6.5.0 User Guide

4. Right-click anywhere in the graph and select Edit > Paste.

Doing this defines the start time from which the pasted data is applied. If you haven’t
selected a start time in the graph, the paste function assumes that the pasted data is to be
applied from your model’s start time. Data with times (two row or column format) is
always pasted into the graph in the specified time intervals.
The ‘Paste’ dialog box is also displayed.
5. Select the correct option from the two choices:
◊ The data is in rows
◊ The data is in columns
and click the OK button.
If the data you are pasting contains any format errors or time errors, a message is dis-
played describing the problem. You must correct these errors and try to paste the data
again.
If there are no errors, the data is successfully pasted into the graph.

Changing the graph view

There are several ways to change the appearance of the graph window. The following pro-
cedure describes how to show and hide elements of the graph, resize cells and change how
the graph’s axes are displayed.

To change the graph view:

● Click the Show Graph button to show or hide the graph.

● Click the Show Cells button to show or hide the data cells.
● Click the edges of individual cell boundaries and drag to increase or reduce their width:

● Click the button to the left of the time interval cell column headings to select all cells:

and drag the edges of a cell boundary to simultaneously increase or decrease the width of
all cells.
● To show the entire graph, right-click in the graph and select View > Show entire graph.
To revert to the original view, repeat this action.
● To show the full length of the X axis, right-click in the graph and select View > Show
entire X axis.
● To show the full length of the Y axis, right-click in the graph and select View > Show
entire Y axis.
● To set the scales of the two axes, right-click in the graph and select View > Set axis
scales.
◊ Drag the horizontal and vertical sliders, located below and to the left of the Example
Graph, to change the scale for the relevant axis.

152
Legion SpaceWorks R6.5.0 User Guide

◊ To show the entire horizontal axis in the graph view window, check the Show entire X
range box. Similarly, to show the entire vertical axis in the graph view window, check
the Show entire Y range box.
◊ Click the OK button to apply the scale changes or click the Cancel button to discard
your changes.

At horizontal scales of less than one pixel per bar, it is not possible to manually draw val-
ues in the graph view using Free Draw. This is due to the ambiguity in deciding which time
the values should be applied to. If you attempt to do so, an error message is displayed.

Selecting entries in the graph

There are many ways to select data in a Data Profile graph. The following procedure describes
how to select individual entries, multiple entries and ranges of Entities.

To select entries in the graph:

● To select one entry, click once on the value in its data cell or click once on its vertical bar
in the graph.
● To select more than one entry, repeat the step above but hold down Ctrl and click to
select specific multiple entries, or hold down Shift and click to select the start and end of
a range of entries.
● To select all entries in the graph, click the Select All button.
● To select all entries with a value greater than 0, click the Select > 0 button.
● To select a specific range of entries, right-click in the graph and Select > Range. The
‘Select a Range of Entities’ dialog box is displayed.
Enter a Start time and End time, making sure to use recognised time formats, and click
OK.
● To de-select all entries, click the Select None button.

Importing data for a single Arrival or Event Profile

You can import data from an external application into a single Arrival or Event Profile, as
opposed to the multiple profiles you can create with the Data Import Manager. Importing data
clears any existing data from the graph you import it into.
The data to be imported must be in one of the following recognised formats:
● Comma separated values files ('csv' files)
● Tab delimited files (txt files)
Data can be imported with or without time- values, but for such data the Model Builder
assumes that the data is to be applied to consecutive one-second intervals starting from the
model start time.

To import data for a single Arrival or Event Profile:

1. Highlight the appropriate profile or create a new Data Profile (see Creating a new Arrival
or Event Profile).
2. Right-click in the graph and select File > Import. The ‘Import Data File’ dialog box is dis-
played.

Ensure that the file you are importing is not already open in another application as this will
create a file-sharing error and you will not be able to import it.
3. Browse to the data file you want to import and select the correct file type from the drop-
down list in the Files of type field. The ‘Import’ dialog box is displayed.

© 2001–2017 Legion International Ltd 153

Legion SpaceWorks R6.5.0 User Guide

4. Select the correct option from the two choices:

◊ The data is in rows.
◊ The data is in columns.
5. If the data file uses rows or columns for the names of Data Profiles, you need to indicate
this here and advise the software to ignore this naming information.
To do so, under the question ‘Are the first columns (or rows) for Data Profile names?’ tick
the Yes box and enter the number of columns or rows that contain naming information.
If the data is in rows and the first column contains naming information, the Yes box is
ticked and the number of columns is set to 1 as only the first column contains naming
information. If there is no header (naming) information in the imported file, leave the Yes
box unticked.
6. Click OK. If there are no formatting or time errors in the imported file, it is successfully
imported into the Data Profile.

Checking and updating imported file properties

After importing a file, you can check the following facts about it:
● File (including name and full location path).
● Status (whether the file has been modified since it was imported. If it has been modified,
this line will ask you to click the Update button).
● Access Details
◊ First Created
◊ Last Accessed
◊ Last Modified
◊ First Imported
◊ Most Recently Imported

To check and update imported file properties:

1. Select the Data Profile containing the imported data.
2. Right-click in the graph and select File > Properties. The following information panel is
displayed.

If the original data file has not been changed since it was imported, click the Close button.

154
Legion SpaceWorks R6.5.0 User Guide

If the original data file has been changed since it was imported, click the Update button.
3. Enter the correct information about rows, columns and headers as described in step 4 of
To import data for a single Arrival or Event Profile:.
If there are no formatting or time errors in the updated file, it is successfully updated and
the new values are reflected in the Data Profile.

Cutting, copying and pasting demand data

Any demand data that you select in the graph can be cut, copied and pasted to any other time
interval within the Data Profile. Within Legion SpaceWorks, cut, copy and paste functions work
in the standard Windows manner and you can access them by right-clicking in a graph and
selecting Edit > Cut, Edit > Copy or Edit > Paste.
The following standard Windows key combinations also work:

● Ctrl-X to cut data

● Ctrl-C to copy data

● Ctrl-V to paste data

When using the right-click menu, right-click on the exact start time where you want to paste
the data and select Edit > Paste.
When using Ctrl-V, click once on the exact start time from where you want to paste the data
and press Ctrl-V.

A note on pasting data

The behaviour of the paste function differs according to the source of the data on the Windows
clipboard, i.e. whether the data in the clipboard was copied internally from the demand graph
or copied externally from another application.
Internal data that has been copied to the clipboard from the graph can be pasted anywhere in
the graph and the relative positions (intervals) of multiple selections are maintained.
With external data copied from an application other than Legion SpaceWorks, you need to spe-
cify the format of the data in the ‘Paste’ dialog box when you paste the data. See To paste
data into an Arrival, Availability or Event Profile: for full instructions.

Repeated pasting of data

The Repeated Paste function enables you to quickly place several copies of a selection of
demand data at regular, defined intervals.

To Repeat-paste data into a demand graph:

1. Ensure that the graph is unlocked.
2. Select and copy the data you want to paste.
3. Move the cursor to the time interval where you want the data to be pasted and right-click
once.

Do not left-click at this point as this will change the selection and result in data being pas-
ted only once.
The start time is indicated by a small green triangle on the horizontal axis.

© 2001–2017 Legion International Ltd 155

Legion SpaceWorks R6.5.0 User Guide

4. From the right-click menu, select Edit > Repeated Paste. The ‘Repeated Paste’ dialog
box is displayed.
5. Enter the Number of repetitions (the number of times you want to paste the copied
data).
or
Select the Duration to paste over option and enter the duration (in seconds) over which
you want to paste the copied data.
6. To specify the interval between each of the repetitions, enter a number in the box labelled
‘Paste data every n seconds’.

This interval is the time between the start of each repetition of data: a 10s interval will
paste your data anew every 10s from the first time it was pasted.
7. Click the OK button.
The data is pasted according to the number of repetitions you specified or over the time
interval you entered.

Deleting demand data from a Data Profile (Arrival or Event)

You can delete selected data entries from a Data Profile and also clear all data from a Data
Profile graph. The following two procedures assume that you have already selected the appro-
priate Data Profile.

To delete demand data from a Data Profile:

1. Select the entries you want to delete using any of the methods described in Selecting
entries in the graph.
2. Press the Delete key. You are prompted to confirm this action.
3. Click Yes to delete the selected entries or No to retain the entries.

To clear all data from a Data Profile graph:

156
Legion SpaceWorks R6.5.0 User Guide

1. Click the Clear Graph button. The following warning is issued:

This will remove all data from the graph! Do you want to proceed?
2. Click Yes to delete all data from the graph (this cannot be undone), or No to retain all the
data.

Copying a Data Profile (Arrival or Event)

The following procedure assumes you have already selected the Data Profile you want to
copy.

To copy a Data Profile:

1. Click the Copy button.
A new Data Profile is added to the list on the left-hand side of the ‘Edit Data Profile’ dialog
box.
2. Type a meaningful name for this Data Profile in the highlighted name box and press Enter.

Renaming a Data Profile

The following procedure assumes you have already selected the Data Profile you want to
rename.

To rename a Data Profile:

1. Click the Rename button.
The ‘Edit Name’ dialog box is displayed.
2. Type a meaningful new name into the box and click the OK button, (you will not be able to
use the name of an existing profile).
The name of the Data Profile is changed.

Deleting a Data Profile

To delete a Data Profile from your list of available profiles, follow this procedure which
assumes that you have already selected the Data Profile you want to delete.

To delete a Data Profile:

1. Click the Delete button.
2. The Data Profile is removed from the list in the ‘Edit Data Profile’ dialog box.

© 2001–2017 Legion International Ltd 157

Legion SpaceWorks R6.5.0 User Guide

Modifying Arrival, Availability or Event Profile data

Once you have entered data into a profile, you can alter it using Legion's 'modification' tools.
Of the methods described below, only 'Set to Value' can be used with Availability Profiles
where it changes the state of your data to 'ON' or 'OFF'

There is no Undo function in the ‘Edit Data Profile’ dialog box, so take care when altering
data. If you want to experiment with demand data but do not necessarily want to save
your changes, always click Cancel rather than OK or Apply in the ‘Edit Data Profile’ dialog
box.
Once you have entered demand data into an Arrival or Event Profile, you can apply modi-
fications to selected ranges of data, using one of these three options:
● Set to Value–sets the demand within selected entries to a specified value (or changes the
state of data to 'ON' of 'OFF' if you are modifying an Availability Profile).
● Change by Value–adjusts the demand within selected entries by a specified value.
● Set Percentage–adjusts the demand within selected entries by a specified percentage.
The following procedure assumes you have already selected the Data Profile whose data you
want to modify.

To modify demand data:

1. Select the data you want to modify using any of the methods described in Selecting entries
in the graph.
2. Right-click in the graph and select Apply > Modification. The ‘Modify’ dialog box is dis-
played.
3. Select one of the three modification options:
◊ Set to value
Enter the value you want to change the entry or entries to. This value must be greater
than or equal to zero. For example, if you enter 10, the selected data will be changed
to 10 when you click OK.

When applying the ‘Change by value’ modification, the modified value can never be less
than zero, regardless of the value you enter. For example, 22 reduced by 60 produces
zero.
◊ Change by value
Enter the value by which you want to change the selected data. For example, if you
enter 10, the selected data will be increased by 10 when you click OK. To reduce the
value of the selected data, enter a minus sign before the value. -10 will reduce the
selected data by 10.
◊ Set percentage
Enter the percentage by which you would like to modify the selected data. This per-
centage must be greater than or equal to zero. If you enter 125%, the selected data
will be increased by 25%; if you enter 75%, the selected data will be decreased by
25%.
This percentage change is applied individually to all selected data entries and returns a
result rounded off to the nearest integer.
4. Click OK to apply your modifications to the selected data.

158
Legion SpaceWorks R6.5.0 User Guide

Manipulating demand data (Arrival, Availability and Event

Profiles)
The Model Builder includes functions that enable you to manipulate demand data in non-uni-
form ways. These functions are:
● Pulse
● Spread
● Interpolation
● Random Noise
● Split

There is no Undo function in the ‘Edit Data Profile’ dialog box, so take care when altering
data. If you want to experiment with demand data but do not necessarily want to save
your changes, always click Cancel rather than OK or Apply in the ‘Edit Data Profile’ dialog
box.

Availability Profiles only use 'OFF' and 'ON' (0 and 1) as data, therefore Spread and Split
do not apply to them.

Applying Pulse
The Pulse function enables you to quickly define a Standard Pulse (single fixed value over a
given time interval) or a Pulse Train (repeated standard pulse over a specified period of
time).
The following procedures assume that you have already selected a suitable Data Profile. Avail-
ability profiles work slightly differently from the other data profiles, so their procedures are
described in Applying Pulse to Availability Profiles.

To apply Pulse:
1. Right-click in the graph and select Apply > Pulse. The ‘Pulse/Pulse Train’ dialog box is dis-
played.
2. Enter the Start time for the Pulse in seconds.
3. Enter the Duration of the Pulse in seconds.
4. Enter the number of People (Entities) to apply to each second of the Pulse.
To apply a Pulse Train at this point, see the next procedure below.
5. If you don’t want the pulse to overwrite the existing data and prefer the pulse to be added
to the existing data, untick the Overwrite box under ‘Pulse Application’.
6. Click the OK button to apply the Pulse to the Data Profile.

To apply Pulse Train:

1. Enter the Pulse settings as described in the procedure above.
2. Tick the Pulse Train box.
3. In the On Duration box, specify the number of seconds that the pulse will apply the
‘People’ value in a single cycle of the pulse.
4. In the Off Duration box, specify the number of seconds that the pulse will not apply the
pedestrians value (that is, no demand will be applied) in a single cycle of the pulse.

© 2001–2017 Legion International Ltd 159

Legion SpaceWorks R6.5.0 User Guide

5. If you don’t want the Pulse to overwrite the existing data and prefer the pulse to be added
to the existing data, untick the Overwrite box.
6. Click the OK button to apply the Pulse Train.

Applying Pulse to Availability Profiles

To apply Pulse to an Availability Profile:
1. Right-click in the graph and select Apply > Pulse. The ‘Pulse/Pulse Train’ dialog box is dis-
played.
2. Enter the Start time for the Pulse in seconds.
3. Enter the Duration of the Pulse in seconds.
4. Select a 'State' of OFF or ON, where OFF represents 0 or 'unavailability' and ON rep-
resents 1 or 'availability'.
To apply a Pulse Train at this point, see the next procedure below.
5. Click the OK button to apply the Pulse to the Data Profile.

To apply Pulse Train to an Availability Profile:

1. Enter the Pulse settings as described in the procedure above.
2. Tick the Pulse Train box.
3. In the Pulse duration box, specify the number of seconds that the pulse will apply either
the 'ON’ or 'OFF' value in a single cycle of the pulse (this depends on the state you selec-
ted in step 4 of the previous procedure).

If you selected the 'ON' state, the pulse duration will consist of the 'ON' value and the
'Time Between' will consist of the 'OFF' value. These values are reversed if you selected
'OFF' as your 'State'.
4. In the Time between box, specify the number of seconds you want to pass between
pulses.
5. Click the OK button to apply the Pulse Train.

Existing data is always overwritten in the case of Availability Profiles.

Applying Spread
The Spread function takes the demand in a single demand entry and spreads it uniformly
across a specified time period, starting from the time of the selected demand.
The following procedure assumes that you have already selected an Arrival or Event Profile.

To apply a Spread:
1. Select the single demand entry that you want to Spread.
If you want to define the duration of the spread at the same time as selecting the data
entry, click on the entry and drag the cursor to the right until you have also selected the
time-range.

160
Legion SpaceWorks R6.5.0 User Guide

2. Right-click in the graph and select Apply > Spread.

If you have already highlighted the duration of the spread, then the spread is instantly
applied and you do not need to complete step 3. If you did not select the duration, the
‘Apply Spread’ dialog box is displayed.
3. Enter the Spread duration, in seconds.
4. Click the OK button to apply the spread.

© 2001–2017 Legion International Ltd 161

Legion SpaceWorks R6.5.0 User Guide

If the result of a spread overlaps either existing demand in the profile or demand from sub-
sequent spread selections, the ‘Spread Duration Overlaps Existing Data’ message is dis-
played.
In this situation, you have three choices:
● Click Abort to stop the spread operation and return to the ‘Edit Data Profile’ dialog box.
● Click Overwrite to replace the existing demand within the Spread Duration with the result
from the spread.
● Click Increment to add the resulting spread data to any existing demand within the
Spread Duration.

Undoing the last Spread

You can undo your last Spread at any time by doing the following:
● Right-click in the graph and Select Apply > Undo Last Spread. The effects of the last
Spread are removed. Use the Undo function with care as it restores the Data Profile graph
to its state before you applied your last Spread. Changes after the Spread will be lost.

Applying Interpolation
The Interpolation function takes the demand values at the start and end of a selected data
range and generates demand data by interpolating values linearly from the first value in the
data range to the last.
You can use interpolation to quickly fill-in sections of the demand graph with equal values or
to generate linearly increasing or decreasing demand between two different values.
The following procedure assumes that you have already selected a Data Profile.

To apply Interpolation:
1. Select the range of data over which you want to apply the interpolation, including the first
and last values which define the interpolation.
Select the first and last data values very carefully to avoid unexpected results.
2. Right-click in the graph and select Apply > Interpolation. The interpolation is performed
and the results displayed in the graph.
The following examples illustrate the Interpolation function. The selected demand data is illus-
trated in the left-hand graphs with the results of the Interpolation illustrated in the right-hand
graphs.

162
Legion SpaceWorks R6.5.0 User Guide

For multiple ranges of data, always leave at least one second between the end of one
range and the start of the next.
Select the Interpolation range carefully. If you accidentally select zero as the first or last
values, the result will be inaccurate.

When interpolating Availability Profiles, the function will simply fill the selected range with
'ON' values (1).

© 2001–2017 Legion International Ltd 163

Legion SpaceWorks R6.5.0 User Guide

Applying Random Noise

Random noise randomly alters (adds to or subtracts from) each demand entry within a selec-
ted range. This provides a more ‘natural’ demand pattern. You can define the range within
which the random noise is applied.

When applying Random Noise to an Availability Profile, the process will simply randomise
the 'OFF' and 'ON' states throughout your selected data range.
The following procedure assumes that you have already selected a Data Profile.

To apply Random Noise:

1. Select the range of data entries to which you want to apply random noise.
2. Right-click in the graph and select Apply > Random Noise. The ‘Random Noise Setup’
dialog box is displayed, unless you are modifying an Availability Profile for which these set-
tings are not necessary.
3. Enter the Lower Limit and Upper Limit of the range of random noise you want to apply.
For example, if you set limits of between 2 and 5, random noise will be applied to each
selected demand entry within a range of 2, 3, 4 or 5.
4. Select one of the following options according to whether you want the random noise to add
to, subtract from or both add and subtract from the existing data values:
◊ Add noise to existing values
◊ Subtract noise from existing values
◊ Mix addition and subtraction of random noise
5. Depending on whether you want to maintain the existing totals of your data or if you are
happy for the totals to vary, select one of these two options:
◊ Yes, maintain the existing totals
◊ No, existing totals can vary

164
Legion SpaceWorks R6.5.0 User Guide

6. Click the OK button to apply random noise to your selected data entries.
The following example shows the outcome of applying random noise to a constant demand of
20, using lower and upper limits of 2 and 5, and applying the Mix addition and subtraction of
random noise method.

Applying Split
The Split function takes a range of selected data, and splits it into a number of smaller, equal
values distributed evenly or randomly throughout the selected range.

Use Split to create a timetable-like pattern from raw, approximate data.

The following procedure assumes that you have already selected a Data Profile.

To apply Split:
1. Select the range of data over which the split is to be distributed, starting with the demand
to be split in the first entry in the range.
2. Right-click in the graph and select Apply > Split. The ‘Apply Split’ dialog box is displayed.
3. Enter a Number of sections to split into.
4. Enter the Minimum interval to be observed when the split data is distributed (absolute
seconds from midnight or one of the recognised time formats).
5. Tick one or more of the following options, or leave them all unticked if you don’t want to
apply any of them:
◊ Random start
Specifies whether the first entry of the Split data is placed randomly rather than at the
start of the selected range.
◊ Random distribution of sections

© 2001–2017 Legion International Ltd 165

Legion SpaceWorks R6.5.0 User Guide

Specifies whether the new Split data entries are randomly distributed within the selec-
ted range.
◊ Force Minimum Interval before first placement
Ensures that the first entry of the Split demand is placed such that the Minimum Inter-
val you specified is maintained between the first entry and any other demand entry
before the selected range.
6. Click the OK button to apply the Split.
The following example illustrates an initial demand of 60 being split into 4 sections over 50
seconds, applying a random distribution with a minimum interval of 7 seconds.

166
Legion SpaceWorks R6.5.0 User Guide

Scenarios
Data Scenarios enable you to model, simulate and analyse a range of different demand situ-
ations for the same model.
This means that your model (‘lgm’) file can have several different scenarios associated with
it, such as ‘Morning Rush Hour’, ‘Afternoon’, ‘Evening Rush Hour’, ‘Match Day’, etc., all of
which can be simulated and analysed without having to change the model file.

Base Scenario
Every model must have a Base Scenario, which is defined as all the data that is associated
with the Spatial Objects in the model. For example, if an Entrance’s parameters reference an
Arrival Profile called ‘West Entrance Demand’, then this Arrival Profile automatically becomes
part of the Base Scenario.
All scenarios are visible in the Model Builder’s Object Directory, on the tab labelled ‘Scen-
arios’. See Object Directory for further information.
A scenario can incorporate the following:
● Arrival Profiles
● Delay Profiles
● Exit Profiles
● Event Profiles
● Populated Zones
● Evacuation Zones
● Entity and Supply Types
All additional scenarios are based on pre- existing scenarios (either the Base Scenario or
another scenario) with modifications to the original data; for example, ‘Scenario Two’ might
be based on the Base Scenario but may use modified demand data or a different Delay Profile,
and so on.

Scenario Manager
The Scenario Manager enables you to add, delete and rename scenarios.

● To open the Scenario Manager, click or select Data > Scenario Manager.

© 2001–2017 Legion International Ltd 167

Legion SpaceWorks R6.5.0 User Guide

Adding a scenario

Using the data creation methods described earlier in this section, you will need to create
new demand data for use in any scenarios you want to add.
As mentioned above, each model must have a Base Scenario, which is viewable in the Object
Directory and also in the Scenario Manager. This Base Scenario is automatically generated by
the software as you add objects and demand data to your model.
This procedure describes how to add another scenario to the model as well as the Base Scen-
ario.

To add a scenario:

1. Click or select Data > Scenario Manager to display the Scenario Manager, which
will already contain the Base Scenario.
2. Click the Add button.
The ‘Add Scenario’ dialog box is displayed.
3. Enter a meaningful name for the new scenario in the Name box.
4. From the Based Upon drop-down menu, select the existing scenario you want to base
this new scenario on.
5. From the Modification Type drop-down menu, select the type of data modification you
want to apply to the demand data in the original scenario:
◊ None–no new Data Profiles are created and the initial population of any Populated
Zones or Evacuation Zones is unchanged (if you select this option, click OK now, as
you do not need to make any further changes).
◊ Global–this applies specified changes to all the Data Profiles, Populated Zones or Evac-
uation Zones within the original scenario.

168
Legion SpaceWorks R6.5.0 User Guide

◊ Advanced–this enables you to apply specified changes to one or more Data Profiles,
Populated Zones or Evacuation Zones within the original scenario (see To apply
Advanced Modifications when adding a scenario: for full details).
6. If you selected Global modification:
◊ Check the All arrival profiles box and enter a percentage value in the % of ori-
ginal box (this will change all original Data Profile data by the percentage applied–
50% will halve all values, 200% will double all values, etc.).
and/or
◊ Check the Apply over interval box and enter Start and End times to specify a time-
range within which you want these data modifications to be applied.

Setting a time-range is useful for modelling evacuations or events like the closure of all
Entrances for a set period (this would involve setting the Data Profile to 0% for the time-
range).
7. If you want to change the values of any Populated Zones or Evacuation Zones, check the
All populated and evac zones box and enter a percentage in the % of original box.
8. Click Apply or OK to apply your changes and create the new scenario.
The following procedure describes how to apply modifications when you have selected the
‘Advanced’ option while adding a scenario.

To apply Advanced Modifications when adding a scenario:

1. From the Modification Type drop-down menu, select Advanced.
The ‘Data Profiles’ portion of the dialog box displays a list of Arrival or Event Profiles used
by the original scenario and the ‘Initial Population’ portion displays details of any Pop-
ulated Zones or Evacuation Zones.
2. Tick the box to the left of any Arrival or Event Profile you want to modify.
3. Double-click Percentage, Start Time and End Time and enter new values for each
Arrival or Event Profile.
4. Tick the box to the left of any Populated/Evacuation Zone you want to modify.
5. Double-click Percentage and enter a percentage value to change the population of any
Populated Zones or Evacuation Zones.
6. Click Apply or OK to apply your changes and create the new scenario.

General remark on scenarios

When you are simulating and analysing multiple scenarios, you have two options:
● When demand levels change but the origins and destinations remain the same, import
data for the Base Scenario and then modify the Base Scenario as described above.
● When the simulated flows are fundamentally different in terms of origins and destinations,
import the demand data using the Data Import Manager and then specify each scenario
manually.

Deleting and renaming scenarios

You can delete or rename scenarios in the ‘Scenario Manager’ dialog box.

To delete or rename a scenario:

1. Click or select Data > Scenario Manager to display the Scenario Manager.
2. Click on the scenario that you want to delete or rename.
3. Click either:

© 2001–2017 Legion International Ltd 169

Legion SpaceWorks R6.5.0 User Guide

◊ Delete–the scenario is removed.

or
◊ Rename–enter a new name in the ‘Edit Name’ dialog box.

You cannot delete the Base Scenario.

4. Click Apply or OK to save your changes.

Deleted objects
If you delete Spatial Objects from the model and there are no objects left that relate to a data
item in a scenario, then the Scenario Manager will no longer display details of that data item.
For example, if all Delay Points that refer to ‘Gateline A delay profile’ are removed from the
model, the ‘Gateline A delay profile’ row is no longer displayed.

Exporting models as ‘ora’ files

When you export your model as an ‘ora’ file in order to be used in the Legion Simulator, the
‘Export ORA’ dialog box prompts you to select which scenarios you want to export along with
the model file. In the Select Scenarios pane of the dialog box, tick each of the scenarios you
want to export and click OK. See Exporting a model as an ‘ora’ file for further information.

170
Legion SpaceWorks R6.5.0 User Guide

Exporting Model Data

This command line-activated option exports all data connected with a model into a spread-
sheet, so that it can be entered into the Legion Data Template or extracted and used in any
way you may find useful. It is particularly relevant for models produced in Legion Studio
(which predate the current Data Template).

To export model data:

1. Type exportmodeldata in the Command line and press Enter.
The 'Save As' dialog is displayed.
2. Location, 'File name' and 'Save as type' are already selected. The files is automatically
prefixed with 'Model Data-' to distinguish it from an OD Matrix export. Change the names,
if required.
3. Click Save.
The new spreadsheet is populated with all the relevant model data and organised by tabs
named 'Entity Types', 'Supply Types', 'Arrival Profiles', etc.

© 2001–2017 Legion International Ltd 171

Legion SpaceWorks R6.5.0 User Guide

11: Spatial Objects–Basics

In this chapter
Spatial Objects help define the space through which Entities move. Entities receive inform-
ation and instructions from Spatial Objects and these instructions, together with the Entity’s
individual preferences, are taken into account by the Legion Simulator to determine an
Entity’s next step.
This section covers the following topics:
● Types of Spatial Object
● The form of Spatial Objects
● Drawing and placing Spatial Objects
● Setting the parameters of Spatial Objects
● Refining the drawing of Spatial Objects
For specific information on each Spatial Object, please see 15: Spatial Objects–in Detail.

172
Legion SpaceWorks R6.5.0 User Guide

Types of Spatial Object

There are three types of Spatial Object in Legion SpaceWorks:
● Activity Objects
● CAD Objects
● Analysis Objects
For more information on CAD Objects, see Drawing CAD objects.

Activity Objects
Activity Objects provide origins and targets for Entities to move towards or away from. They
represent the specific functionality of a site and should be placed in the model according to the
physical information you possess.
They may also enable Entities to carry out certain activities, such as waiting, queuing and
receiving services. Within a model they sit in an Object Layer. For more information, see Lay-
ers . As well as providing structure and rationale for Entities, they can also supplement
Legion's auto-navigation system to correct anomalies, such as unrealistic congestion
The following table contains a list of Activity Objects along with their icons and a brief descrip-
tion of how they are typically used.

Icon Name Typical usage

Entrance To bring Entities into a model so they can be targeted to

another object or Final Destination.

Exit To provide a Final Destination for Entities and remove them

from the model. Can also be used to model departing trains
and other modes of transport.

Populated To provide a number of Entities at the very start of a sim-

Zone ulation and target them to another object.

Evacuation To provide Entities for an evacuation simulation or otherwise

Zone affect the movement of Entities who enter it . Standardised
and custom pre-movement settings can be applied.

Level Exit To remove Entities from one level of a model, so that they can
instantaneously re-enter another level.

Level To allow Entities that have exited one level of the model
Entrance through a Level Exit, to instantaneously re-enter another level
of the model.

Stair To represent staircases. Several configurations are available.

Escalator To represent escalators.

Gate To represent gates (IN, OUT, Switch).

Delay To delay Entities individually for a defined length of time and

Point) in a specific distribution, before sending them to other targets.

© 2001–2017 Legion International Ltd 173

Legion SpaceWorks R6.5.0 User Guide

Icon Name Typical usage

Queue To simulate the form and function of a queue by causing Entit-

ies to form a line with a defined direction. When an Entity
reaches the head of the queue they are re-targeted to a Delay
Point.

Queue To simulate supermarket checkout or post- office style

Group Queuing systems where there is a series of single Queues,
each serving their own individual service point and offering
the same service.

Waiting To make selected Entities passing over this area wait for an
Zone event with an ‘absolute time’ to occur. Once this event has
occurred, all the Entities that were waiting are released and
re- targeted by an overlaid Direction Modifier. Along with
Exits, Waiting Zones can be ‘Final Destinations’.

Direction To redirect Entities to another target when they pass over this
Modifier object, according to filters and conditions. Direction Modifiers
can also change an Entity’s Type and assign a different Final
Destination.

Focal Node To attract Entities to a certain place before retargeting them

to another object or objects.

Drift Zone When Entities enter the area of a Drift Zone, they may move
in a certain direction, or change speed, according to the
defined parameters of the Drift Zone. Useful for alleviating
congestion or correcting unusual or inaccurate Entity move-
ment.

Focal Drift Enable you to define a series of intermediate focal targets

Zone between an origin object and a target object for Entities to fol-
low as part of their overall journey. Each FDZ has a focus
which can be either a point or a segment, and while an Entity
is within the area of an FDZ it is directed towards this focus.

Route A guide (any shape, using the CAD drawing tools) that can
Guide restrict or allow the passage of Entities according to its filter.
Useful for cordoning off space within a model.

Mesoscopic A zone which enables you to 'abstract' an area of your model

Transition in which you don't require detailed simulation and analysis.
Zone For example: shops, waiting areas, lifts, transport shuttles
and more.

Multipath A zone in which Entities can choose between different poten-

Zone tial routes depending on time and distance preferences.

Analysis Objects
Analysis Objects (Zones, Lines and Poly-lines) are used most widely and powerfully in the Ana-
lyser but they also exist within the Model Builder. In the Analyser, they are used to identify
areas of a simulation that you want to 'interrogate' analytically, using a wide range of met-
rics. These kinds of analyses are known as 'Reporting' analyses'

174
Legion SpaceWorks R6.5.0 User Guide

In the Model Builder, Analysis Objects are used in setting up 'Conditions', which enable you to
model operational measures taken in response to over-crowding or other dynamic events.
These kinds of analyses are known as 'Conditional' analyses'. For an explanation of Condi-
tions, see 14: Conditions in Models and for more information on Analysis Objects within the
Analyser, see About Analysis Objects.

While it is usual to set up 'Reporting' analyses in the Analyser, you can do so in the Model
Builder. When your model is eventually opened in the Analyser, these analyses will
already be there and will not need to be added.

© 2001–2017 Legion International Ltd 175

Legion SpaceWorks R6.5.0 User Guide

The form of Spatial Objects

Spatial Objects are similar to CAD objects in that they can be drawn directly into a model and
they have an ‘area’: a size and shape that you define when you draw and place an object into
your model.
Certain Spatial Objects, namely Exits, Level Exits, Delay Points, Queue Groups, Focal Nodes,
Escalators, Stairs and Waiting Zones need a ‘Focal Segment’ as well as an area.

For Waiting Zones, the Focal Segment is optional as you may require the zone to work
purely as a filter rather than a target.
The following illustration shows the area and Focal Segment of an Exit, along with other key
elements.

How Focal Segments work

Focal segments ensure that Entities approach targeted objects from any direction in a realistic
manner. They prevent inaccurate congestion at corners and help to create accurate queuing
patterns for stairs and escalators without the need for special Drift Zones.
A Focal Segment is composed of the segment itself (line AB in the diagram below), ,which has
a focal point (the cyan square in the middle of AB) and two adjustable approach angles (shown
below as green dotted lines).

176
Legion SpaceWorks R6.5.0 User Guide

Focal point
The focal point is used by Legion’s auto-navigation function to direct Entities (who can’t yet
‘see’ the target object) towards the Focal Segment.

Focal segment
This line influences Entities once they can ‘see’ the segment they are targeted towards. Entit-
ies can see the focal point from any distance, depending on the presence of obstacles and
other environmental conditions.

Approach angles
The approach angles, which can be configured when you draw the Spatial Object, govern the
angle at which Entities (from any direction) approach the Focal Segment.

Entity behaviour in zones I–IV

In Zone I, which is around 8 metres from the segment, Entities can see the Focal Segment
and begin to approach it using next best-step decisions which are restricted to the space
between the approach angles.
Entities also exclude their own body-radius plus a subjective lateral clearance space (subject
to their momentum and ambient density) when calculating the accessible space of the Focal
Segment. This excluded area is represented by the black circular arrows around points A and
B in the diagram.
In Zone II, which is around 2 metres from the segment, Entities approach it using next best-
step decisions which are restricted to the triangular area defined by the segment and an
Entity’s position in relation to points A and B. The effect of this restriction is to limit Entities
‘synchronising’ with each other, which can lead to hesitation and unrealistic blockages.

© 2001–2017 Legion International Ltd 177

Legion SpaceWorks R6.5.0 User Guide

In Zones III and IV, which are further away than the 8 metre-visibility of the Focal Segment,
Entities head towards the nearest point along the distant segment and their step-choices are
unrestricted at this distance. For instructions on placing a Focal Segment, see Placing a Focal
Segment.

178
Legion SpaceWorks R6.5.0 User Guide

Drawing and placing Spatial Objects

Like CAD objects, Legion’s Spatial Objects can be drawn directly into a model. If you want to
draw several instances of the same kind of object, one after another, click the ‘Auto-Repeat’
button first . This enables you to immediately click and draw the same type of object after
drawing and placing an object (for instance, you may wish to draw several Entrances before
moving on to Exits). See step 1 of the following procedure.
You can draw an object as a rectangular shape or a polygonal shape by first clicking one of the
drawing icons (‘Rectangle Mode’ and ‘Polygon Mode’) on the Spatial Objects toolbar, illus-
trated in step 2 of the following procedure.
You can also draw objects and lines by typing commands into the Command bar and following
the instructions in the Output Bar. See Drawing Spatial Objects using commands for full
details.
If you have imported origin and destination objects using the new Data Template spreadsheet,
you can select these pre-defined objects from a drop-down list when naming new objects in
the workspace.

Press the Esc key at any time to cancel.

To draw a Spatial Object:

1. If you want to draw several instances of the same type of object in a row, click the ‘Auto-
Repeat’ icon .

When you want to deactivate ‘Auto-Repeat’, click its icon again.

2. Click either the rectangular drawing icon or the polygonal drawing icon .
3. Click on the icon belonging to the Spatial Object you would like to draw.
4. Click in the model at the point where you would like to start drawing the object.
5. If you are drawing a rectangular object:
◊ Drag your cursor to define the size and shape of the object. When you are happy with
its proportions, click to complete and place the object.
If you are drawing a polygonal object:
◊ Move your cursor to the first vertex of the polygon you are drawing and click your
mouse. Now move the cursor to the next vertex of the polygon and click to place that
point.
◊ Continue for as many points as the polygon contains and, to complete the shape, right-
click your mouse and select Finish Boundary to place the object.

Delay Points and Waiting Zones also have Dispersal Points. You will need to add these
after drawing them. See Drawing Delay Points for instructions.
If the object has a Focal Segment as well as an area you will be prompted to place a Focal
Segment. See Placing a Focal Segment.

Placing a Focal Segment

Follow this procedure when you need to place a Focal Segment when drawing a Spatial Object
that can receive links. In the course of this procedure, you will be prompted by the Output Bar
to make decisions about the position and size of the Focal Segment (usually whether to use
default settings or draw the segment manually).

© 2001–2017 Legion International Ltd 179

Legion SpaceWorks R6.5.0 User Guide

Waiting Zones and Level Exits can work purely as filtering objects so when drawing them you
will be asked if you want to use the object as a target or as a filtering object.

To place a Focal Segment:

1. Complete steps 1 to 4 of To draw a Spatial Object:.
You are prompted to choose whether you want to use a side of the object as a Focal Seg-
ment or not.
2. Press Enter to confirm and go to step 3.
If you want to draw the segment manually, type n, press Enter and draw start and end
points for the segment. When you have done so, an arrow showing the direction in which
Entities will cross the Focal Segment is displayed. Go to step 4.
3. If you want to use the whole side of the object as the Focal Segment:
◊ Click on the side you want to use as the segment.
The Focal Segment, with the correct Entity crossing direction, is created and the ‘Edit
<object name>’ dialog box is displayed.
If you only want to use part of an edge as the Focal Segment:
◊ Hold down the Shift key and draw the segment manually from one of the corners of
the object.
◊ Click to complete the Focal Segment.
The Focal Segment, with the correct Entity crossing direction, is created and the ‘Edit
<object name>’ dialog box is displayed.
4. To accept the suggested Entity-crossing direction, press Enter; to reverse the direction of
the arrow, type n and press Enter.
5. The Focal Segment is created and the ‘Edit <object name>’ dialog box is displayed.
6. Enter a name for the object (or choose from the drop-down list of imported objects if
appropriate) and set any required parameters. See Setting the parameters of Spatial
Objects.

Adjusting a Focal Segment

Once you have defined a Focal Segment you can always adjust its approach angles and focal
point at a later stage. This is particularly useful with objects like Stairs and Escalators where
the Focal Segments are automatically placed using a default focus point and approach angles.

We recommend that you keep the Focal Segment on or very close to the side of the Spa-
tial Object in question.

To adjust a Focal Segment:

1. Select the object whose Focal Segment you want to adjust. The Focal Segment will be high-
lighted in green dotted lines, with the focal point and vertices of the segment and approach
angles highlighted in blue.

180
Legion SpaceWorks R6.5.0 User Guide

2. To move the focal point or change the approach angles, click once on the relevant vertex,
move the cursor to the new position and click again to release.

Entity facing direction

When drawing Waiting Zones, Delay Points and Evacuation Zones, you are prompted to define
a facing direction for the Entities within these objects.

This setting is only relevant if you intend to present your model in Legion 3D.
After defining the shape of the object, you are asked: ‘Apply entity facing direction? [Y]/N’. To
accept, press Return and then position the graphical arrow using your cursor (you can change
this angle in the Edit <object> dialog box.

Drawing Spatial Objects using commands

You can also start to draw and place objects by typing commands into the Model Builder. Once
you have entered a command, follow the instructions on the Output Bar. Most instructions can
be carried out by typing coordinates into the Command bar or clicking into the workspace with
the mouse.
This procedure describes how to draw an Exit but for a comprehensive list of SpaceWorks com-
mands, including all objects, see Appendix: SpaceWorks Commands.

To draw an Exit using a command:

1. Type exit and press Enter.
The Output Bar prompts you with: From point:
2. Type x and y coordinates for the starting point of the Exit’s geometry (x,y) and press
Enter.
or
Click in the workspace at the starting point.
The Output Bar prompts you with: To point:
3. Repeat step 2 for the finishing position of the exit.
You are prompted to choose between using a side of the object as the Focal Segment or
drawing the segment manually.
4. To use a side of the object as the Focal Segment, press Enter and go to step 5.
If you want to draw the segment manually, type n, press Enter, type the x and y coordin-
ates for the segment and press Enter again. When you have done so, an arrow showing
the direction in which Entities will cross the Focal Segment is displayed. Now go to step 7.
5. Move your cursor over one of the sides of the object (the side will be highlighted in green).
6. Click on the highlighted side you want to use as the segment. If you don’t want to use the
whole length of the selected side as the segment, hold down the Shift key and move your
cursor along the side of the object to the desired length of the segment and click.
An arrow showing the direction in which Entities will cross the Focal Segment is displayed.
7. To accept the direction, press Enter , to reverse the direction of the arrow, type n and
press Enter.
The ‘Edit Exit’ dialog box is displayed.
8. Enter a name for the object, or choose a name from the drop-down list of imported objects
(if appropriate), and set any required parameters. See Setting the parameters of Spatial
Objects.

© 2001–2017 Legion International Ltd 181

Legion SpaceWorks R6.5.0 User Guide

Deleting Spatial Objects

There are several ways to delete Spatial Objects from a model:
● In the Object Directory, select one or more objects, right-click and select Delete.
● In the workspace, select one or more objects, right-click and select Delete.
● After using the ‘Find’ tool to locate objects, you can right-click objects in the Output Bar
and select Delete Object(s).
● If an object generates errors or warnings and you no longer require the object, you can
right-click on the QA message and select Delete Object.

The size of Spatial Objects

Spatial Objects must be large enough so that Entities cannot step right over them and thereby
avoid being affected or filtered by the object. The exception to this rule is that Exits and Level
Exits always recognise and affect Entities that step over them.
The longest single step that an Entity can take is calculated from the distance the Entity can
travel in one time-step (0.6 seconds) going at the fastest unimpeded speed according to the
Speed Distribution of the Entity Type it belongs to. At its top speed (1.7 m/s), the Default
Entity Type can take a step of 1.02 metres.
This implies that any Spatial Objects intended to affect a Default Entity Type should have a
depth greater than 1.02 metres in the direction of the Entities’ approach to ensure that they
are not stepped over; again, with the exception of Exits and Level Exits.

Entities’ scanning ability

The in-built intelligence of Legion Entities enables them to ‘scan’ up to 5.0 metres ahead of
themselves in the direction of travel. Because of this, any Spatial Object should ideally have
sufficient depth in the direction of travel to ensure that Entities step into its area before they
react to any other object they perceive (for example they may slow down if they perceive a
wall beyond an Exit when in fact they would actually exit the space or head to another level
before being affected by any obstacle).
This is not always possible in confined spaces, however, and you should tackle these situ-
ations at your own discretion.
Exits, Level Exits, Delay Points, Waiting Zones, Focal Nodes, Escalators, Stairs and Focal Drift
Zones have Focal Segments; single Queues have a focus rather than a segment and it is
dynamic: it is placed at the head of the Queue and jumps to the end of the Queue as Entities
join it. Queue Groups also take a single focus rather than a Focal Segment.

Visibility-based Analysis Zones

A unique feature of Analysis Zones is that they can be drawn and placed according to 'vis-
ibility'. This means that, from a chosen viewpoint (a single point or a defined segment), the
shape and extent of an Analysis Zone can be calculated and placed according to how visible an
area of your model is from the chosen viewpoint.
This method limits the shape and size of the finished zone by viewing distance and viewing
angles: it stands to reason that physical objects can only be viewed within a certain distance
and between certain angles. This drawing method produces a shape, which reflects these phys-
ical and optical limitations.
This is useful when you want to analyse the impact of signs, information boards, or advert-
isements within a site, while taking obstacles and interruptions to sight lines into con-
sideration. An Analysis Zone can be placed that covers just the area in which Entities can view
a certain element of the venue, thus honing in on its effectiveness as a source of information
and influencer of movement.

182
Legion SpaceWorks R6.5.0 User Guide

When placing an Analysis Zone, you have the choice of calculating visibility from a single
point or a segment. A point is useful for small areas like a camera lens; a segment is bet-
ter for wider objects like information boards, or signs, or shop windows. The procedures
for both are slightly different.

To draw a visibility-based Analysis Zone for a point:

1. Click the visibility drawing icon (any icons and features not connected with visibility
drawing are disabled).

2. Click the Analysis Zone icon .

You are prompted to select 'Visibility for Point or Segment? [P]/S'
3. For a point, hit Return.
4. Click to place the visibility point. Choose the point whose visibility you want the Analysis
Zone to calculate and model. This should be the centre of the object (camera, small sign,
etc.). Use the pan and zoom tools as normal if required.

You can only place your point inside the model's accessible space. A dotted line is tem-
porarily imposed on the model, delineating areas of accessible space.
You are prompted to 'Move mouse to change distance'.
5. To set the distance from where you wish to calculate the visibility of the point, move the
mouse to the required place and left-click to fix it. By dragging the visibility arrow, you
can affect distance and direction. You can also type the distance coordinates (two figures
are needed) directly into the Command bar if you prefer. This screenshot shows the point
in the middle of a street Exit. The arrow has been extended to the required visibility dis-
tance.

You can now set the low and high angles from which your point can be seen.
6. To set the low angle, move your mouse to the required position and left-click.

7. To set the opposite (high) angle, move your mouse to the required position and left-click.

© 2001–2017 Legion International Ltd 183

Legion SpaceWorks R6.5.0 User Guide

8. You can now review your settings and, if you need to make any adjustments, you can
'grab' the various distance and angle markers by clicking on them and moving them. They
are highlighted in red, as in this screenshot.

When you're happy with the shape of the Analysis Zone, hit Return. The ‘Edit Analysis
Zone’ dialog box is displayed.
9. Enter an appropriate name for the Analysis Zone and click OK.
The new zone appears in the workspace and in the Object Directory, in the Analysis Layer.
10. Repeat from step 2 for any more Visibility-based Analysis Zones you would like to place.
To exit 'visibility mode', click the icon again.

To draw a visibility-based Analysis Zone for a segment:

1. Click the visibility drawing icon .

2. Click the Analysis Zone icon .

You are prompted to select 'Visibility for Point or Segment?'
3. For segment, type s and hit Return.
4. Draw the segment as you would draw a line of CAD or the side of any object. Use the pan
and zoom tools as normal if required. These screenshots illustrate the use of a segment
across a visible shopfront.

Drawing from left to right will create a directional arrow pointing up; drawing from right to
left will create a directional arrow pointing down; drawing top to bottom will create a dir-
ectional arrow pointing to the right; drawing bottom to top will create a directional arrow
pointing to the left. Also, you can only draw your segment inside the model's accessible
space. A dotted line is temporarily imposed on the model, delineating areas of accessible
space.

184
Legion SpaceWorks R6.5.0 User Guide

You are prompted to 'Move mouse to change distance'.

5. To set the distance from where you wish to calculate the visibility of the segment, move
the mouse to the required place and left-click to fix it. By dragging the visibility arrow, you
can affect distance and direction. You can also type the distance coordinates (two figures
are needed) directly into the Command bar if you prefer. This screenshot shows the seg-
ment drawn along one side of a retail unit. The arrow has been extended to the required
visibility distance.

You can now set the low and high angles from which your segment can be seen.
6. To set the low angle, move your mouse to the required position and left-click.

7. To set the opposite (high) angle, move your mouse to the required position and left-click.

© 2001–2017 Legion International Ltd 185

Legion SpaceWorks R6.5.0 User Guide

8. You can now review your settings and, if you need to make any adjustments, you can
'grab' the various distance and angle markers by clicking on them and moving them. They
are highlighted in red, as in this screenshot.

When you're happy with the shape of the Analysis Zone, hit Return. The ‘Edit Analysis
Zone’ dialog box is displayed.
9. Enter an appropriate name for the Analysis Zone and click OK.
The new zone appears in the workspace and in the Object Directory, in the Analysis Layer.
10. Repeat from step 2 for any more Visibility-based Analysis Zones you would like to place.
To exit 'visibility mode', click the icon again.

186
Legion SpaceWorks R6.5.0 User Guide

Setting the parameters of Spatial Objects

When you have drawn and placed a Spatial Object and positioned any required Focal Segment
or Dispersal Points, its ‘Edit <object name>’ dialog box is displayed.
The content of each dialog box differs according to which object you are working with (the
illustration below shows the ‘Edit Direction Modifier’ dialog box) but it will always contain a
principal 'Parameters' tab where you can enter the object’s name and other key details.

Depending on the type of object, other tabbed pages of the dialog box enable you to define
parameters relating to Links, Filters, Final Destinations, Target Parameters, Focal Distribution
and, in the case of Direction Modifiers, Target Rules and Conditions. Drift Zones, Waiting
Zones and Delay Points also have an 'Additional Parameters' tab for special Entity behaviour-
related settings.
When you have entered or selected all the appropriate parameters for the object in question,
click OK to save your changes. You can edit these parameters at any stage in your model
building activities. See Editing Spatial Objects. Parameters are discussed for each Spatial
Object in 15: Spatial Objects–in Detail.

© 2001–2017 Legion International Ltd 187

Legion SpaceWorks R6.5.0 User Guide

Grouping Spatial Objects

You can create composite objects by grouping them together. This is covered in detail in Creat-
ing Group Objects.

Target Parameters
All objects that contain Focal Points as part of their structure have an additional parameter tab
named 'Target Parameters'. This enables you to adjust the way Entities navigate towards the
Focal Point when they can't 'see' it due to obstructions in their path.
The tab contains a checkbox labelled 'Use Focal Point Navigation'. If this option is checked,
Entities will auto-navigate to the Focal Point and, once they can see it, will cross the Focal Seg-
ment at the nearest point.
If the option is unchecked, Entities will head towards the nearest visible point on the Focal Seg-
ment whether they can see the Focal Point or not (this method can create more realistic move-
ments but may also slow the software's performance).
In this illustration, the left-hand example shows how Entities move towards an obscured Focal
Point with 'Focal Point Navigation' checked and, on the right, how they behave when the
option is unchecked.

188
Legion SpaceWorks R6.5.0 User Guide

Refining the drawing of Spatial Objects

We have covered the simplest and easiest way to draw and place a Spatial Object. This sec-
tion focuses in greater detail on the Model Builder’s drawing tools and covers topics including
how to trim, move, select, and arrange Spatial Objects.

Using the Grid

It is very important when building a model that your objects are positioned correctly and do
not create problems in the simulation by overlapping each other, giving conflicting instruc-
tions to the Entities or by allowing Entities to miss them because they are positioned inac-
curately.
Turning on the Model Builder’s Grid enables you to check the accurate placement of your Spa-
tial Objects, snap them to specific points on the grid and helps avoid problems early on in the
project.
When you first show the Grid, its default settings are:
● Grid scale (m): 0.1
● Minor divisions: 1
● Major divisions: 10

To show the Grid:

● Click or select View > Show Grid (to hide the Grid, click the icon again).

● Click or select View > Show Axes (to hide the Axes, click the icon again)

To snap to the Grid:

● To snap to the Grid, click the ‘Snap to Grid’ icon .

To change Grid settings

1. Select Tools > Options > Tools Settings.
2. Enter a value for the Grid Scale (m) in metres.

Grid scale must be between 0.1 and 100m.

Choose a scale that allows you to check distances or define shapes (snap to grid) at a level
of accuracy for the space you are modelling.
3. Enter a value for the Minor divisions you want the Grid to display.
This value should be a multiple of the Grid Scale.
4. Enter a value for the Major divisions of the Grid Scale.
This value should also be a multiple of the Grid Scale.
5. Click the OK button.

Using Snaps
Snaps enable you to place Spatial Objects next to other objects or CAD lines, or at a certain
point on the grid, with greater speed and accuracy. They are also useful when positioning
objects in line with the Grid, if you have displayed and enabled it.
To activate one (or more) of the types of Snap, click on the appropriate icon or icons on the
Snaps toolbar. To switch a particular Snap off, click its icon again; the grey border around the
active icon disappears.

© 2001–2017 Legion International Ltd 189

Legion SpaceWorks R6.5.0 User Guide

The following table contains the Grid functions and available Snaps within the Model Builder.

Snap
Icon Name Function
symbol

Snap to Cursor snaps to the vertices of the N/A

Grid Grid, whether the Grid is visible or not.

Show Axes Displays the X and Y axes in your N/A

model.

Orthogonal Means you can only draw lines at 90° N/A

Snap angles to your reference point.

Snap to Cursor snaps to the ends of lines or

End-point corners of polygons.

Snap to Cursor snaps to the mid-point of lines

mid-point or sides of polygons.

Snap to Cursor snaps to the nearest point on

Nearest lines or sides of polygons.

Snap to Cursor snaps to nearest centre of a

Centre circle or arc.

Snap to Cursor snaps to the nearest (actual or

Intersection projected) intersection of any pair of
segments.

To use snaps:
1. Click on one or more of the Snap icons described in the table above.
2. Draw new lines or objects, or move existing lines or objects.
When you move the cursor close to another Spatial Object or CAD element, the Snap sym-
bol appears and snaps temporarily onto any obstacles or Spatial Objects at highlighted
points defined by the Snap type(s) you selected (mid-point, end-point, etc.).

As a reference guide, when you move an existing line or object, its initial location is high-
lighted in red and a white line displayed from that point to the location of your cursor.
3. Click near the highlighted point to snap the vertex you are drawing or moving directly onto
this point.
If there are no highlighted points near to snap to, you may click and place the line or
object where you please.

Priority of Snaps
Snaps are prioritised so that if two possible snapping points are within range, the one with the
highest priority is chosen. The order of priority is as follows: End-point > Mid-point >
Centre > Intersection > Nearest.

Selecting Spatial Objects

There are several ways to select Spatial Objects in a model.

To select a Spatial Object:

190
Legion SpaceWorks R6.5.0 User Guide

1. Do one of the following:

◊ Click anywhere on the boundary of the object (or objects).
You may use the standard Windows method of selecting multiple objects by holding
down the Ctrl key and selecting each object individually.
◊ In the Object Directory, right-click on the object’s name and Select Object.
◊ Click and drag a rectangle completely around the object (or objects) you want to select
and click to select.

Cutting, copying and pasting Spatial Objects

You can cut, copy and paste Spatial Objects within the same model file or between different
model files. In all cases, these actions may lead to naming conflicts which can be resolved in
the ways described in Cutting, copying and pasting between different model files.

Cutting, copying and pasting within the same model

To cut and copy objects within one model file:
1. Select the object or objects you want to cut or copy and do one of the following:

◊ Right-click in the model and select Cut or Copy .

or
◊ Press Ctrl-X or Ctrl-C.
The object or objects are now cut or copied to the Clipboard.

To paste objects within one model file:

1. After cutting or copying an object or objects, do one of the following:

◊ Right-click in the model and select Paste .

or
◊ Press the Ctrl-V keys.
The object or objects to be pasted appear attached to your cursor. Move the cursor to
the point where you want to paste and click.
To cut, copy or paste using a Base Point, type Cut or Copy or Paste into the Command bar
and follow the Command bar’s instructions.

To paste objects by using coordinates:

1. Cut or Copy an object or objects using one of the methods described above.
2. Paste the object or objects using one of the methods described above but when the object
or objects appear attached to the cursor, type the X and Y coordinates, of where you would
like to place the object, in the Command bar (using the format: x,y) and press Enter.

A pasted object inherits all the properties, filtering, links and other information that the
copied object contained. The number and types of links from/to pasted objects depends on
the object selection.

Naming pasted objects

To avoid name clashes, Spatial Objects are automatically given new names when they are pas-
ted.
The auto-naming convention followed is: <original name>#<N+1>, where N is the largest
index of the Spatial Object of the same type with the same prefix (<original name>) currently
in the model.

© 2001–2017 Legion International Ltd 191

Legion SpaceWorks R6.5.0 User Guide

For instance:
● Copying and pasting “Entrance #005” in a model that already contains 13 Entrances
labelled “Entrance #001”...”Entrance #013” will result in the pasted object being named
“Entrance #014”.
● Copying and pasting “Main Entrance” in a model where no other Entrances have the same
name results in “Main Entrance #001”.
You may give two Spatial Objects of different types the same name. For instance, it is pos-
sible to have a Drift Zone and a Waiting Zone both named “Platform#001” in the same model.
It follows that if you copy a Drift Zone called “Platform #002” into a model already containing
a Waiting Zone labelled “Platform #003”, then no conflict will arise and the pasted Drift Zone
will also be labelled “Platform #003”.

Cutting, copying and pasting between different model files

Sometimes large, complex models require a number of people to work simultaneously on sep-
arate model files and copy Spatial Objects from each file into a ‘master file’. When objects or
entire layers are copied across model files, the following things occur:
● All links will remain intact throughout the cut/copy–paste activity as long as both the
object linked-from and the object linked-to are included in the copy.
● Properties and filters of all the objects copied across will also be copied. This means that
data, such as Arrival Profiles, Supply and Entity Types and Delay and Event Profiles, will
be copied across different models, provided that they are referenced by at least one Spa-
tial Object included in the selection.
● If any Spatial Objects being copied have the same names as Spatial Objects already in the
target file, the ‘Name Clash’ dialog box is displayed.

Select one of the following options:

◊ Automatically rename the pasted object
◊ Use the existing object (Already present in model)
◊ Overwrite the existing (Use newly pasted)
and click the OK button.

Moving Spatial Objects

You can move objects within your model by using any one of the methods described in the fol-
lowing procedure.

To move a Spatial Object:

1. Right-click within the space of an object and select Move <object name>.

192
Legion SpaceWorks R6.5.0 User Guide

or
Select the object and type Move in the Command bar and press Enter.
or
Type Move into the Command bar, press Enter, click on the object and press Enter
again.
2. Click in the model to establish a Base point for the object you are moving.

You can move multiple objects at the same time by selecting them before typing the
Move command.
or
Type a Base point value into the Command bar and press Enter.
The object appears attached to your cursor.
3. Move your cursor to the place where you want to move the object and click to position it.

To undo, press Ctrl-Z or select Edit > Undo.

To move a Spatial Object using coordinates:

1. Right-click within the space of an object and select Move <object name>.
or
Click on the object and type Move into the Command bar and press Enter.
or
Type Move into the Command bar, press Enter, click on the object and press Enter
again.
2. Type the X and Y coordinates of the Base point (this is the reference point for the move)
into the Command bar and press Enter.
3. Type the X and Y coordinates of the place you want to move the Base point to into the Com-
mand bar and press Enter (for instance, typing 5,10 moves the Base Point to those
coordinates).

Changing the shape of Spatial Objects

Having drawn and defined a Spatial Object, you may want to change its shape and appear-
ance. You can do this by moving, adding and deleting vertices.
The vertices of an object are visible whenever you select the object: they are displayed as
small green squares where the lines of the objects meet.

To change the shape of a Spatial Object:

1. Select an object using any of the methods described in Selecting Spatial Objects.
2. Click on one of the object’s vertices to ‘snag’ it, move your cursor to another position and
click again to release it.
The vertex moves to its new position.
3. Repeat for other vertices until you are satisfied with the changes you have made to the
object’s shape.
You can add or delete vertices from an object to change its shape. Deleting a vertex can
instantly change the shape of an object, for example, deleting a vertex from a square turns it
into a triangle. Adding a vertex gives you a new point from which to change the shape of an
object.

© 2001–2017 Legion International Ltd 193

Legion SpaceWorks R6.5.0 User Guide

To add or delete a vertex:

1. Select an object using any of the methods described in Selecting Spatial Objects.
2. To add a vertex, right-click on an existing vertex and select Add Vertex.
A new vertex is added to the object, in a clockwise position from the vertex you first
clicked on.
or
◊ To delete a vertex, right-click on an existing vertex and select Delete Vertex.
The vertex is deleted and the shape of the object is instantly updated with the vertices
either side of the deleted vertex joined by a single line.

Rotating Spatial Objects

You can rotate Spatial Objects using the User Coordinate System (UCS). The angle of rotation
is anti-clockwise from the X axis, as illustrated below.

This is particularly useful when you have, for example, a circular Drift Zone at
one end of a flight of stairs that you would like to rotate and use for the other end
of the stairs.

You can rotate multiple objects at the same time by selecting them before typing the
Rotate command.

To rotate an object:
1. Right-click within the space of an object and select Rotate <object name>.
Click on the object, type Rotate into the Command bar and press Enter.
or
Type Rotate into the Command bar, press Enter, click on the object and press Enter
again.
2. Click in the model to establish a Base point for the object you are rotating.
or
Type a Base point value into the Command bar and press Enter.
3. Type an angle of rotation into the Command bar and press Enter to rotate the object
around the Base point.
Typing 45 will rotate the object 45° (UCS), typing 315, or -45 will rotate the object 315°
(UCS).

194
Legion SpaceWorks R6.5.0 User Guide

Scaling Spatial Objects

You can rescale objects by equal multiples along the X and Y axes.

To scale an object:
1. Right-click within the space of an object and select Scale <object name>.

You can scale multiple objects at the same time by selecting them before typing the Scale
command.
or
Click on the object and type Scale into the Command bar and press Enter.
or
Type Scale into the Command bar, press Enter, click on the object and press Enter
again.
2. Click in the model to establish a Base point for the object you are scaling.
or
Type a Base point value into the Command bar and press Enter.
3. Type a Scale factor, in decimals, into the Command bar and press Enter.
As an example, typing 2 will enlarge the object by a factor of 2 in the direction of the X
and Y axes; typing 0.5 will halve the size of the object.

Trimming Spatial Objects

The Trim tool enables you to crop and reshape Spatial Objects to fit existing CAD forms or
other objects. For example, you could fit an Entrance or an Exit to, say, a curved wall or
around the perimeter of an obstacle.

To stop the trimming process at any time, press the Esc key.
The following procedure uses the example of trimming a Drift Zone around part of a circular
CAD object.

To trim a Spatial Object:

1. Click or select Modify > Trim (or type trim in the Command bar).
The Output Bar prompts you to Select object to trim.
2. Click on the object whose shape you want to change by trimming (in this example, the rect-
angular Drift Zone).

The Output Bar prompts you to Select trimming edges.

3. Click on the object (or objects) to whose shape you wish to trim the original object (in this
example, the CAD circle).

© 2001–2017 Legion International Ltd 195

Legion SpaceWorks R6.5.0 User Guide

4. Press the Enter button.

The Output Bar prompts you to Trim object.
5. To trim the original object, click within the area of the object you want to remove (in this
case, in the space of the Drift Zone that lies within the shape of the CAD circle). The object
is trimmed, as in the example below.

6. Press the Enter button when you have finished trimming.

Creating a Rectangular Array

The Rectangular Array tool enables you to reproduce one or more objects in symmetrical form-
ation along two axes (rows and columns). This is particularly useful when you need to place
identical Spatial Objects at regular intervals and equidistant from each other (for example, a
bank of Delay Points to model turnstiles).

To create a Rectangular Array:

1. Click on or select Modify > Rectangular Array (or type rectarray in the Command
bar).
The Command bar prompts you to Select object(s) for the array.
2. Select the object (or objects) you want to reproduce, and press Enter.
The Command bar prompts you to Select the object reference point.
3. Click within the object (or at one point within the selected objects) to define the reference
point around which the array will be generated.
The Command bar prompts you to Select row direction and spacing interval.
4. Move your cursor in the direction you want the row of reproduced objects to be arrayed.
5. Click at the point which represents the space you want to maintain between each sub-
sequent object in the row:

196
Legion SpaceWorks R6.5.0 User Guide

The Command bar prompts: How many objects in a row (to create a single row, enter
1).
6. Type the number of reproduced objects you want to appear in the row you have just
defined and then press Enter.
The Command bar prompts you to Select column direction and spacing interval.
7. Move your cursor in the direction you want the column of reproduced objects to be
arrayed.
8. Click at the point which represents the space you want to maintain between each sub-
sequent object in the column.
The Command bar prompts: How many objects in a column (to create a single
column, enter 1).
9. Type the number of reproduced objects you want to appear in the column you have just
defined and then press Enter.
The arrayed objects are displayed in the Model Builder workspace. All properties and links
associated with the original object are also associated with the objects in the array.

Creating a Polar Array

The Polar Array tool enables you to reproduce one or more objects in a regular circular
arrangement around a specified central point. The procedure involves using the mouse, mov-
ing the cursor and typing values into the Command bar.

To create a Polar Array:

1. Click or select Modify > Polar Array (or type polararray in the Command bar).
The Command bar prompts you to Select object(s) for the array.
2. Select the object (or objects) you want to reproduce, and press Enter.
The Command bar prompts you to Select the centre of the Polar Array.
3. Click within the model to select the point around which the Polar Array will be generated.
The Command bar prompts you to Select the object reference point.
4. Click within the object (or at one point within the selected objects) to define the reference
point around which the array will be generated.
The Command bar prompts you to Select the increment angle.
5. Click at the point which represents the angle you want to maintain between each object as
it is plotted in the array.
The Command bar prompts: How many objects in the Polar Array.
6. Type the number of reproduced objects you want to appear in the array and then press
Enter.
The Command bar asks: Do you wish to rotate the object(s) as they are copied?.
7. To rotate the objects, type y and press Enter; if you do not want to rotate the objects,
type n and press Enter.

© 2001–2017 Legion International Ltd 197

Legion SpaceWorks R6.5.0 User Guide

The arrayed objects are displayed in the Model Builder workspace. All properties and links
associated with the original object are also associated with the objects in the array.

Mirroring Spatial Objects

The Mirror tool enables you to copy one or more selected objects around a specified axis of
symmetry.

To Mirror an object or objects:

1. Click or select Modify > Mirror (or type mirror in the Command bar).
The Command bar prompts you to Select object(s) to mirror.
2. Select the object (or objects) you want to mirror, and press Enter.
The Command bar prompts you to Select first point of mirror axis.
3. Click at the point in the model where you want the first point of the mirror axis to be.
The Command bar prompts you to Select second point of mirror axis (you can define
a horizontal, vertical or oblique axis).
4. Click at the point in the model where you want the second point of the mirror axis to be.
This defines the plane of the ‘mirror’.

The object (or objects) are mirrored across the axis you defined. All properties and links
associated with the original object are also associated with the mirrored objects.

Measuring distances
The Measure tool enables you to accurately measure:
● The distance between two points
● The cumulative length of a number of contiguous line segments
● The area of a closed rectangle or polygon

To measure the distance between two points:

1. Click or select Tools > Measure.

2. Click the cursor at the starting point of the distance you want to measure.
3. Click the cursor at the end point of the distance you want to measure.
As you move the cursor, notice that the distance you are moving the cursor is updated in
the Status Bar. When you click at the end of the distance, the distance between these two
points is recorded in the Output Bar, for example:

198
Legion SpaceWorks R6.5.0 User Guide

Length of last segment = 180.50m

4. Press the Esc key to finish measuring.

To measure the cumulative length of a number of lines:

1. Click or select Tools > Measure.

2. Click the cursor at the starting point of the distance you want to measure.
3. Click the cursor at a second point and as many further points as you require.
Each time you click at the end of a line, the lengths of these lines are recorded in the Out-
put Bar, for example:
Length of last segment = 180.50m
Length of last segment = 39.65m
Length of last segment = 95.40m
The cumulative distance of all the lines is recorded in the Status Bar, for example, the dis-
tance for the three lines above is displayed as 315.55m.
4. Press Enter to finish measuring.
The total distance is displayed in the Output Bar.

To measure the area of a closed rectangle or polygon:

1. Click or select Tools > Measure.

2. Click the cursor at the starting point of the shape whose area you want to measure.
3. Click the cursor at a second point and as many further points as your shape requires.
4. Right-click and select Finish (close polygon) to complete your shape.
The total length of the perimeter and the total area of the shape are recorded in the Output
Bar, for example:
Total length = 142.29m
Closed area = 1220.29m2
5. Press the Esc key to finish measuring.

Copying the geometry of Spatial Objects

The Copy Geometry tool enables you to quickly change the shape of one object to exactly
match the shape of another object. This is particularly useful if you need to place one object
directly over another (a Direction Modifier over a Delay Point, for example).

To copy the geometry of a Spatial Object:

1. Click or select Modify > Copy Geometry (or type copy geometry).
2. Select the object you want to modify.
3. Select the object whose geometry you want to copy.
The Output Bar asks Do you want to superimpose the copy on top of the original
(Y/N)?
4. If you want to superimpose the object whose geometry you are changing directly on top of
the original object, type y and press Enter.
If you do not want to superimpose the object, type n and press Enter.
5. Press Enter to copy the object’s geometry.
The first object’s shape is altered to match the geometry of the second object.

© 2001–2017 Legion International Ltd 199

Legion SpaceWorks R6.5.0 User Guide

The Find Tool

The Find tool enables you to search for all the elements that constitute a model, using various
criteria. In this way you can isolate objects that have common properties (names, filtering
methods, targets, etc.), which can be helpful when debugging the model or ‘group-editing’ a
number of objects at once.

Search criteria
You can base a search on one or more of the following criteria, which all appear in the ‘Find’
dialog box:
● Type–search for all objects of a specified type (Entrance, Supply Type, Delay Profile,
etc.).
● Name–search for all objects with a common name, based on the whole name or part of the
name combined with ‘*’ and ‘?’ wildcards (see Using ‘Wildcards’).
● Layer–search for all objects in a specified layer.
● Depends Upon–search for all objects that are associated with a specified data object
(Entity Type, Arrival Profile, etc.).
● Linking To–search for all objects that link to specified objects (Exit, Delay Point, etc.).
● Linking From–search for all objects with links from specified objects (Queue, Entrance,
etc.).
● Final Destination–search for all objects linked to specified Final Destinations (Exit, Waiting
Zone, etc.).
● Filter Method–select one of the available methods to search for objects or elements that
use filters (‘Affect none’, ‘Affect all’, ‘Selected attributes’, ‘Tracked entities’).
If you choose ‘Selected attributes’, the following five criteria also become available;
choose one or more and select the relevant objects to refine your search
◊ Filter by target
◊ Filter by entity type
◊ Filter by activity
◊ Filter by origin
◊ Filter by final destination

Selecting Criteria
To select criteria in the ‘Find’ dialog box, check the box next to the name of the criterion. This
enables the associated field, drop-down menu or ‘browse’ button.
‘Name’ requires you to type a name into the related text box.
‘Type’ and ‘Filter method’ require you to select items from drop-down menus.
The other criteria require you to click on a browse button, which displays a further ‘Select
Objects’ dialog box from which to select objects or targets, etc.

To deselect criteria, click the ‘Clear All’ button.

200
Legion SpaceWorks R6.5.0 User Guide

All available objects are listed in the left-hand pane (Available) of the dialog box. To include
items in your search, you must move them into the right-hand pane (Selected).

To select items:
1. You may need to expand the list of items by clicking the + symbol to reveal all items.
2. Select items in the following ways.
◊ To move all items into the Selected pane, click the >> button.
◊ To move a single item into the Selected pane, click on the item and click the > button.
◊ To move all items back into the Available pane, click the << button.
◊ To move a single item back into the Available pane, click on the item and click the <
button.
3. Click the OK button.

Using ‘Wildcards’
When typing a name into the Name field, you can enter the full name of the object you are
searching for, if you know it, or you can use one of the two accepted ‘wildcards’: ‘?’ and ‘*’.
The ‘?’ wildcard substitutes a single character, so if you typed Ent?, the Find tool would
search for a four-letter name beginning with “Ent”.
The ‘*’ wildcard substitutes 0 or more letters, so if you typed Ent*, the Find tool would search
for words of any length beginning with “Ent”.
These wildcards can be useful when you are searching for a range of objects whose names are
similar.

To search for objects using the Find tool:

1. Click or select Data > Find to display the ‘Find’ dialog box.
2. Working down the list of Search Criteria, check the box of each criteria you want to use
in your search and specify the object, target or filtering method you require in each case.
3. Select one of the Search Scope options:

© 2001–2017 Legion International Ltd 201

Legion SpaceWorks R6.5.0 User Guide

◊ Match all–finds objects that meet all your criteria.

◊ Match any–finds objects that match at least one criteria.
4. Click the OK button.
If the search finds results, they are displayed in the ‘Search Results’ tab of the Output Bar.
If no search results are found, the following message is displayed:
No results found matching the search criteria.
5. Click the Close button to close the ‘Find’ dialog box.

Searching with the Output bar

You can perform searches in the ‘Command’ line of the Output bar by typing Find, pressing
Enter and then typing in further commands, like Name=*street* (this will search for any
object with the string “street” somewhere in its name). The following table contains the valid
terms.

Command Searches for Search options

Type All objects of a spe- Any object or element within the model (Activ-
cified type ity Objects, Analyses, Analysis Objects, Data
Profiles, Objects, Layers).

Name All objects with a Text: whole name

common name Wildcards ‘?’ and ‘*’

Layer Layers within the Any of the four types of Layer found in
model SpaceWorks (Activity, CAD, Conditions, Par-
tition).

Depends_ All objects that Arrival Profile

On depend on a spe- Availability Profile
cified data object. Delay Profile
Entity/Supply Type
Event Profile
Exit Profile

Linking_To All objects that are Any objects that can be linked to.
linked to a specified
object

Linking_ All objects with Any objects that can be linked from.
From links from specified
objects

Final All objects linked to Any object that can be used as a Final Destin-
Destination as Final Destin- ation
ations

Filter_ All objects that use Affects All

method a specified method Affects None
of filtering Selected Attributes
Tracked Entities

Filter_ Tar- All objects that fil- Delay Point

get ter by a specified Exit

202
Legion SpaceWorks R6.5.0 User Guide

Command Searches for Search options

Target Escalator
Focal Node
Level Exit
Queue/Queue Group
Stair
Waiting Zone

Filter_ All objects that fil- Entity Type

Entity_ ter by specified
Type Entity Types

Filter_Activ- All objects that fil- Activities

ity ter by specified
Entity activities

Filter_ Ori- All objects that fil- Origins

gin ter by specified ori-
gins

Filter_ All objects that fil- Final Destinations

Final_ ter by specified
Destination Final Destinations

All these criteria can be used in combination with AND, OR and AND NOT, as described in the
following table:

Syntax Meaning

& AND

| OR

! AND NOT

To search using the Command bar:

1. Type Find and press Enter (there is no need to click in the Command bar before typing).
2. Enter a command from the list above (using wildcards if necessary) and possibly com-
bining your commands with the appropriate syntax (AND, OR, AND NOT).
3. Press Enter.
If the search finds results, they are displayed in the ‘Search Results’ tab of the Output Bar.
A message is displayed if no search results are found.
4. Click the Close button to close the ‘Find’ dialog box.

Examples of searches using commands

Example 1
Command: Name = *Floor*
This returns all objects with “Floor” in their name (“Ground Floor”, “First Floor”, “Floor 1",
“First Floor Waiting Zone”, etc.).
Example 2

© 2001–2017 Legion International Ltd 203

Legion SpaceWorks R6.5.0 User Guide

Command: Type = Entrance & (Name = *Ground* | Name = *First*)

This returns all objects of the Entrance type with either “Ground” or “First” in their name.
Example 3
Command: Linking_To = Exit 1! Linking_To = Exit 2 & Depends_Upon = Arrival Pro-
file A
This returns all objects linked to “Exit 1" but not to “Exit 2", and depending upon “Arrival Pro-
file A”.

Search Results
Successful search results are displayed in the ‘Search Results’ tab of the Model Builder Output
Bar. They are listed by object and type.
● To select an object, right-click on its name and Select Object(s).
● To select more than one result, hold down Ctrl and select the specific multiple entries, or
hold down Shift and select the start and end of a range of entries. After selecting these
multiple objects, click the Select Object(s) button.
● To edit the properties of one of the results, double-click it or right-click on its name and
select Edit Properties.

Editing Spatial Objects

You can edit the parameters of Spatial Objects by displaying each object’s ‘Edit <object
name>’ dialog box. There are several ways to do this:
● Right-click inside an object and select Edit <object name>. If there is more than one
object in the vicinity of the cursor when you click, the resulting menu will offer you a list of
objects to select from. If there are more than ten objects available, select More to display
the entire list.
● In the Object Directory, double-click on an object.
● In the Object Directory, right-click on an object and select Edit Properties .
● If the object is listed as one of your search results, double-click on it or select it and then
press the Edit Properties button.
Change any parameters and click OK to confirm your changes. See Setting the parameters of
Spatial Objects and also 15: Spatial Objects–in Detail.

Group-editing Spatial Objects

You can edit the properties of multiple Spatial Objects of the same type at the same time. This
is known as a group-edit.

To group-edit Spatial Objects:

Either

1. Use the Find tool to search for a group of objects of the same type (see The Find Tool)
2. Select the objects you want to edit.
3. Click the Edit Properties button.
The ‘Edit Multiple <object types>’ dialog box is displayed.
4. Change any parameters that are available (some may be greyed out because they are
only available for individual editing) and click the OK button to save your changes.
or
1. Type Edit in the Command bar and press Enter.
2. In the workspace, select the objects you want to edit.
3. Press Enter again.

204
Legion SpaceWorks R6.5.0 User Guide

The ‘Edit Multiple <object types>’ dialog box is displayed.

4. Change any parameters that are available (some may be greyed out because only avail-
able for individual editing) and click the OK button to save your changes.

If the group of objects you have selected is made of up of different object types, the ‘Edit
Multiple Objects’ dialog box for each of the object types opens in sequence as you save
your changes

Renaming Spatial Objects

The Rename tool enables you to rename a range of objects with the same name or a shared
portion of text. For example, you could change the name of every object containing the text
“Floor 1” in its name to “First Floor” instead. Rename is case-sensitive. It is not limited to
whole object names, but will also rename portions of text within names that match the
Replace text. For example, replacing “First” with “Second” will result in an object called “First
Floor Entrance” being renamed to “Second Floor Entrance”.

To rename objects:

1. Click or select Data > Rename.

The ‘Rename’ dialog box is displayed.
2. Type the text you want to replace into the Replace box.
3. Type the new text into the With box.
4. Select the Scope of your change from these three options:
◊ Selected objects–limits the change to objects you have selected in the workspace.
◊ Selected search results–limits the change to objects you have selected within
Search Results.
◊ All objects–applies the change to all objects within the model containing the original
text.
5. Click OK to make the change.
A message informs you of the number of changes you made.

© 2001–2017 Legion International Ltd 205

Legion SpaceWorks R6.5.0 User Guide

Object Catalogues and the Object Store

You can save Spatial Objects into catalogues so that you or your colleagues can reuse them in
other models. Catalogues can be stored on local or networked drives. Full details can be found
in 24: Object Catalogues and the Object Store.

206
Legion SpaceWorks R6.5.0 User Guide

12: Layers
In this chapter
This part of the guide provides further information about layers and their use within Legion
models.
This section covers the following topics:
● About layers
● Working with layers

© 2001–2017 Legion International Ltd 207

Legion SpaceWorks R6.5.0 User Guide

About layers
Layers enable you to manage your model, simulations and analyses and keep them visually
and conceptually ‘tidy’. Models can rapidly become very complex and it is helpful to arrange
different model objects in different layers.
This enables you to view, or work on, the layer of your choice rather than having to tackle the
whole model at once. Layers also enable different members of your team to work on different
areas of a model at the same time.

Types of layer
There are four types of layer within Legion SpaceWorks:
● CAD Layers
● Activity Object Layers
● Partition Layers
● Analysis Layers, including the Conditions Layer (Model Builder)
Whenever you create a new model within the Model Builder, a default CAD Layer; default
Activity Object Layer and default Conditions Layer are created. Layers are listed in both the
Object Directory and the Layer directory. Similarly, when you open a project in the Analyser,
a default Analysis Object Layer is created.

CAD Layers
A CAD Layer stores CAD that has been imported into, or drawn in, the Model Builder. It may
contain either Presentation CAD or Simulation CAD (see Preparing a CAD plan).
Each CAD Layer has two tabs, labelled Properties and FDS.
Properties
● Name.
● A check box labelled Use in simulation, which enables you to use the contents of this
layer as part of a simulation. CAD segments included in simulation layers will be treated
by Entities as obstacles.
● A check box labelled Use for Auto-navigation, which enables you to include or exclude
the contents of the layer from the auto-navigation process (this will enhance per-
formance). Auto-navigation is also know as macro-navigation.
● The number of CAD objects stored in the layer.
● An attribute to indicate whether the layer contains imported CAD or user-drawn CAD.
● (If the layer contains imported CAD) the filename of the imported file along with the date
and time it was imported. When you import a .dxf, .dgn or .dwg file, you are presented
with the option to retain any existing layer structure in the file.
FDS
This tab enables you to use the CAD objects on this layer as part of a file to be used with the
FDS software (see y for further information).
There are only two parameters to set on this tab:
● A check box labelled Include CAD in FDS file, which enables you to include the CAD in
this layer as part of the file you will export for use with the FDS software.
● A box labelled Height of CAD, which enables you to enter a height in metres for the CAD
walls (this is also known as the z-coordinate).

208
Legion SpaceWorks R6.5.0 User Guide

A note about the ‘Use for Auto-navigation' option

When this option is unchecked, auto-navigation will ignore all CAD objects on the layer when
calculating possible paths for Entities. Entities will still negotiate the objects when they
encounter them during the course of a simulation. Focal Drift Zones and Queue Groups will
also ignore these CAD items when their visibility polygons are generated.
Ignoring these small CAD objects can significantly reduce the calculations that auto- nav-
igation has to perform, thereby enhancing performance. We advise you to create a layer or
layers exclusively containing such small objects so that it is easy for you to identify them and
include or exclude them from auto-navigation.
When this option is checked, auto-navigation will consider all CAD objects on the layer when
calculating possible paths.

Activity Object Layers

An Activity Object Layer stores Activity Objects, like Delay Points, Queues, Stairs, etc. Such
objects may be arranged over several Activity Object Layers to allow for easier management
of objects.
An Activity Object Layer has a:
● Name.
● List of Activity Objects stored in the layer.

Partition Layers
Partition Layers are useful when you need to override Legion’s auto-navigation system and
place Focal Drift Zones to provide routing instructions instead. This can be done using Inter-
active or Batch partitioning (see Focal Drift Zone partitioning for details).
Before you can place Focal Drift Zones, you need to specify a unique target object for the Par-
tition Layer. See Selecting a target for the Partition Layer.

Analysis Layers
An Analysis Layer stores Analysis Objects: Analysis Lines, Poly-lines and Zones. It contains a:
● Name
● List of Analysis Objects stored in the layer.

Conditions Layer
The Conditions Layer is an Analysis Layer that is created by default whenever you create a
new Model. It stores any Analysis Objects which you place in order to introduce Conditions
into a model. For more information, see 14: Conditions in Models.

Properties of layers
You can define whether a layer is:
● Snappable/unsnappable.
● Locked/unlocked.
● Visible/invisible.
When a layer is snappable, you can snap new objects to objects in the layer. When a layer is
locked, you cannot select or modify any of the objects in the layer. When a layer is visible, all
objects in it are displayed in the workspace (conversely, when it is invisible, the objects are
not displayed).

© 2001–2017 Legion International Ltd 209

Legion SpaceWorks R6.5.0 User Guide

Working with layers

This section contains all the procedures you require to make best use of layers within Legion
SpaceWorks. Firstly, you need to be aware of two important components: the Layers Dir-
ectory and the Active Layers Toolbar.

Layers Directory
The Layers Directory allows you to add new layers and view and edit the properties of existing
layers. It is displayed alongside the Legion SpaceWorks workspace and can also be displayed
by selecting View > Toolbars > Layers.

The Layers Directory lists all layers in the model alphabetically, along with icons that denote
whether a layer is snappable, locked or visible:

A diagonal bar across an icon means it is either not snappable or not visible; the open or
closed padlock icon tells you whether the layer is locked or unlocked. A blue padlock icon
denotes a layer that cannot be unlocked; all non-Analysis Layers within the Legion Analyser
are permanently locked.
In the top right of the dialog box there are two further icons: Clicking the left-hand ‘copy’ icon
duplicates a selected layer; clicking the rubbish bin icon deletes a selected layer.

To make layers snappable, visible or locked:

1. Select View > Toolbars > Layers or drag the Layers Directory over the workspace to
enlarge it.
2. Click once on the appropriate icons adjacent to a layer to toggle them on or off.
For example, to lock a layer, click on the padlock icon so that it appears as a closed pad-
lock; to make a layer invisible, click on the eye icon so that it is crossed out with a diag-
onal line.
3. Repeat for each layer whose properties you want to change.

210
Legion SpaceWorks R6.5.0 User Guide

You can also make one or more layers visible or invisible from the Object Directory. Click
on the eye icon next to a layer or a selection of layers. You can also do this for objects
within layers.

Active Layers Toolbar

This toolbar sits at the top of the workspace along with the other toolbars. It enables you to
create new layers and also to view and change the active layer for each layer type.
In the Model Builder and Analyser, the Active Layers toolbar displays the name of the current
active layer for each of the relevant layer types. All additional layers are displayed alpha-
betically in drop-down lists next to the names of the active layers.
Active Layers are not relevant in the Simulator but Layer Views are, therefore only the ‘Edit
Views’ portion of the toolbar is available in the Simulator (see Layer Views).

Adding layers
You can quickly add extra layers to your model in addition to the default layers. Usually, only
one Conditions Layer is required per model.

To add a layer:

1. On the Active Layer toolbar, click , or to add, respectively, a new C AD

Layer, Objects Layer, Partition Layer or Analysis Layer.
or
In the Layers Directory, right-click on CAD, Objects, Partition or Analysis Objects and
select Add Layer.
The ‘Edit <CAD/Activity Objects/Partition/Analysis Objects> Layer’ dialog box is dis-
played.
2. Depending on the type of layer you are adding:
◊ For an Activity Object or Analysis Layer, enter a name in the 'Name' box and click OK.
◊ For a Partition Layer, enter a name in the 'Name' box and select a Target for the layer
(see Selecting a target for the Partition Layer for more information).
◊ For a CAD Layer, enter a name in the 'Name' box and, if you want this layer to appear
in the eventual simulation, tick the box Use in simulation. If you do not tick this box,
the layer can only be used for Presentation CAD. See also Changing the properties of a
CAD Layer.
The new layer appears in the list. Any layers excluded from simulations are shown in ital-
ics in the Layers Directory.

Changing the properties of a CAD Layer

By changing the properties of a CAD Layer you can specify whether the CAD Objects on a layer
are included as part of a simulation and whether to include the CAD as part of a file for use
with FDS (Fire Dynamics Simulator) fire-modelling software. You can also choose whether or
not the layer is considered when auto-navigation routes are calculated.

To change the properties of a CAD Layer:

1. Right-click on the relevant CAD Layer in either the Object Directory or the Layers Dir-
ectory and select Edit Properties.
The ‘Edit <Layer>’ dialog box is displayed.
2. Specify whether to use the CAD objects it contains within your simulation, by checking or
unchecking the box labelled ‘Use in simulation’.

© 2001–2017 Legion International Ltd 211

Legion SpaceWorks R6.5.0 User Guide

3. If the layer contains objects that you would like to exclude from the auto-navigation pro-
cess, uncheck the box labelled Use for auto-navigation. This can help speed up the soft-
ware as it doesn’t calculate possible Entity paths around each small CAD element. It also
activates the 'Availability' tab, so you can now apply Availability profiles to the CAD layer.

Entities will still be able to negotiate around small objects when they encounter them on
their journey.
4. If you want to include the CAD on this layer in a file for use with the FDS software, click on
the FDS tab.
5. Check the box labelled Include CAD in FDS file.
6. Enter a value in metres for Height of CAD.
7. Click OK to save your settings.

Applying Availability profiles to CAD layers

In certain situations you may need to make CAD layers available or unavailable at different
times in a simulation. This is useful when modelling different types of train on the same plat-
form.
For example, you may need different CAD-defined trains to appear on a platform at different
times to simulate timetabled services. You can achieve this by making different CAD layer
views available at different times.

To apply an Availability profile to a CAD layer:

1. Right-click on the relevant CAD Layer in either the Object Directory or the Layers Dir-
ectory and select Edit Properties.
2. Uncheck the box labelled 'Use for auto-navigation'.
3. Click on the ‘Availability’ tab.
4. Select an Availability Profile from the drop-down list labelled ‘Time Scope’.
5. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
6. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
7. Set up your condition as described from step 4 of To set up a Condition:.
8. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
9. Click OK to save the parameters.

CAD Layers and Availability Profiles

To assist with modelling different services and types of rolling stock on the same platform,
CAD layers can be linked to Availability Profiles. This means that different trains and types of

212
Legion SpaceWorks R6.5.0 User Guide

rolling stock can be drawn in CAD and these designs can then be 'turned on' or 'off' at spe-
cified times within a simulation. In this manner, Entities will interact with this CAD only when
it is available.
You can then use Layer View events on the Analyser Timeline to show or hide these CAD trains
at the correct times within your simulation and any animations you may produce as part of
your project. See 'Setting a Layer View' in Screen Camera track events for more information.

Making layers active

Each type of layer has one ‘active’ layer at any one moment. When a layer is active, it means
that any new objects, relevant to a particular type of layer that you add or draw, will be added
to it automatically. For instance, any CAD you draw will be added to the active CAD Layer, and
so on.

To make a layer active:

● Select an object and click the ‘Activate a Layer’ icon . This makes the layer on which
the object was sitting the active layer.
or
● On the Active Layer toolbar, select the layer you want to make active from the relevant
drop-down menus.
This layer is now the active layer and appears in the Active Layers Toolbar.
or
● In the Layers Directory, right-click on the layer you want to make active and select Make
active.

Selecting a target for the Partition Layer

To quickly create a Partition Layer with a target already selected, right-click within the
area of the target object and select Create Partition Layer with <object name>.
If you are using a Partition Layer to place Focal Drift Zones, you must select a target object
for the layer. If you do not, an error is reported by the Model QA.

To select a target for the Partition Layer:

1. Make sure that a target object has already been drawn.
2. Open an existing Partition Layer or create a new one.
The ‘Edit <Partition Layer>’ dialog box is displayed.
3. Click the ‘Browse’ button to the right of the field labelled ‘Target’.
4. Select a target from the list of available objects in the ‘Select Object’ dialog box.
5. Click OK to save your settings.

Duplicating layers
You can duplicate layers, whether they are locked or not. If your model contains several
floors with identical layout or objects, duplicating can save you time in the model building
phase of your project. When you duplicate a layer, you create a complete copy of all the
objects and their properties that exist on the original layer.

To duplicate a layer:
1. In either the Layers Directory or the Object Directory, right-click on the layer you want to
duplicate and select Duplicate.
or

© 2001–2017 Legion International Ltd 213

Legion SpaceWorks R6.5.0 User Guide

◊ Select the layer you want to copy and click on the Duplicate icon . Click Yes to con-
firm.
The new layer is created, named and added to the list of available layers.

Cutting, copying and pasting layers

You can cut, copy and paste entire layers. When you paste a layer, it is automatically
renamed using the standard naming convention, and name clashes are avoided.
All objects that were in the layer at the time of cutting or copying are pasted too, along with
their links, filters and other object references.

To cut or copy and paste a layer:

1. In either the Layers Directory, or the Object Directory, right-click on the layer you want to
cut or copy and select either Cut or Copy.
2. Right-click in the same model or another model and select Paste.
or
Right-click within either the Layers Directory or the Object Directory and select Paste
Layer.
3. The pasted layer is automatically renamed and added to the list of available layers.

Deleting layers
You can use either the Object Directory or the Layers Directory to delete layers from your
model.

To delete a layer:
1. In either the Layers Directory or the Object Directory, right-click on the layer you want to
delete and select Delete.
or

Select the layer you want to delete and click on the Delete icon .
2. Click Yes to confirm.
The layer and its contents are removed from the model.

Moving and copying objects to other layers

You can move and copy objects to other appropriate layers within the same model. This
means you can move an Activity Object to another Activity Object Layer or a Partition Guide to
another Partition Layer.

To move or copy objects to other layers:

1. Select the object or objects you want to move or copy to another layer.
2. Right-click in the model and select either Move to Layer or Add to Layer.
3. The ‘Copy to Layer’ dialog box is displayed, providing a choice of suitable destination lay-
ers.
4. Select the appropriate layer and click OK to move or copy the original object.

Moving and copying to layers using the Command line

You can also copy and move objects to other appropriate layers within the same model by typ-
ing commands into the Command line. This process also means you can move and copy CAD
objects to other CAD Layers.

To move or copy objects to other layers using the Command line:

214
Legion SpaceWorks R6.5.0 User Guide

Do not mix Spatial Objects and CAD objects in your selection as there is no suitable layer
that can contain both types of object.
1. Type either Copy to Layer or Move to Layer into the Command Line.
The software prompts you to select object(s).
2. Select one or more objects from the workspace (including CAD if required).
3. Press Enter.
A dialog box is displayed with a choice of suitable destination layers.
4. Select the appropriate layer and click OK to move or copy the original object.

Dragging and dropping objects into other layers

You can drag objects between layers using the Object Directory. When you do this, the object
is moved rather than copied. You must expand the Object Directory structure so that all layers
are visible; a layer must also be unlocked in order to receive objects.

To drag an object to another layer:

1. Click and hold on the object’s name and drag it to the layer you want to move it to.
As you drag it over the various layers in the Object Directory, the names of those layers
that are suitable to receive the object are highlighted. Unsuitable or locked layers are not
highlighted.
2. When you have dragged the object over the required layer, release the mouse button.
3. The object has now been moved to the chosen layer.

Layer Views
You can define certain ‘views’ that contain a specified group of layers. This enables you to
quickly display a predefined selection of layers. Combined with the ability to set active Layer
Views in the Analyser's Timeline, this is a powerful way of attracting viewer's attention to par-
ticular aspects of your model (different train designs, annotations, vehicle CAD, doors, etc.).
See Setting a Layer View for further information.

To define a Layer View:

1. Click the Layer Views button .

The ‘Edit Layer View’ dialog box is displayed.
2. Click the New button and enter a name for the Layer View in the highlighted name box.
3. Tick each layer in the Properties pane that you want to appear in this particular view.
4. Click Apply or OK to save your changes.
Try creating Layer Views that contain similar types of layer, like all your Presentation CAD Lay-
ers or layers that contain all your Analysis Objects.
To switch from one Layer View to another, select a view from the drop-down list adjacent to
the Layer View icon.

Deleting, renaming and copying Layer Views

This procedure describes how to delete, rename and copy Layer Views.

To delete, rename and copy Layer Views:

1. Click the Layer View icon to display the ‘Edit Layer View’ dialog box.
2. Click on the Layer View you want to delete, rename or copy.
3. Click one of the available buttons in the top left-hand corner:

© 2001–2017 Legion International Ltd 215

Legion SpaceWorks R6.5.0 User Guide

◊ Delete–removes the Layer View from the list.

◊ Rename–enter the new name into the ‘Edit Name’ dialog box and click OK.
◊ Copy–adds a copy of the Layer View to the list; type a meaningful name for the copied
Layer View in the highlighted name box and press Enter.
4. Click Apply or OK to save your changes.

Loading older model files

If you open a model (‘lgm’) file that was created in a version of the Model Builder earlier than
v2.0, it is automatically upgraded to use layers in the following manner:
● All CAD is loaded into the default CAD Layer and marked as imported CAD. The Layer is
locked.
● All objects are loaded into the default Activity Object Layer.
● All Focal Drift Zones are loaded into the default Partition Layer.
Within the Legion Analyser, existing ‘ana’ files are also upgraded to use the layer scheme. All
Analysis Lines, Analysis Poly-lines and Analysis Zones are added to the default Analysis Layer.

216
Legion SpaceWorks R6.5.0 User Guide

13: Linking and Filtering

In this chapter
This part of the guide concentrates on some of the essential tasks and principles associated
with Spatial Objects’ linking and filtering. These methods define how Entities read information
from Spatial Objects and how this affects their route, the activities they engage in during a
Legion simulation and the decisions they make about choices of route.
This section covers the following topics:
● Linking
● Link operations
● Filtering

© 2001–2017 Legion International Ltd 217

Legion SpaceWorks R6.5.0 User Guide

Linking
Linking is the process of specifying a sequence of objectives (targets) that Entities may wish
to meet (visit) on their journey through a Legion model and towards their final destination.
By linking one Spatial Object (the 'origin object') to one or more 'target objects' you are trans-
lating an objective (to exit, to withdraw cash, to use a ticket gate) into alternative locations
represented by Spatial Objects (Exits, Gates, Queues, Delay Points) for fulfilling that object-
ive. You can add these links manually in the workspace and by using the Object Directory but
they can also be introduced by pasting pairs or groups of objects into a model.
You must decide on an object's linking method before creating links between objects. When
you first draw a Spatial Object, the ‘Edit <object name>’ dialog box is displayed and it is
here, on the ‘Links’ tab, that you can specify the linking method.
Although you must decide the linking method before adding links between objects, you cannot
define specific 'Percentage Weighting' values until you have created links between the origin
object and its target object or objects. In the same way, you must create new Entity Types
and Supply Types if you want to assign Entities other than the Default Entity or Supply Type as
part of your links.
Spatial Objects that can be the origins of links are:
● Entrances
● Populated Zones
● Evacuation Zones
● Level Entrances
● Delay Points
● Queues (to Delay Points only)
● Queue Groups
● Direction Modifiers
● Focal Nodes
● Stairs
● Escalators
● Gates (IN and OUT)
Spatial Objects that can be linked to are:
● Focal nodes
● Delay points
● Waiting Zones (can also filter)
● Queues,
● Queue Groups,
● Level Exits (can also filter)
● Stairs (can also filter)
● Escalators (can also filter)
● Gates (IN and OUT)
● Mesoscopic Transit Zone
● Exits

218
Legion SpaceWorks R6.5.0 User Guide

Linking methods
The four linking methods you can select for Spatial Objects are outlined below. There are
subtle variations when it comes to Queues and Queue Groups.

When linking to or from Gate objects, note that a 'Switch' Gate (one capable of switching
through the simulation from operating as an IN Gate to an OUT Gate and back) will require
you to choose the IN or OUT Gate Side when linking to or from it.

Link by Percentage Weighting

This is the default option for each Spatial Object. It assigns a specified percentage of Entities
leaving an object to the respective targets that the object is linked to. You can set the per-
centage weighting of Entities using each of the links from the origin object to the target object
or objects. If you have an Entrance linked to both an Exit and a Queue, you can specify that
70% percentage of Entities using the Entrance head towards the Exit and 30% head towards
the Queue.

You can set percentages as fractions up to three decimal places, e.g. 70.258%.
This method is preferable when your demand information is of the form: ‘about 70% of people
arriving at the station have a travel card, whereas the remaining 30% purchase a ticket’.
The following procedure assumes that, for the Spatial Object you are linking from, you have
selected Link by Percentage Weighting and also linked the object to the relevant target
objects. See Linking for further information.

Percentages are not exact. For example, 70% is interpreted as ‘around 70%’, in order to
avoid contrived patterns of Entity activity. The larger the percentage figure, the smaller
the difference between defined and actual percentage weighting.

To link by Percentage Weighting:

1. Ensure the ‘Edit <object>’ dialog box is displayed.
2. Click on the Links tab. A chart is displayed in the dialog box, featuring a list of available
target objects and a series of columns indicating percentage weighting:
3. To define the number of Entities you want to assign to each target, click on the name of
each target and drag your cursor to the right.
Notice the horizontal percentage bar which indicates the percentage of Entities you are
assigning to the target object. The Entrance illustrated is linked to four target objects.

© 2001–2017 Legion International Ltd 219

Legion SpaceWorks R6.5.0 User Guide

If you are aiming to reproduce these percentage weightings closely, then you should go to
step 6. Otherwise, consider inputting appropriate values in steps 4 and 5 depending on the
people in your simulation and their familiarity (or lack thereof ) with the site.
4. Enter a value for the '% of people consider congestion' ahead.
This percentage defines the proportion of Entities that will seek to avoid excessive con-
gestion if or when it arises. ‘Congestion avoiders’ periodically re-evaluate their choice of
target and may switch to a target which is not necessarily the one to which they were ori-
ginally assigned.
5. Enter a value for the '% of people follow the majority'.
This percentage defines the proportion of Entities that, owing to lack of familiarity , will
seek to follow major flows in the hope that the ‘safety in numbers’ principle will apply and
help them to reach their destination. Again, by doing so, ‘followers’ may switch to a target
which is not necessarily the one they were originally assigned.
6. If you want Entities to consider whether a target object is available or not (according to its
Availability Profile), check the box labelled 'Use Target Availability'.This means that Entit-
ies will be reassigned to other available targets in the same percentages, if one of their tar-
gets is unavailable at the time.
If you don't want Entities to consider whether a target object is available or not, uncheck
the box labelled 'Use Target Availability'. In this case Entities will use the target as if it
were available, regardless of any Availability Profiles associated with it.

220
Legion SpaceWorks R6.5.0 User Guide

7. Click OK to save your changes.

The 'Use Target Availability' parameter functions slightly differently when Entities are
being linked to Delay Points. See A note on 'Use Target Availability' in connection with Delay
Points.

Link by Entity Type

This method assigns specific Entity Types to the links between the origin object and the target
object or objects. This linking method is preferable when you have created an Entity Type
such as ‘Staff’, where the Entities are likely to engage in a series of activities unique to their
type.
When Linking by Entity Type from an Entrance or a Populated Zone, you must associate the ori-
gin object with an Entity Supply Type first. You can do this on the first ‘Parameters’ tab of the
‘Edit <object name>’ dialog box which appears after you have drawn and placed a Spatial
Object.
To select more than the Default Supply Type, you must first create new Supply Types. For fur-
ther information, see Creating and editing Supply Types.

To link by Entity Type:

1. Ensure the ‘Edit <object>’ dialog box is displayed.
2. Click on the Links tab.
3. Select Link by Entity Type.
4. Click OK to close the dialog box.
5. Add links between the origin object and the target object or objects.
For each link you place, the ‘Link Parameters’ dialog box is displayed. The portion labelled
‘Objects’ contains details of the origin object and the target object it is linking to.
6. In the lower portion labelled ‘Linking by Entity Type’, drag and drop Entity Types you want
to assign to the linked object from the Entity Types ‘Available’ pane into the Entity Types
‘Selected’ pane.
You can also do this by using the following buttons to move the available Entity Types from
the Available pane of the dialog box to the Selected pane:
◊ To move all Entity Types into the Selected pane, click the >> button.
◊ To move a single Entity Type into the Selected pane, click on the item and click the >
button.
◊ To move all Entity Types back into the Available pane, click the << button.
◊ To move a single Entity Type back into the Available pane, click on the item and click
the < button.
7. Click OK to save your changes.

Link by Entity Choice

This method relies on Entities to choose which target in their itinerary to move to next.

To link by Entity Choice:

1. Ensure the ‘Edit <object>’ dialog box is displayed.
2. Click on the Links tab.
3. Select Link by Entity Choice.
4. Select one of the two Entity Choice Decision Methods:

© 2001–2017 Legion International Ltd 221

Legion SpaceWorks R6.5.0 User Guide

● Shortest distance–the default scheme for all origin objects except for queues. Entities
will head to the target closest to them.The choice is based on the distance between the
Entity's initial position in the origin object and the focal point of each of the target objects
(usually, the mid-point of the Focal Segment). The calculation is subject to a distance-
estimation noise term that you can specify in the ‘Model Properties’ dialog box.
● Shortest queue (when linking to a Queue Group) or Fewest occupants–this choice
scheme is only available when the target objects are Gates, Queues, Queue Groups, Delay
Points, Waiting Zones or Focal Nodes. It only routes Entities to active objects, active being
defined as follows:
◊ Gates–the Gate is visible from the area where the decision is made and the Gate is
open.
◊ Queues–the queue is visible from the area where the decision is made and (if a queue
management scheme is in place) it is open.
◊ Delay Points–the capacity has not been exceeded.
◊ Queue Groups, Waiting Zones and Focal Nodes are always active and available.
At this stage, depending on the Entities in your simulation and their familiarity (or lack
thereof) with the site being modelled, you should consider inputting appropriate values in
steps 5 and 6 You can, however skip those steps and go to 7, if you so wish.
5. Enter a value for % of people consider congestion ahead.
This percentage defines the proportion of Entities that will seek to avoid excessive con-
gestion if and when it arises. ‘Congestion avoiders’ periodically re-evaluate their choice of
target and may switch to a target which is not necessarily the nearest to their original or
current position.
6. Enter a value for % of people follow the majority.
This percentage defines the proportion of Entities that, owing to lack of familiarity, will
seek to follow major flows in the hope that the ‘safety in numbers’ principle will apply and
help them reach their destination. Again, by doing so, ‘followers’ may switch to a target
which is not necessarily the one closest to them.
7. Click OK to save your changes.

Link by Entity Choice (Queue Groups)

Linking for Queue Groups is identical to that described in Link by Entity Choice, with one small
difference. Instead of the option ‘Fewest occupants’, the ‘Queue Group Links’ tab contains the
option Shortest queue.

Link by Entity Choice (Queues)

The linking method 'Fewest Occupants’ is automatically selected when you link a Queue to a
Delay Point. No other linking choices are available and you cannot change any of the para-
meters in the ‘Link Parameters’ dialog box. See Linking a Queue to a Delay Point.

Link by Final Destination

This method links Entities to intermediate objects according to their Final Destinations (for
example, you may wish to link all Entities heading to a national rail platform to a waiting area
near an announcement board). In this case, you would link from a Direction Modifier to a Wait-
ing Zone, using ‘Link by Final Destination’ (the Platform).

To link by Final Destination:

1. Ensure the ‘Edit <object>’ dialog box is displayed.
2. Click on the Links tab.
3. Select Link by Final Destination.
4. Click OK to close the dialog box.

222
Legion SpaceWorks R6.5.0 User Guide

5. Add links between the origin object and the target object or objects.
For each link you place, the ‘Link Parameters’ dialog box is displayed. The portion labelled
‘Objects’ contains details of the origin object and the target object it is linking to.
6. In the lower portion labelled ‘Linking by Final Destination’, drag and drop destinations you
want to assign to the linked object from the Final Destinations ‘Available’ pane into the
Final Destinations ‘Selected’ pane.
You can also do this by using the following buttons to move the available destinations from
the Available pane of the dialog box to the Selected pane:
◊ To move all Entity Types into the Selected pane, click the >> button.
◊ To move a single Entity Type into the Selected pane, click on the item and click the >
button.
◊ To move all Entity Types back into the Available pane, click the << button.
◊ To move a single Entity Type back into the Available pane, click on the item and click
the < button.
7. Click OK to save your changes.

© 2001–2017 Legion International Ltd 223

Legion SpaceWorks R6.5.0 User Guide

Link operations
You can add, edit, delete and copy links between origin objects and target objects. In the case
of Linking by Percentage Weighting, these links must be established before you can define the
specific percentages of Entities you want to assign to target objects.
The following procedure assumes that you have drawn and placed all the relevant Spatial
Objects and have selected the appropriate linking method. If you need more information,
please see Drawing and placing Spatial Objects.

Adding a link
Links are always created in the direction of travel: origin object first, target object second.
When you are Linking by Percentage Weighting, all links are drawn in blue, whereas when you
are Linking by Entity Type, the links appear in the various colours of the Entity Types.

To add a link between objects:

1. Right-click on the origin object and select Add/Edit Link.
If there is more than one origin object in the area where you click, a submenu similar to
the one illustrated appears from which you can select the correct object:

If there are more than 10 objects in this submenu, select More to see the full list.
2. Move your cursor over the target object that you want to link to.
Notice that your cursor is now dragging a coloured line, which indicates the new link you
are creating.
3. Click within the area of the object you are linking to.
If there is more than one target object in the area where you click a submenu appears
from which you can select the correct object.
When you have clicked the correct object, the ‘Link Parameters’ dialog box is displayed.
This dialog box differs according to the linking method you have selected for the origin
object. In the case of Gates, ensure that you select the correct Gate Side (IN or OUT), as
illustrated below. A Gate may have a unique name but two 'sides' if is a 'Switch' Gate.

4. Complete the ‘Link Parameters’ dialog box in one of the following ways:
◊ If you are Linking by Percentage Weighting, enter the percentage of Entities you want
to assign in the Percentage box.

224
Legion SpaceWorks R6.5.0 User Guide

◊ If you are Linking by Entity Type, select or de-select the Entity Types you want to
assign to the each target object by using the following buttons to move the available
Entity Types from the Available pane of the dialog box to the Selected pane:
To move all Entity Types into the Selected pane, click the >> button.
To move a single Entity Type into the Selected pane, click on the item and click the >
button.
To move all Entity Types back into the Available pane, click the << button.
To move a single Entity Type back into the Available pane, click on the item and click
the < button.
5. Click OK.

Adding several links at once

You can also add several links from ‘Edit <object>’ dialog boxes, rather than adding them one
by one in the workspace.

To add several links:

1. Open the ‘Edit <object>’ dialog box of any Spatial Object that you can link from.
2. Click on the Links tab and ensure you have selected the appropriate linking method.
3. Click the Add Link button.
The ‘Select Target Objects’ dialog box is displayed, with a tree listing all objects that are
available for linking to.
When you have clicked the correct object, the ‘Link Parameters’ dialog box is displayed.
This dialog box differs according to the linking method you have selected for the origin
object.
In the case of Gates, ensure that you select the correct Gate Side (IN or OUT), as illus-
trated below. A Gate may have a unique name but two 'sides' if it is a 'Switch' Gate.

4. Select one or more target objects from the tree structure and click OK.
5. Adjust link parameters according to the method selected:
◊ Link by percentage weighting–adjust percentages per target as described in Linking
methods.

© 2001–2017 Legion International Ltd 225

Legion SpaceWorks R6.5.0 User Guide

◊ Link by entity type–you will need to select a different Entity Type for each target selec-
ted as described in Linking methods.
◊ Link by entity choice–edit as described in Linking methods.
6. Click OK to save your settings.

Editing a link
At any point, you may change the Percentage Weighting of a link or the Entity Types it is
assigning to the target object.

To edit an existing link:

1. Right-click on the origin object and select Add/Edit Link.
A red line appears, linked to the centre of the object and to the cursor.
2. Move your cursor over the target object and click.
The ‘Link Parameters’ dialog box is displayed.
3. Depending on the linking method of the origin object, change either the Percentage value
or selected Entity Types.
4. Click OK.

Deleting links
There are two methods for deleting links; the second method below enables you to delete
more than one link at a time.
If Linking by Percentage Weighting is the active linking method of the origin object, deleting a
link will reduce the total percentage to below 100%. As a result, you must either create addi-
tional links or increase the percentage weighting of the remaining links to 100%

To delete a link:
1. Right-click on the origin object and select Delete Link.
2. Move your cursor over the target object and click. The link disappears.
or
3. Open the origin object’s ‘Edit <name>’ dialog box and click on the Links tab.
4. Click the Delete Link button.
The ‘Select Target Objects’ dialog box is displayed, with a tree listing all objects which are
currently linked to.
5. Select one or more target objects from the tree structure and click OK.
6. The link or links are removed.
7. Click OK to confirm.

Copying links from another object

You can quickly copy all the links and linking information from an existing Spatial Object to a
new object by following this procedure.

To copy links from another object:

1. Create or select the Spatial Object (origin object) that you want to copy links into.
2. Display this object’s ‘Edit <object name>’ dialog box.
3. Click on the Links tab.
4. In the lower pane called Copy Links from Existing Object, click the Select Object button.
The ‘Select objects to copy from’ dialog box is displayed.

226
Legion SpaceWorks R6.5.0 User Guide

Using the directory structure, highlight the object whose links you want to copy.

In the case of Gates, ensure that you select the correct Gate Side (IN or OUT). A Gate may
have a unique name but two 'sides' if it is a 'Switch' Gate.
5. Click OK to copy the links into the origin object.

This action will override the origin object’s existing linking method and replace any exist-
ing links.
When copying groups of objects within the same model or across to a different model, links
between pasted objects replicate links between copied objects. This provides a handy method
of modelling multiple level buildings by creating the logic for one floor and then generating the
models for the additional floors through copying and pasting.

Copying links to another object

You can quickly copy the links belonging to one object to another object or objects. For
example, you may have placed several new Entrances and would like them to have the same
links to targets as an existing Entrance. In this case you could quickly copy the original
Entrance’s links to all the new Entrances.

This action will override receiving objects’ existing linking methods and replace any exist-
ing links.

To copy links to other objects:

1. Open the ‘Edit <name>’ dialog box of an object that can take links.
2. Click on the ‘Links’ tab.
3. Click the Copy to button.
The ‘Select objects to copy links to’ dialog box is displayed.

© 2001–2017 Legion International Ltd 227

Legion SpaceWorks R6.5.0 User Guide

Using the directory structure, highlight the object or objects to which you want to copy the
original object’s links.

In the case of Gates, ensure that you select the correct Gate Side (IN or OUT). A Gate may
have a unique name but two 'sides' if it is a 'Switch' Gate.
4. Click OK to copy the links to the selected object or objects.

‘Stealing' links
You can ‘steal’ pre-existing links from one object and move them all to another object (this
removes the links entirely from the object from which they are stolen). This can be useful in
situations where linking conditions change or new objects are introduced into a route that has
already been set up.
Throughout the following procedure, error messages will be displayed should you accidentally
select invalid objects.

In the case of Gates, ensure that you select the correct Gate Side (IN or OUT) when select-
ing objects. A Gate may have a unique name but two 'sides' if it is a 'Switch' Gate.

Stealing Links from an Object:

1. Right-click on the object that requires the links (let’s call this ‘object X’) and select Steal
Links.
You are prompted to ‘Choose the object to steal links from’.
2. Select the object containing the desired links (‘object Y’).
You are prompted to ‘Steal links from all or selected originating objects? ([A]/S)’
3. To steal all the links, type A and press Enter.
All the links are added to ‘object X’ and removed from ‘object Y’.
4. If you would rather select a limited number of links:
◊ Type S and press Enter.
◊ Select the object(s) linking to ‘object Y’: it is their links to ‘object Y’ that will be added
to ‘object X’.
◊ Press Enter.
The links from the selected object(s) are added to ‘object X’.

228
Legion SpaceWorks R6.5.0 User Guide

Inspecting links
This feature enables you to visually trace and audit a series of object links within a model. As
well as helping you to understand the logic of a model, the Inspect Links feature can also warn
you about possible issues and errors in your model. Hovering your cursor over a link reveals
further information about the link in the form of a ToolTip.
This procedure assumes that you have a model with links open in the Model Builder.

To inspect links:

1. Click or select Objects > Inspect Links.

In the workspace, all CAD and model objects are 'dimmed' so that objects, when selected,
stand out more clearly.
2. Locate the object whose links you want to inspect and left-click to select it. Feel free to
pan and zoom as normal at any point within this procedure.
3. The object will be highlighted and existing link markers will be displayed. The following
screenshot shows a metro carriage linked to a platform's Focal Node.

4. For more information about a link, hover your cursor over any part of the link marker to
display a ToolTip.

5. If you would like to add more objects to the link sequence you are inspecting, hold down
Ctrl and left-click on the next object. It will be highlighted along with the original object.

You can also click on any other object in the model without holding down Ctrl: this will
deselect your first (or previously selected) object(s) and highlight the new object.
6. Continue to select objects and inspect links until you are satisfied.
7. To exit the process, hit the Esc key at any point.

Object link statuses

The Inspect Links tool can highlight problems with objects and their links. When you select an
object, there are four possible status icons that may be displayed:

© 2001–2017 Legion International Ltd 229

Legion SpaceWorks R6.5.0 User Guide

● Green tick means that the object's links are correctly configured.

● Amber warning means that the object's links contain problems that would cause a QA
warning (for example, linking is my Entity Choice but there is only one target selected).

● Red warning means that the object contains an error that will cause a QA warning (for
example, percentage allocation of Entities not equalling 100%).

● Revert to Final Destination means that Entities will do so when leaving this object.

230
Legion SpaceWorks R6.5.0 User Guide

Filtering
There are certain objects that enable you to filter for Entities according to type, activity or
goal. This means you can control precisely which Entities are affected by an object.
The following objects can filter:
● Direction Modifiers
● Evacuation Zones
● Level Exits (when in filter rather than target mode)
● Waiting Zones (when in filter rather than target mode)
● Drift Zones
● Focal Drift Zones
● Route Guides
● Stairs
● Escalators
● Multipath Zones
During a Legion simulation, whenever Entities encounter this kind of object, filter settings
determine which Entities are affected. For example, a Direction Modifier might redirect Entit-
ies that match its filtering criteria from a Waiting Zone to a train platform. A Route Guide
might prevent passengers from entering space reserved for staff by applying a filter to
exclude all Entity Types except for staff. The filtering criteria are very precise and flexible.
In SpaceWorks you can define ‘advanced filters’ in spatial objects in the same way you can
define them for Analyses in the Analyser. See 22: Advanced Filtering for more information.

Specifying filter settings

Objects that filter have a tabbed page on their ‘Edit <object name>’ dialog box called ‘Entity
Filters’, where you can specify filtering settings.

Filtering objects automatically filter for 'All' Entities until you change their settings.
The following procedure assumes that you have drawn and placed the object whose filter set-
tings you want to specify. It deals with 'Standard' filter settings; 'Advanced' filter settings are
covered in 22: Advanced Filtering.

To specify filter settings:

1. Right-click on the object and select Edit Properties.
The ‘Edit <object name>’ dialog box is displayed (in this example, it is the ‘Edit Direction
Modifier’ dialog box.
2. Click on the Entity Filter tab.
3. If you have already created Named Filters, which you would like to use, select the 'Named
Filter' option and choose a filter from the drop-down list. You can now click OK to finish
and save your filter settings. If you do not have any Named Filters, either create them as
described in Creating Named Filters, or continue from step 4.
4. From the drop-down list labelled ‘Filtering Method’, select one of the three options:
◊ All–all Entities in the model will be affected (click OK)
◊ None–no Entities in the model will be affected (click OK)
◊ Selected attributes–you can now define precise filtering criteria

© 2001–2017 Legion International Ltd 231

Legion SpaceWorks R6.5.0 User Guide

5. If you chose the third option above, select attributes from the five categories of ‘Activity’,
‘Entity Type’, ‘Final Destination’, ‘Origin’ and 'Target'.
6. To do this, expand the tree of ‘available’ attributes as you need and move them into the
‘selected’ pane using the > and >> buttons (to remove selected attributes, use < and
<<).

If you selected 'Target' and wish to choose a Gate object, ensure that you select the cor-
rect Gate Side (IN or OUT). A Gate may have a unique name but two 'sides' if it is a
'Switch' Gate.
7. From the drop-down list labelled ‘Logic method’, select one of the following:
◊ AND–only Entities with every selected attribute will be affected
◊ OR–Entities with any of the selected attributes will be affected
8. If you wish to exclude your selected attributes from the filter, you can do so by clicking
on the tick above your criteria labelled ‘All selected’ to change it to ‘All EXCEPT’.
This enables you to specify which attributes are excluded from the filter, which can speed
up your work if you have far more attributes to include than exclude. It also helps to keep
information about the logic of the object brief and easy to understand. This illustrated
example filters for all Entity Types except for the type named ‘Staff’.

232
Legion SpaceWorks R6.5.0 User Guide

9. Click OK to save the filter settings.

Creating Named Filters

You can create, name, save and reuse filter settings, which speeds up the task of setting up
Activity Objects. When defining the filter in an object or analysis, you will be able to choose a
Named Filter from a drop-down list.

It is best to create Named Filters only when your model is reasonably complex and con-
tains Activity Objects, Entities, and Entity Supplies.

To create a Named Filter:

1. Click or select Data > Filters. The ‘Edit Filter’ dialog box is displayed.
2. Click the New button in the top left-hand corner. The 'Filter' tab is populated.

© 2001–2017 Legion International Ltd 233

Legion SpaceWorks R6.5.0 User Guide

3. Set up your filter settings as described from step 3 of Specifying filter settings.
4. If you want to set advanced filters, click on the Advanced button and follow the steps as
described in Entering advanced filters.
5. Click Apply to save this Named Filter. You can now select this Filter when setting the para-
meters of Activity Objects by selecting it from the 'Named Filter' drop-down list.
6. To add a new filter, repeat from step 2.
7. Click OK to save your changes and close the dialog box.

Viewing Links, Target Filters and Final Destinations

You can show or hide these relationships between objects within your model in the following
ways.

To show or hide links, filters and Final Destinations:

● To show all links between objects in your models, click or select Objects > Links.

● To show all Target Filters, click or select Objects > Target Filters.

● To show all links between origin objects and Final Destination, click or select Objects
> Final Destinations.

Specifying how Links, Target Filters and Final Destinations are drawn
You can choose how to display these links and objects by selecting from a range of different
lines, arrows and colours. You can also decide whether to resize them as you zoom in and out
of a model (scaling).

To specify how Links, Target Filters and Final Destinations appear:

234
Legion SpaceWorks R6.5.0 User Guide

1. Select Tools > Options > Links, Filters, Final Destinations.

2. For ‘Route Link Origin and Target Markers’:

◊ Check the box labelled ‘Mark origins’ (uncheck if you don’t want to display them)
◊ Select a style of line and marker square from the adjacent drop-down list.
◊ Check the box labelled ‘Scaled’ if you would like the marker to be resized as you zoom
in and out of a model.
◊ Repeat these three steps for ‘targets’.
3. For ‘Filtering Object and Target Markers’:
◊ Check the box labelled ‘Mark objects’ (uncheck if you don’t want to display them)
◊ Select a style of line and marker circle from the adjacent drop-down list.
◊ Check the box labelled ‘Scaled’ if you would like the marker to be resized as you zoom
in and out of a model.
◊ Repeat these three steps for ‘targets’.
4. For ‘Final Destination Origin and Destination Markers’:
◊ Check the box labelled ‘Mark origins’ (uncheck if you don’t want to display them)
◊ Select a style of line and marker triangle from the adjacent drop-down list.
◊ Check the box labelled ‘Scaled’ if you would like the marker to be resized as you zoom
in and out of a model.
◊ Repeat these three steps for ‘destinations’.

© 2001–2017 Legion International Ltd 235

Legion SpaceWorks R6.5.0 User Guide

14: Conditions in Models

In this chapter
This part of the guide explains the ‘Condition’ feature, which can be used with certain spatial
objects to affect Entities when predefined conditions within a model are met. These conditions
are defined by placing Analysis Objects in the model and using available metrics to set up
'Conditional' analyses for use with certain Spatial Objects.
Direction Modifiers are the most likely objects to use conditions but Focal Nodes, Queues,
Queue Groups, Exits and Delay Points can also use conditions in connection with Availability
Profiles, so that objects can be ‘switched on’ or ‘off’ when certain conditions are met.
This section covers the following topics:
● About Conditions
● Setting up Conditions
● Restrictions

236
Legion SpaceWorks R6.5.0 User Guide

About Conditions
Using conditions is a powerful method for modelling situations where certain pre-defined cri-
teria may prompt operational interventions or cause pedestrians to make certain kinds of
decisions.
Such criteria might include things like a combination of occupancy, density, speed or other
pedestrian experience metrics. For example, you may wish to model opening a new exit route
when a certain level of density is reached for Entities travelling towards a particular Final
Destination. If you are using Environment Maps based on FDS output files, you can also create
conditions relating to temperature, visibility and toxicity.
In Legion SpaceWorks, the Spatial Objects that can make use of Conditions to influence the
movement of Entities are: Direction Modifiers, Focal Nodes, Queues, Queue Groups, Exits and
Delay Points.
In order for these objects to have any conditions to use, you must first place Analysis Objects
(Zones, Lines or Poly-lines) in your model and set up Analyses. Conditions can then be defined
using the standard logical expressions (=, <, >, AND, OR, NOT).
To help you better understand Conditions, familiarise yourself with About Analysis Objects,
Setting up analyses and Setting Direction Modifier parameters.

© 2001–2017 Legion International Ltd 237

Legion SpaceWorks R6.5.0 User Guide

Setting up Conditions
Before setting up Conditions, you need to plan ahead and articulate precisely the operational
measure(s) you want to model. This will help you specify the analyses whose results will be
part of the condition or conditions you select. Depending on the conditions you need to set up,
you may have to use a combination of Analyses Objects, Environment Maps and Analyses
(Environment Maps handle fire metrics, such as temperature, visibility and so on).

Analysis Objects and Analyses use the same icons and interface as described in About ana-
lyses.
An example of an operational measure might be: ‘If visibility in a corridor falls below a cer-
tain threshold during an evacuation, the corridor's Exit should be closed'. This can be achieved
by using an Environment Map, Analysis Zone, and an Exit with conditional availability.
In order to use the Visibility metric, you need a slice file produced in FDS (Fire Dynamics Sim-
ulator) software (see Exporting a model for use with FDS). This slice file must then be asso-
ciated with an Environment Map (see Environment Maps ). Next you need to place the
appropriate Analysis Objects in the relevant areas of the model.
For further information about Analysis Objects and how to use them, see About Analysis
Objects and the rest of that section. All such Analysis Objects are stored on the Model
Builder’s Conditions Layer and all Analyses appear on the ‘Data’ tab of the Object Directory.
Once you have placed your Analysis Objects, you need to set up one or more Analyses. For
full instructions on setting up Analyses, see Setting up analyses. If you don't set up Analyses,
your Conditions tab won't contain any metrics for you to use.
The following procedure assumes that you have set up at least one analysis and have also
placed the object, a Direction Modifier for example, that will use the Conditions. This pro-
cedure explains how to set up a condition of visibility falling below 2 metres in a particular
zone. Available metrics depend on the kind of analyses you have set up.

Any errors in the syntax of your conditional statements will be highlighted. There are
example statements on the ‘Conditions’ tab as a guide.

To set up a Condition:
1. Complete steps 1 to 5 of Setting Direction Modifier parameters.
2. To use conditions, check the box labelled use condition. This makes the ‘Conditions’ tab
and the associated ‘Restrictions’ available.
3. If you chose Event Profile or Availability Profile from the Time Scope list, select an option
from the left-hand drop-down list:
◊ AND–the condition will apply only when the Scope settings and the conditional settings
are both ‘true’.
◊ OR–the condition will apply when either the Scope settings or the conditional settings
are ‘true’.
4. Click on the Condition tab.
5. If you have already created Condition Objects, which you would like to use, select the
'Condition Object' option and choose a condition from the drop-down list. You can now
click OK to finish and save your condition settings. If you do not have any Condition
Objects, either create them as described in Creating Condition Objects, or continue from
step 6.
6. To add a condition, select a metric from the drop-down list (in this example, Visibility )
and click the Add button. This places the metric into the space below the dialog box.

238
Legion SpaceWorks R6.5.0 User Guide

7. Add a condition to the end of the metric, for example < 2.00, so that it reads Analysis
#001::Visibility Map::Area <2.00
8. Place square brackets around the condition (these are essential for the condition to be
accepted).

9. To add a further condition, type And and press Enter.

10. Select a metric from the drop-down list and click the Add button.
11. Add a condition to the end of the metric as required and as with all conditions, ensure
that it is enclosed in square brackets.
12. If you want to apply restriction to these conditions, click on the Parameters tab and fol-
low the instructions in Restrictions.
Otherwise, click OK to confirm and save these settings.

If you want to quickly identify any Analyses used by Conditions, type the command list-
conditionalanalyses.

© 2001–2017 Legion International Ltd 239

Legion SpaceWorks R6.5.0 User Guide

Restrictions
When you have set up your Conditions, you can fine-tune their impact by setting the following
time restrictions (in seconds) on any event occurring as a result of the criteria being met.
These restrictions are best explained in the context of pedestrian-activated traffic signals at a
crossing:
● Time before action–a built-in minimum delay between the condition being met (e.g. the
button being pushed) and the action (signals changing to red for cars and green for ped-
estrians) taking effect.
● Minimum activity period–enter a minimum period for any resulting activity (e.g. when
lights do change to green, a minimum ‘walk’ period applies which allows a number of ped-
estrians to cross safely).
● Maximum activity period–enter a maximum period for the resulting activity. In our
traffic signals example, this value would be set to equal the minimum activity period if the
lights operated on a fixed-walk cycle.
● Minimum time between Actions–enter the minimum time to leave before the action is
repeated again. In our example, if the lights have just changed from green to red, they
will not change back to green for a while, even if the button has been pressed.

240
Legion SpaceWorks R6.5.0 User Guide

Creating Condition Objects

You can create, name, save and reuse conditions, which speeds up the task of setting up Activ-
ity Objects. When defining the condition for an object, you will be able to choose a Condition
Object from a drop-down list.

It is best to create Condition Objects only when your model is reasonably complex and con-
tains objects, Entities, Entity Supplies, and Analyses.

To create a Condition Object:

1. Click or select Data > Conditions. The ‘Edit Conditions’ dialog box is displayed.
2. Click the New button in the top left-hand corner. The 'Condition' tab is populated.

3. Set up a Condition as described in steps 5 to 10 of To set up a Condition:.

4. To save the Condition, click Apply.
5. To add a new Condition Object, repeat from step 2.
6. Click OK to save your changes and close the dialog box.

© 2001–2017 Legion International Ltd 241

Legion SpaceWorks R6.5.0 User Guide

Exporting Conditions
Rather than setting up all Conditions on an object-by-object basis within the Model Builder,
you can export a list of objects and add their conditions manually in one place: a single 'csv'
file. To do so, you first need to draw your Spatial Objects and make sure they have the 'use
condition' parameter checked. Then you can export the objects and work on them separately.

If some objects already have Conditions, these will be exported as well.

To export Conditions:
1. Select Data > Export Conditions or type exportconditions .
A Windows 'Save As' dialog is displayed.
2. Select a location to save the exported file to.
3. Click Save.
You can now open the exported file using a spreadsheet programme. All your model's objects
and any pre-existing Conditions will be exported.
You can now add conditions to this spreadsheet and import the file back into the Model Builder
(see Importing Conditions).

It is easier to check the validity of your Conditions by referring to an exported list rather
than editing objects one by one.

242
Legion SpaceWorks R6.5.0 User Guide

Importing Conditions
When you want to import a 'csv' file of Conditions into your model, follow this procedure. This
is usually done when Conditions have been added to one central file rather than created on an
object-by-object basis. See Exporting Conditions for more information.

To import Conditions:
1. Select Data > Import Conditions, or type importconditions
2. Locate the file you wish to import.
3. Click Open.
The Conditions are imported into the model; if any objects are missing or have been removed,
their Conditions will be ignored and not imported. To check that the import has been suc-
cessful, run a QA or edit specific objects and check their 'Conditions' tab.

© 2001–2017 Legion International Ltd 243

Legion SpaceWorks R6.5.0 User Guide

15: Spatial Objects–in Detail

In this chapter
11: Spatial Objects–Basics covered object types, how to draw and place objects, and touched
on the process of setting object parameters.
This part of the guide discusses the parameters that make each Spatial Object unique and
enable it to carry out its intended function. The common aspects, such as naming, filtering and
linking will not be explained again here and it is assumed that you are comfortable with these
procedures.
This section covers the following topics:
● About Spatial Object parameters
● Comprehensive guide to Spatial Objects

244
Legion SpaceWorks R6.5.0 User Guide

About Spatial Object parameters

As mentioned in the section Setting the parameters of Spatial Objects, each Spatial Object has
an associated dialog box called ‘Edit <object type> <object name>’ (e.g. Edit Direction Modi-
fier 'DM IN Gate'). This is where you define all the parameters that make the Spatial Object
functional.
This dialog box always contains an initial tabbed page called ‘Parameters’, where you can
name the object and, in the case of Entrances, Populated Zones and Evacuation Zones, set up,
edit or delete Demand Lines. Demand Lines display, and enable you to define, one or more
combinations of Entity/Supply Types, Profiles, Populations and Final Destinations.

A Demand Line can contain more than one Final Destination and different Demand Lines
can share Final Destinations. Assignment of Entities to Final Destinations can only be done
using percentage weighting or by Entity Choice > Shortest Distance
Delay Points, Drift Zones, Evacuation Zones, Level Exits and Waiting Zones have an extra tab
named 'Additional Parameters' where you can specify more specialised types of Entity move-
ment and behaviour. See the relevant sections of this guide for more information about these
particular objects.
All objects except for Entrances, Populated Zones and Evacuation Zones have an ‘Availability’
tab and a ‘Conditions’ tab. See Availability Profiles and About Conditions for more information.
Some objects also have a ‘Links’ tab or an ‘Entity Filters’ tab and two objects–Delay Points
and Waiting Zones–have a ‘Focal Distribution’ tab. All objects which are capable of being used
as targets for Entities also have a tab labelled 'Target Parameters.'
Most procedures in this part of the guide assume that you have correctly drawn and placed the
Spatial Objects in question (including Focal Segments where necessary) and have displayed
the ‘Edit <object name>’ dialog box either at the time of drawing or after selecting Edit Prop-
erties.
If you need a recap on these procedures, please see Drawing and placing Spatial Objects, Pla-
cing a Focal Segment and Selecting Spatial Objects.
The objects Delay Points, Escalators, Focal Nodes, Gates, Mesoscopic Transit Zones and Stairs
have a parameter that enables you to limit the maximum flow of pedestrians using them. This
can be useful when you need to test your model against strict regulatory requirements for
flow rates on stairs and escalators, or through gates and so on. It appears on the main 'Para-
meters' tab and is labelled 'Flow Rate Limiting. To set a maximum flow rate, check the box
Maximum and enter a value for people/minute in the adjacent box.
Some objects are more complex than others and for this reason Delay Points, Direction Modi-
fiers, Queues, Queue Groups, Waiting Zones and Focal Drift Zones have special instructions
for defining their parameters and in some cases placing certain physical features of the
object.

© 2001–2017 Legion International Ltd 245

Legion SpaceWorks R6.5.0 User Guide

Comprehensive guide to Spatial Objects

Entrances
Entrances allow Entities to enter a Legion SpaceWorks model. They introduce particular num-
bers of Entity or Supply Types over time according to one or more Arrival Profiles.

Entrances may be used within models to represent arriving trains, trams, buses, aero-
planes, etc.
Non-vehicular Entrances perform best when they are narrow (about 0.5m) in the direction
Entities are travelling in. Drawing Entrances at this depth prevents Entities from stacking up
behind each other, as 0.5m will only introduce (or ‘seed’) one Entity per time-step. This
means you will avoid the problem of fast moving Entities getting blocked behind slower ones.
Entrances must also be placed at least 20cm clear of any walls in order to accommodate the
proper seeding of Entities.

For Entrances, the simulator keeps a count of the Entities that failed to enter in any time-
step and tries to introduce them in a subsequent time-step.
Placing Entrances and Exits in high-density areas with bi-directional flow should be avoided:
models should be extended out to non-bottleneck areas whose exclusion will not affect sim-
ulation outputs. If you are forced to deviate from this guideline, then Entrances and Exits
should not overlap and the depth of Entrances should be kept to a minimum, 1-10cm being a
good guide.

Setting Entrance parameters

This procedure assumes that the ‘Edit Entrance <name>’ dialog box is open.

To set Entrance parameters:

1. Enter a name, or choose a name from the drop-down list of imported pending objects, in
the 'Name' box.
2. To add a Demand Line (or Lines), click the New button once for each Demand Line you
need.
3. For each Demand Line:
◊ Double-click in the ‘Entity/Supply Type’ column and select from the available list.
◊ Double-click in the ‘Profile’ column and select from the available list.
◊ Double-click in the ‘Final Destinations’ column (optional; you can assign links manually
as well). If you don't want to add a Final Destination, proceed to step 9).
The ‘Final Destinations’ dialog box is displayed.
4. Select one ‘Assignment Method’ from:
◊ Assign by percentage weighting
◊ Assign by entity choice: shortest distance
5. To add Final Destinations, click Add destination.
The ‘Select final destinations’ dialog box is displayed.
6. Expand the object trees within the dialog box and select one or more destinations (press
and hold the ‘Ctrl’ key while clicking to select more than one).
7. Click OK to add the destination(s).
8. If you want to distribute Entities evenly across your destinations, click Uniform Dis-
tribution.

246
Legion SpaceWorks R6.5.0 User Guide

If you want to input the distribution manually, click next to each destination name and
drag the distribution bar to set the percentage (they must equal 100%).

9. Click OK to return to the main parameters tab.

10. In the 'Link Properties' area, select one of these options:
◊ Do not change target
◊ Use final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
11. Click OK to save the parameters.

Exits
Exits enable Entities to leave your model. Unless you associate the Exit with an Exit Profile, it
will assume there is enough space ‘outside’ for all Entities to leave as soon as they reach the
Exit.

Exits may also be used within models to represent departing trains.

An Exit Profile limits the number of people able to leave per minute. This is useful if the space
outside your model acts as a potential capacity constraint. For instance, you might use an Exit
Profile when you know that Entities are leaving the model to enter a narrow corridor or train
carriage (see Exit Profiles for more information).
An Exit can be just 20cm deep (in model scale) provided that no obstacle which an Entity
might perceive (and alter its behaviour as a result) lies behind it. Otherwise, its depth needs
to be 5m.

© 2001–2017 Legion International Ltd 247

Legion SpaceWorks R6.5.0 User Guide

You can also associate an Availability Profile with an Exit (see Availability Profiles for further
information).

Setting Exit parameters

This procedure assumes the 'Edit Exit <name>' dialog box is open.

To set Exit parameters:

1. Enter a name, or choose a name from the drop-down list of imported pending objects, in
the 'Name' box.
2. If the Exit doesn’t require an Exit Profile, go to step 4.
3. To associate the Exit with an Exit Profile, check the box labelled Use exit profile and
select a profile from the adjacent drop-down list. For more information, see Exit Profiles.
4. If you want to link the Exit to an Availability Profile, click on the ‘Availability’ tab.
5. Select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 11.
6. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
7. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
The OR option is useful in cases where, for example, you may wish to allow a higher num-
ber of Entities out of an exit when an unforeseeable instance of high density occurs at a
time not covered by the Availability Profile.
8. Set up your condition as described from step 4 of To set up a Condition:.
9. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
10. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment.
11. Click OK to save the parameters.

Exit Profiles
Exit Profiles work with Exits to limit (by means of a ‘Cap rate’) the flow of Entities leaving a
model. An Exit Profile can be linked to several Exits and, like a Delay Profile, it can contain
several intervals over time which have different Cap rates or none at all (a rate of zero will
prevent any Entities from leaving).
The following procedure describes how to set up an Exit Profile that could be used with an Exit
representing people entering a regulated-flow area just outside your model. This scenario
could involve security controls and stadium ingress trains leaving from a platform every three
minutes and taking one minute for passengers to board.

248
Legion SpaceWorks R6.5.0 User Guide

The red blocks represent periods between trains where the Exit is capped to 0, thereby pre-
venting any Entities from Exiting (entering the ‘train’). The intervals between the blocks have
no capping and therefore Entities are able to leave the Exit with no restrictions.

To create an Exit Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Exit Profile.

You can also create Exit Profiles using the new Data Template spreadsheet.
3. Click the New button in the top left-hand corner. A new ‘empty’ profile is displayed at the
top of the ‘Exit Profile’ tab.
4. Click the Add button on the right-hand side of the dialog box. A red ‘time block’ appears in
the profile, spanning the whole of the simulation time.
5. Enter a Start time of 00:01:00 and an End time of 00:04:00 in the relevant boxes.
6. Enter a Cap rate of 0.
7. Click Update to apply the settings for this period of the Exit Profile.
8. Repeat steps 4 to 7 for two further time blocks, ensuring that each block’s Start time is
one minute after the end of the previous block and that each block lasts for three minutes.
Click Apply to save this profile.
It is now available to be associated with an Exit.

To remove a time block from a profile, click on it and then click the Remove button.
You can add as many time blocks to a profile as you can fit into the running time of your sim-
ulation, with differing Cap rates as required.

© 2001–2017 Legion International Ltd 249

Legion SpaceWorks R6.5.0 User Guide

Availability Profiles
Availability Profiles enable you to turn certain spatial objects ‘on or off’ at specified times and
for specified periods within the runtime of a simulation. You can create them using the Data
Template spreadsheet template or you can create them manually in the following manner.

You can also create Availability Profiles using the new Data Template spreadsheet tem-
plate.

To create an Availability Profile:

1. Click or select Data > Data Profiles. The ‘Edit Data Profile’ dialog box is displayed.
2. From the drop-down list on the left of the dialog box, select Availability Profile.
3. Click the New button in the top left-hand corner. A new ‘empty’ profile is displayed at the
top of the ‘Availability Profile’ tab.
4. Click the Add button on the right-hand side of the dialog box. A green ‘time block’ appears
in the profile, spanning the whole of the simulation time.
5. Enter a Start time of 00:00:00 and an End time of 00:10:00 boxes. This period of 10
minutes represents the ‘ON’ period of the profile (the time when any associated object will
be available for Entities to use within a simulation).
This setting means that whichever object is associated with this profile will be available
for the first ten minutes of a simulation. Of course you can tailor this period to a specific
period with the runtime of your simulation.
6. Click the Update button to apply the ‘ON’ period. The green time block will reflect the new
period.
7. Click OK to save the Availability Profile.

Populated Zones
A Populated Zone is an area that already contains Entities (Entity or Supply Types) at the start
of a simulation. It must be sized to fit the relevant location, which may be the seating area of
a stadium or the space within a shop, etc. Entities are introduced (or ‘seeded’) randomly into
the Populated Zone at the start of a simulation.
A Populated Zone packs Entities without luggage to a maximum of 8 or 9 Entities per m 2. You
will receive a warning if your input tries to exceed 10 Entities per m2 and an error if it exceeds
15 Entities per m2.

Populated Zones with an initial population of one Entity can be as small as you like as in
this case they are exempt from warnings and errors.
Use Populated Zones wherever you need Entities to appear ‘already in the model’ at the start
of the simulation. For example, you might use them in the following instances:
● Egress modelling when, for example, Entities may start within seated areas of the model.
This can be useful for modelling the end of sporting events.
● Terminal modelling, where Populated Zones can be used along with Entrances to represent
people already in a space, for example, waiting for trains, standing in front of an inform-
ation board or en route to a destination.
Entities are directed to move away from the zone towards other destinations as soon as the
simulation starts. If you want them to remain static, you need to overlay the Populated Zone
with a Waiting Zone (the Copy Geometry tool can help you to do this; see Copying the geo-
metry of Spatial Objects).
Populated Zones only introduce Entities in the first time-step. If the space of the zone is insuf-
ficient for all Entities, those that cannot fit are discarded.

250
Legion SpaceWorks R6.5.0 User Guide

Like Entrances, Populated Zones need Demand Lines to introduce Entities into the model and
you can also assign Final Destinations to the Entities.

Setting Populated Zone parameters

This procedure assumes the ‘Edit Populated Zone <name>’ dialog box is displayed.

To set Populated Zone parameters:

1. Enter a name, or choose a name from the drop-down list of imported pending objects, in
the 'Name' box.
2. To add a Demand Line (or Lines), click the New button once for each Demand Line you
need.
3. For each Demand Line:
◊ Double-click in the ‘Entity/Supply Type’ column and select from the available list.
◊ Double-click in the ‘Population’ column and enter a number.
◊ Double-click in the ‘Final Destinations’ column (optional; you can assign links manually
as well). If you don't want to add a Final Destination, proceed to step 9).
The ‘Final Destinations’ dialog box is displayed.
4. Select one ‘Assignment Method’ from:
◊ Assign by percentage weighting
◊ Assign by entity choice: shortest distance
5. To add Final Destinations, click Add destination.
The ‘Select final destinations’ dialog box is displayed.
6. Expand the object trees within the dialog box and select one or more destinations (press
and hold the ‘Ctrl’ key to select more than one available object).
7. Click OK to add the destination(s).
8. If you want to distribute Entities evenly across your destinations, click Uniform Dis-
tribution.
If you want to input the distribution manually, click next to each destination name and
drag the distribution bar to set the percentage (they must equal 100%).

© 2001–2017 Legion International Ltd 251

Legion SpaceWorks R6.5.0 User Guide

9. Click OK to return to the main parameters tab.

10. In the 'Link Options' area, select one of these two options:
◊ Use final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
11. .
12. Click OK to save the parameters.

Evacuation Zones
These objects introduce Entities for use in evacuation simulations and they can also affect the
movements of Entities that happen to walk through them. They enable you to introduce a pop-
ulation to a model, specify the delay between the discovery of a fire and the sounding of an
alarm, and also to specify ‘pre-movement’ behaviour which complies with British Standard PD
7974-6 (this behaviour can also be customised).
Evacuation Zones are best used when you want to analyse the performance of a whole model
or a specific area of a model in terms of evacuation. Like Populated Zones, they introduce a
specified number of Entities into a model but with Evacuation Zones you can specify an alarm
time, select the Entity Type of evacuees and define pre-movement behaviour.
While the principle role of an Evacuation Zone is to introduce Entities into a model, they can
also be used as filtering objects, meaning that a Demand Line (with an initial population) is
not essential. However, in such cases you will need to adjust the 'Entity Filter' settings to
ensure that the zone affects at least some Entities.

Setting Evacuation Zone parameters

This procedure assumes the ‘Edit Evacuation Zone’ dialog box is displayed.

To set Evacuation Zone parameters:

252
Legion SpaceWorks R6.5.0 User Guide

1. Enter a name, or choose a name from the drop-down list of imported pending objects, in
the 'Name' box.
You may not need to add any Demand Lines as any Entities in the model who happen to be
in the zone at the time of the alarm will be affected.
2. To add a Demand Line (or Lines), click the New button once for each Demand Line you
need.
3. For each Demand Line:
◊ Double-click in the ‘Entity/Supply Type’ column and select from the available list.
◊ Double-click in the ‘Population’ column and enter a number.
◊ Double-click in the ‘Final Destinations’ column.
The ‘Final Destinations’ dialog box is displayed.
4. Select one ‘Assignment Method’ from:
◊ Assign by percentage weighting
◊ Assign by entity choice: shortest distance
5. To add Final Destinations, click Add destination.
The ‘Select final destinations’ dialog box is displayed.
6. Expand the object trees within the dialog box and select one or more destinations (press
and hold the ‘Ctrl’ key to select more than one available object).
7. Click OK to add the destination(s).
8. If you want to distribute Entities evenly across your destinations, click Uniform Dis-
tribution.
If you want to input the distribution manually, click next to each destination name and
drag the distribution bar to set the percentage (they must equal 100%).

© 2001–2017 Legion International Ltd 253

Legion SpaceWorks R6.5.0 User Guide

◊ Click OK to return to the main parameters tab.

9. In the 'Evacuation Options' area, enter an Alarm time in seconds (this will be the number
of seconds after the start of the simulation so, for example, if you want to simulate an
alarm three minutes into the run-time, enter 180).
10. To change all evacuees to a particular Entity Type, check Evacuating entity type and
select from the adjacent drop-down list.
11. In the 'Link Options' area, select one of these two options:
◊ Use final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
12. If you want to set (or modify) the Entity facing direction, click the 'Additional Para-
meters' tab and check the box labelled ‘Apply facing direction’.
13. Enter a value for ‘degrees’ and a margin of tolerance (of 5 or 10 degrees) in the box
labelled ‘+/- degrees’.This setting is only relevant if you intend to present your model in
Legion 3D.
14. Click on the Pre-movement tab.
15. In the drop-down list labelled Type, select either British Standard PD 7974-6 or Cus-
tom.
◊ If you select British Standard PD 7974-6, select the appropriate settings for Scen-
ario, Alertness, Familiarity, Building Type, Staff training and Alarm type.
◊ If you select Custom, enter Min, Mean and Max values in the lower portion of the
page labelled ‘Profile’.
16. Click on the Links tab and complete the link details (for further information, see Linking
methods).
17. If you want the zone to filter for certain Entities, click on the Entity Filter tab and com-
plete the Filtering parameters (for further information on filtering, see Specifying filter set-
tings).
18. Click OK to save the parameters.

Pre-movement settings
The ‘Edit Evacuation Zone’ dialog box contains a tab called ‘Pre-movement’. It includes set-
tings for six key categories of fire evacuation analysis which are contained in British Stand-
ards guidelines: Scenario, Alertness, Familiarity , Building Type , Staff training and
Alarm type.

See British Standards document PD 7974-6 for full details.

Each category contains three options which affect how evacuees respond to the alarm.

254
Legion SpaceWorks R6.5.0 User Guide

Depending on the type and scope of your evacuation analysis, select the appropriate settings
from the 'British Standard PD 7974-6' option. The ‘Pre-movement’ tab also enables you to
override these categories by selecting Custom from the list labelled Type. You can then
enter minimum, mean and maximum values (in seconds) which are used to control the dis-
persal of evacuees according to probability factors.
For example, a minimum of 30s, mean of 45s and maximum of 60s means that the first evacu-
ees to leave the zone will leave 30 seconds after the alarm; the majority will leave around the
45 second mark and the last few to leave will leave after one minute.

Evacuation Zone Summary

if your model contains one or more Evacuation Zones, you can quickly view a snapshot of
their key properties (Detection time, Alarm time and Pre-movement time).

To view an Evacuation Zone Summary:

1. Select Data > Evacuation Zone Summary.
The following dialog is displayed, displaying a list of Evacuation Zones and a colour-keyed
summary of key properties over time (Detection, Alarm, Pre-movement).

© 2001–2017 Legion International Ltd 255

Legion SpaceWorks R6.5.0 User Guide

2. Click OK to close the dialog.

Level Exits and Level Entrances

In Legion SpaceWorks, the role that Level Exits and Level Entrances played in earlier versions
has largely been incorporated by the new Stair and Escalator objects, which now handle the
movement of Entities from one level of a model to another.
However, they remain available for the modelling of lifts and in case you need to create an
ad-hoc stair or escalator if for any reason you find that the specialised objects do not fulfil
your requirements.
You must always create Level Exits and Level Entrances as pairs. First, place the Level Exit in
the area where Entities will leave one level of the site and place the Level Entrance in the cor-
responding area of the other level of the site. A Level Entrance can only receive Entities from
its paired Level Exit.
In your model, the ‘area of transfer’ between levels must be represented twice: once for the
Level Exit and once for the Level Entrance. Level Exits (and paired Level Entrances) should, if
possible, be at least 5m long in the direction of Entity travel and any obstacles that appear in a
Level Entrance must also appear in the paired Level Exit.
Obstacles directly behind Level Exits should, where possible, be removed because they are
detected by an Entity and artificially influence their approach towards the (Level) Exit.
The following example illustrates a staircase between two floors of a building (the stair has
three flights). The left-hand illustration is of the original architectural CAD plan, the right-hand
illustration is of ‘cleaned CAD’ and features a red Level Exit and a green Level Entrance.
The architectural drawing of Level 1 shows the second flight of stairs cut-off, for illustrative
purposes. The Level 2 drawing shows both the second and third flight of stairs in full: as a per-
son would see them if viewing from a great height.

256
Legion SpaceWorks R6.5.0 User Guide

The logical place to locate the Level Exit/Level Entrance pair is on the second flight of stairs
because it appears in both Level 1 and Level 2 plans. The Level 1 drawing of the second flight
will need to be extended to match the Level 2 drawing. The Level Exit and Level Entrance can
then be placed. The obstacles that appear in a Level Entrance match those in the paired Level
Exit.

Congestion
If a Level Entrance is located in an area that becomes congested, Entities will not pass through
the Level Exit until there is sufficient space for them in the Level Entrance.
Movement from a Level Exit to a Level Entrance is one-way. Once an Entity has passed from a
Level Exit into the Level Entrance, it cannot pass back into the Level Exit, even if congestion
builds up and forces Entities backwards: they will remain in the congested Level Entrance.

Showing Clones
Entities affected by a Level Exit upon their first step into its area immediately appear in the
same location inside the paired Level Entrance. This process is referred to as ‘cloning’ and it
ensures that the area occupied by Entities that have moved to a different level does not
appear to be available for other Entities to move into until the next time-step.

Setting Level Exit parameters

You can draw a Level Exit in the same way as you would a regular Exit but you will be promp-
ted to decide whether you want to use it as a target object (with a Focal Segment) or to allow
the object to filter for Entities.
Create as Target or Filtering object? [T]/F
Target is the default setting, so press Enter to create the Level Exit as a target object, or type
F and press Enter to create it as an object that filters Entities. You will need to set up slightly
different parameters depending on your choice of target of filter object.

To set Level Exit parameters:

1. Ensure the ‘Edit Level Exit’ dialog box is displayed.

© 2001–2017 Legion International Ltd 257

Legion SpaceWorks R6.5.0 User Guide

2. Enter a name for the Level Exit in the 'Name' box (or leave it as it is if you are happy with
the existing name).
3. If the Level Exit doesn’t require an Exit Profile, go to step 5.
4. To associate the Exit with an Exit Profile, check the box labelled Use exit profile and
select a profile from the adjacent drop-down list.
5. If the Level Exit is a filtering object, you can click on the 'Additional Parameters' tab and
enter a value in the box labelled 'Transition Cost'. The higher the value, the higher the per-
ceived cost of using the Level Exit to the Entity. This may assist Entities to choose other
less costly means of leaving a level, such as an escalator.
6. If appropriate, click on the Entity Filter tab and complete all filtering details (see Spe-
cifying filter settings for full instructions).
7. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment.
8. If you want to link the Exit to an Availability Profile, click on the ‘Availability’ tab and
select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 13.
9. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
10. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
The OR option is useful in cases where, for example, you may wish to allow a higher num-
ber of Entities out of an exit when an unforeseeable instance of high density occurs at a
time not covered by the Availability Profile.
11. Set up your condition as described from step 4 of To set up a Condition:.
12. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
13. Click OK to save the parameters.

Setting Level Entrance parameters

You can draw a Level Entrance in the same way as you would a regular Entrance, except you
can’t add Entity Supplies or Arrival Profiles. You are, however, required to select the Level
Exit with which it is paired.

To set Level Entrance parameters:

1. Ensure the ‘Edit Level Entrance’ dialog box is displayed.
2. Enter a name for the Level Entrance in the 'Name' box (or leave it as it is if you are happy
with the existing name).
3. Select the correct ‘paired’ Level Exit from the Level Exit drop-down menu.

258
Legion SpaceWorks R6.5.0 User Guide

4. Tick the box named Make size and shape consistent with level exit.
5. Click OK to save the parameters.

Stairs
The Stair object is flexible enough to represent one or all of the following types of stair con-
figuration, which combine flights of steps with landings where required.
● Single stair (no landing required)
● Linear multiple stair
● Dogleg stair
● 2-flight return stair
● Offset stair
● Extended dogleg stair
● 3-flight return stair

Notes about Stairs

Stair objects can act as targets or filters. When targets, Stair objects require you to define
Focal Segments. They can be set up to allow movement upwards, downwards or in both dir-
ections to match the operational conditions of the venue being modelled. When Stairs are
used to filter Entities, you need to set Up and Down filter settings.
If a Stair permits movement in the up direction, the Focal Segment is placed on the first stair
of the flight; if a Stair permits downwards movement only, then the Focal Segment is placed
on the last stair of the flight; finally, if the stair is bidirectional, Focal Segments are placed in
both positions. When you draw stairs, the software will automatically choose the location of
these Focal Segments.
Landings can be orthogonal or polygonal and flights of stairs can be drawn from any side of a
landing, which enables you to create dogleg configurations and return stairs.
The procedures below describe how to create a single Stair and a linear multiple Stair as both
Target and Filter objects. These forms of stair contain all the elements you need to construct
the remaining types.

Stairs are always drawn from bottom to top and always finish on a step, never a landing.
The basic elements of creating the different varieties of Stair are:
1. Drawing the Stair section.
2. Splitting the Stair at some point if it connects two levels across separated CAD.
3. Deciding on whether to add a landing (type y or n).
4. Drawing a landing.
5. Adding another Stair section and either completing the object or continuing with further
landings and flights.
6. Deciding whether the Stair will be a Filter or Target object (type t or f).
7. Setting Stair parameters.

Splitting a stair across separated CAD

A Stair object can be contained within one level of CAD or split across two levels. In the case
of the latter, you must split the object at the relevant point in the drawing process, then define
the ‘overlap area’ between the two split elements of the Stair, and then place the second por-
tion of the Stair in the correct location.

© 2001–2017 Legion International Ltd 259

Legion SpaceWorks R6.5.0 User Guide

The overlap area defines the location of the Level Exit/Level Entrance pair which manages the
transition of Entities from one level to another as part of the Stair object.
This illustration shows a bidirectional Stair with two landings, which is split across two levels
of CAD (the left-hand side is the lower level).

Creating a single stair (Target)

This object represents a single stair with no landing used as a Target object.

To create a single stair (Target):

1. Click or select Objects > Stair.

The minimum length a single flight of stairs can be is 0.5 metres.

2. Draw the segment that marks the beginning of the first stair, drag out the flight to the
necessary length and then:
◊ If the flight is completely contained within one level, click to complete it and go to step
5.
◊ If the flight needs to be split across two levels, hold down Ctrl and click.
You are prompted to accept the default overlap area (this will be somewhere between
the minimum 0.5 metres and the maximum 2 metres) or define your own.
3. Press Enter to accept the default overlap area.
or
Type n, press Enter and then drag the area to the desired length (minimum of 0.5m to a
maximum which cannot exceed the length of the first flight); click to set the overlap area.
4. Place the overlap area in the correct position on the second level of your CAD and continue
to draw the rest of the Stair. Click to complete the section.
5. When prompted if you wish to add a landing, type n and press Enter
6. You are prompted to Create as Target or Filtering object? [F]/T.
Type T and press Enter to create the Stair as a target object.
The ‘Edit Stair’ dialog box is displayed.
7. Enter a meaningful name for the new stair in the 'Name' box.
8. Select an 'Entity direction on stair':
◊ Up only
◊ Down only
◊ Bidirectional (default option)

260
Legion SpaceWorks R6.5.0 User Guide

9. In the 'Link Properties' area, select one of these options:

◊ Do not change target
◊ Revert to final destination (Entities will proceed to their Final Destination)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
10. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
11. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment. Which tab(s) you select depends on the direction Entit-
ies will travel in on the Stair.
12. To set Availability and possibly Condition parameters, follow the steps in Setting Avail-
ability parameters.
13. Click OK to close the ‘Edit Stair’ dialog box.

If you need to adjust Focal Segments after drawing a Stair, see Adjusting a Focal Segment
for details.

Creating a single stair (Filter)

To create a single stair (Filter):
1. Follow steps 1 to 5 in To create a single Stair (Target).
You are prompted to Create as Target or Filtering object? [F]/T.
2. Filtering is the default choice, so just press Enter to create the Stair as a filter object.
The ‘Edit Stair’ dialog box is displayed.
3. Enter a meaningful name for the new stair in the 'Name' box
4. Select an 'Entity direction on stair':
◊ Up only
◊ Down only
◊ Bidirectional (default option)
5. If you want to change the default 'Distance Factors', enter new values in the boxes
labelled:
◊ Distance Factor Up
◊ Distance Factor Down
For more information on these factors, see Distance Factors for Stairs and Escalators.
6. In the box labelled 'Link Properties', decide what Entities will do when leaving the Stair:
◊ Do not change target – Entities keep same target
◊ Revert to final destination – Entities proceed to their Final Destination
◊ Specify links – add specific links using the available 'Links from Top' and 'Links from
Bottom' tabs and by following Linking methods.

© 2001–2017 Legion International Ltd 261

Legion SpaceWorks R6.5.0 User Guide

7. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
8. Set the Stair's filter settings by clicking on 'Up Filter', 'Down Filter' (or both if it's a bid-
irectional Stair) and following the steps outlined in Specifying filter settings.
9. To set Availability and possibly Condition parameters, follow the steps in Setting Avail-
ability parameters.
10. Click OK to close the ‘Edit Stair’ dialog box.

Creating a Stair with a landing

This object represents a stair with at least one landing and two flights. This procedure
describes how to draw a stair object with two flights and one landing but when creating your
own version, you can add as many landings and flights as you need.

To create a linear multiple stair:

1. Follow steps 1 to 4 of To create a single Stair (Target).
2. When prompted if you wish to add a landing, press Enter.
3. Now drag out a landing to the required size and click to complete it.
◊ When drawing polygonal landings, use the Grid and Snaps to aid accuracy.
◊ To complete a polygonal landing, right-click and select Finish Boundary (Close);
this will automatically attach the final vertex of the landing to the appropriate point of
the flight of stairs.

Placing the final vertex manually will result in a self-intersecting landing and will generate
errors during ‘ora’ import.
4. Click on the side of the landing from which you would like to draw the next flight of stairs.
You are asked whether you wish to add a further landing.
5. To add a landing, press Enter and repeat step 4.
or
If you don’t wish to add a landing, type n and press Enter.
6. From here you need to choose whether the Stair is a Filter or Target object and follow the
steps in either To create a single Stair (Target) or To create a single Stair (Filter).

Changing the direction of Entities in a Stair object

After placing a Stair object, you can change the direction of Entities by right-clicking on the
object and selecting Edit Stair Object <name> to open up the relevant ‘Edit’ dialog box.
Changing Bidirectional to Up or Down
When changing a Bidirectional stair to either an Up or Down stair, select the appropriate
option in the ‘Edit Stair <name>’ dialog box and click OK. Remember to update any Linking
parameters that may need to be changed.
Changing Up or Down to Bidirectional
When changing a uni-directional Stair into a Bidirectional Stair, after selecting either Up or
Down, the relevant Links tabs will not be available immediately and a message will inform
you of this.
To edit the Linking parameters, you need to click OK to close the message and then close the
‘Edit Stair <name>’ dialog box. Next, reopen the ‘Edit Stair <name>’ dialog box and update
the linking parameters as required.
Changing Up to Down or vice-versa

262
Legion SpaceWorks R6.5.0 User Guide

When changing an Up stair to a Down stair or vice-versa, the procedure is slightly more
involved as there is an intermediate step which requires you to change the stairs to bid-
irectional. This procedure works for both cases.

To change an Up stair to a Down stair:

1. Open the ‘Edit Stair <name>’ dialog box.
2. Select the Bidirectional option.
A message is displayed, informing you that the downward ‘Links’ tab needs to be updated.
3. Click OK to close the message and OK again to close the dialog box.
4. Reopen the ‘Edit Stair <name>’ dialog box and select the Down option.
5. Click on the Linking from Bottom tab and set linking parameters as described in Linking
methods.
6. Click OK to save your changes.

Stairs and links

Linking
Stairs can be linked to and from in the standard Legion manner (see Linking). In the case of
bidirectional stairs contained within one level of continuous space, you will be prompted to
define whether a link is to (or from) the bottom or the top of the stair. This is because within a
single level of a model, the software does not know to which end of the object you are attach-
ing a link.
Stairs and Partition Layers
If you need to create a Partition Layer for a stair, the procedure is slightly different to that for
other objects if the stair is bidirectional. You can only create a Partition Layer from a Stair if it
is a target rather an object that filters.

To create a Partition Layer for a stair object:

1. Right-click on the stair and select Create Partition Layer with Stair Object <name>.
If the stair in question is a bidirectional stair contained within a single level, you will be
prompted to select one of these options:
◊ Routing to TOP
◊ Routing to BOTTOM
2. Click OK.

Escalators
The Escalator object represents an escalator, comprising five key sections:
● the area from the end of the balustrades to the comb line
● the flat portion of stair that leads to the lower work point
● the inclined stair (riser) that leads to the upper work point
● the flat portion of stair leading to the upper comb line
● the upper landing as far as the end of the balustrades
When placing an Escalator, you need to draw these elements in sequence. Follow the prompts
in the Output Bar.
In simulations, Entities appear to be standing still while using escalators (there is no over-
taking).

© 2001–2017 Legion International Ltd 263

Legion SpaceWorks R6.5.0 User Guide

Like Stairs, Escalator objects can act as targets or filters. When targets, Escalators
require you to define Focal Segments. They can be set up to allow movement upwards
downwards to match the operational conditions of the venue being modelled. You can also
specify if and on which side Entities stand or walk when using an Escalator. When Escal-
ators are used to filter Entities, you need to set Up and Down filter settings

Splitting an Escalator across separated CAD

Like Stairs, Escalators can be contained within one level of CAD or split across two levels. In
the case of the latter, you must split the object during the drawing process, define the ‘over-
lap area’ between the two split elements of the escalator and place the second portion of the
Escalator in the correct location.
The overlap area defines the location of the underlying Level Exit/Level Entrance pair which
manages, behind the scenes, the transfer of Entities from one level to another as part of the
Escalator object.
This photograph is labelled to show the constituent parts of an escalator that you will need to
draw when placing an Escalator object. The ‘comb line’ is the point at which the flat stair
emerges at the start of an Escalator (and disappears at the end) and the ‘work point’ is the
point at which the flat stair starts to rise.

This illustration shows a single escalator split across two levels of CAD (the left-hand side is
the lower level).

Creating an Escalator

As with the Stair object, escalators are always drawn from the bottom up.
While the flat stair and riser sections of an escalator are always rectangular, you may draw
the areas between comb lines and balustrades as polygonal sections if required.

264
Legion SpaceWorks R6.5.0 User Guide

To draw an escalator:
1. Draw the first portion of the escalator:
◊ When drawing a rectangular area, click to complete it.
◊ When drawing a polygonal area, place all the necessary vertices, press Enter to com-
plete it and then click on the side of the area from which you want to draw the flat stair
portion of the escalator.
2. Drag out the first flat stair section of the escalator to the required size and click to com-
plete it.
3. Drag the main riser section out to the desired size and:
◊ If the escalator is completely contained within one level, click to complete it and go to
step 7.
◊ If the escalator needs to be split across two levels, hold down Ctrl and click.
You are prompted to accept the default overlap area (this will be somewhere between
the minimum 0.5 metres and the maximum 2 metres) or define your own.
4. Press Enter to accept the default overlap area.
or
Type n, press Enter and then drag the area to the desired length (minimum of 0.5m to a
maximum which cannot exceed the length of the first stair section); click to set the over-
lap area.
5. Place the overlap area in the correct position on the second level of your CAD and continue
to draw the rest of the riser section of the escalator. Click to complete the section.
6. Drag out the second flat stair section of the escalator to the required size and click to com-
plete it.
7. Draw the area from the upper comb line to the end of the balustrades.
If the area is polygonal, when you have finished drawing it you are asked to select one of
its sides as the ‘entry segment’, being the segment which Entities will cross as they board
the escalator at this end. This step is necessary because, depending on the direction of the
escalator, a Focal Segment may be required at this end.
You are prompted to 'Create as Target or Filtering object? T[F]'.
8. Press Enter if you want the Escalator to be a Target or type F and press enter if you want
the Escalator to filter for Entities instead.
The ‘Edit Escalator’ dialog box is displayed.
See the following procedures for further parameters for both Target and Filter objects.

To set the Escalator’s properties (Target):

1. Enter a meaningful name for the new escalator in the 'Name' box.
2. Select a 'Direction':
◊ Up
◊ Down
According to the direction you select, the focal segment will be automatically placed at the
bottom (Up) or top (Down) of the Escalator.
3. Set 'Speed and Slope' values:
◊ Enter a value for Tangential Speed (escalator speeds generally range from 0.5m/s to
1.0m/s but check with the manufacturer).

© 2001–2017 Legion International Ltd 265

Legion SpaceWorks R6.5.0 User Guide

◊ Enter a value for Slope (escalator slopes generally range from 30° to 35° but check
with the manufacturer).
◊ Enter a value for the Distance Factor (for more information, see Distance Factors for
Stairs and Escalators).
4. In the 'Link Properties' area, select one of these three options:
◊ Do not change target (Entities will proceed to their next target unchanged).
◊ Revert to final destination (Entities will proceed to wards their original Final Destin-
ation).
◊ Specify links (if you select 'Specify link', click on the 'Links' tab and add your target
objects manually following the steps in Linking methods).
5. In the 'Escalator Walk/Stand Preference' area, select from the following options to define
how Entities ride on the escalator:
◊ Stand on the left
◊ Stand on the right
◊ Stand on both sides
◊ Walk on both sides.
6. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
7. To set Availability and possibly Condition parameters, follow the steps in Setting Avail-
ability parameters.
8. Click OK.
If you need to adjust Focal Segments after drawing an Escalator, see Adjusting a Focal Seg-
ment for details.

To set the Escalator’s properties (Filter):

1. Enter a meaningful name for the new escalator in the 'Name' box.
2. Select a 'Direction':
◊ Up
◊ Down
According to the direction you select, the focal segment will be automatically placed at the
bottom (Up) or top (Down) of the Escalator.
3. Set 'Speed and Slope' values:
◊ Enter a value for Tangential Speed (escalator speeds generally range from 0.5m/s to
1.0m/s but check with the manufacturer).
◊ Enter a value for Slope (escalator slopes generally range from 30° to 35° but check
with the manufacturer).
◊ Enter a value for the Distance Factor (for more information, see Distance Factors for
Stairs and Escalators).
4. In the 'Link Properties' area, select one of these three options:
◊ Do not change target (Entities will proceed to their next target unchanged).
◊ Revert to final destination (Entities will proceed to wards their original Final Destin-
ation).
◊ Specify links (if you select 'Specify link', click on the 'Links' tab and add your target
objects manually following the steps in Linking methods).

266
Legion SpaceWorks R6.5.0 User Guide

5. In the 'Escalator Walk/Stand Preference' area, select from the following options to define
how Entities ride on the escalator:
◊ Stand on the left.
◊ Stand on the right.
◊ Stand on both sides.
◊ Walk on both sides.
6. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
7. Set the Escalator's filter settings by clicking on Entity Filter' and following the steps out-
lined in Specifying filter settings.
8. To set Availability and possibly Condition parameters, follow the steps in Setting Avail-
ability parameters.
9. Click OK.

Linking to Escalators
Escalators can be linked to and from in the standard Legion manner (see Linking).

Distance Factors for Stairs and Escalators

Stairs and Escalators, when used as filtering objects rather than as direct targets, have a para-
meter named 'Distance Factor' and, as part of SpaceWork's auto-navigation it influences how
Entities perceive the effort required to follow particular routes and therefore how they decide
which route, terrain or vertical circulation elements to take.
Escalators have a default Distance Factor of 0.2, implying that for every metre travelled an
Entity will use only 20% of the energy they would walking one metre on flat ground. Stairs
have a Distance Factor of 1.98, implying that using the stairs requires almost twice the effort
per metre than walking on flat ground. This illustration shows how this perceived effort can
influence an Entity's choice of route.

© 2001–2017 Legion International Ltd 267

Legion SpaceWorks R6.5.0 User Guide

While the actual distance of the Stair Route is shorter than the distance of the Escalator Route,
the perceived distance in terms of effort is much longer, so the Entity will choose the Escal-
ator Route as the effort required is less even though the distance is greater.

Gates
The Gate object represents an individual ticket gate and can be set up to be an 'IN' Gate, an
'OUT' Gate or a 'Switch' Gate. An IN Gate enables pedestrians to travel from an unpaid to a
paid area of a model; an OUT Gate enables pedestrians to travel from a paid to an unpaid area
of a model; and a Switch Gate is one in which IN and OUT status can be alternated throughout
a simulation. While there are several key parameters you can set for Gates, as with all
objects, further control and logic is available through the use of Gate Control Profiles.

The relationship between legacy gatelines from earlier versions of SpaceWorks and Gate
objects (version R6.5.0 onwards) requires that Gate Control Profiles can be created from
Availability Profiles and also that Availability Profiles can be created from Gate Control Pro-
files. See Gates, Gatelines, Gate Control Profiles and Availability Profiles.
To clarify further:
● In gate–this gate enables pedestrians to flow through it from an unpaid area of the model
to a paid area.
● Out gate–this gate enables pedestrians to flow through it from a paid area of the model to
an unpaid area.
● Switch gate–the flow of pedestrians through this kind of gate can be alternated from In to
Out throughout the simulation, according to its associated Gate Control Profile.
When drawing a Gate, there is no default setting for In, Out or Switch and you are able to
choose which state you prefer after you've placed the object. The different states require
slightly different parameters to be set, as described below. As with all objects, it helps to use
the Model Builder's various Snap tools when drawing and placing a Gate.

To draw a Gate:

1. Click or select Objects > Gate.

2. Begin drawing from the 'unpaid' side of the gate by clicking to place the first point of the
segment through which pedestrians will enter the gate.
3. Click to place the second point to complete the segment (this segment will usually straddle
or connect with your gateline CAD lines).
Rather than clicking, you can also hit Enter when you have positioned your cursor, or you
can enter the exact coordinates using the number keys on your keyboard.
4. Drag the Gate object to the 'paid' side of the gate and click to set the gate length.
Rather than clicking, you can also hit Enter when you have positioned your cursor, or you
can enter the exact coordinates using the number keys on your keyboard. The Gate object
is displayed in the workspace. At each end of the gate you will see that there are auto-
matically created trapezoids. These represent the space where Entities queue to use the
gate when it the gate is occupied. You cannot modify these areas.

268
Legion SpaceWorks R6.5.0 User Guide

Depending on where your cursor is placed, the Gate object will display an arrow indicating
whether the gate is an In, Out, or Switch gate. The illustration above indicates an Out gate
(because the cursor is hovering over the trapezoid at the 'paid' side of the gate).
If you shift the cursor towards the centre of the Gate, you will see a double arrow, indic-
ating the Switch state.

And if you move the cursor to the trapezoid at the 'unpaid' side of the gate, you will see a
green arrow, indicating the In state.

5. To set the state of the gate to In, Out, or Switch, move your cursor to the appropriate pos-
ition as just described and click, or you can type i, o, or s and hit Enter.
The Edit Gate dialog box is displayed. Its active contents will differ according to which
state of Gate you have chosen. Here a 'Switch' gate's parameters are illustrated.

© 2001–2017 Legion International Ltd 269

Legion SpaceWorks R6.5.0 User Guide

6. Continue to the next procedures to set parameters for the three types of Gate.

To set an 'In' Gate's parameters

1. Enter a meaningful name for the new gate in the 'Name' box
2. To link the gate to the required data profile, from the drop-down list 'Control profile',
select a Gate Control Profile.
The inbuilt profiles are 'Always CLOSED', 'Always IN', 'Always OUT' but other bespoke pro-
files may be listed.
3. To specify when waiting pedestrians 'Step into gate' when the gate they are approaching is
currently being used, select Immediately or Wait until occupier moves.
This parameter controls how pedestrians behave when the gate they are queuing for is
occupied by another pedestrian: they can step into the gate immediately or they can wait
until the occupying pedestrian has passed through the gate.
4. In the 'Link Options IN' panel, select either:
◊ Revert to final destination (Entities will proceed to their Final Destination)
◊ Specify links

270
Legion SpaceWorks R6.5.0 User Guide

If you select 'Specify link', click on the 'Links from IN gate' tab and add your target
objects manually following the steps in Linking methods).
5. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting IN'. To do so, check the box Maximum and
enter a value for people/minute in the adjacent field.
6. Click the 'IN Delays' tab.
7. Choose a Delay Profile for the default Entity Type (‘All Other Entity Types’) by double-click-
ing in the ‘Delay Profile’ column and selecting a profile from the list.
8. If you wish to add an extra Entity Type/Delay Profile combination, click the New button to
add a new row to the ‘Delay profiles’ portion of the dialog box.
9. Double-click in the ‘Entity Type’ column and select a type from the drop-down list.
10. Double-click in the adjacent ‘Delay Profile’ column and select a profile from the drop-
down list.
11. Repeat steps 8 to 10 for any new combinations of Entity Type and Delay Profiles you
would like to add.
12. Click the 'Target Parameters' tab. Entities automatically navigate towards the Focal Point
of an object if and when they cannot 'see' it due to obstructions. In rare instances this may
cause them to move in an unexpected or illogical manner. To remedy this, uncheck Use
focal point for navigation. In this case Entities will navigate towards the closest point
on the Focal Segment.
13. Click OK.

To set an 'Out' Gate's parameters

1. Enter a meaningful name for the new gate in the 'Name' box
2. To link the gate to the required data profile, from the drop-down list 'Control profile',
select a Gate Control Profile.
The inbuilt profiles are 'Always CLOSED', 'Always IN', 'Always OUT' but other bespoke pro-
files may be listed.
3. To specify when waiting pedestrians 'Step into gate' when the gate they are approaching is
currently being used, select Immediately or Wait until occupier moves.
This parameter controls how pedestrians behave when the gate they are queuing for is
occupied by another pedestrian: they can step into the gate immediately or they can wait
until the occupying pedestrian has passed through the gate.
4. In the 'Link Options OUT' panel, select either:
◊ Revert to final destination (Entities will proceed to their Final Destination)
◊ Specify links
If you select 'Specify link', click on the 'Links from OUT gate' tab and add your target
objects manually following the steps in Linking methods).
5. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting OUT'. To do so, check the box Maximum and
enter a value for people/minute in the adjacent field.
6. Click the 'OUT Delays' tab.
7. Choose a Delay Profile for the default Entity Type (‘All Other Entity Types’) by double-click-
ing in the ‘Delay Profile’ column and selecting a profile from the list.
8. If you wish to add an extra Entity Type/Delay Profile combination, click the New button to
add a new row to the ‘Delay profiles’ portion of the dialog box.

© 2001–2017 Legion International Ltd 271

Legion SpaceWorks R6.5.0 User Guide

9. Double-click in the ‘Entity Type’ column and select a type from the drop-down list.
10. Double-click in the adjacent ‘Delay Profile’ column and select a profile from the drop-
down list.
11. Repeat steps 8 to 10 for any new combinations of Entity Type and Delay Profiles you
would like to add.
12. Click the 'Target Parameters' tab. Entities automatically navigate towards the Focal Point
of an object if and when they cannot 'see' it due to obstructions. In rare instances this may
cause them to move in an unexpected or illogical manner. To remedy this, uncheck Use
focal point for navigation. In this case Entities will navigate towards the closest point
on the Focal Segment.
13. Click OK.

To set a 'Switch' Gate's parameters

Setting the parameters for a 'Switch' Gate is identical to the procedures for 'In' and 'Out'
gates; it just requires all tabs and parameters marked IN and OUT to be addressed.

Entity Behaviour Modification Options

The Spatial Objects Delay Points, Waiting Zones and Drift Zones each have an 'Additional Para-
meters' tab. You can use this tab to further modify how Entities behave when affected by
these objects. This topic explains when and how to use these options and the implications of
doing so for your models.
'Additional Parameters' enable you to specify things like the direction in which Entities face
(Delay Points and Waiting Zones) and their orientation while queueing (Drift Zones). They also
enable you to apply some special types of movement depending on context.
Delay Point and Waiting Zone Options
● None—no special behaviour is applied to Entities
Vehicle
● Diffusing
◊ Removes Entity synchronisation and reduces priority of Entities and encourages an
even dispersion inside the zone.
◊ Use it to encourage Entities to disperse evenly within a crowded space, such as a train
carriage or lift.
● Waiting
◊ Reduces priority of Entities further so that all other Entities can move past them. It
also removes Entity synchronisation.
◊ Use it to encourage waiting or delayed Entities to reposition themselves to allow other
Entities to move past them. Useful in train carriages and lifts.
Platform
◊ Removes Entity synchronisation and modifies Discomfort and Frustration parameters.
◊ Use it to encourage waiting or delayed Entities to reposition themselves to allow other
Entities to move past them. Useful on crowded platforms and similar contexts.
Drift Zone Options
● None—no special behaviour is applied to Entities
Entity Step
◊ Entity Priority
> High—Entities have priority and are able to pass other Entities (with a lower pri-
ority) first.

272
Legion SpaceWorks R6.5.0 User Guide

> Low—Opposite effect to 'High'.

> Use where an 'after you' etiquette is helpful to resolve competition between oppos-
ing or allied Entities.
> High and Low priorities can be used in combination to amplify the effect of each.
◊ Direction
> Left—Entities prefer to avoid other Entities and obstacles by stepping to the left.
> Right—Entities prefer to avoid other Entities and obstacles by stepping to the right.
> Use to help resolve high-density counter-flow inside constrained areas (stairs, pas-
sageways, footpaths and similar).
> Also helps when modelling the effects of signage, floor markings, or local customs.
Vehicle
◊ Alighting—Similar to 'High priority'; increases tolerance of Discomfort resulting from
high-density and removes Entity synchronisation.
> Use to help Entities leave a crowded space (lift, train carriage and similar).
◊ Late boarding—By increasing tolerance of Discomfort and removing Entity syn-
chronisation, this results in Entities being more willing to push into crowded areas (like
a cramped train carriage).
> Use to help Entities enter a crowded space (lift, train carriage and similar).

Delay Points
Delay Points cause Entities to pause in a specified fashion, for a specified interval of time
(defined by Delay Profiles). When they have individually satisfied the conditions of the Delay,
Entities are targeted to another object as part of their journey.
Delay Points differ from Waiting Zones in the following ways:
● A Delay Point is associated with one or more Delay Profiles, whereas a Waiting Zone
induces an indefinite delay which is typically interrupted by an Event Profile linked to a
superimposed Direction Modifier.
● A Delay Point gives waiting Entities instructions individually, according to their Delay Pro-
file, whereas a Waiting Zone instructs Entities collectively.
Delay Points have an area, a Focal Segment and you may also place Dispersal Points.
You should use Delay Points when an individual Entity’s delay leads to a change in destination,
for example when a person stops at an information point in a retail centre to find out the loc-
ation of a particular store, or pauses to eat food beside a kiosk before returning to a stadium
seat.
You can also use Delay Points anywhere that Entities are likely to stop for a particular time,
until a particular time (one event only), or according to a distribution.
Delay Points are also used in combination with Queues to represent service points where a per-
son eventually receives the service they were queuing for.

A note on 'Use Target Availability' in connection with Delay Points

The 'Links' tab of Spatial Objects contains a parameter called 'Use Target Availability'. Its
main function is to direct Entities to consider or disregard the availability of target objects that
comprise part of their route (see Linking methods for a recap).
When 'Use Target Availability' is checked with respect to Delay Points, Entities perceiving that
a Delay Point is unavailable (due to it having no capacity or because an Availability Profile has
changed its status to 'OFF') will wait within their origin object before proceeding to the Delay

© 2001–2017 Legion International Ltd 273

Legion SpaceWorks R6.5.0 User Guide

Point. However, they will only wait if they are being targeted from one of these four objects:
Entrance, Populated Zone, Focal Node or another Delay Point. From any other objects, they
will approach the Delay Point target and disperse close to it.
When 'Use Target Availability' is unchecked, Entities will disregard availability and approach
the target objects anyway.

Drawing Delay Points

In common with Waiting Zones, Delay Points require you to place Dispersal Points. These
instruct Entities on how to diffuse within the area of the Delay Point.

The kind of dispersion that Dispersal Points counteract may actually be useful for mod-
elling train carriages where density is low and people tend to disperse to the perimeters.

To draw a Delay Point:

1. Follow the procedures: To draw a Spatial Object: and Placing a Focal Segment.
You are prompted to place one or more Dispersal Points within the area of the object.
2. Click once within the area of the Delay Point to place a Dispersal Point. It appears as a red
circle centred on the cursor’s cross-hairs and is labelled “N0” in yellow.
3. Repeat step 2 for as many Dispersal Points as you wish to place.
4. To finish placing Dispersal Points, press Enter.
5. The ‘Edit Delay Point’ dialog box is displayed, open on the ‘Parameters’ tab.
See ‘Setting Delay Point parameters’.

Setting Delay Point parameters

The settings for a Delay Point are quite complicated, so this section contains three procedures
for setting Delay Point, Entity Waiting and Focal Distribution parameters respectively. It
assumes that you have drawn and placed a Delay Point and that the ‘Edit Delay Point’ dialog
box is displayed.

To set Delay Point parameters:

1. Enter a name for the Delay Point in the 'Name' box (or leave it as it is if you are happy
with the existing name).
2. Enter a figure in the Capacity box. This defines the maximum number of waiting Entities
that the Delay Point can hold at any one time. Think of this as ‘service capacity’ rather
than physical capacity.
3. Choose a Delay Profile for the default Entity Type (‘All Other Entity Types’) by double-click-
ing in the ‘Delay Profile’ column and selecting a profile from the list.
4. To add an extra Entity Type/Delay Profile combination, click the New button to add a new
row to the ‘Delay profiles’ portion of the dialog box.
5. Double-click in the ‘Entity Type’ column and select a type from the drop-down list.
6. Double-click in the adjacent ‘Delay Profile’ column and select a profile from the drop-down
list.
7. Repeat steps 4 to 6 for any new combinations of Entity Type and Delay Profiles you would
like to add.
See the next procedure.

For more information on Delay Profiles, see Delay Profiles. You must have already cre-
ated a Delay Profile if you want to associate a Delay Point with it.

274
Legion SpaceWorks R6.5.0 User Guide

Setting Waiting Location parameters

The next procedure is concerned with the portion of the ‘Edit Delay Point’ dialog box labelled
'Waiting Location'. These parameters combine with the Dispersal Points to determine the dis-
tribution of Entities in the area of the Delay Point: basically they define where people choose
to wait until they move on to another target.
The parameters you need to set are concerned with Decision, Dispersion and Factor.
● Decision
This refers to how each delayed Entity will try to reach the point where it wants to wait.
This decision is based on one of these three considerations:
◊ Distance–an Entity will not come to rest until it has reached its desired waiting point.
◊ Time–an Entity will estimate the time it will take to get to its desired waiting point at
its preferred speed. It will then allow itself that much time to reach its waiting point
and will stop when the time runs out.
◊ Time and Distance–this is similar to the Distance option but applies a user-specified
Maximum time.
● Dispersion
This refers to how delayed Entities attempt to distribute themselves between the point
where they entered the area of the Delay Point and the Dispersal Point they are heading
for.
◊ The Linear function has an associated Factor setting
A Factor value of 1 distributes Entities in a uniform pattern along a line from their point
of entry to their FDP; a Factor of 100 distributes Entities closer to the FDP; a Factor of
0.001 distributes Entities closer to their point of entry.
◊ The Boltzmann function has an associated Ratio setting
The ratio skews the distribution of Entities according to the formula: 1:x, where x is a
number you define.

To set Waiting Location parameters:

1. Select one of the three options from the Decision drop-down menu:
◊ Distance
◊ Time
◊ Time and Distance
2. Select an option from the Dispersion drop-down menu:
◊ Linear
◊ Boltzmann
3. Depending on the Dispersal method you selected, enter a Factor value or a Ratio value.
4. Click on the Additional Parameters tab and see the following procedure.
5. In the 'Link Options' area, select one of these two options:
◊ Revert to final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).

© 2001–2017 Legion International Ltd 275

Legion SpaceWorks R6.5.0 User Guide

6. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.

Setting Additional Parameters

These 'Additional Parameters' enable you to specify the direction that waiting Entities assume
and also enable you to apply any special types of movement depending on context.

To set Additional Parameters:

1. If you want to set (or modify) the Entity facing direction, check the box labelled ‘Apply
facing direction’ and enter a value for ‘degrees’ and a margin of tolerance (of 5 or 10
degrees) in the box labelled ‘+/- degrees’.
2. If you would like your Entities to change their waiting behaviour to respond to certain
environmental conditions, you can specify 'Entity Special Behaviour':

Use behaviour modification options with caution. In most cases the options should only be
used to influence sub-sets of Entities within discrete areas of a model and where a model
without the modification has shown anomalous behaviour
● None—no special behaviour is applied to Entities
Entity Environment
● Vehicle (carriages, buses, lifts and other vehicles)
◊ Diffusing
> Removes Entity synchronisation and reduces priority of Entities and encourages an
even dispersion inside the zone.
> Use it to encourage Entities to disperse evenly within a crowded space, such as a
train carriage or lift.
◊ Waiting
> Reduces priority of Entities further so that all other Entities can move past them. It
also removes Entity synchronisation.
> Use it to encourage waiting or delayed Entities to reposition themselves to allow
other Entities to move past them. Useful in train carriages and lifts.
● Platform (rail and metro; areas in front of lifts, buses and other vehicles)
◊ Removes Entity synchronisation and modifies Discomfort and Frustration parameters.
◊ Use it to encourage waiting or delayed Entities to reposition themselves to allow other
Entities to move past them. Useful on crowded platforms and similar contexts.
3. Click on the Links tab and complete the link details (for further information, see Linking
methods).

Setting Dispersal Point parameters

Dispersal Points instruct Entities on how and where to disperse themselves within the area of
a Delay Point. Without them, Entities would congest near the borders of the Delay Point and
create a pattern that applies well to some situations (such as rooms or carriages) but not so
well in others. FDPs ‘encourage’ Entities to find positions to wait further inside the area of the
Delay Point.
However many FDPs you place in your Delay Point, their Entity weightings must all add up to
100%. This percentage is allocated automatically by the software but you can change these
settings using the following procedure.

If a delay is brief, an Entity may actually fulfil its delay requirements while walking
towards a Dispersal Point.

276
Legion SpaceWorks R6.5.0 User Guide

To set Dispersal Point parameters:

1. On the ‘Edit Delay Point’ dialog box, click on the 'Dispersion' tab to see a list of one or
more Dispersal Points.
2. Double-click on the Weighting value of one of the Dispersal Points.
3. Enter a new value, ensuring that all values total 100%.
4. Press Enter.
Click Uniform weighting to spread the 100% weighting equally between the FDPs if
required. If your current distribution falls short of 100%, you can select an FDP and then
click Make up to 100% to increase its percentage so that the total equals 100%.
5. Click OK to save the Delay Point parameters.

Adding and deleting Dispersal Points

You can add and remove Dispersal Points, but remember that their cumulative percentage
weighting must always equal 100%.

To add a Dispersal Point:

1. Select the Delay Point (or Waiting Zone) to which you want to add one or more Dispersal
Points.
2. Right-click within the boundary of the selected object at the place you want to add an Dis-
persal Point and select Add Distribution Focus.
A small yellow square representing the Dispersal Point appears at the point you clicked.
3. Repeat step 2 for as many Dispersal Points as you require.
4. Adjust the percentage weightings by following the procedure Setting Dispersal Point para-
meters.

To delete a Dispersal Point:

1. Select the Delay Point (or Waiting Zone) from which you want to delete one or more Dis-
persal Points.
2. Right-click on the Dispersal Point (small yellow square) that you want to delete and select
Delete Distribution Point.
3. Repeat step 2 for as many Dispersal Points as you want to delete.
4. Adjust the percentage weightings of the remaining Dispersal Points by following the pro-
cedure Setting Dispersal Point parameters.

Setting Availability parameters

You can associate Delay Points with Availability Profiles, to switch them ‘on’ or ‘off’ at specific
times or in response to certain conditions in a simulation.

To set Availability parameters:

1. If you want to link the Delay Point to an Availability Profile, click on the ‘Availability’ tab.
2. Select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 7.
3. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
4. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.

© 2001–2017 Legion International Ltd 277

Legion SpaceWorks R6.5.0 User Guide

◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
The OR option is useful in cases where, for example, you may wish to allow a higher num-
ber of Entities out of an exit when an unforeseeable instance of high density occurs at a
time not covered by the Availability Profile.
5. Set up your condition as described from step 4 of To set up a Condition:.
6. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
7. Click OK to save the parameters.

Target Parameters
There is an additional tab named 'Target Parameters' where you can adjust the way Entities
navigate to the Focal Point when they can't 'see' it due to obstructions. The tab contains a
checkbox labelled 'Use Focal Point Navigation'.
If you check this option, Entities will auto-navigate to the Focal Point and, once they can see
it, will cross the Focal Segment at the nearest point. If you leave the option unchecked, Entit-
ies will head towards the nearest visible point on the Focal Segment whether they can see the
Focal Point or not (this method can create more realistic movements but may also slow the
software's performance).

Queues
Queues simulate the activity of people queuing for services like cash machines, or ticket coun-
ters. You can set their position, how visible they are to your Entities, the angle at which the
Queue grows and the ‘rigidity’ of the developed Queue (that is, how willing the queuing Entit-
ies are to let non-queuing Entities pass through the line). Queues can also be included in
Queue Groups (see Queue Groups).
Queues have a ‘Direction of Growth’, a ‘Region of Visibility’ and a ‘Zone of Influence’. They
can receive links from other objects but can only be linked to Delay Points. Each Queue must
be linked to a Delay Point for it to function properly.
The Legion Model Builder provides you with the tools to create three types of queue:
● Single Queue to single service point–one Queue leading to one service point, like a queue
for a cash machine.
● Single Queue to multiple service points–one Queue serviced by multiple service points.
Entities wait at the head of the Queue until a service point becomes available, like a queue
in a post office.
● Grouped single Queues to single service points–a series of single Queues, each serving
their own individual service point and offering the same service. Each service point has its
own queue but Entities decide which queue to join, like queues for supermarket checkouts.
This type of Queue is covered in Queue Groups.

Service points are modelled by using Delay Point objects.

Creating a Queue
Queues are a little more complex to draw and place than most Spatial Objects.

To draw a Queue:

278
Legion SpaceWorks R6.5.0 User Guide

1. Click the Queue icon .

2. Click in the model where you would like to place the head of the Queue (the point at which
the first Entity in the queue will stand).
3. Drag the cursor to define a circle that represents the Queue’s Region of Visibility (this
circle increases or decreases the distance from which an Entity can ‘see’ a particular
Queue as it scans ahead). If the Queue is to be used in a Queue Group, you do not need to
set a specific Region of Visibility, click as described in step 4.
4. Click to place the Region of Visibility.
Your cursor now displays a movable green arrow, which indicates the physical Direction of
Growth for the Queue.
5. Move the arrow end-point to the position in which you would like the Queue to grow
towards and click to place it.
6. The ‘Edit Queue <name>’ dialog box is displayed.
See ‘Setting Queue parameters.

Setting Queue parameters

This procedure contains steps for both setting the parameters of a single Queue linked to a
single service point, and for setting parameters of a single Queue linked to multiple service
points.

To set Queue parameters:

1. Enter a name in the 'Name' box (or leave it as it is if you are happy with the existing
name).
2. Leave the Direction of Growth as it is, unless you want to change the angle you set
when you drew the Queue.
3. Enter a value between 0 and 1 in the Rigidity box. This dictates how ‘porous’ the line of
Entities waiting in the Queue is, where a value of ‘1’ is the most rigid.
4. Enter a value between 0 and 1 in the Alignment Factor box. This dictates how precisely
Entities line up behind each other, where a value of ‘1’ is the most straight and precise
alignment.
5. Enter a value between 0 and 1 in the Proximity Factor box. This dictates how close to
one another the Entities are willing to stand, where a value of ‘1’ is the closest.
6. If you would like Entities to wait until they can see the head of the Queue before attempt-
ing to join it, then leave the box labelled Use queue visibility checked.
or
If you would like Entities to attempt to join the Queue even when they can’t see the head
of it, uncheck this box.
7. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment.
8. Proceed to the next procedure 'Linking a Queue to a Delay Point'.

Linking a Queue to a Delay Point

In Legion SpaceWorks models, Delay Points represent the service points that Queues lead up
to (cash machines, ticket machines, etc.). Queues can only link to Delay Points and all Queues
in your model must link to a Delay Point.

© 2001–2017 Legion International Ltd 279

Legion SpaceWorks R6.5.0 User Guide

This procedure assumes that you have already drawn the relevant Delay Point and set its para-
meters. For further information, see Drawing Delay Points.

To link a Queue to a Delay Point:

1. Select the Queue you want to link from, ensuring that its central square node is visible.
2. Right-click on the central node and select Add/Edit Link.
3. Move your cursor into the area of the Delay Point.
4. Click within the area of the Delay Point.
5. The ‘Add Link’ dialog box is displayed.
This dialog box contains information about the link you have just created, but you cannot
change anything within it. However, you can click Cancel to cancel the link if it was cre-
ated unintentionally.
6. Click OK to close the dialog box.

To link a Queue to more than one Delay Point:

1. In the Object Directory, double-click on the Queue you want to link from
or
Right click on the Queue and select Edit Queue: <Queue name>.
The ‘Edit Queue <name>’ dialog box is displayed.
2. Click on the ‘Links’ tab and click the Add Link button.
The ‘Select target objects’ dialog box is displayed.
3. Select the objects you want to link the Queue to and click OK.
The objects are listed on the ‘Links’ tab.
4. Click OK to close the dialog box.

Setting Availability parameters

You can associate Queues with Availability Profiles, to switch them ‘on’ or ‘off’ at specific
times or in response to certain conditions in a simulation. The steps are identical to those
described in Setting Availability parameters.

Queue Groups
A Queue Group is an object that enables you to model airline check-in or supermarket check-
out-style queuing systems where there are a series of single Queues, each leading to indi-
vidual service points that offer the same service. Each service point has its own Queue but
Entities decide which Queue to join after assessing which visible Queue is shortest.

Creating a Queue Group

Because a Queue Group is a collection of individual Queues, you must first place all the indi-
vidual Queues and then form a group. The process is very like 'grouping objects' in drawing
and graphics applications.

To create a Queue Group:

1. Follow the steps in To draw a Queue: to draw and place the Queues you want to include in
your Queue Group.
2. Select each of the Queues you want to group together. If you need more information, see
Selecting Spatial Objects.
If you are going to draw the Queue Group manually, click either the rectangular drawing
icon or the polygonal drawing icon .

3. Click the Queue Group icon .

280
Legion SpaceWorks R6.5.0 User Guide

4. Click within the Queue Group object to place a Focal Point (this is the point to which Entit-
ies targeted to the Group will head for initially).
A suggested polygon, based on your chosen Focal Point, is displayed with a dark green dot-
ted outline. If you want to change the shape of this polygon, move your cursor.
5. To accept a suggested polygon, press Enter.
To reject a suggested polygon, type n and press Enter. Now manually draw the shape of
the Queue Group (to complete a polygon, press Enter).
6. The ‘Edit Queue Group’ dialog box is displayed.
See the next two procedures for information on how to complete the Queue Group Para-
meters.

Setting Queue Group Members

The following procedure contains steps for setting the Queue Group Members parameters of a
Queue Group. These parameters involve naming the group and possibly adding or removing
individual queues.
The following procedure assumes that you have created a Queue Group and that the ‘Edit
Queue-Group Parameters’ dialog box is displayed.

To set Queue Group Members:

1. Enter a name for the Queue Group in the 'Name' box (or leave it as it is if you are happy
with the existing name).
2. You may be happy with the Queues you selected for your Queue Group but if not, you can
add and remove Queues here:
◊ To move all Queues from the Available Queues pane into the Group Members pane,
click the >> button.
◊ To move a single Queue from the Available Queues pane into the Group Members
pane, click on the Queue and click the > button.
◊ To remove all Queues back into the Available Queues pane, click the << button.
◊ To move a single Queue back into the Queues Available pane, click on the Queue and
click the < button.

Setting Queue Management

The Queue Management parameters enable you to assign a priority and a maximum desired
length to each queue in the group and also to apply an optional Queue Closing Scheme.
The priority and length settings principally control when new queues open but are also used to
adjudge when queues should close if a closing scheme is running.
The closing scheme itself instructs the software when to close queues that are no longer
needed and how to distribute any Entities that may still be queuing when the decision to close
a queue is taken.
Priority and desired length
Setting the ‘Priority’ and ‘Maximum desired queue length’ enables you to set the point at
which queues fill up and alternative queues need to open to cope with demand.
Consider the case of a Queue Group containing three Queues with the following attributes.

Name Priority Maximum desired length

Queue #001 1 10

© 2001–2017 Legion International Ltd 281

Legion SpaceWorks R6.5.0 User Guide

Name Priority Maximum desired length

Queue #002 3 10

Queue #003 2 8

Entities will initially head to Queue #001 as it has the highest priority (1). Once this queue has
10 people waiting in it, Queue #003 will open as it has the next highest priority (2).
Entities will begin to choose between Queue #001 and Queue #003 in accordance with the
Entity Choice Assessment Method associated with the Queue Group (i.e. shortest queue or
shortest distance to the queue).
If Queue #003 reaches its capacity of 8 people while Queue #001 is also at capacity, then
Queue #002 will open and Entities will start to join it as well.
Queue Closing
The Queue Closing scheme uses the priority settings to decide which Queues to close first: low-
est priority Queues are closed before those with a higher priority.
The scheme also uses a ‘threshold’ setting, which you can set at anywhere between 0 and
100%. This threshold indicates an amount of available queue capacity above which the lowest
priority Queue will close. Capacity is calculated using those Entities already waiting in Queues
and those Entities already on their way to join Queues.
So, in the example above, if all three Queues are open and the threshold is set to 50%, then
the lowest priority Queue will close when the remaining capacity in the other two Queues is
greater than 50% (in this case a capacity of more than nine Entities).

When a Queue closes, you can decide whether Entities waiting in that Queue remain there
until they receive the service they are queueing for (no other Entities can join the Queues
once it has closed, however) or you can send these Entities to the other open Queues.
In the latter case, capacity is calculated by also counting these Entities that will need to be
reallocated.

To set Queue Management parameters:

1. Check the box labelled ‘Use queue management’.
2. For each Queue:
◊ Double-click in the ‘Priority’ column and set a priority (1,2,3, etc.)
◊ Double click in the ‘Maximum desired queue length’ column and enter the maximum
number of Entities you would like the Queue to contain.
The third column, ‘Close at’, displays the threshold figure at which a Queue will close (if it
is 15 it means that when the number of Entities queuing in all Queues is 15 or fewer, then
this Queue will close). This figure changes as you change the ‘Threshold’ setting (see step
4).
3. To apply an optional Queue Closing Scheme, check the box labelled ‘Use queue closing
scheme’.
4. Set the ‘Threshold’ by sliding the horizontal bar or entering a percentage in its adjacent
field.
5. If you want to send Entities in closed Queues to join other available Queues, check the box
labelled ‘Redirect entities to remaining queues’. Otherwise, the Entities will remain until
they reach the Queue’s Delay Point and move on.
6. Click OK to save your settings.

282
Legion SpaceWorks R6.5.0 User Guide

Setting Queue Group links

The ‘Links’ tab enables you to specify whether Entities will join one of the Queues according to
‘Shortest queue’ or ‘Shortest distance’. See Linking methods for full details on Queue Group
linking.

Queue Groups and Delay Points

There’s no need to link Queue Groups to Delay Points: the individual Queues within the group
take care of that. The point of the Queue Group is to enable Entities to choose between the
available Queues within the group.

Waiting Zones
Waiting Zones cause Entities to wait inside a defined area of your model, for an undefined
period. As in the case of Delay Points, Entities disperse inside the area of the Waiting Zone
according to a combination of defined Entity waiting parameters and Dispersal Points.
To get Entities to leave a Waiting Zone, you need to interrupt their wait with one or more
Event Profiles, each linked to a Direction Modifier. This combination will cause selected Entit-
ies to move on to a new target when a scheduled event occurs. For more information on Event
Profiles, see About Demand Data; see also Direction Modifiers.
You can link Entities directly to Waiting Zones or you can set Waiting Zones to filter Entities by
Target or by Entity Type:
● If the Waiting Zone filters By Target, the Direction Modifier you link to it must change the
affected Entities’ target.
● If the Waiting Zone filters By Entity Type, the Direction Modifier you link to it must change
the affected Entities’ Types.
Waiting Zones have an area, either a Focal Segment or Filter properties, and also require Dis-
persal Points.

Superimpose objects by using the Copy Geometry tool. See Copying the geometry of Spa-
tial Objects.
Waiting Zones are best used for scheduled events, like the regular arrival and departure of
trains. A typical use for a Waiting Zone would involve superimposing a Direction Modifier onto
it, which in turn is associated with an Event Profile.

Drawing Waiting Zones

Waiting Zones are very similar to Delay Points in form, so to draw one and place its Dispersal
Points, please follow the steps described in To draw a Delay Point:. The only difference is that
for Waiting Zones Focal Segments are optional. When drawing a Waiting Zone you will be
prompted to decide whether it is to be used as a target object or whether it will be used to fil-
ter Entities:
Create as Target or Filtering object? [T]/F
Target is the default setting, so press Enter to create the Waiting Zone as a target object, or
type F and press Enter to create it as an object that filters Entities.

Setting Waiting Zone parameters

This procedure assumes that you have placed a Waiting Zone. Many of these settings are
identical to those for Delay Points and the following procedure refers to them.

To set Waiting Zone parameters:

1. Ensure the ‘Edit Waiting Zone <name>’ dialog box is displayed.
2. Enter a name, or choose a name from the drop-down list of imported pending objects, in
the 'Name' box.

© 2001–2017 Legion International Ltd 283

Legion SpaceWorks R6.5.0 User Guide

3. The Entity Waiting parameters are the same as those for Delay Points so please follow the
steps in To set Waiting Location parameters:.
4. If you created the Waiting Zone as a filter object, then you can click on the 'Entity Filter'
tab and complete the Filtering parameters (for further information on filtering, see Spe-
cifying filter settings). Otherwise the ‘Entity Filters’ tab will be unavailable and you can
omit this step.
5. To set the Dispersal Point parameters, follow the steps in Setting Dispersal Point para-
meters.
6. To set Availability and possibly Condition parameters, follow the steps in Setting Avail-
ability parameters.
7. If your Waiting Zone is a target object, Entities automatically navigate towards the Focal
Point of the object if and when they cannot 'see' it due to obstructions. In rare instances
this may cause them to move in an unexpected or illogical manner. To remedy this, click
to the 'Target Parameters' tab and uncheck 'Use focal point for navigation'.In this case
Entities will navigate towards the closest point on the Focal Segment.

Setting Additional Parameters

These 'Additional Parameters' enable you to specify the direction that waiting Entities assume
and also enable you to apply any special types of movement depending on context.

To set Additional Parameters:

1. If you want to set (or modify) the Entity facing direction, check the box labelled ‘Apply
facing direction’ and enter a value for ‘degrees’ and a margin of tolerance (of 5 or 10
degrees) in the box labelled ‘+/- degrees’.
2. If you would like your Entities to change their waiting behaviour to respond to certain
environmental conditions, you can specify 'Entity Special Behaviour':

Use behaviour modification options with caution. In most cases the options should only be
used to influence sub-sets of Entities within discrete areas of a model and where a model
without the modification has shown anomalous behaviour.
● None—no special behaviour is applied to Entities
Entity Environment
● Vehicle (carriages, buses, lifts and other vehicles)
◊ Diffusing
> Removes Entity synchronisation and reduces priority of Entities and encourages an
even dispersion inside the zone.
> Use it to encourage Entities to disperse evenly within a crowded space, such as a
train carriage or lift.
◊ Waiting
> Reduces priority of Entities further so that all other Entities can move past them. It
also removes Entity synchronisation.
> Use it to encourage waiting or delayed Entities to reposition themselves to allow
other Entities to move past them. Useful in train carriages and lifts.
● Platform (rail and metro; areas in front of lifts, buses and other vehicles)
◊ Removes Entity synchronisation and modifies Discomfort and Frustration parameters.
◊ Use it to encourage waiting or delayed Entities to reposition themselves to allow other
Entities to move past them. Useful on crowded platforms and similar contexts.
3. Click OK to save the parameters.

284
Legion SpaceWorks R6.5.0 User Guide

Direction Modifiers
Different Roles of Direction Modifiers
The principal role of a Direction Modifier is to re-target Entities to other Activity Objects dur-
ing their journey. This is useful when, for example, you want to redirect waiting Entities to a
platform in response to a station announcement or when you want to define a catchment area
from which a percentage of people is redirected to a nearby attraction (for example a shop or
ticket office) or an alternative route.
A second role is to change an Entity’s Type. As an example, this can be useful when modelling
passengers who drop off luggage at a certain point in the model and thereafter occupy a smal-
ler footprint and possibly move at a different pace.
A third role is to change an Entity’s Final Destination. This could be used during evacuation
modelling: the Direction Modifier could change an Entity’s Final Destination to be one of the
exits as soon as an evacuation begins.

Scope and Influence of Direction Modifiers

Direction Modifiers can be active throughout a simulation or you can make them active at cer-
tain times only. To turn a Direction Modifier ‘on’ or ‘off’ at certain times, you can associate it
with an Availability Profile. Alternatively, you can use conditional functionality to activate a
Direction Modifier when certain conditions (for example, a certain level of congestion or, if
you have imported FDS files, a certain temperature or level of visibility) occur within the sim-
ulation.
Direction Modifiers can be configured to affect all of the Entities within them when active, or
they can be restricted to affect a subset of their occupants. You can do this either by spe-
cifying the percentage of Entities affected by the Direction Modifier, or by providing an abso-
lute number of pedestrians to affect. This last goal is achieved by associating the Direction
Modifier with an Event Profile.
If you choose to affect only a subset of the Entities, you can place a Selection Segment to dic-
tate which Entities are selected. See Placing a Selection Segment within a Direction Modifier
for more information.

Setting Direction Modifier parameters

This procedure assumes you have already drawn a Direction Modifier and the 'Edit Direction
Modifier <name>' dialog box is displayed.

To set Direction Modifier parameters:

1. Enter a name for the Direction Modifier in the 'Name' box (or leave it as it is if you are
happy with the existing name).
2. In the ‘Action’ portion of the dialog box, select one, two or all of the following options,
depending on how you want the Direction Modifier to affect Entities:
◊ Change Entity Type to–select an Entity or Supply Type from the adjacent drop-down
list.
◊ Change target–you will need to link the Direction Modifier to other targets for this to
work. If you choose this, you will need to select either 'Specify Links' or 'Revert to
final destination'. If you choose the former, you will need to specify links on the 'Links'
tab; if you choose the latter, Entities will continue to their Final Destination.
◊ Change final destination–You will need to add Final Destinations to the Direction
Modifier for this to work.
3. In the ‘Scope’ portion of the dialog box, enter a percentage value between 0 and 100 in the
box labelled Percentage of entities to affect.

© 2001–2017 Legion International Ltd 285

Legion SpaceWorks R6.5.0 User Guide

If you set this to fewer than 100%, then the number of Entities that the ‘Scope’ portion
affects will be scaled accordingly. For example, assume that this value has been set to
40%. If at a given moment in time a Direction Modifier's occupancy is 600 Entities and the
Scope attribute is set to ‘Always’ or there is an active Event Profile that affects 600 or
more Entities at that precise moment, then only 240 Entities will actually be affected in
that time-step.
4. Select a Data Profile from the drop-down list labelled 'Profile'.
5. If you want to apply conditions to the Direction Modifier, check the box labelled ‘use con-
dition’ to enable the 'Conditions' tab. See 14: Conditions in Models and in particular, To set
up a Condition: for further information.
If you wish to apply any restrictions to the condition, enter values for the following restric-
tions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
6. Click on the Entity Filter tab and complete the Filtering parameters (for further inform-
ation on filtering, see Specifying filter settings).
7. Click on the Links tab and complete the link details (for further information, see Linking
methods).
8. If applicable, click on the Target Rules tab and set up the appropriate rules. See Setting
Target Rules for full instructions.
9. If you checked the box labelled ‘Change final destination’ earlier, click on the Final
Destinations tab and click the Add Destination button, otherwise proceed to step 14.
The ‘Select final destinations’ dialog box is displayed.
10. Expand the object trees within the dialog box and select one or more destinations (press
and hold the ‘Ctrl’ key while clicking to select more than one).
11. Click OK to add the destination(s).
12. If you want to distribute Entities evenly across your destinations, click Uniform Dis-
tributionIf you want to input the distribution manually, click next to each destination
name and drag the distribution bar to set the percentage (they must equal 100%).

286
Legion SpaceWorks R6.5.0 User Guide

13. Click OK to return to the main parameters tab.

14. Click OK to save the parameters.

Setting Target Rules

Target Rules enable you to specify how often and when Entities are affected by a Direction
Modifier. For example, you may wish to ensure that Entities are not affected more than once,
or you may want to prevent Entities visiting one of the DM's targets before they have visited
another.
This procedure assumes that the ‘Edit Direction Modifier’ dialog box is already displayed, open
on the ‘Target Rules’ tab.

The default setting for Target Rules is ‘Not used’.

To set Target Rules for a Direction Modifier:

1. In the ‘Entity Memory Usage’ portion of the dialog box, select one of the following options:
◊ Not used–the same Entity may be affected by the same Direction Modifier over and
over again if it crosses its area multiple times (go to step 4).
◊ Do not visit a target more than once–the DM will not direct Entities to a target
they have already visited (go to step 4).
◊ Do not affect Entities that have visited targets in the list below–Entities that
have visited objects selected from the list below will not be affected (go to step 2).
◊ Only affect Entities that have visited targets in the list below–Entities will
only be affected after they have visited objects selected from the list below (go to step
2).
◊ Do not affect an Entity more than once–Entities that have visited once will not be
affected if they visit again in the course of the simulation.

© 2001–2017 Legion International Ltd 287

Legion SpaceWorks R6.5.0 User Guide

◊ Affect Entity multiple times while inside–Entities may be affected more than
once while they are inside the Direction Modifier (for example, they may miss a train,
return to their waiting point and then attempt to board subsequent trains).
2. In the ‘Target List’ portion of the dialog box, specify whether Any target or All targets
should be used in the evaluation.
By way of illustration, if you selected ‘Do not affect Entities that have visited targets in the
list below’, then specifying ‘Any target’ means that if an Entity has visited one of the tar-
gets in your Target List, it will not be affected again. Conversely, 'All targets' means that
an Entity will continue to be affected until it has visited each and every target in the list.
3. Select targets in the following ways.
◊ To move all items into the Selected target(s) pane, click the >> button.
◊ To move a single item into the Selected target(s) pane, click on the item and click the
> button.
◊ To move all items back into the Available target(s) pane, click the << button.
◊ To move a single item back into the Available target(s) pane, click on the item and
click the < button
4. Click OK to save your rules or click any of the other tabs if required.

Placing a Selection Segment within a Direction Modifier

If your Direction Modifier affects a percentage of Entities, rather than all of them, you may
like to specify which Entities within this percentage are affected first. You can do this by pla-
cing a ‘Selection Segment’ within the Direction Modifier.
Those Entities closest to the segment will be affected first (for example, a percentage of those
Entities near a segment placed along the edge of a platform would be the first to board an
arriving train). A Direction Modifier can only contain one Selection Segment.

To place a Selection Segment:

1. Select the Direction Modifier.
2. Right-click within the area of the Direction Modifier at the point you would like to place the
segment and select Add Selection Segment.
A very short segment is placed at this point, indicated by a cyan square.
3. To lengthen the segment, click on the square and drag the segment to the desired length.
Click again to place the segment.
4. To reposition the segment, click on its vertices and drag to the position you require.
5. To remove a segment, select the Direction Modifier, right-click within it and select Delete
Selection Segment.

Focal Nodes
Focal Nodes are intermediate targets comprising an area and a Focal Segment. Entities tar-
geted to a Focal Node move towards its Focal Segment and are re-targeted to another object
once they step into its area. In this way Focal Nodes function as intermediate objectives or
‘decision-points’ within an Entity's total journey.
You should use Focal Nodes when you want to create a subroute for a percentage of your Entit-
ies or certain Entity Types. A typical application arises when there are multiple valid paths to
the same onward destination.
You can associate Focal Nodes with Availability Profiles (for more information, see Availability
Profiles).

288
Legion SpaceWorks R6.5.0 User Guide

Setting Focal Node parameters

This procedure assumes you have already drawn a Focal Node and the 'Edit Focal Node
<name>)' dialog is displayed.

To set Focal Node parameters:

1. Enter a name for the Focal Node in the 'Name' box (or leave it as it is if you are happy with
the existing name).
2. In the 'Link Options' area, select one of these two options:
◊ Revert to final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
3. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
4. If you want to associate the object with an Availability Profile, click the 'Availability' tab.
5. Select an Availability Profile from the drop-down list labelled ‘Time Scope’.
6. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
7. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
8. Set up your condition as described from step 4 of To set up a Condition:.
9. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
10. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment.
11. Click OK to save the parameters.

Setting Availability parameters

You can associate Focal Nodes with Availability Profiles, to switch them ‘on’ or ‘off’ at specific
times or in response to certain conditions in a simulation. The steps are identical to those
described in Setting Availability parameters.

Drift Zones
Drift Zones provide information about the nature of a space and people’s movement through
it, such as the level of the terrain and any necessary changes of direction or changes in walk-
ing speed. In some circumstances, notably long corridors, they may be more appropriate to

© 2001–2017 Legion International Ltd 289

Legion SpaceWorks R6.5.0 User Guide

use than Focal Drift Zones. They are useful as a supplementary routing measure in areas of
high congestion or anomalous situations where Entity movement needs to be ‘corrected’ from
that created by Legion auto-navigation.
Drift Zones have an area, a directional arrow and can filter by Entity Type and Target. They
are generally used for modelling the following:
● Long narrow corridors, generally for corridors of 2m width or less.
● Stairs and escalators in rare occasions when the specialised Stair and Escalator objects
are not sufficient.
● Boarding areas in front of ‘ad-hoc’ stairs and escalators when the specialised Stair and
Escalator objects are not sufficient.
Drift Zones are also useful in the following cases:
● ‘Keep left’ signs
◊ In instances where signage results in people moving in an absolute direction (to the
left or right) as opposed to towards a point (represented by a Focal Drift Zone).
● Heavy two-directional flow
◊ In corridors where very heavy bidirectional flow is expected, operational procedures
to segregate that flow are best represented with two Drift Zones directing Entities in
opposite directions (using filters to select Entities).

Entities affected by a Drift Zone move in the general direction it defines rather than
towards a specific focal point.

Drift Zone parameters

The parameters you need to set for a Drift Zone are numerous and fairly complicated, so this
section contains four procedures for setting the parameters named Speed Change, Direction
Change, Stairs and Escalators, Additional, and Availability Parameters.

Setting Speed Change parameters

These parameters affect the speed at which Entities pass through the area being modelled by
the Drift Zone. This procedure assumes that you have drawn a Drift Zone and the 'Edit Drift
Zone <name>' dialog box is displayed.

To set Speed Change parameters:

1. Enter a name for the Drift Zone in the 'Name' box (or leave it as it is if you are happy with
the existing name).
2. In the ‘Speed Change’ portion of the dialog box, select one of the three options:
◊ No Speed Change–this does not affect Entities at all.
◊ Modify Speed By–enter a percentage and select either the ‘Speed Increases’ or ‘Speed
Decreases’ option button.
◊ Start/Stop Probability–enter a percentage for the probability that Entities will stop in
any one time-step (0.6s).
See the following procedure.

Setting Direction Change parameters

Firstly, if you want to turn all Direction Change options off , uncheck the box labelled ‘Change
direction’. This means that the direction of Entities is not affected by the Drift Zone, although
their speed will still be affected by any parameters you have set.

To set Direction Change parameters:

1. Select one of the three options:

290
Legion SpaceWorks R6.5.0 User Guide

◊ Linear–enter a value to define the angle (0° to 360°) in which Entities will drift or drag
and move the Drift Zone’s arrow in the model.
◊ Random Deviation–this causes Entities to move in a defined direction according to a
defined probability. Enter a value for the Max Deviation Angle (this is the maximum
direction-change allowed between steps) and then enter a Change Probability value
(this is a percentage and defines the probability of Entities changing direction in the
angle of deviation).
◊ Circular–this makes the Drift Zone circular. Select either Clockwise or Counter
Clockwise to set the direction of the Drift Zone and enter values for X and Y coordin-
ates in the boxes labelled Centred On. You can also change the centre by clicking and
dragging the central node of the Drift Zone in the model.

Setting Stairs and Escalators parameters

These parameters affect the way Entities modify their movements within a Drift Zone which is
being used to model a stair or escalator.

To set parameters for stairs and escalators:

● Select one of the five options:
◊ Flat Ground–this does not affect Entities at all.
◊ Stairs Boarding Area–this is placed in front of ‘ad-hoc’ stairs. Entities modify their
movements according to their Entity Profile. It is not necessary to place this in front of
specialised Stair Objects.
◊ Escalator Boarding Area–this is placed in front of ‘ad-hoc’ escalators. Entities modify
their movements according to their Entity Profile. It is not necessary to place this in
front of specialised Escalator Objects.
◊ Stairs–if you select this option, you must also select either the ‘Up’ or ‘Down’ option
button.
◊ Escalator–if you select this option, you must also select either the ‘Up’ or ‘Down’ option
button.
Enter a value for Tangential Speed (escalator speeds generally range from 0.5m/s to
1.0m/s but check with the manufacturer).
Enter a value for Slope (escalator slopes generally range from 30° to 35° but check
with the manufacturer).

Setting Additional Parameters

These 'Additional Parameters' enable you to specify the direction that queuing Entities face in,
to set 'Navigation Properties', and also to apply any special types of movement depending on
context.

To set Additional Parameters:

1. To specify the direction in which queuing Entities face, check the box labelled 'Change the
orientation of Queuing Entities' and enter an integer into the 'Change to n degrees' box.
2. To set 'Navigation Properties', enter a number in the box labelled 'Distance Factor'.

The distance factor applies if the Drift Zone is a filtering object rather than a target object.
Distance factors indicate how much more or less energy a person would use using an escal-
ator or stairs compared to walking. Escalators have default factor of 0.2 (20% of the
energy needed to walk on flat ground is required) and stairs have a default factor of 1.98
(almost twice as much effort needed compared to walking on flat ground).

© 2001–2017 Legion International Ltd 291

Legion SpaceWorks R6.5.0 User Guide

3. If you would like your Entities to change their behaviour to respond to certain envir-
onmental conditions, you can set 'Entity Special Behaviour' parameters:

Use behaviour modification options with caution. For example, the Alighting and Late
boarding modifications make Entities highly motivated, which can lead to unreliable res-
ults if assigned incorrectly. In most cases the options should only be used to influence sub-
sets of Entities within discrete areas of a model and where a model without the modi-
fication has shown anomalous behaviour
● None—no special behaviour is applied to Entities
● Entity Step
◊ Entity Priority
> High—Entities have priority and are able to pass other Entities (with a lower pri-
ority) first.
> Low—Opposite effect to 'High'.
> Use where an 'after you' etiquette is helpful to resolve competition between oppos-
ing or allied Entities.
> High and Low priorities can be used in combination to amplify the effect of each.
◊ Direction
> Left—Entities prefer to avoid other Entities and obstacles by stepping to the left.
> Right—Entities prefer to avoid other Entities and obstacles by stepping to the right.
> Use to help resolve high-density counter-flow inside constrained areas (stairs, pas-
sageways, footpaths and similar).
> Also helps when modelling the effects of signage, floor markings, or local customs.
Entity Environment
● Vehicle (carriages, buses, lifts and other vehicles)
◊ Alighting—Similar to 'High priority'; increases tolerance of Discomfort resulting from
high-density and removes Entity synchronisation.
> Use to help Entities leave a crowded space (lift, train carriage and similar).
◊ Late boarding—By increasing tolerance of Discomfort and removing Entity syn-
chronisation, this results in Entities being more willing to push into crowded areas (like
a cramped train carriage).
> Use to help Entities enter a crowded space (lift, train carriage and similar).
4. Click on the 'Entity Filter' tab and complete the filtering details (for further information,
see Filtering).
5. Click on the 'Availability' tab if you wish to set availability restrictions on the Drift Zone.
See 'Setting Availability Parameters' after this procedure.
6. Click OK to save the parameters.

Setting Availability parameters

You can associate Drift Zones with Availability Profiles, to switch them ‘on’ or ‘off’ at specific
times or in response to certain conditions in a simulation.

To set Availability parameters:

1. If you want to link the Drift Zone to an Availability Profile, click on the ‘Availability’ tab.
2. Select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 7.

292
Legion SpaceWorks R6.5.0 User Guide

3. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
4. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
5. Set up your condition as described from step 4 of To set up a Condition:.
6. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
7. Click OK to save the parameters.

Focal Drift Zones

Like Drift Zones, Focal Drift Zones (FDZs) can be used as a supplement to Legion auto-nav-
igation. They enable you to define a series of intermediate focal targets between an origin
object and a target object for Entities to follow as part of their overall journey. Each FDZ has a
focus which can be either a point or a segment, and while an Entity is within the area of an
FDZ it is directed towards this focus.
This focus must be outside the object's area: if not, Entities will not leave the area because
they will reach the focus and stay there. There must be no obstacles between Entities in the
area of an FDZ and their focus.

Before placing FDZs, you must create a Partition Layer (or Layers) for them.

Focal Drift Zone partitioning

In this context, partitioning means covering the accessible space within a Partition Layer with
a series of appropriately shaped FDZs. This coverage can be partial or complete.
There are two main ways to achieve this:
● Interactive Focal Drift Zone partitioning
● Batch Focal Drift Zone partitioning
and a further method for placing individual FDZs as and when needed as a result of conflicts in
the partitioning processes. If you experience errors with gaps in partitioning or inaccurately
placed FDZ borders, see Changing the algorithm to resolve errors with FDZs.

Interactive Focal Drift Zone partitioning

In this method, FDZs are generated one at a time, and you are required to accept or reject a
suggested FDZ before the software generates another (this is the ‘interactive’ part).
Interactive partitioning requires an active Partition Layer. To create such a layer you need to
either right-click on the target object and select Create Partition Layer or create a new
layer and then select its associated mandatory target object. For more information on Layers,
see 12: Layers.
To stop this process at any point, press the Esc key. You will be asked if you want to keep any
FDZs you may have generated so far.

To use Interactive FDZ partitioning:

© 2001–2017 Legion International Ltd 293

Legion SpaceWorks R6.5.0 User Guide

1. Click on or select Route Partitioning > Interactive (or type autofdz_

interactive).
An initial Focal Target is indicated by a marker (a red circle) within the target object.

2. Click once on this marker.

The shape of a suggested FDZ is indicated by brown dotted lines. You can move these lines
by moving your cursor, which will also move the original marker. If you want to override
the suggested focal point, hold down the Shift key and click where you want the focal
point to be.
Focal Points must not be placed on, or too near to, walls. To help avoid this happening, any
current Snaps that you may have active are turned off until partitioning ends through com-
pletion, abandonment or error. At this point, any existing Snaps settings are resumed.
Always place Focal Points at least 10cm (model-scale) from walls.
3. When you are happy with the shape and position of the suggested FDZ, press Enter.
The area of the suggested polygon is filled-in and the space it covers is no longer available
for partitioning. The software uses the placed FDZ to suggest new candidate focal targets
to help you place the next FDZ. These appear as red markers on the edges of the FDZ you
have just placed.

4. Click once on one of these new markers. A new FDZ is suggested and appears as a light
brown shape.

5. Either press Enter to accept the suggested FDZ, or type n and press Enter to reject it.
If you experience errors with gaps in partitioning or inaccurately placed FDZ borders, see
Changing the algorithm to resolve errors with FDZs.
Repeat steps 4 and 5 until you have placed all possible FDZs. The ‘Auto FDZ Parameters’
dialog box is displayed.
6. Enter a value (in metres) in the box labelled Enter the distance to offset Focal Points
from corners. This distance represents the space that people generally leave between
themselves and an obstacle they are passing (0.5 metres is a realistic distance).
If the demand on a model increases significantly (for example when different scenarios
are tested), you may need to increase this offset value to ensure accurate simulation of
people moving around corners and obstacles.
7. Click OK to close the dialog box.

294
Legion SpaceWorks R6.5.0 User Guide

After placing the FDZs, you must set up their parameters. See Setting Focal Drift Zone para-
meters for further information.

Batch FDZ partitioning

This method of partitioning does not ‘pause’ for you to accept or reject the suggested FDZs, it
attempts to place them all in one sweep. Even if you intend to use Interactive partitioning, this
method is useful as a way of identifying potential spatial conflicts and as such is recom-
mended as a ‘first resort’.

To use batch partitioning:

1. Click on or select Route Partitioning > Batch toolbar button (or type autofdz_
batch).
An initial Focal Target is indicated by a marker (a red circle) within the target object.
2. Click once on this marker.
The shape of a suggested FDZ is indicated by brown dotted lines. You can move these lines
by moving your cursor, which will also move the original marker. If you want to override
the suggested Focal Target, hold down the Shift key and click where you want it to be.

Focal Targets must lie within the accessible space of the model.
3. When you are happy with the shape and position of the suggested FDZ, press Enter.
The software will now try to fill all available space with a series of FDZs. If it does so suc-
cessfully, the ‘Auto FDZ Parameters’ dialog box is displayed.
If you experience errors with gaps in partitioning or inaccurately placed FDZ borders, see
Changing the algorithm to resolve errors with FDZs.
4. Enter the offset distance in metres; this is the distance between the focus of each FDZ and
the corners of walls or obstacles (0.5 metres is a realistic distance).
5. Click OK to close the dialog box.

There is a high probability that this process will encounter spatial conflicts. Please see the
following section for information on how to resolve these.
After placing the FDZs, you must set up their parameters. See Setting Focal Drift Zone para-
meters for further information.

Spatial conflicts
A spatial conflict occurs in batch partitioning when two or more suggested FDZs would, if gen-
erated, occupy the same space. This occurs when Entities have a choice of routes around an
obstacle. When a conflict is detected, the software stops processing the accessible space.
Non-conflicting polygons are added to the model as FDZs, a warning message is displayed and
conflicted areas are coloured red.
This is an example of a spatial conflict:

© 2001–2017 Legion International Ltd 295

Legion SpaceWorks R6.5.0 User Guide

The red area is the conflicted area where both focal targets are suggesting FDZs that would
overlap.
There are three ways to resolve the conflict:
● Manually draw FDZs and Drift Zones in the conflict area.
● Start the Interactive FDZ partitioning process. This continues from the last suggested focal
targets of non-conflicting FDZs and it enables you to choose which route should be fol-
lowed.
● Split the conflict area using a Partition Guide and then resume the batch partitioning.

Placing an Individual Focal Drift Zone

This procedure describes how to place a single FDZ. You will not need to do this very often but
may find it useful to resolve problems with tricky geometry in the model or with spatial con-
flicts encountered by the other partitioning methods. You may also use Focal Drift Zones with
focal segments to improve navigation of very large crowds around corners, or to create ‘fan-
ning-in’ or ‘fanning-out’ effects near bottlenecks.

To place an individual Focal Drift Zone:

1. Click on or select Objects > Focal Drift Zone.

2. Click in the model where you would like to place the FDZ’s focal target.y
The shape of a suggested FDZ is indicated by brown dotted lines. You can move these lines
by moving your cursor, which will also move the focus.
3. To accept the suggested shape press Enter and go to step 6. To reject the suggestion and
draw the shape manually, type n and press Enter.
4. Drag and draw the shape of the FDZ manually; press Enter to place it.
5. You are prompted to decide if you want to add a Focal Segment. Press Enter to add one,
or type n and press Enter to place the FDZ without a Focal Segment and go to the last
step.
6. If you chose to place a Focal Segment, follow the steps described in Placing a Focal Seg-
ment.
7. Set the FDZ’s parameters as described in Setting Focal Drift Zone parameters.

Using Partition Guides

Partition Guides are lines that can be drawn in a model in the same way as you would draw
CAD lines; the difference is that Partition Guides do not present physical obstructions to Entit-
ies and they are grey rather than white.

296
Legion SpaceWorks R6.5.0 User Guide

They are also useful for solving spatial conflicts when you are partitioning your model’s
accessible space with Focal Drift Zones. This does not apply to auto-navigation since spatial
conflicts do not arise where it is active.
Partition Guides have a tiny area of 7cm (in model-scale terms) surrounding them that cannot
be covered by the FDZ. This creates the slight risk of Entities losing instructions if their
centres stray into this unpartitioned area. To avoid this, snap all adjacent, generated FDZs to
any Partition Guides you have used. See Using Snaps.

Using Partition Guides to resolve a conflict:

1. Click on or select Route Partitioning > Partition Guide Mode.

2. Click on the Create CAD Line icon .

3. Draw a Partition Guide to bisect the conflict area (Partition Guide illustrated below in
grey).

4. Click on or select Route Partitioning > Batch.

The batch partitioning process resumes from the last-known suggested Focal Target and
tries to partition the remaining accessible space. This time however, the Partition Guide
prevents the candidate polygons for each Focal Target from overlapping, allowing the
batch partitioning to succeed:

Potential problem with the first Focal Drift Zone

Due to the way that accessible space is calculated in both Interactive and Batch partitioning,
the focus of the first FDZ that is laid down will lie within its own area. If left here it would
cause Entities entering the FDZ to remain trapped within it, which is why it gives rise to a QA
error. There are several ways to remedy this:
● Drag the focus out of the FDZ’s area (this may mar the original ‘line of sight’ principle and
cause Entities to move towards the FDZ in an unrealistic manner).

© 2001–2017 Legion International Ltd 297

Legion SpaceWorks R6.5.0 User Guide

● Delete the FDZ and replace it with a Drift Zone (taking care to ensure that the Drift Zone’s
Direction Change parameters do not create any routing anomalies).
● Trim the FDZ to the edge of the Activity Object used to initially generate the FDZs as part
of the partitioning process (this is the recommended method).

Setting Focal Drift Zone parameters

As with all Spatial Objects, you need to set the parameters of the FDZs you have placed. This
is best done as a ‘group edit’.

To set FDZ parameters:

1. Select all the FDZs you need to edit in the Object Directory (they will be on a Partition
Layer).
2. Select Edit Properties.
The ‘Edit Multiple Focal Drift Zones’ dialog box is displayed.
3. If you require your FDZs to only affect those Entities navigating towards their focal seg-
ments, check the box labelled 'Filter by entities navigating through the associated focal
segment'. This can be important if you have FDZs close together and want to ensure they
only affect the desired Entities.
4. Click on the Filters tab and complete filtering details (see Specifying filter settings for full
instructions). If you checked the box mentioned in the previous step, you may not need to
specify any further filters here.
5. If you want to link a Focal Drift Zone to an Availability Profile, click on the ‘Availability’
tab.
6. Select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 10.
7. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
8. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
9. Set up your condition as described from step 4 of To set up a Condition:.
10. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
11. Click OK to save the parameters.

Changing the algorithm to resolve errors with FDZs

In rare instances, during Interactive and Batch partitioning, Legion’s partitioning algorithm
may leave gaps in the space to be covered or may plot inaccurate positions for the boundaries
of FDZs. When this happens, changing the Boolean algorithm may resolve the problem. You
can do this from the Model Builder’s Tools > Options menu.

To change the partitioning algorithm:

1. Select Tools > Options.

298
Legion SpaceWorks R6.5.0 User Guide

The ‘Options’ dialog box is displayed.

2. Click on AutoFDZ Settings.
3. Under ‘AutoFDZ partitioning engine’, select one of these options:
◊ OpenGL–this is the default setting and is good for solving errors that may be caused
by KBool, such as inaccurate boundaries.
◊ KBool–this is good for avoiding the gaps in accessible space that OpenGL may some-
times leave.
If your attempts to partition model space encounter both types of error, you can change
the algorithm settings several times during Interactive Partitioning.
4. Click Apply or OK to save your changes. These settings will hold until you change them or
reinstall the software.
5. Try Interactive or Batch Partitioning again.

Route Guides
Route Guides can be used to steer Entities away from certain areas of a model and thereby
suggest they take an alternative route. They have a directional feature, similar to Analysis
Lines, and the ability to filter for Entities. Sometimes Entities may cross a Route Guide as a
result of congestion but they can also be set up as obstacles that cannot be crossed under any
circumstances.
For example, you can use Route Guides to model one-way passageways (by blocking access
to the passageway in one direction) or to restrict certain areas of a model to Entity Types rep-
resenting staff or VIPs. The filter on Route Guides also helps when modelling routes for mobil-
ity impaired people, as inaccessible areas or elements can be barred to these types of Entity.

To place a Route Guide:

1. Click the Route Guide icon.

2. Click in the workspace at the point you would like to start drawing the guide.

Drawing from left to right will create a directional arrow pointing up; drawing from right to
left will create a directional arrow pointing down; drawing top to bottom will create a dir-
ectional arrow pointing to the right; drawing bottom to top will create a directional arrow
pointing to the left.
3. To draw a single segment, drag the cursor to the point where you would like to place the
other end of the line, click, and press Enter.
To draw a poly-line, drag the cursor to the point where you would like to place the other
end of the first line and click; then move the cursor to the point where you would like to
place the end of the second line and click, and so on for each new line you would like to
place as part of the Poly-line. Click and press Enter to complete the line.
The ‘Edit Route Guide <name>’ dialog box is displayed.
4. Enter an appropriate name for the Route Guide.
5. If you want the Route Guide to keep Entities from crossing it in either direction, check
Affect Entities in either direction.
6. If you want the Route Guide to work as an inviolable obstacle, check Function as an
obstacle.
7. To specify which specific Entities are affected by the Route Guide, click the ‘Entity Filter’
tab and specify the filters in the standard manner as described in Specifying filter settings.
8. If you want to link the Route Guide to an Availability Profile, click on the ‘Availability’ tab.

© 2001–2017 Legion International Ltd 299

Legion SpaceWorks R6.5.0 User Guide

9. Select an Availability Profile from the drop-down list labelled ‘Time Scope’. If you don’t
want to apply conditions, proceed to step 14.
10. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
11. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
The OR option is useful in cases where, for example, you may wish to allow a higher num-
ber of Entities out of an exit when an unforeseeable instance of high density occurs at a
time not covered by the Availability Profile.
12. Set up your condition as described from step 4 of To set up a Condition:.
13. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions
14. Click OK.

Mesoscopic Transition Zone

The Mesoscopic Transition Zone (MTZ) enables you to represent areas of a model that are
immaterial to your study, and which do not require detailed simulation, analysis, or the visu-
alisation of Entities. In a sense, an MTZ enables you to 'abstract' an area of your model.
Inside an MTZ, Entities are not visible and they are navigated mesoscopically, rather than
with the usual microscopic accuracy of a Legion simulation.
Some of the situations and areas where using an MTZ might benefit your project:
● Lifts—Pedestrian behaviour inside lifts is often irrelevant to a study and does not affect
overall pedestrian flow. An MTZ can be used to represent a lift and Entities will be sim-
ulated mesoscopically until they alight.
● Shops—Much like lifts, shops (and cafés, etc.) may be intermediate destinations within
which the behaviour of Entities is immaterial to your study.
● Holding areas—Many models contain areas where pedestrians are held for a certain period
of time (outside stations during rush hour, for example); there may also be zones in which
pedestrian behaviour is of no particular interest to your study (like communal areas in a
sports stadium).
● 'Internal' transit services—MTZs can be used to model transport services within models.
For example, you may wish to transfer Entities between airport terminals without sim-
ulating their behaviour en route in microscopic detail.

When drawing an MTZ, you will be asked 'Does this MTZ have any entrance/exit areas?'
This question refers to whether or not the zone will contain a volume of space which Entit-
ies will enter and exit, or whether the zone will be comprised of single segments which
Entities simply cross. Answering yes or no changes how you draw the object. If you
answer 'yes', you will draw an area (or areas if the exit area is in a different location to
the entrance area); if you answer 'no', you will simply draw segments. Segments are use-

300
Legion SpaceWorks R6.5.0 User Guide

ful when the geometry you wish to model mesoscopically is difficult to draw or lays bey-
ond the boundaries of your model (for example, a string of complex train carriages or a
holding area outside your area of interest).

Drawing a Mesoscopic Transition Zone

To draw a Mesoscopic Transition Zone:

1. Click the MTZ icon .

You are asked 'Does this MTZ have any entrance/exit areas?'.
2. For 'yes', press Enter, for 'no' type n and press Enter and then proceed to step 8'.
3. In the workspace, click and draw the MTZ at the appropriate location.
You are asked if you would like to use a segment of the MTZ as a focal segment.
4. Follow the steps in Placing a Focal Segment.
You are asked 'Does this MTZ have an exit area?' By 'exit area' we mean a location in
another part of your model where mesoscopically simulated Entities eventually emerge
from. This may be a lift on another level or a carriage at another station. If you answer
'yes', you will be required to draw this new exit area in another part of your model; if you
answer 'no', you will be required to place an exit segment on the object you are currently
drawing.
5. For 'yes', press Enter, for 'no' type n and press Enter and then proceed to step 7'.
6. Draw the exit area in the appropriate part of your model. Your single zone will now appear
to have two separate areas but they are part of the same object.
The 'Edit Mesoscopic Zone' parameters dialog is displayed and you can proceed to 'Setting
Mesoscopic Transition Zone parameters' below.
7. Select an edge of the MTZ to use as the exit segment (hold down 'Shift' if you want to
select a portion of the edge rather than the whole.
The 'Edit Mesoscopic Zone' parameters dialog is displayed and you can proceed to 'Setting
Mesoscopic Transition Zone parameters' below.
8. Draw the single-line entrance segment, following the steps in Placing a Focal Segment.
9. Draw the single-line exit segment.
The 'Edit Mesoscopic Zone' parameters dialog is displayed.

Setting Mesoscopic Transition Zone parameters

This procedure assumes that you have placed an MTZ object, or segments.

To set MTZ parameters:

1. Enter a name for the MTZ in the 'Name' box (or leave it as it is if you are happy with the
existing name).
2. Enter a figure in the Capacity box. This defines the maximum number of Entities that the
MTZ can hold at any one time.
3. From the 'Activity' drop-down list, select an activity for the Entities in the zone.
4. If your zone contains two areas or segments and you want both to be the same shape and
size, check the box 'Make exit size and shape consistent entry'.
5. If your zone contains two areas and you would like Entities to exit using their original pos-
itions in the entry area, check the box 'Transpose entity positions on exit'.
6. Choose a Delay Profile for the default Entity Type (‘All Other Entity Types’) by double-click-
ing in the ‘Delay Profile’ column and selecting a profile from the list.

© 2001–2017 Legion International Ltd 301

Legion SpaceWorks R6.5.0 User Guide

7. To add an extra Entity Type/Delay Profile combination, click the New button to add a new
row to the ‘Delay profiles’ portion of the dialog box.
8. Double-click in the ‘Entity Type’ column and select a type from the drop-down list.
9. Double-click in the adjacent ‘Delay Profile’ column and select a profile from the drop-down
list.
10. Repeat steps 7 to 9 for any new combinations of Entity Type and Delay Profiles you would
like to add.
11. In the 'Link Options' area, select one of these two options:
◊ Revert to final destination (Entities will proceed to wards this target or targets)
◊ Specify links
If you select 'Specify link', click on the 'Links' tab and add your target objects manually fol-
lowing the steps in Linking methods).
12. If you need to test your model against required regulatory flow rates you may wish to set
a maximum value for 'Flow Rate Limiting'. To do so, check the box Maximum and enter a
value for people/minute in the adjacent field.
13. If you would like to associate the object with an Availability Profile, click the 'Availability'
tab.

To set Availability and Condition parameters:

1. Select an Availability Profile from the drop-down list labelled ‘Time Scope’.
2. If you want to apply conditions to the Availability Profile, check the box labelled ‘use con-
dition’.
3. Select an option from the left-hand drop-down list:
◊ AND–the condition will apply only when the ‘Time scope’ settings and the conditional
settings are both ‘true’.
◊ OR–the condition will apply when either the ‘Time scope’ settings or the conditional set-
tings are ‘true’.
4. Set up your condition as described from step 4 of To set up a Condition:.
5. If you wish to apply any restrictions to the condition, click on the ‘Availability’ tab again
and enter values for the following restrictions (details in Restrictions):
◊ Time before action
◊ Minimum activity period
◊ Maximum activity period
◊ Minimum time between Actions

To set Target Parameters

1. Entities automatically navigate towards the Focal Point of the object if and when they can-
not 'see' it due to obstructions. In rare instances this may cause them to move in an unex-
pected or illogical manner. To remedy this, click to the 'Target Parameters' tab and
uncheck 'Use focal point for navigation'.In this case Entities will navigate towards the
closest point on the Focal Segment.
2. Click OK to save your settings and close the dialog.

Moving, rotating and scaling Mesoscopic Transition Zones

MTZs can be moved, rotated, and scaled in exactly the same way as other objects in the work-
space. However, for MTZs with 'entry' and 'exit areas' (which resemble two separate objects
as mentioned above), when you right-click on one of the areas (entry or exit) you are offered

302
Legion SpaceWorks R6.5.0 User Guide

the choice of adjusting both areas or just the entry or exit area. For example, here is what
you see when you right-click on the entry area of an MTZ. The ' (Entry Area)' only is high-
lighted here.

Multipath Zone
The Multipath Zone (MPZ) enables you to create an area of your model within which Entities
choose between multiple possible routes depending on conditions along the routes and their
preferences for distance and time. This new object simplifies modelling and shifts route
choice away from predetermined inputs and towards more genuinely emergent outputs.
You should place MPZs in areas where Entities ought to consider alternative paths within their
journey. A good place would be where there are a choice of vertical circulation elements like
stairs and escalators. In such places, pedestrians make decisions based on immediately per-
ceptible congestion, and assumed effort. Enabling them to choose their own routes by placing
an MPZ in relevant areas ensures decisions are made without a false 'God-like' knowledge of
the whole environment.

Drawing a Multipath Zone

To draw a Multipath Zone:

1. Click the MPZ icon .

2. Draw the zone over the relevant area of your model.
The 'Edit Multipath Zone' dialog is displayed.

© 2001–2017 Legion International Ltd 303

Legion SpaceWorks R6.5.0 User Guide

3. To set the criteria by which Entities decide between multiple routes, adjust the Distance vs
Time slider.
At first, the slider is set at 50:50, meaning half the Entities inside the zone think the dis-
tance they have to travel along a route is more important than the time it will take, and
vice versa.
4. Click and slide the value towards either Distanceor Time. The 50:50 value will change as
you do so.

The closer you move the slider to 'Distance', the more Entities will choose a shorter trip.
For example, even though they might see that a longer route is quicker due to less con-
gestion, they will stick with the shorter route to preserve effort
The closer you move it to 'Time', the more Entities will choose what they perceive to be
the quicker route. For example, even though they might see that the quicker route is more
congested, they may stick with this choice rather than switch to a longer route which they
perceive as less congested.
5. To introduce a certain amount of random route selection, adjust the 'Random Noise' slider.
If you slide it to 0%, every Entity will obey the Distance vs Time setting. The maximum

304
Legion SpaceWorks R6.5.0 User Guide

setting, 20%, means that this amount of Entities will ignore the Distance vs Time setting,
leading to potentially more realistic decisions. Try different percentages to fine-tune your
results.
6. To set filter parameters, click on the 'Entity Filter' tab and follow the instructions in Spe-
cifying filter settings
7. Click OK to save your settings and close the dialog.

Creating Group Objects

Certain situations require you to combine two or more Spatial Objects in order to model par-
ticular elements of a site, like gatelines or platforms or check-in desks. Legion SpaceWorks
enables you to place and configure the required objects and then to combine them into one by
grouping them together. This technique is similar to that used with Queue Groups (see Queue
Groups).
Group Objects can be edited, copied, pasted, moved, scaled and rotated just like other sin-
gular objects.
The following example deals with three objects that are commonly used together to model an
automated gateline: Focal Node, Delay Point and Drift Zone.

To group objects:
1. Draw the individual objects and set their parameters as required.
2. Select the objects in the Object Directory, right-click on one of them and select Create
Group.
or
Type Group into the Command Bar, select the objects in the workspace, and press Enter.
The ‘Edit Group Object’ dialog box is displayed, featuring your chosen objects in the ‘Selec-
ted’ pane and other available objects in the ‘Available pane’.

Objects that already belong to a group will not appear in the ‘Available’ pane.
3. Enter a meaningful name for the group in the ‘Name’ box.
4. If you wish to add or remove objects from this group, you can do so by moving them in or
out of the ‘Selected’ pane using the selection buttons >, >>, <, <<.
5. Click OK to close the dialog box.
The new object is created and added to the ‘Groups’ folder in the Object Directory. The
group can be expanded to reveal its constituent objects. The constituent objects will not be
listed individually as long as they are part of a group

© 2001–2017 Legion International Ltd 305

Legion SpaceWorks R6.5.0 User Guide

You can also drag and drop objects belonging to the Object Directory into or out of an exist-
ing group.
Hiding and showing Group Objects
This function works slightly differently for groups and their objects. In the Object Directory,
click once on the eye icon next to a group's name to hide the constituent objects but leave the
group object border visible. To hide this border as well, click on the eye icon once more. Hide
and show the constituent objects by expanding the group tree and clicking the appropriate eye
icons in the usual fashion.

Managing links into a Group Object

Because a Group Object contains several Spatial Objects, some extra work is necessary to
manage how links work: both into and out from the group.
The ‘Links In’ tab enables you to control which ‘internal’ objects of the group can be linked to,
and how external objects will link to them.

If you need to refresh your knowledge of linking methods, please see Linking methods.

To define links in to the Group Object:

1. Open the Group Object dialog box by double clicking on the object in the Object Directory
or right-clicking in the workspace and selecting Edit > Group Object <name>.
2. Click the ‘Links In’ tab.
3. Select one of the four available linking methods:
◊ Link by percentage weighting
◊ Link by entity type
◊ Link by entity choice
◊ Link by Final Destination
4. Click the Add Link button.
5. See the following related procedures for each of the four methods.

To define links by percentage weighting:

1. From the ‘Select target objects’ dialog box, select the objects you want to be able to
receive links and click OK.
2. The objects will be listed in the dialog box along with a series of columns indicating per-
centage weighting.
3. To define the percentage of Entities you want to distribute to each object, click on the
name of each target and drag your cursor to the right.
The horizontal percentage bar indicates the percentage of Entities you are assigning to
each object (a split of 50/50% between two objects means that half of all Entities targeted
to the group will go to each).

306
Legion SpaceWorks R6.5.0 User Guide

4. Enter a value for the ‘% of people consider congestion ahead’.

5. Enter a value for the ‘% of people follow the majority’.
If you want to split percentages equally between all the selected objects, click the Uni-
form Distribution button.
6. Click OK to save your changes.

To define links by Entity Type:

1. From the ‘Select target objects’ dialog box, select the objects you want to be able to
receive links and click OK.
The ‘Add Link’ dialog box is displayed.

© 2001–2017 Legion International Ltd 307

Legion SpaceWorks R6.5.0 User Guide

2. Select the Entity Types you would like to be able to link to the Group Object using the selec-
tion buttons >, >>, <, <<.
3. Click OK.
4. If you added more than one object, the ‘Add Link’ dialog box for each of the objects will be
displayed in turn. Repeat steps 2 and 3 for each.
5. Your selected Entity Types and objects they are linked to are displayed in the ‘Edit
<name> dialog box.

308
Legion SpaceWorks R6.5.0 User Guide

6. Click OK to save your changes.

To define links by Entity choice:

1. From the ‘Select target objects’ dialog box, select the objects you want to be able to
receive links and click OK.
The objects are listed in the ‘Objects’ column.
2. Enter a value for the ‘% of people consider congestion ahead’.
3. Enter a value for the ‘% of people follow the majority’.
4. Under ‘Entity Choice Decision Method’, select one of:
◊ Shortest distance
◊ Fewest occupants
5. Click OK to save your changes.

To define links by Final Destination:

1. From the ‘Select target objects’ dialog box, select the objects you want to be able to
receive links and click OK.
The ‘Add Link’ dialog box is displayed with details of the first object selected.
2. Select the Final Destinations you would like to be able to link to the Group Object using the
selection buttons >, >>, <, <<.
3. Click OK.
4. If you added more than one object, the ‘Add Link’ dialog box for each of the objects will be
displayed in turn. Repeat steps 2 and 3 for each.
5. Your selected Entity Types and destinations are displayed.
6. Click OK to save your changes.

© 2001–2017 Legion International Ltd 309

Legion SpaceWorks R6.5.0 User Guide

Managing links out from a Group Object

The ‘Links Out’ tab enables you to control which ‘internal’ objects can link out from the group
and which Linking Method is to be used. In this way you can manage how Entities are routed
on to other objects after visiting the Group Object.

For full details of the different linking methods available, see Linking methods.

To define links out from the Group Object:

1. Open the Group Object dialog box by double clicking on the object in the Object Directory
or right-clicking in the workspace and selecting Edit > Group Object <name>.
2. Click the ‘Links Out’ tab.
3. Select the objects you want to link from the group by moving them from the ‘Available’
pane into the ‘Selected’ pane using the selection buttons >, >>, <, <<.
4. Select one of the four available linking methods:
◊ Link by percentage weighting
◊ Link by entity type
◊ Link by entity choice
◊ Link by Final Destination
5. To add links at this stage, click the Add Link button.
The ‘Select Target Objects’ dialog box is displayed, with a tree listing all objects that are
available for linking to.
6. Select one or more target objects from the tree structure and click OK.
7. Adjust link parameters according to the method selected:
◊ Link by percentage weighting–adjust percentages per target as described in Linking
methods.
◊ Link by entity type–you will need to select a different Entity Type for each target selec-
ted as described in Linking methods.
◊ Link by entity choice–edit as described in Linking methods.
◊ Link by final destination–edit as described in Linking methods.
8. Click OK to save your changes.
Further details about adding, deleting and copying links can be found in Link operations.

310
Legion SpaceWorks R6.5.0 User Guide

16: Legion Simulator–Basics

In this chapter
This part of the guide introduces you to the Legion Simulator: its workspace, toolbars, menus
and describes how to set certain display preferences, quickly playback a simulation and per-
form several basic tasks. More complex tasks concerned with recording ‘avi’ and ‘res’ files
are dealt with in the subsequent section.
This section covers the following topics:
● About the Simulator
● The Simulator interface
● Simulator components
● Playing back a simulation

© 2001–2017 Legion International Ltd 311

Legion SpaceWorks R6.5.0 User Guide

About the Simulator

The Simulator is where you play back pedestrian simulations and record all the data that you
need to inform your analyses in the Legion Analyser. Each time you play or record a sim-
ulation, the Simulator calculates the movement of every single Entity in its journey through
the space you have modelled. Due to the complexity and accuracy of the Legion algorithms,
each simulation is slightly different from the last (unless you choose to reuse the identical sim-
ulation ‘seed’, see Specifying the Simulation Seed).
As well as running the simulation, the Simulator is also a useful visual tool for checking that
your model and Entities are behaving as expected. You may find that you need to tweak your
model file after viewing the movement of Entities within the Simulator.
The Simulator shares certain tools and features with the Model Builder. In order to avoid repe-
tition, you are referred to the earlier sections of the guide as appropriate.

Starting the Simulator

To start the Simulator:
1. Select Start > All Programs > Legion International > Legion SpaceWorks >
Multi-Agent Simulator.
On your very first startup you will be prompted to select a measurement system: imperial
or metric (this choice will be reflected in all measurements and analytical outputs).
2. Select either Metric or Imperial and click OK.
You can change the measurement system later in Tools > Options > Application Settings >
‘Unit system’.
The Simulator application starts.

312
Legion SpaceWorks R6.5.0 User Guide

The Simulator interface

The picture below illustrates the user interface of the Simulator, with all its major components
labelled. Although you can customise the appearance of the interface, this illustration rep-
resents a typical layout after installation.

© 2001–2017 Legion International Ltd 313

Legion SpaceWorks R6.5.0 User Guide

Simulator components
This section describes the various elements that go to make up the Legion Simulator.

Simulator viewing window

This space is similar to the Model Builder’s workspace. It is where you can view the simulation
in progress. Like the Model Builder, you can change the background to white if you prefer; see
Changing the workspace background colour.

Main Menu Bar

The main menu provides access to all Simulator functionality. All procedures in this guide
refer to the main menu options and, when appropriate, the equivalent toolbar options.

Toolbars
The Simulator has several toolbars, which are initially grouped together above the workspace.
The purpose of each icon is explained in this guide as specific tasks are described.
For information on repositioning or customising toolbars, see Repositioning toolbars and turn-
ing toolbars off and Creating a custom toolbar.

Object Directory
Like the Model Builder, the Simulator has an Object Directory but the Simulator’s directory is
simpler in that it only enables you to show or hide the objects in the inventory and to show or
hide Entity Colour Schemes.

Entity Colour Schemes will only be available if the LGM you are using contains them.
Objects are displayed in a ‘tree structure’ on the 'Objects' tab and are sorted alphabetically.
Click on the + and – icons to expand or close levels of the Object Directory. Each visual object
in the directory has an eye icon box to the left of its name. To hide an object in the workspace,
click on its adjacent eye icon to display a bar across it. To show an object again, click the eye
icon to remove the bar.
To show or hide an Entity Colour Scheme, switch to the 'Analysis' tab and click on the white
cross (on red background) icon to show the scheme or on the white tick (on green back-
ground) icon to hide it.

314
Legion SpaceWorks R6.5.0 User Guide

For further information about Entity Colour Schemes, see Creating Entity Colour Schemes.

Output Bar
The Output Bar is designed to provide feedback on the simulation. It has two tabs:
● Information
● QA
and functions in the same way as the Model Builder’s, described in Output Bar.

Information
This displays a certain amount of feedback about the simulation you are currently running,
such as the Entity Types and Profiles being used.
Right-click on this tab for menu options to Clear or Copy the contents of the ‘Information’
tab.

QA
This stands for Quality Assurance and displays any errors within your simulation.

Analysis
This tab of the Output Bar contains information about all and any Analyses within the sim-
ulation, including Analysis Objects, Accumulation Interval, Instantaneous results, Cumulative
results, Average results, and Average Advanced results.

Conditional Functionality
This tab of the Output Bar contains information about objects using Conditions in the sim-
ulation. For Direction Modifiers and objects with conditions or availability, the tab provides the
following information: Activity Object name, Availability Profile, Combining Method, Time

© 2001–2017 Legion International Ltd 315

Legion SpaceWorks R6.5.0 User Guide

Before Action, Minimum Activity Period, Maximum Activity Period, Minimum time between
actions, Condition, Availability status, and whether the condition has been met at any point
within the playback.
The tab is useful for determining when conditions are met and whether objects are active at
any given time within a simulation.
.

Status Bar
The Status Bar at the bottom of the Simulator interface displays information regarding (mov-
ing from left to right):
● Status of the application and ‘ToolTips’.
● Current position of your cursor (by X and Y coordinates).
● Current Time within the simulation.
● Rate (0.000sec/sec) of the simulation, meaning how many seconds the Simulator is taking
to process one second of ‘real time’ within the model.
● Number of Entities (including Clones) within the simulation at any time.

Playback toolbar
The playback toolbar is linked to the Timeline (see below) and contains the controls you need
for playing, recording, pausing, accelerating and restarting a simulation. See Playing back a
simulation for full details.

Timeline
The Timeline enables you to schedule all the key activities that you need to take place during
the single playback of a simulation. Having done so, it also provides a visual snapshot of all
the activities you have set up and a scrolling ‘dial’ to inform you of what is happening and
when during the course of a playback. See 17: Simulator Timeline for more detailed inform-
ation.

Layer Views
Although you cannot add, duplicate or otherwise manipulate layers within the Simulator, you
can select Layer Views as in the Model Builder, by using the Layer View control. See Layer
Views for further information.

Arranging windows
For information on how to move and rearrange windows, please see Arranging windows.

Moving and Hiding components

The Object Directory and Timeline can be moved an hidden as described in Moving and Hiding
Components.

316
Legion SpaceWorks R6.5.0 User Guide

Playing back a simulation

After opening a model you can quickly play back your simulation as a ‘sense-check’ to see
whether the Entities are behaving as planned and expected.
This section deals with playing a single simulation. Multiple simulation runs, called ‘batch
runs’, are also available and may save you time and effort. See Simulator batch runs for full
details.
For information on recording all or part of the simulation to produce a ‘res’ file (this contains
all the data you need to perform analyses within the Legion Analyser), see 17: Simulator
Timeline.

Opening a model for simulation

To simulate a model, the Simulator uses the ‘ora’ file that you exported at the end of your
model building phase. This file contains the data and objects necessary to run a simulation. To
provide the visual dimension of your simulation, the Simulator also needs the model (‘lgm’)
file.

To open a model for simulation:

1. Click or select File > Open.

The ‘Open Project Files’ dialog box is displayed.
2. Click the browse button to the right of the Model File box and select the appropriate ‘lgm’
file.
3. Click the browse button to the right of the Data Source box and select the appropriate ‘ora’
file.
4. If your simulation includes vehicles, check the box labelled ‘Load Aimsun simulation result
file’, click the related browse button and select the appropriate XML file.
See Showing vehicles in the Simulator for more information.
5. Click OK to confirm your choices.
Your model file is displayed within the simulation viewing window (the ‘ora’ file is also
associated with it). You are now ready to play and record a simulation.

Changing the Display Model

If you want to change the ‘lgm’ file you are displaying, select View > Change Display
Model and select a new file using the ‘Open’ dialog box.

Choosing a rendering engine

You can choose a rendering engine to guarantee the best quality display and highest per-
formance.

To choose a rendering engine:

1. Select Tools > Options.
2. The ‘Options’ dialog box is displayed.
3. Click to expand the tree labelled Display Preferences and click on Rendering Engine.
4. Select one of the two options:
◊ Render using native Windows renderer–uses your default Windows rendering
engine.
◊ Render using OpenGL–provides faster performance for PCs with new graphics cards
that support OpenGL hardware acceleration.

© 2001–2017 Legion International Ltd 317

Legion SpaceWorks R6.5.0 User Guide

5. Click Apply or OK to save your changes.

Setting display preferences

Before running a simulation, you can specify certain preferences to ensure that it contains the
visual elements you want to display. You can also set default display preferences in Tools >
Options > Display Preferences.
Use the following icons to set display preferences.

Icon Name Use

Model Show or hide the border of your model

Scope

Accessible Show or hide the space accessible to Entities

Space (shaded grey)

Vehicles Show or hide Aimsun vehicles, if part of the sim-

ulation

Entities Show or hide Entities

Filled Fill the Entities with solid colour (easier to see but
Entities may slow down the simulation)

Preferred Show or hide indicators of Entities’ previous pos-

Direction ition and preferred direction from that position (see
the next topic “Last Step: Preferred Direction”)

Clones Show or hide cloned Entities (see Showing Clones)

Last Step: Preferred Direction

When you choose to display the Last Step: Preferred Direction of Entities, the following ele-
ments are displayed.
● The cross marks the Entity’s position at the last time-step.
● The arrow to the centre of the Entity indicates the direction it would have preferred to take
at the last step.
● A yellow line joins the cross and the arrow (the longer the yellow line, the higher the walk-
ing speed of the Entity).

Playing a simulation
When you have opened a file for simulation and selected your display preferences, you are
ready to play the simulation. Use the following controls to play a simulation More complex
functions of the Timeline are covered in 17: Simulator Timeline. Some controls are only avail-
able if playback is paused or stopped.

318
Legion SpaceWorks R6.5.0 User Guide

Icon Name Use

Play Start the simulation at processing speed (fastest

possible)

Pause Pause the simulation (click again to resume)

Stop Stop the simulation

Record Begin recording files (‘res’ and/or ‘avi’ files)

Step For- Advance one time-step per click

ward

Step Back Go back one time-step per click

Accelerate Speed up the simulation

Decelerate Slow down the simulation (click this before start-

ing the simulation if you want to begin at slower
than processing speed)

Restart Return to the start of the simulation (you can only

do so after you have pressed Stop)

Showing vehicles in the Simulator

If your simulation includes vehicles you need to load an Aimsun XML file when opening project
files in order to display the vehicles. This XML file contains all vehicle positions over time and
enables Legion SpaceWorks to visualise traffic.
When loading project files, using the ‘Open Project Files’ (dialog box, you can now check the
box labelled ‘Load Aimsun simulation result file’, click the adjacent Browse button and nav-
igate to the appropriate Aimsun XML file.
With vehicle positions loaded, the Simulator can display traffic as part of the simulation.

© 2001–2017 Legion International Ltd 319

Legion SpaceWorks R6.5.0 User Guide

Changing the Aimsun results file

If you want to change the Aimsun results file you are displaying, select View > Change Aim-
sun result file and select a new XML file using the ‘Open’ dialog box.

Specifying the Simulation Seed

In the Simulator (and the Analyser with an ‘ora’ file loaded), there is an option on the Play-
back menu called ‘Simulation Seed’. The ‘seed’ is used to start the sequence of calculations
made by the software during a simulation (such calculations govern the preferred speed of
Entities, their size, and how they make decisions within the course of a simulation). This
option enables you to play back a simulation using either a new series of calculations or the
exact same calculations used in a previous simulation.
Using the same seed as a previous simulation can be useful if you spot problems or errors in a
playback and wish to either study the problem area more closely in the next playback or
adjust the geometry of a model to see whether such changes make a difference when the
same seed is used.
To aid you in selecting a particular seed, the number of the seed being used is now displayed
in the Output Bar of the Simulator or Analyser, for example:
“Simulator is using seed 772736266”

To use the Simulation Seed option:

1. Open an ‘ora’ file.
The number of the seed to be used in the next playback is displayed in the Output Bar.
2. Play back the simulation one or more times as required, selecting Playback > Restart
to return the simulation to its start time.

320
Legion SpaceWorks R6.5.0 User Guide

Note that each time you select Restart, a new seed number is generated and displayed in
the Output Bar. You need only specify a particular seed when you want to repeat a seed
exactly; until you do so, each seed will be randomly generated.
3. If you want to specify a particular seed, select Playback > Simulation Seed.
The ‘Simulation seed point’ dialog box is displayed.

4. Select the Use seed option.

5. Enter the number of the seed you want to use again in the edit box (check the Output Bar
for seed numbers).
6. Click OK.
7. Play back the simulation again.
The simulation will now use this seed every time you play back.
8. To change the seed, repeat steps 3 to 6 but select the Use random seed option.

Saving computer memory

Occasionally, with very complex models, you may find the Simulator consumes almost all
your computer’s memory. To avoid this happening, you can put the Simulator into ‘Memory
saving mode’, which reduces the amount of memory needed by the Simulator.

To activate ‘Memory saving mode’:

1. Select Tools > Options > Application Settings.
2. Under ‘Memory saving mode’, check the box labelled Activate.
The figure in the box labelled 'Flush Limit (MB)'.is the amount of memory that the soft-
ware will always have available for running SpaceWorks. There is no reason to change this
figure unless Legion support ask you to do so.
3. Click OK.

Recording ‘res’ and ‘avi’ files

Playing a simulation is purely visual in nature; no data is recorded. To record data for use in
the Legion Analyser, you must record your simulation in a ‘res’ file. You can also choose to
record the simulation as an ‘avi’ file for use in presentations. Full details of these operations
can be found in 17: Simulator Timeline.

Logging playback information

You can record a log of every simulation playback and recording you make. This log will save
the key information about each run, along with QA messages. The log is saved to a .'csv' file
and can be found in the same directory as the model you are simulating, with the same name

© 2001–2017 Legion International Ltd 321

Legion SpaceWorks R6.5.0 User Guide

as the model in question. The logs apply to batch runs of more than one model too.

To set up logging:
1. Select Tools > Options > Logging

2. Check the box labelled 'Enable logging'.

3. Click Apply to save your settings or OK to save and close the dialog.

Panning and zooming

There are many handy ways to view different parts of your simulation by panning and zoom-
ing around the viewing window. For full information on panning and zooming, see Panning and
zooming.

Tracking Entities
During a playback or a recording, you can select specific Entities to track within the sim-
ulation. This can be useful for checking that Entities are behaving as expected or intended. Dis-
playing Entity Trails makes them even more distinctive. You can set the length (and
information conveyed by) of Entity Trails in Tools > Options (see Setting the length of Entity
Trails). The number of tracked Entities at any point is displayed in the Output Bar.

To select Entities to track:

1. Click or select Playback > Play .

2. When Entities that you want to track enter the simulation, click or select Playback >
Pause.
3. Select Entities by holding down the Ctrl key and dragging the cursor around them. You
may need to pan or zoom within the display to isolate certain Entities.
Each selected Entity is now marked by yellow cross-hairs (to de-select Entities, hold down
the Shift key and draw around them to remove their cross hairs). The number of tracked
Entities is also displayed in the Output Bar.

322
Legion SpaceWorks R6.5.0 User Guide

◊ If you also want to display the ‘trails’ of the Entities you are tracking, click or
select Display > Tracked Entity Trails. This displays a red trail behind each of the
Entities, which makes their pattern of progress easier to follow. If you want to change
the length of Entity trails, see Setting the length of Entity Trails.
4. Repeat step 3 for any other Entities you want to track.

5. Click or select Playback > Play to continue with the simulation.

Tracked Entities counted

When tracking Entities in a simulation, the number of Entities being actively tracked is dis-
played on the Output Bar.

Setting the length of Entity Trails

When tracking Entities, displaying their trails can help visualize their progress through models
and identify trends and problems with their journeys. Sometimes, however, the trails can
provide too much information. For example, you may find it useful to see where Entities have
just been, rather than where they've been over the last half hour. You can set the length
(meaning how many time-steps are visualised) of Entity Trails in Tools > Options.
To set the length of Entity Trails:
1. In the Simulator or Analyser, select Tools > Options > Entity Trail Options

2. In the 'Entity Trail Length' box, select one of these options:

◊ Unlimited (entire trail will be shown for each tracked Entity)
◊ Not more than n steps (enter a number directly into the box or click the up and down
arrows to change the value – holding a click for longer will accelerate the progress of
numbers in either direction).

© 2001–2017 Legion International Ltd 323

Legion SpaceWorks R6.5.0 User Guide

3. Click Apply or OK to save your changes.

Viewing Entity details

During a simulation you can view details of an individual Entity, including ID, Entity Type,
speed, direction, target and other details.

To view the details of an individual Entity:

1. Play back a simulation.

2. Click or select Playback > Pause.

3. Zoom into the Entity whose details you want to view.
4. Place the cursor over the Entity.
A pop-up panel displays detailed information for the Entity.

5. To close the pop-up, move the cursor away from the Entity.

Increasing simulation speed

Simulations can be quite demanding on hardware resources; the more complex and detailed
the visuals are, the slower the simulation is likely to run.
There are several things you can do to try and speed up the simulation processing time:
● Turn off all layers and objects in the Object Directory.
● Minimise visual elements using the options described in Setting display preferences.
● Minimise the Simulator while the simulation is running.
● Close down all other programs that might impinge on your hardware’s performance.

324
Legion SpaceWorks R6.5.0 User Guide

Saving the current view

While you are working on a simulation, you may wish to capture screenshots of it. You can do
so by saving your current view at any time.

To save the current view:

1. Ensure the simulation currently displays the view you want to save.
2. Right-click within the workspace and select Save Current View or Select File > Save
Current View
The ‘Save As’ dialog box is displayed.
3. Select a location and type a name for the file.
4. Select BMP Files, JPEG Files or PNG Files in the Save as type field.
5. Click the Save button.

Printing views of a simulation

While you are working on a simulation, you may wish to print selected views of it.

To print views of a simulation:

1. Ensure the simulation currently displays the view you want to print.

2. Click or select File > Print.

The ‘Print’ dialog box is displayed.
3. Specify any printing preferences you may need to change; select one of the following
options:
◊ Fit model to page–prints the full extent of the simulated model.
◊ Maintain current view–prints only what you can currently see in the viewing win-
dow.
4. Click the Print button.
If you want to check how your printout will look before printing the model, use Print preview.

To preview your printout:

1. Ensure the simulation currently displays the view you want to print.
2. Select File > Print preview.
3. A preview of your printout is displayed, with button-options to Print, Zoom and Close.
4. If you are happy with the preview, click the Print button to print the simulation.
If you want to change the contents of the printout, check or uncheck objects in the Object
Directory to the left of the preview.
5. Click the Close button to return to the Simulator.

Using Help
Please see Using Help for full instructions.

Sending feedback
Please see Sending feedback for full instructions.

© 2001–2017 Legion International Ltd 325

Legion SpaceWorks R6.5.0 User Guide

17: Simulator Timeline

In this chapter
This part of the guide introduces the Simulator’s Timeline control.
This section covers the following topics:
● About the Timeline
● Timeline components
● Default Tracks and Events
● Defining Events

326
Legion SpaceWorks R6.5.0 User Guide

About the Timeline

The Timeline enables you to schedule the key activities that you may need to take place dur-
ing the playback or recording of a simulation. It also provides a visual snapshot of all the activ-
ities you have set up and a scrolling ‘dial’ to inform you of what is happening and when during
the course of a playback.
The Timeline feature can save considerable time as, during the same recording session, you
can record ‘res’ and ‘avi’ files for all or part of a simulation.

In the Simulator you can only have two tracks present at any time: a Record .AVI track
and a Record .RES track. Consequently, unless you delete one of the default tracks, you
cannot add new tracks manually.
When you open a new model and ‘ora’ file in the Simulator, two default tracks are created
automatically which allow you to record full-length ‘avi’ and ‘res’ files. The properties of these
tracks and events are already set up and require no further work on your part.

© 2001–2017 Legion International Ltd 327

Legion SpaceWorks R6.5.0 User Guide

Timeline components
When you start up the Simulator and open project files, the Timeline appears underneath the
workspace area. The following illustration points out the main features of the Timeline. Note
that it already contains one of each of the possible types of track available in the Simulator.

Playback toolbar
This component was described earlier; please see Playing back a simulation for full details.

Time-track
This strip along the top of the Timeline reflects the time-range contained within the loaded
‘ora’ file. Wherever you move the cursor in the space beneath the Time-track, a red ToolTip
will display the exact time of that point along the track. This is useful when you want to place
an event on a Track at a particular time.

Changing the Zoom level

You can zoom in and out from the Timeline, which changes the length of the labelled ticks run-
ning along the Timeline. You can set the ticks manually or by zooming in and out of the
Timeline using your mouse wheel.

To change the Zoom level:

1. Position your cursor over the Time-track and scroll the mouse button backwards and for-
wards to zoom in and out of the Timeline. Notice that the tick lengths change as you do so.
or
Right-click on the Time-track and select Set Zoom level.
The ‘Zoom Level’ dialog box is displayed.

2. Select one of the available tick-length options (the smaller the time value, the closer the
zoom).
3. Click OK to save the new Zoom level.

328
Legion SpaceWorks R6.5.0 User Guide

Time-pointer
The vertical, green Time-pointer crosses all tracks and indicates where you are, temporally,
within the simulation. Before playback begins, it is positioned at the start of the simulation
time at the left-hand side of the Timeline. When you start a playback, it moves to the right,
one time-step at a time, until it reaches the centre of the display, where it remains while
events scroll past it to the left. As a playback approaches the end of its time, the Time-track
moves to the right of the display where it remains if the simulation is allowed to run to the
very end.

Tracks and Events

Tracks are the components of the Timeline that carry the events you want to occur in the
course of a simulation. An event may be, for example, the recording of an ‘avi’ of part of a
simulation or the recording of a ‘res’ file for the whole of the simulation.
Two default tracks are available in the Simulator:
● Record .AVI–record animated files for the whole or part of a simulation; also customise
the appearance of your ’avis’.
● Record .RES–record ‘res’ files for the whole or part of a simulation.

Playing and recording using the Timeline

You can start the Timeline running by pressing ‘Play’ or ‘Record’. The two operations achieve
different results.

When you press Play the Timeline simply plays back the simulation.

When you press Record the Timeline plays back the simulation as above but also saves
any Record .AVI or Record .RES events.

Disabling and enabling events before playback or recording

As you will see in the following pages, when setting up events you will have the option to
check a box labelled ‘Enable this event’. If checked, this option will ensure that the task will
be performed during playback or recording; if you leave the option unchecked, the task will be
ignored.
You can also enable or disable an event by right-clicking on it in the Timeline and selecting
either Disable or Enable.

© 2001–2017 Legion International Ltd 329

Legion SpaceWorks R6.5.0 User Guide

Default Tracks and Events

Whenever you open a new model and ‘ora’ file in the Simulator, two default tracks, with asso-
ciated events, are added to the Timeline:
● Record .RES–this track contains a full-length Record .RES file event.
● Record .AVI–this track contains a full-length Record .AVI file event.
All valid track properties have been set and all you need to do to run these events is to press
the record button on the Timeline playback toolbar. All recorded files will be saved in the
same location as the current simulation’s ‘ora’ file.

The codec selected for the default ‘avi’ track will produce a very large, uncompressed file.
You may wish to change this setting within the track’s properties.
You can change the properties of the default tracks and events, delete them, disable them,
change the default event colours and so on. These subjects are covered in the rest of this part
of the guide.
In the Simulator you can only have two tracks present at any time: a Record .AVI track and a
Record .RES track.

Track control icons

Each track in the Simulator Timeline has these three icons:
Click to enable or disable the track. When the track is enabled, the green tick shows, when
disabled the tick is crossed out.
Click to lock or unlock the track. When a track is locked, you cannot make any changes to
it.
Click and select a colour from the pop-up palette for events on the track.

Status icons
Just to the right of the Track names, there is space for one of three icons which indicate its
status:

Ok to play back.

Warning issued which may need attention, but will play back.

Error detected, will not play back until remedied.

Changing the position and height of tracks

● To reposition a track, position the cursor over a track until it changes to this shape
then click and drag the track up or down within the list, and release.
● To change the height of a track, position the cursor over its lower boundary until it

changes to this shape and then click and drag downwards to change the height of the
track.

● To collapse the whole Timeline down to just the Time-track and Playback toolbar, click.
To restore it, click the icon again.

Setting Track properties for Record .AVI and .RES tracks

The Record .RES and Record .AVI tracks enable you to name output files and specify where
they will be saved. The Record .AVI track properties are a little more complex than the Record
.RES properties.

330
Legion SpaceWorks R6.5.0 User Guide

Set the Record .RES track properties

To set properties for the Record .RES track:
1. Right-click on the Record .RES track header (in the area below the Playback toolbar) and
select Track properties.
The properties dialog box is displayed, open on the ‘Filename’ tab.
2. Click the browse button to the right of the box labelled ‘Filename to save to’.
The Windows ‘Save As’ dialog box is displayed.
3. Navigate to a location, enter a file name for the recorded ‘res’ file and Click Save.
4. Click on the 'Track info' tab to see a summary of this track. Using the checkbox labelled
'Enable this track' you can enable or disable it here (you can also do this on the track
header).
5. Click OK to save these settings.

Set the Record .AVI track properties

By setting Record .AVI track properties you can define the size and quality of the ‘avi’ file as
well as customise certain features of its layout and visual design, like logos, titles, fonts and
background colour.

To set properties of the Record .AVI track:

1. Follow steps 1 to 3 of To set properties for the Record .RES track:.
2. Click on the AVI tab.
The properties dialog box is displayed, open on the ‘Filename’ tab.
3. Click the browse button to the right of the box labelled ‘Filename to save to’.
The Windows ‘Save As’ dialog box is displayed.
4. Navigate to a location, enter a file name for the recorded ‘res’ file and Click Save.
5. Click on the 'AVI' tab.
6. Select one of the Video Size options:
◊ Standard size–if you select this option, choose one of the standard screen resolutions
from the associated drop-down list.
◊ Custom size–if you select this option, enter the required dimensions in pixels (e.g.
320 x 240) and select one of the three aspect ratios, which define the relationship
between height and width of the image: Free aspect, Lock aspect ratio to 4:3,
Lock aspect ratio to 16:9.
7. Select a codec from the Codec drop-down list (choose the one that best matches your
installed software).
8. Click and drag the Quality bar to set a value between 0 and 100 (100 being the best qual-
ity and least compression).
9. Click and drag the Speed bar to specify the speed you want the simulation to be recorded
at (the range is between 1x (real time) and 30x (30 times real time).
10. If you don’t want to change the layout of the avi, go to the next step.
If you want to change the layout of the avi, click the Layout button and see Customising
the ‘avi’ layout.
11. Click on the 'Track info' tab to see a summary of this track. Using the checkbox labelled
'Enable this track' you can enable or disable it here (you can also do this on the track
header).

© 2001–2017 Legion International Ltd 331

Legion SpaceWorks R6.5.0 User Guide

12. Click OK to apply these settings.

Customising the ‘avi’ layout

The ‘avi’ Layout Designer is accessible from the ‘AVI’ tab of the Record .AVI track properties
dialog box and enables you to organise the look of the recorded avi. Here you can change, res-
ize and reposition the model view, caption, clock and logo.

To customise the AVI layout:

1. On the ‘AVI’ tab of the ‘Record .AVI Track Properties’ dialog box, click the Layout button.
The Layout Designer is displayed and already contains a view of your model, the Legion
logo and a clock.

2. To add any of the customisable items in the ‘Avi components’ toolbar, click and hold the
relevant icon and drag into the Layout Designer. Position and resize the items according to
preference.
3. To change the properties of a label, clock or logo, click on the item to select it and change
the properties in the left-hand panel of the dialog box. Change properties in the ‘Value’
column by entering text directly, browsing for files or selecting values from drop- down
lists.

Caption

Clock–change time format; font; text colour, contour line values and background col-
ours.

Logo–browse to select an alternative logo image; change logo colour, contour line val-
ues, background colour and transparency.
4. To change the background colour of the ‘avi’, select a colour from the drop-down palette
labelled Background Colour.

332
Legion SpaceWorks R6.5.0 User Guide

5. You can also align the ‘avi’ components in relation to each other; see Aligning ‘avi’ com-
ponents for details.
6. If you want to delete a removable item, click to select it and press Delete.
7. Click OK to save your layout settings.

Aligning ‘avi’ components

The ‘Align components’ toolbar in the top right-hand corner of the Layout Designer contains
icons which enable you to align and resize components in relation to each other (the exception
is the ‘Centre horizontally’ icon which can affect a single item). For example, you can make
two items the same width as each other or align them so that their left-hand sides coincide.

Icon Name How to use

Align left Select at least two items and click to align their
left sides

Align right Select at least two items and click to align their
right sides

Align top Select at least two items and click to align their
top sides

Align bot- Select at least two items and click to align their
tom bottom sides

Equal Select at least two items and click to make them

widths the same width

Equal Select at least two items and click to make them

heights the same height

Centre Select at least one item and click to centre it hori-

horizontally zontally (its vertical position will be unchanged)

For these icons to work, you need to select at least two layout items using a single click and
Ctrl-click. When you have selected two items, notice that the first item has red vertices and
the second has green vertices, as with the logo and clock below.

The important thing to note is that the item which will be changed when an alignment icon is
clicked is the item with the red vertices; think of the green vertices as being ‘safe’, which
means that item will not be changed.
For instance, in the illustrated example, if you were to click on the Make same width icon, the
Legion logo item will be changed so that it is the same width as the clock. To swap red and
green vertices between items, Ctrl-click on one of the selected items.
When you have more than two selected items, Ctrl-clicking on one of them will change its ver-
tices to green and change all other items’ vertices red.

© 2001–2017 Legion International Ltd 333

Legion SpaceWorks R6.5.0 User Guide

Changing Track properties

If at any time after placing a track you need to change its properties, right-click on the track’s
‘header’ (in the area below the Playback toolbar) and select Track properties.

Deleting tracks
To delete a track:
1. Right-click on a track and select Delete.
2. Confirm the action when prompted.
The track is deleted from the Timeline.

334
Legion SpaceWorks R6.5.0 User Guide

Defining Events
The following procedures show you how to set up events for each track in your Timeline.
Rememter that tracks and events are automatically set up for you when you load an ‘ora’ file.
These procedures are only relevant if you have deleted events and want to add them again.

When placing any type of event, check the red ToolTip for the exact time as you place your
cursor along the Time-track.

Record .RES events

This type of event records a ‘res’ file for either the whole of your model run time or for a
period you specify. After placing a Record .RES event on the track you can change its time-
range, as described in Changing the start and end times of a Record .RES event.

Adding a full-length Record .RES event

This feature enables you to add an event that will record the whole simulation.

To add a full-length Record .RES event:

1. Right-click on the relevant track and select Add a Full-length Record .RES event.
The ‘Record RES’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. Check any of the additional metrics you wish to include in the ‘res’ file:
◊ Inconvenience
◊ Frustration
◊ Discomfort
◊ Dissatisfaction.
5. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping events.

Adding a Record .RES event

When right-clicking to add events, make sure you click in the area to the right of the Track
status icon (that is, not on the left-hand side of the track where the name of the track is dis-
played).

To add a Record .RES event:

1. Right-click on the relevant track at the point at which you want the event to start and
select Add a Record .RES event.
The ‘Record RES’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. Check any of the additional metrics you wish to include in the ‘res’ file:
◊ Inconvenience
◊ Frustration

© 2001–2017 Legion International Ltd 335

Legion SpaceWorks R6.5.0 User Guide

◊ Discomfort
◊ Dissatisfaction
5. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping
events.
6. if required, change the start and end time of the event by following the next procedure.

Changing the start and end times of a Record .RES event

You can change the start and end times of an event by dragging its start and end points along
the event track or by specifying new start or end times.

To change the start and end times of a Record .RES event:

Either
1. Position the cursor over the start or finish of the event that you want to change. The cursor
changes to a left or right bracket with arrows.
2. Click and drag the cursor in the direction of the arrow (left or right) until you reach the
required point along the Time-track.
3. Release the cursor to place the new start or end time of the ranged event.
or
4. Right-click on the relevant event and select Set event time.
The ‘Set Event Time’ dialog box is displayed.

5. To change the start time of the event, check Set the start of the event and select one
of these options:
◊ to the start of the timeline.
◊ to this time (and enter a time).
6. To change the end time of the event, check Set the end of the event and select one of
these options:
◊ to the end of the timeline.
◊ to this time (and enter a time).
7. Click OK to set the time.

336
Legion SpaceWorks R6.5.0 User Guide

Improving performance while recording 'res' files

There are two settings you can change to speed up Legion SpaceWorks while saving 'res' files.
You can set the number of frames of a recording that the software stores in its caching before
writing them to disk and you can also exclude Legion metrics. You can change these settings
in the Simulator's Tools > Options dialog.

To improve performance while recording 'res' files:

1. Select Tools > Options > Application Settings.
2. In the section labelled 'RES files', do one or both of the following:
◊ Increase the number in the box labelled 'Number of frames to buffer before saving'.
The more frames cached before writing to disk, the better the performance
◊ Uncheck the box labelled 'Include Legion metrics by default'. This means the 'res' file
will be recorded without the inclusion of Dissatisfaction, Inconvenience, Discomfort
and Frustration.
3. Click OK.

Splitting large ‘res’ files

If you think that a generated ‘res’ file will exceed 1.9 GB in size, you may wish to split it into
smaller files to avoid potential problems when moving or copying it. A feature in Tools >
Options enables you to do so.
When a ‘res’ file is split, additional data files with the extension ‘rdf’ are automatically cre-
ated. One or more of these files may be created, depending on the size of the ‘res’ file. These
files take the name of the initial ‘res’ file (for example Model1.res will produce Model1_
001.rdf, Model1_002.rdf and so on). Always keep these ‘rdf’ files in the same directory as the
‘res’ file they are associated with.

To split large ‘res’ files:

1. Select Tools > Options > Application Settings.
2. Check the box labelled Split large files.
3. Click OK.

If you want to regenerate and overwrite a ‘res’ file that has associated ‘rdf’ files, it is
recommended that you delete the initial ‘res’ file and ‘rdf’ files to ensure that the proper
number of ‘rdf’ files are regenerated.

Record .AVI events

This type of event records an ‘avi’ file from the point at which you place it along the Timeline.

Adding a Record .AVI event

To add a Record .AVI event:
1. Right-click on the relevant track at the point at which you want the event to start and
select Add a Record .AVI event.
The ‘Record AVI’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. Click Apply or OK to save the event.

© 2001–2017 Legion International Ltd 337

Legion SpaceWorks R6.5.0 User Guide

If the event overlaps other events, an error message is displayed. See Overlapping
events.

Changing the start and end times of a Record .AVI event

Follow the procedure for Changing the start and end times of a Record .RES event.

Adding a full-length Record .AVI event

To add a full-length Record .AVI event:
1. Right-click on the relevant track and select Add a full-length Record .AVI event.
The ‘Record AVI’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping events

Overlapping events
If you attempt to add an event to a track within a time period that already contains similar
events, the ‘Resolve Event Overlap’ dialog box is displayed.

It lists the events that overlap and provides two solutions for resolving the conflict.

To resolve overlapping events:

1. Select one of the two following options:
◊ Merge the overlapping events into a single event–this consolidates the events into one.
◊ Fit the new/moved/resized event around the conflicting event(s)–this resolves the
overlap problem by fitting the latter events around the existing event(s).
If you click Cancel the event or events you are attempting to place are not placed.
2. Click OK.

Specifying the colour of ranged events

To make different ranged events visually distinct, you can assign different colours to them.

338
Legion SpaceWorks R6.5.0 User Guide

To assign colours to events:

● To assign a colour to the ranged events in a track, click the Event Colour icon to the left
of the track and choose a colour from the available palette.
To define and use a custom colour, on the colour palette click on More to access the Win-
dows custom colour dialog box.

Changing event properties

To change the properties of events, right-click on the relevant event on an event track and
select Properties to display the event’s properties dialog box.

Deleting events
To delete an event:
1. Right-click on the event you want to delete and select Delete.
2. Confirm the action when prompted.
The event is deleted from the track.

Moving and docking the Timeline

You can move the Timeline by double-clicking on its side-label ‘Timeline’ and either leaving to
float or dragging it to the sides or top of the Simulator window; when you release the mouse
button, it will dock to the top or sides.

Closing the Timeline

You can close the Timeline by clicking the x icon on its side-label. To reopen the Timeline,
right-click on an empty area of the toolbar and select Timeline.

© 2001–2017 Legion International Ltd 339

Legion SpaceWorks R6.5.0 User Guide

19: Maps and Ranges

In this chapter
This part of the guide introduces you to the analytical maps available in the Legion Analyser.
This section covers the following topics:
● About Maps and Value Ranges
● Standard maps
● Custom Maps
● Custom ranges

340
Legion SpaceWorks R6.5.0 User Guide

About Maps and Value Ranges

Legion Analyser Maps provide colour-coded representations of the simulation you are ana-
lysing, enabling you to visualise key Entity experience and crowd dynamic metrics such as
density and space utilisation. They are good for obtaining an overview of a scheme's per-
formance; and intuitive enough for non-technical audiences to grasp. You can apply them to
the whole model or restrict them to specific areas defined by Analysis Zones.

You can also apply alternative metrics within a map to Stairs, Escalators and areas
marked out by Analysis Zones. See Using Alternative Value Ranges for more information.
The colours displayed in a Legion map are linked to two types of range:
● Value ranges–essentially these are Levels of Service (such as those defined by J. Fruin or
the US Highway Capacity Manual) used to rate experience-metrics.
● Colour ranges–an ordered list of colours used to describe local conditions that typically
range from ‘excellent’ (blue) to ‘bad’ (red).
Colours within a map can represent the following:
● Occupancy–the number of Entities inside an area.
● Anything that can be used to measure Entity experience–examples include speed
achieved, density experienced and total distance covered by Entities inside an area.
● Time–the duration inside an area for which a preset condition on occupancy or on any
Entity experience metric has been met.
The Legion Analyser provides several default maps but you can also create your own using
default or custom value and colour ranges.

© 2001–2017 Legion International Ltd 341

Legion SpaceWorks R6.5.0 User Guide

Standard maps
The following standard maps are available within the Analyser, on the Maps menu:
● Cumulative High Density
● Cumulative Max Density
● Cumulative Mean Density
● Cumulative Min Density
● Evacuation Time
● Space Utilisation
● Underground Cumulative High Density (15 mins)
● Underground Cumulative High Density (60 mins)
● Underground Cumulative Max Density (15 mins)
● Underground Cumulative Max Density (60 mins)
Descriptions of each map and their typical uses follow.

Cumulative High Density Map

This map shows how long various areas of a site have registered densities greater than a spe-
cified limit. The range of colours represent time. The map is similar to a 'temperature' map:
areas that have experienced high levels of density for a long time appear red, those that have
experienced shorter periods of density appear blue.
This map is best used for identifying 'hotspots' within a site: areas where high levels of dens-
ity are sustained. It asks the questions “is this design creating persistently uncomfortable
crowd densities?” and “should it be altered to alleviate these problems?”

Cumulative Max/Mean/Min Density Maps

These maps display the maximum, mean and minimum levels of density registered in an area
from the beginning of playback to the current moment. They are generally used in com-
bination with value ranges corresponding to widely used Levels of Service (Fruin's, USHCM,
etc.).
They are best used for measuring the performance of a site against predetermined standards
or imperatives such as 'the average density within a unit of space must not exceed Fruin's
Level of Service x', etc.

Evacuation Time Map

Evacuation Time maps represent the amount of time that has elapsed from the beginning of
playback to the most recent moment when an area was occupied. They are very useful for
safety assessments (e.g. ‘train on fire’, ‘station on fire’) and egress assessments (time to
clear a stadium or office building). They can also be used for platform capacity assessments,
to show how quickly platforms clear following the arrival of a train.

Space Utilisation Map

The Space Utilisation Map reveals how much space within a site is being used. It records the
location of every step of each Entity over the duration of the simulation. You can think of this
as a clean floor surface getting slowly darker in proportion to usage: heavily used areas are
generally coloured red, lightly used areas, blue. Areas of the simulation that are not used at
all remain white (or black, if that is your chosen background colour).
The colour range represents the amount of time a unit of space has been occupied within the
simulation. This unit of space for this (and all other maps in a given project) is set within the
‘Edit Project Settings’ dialog box (see Setting the map resolution). Its default setting is 10 x
10 cm which is suitable for all but very large models.

342
Legion SpaceWorks R6.5.0 User Guide

This map is best used for illustrating which areas of a site are used the most and the least. It
can support questions such as “if this area is not being used regularly, could it be used for a
small kiosk or retail unit?”

Underground Cumulative High Density (15 mins) Map

This map is based on the 2016 edition of Transport for London’s Station Modelling with Legion
SpaceWorks: Best Practice Guide. It is particularly good for underground, metro, and subway
systems and it uses a bespoke colour range named 'Underground Cumulative High Density'.
Like every other type of map, however, you can customise its parameters and settings to suit
your own iterations and observations and scenarios. In terms of Map Exclusions, this map's
parameters automatically have 'Exclude Escalators and 'escalator' Drift Zones' selected in the
Analyser.
The 15-minute version of this map generates Entity data in 15-minute batches before being
reset by a 'Clear Map' events and recommencing for the second 15-minute period and so on.
To go with this type of map, there is a default Analyser Timeline track named 'Save 15-minute
Underground maps'.

Underground Cumulative High Density (60 mins) Map

This map is based on the 2016 edition of Transport for London’s Station Modelling with Legion
SpaceWorks: Best Practice Guide. It is particularly good for underground, metro, and subway
systems and it uses a bespoke colour range named 'Underground Cumulative High Density'.
Like every other type of map, however, you can customise its parameters and settings to suit
your own iterations and observations and scenarios. In terms of Map Exclusions, this map's
parameters automatically have 'Exclude Escalators and 'escalator' Drift Zones' selected in the
Analyser.
The 60-minute version of this map generates Entity data in 60-minute batches before being
reset by a 'Clear Map' event and recommencing for the second 60-minute period (if the
runtime is long enough) and so on. To go with this type of map, there is a default Analyser
Timeline track named 'Save 60-minute Underground maps'.

Underground Cumulative Mean Density (15 mins) Map

This map is based on the 2016 edition of Transport for London’s Station Modelling with Legion
SpaceWorks: Best Practice Guide. It is particularly good for underground, metro, and subway
systems and it uses a bespoke colour range named 'Underground Cumulative High Density'.
Like every other type of map, however, you can customise its parameters and settings to suit
your own iterations and observations and scenarios. In terms of Map Exclusions, this map's
parameters automatically have 'Exclude Escalators and 'escalator' Drift Zones' selected in the
Analyser.
The 15-minute version of this map generates Entity data in 15-minute batches before being
reset by a 'Clear Map' events and recommencing for the second 15-minute period and so on.
To go with this type of map, there is a default Analyser Timeline track named 'Save 15-minute
Underground maps'.

Underground Cumulative Mean Density (60 mins)

This map is based on the 2016 edition of Transport for London’s Station Modelling with Legion
SpaceWorks: Best Practice Guide. It is particularly good for underground, metro, and subway
systems and it uses a bespoke colour range named 'Underground Cumulative High Density'.
Like every other type of map, however, you can customise its parameters and settings to suit
your own iterations and observations and scenarios. In terms of Map Exclusions, this map's
parameters automatically have 'Exclude Escalators and 'escalator' Drift Zones' selected in the
Analyser.

© 2001–2017 Legion International Ltd 343

Legion SpaceWorks R6.5.0 User Guide

The 60-minute version of this map generates Entity data in 60-minute batches before being
reset by a 'Clear Map' event and recommencing for the second 60-minute period (if the
runtime is long enough) and so on. To go with this type of map, there is a default Analyser
Timeline track named 'Save 60-minute Underground maps'.

Analysis options for Underground Maps

There are certain options you can set when using Underground-specialised maps in Analyser
projects. You can instruct the software to add specialised Underground map tracks to the Ana-
lyser Timeline; you can set absolute or relative 15 and 60-minute intervals; you can set
default map sizes and also set default image formats for Snapshot events.

To set Analysis options:

1. Select Tools > Options > Analysis Options.

2. Check the box labelled 'Add underground-specialised timeline tracks to new Analyser pro-
jects'. This ensures that all projects have relevant Underground Map tracks on the Ana-
lyser Timeline.
3. For the option 'Timing for 15-minute interval events', select one of the two options:
◊ Absolute–this will set the intervals at 15, 30, 45 minutes past the hour.
◊ Relative to model start time–this will set intervals at periods relative to the
runtime of the model (so, for example, if a model begins at 13:05, the first 15-minute
interval will expire at 13:20).
4. Select a 'Default image size for map saves': it is probably best to keep the default values
of 1024 x 480 but you can enter your preferred dimensions in pixels.
If you change these dimensions but later wish to restore the original dimensions, click the
Restore default sizes button.
5. Select a 'Default image format for maps' from the drop-down list ( 'png', 'bmp' or 'jpg').

344
Legion SpaceWorks R6.5.0 User Guide

6. Click Apply to save your settings, or click OK to save your settings and close the dialog
box.

Viewing maps as part of a simulation

You can view maps as part of a simulation during playback and recording.

To view maps as part of a simulation:

1. Ensure you have a simulation open (see To start an on-line analysis session:).
2. Ensure that the map(s) you want to see are active by checking their status on the ‘Data’
tab in the Object Directory
3. In the Object Directory, find the map you wish to view, right-click on its name and select
Show Map.
or
Right-click in the viewing window and select Maps > Cumulative High Density (or
other choice).
4. Play back or record the simulation (see Playing back a simulation or Record .RES track
events.
5. As the simulation runs, the colours of the selected map’s parameters and ranges are over-
laid on the simulation.
6. If you want to display the map’s legend, right-click in the viewing window and select Maps
> Show current map legend.
The legend is displayed vertically on the right-hand side of the viewing window but can be
dragged, repositioned and resized, like the example here.

© 2001–2017 Legion International Ltd 345

Legion SpaceWorks R6.5.0 User Guide

If you have used Alternative Value Ranges for Stairs, Escalators, or Zones, two or more
legends may be displayed within the Map legend window. You may need to resize the window
to display all the information.

Clearing the current map

To clear a currently running map of all its data at any point, right click in the workspace and
select Maps > Clear current map.

346
Legion SpaceWorks R6.5.0 User Guide

Custom Maps
The Analyser enables you to create custom Maps for use with pre-existing or custom Value
and Colour Ranges. To be able to do so, you first need to understand all the possible map para-
meters along with Value and Colour Ranges and Alternative Value Ranges.

Map parameters
All map parameters are contained on the ‘Parameters’ tab of the ‘Edit Map’ dialog box. You
may find that, depending on your choice of map, certain parameters are not relevant or avail-
able.

To view map parameters:

1. Click or select Analysis > Maps to display the ‘Edit Map’ dialog box.
2. Click on the map whose parameters you want to view in the list of maps in the left-hand
pane.
The following sections describe the various settings on the ‘Parameters’ tab.

Metric
This drop-down menu contains the following settings (the final four settings only appear if you
included this data when you saved the ‘res’ file or if you are running an on-line analysis):
● Occupancy–the number of Entities occupying or being in close proximity to a unit of
space at any one time.
● Occupancy Time–the cumulative length of time that Entities have occupied or been very
close to a unit of space.
The following Entity experience metrics are averaged for all Entities close to or inside a unit of
space.
● Speed–the average speed achieved by Entities close to or inside a unit of space.
● Entity Density –the density approximately computed for each Entity by drawing a cir-
cular area of 0.6 metres around them, estimating the accessible space inside that area
and then estimating the number of Entities inside that area including themselves.
● Total Distance–the total distance travelled by an Entity since the playback began.
● Inconvenience–a measure of walking experience comparing actual length of journey to
an Entity’s preferences.
● Frustration–a measure of walking experience comparing actual speed and time to an
Entity’s preferences.
● Discomfort–a measure of walking experience comparing perceived congestion to an
Entity’s preferences.
● Dissatisfaction–a ‘holistic’ measure of each Entity’s walking experience compared to
their respective preferences; it encompasses inconvenience, frustration and discomfort.

Area
Select the area of the model you want to apply a map to. This drop-down menu lists ‘Whole
Model’ along with any Analysis Zones you may have placed in the simulation. It also has the
option 'Alternative Regions Only', which you can select if you decide to apply Value Ranges to
portions of the map defined by Stairs, Escalators or Analysis Zones. See Using Alternative
Value Ranges for more information.
Having selected an area you can then choose to ‘Use smoothing’ or not:

© 2001–2017 Legion International Ltd 347

Legion SpaceWorks R6.5.0 User Guide

● Use smoothing–leave this box unchecked to prevent blending, thus keeping the range's
colours distinct (useful in Maps where the colours may represent a pass or fail against a
standard).
Check this box to display a gradation of the available colours (useful in Maps where spe-
cific ranges are not crucial).
The following illustrations show a Density Map with 'Use smoothing' unchecked (left-hand
map) and with it checked (right-hand map).

The orange represents Fruin's LoS 'E' which, in the left-hand example is quite expansive; with
'Use smoothing' switched on the map clearly illustrates that most of the area in fact
registered densities at the lower end of that Level of Service.

Zone of Influence
Legion maps are based on the concept of a ‘zone of influence’ which is effective around each
Entity. This is necessary to provide a precise definition of which Entities a unit of space should
consider when computing its occupancy and related metrics.

If, in any frame, a unit of space lies within the Zone of Influence of more than one Entity,
the reported value for that time-step is: an average over all Entities if the metric is an
experience metric; a total value if the metric is occupancy; and the most recent time when
the unit of space was occupied if the metric is occupancy time.
The two options for this parameter are Fixed Radius and Entity Trail:
● Fixed Radius–this setting means that the Entity will influence a circular area around it
defined by the radius you enter here. It is initially set at 0.6 metres but you can increase
or decrease this value.

This setting is appropriate for all Maps using Entity experience metrics: the colour of each
unit of space represents the experience an Entity would have if it were 'parachuted' into
that precise space.
● Entity Trail–this setting means that the Entity will influence the space it traverses. This
ensures that all areas an Entity passes over are represented in the map.

348
Legion SpaceWorks R6.5.0 User Guide

It is therefore appropriate for occupancy-based maps (i.e. Space Utilisation and Evacuation
Time maps).

Accumulation Method
This parameter refers to the method that each unit of space uses to accumulate data over
time, from the simulation start time (or restart time) to the current time-step. Some of the
methods require you to enter a value, such as a Cut-off value or a Decay coefficient. Accu-
mulation Method does not apply to Occupancy or Occupancy Time and is not available if either
of these are selected as the map's Metric.
The settings within this parameter are:
● Min–records the minimum value of any experience metric registered since playback
began.
● Max–records the maximum value of any experience metric registered within a unit of
space.
● Mean Value–records the mean value of an Entity experience metric registered within a
unit of space. This accumulation method disregards idle periods so it is good for identi-
fying spikes.
● Count Above the Cut-Off Value–records the number of time-steps from the start of the
simulation in which the value of an Entity experience metric exceeds your specified cut-off
value.
● Count Below the Cut-Off Value–records the number of time-steps from the start of the
simulation in which the value of an Entity experience metric falls short of your specified
cut-off value.
● None–values are not accumulated; they are overwritten when any new value is registered
within a unit of space.
● Exponential Decay–the values recorded by a unit of space decay over time according to
the Decay coefficient entered here (0.1 is a suitable coefficient for most situations).
● Mean value with zeros–means are calculated using zeros for each time-step–even
when no new data is recorded by a unit of space. This has a dampening effect because
peaks are counterbalanced by periods of inactivity. It is therefore useful for identifying
consistently high values.
● Weighted–The weighting factors defined in the associated weighted value range will be
used to scale the accumulated metric.

If you are creating a 'Weighted Map' and intend to select Weighted Value Ranges on the
'Value and Colour Ranges' and or 'Alternative Value Ranges' tabs, you must select
Weighted as the Accumulation Method.

© 2001–2017 Legion International Ltd 349

Legion SpaceWorks R6.5.0 User Guide

Exponential Decay and Mean value with zeros may slow down the performance of an ana-
lysis and are best applied to a Zone rather than the Whole Model.

Reset Interval
If you would like to clear an active map at certain time intervals, check the Enable box and
enter a value in seconds in the Reset map every n seconds box.
Continue to Value and Colour Ranges.

Value and Colour Ranges

Click on the Value and Colour Ranges tab on the ‘Edit Data’ dialog box. The Value or Colour
Range drop-down menu contains a list of available ranges that you can apply to the general
area of a map. The general area is the extent of the map not affected by Alternative Value
Ranges, if you choose to use them.

It will also contain any custom Colour and Value Ranges that you have defined.
Continue to Using Alternative Value Ranges.

Colour Ranges
Colour Ranges are useful when you don’t have specific value limits for metrics such as Occu-
pancy, Frustration and so on. By applying a colour range (rather than a value range) to a map,
the map will create a range of values dynamically and sort them into the various colour ‘bins’.
There are two built-in Colour Ranges:
● Default spectral progression–progresses from blue (low values) to red (high values).
This can be used with most Entity experience metrics for which low values mean ‘excel-
lent’ and high values mean ‘poor’.
● Default reverse spectral progression–progresses from red (low values) to blue (high
values). This can be used with speed for which low values mean ‘poor’ and high values
mean ‘excellent’.
Also, any custom colour ranges you have defined will also be listed.

350
Legion SpaceWorks R6.5.0 User Guide

Colour-to-Value Assignment
Because the range of values most metrics take (excepting speed and density) are dependent
on particular simulations, there is no single set of values that will work for all models. For this
reason, the Analyser enables you to determine ranges dynamically.
Select one of the following options:
● Assign colours to value range dynamically–the minimum and maximum time in
seconds is shown after a simulation has run. These values (usually ‘times’) correspond to
the minimum and maximum values registered anywhere in the model.
● Assign colours to the fixed value range–you can specify the range of values in the
min and max boxes.
It is useful to first generate a map using Assign colours to value range dynamically and
then select Assign colours to the fixed value range, enter min and max values and click
OK. The map will automatically redraw with the revised colours. You can also use the same
fixed value range for another scheme, to enable a like-for-like comparison.

Save the current assignment as a Value Range

This parameter enables you to take a colour range (a bespoke range or a pre-existing one)
and save it as a fixed Value Range, so that it can be used within other maps, analyses or
Entity Colour Schemes.
To save the assignment, enter a new name (if required) in the space provided and click the
Save button. If you want to delete the colour range you used to create the new value range
from, check the box labelled ‘Delete the original colour range’ before clicking Save.
See also Creating a custom Colour Range.
Continue to Map Exclusions.

© 2001–2017 Legion International Ltd 351

Legion SpaceWorks R6.5.0 User Guide

Map Exclusions
Sometimes it is not necessary to map every nook and cranny of a model. For those times
when you don't need to analyse and visualise certain parts of a simulation, there are para-
meters named 'Map Exclusions'. As you might expect, these are areas, selected or defined by
you, within which Legion map data will not be displayed, while, around it, the rest of the map
area is generated and displayed as usual.
All excluded data is still accumulated 'in the background', so you can remove these exclusions
if you like, to show the data recorded in these areas in a subsequent simulation. The areas
that can be excluded are Stairs (including their embedded Drift Zones); Escalators (and their
embedded Drift Zones); and other areas defined by Analysis Zones that you have placed in a
model. This latter exclusion zone can be any size, shape or orientation
Stair and escalator exclusion instructions apply to top and bottom sections of split objects and
to all landings and flights. Map Exclusions are available for all Legion maps: space- centric
maps and Environment maps. To exclude stairs and/or escalators from a map, there are
simple check-boxes within Edit Map dialog boxes. To exclude other areas (e.g. train carriages
or retail spaces or waiting areas), you can choose to exclude an area defined by a previously-
placed Analysis Zone. These zones will be available for selection from a drop-down list within
the Map dialog box.

You can use one, two or all three types of exclusion but if you wish to use a zone, you
need to have placed an Analysis Zone previously, in the appropriate area of your sim-
ulation.

For all 'Underground' maps, 'Exclude Escalators and 'escalator' Drift Zones' is auto-
matically selected because these maps are not intended to visualise the data from Escal-
ators.

To set Map Exclusions:

1. Open a custom or standard Map.
2. Click on the 'Map Exclusions' tab.
3. If you wish to exclude stairs from this map, check the box labelled 'Exclude Stairs and
'stair' Drift Zones'.
4. If you wish to exclude escalators from this map, check the box labelled 'Exclude Escal-
ators and 'escalator' Drift Zones'.
5. If you wish to exclude another area of the map demarcated by a previously placed Ana-
lysis Zone, click the Add button in the panel named 'Exclude by Analysis Zone'.
The 'Select Objects' dialog box is displayed.

352
Legion SpaceWorks R6.5.0 User Guide

6. Select one or more Analysis Zones by highlighting them and using the >, <, >> and <<
buttons to move them from left to right panels (and back again if required).
Your selection(s) will appear in the 'Map Exclusions' tab.

7. Click Apply to save your changes, or OK to save your changes and close the dialog box.

Creating a custom map

The following procedure describes how to create a new, customised map. For more inform-
ation, see Map parameters. This procedure can be used for creating 'Weighted Maps', using
weighted ranges.

To create a custom map:

1. Click or select Analysis > Maps to display the ‘Edit Map’ dialog box.
2. Select Environment Map or Map from the drop-down list on the left-hand side of the dia-
log box. See Environment Maps for more information.
3. Click the New button in the top left-hand corner of the dialog box.
A new map is added to the left-hand pane.
4. Type a meaningful name for this new map in the highlighted name field and press Enter.

© 2001–2017 Legion International Ltd 353

Legion SpaceWorks R6.5.0 User Guide

5. Set the 'Parameter', 'Value and Colour Ranges' and, if appropriate, the 'Alternative Value
Ranges' on each of the respective tabs.
6. Click Apply or OK to save the map.

If you are creating a 'Weighted Map' and intend to select Weighted Value Ranges on the
'Value and Colour Ranges' and or 'Alternative Value Ranges' tabs, you must select
Weighted as the Accumulation Method.

354
Legion SpaceWorks R6.5.0 User Guide

Environment Maps
Environment maps display the conditions registered inside a model and the Entities within it in
the case of fire. They use data from files generated by the FDS (Fire Dynamics Simulator)
fire-modelling software in order to display factors such as temperature, visibility and toxicity.
The Analyser can overlay data from FDS onto the model file as a map related to a specific
value and colour range. There are two types of data file available for use with an Environment
map:
● Slice file–this file contains data based on a 2-dimensional spatial model and recorded at
the specified height of a cross-section.
● Plot 3D–this file contains data based on a 3-dimensional model of a space.
These files must already have been generated using FDS, possibly in combination with the
Legion Model Builder (see Exporting a model for use with FDS). Each type of data file requires
you to set certain properties. These are dealt with respectively in the following two pro-
cedures.

To create an Environment map using a Slice file:

1. Click or select Analysis > Maps to display the ‘Edit Map’ box.
2. Select Environment Map from the drop-down list of available map types and click the
New button.
3. Enter a meaningful name for the new map in the highlighted name box (or click the
Rename button).
4. On the ‘Parameters’ tab, select Slice file as the Map data file type.
5. Click the Add button, locate the relevant slice file (.sf) and click Open.
The box labelled 'Units' automatically displays the relevant unit of the Slice file (for
example, M for metres, C for centigrade).

If you edit these units while the map is displayed, you will need to hide it and then display
it again to see your changes.
6. Repeat step 5 for any further Slice files (additional files should use the same Units as the
first file you added).
7. Highlight a file and then in the ‘Selection map size’ portion of the dialog box, enter the
appropriate dimensions for Bottom, Top, Left.Right.

If you added more than one Slice file, highlight each file and enter their dimensions.
8. Click on the Value and Colour Ranges tab.
9. Select a Value or Colour Range for the map.
10. If required, check the box labelled 'Use smoothing' so that colour values blend smoothly
into one another when displayed.
11. Click Apply or OK to save your changes.

To create an Environment map using a Plot 3D file:

1. Click or select Analysis > Maps to display the ‘Edit Data’ dialog box.
2. Select Environment Map from the drop-down list of available map types and click the
New button.

© 2001–2017 Legion International Ltd 355

Legion SpaceWorks R6.5.0 User Guide

3. Enter a meaningful name for the new map in the highlighted name box (or click the
Rename button).
4. On the ‘Properties’ tab, select Plot 3D as the Map data file type.
5. Click the browse button labelled 'Smoke-view file', locate the relevant Plot 3D file (.smv)
and click Open.
6. Enter values for these related boxes (floor and ceiling measurements are in metres):
◊ Floor
◊ Ceiling
◊ Metric (select from drop-down list)
7. To extract data from specified heights, you must add 'Plot3D heights'. Click the Add but-
ton.
The 'Height in Plot3D File' dialog is displayed.
8. Enter a height in the field.
9. Repeat steps 7 and 8 for any further heights whose data you want to examine.
10. Click on the Value and Colour Ranges tab.
11. Select a Value or Colour Range for the map.
12. If required, check the box labelled 'Use smoothing' so that colour values blend smoothly
into one another when displayed.
13. Click Apply or OK to save your changes.
When you have completed these procedures, you can display the Environment map during
playback in the same way you would any other kind of map.

356
Legion SpaceWorks R6.5.0 User Guide

Custom ranges
The following procedures describes how to create new, customised Colour Ranges and Value
Ranges for use with maps, analyses and Entity Colour Schemes.

Creating a custom Colour Range

This procedure describes how to create a custom Colour Range.

To create a custom Colour Range:

1. Click or select Analysis > Ranges to display the ‘Edit Data’ dialog box.
2. Select Colour Range from the drop-down list on the left-hand side of the dialog box.
3. Click the New button in the top left-hand corner of the dialog box.
A new Colour Range is added to the left-hand pane and the Properties pane appears on the
right-hand side of the dialog box.
4. Type a meaningful name for this new value in the highlighted name box and press Enter.
5. Click the Add button on the right of the dialog box to add a new colour to the range.
Repeat for as many colours as you need.
6. To change the default name of a colour, double-click to select it, type a new name in its
place and press Enter (or simply click outside of that particular cell). Repeat this step for
as many colours as you want to rename.
7. To change the default colour, double-click on the colour to display a drop-down palette of
optional colours.
8. Select a colour from the palette and then click outside of the coloured box to apply the new
colour. Repeat this step for as many colours as you want to define.
9. If you want to add extra colours, remove colours or move them up or down in the list, high-
light the relevant colour or colours and click the Add, Remove, Up or Down buttons.
10. Click Apply or OK to save the new Colour Range.

Creating a custom Value Range

This procedure describes how to create a new custom Value Range.

To create a custom Value Range:

1. Click or select Analysis > Ranges to display the ‘Edit Data’ dialog box.
2. Select Value Range from the drop-down list on the left-hand side of the dialog box.
3. Follow steps 3 to 8 of To create a custom Colour Range:.
4. For each bin inside the value range, double-click in its Upper Value column and enter a
value. The last bin will always be a ‘catch-all’, which is why a bin is created automatically
by the software as having an Upper Value of Infinity.
5. If you want to add, remove or move bins, highlight the relevant bin or bins and click the
Add, Remove, Up or Down buttons. Please note, however, that unlike colour ranges,
value ranges are always used in order of Upper Value, so any sorting you do will only
change the presentation unless you edit the Upper Values as well.
6. Click Apply or OK to save the new Value Range.

© 2001–2017 Legion International Ltd 357

Legion SpaceWorks R6.5.0 User Guide

Creating a Weighted Value Range

This procedure describes how to create a new Weighted Value Range. A Weighted Value Range
is one which takes into account different degrees of importance you may wish to apply to cer-
tain values. For example, when dealing with density, an Entity's experience of high density
(say 2 person/square metre) may be much more important to you than the experience of 0.25
person/square metre). With a weighted value range, you can give this higher level of density
a 'weight factor' which will be used when calculating a weighted map.

To create a custom Value Range:

1. Click or select Analysis > Ranges to display the ‘Edit Data’ dialog box.
2. Select Weighted Value Range from the drop-down list on the left-hand side of the dialog
box.
3. Follow steps 3 to 8 of To create a custom Colour Range:.
4. For each bin inside the value range, double-click in its Upper Value column and enter a
value. The last bin will always be a ‘catch-all’, which is why a bin is created automatically
by the software as having an Upper Value of Infinity.
5. For each band of your range, set a 'Weight Factor' (double-click in this column and enter a
value: the higher the value the more important the band).
6. If you want to add, remove or move bins, highlight the relevant bin or bins and click the
Add, Remove, Up or Down buttons. Please note, however, that unlike colour ranges,
value ranges are always used in order of Upper Value, so any sorting you do will only
change the presentation unless you edit the Upper Values as well.
7. Click Apply or OK to save the new Value Range.
8. If you want to generate a 'Weighted Map', create a custom map but ensure that you
choose 'Weighted' as its 'Accumulation Method'. See also Creating a custom map.

358
Legion SpaceWorks R6.5.0 User Guide

Underground Cumulative High Density Entity Colour

Scheme
This Entity Colour Scheme is designed for use with the four Underground maps available in the
Analyser. The colour range is based on the 2016 edition of Transport for London’s Station
Modelling with Legion SpaceWorks: Best Practice Guide and appears as shades of magenta
through pink. The new range will be automatically added to existing 'lgm' and 'ana' files, so
that it can be used in existing projects. When you load an older 'lgm' or 'ana' file, you will be
informed that it will be upgraded so that the new colour scheme is available should you wish
to use it.

Deleting, renaming and copying Colour and Value Ranges

This procedure describes how to delete, rename and copy ranges.

To delete, rename and copy ranges:

1. Ensure you have either the ‘Edit Colour Range’ dialog box or ‘Edit Value Range’ box open.
2. Click on the range you want to delete, rename or copy.
3. Click one of the available buttons in the top left-hand corner:
◊ Delete–removes the range from the list.
◊ Rename–enter the new name into the Edit Name dialog box and click OK.
◊ Copy–adds a copy of the range to the list; type a meaningful name for the copied
range in the highlighted name box and press Enter.
4. Click Apply or OK to save your changes.

Exporting Colour and Value Ranges

Once you have defined a Colour or Value Range, you can export it as a data file for use in
other analyses and scenarios.

To export a Colour or Value Range:

1. Ensure you have either the ‘Edit Colour Range’ dialog box or ‘Edit Value Range’ dialog box
open.
2. Click on the range you want to export.
3. Click the Export button.
The ‘Save As’ dialog box is displayed.
4. Select a location and type a name for the file.
5. Click the Save button

Importing Colour and Value Ranges

You can import Colour and Value Ranges from other analyses and scenarios. You can only
import Colour Range files into the ‘Edit Colour Range’ dialog box and Value Range files into the
Edit Value Range dialog box.

To import a Colour or Value Range:

1. Ensure you have either the ‘Edit Colour Range’ dialog box or ‘Edit Value Range’ dialog box
open.
2. Click the Import button.
The ‘Open’ dialog box is displayed.
3. Browse to the file you want to import, highlight it and click Open.

© 2001–2017 Legion International Ltd 359

Legion SpaceWorks R6.5.0 User Guide

4. If the file is successfully imported, the new range is displayed in the list of available
ranges.

360
Legion SpaceWorks R6.5.0 User Guide

Using Alternative Value Ranges

Alongside the Value Range you select for the general part of a map, you can also choose to
highlight areas within the general map and apply an Alternative Value Range to them. When
the map is generated it will display the principal range in the general part of the Map but it will
display results which reflect your Alternative Value Range in the other designated area or
areas.

This feature is not available if you select a Colour Range on the 'Value and Colour Ranges'
tab of a map's parameters.
There are many reasons why you might wish to do so. For example, you may wish to do this
when you have Stairs or Escalators in your model because pedestrian movement is different
on these objects to their movement on flat ground. Consequently, you may wish to apply one
range to most of your map but display Fruin's 'LOS Stairs' range for the area of the map occu-
pied by Stair objects.
The Analyser knows where Stairs and Escalators are, so you don't need to demarcate these
areas. However, for other areas of the model you will need to place an Analysis Zone so that
the Analyser knows which part of the space you wish to apply an Alternative Value Range to.
The following procedure assumes that your model contains Stairs, or Escalators, or has Ana-
lysis Zones in place.

To use an Alternative Value Range in a Map:

1. Open a custom or standard Map.
2. From the 'Area' drop-down list, select 'Whole Model', an Analysis Zone or 'Alternative
Regions Only' (this third option will disable the 'Value and Colour Ranges' tab. This is
because the generated Map will only use the Alternative Range you are about to select and
does not need to know the general Value Range.
3. If you selected 'Whole Model' or an Analysis Zone, click the 'Value and Colour Ranges' tab
and ensure that you have the correct Value Range selected (it must be a Value Range and
not a Colour Range).
4. Click on the 'Alternative Value Ranges' tab.
5. For Stairs, check the box labelled 'Use alternative Value Range for Stairs' and select a
range from the drop-down list (this will apply to all Stairs in the simulation).
6. For Stairs, check the box labelled 'Use alternative Value Range for Escalators' and select a
range from the drop-down list (this will apply to all Ecalators in the simulation).
7. For Zones, check the box labelled 'Use alternative Value Ranges for these regions' and
select Zones and Ranges like this:
◊ Click Add to add a new row for a Zone and its Value Range.
◊ Double-click in the 'Area' column and choose a zone from the drop-down list.
◊ Double-click in the adjacent 'Value Range' column and choose a range from the drop-
down list.
◊ Repeat the three steps above for further Zones and Value Ranges.
8. Click OK to save.

When you generate your map, the general area will reflect the Value Range you selected
on the 'Value and Colour Ranges' tab but Stairs, Escalators and any selected Analysis

© 2001–2017 Legion International Ltd 361

Legion SpaceWorks R6.5.0 User Guide

Zones will reflect your Alternate Value Ranges. The exception is if you selected 'Altern-
ative Regions Only' on the 'Parameters' tab, in which case only the areas specified in step
7 will display maps related to your selected ranges.

Overlapping Zones
There may be areas in your simulation where Analysis Zones overlap and where you may
have selected different Value Ranges for each of them on the 'Alternative Value Ranges' tab.
When the simulation is played back, and the maps displayed, you need to handle how the over-
lapping portion of the two zones is represented: should the Analyser display the Value Range
associated with Zone 1 or the one associated with Zone 2 in this region?
You can control this by ordering the rows in the 'Zones Value Range' portion of the dialog box.
The ranges are calculated and displayed in the order they appear in the list, from top to bot-
tom. So if Zone 1 is listed above Zone 2, the overlapping region will display Zone 1's Value
Range. If you would prefer the overlapping region to display Zone 2's Value Range instead,
highlight the Zone and then click the Up button until you have moved it above Zone 1 in the
list. To move a row down, highlight it and click Down.

362
Legion SpaceWorks R6.5.0 User Guide

Setting the map resolution

As mentioned earlier, the Analyser breaks down space within a simulation into separate units
and registers a value for each unit using Entities’ Zone of Influence settings. These units are
then assigned a colour according to the pertinent range. The dimensions of this grid are
referred to as the 'map resolution’. A lower map resolution will improve performance but will
make the map coarse and less informative.

To set the map resolution:

1. Click or select Analysis > Project Settings to display the ‘Edit Project Settings’ dia-
log box.
2. Enter a value for the Number of subdivisions per metre–the finest resolution is 10cm
by 10cm and the coarsest is 1m by 1m.
3. Click OK to save these settings.

© 2001–2017 Legion International Ltd 363

Legion SpaceWorks R6.5.0 User Guide

Saving the current view

While you are working with simulations and maps, you may wish to capture screenshots of
them for use in presentations or on web pages, etc. You can do so by manually saving your
current view at any time. You can also program this so it happens automatically (please see
Adding a Snapshot event).
Please note that this procedure assumes that you have run the simulation for the desired
period and that the map you wish to save had been activated prior to pressing Play.

To save the current view:

1. Ensure the simulation currently displays the view you want to save.
2. Right-click in the workspace and select Save Current View or select File > Save Cur-
rent View.
The ‘Save As’ dialog box is displayed.
3. Select a location and type a name for the file.
4. Select BMP Files, JPEG Files or PNB Files in the ‘Save as type’ field.
5. Click Save.

364
Legion SpaceWorks R6.5.0 User Guide

Saving all maps

This feature enables you to save all maps as graphic files in a specified location. Even maps
that are not currently displayed in the workspace are saved and you can include or exclude
specific maps using the Object Directory. The maps will be saved from the point within the
playback at which you select this feature.
The manual procedure is described below but you can also program this so it happens auto-
matically (please see Maps track events). This procedure assumes that you have run the sim-
ulation to its end and that the maps you wish to save had been activated prior to pressing Play

To save all maps:

1. On the ‘Analysis’ tab of the Object Directory, de-select any maps you want to exclude.
2. Right-click in the workspace and select Save All Maps or select File > Save All Maps.
The ‘Save All Maps’ dialog box is displayed.

You can also use the Timeline to schedule Save Map events, see Maps track events.
3. Click the Location browse button and specify a location.
4. Select one of the available file formats:
◊ JPEG (jpg)–specify the adjacent 'Quality' setting (10 is the highest quality and involves
the least compression).
◊ Windows bitmap (bmp).
◊ PNG (png).
5. Select the Image Size:
◊ Current view size
◊ Standard–select an image size from the adjacent drop-down menu.
6. Select a View:
◊ Current View–saves maps for the current view in the workspace.
◊ Whole model–saves maps for the whole model view.
7. Click OK.
A progress bar is displayed as the maps are saved.

© 2001–2017 Legion International Ltd 365

Legion SpaceWorks R6.5.0 User Guide

Printing a map
While you are working on simulations and maps, you may wish to print selected views of
them.

To print the map:

1. Ensure the simulation currently displays the details you want to print.

2. Click or select File > Print

The ‘Print’ dialog box is displayed.
3. Specify any printing preferences you may need to change.
● Select one of the following options:
◊ Fit model to page–prints the full extent of the simulated model.
◊ Maintain current view–prints only what you can currently see in the viewing win-
dow.
4. Click the Print button.

366
Legion SpaceWorks R6.5.0 User Guide

Deleting, renaming and copying maps

This procedure describes how to delete, rename and copy maps.

To delete, rename and copy maps:

1. Click or select Analysis > Maps to display the ‘Edit Data’ dialog box.
2. Select either Map or Environment Map from the drop-down list on the left-hand side of
the dialog box.
3. Click on the map you want to delete, rename or copy.
4. Click one of the available buttons in the top left-hand corner:
◊ Delete–removes the map from the list.
◊ Rename–enter the new name into the ‘Edit Name’ dialog box and click OK.
◊ Copy–adds a copy of the map to the list; type a meaningful name for the copied map
in the highlighted name box and press Enter.
5. Click Apply or OK to save your changes.

© 2001–2017 Legion International Ltd 367

Legion SpaceWorks R6.5.0 User Guide

18: Legion Analyser–Basics

In this chapter
This part of the guide introduces you to the Legion Analyser: its workspace, toolbars, menus
and the basic tasks you need to run your analyses.
This section covers the following topics:
● About the Analyser
● The Analyser interface
● Analyser components
● On-line and off-line analyses

368
Legion SpaceWorks R6.5.0 User Guide

About the Analyser

The Legion Analyser enables you to run, record, replay and analyse simulations using two
methods:
● On-line analysis–analysing while simulating (using an ‘ora’ file).
● Off-line analysis–analysing a recorded simulation (using a ‘res’ file).

On-line analyses can only be run on workstations with a valid Legion Simulator licence.
Both methods give you access to a wide range of metrics (density, speed, flow, journey time,
dissatisfaction etc.) and a rich array of display methods and outputs including maps, graphs
and tables.
The Legion Analyser creates an analysis (‘ana’) file as a template for storing the settings of all
maps, graphs and analyses you generate from an ‘ora’ file or the simulation’s ‘res’ file. In this
way, you can analyse many files using the same analysis template, which is a good way to
compare different scenarios.
The Analyser shares certain tools and features with the Model Builder and the Simulator. In
order to avoid repetition, you are referred to the appropriate sections of the guide as appro-
priate.

Until you draw, place and set up specific Analysis Objects, the Analyser assumes you want
to analyse the ‘Whole Model’ and offers suitable metrics to do so.

Basic concept behind the Analyser

The Analyser enables you to take your whole model, or a defined portion of it, and ask certain
questions tied to the objectives of your project. The following schema details the kind of
objectives that typically relate to the four main concerns that Legion analyses relate to:
● Feasibility studies
● Design and construction
● Renovation
● Operations

© 2001–2017 Legion International Ltd 369

Legion SpaceWorks R6.5.0 User Guide

Analysis questions
This is far from being an exhaustive list but the following represent the kinds of questions that
you can ask as part of an analysis:
● Can the venue cope with projected demand?
● What is the gateline or security check configuration that attains the best flow?
● What are the density levels at bottleneck points such at the bottom of stairs?
● What is the average waiting time at facilities in the peak time?
● Which operational scheme optimises individual visitor/customer experience?
● What is an appropriate location for retail units?
● Are vertical circulation elements effective at clearing a platform before the next train
arrives?
● What is the interchange time distribution between lines A, B and C?
● Can the venue be evacuated safely in the case of an incident?
● Will queues in front of facilities impede regular circulation?
By combining the Analyser’s in-built metrics, Analysis Objects and ranges, you can inter-
rogate your simulated space to get answers to all these questions. The most important thing
in the whole of a Legion SpaceWorks project is knowing which questions you need answered.

370
Legion SpaceWorks R6.5.0 User Guide

Legion Viewer files

Once you have set up and generated maps and analyses using a ‘res’ file, you can export them
as a Legion Viewer file (.lgv) for use in the Legion Viewer software.
The Legion Viewer is a standalone application that enables you to play back Legion simulations
and generate pre-defined analyses from a ‘Viewer file’ generated in the Legion SpaceWorks
Analyser. For instructions, please see the Legion Viewer User Guide.

Starting the Analyser

To start the Analyser:
1. Select Start > All Programs > Legion International > Legion SpaceWorks > Ana-
lyser.
On your very first startup you will be prompted to select a measurement system: imperial
or metric (this choice will be reflected in all measurements and analytical outputs).
2. Select either Metric or Imperial and click OK.
You can change the measurement system later in Tools > Options > Application Settings >
‘Unit system’.
The Analyser application starts.

© 2001–2017 Legion International Ltd 371

Legion SpaceWorks R6.5.0 User Guide

The Analyser interface

The picture below illustrates the user interface of the Analyser, with all its major components
labelled. Although you can customise the appearance of the interface, this illustration rep-
resents a typical layout after installation.

372
Legion SpaceWorks R6.5.0 User Guide

Analyser components
This section describes the various elements that go to make up the Legion Analyser.

Object Directory
Like the Model Builder, the Analyser has an Object Directory but the Analyser’s directory is
simpler in that it only has two tabs: ‘Objects’ and ‘Analysis’. As with the Simulator, you can
only use the ‘Objects’ tab to show or hide the objects in the simulation (while you can see
objects you cannot select, modify or delete them); the ‘Analysis’ tab enables you to view and
edit analyses, colour ranges, graphs, maps, Timeline settings and value ranges.
The objects and data are displayed in a tree structure and sorted alphabetically. Click on the
+ and – icons to expand or close levels of the Object Directory.
Each object in the directory has an eye icon to the left of its name. To hide an object in the
workspace, click on its adjacent eye icon to display a bar across it. To show an object again,
click the eye icon to remove the bar.

Toolbars
The Analyser has several toolbars, which are initially grouped together above the workspace.
The purpose of each icon is explained as specific tasks are described.
For information on repositioning or customising toolbars, see Repositioning toolbars and turn-
ing toolbars off and Creating a custom toolbar.

Main Menu Bar

The main menu provides access to all Analyser functionality. All procedures in this guide refer
to the main menu options and, when appropriate, the equivalent toolbar options.

Analysis viewing window

This space is similar to the Simulator’s viewing window. It is where you can view the analysis
in progress during playback and recording. Like the Model Builder, you can change the back-
ground to white if you prefer; see Changing the workspace background colour.

The Layers window

The Legion Analyser has its own layers called Analysis Layers but you can also view the other
Model Builder layers (CAD, Activity Object Layers) by using the Object Directory and Layers
Directory.
The Layers window enables you to add Analysis Layers, view the properties of existing layers,
add, duplicate and copy layers. It is displayed alongside the Analyser workspace and can also
be displayed by selecting View > Toolbars > Layers.
For further information about layers, see 12: Layers.

Graph Windows
These windows display dynamic graphs linked to active analyses. You can close down or add
new Graph Windows.

Output Bar
The Output Bar is designed to provide feedback on your analyses. It has five tabs:
● Information
● QA
● Search Results
● OD matrices
● GJT Summary (if enabled; see Journey Time and Generalised Journey Time reports)

© 2001–2017 Legion International Ltd 373

Legion SpaceWorks R6.5.0 User Guide

● Analysis
● Conditional Functionality
and functions in the same way as the Simulator’s, described in Output Bar.

Information
This displays a certain amount of feedback about the analysis you are currently running.
Right-click on this tab for menu options to Clear or Copy the contents of the ‘Information’
tab. It also has a Command bar where you can type certain commands to do with selecting,
placing and editing objects.

QA
This stands for Quality Assurance and displays any errors within your analysis.

Search Results
This tab displays any relevant results when you search for objects by using the Find tool. Res-
ults are listed by object and type.
Right-click on a listed object for the options to Edit Properties or Select Object(s).

OD Matrices
This tabbed window displays a dynamic table of origins and destinations related to the model’s
demand data. It shows demand totals for origin-destination pairs and grand totals for origins
and each of their destinations. When you playback or record a simulation, this table is dynam-
ically populated with the numbers of Entities reaching their various targets.
These numbers can be black or red: red numbers denote values that have been updated in the
current time-step; black numbers denote values that have not changed in the current time-
step. You can save this data as a comma separated value ('csv') file.

To save the OD Matrices:

1. Select File > Save OD matrix.
The ‘Save As’ dialog box is displayed.
2. Navigate to the place where you want to save the 'csv' file and click Save.

Journey Time
This tabbed window displays Summary information of Journey Time metrics. The content of
the grid is updated as a simulation is run or recorded. See Journey Time and Generalised Jour-
ney Time reports for further information.

Analysis
This tab of the Output Bar contains information about all and any Analyses within the sim-
ulation, including Analysis Objects, Accumulation Interval, Instantaneous results, Cumulative
results, Average results, and Average Advanced results.

Conditional Functionality
This tab of the Output Bar contains information about objects using Conditions in the sim-
ulation. For Direction Modifiers and objects with conditions or availability, the tab provides the
following information: Activity Object name, Availability Profile, Combining Method, Time
Before Action, Minimum Activity Period, Maximum Activity Period, Minimum time between
actions, Condition, Availability status, and whether the condition has been met at any point
within the playback.
The tab is useful for determining when conditions are met and whether objects are active at
any given time within a simulation.

374
Legion SpaceWorks R6.5.0 User Guide

Playback toolbar
The playback toolbar is linked to the Timeline (see below) and contains the controls you need
for playing, pausing, accelerating and restarting a simulation. See Playing a simulation.

Timeline
The Timeline enables you to schedule all the key activities that you need to take place during
the single playback of a simulation. Having done so, it also provides a visual snapshot of all
the activities you have set up and a scrolling ‘dial’ to inform you of what is happening and
when during the course of a playback. See About the Timeline for more detailed information.

Status Bar
The Status Bar at the bottom of the Analyser interface displays information regarding (from
left to right):
● The status of the application and ‘ToolTips’.
● The current position of your cursor (by X and Y coordinates).
● The length, angle and area of any analysis object you may be drawing or placing in the
viewing area.
● The state of Auto-save.
● The current time within the analysis.
● The Rate (0.000sec/sec) of the analysis, meaning how many seconds the Analyser is tak-
ing to process one second of ‘real time’ within the analysis.
● The number of Entities inside the model at the current time.

Arranging windows
For information on how to move and rearrange windows, please see Arranging windows .
When you have several graphs on display at once, you may find it necessary to reposition
them in order to see the simulation and the Object Directory.

Moving and Hiding components

The Object Directory, Layers Directory, Output Bar and Timeline can be moved an hidden as
described in Moving and Hiding Components.

© 2001–2017 Legion International Ltd 375

Legion SpaceWorks R6.5.0 User Guide

Upgrading Results Files

Improvements to Legion SpaceWorks mean that results files ('res') and Legion Viewer files
('lgv') are handled differently than in versions of the software pre-dating the release of R5. In
order to use older results files generated by these earlier versions of SpaceWorks, you are
required to upgrade them. You can upgrade these files in two ways:
● Project by project—when opening these files in the Analyser (or Viewer) as part of project
work.
● Collectively, using the Results Upgrade Tool—when you have many results files you wish
to upgrade before opening them in Legion applications.

Upgrading Results Per Project

As well as the process described in The Results Upgrade Tool, you can upgrade result files one
at a time when opening projects in the Analyser. When creating a new Analyser project, open-
ing an existing 'ana' file or changing project files, if SpaceWorks detects a results file ('res')
that needs to be upgraded it will ask you to upgrade before proceeding.
Creating a new Analyser project
When creating a new project, if the 'Data Source' selected is a 'res' file which needs to be
upgraded, you will be prompted to upgrade immediately. If you select 'Yes', the file will be
upgraded and the project will open. If you select 'No', the project is not created.
Opening an existing 'ana' file
If the existing 'ana' file is associated with a 'res' file which needs to be upgraded, you will be
prompted to upgrade immediately. If you select 'Yes', the file will be upgraded and the 'ana'
file will open. If you select 'No', the 'ana' file will not open.
Changing project files
When changing project files, if the 'Data Source' is a 'res' 'file which needs to be upgraded,
you will be prompted to upgrade immediately. If you select 'Yes', the file will be upgraded and
the project will open. If you select 'No', the project files will not be changed and in fact the
whole project will be closed.

When changing project files, always make sure to save your work first.

The Results Upgrade Tool

The Results Upgrade Tool enables you to select older results files ('res' and 'lgv') and upgrade
them singly or in groups. The upgrade process does not affect the original files, so there is no
chance of previous work files becoming damaged or lost. The following procedure explains
how to upgrade both 'res' and 'lgv' files.

To upgrade files with the Results Upgrade Tool:

1. Select Start > Legion International > Legion SpaceWorks > Results Upgrade
Tool.
The Results Upgrade Tool is displayed.
2. Click Add files.
3. Locate the files you wish to upgrade and click Open.
The file type 'Upgradeable Legion Files' is selected but you can filter the list using the
drop-down menu in the bottom right-hand corner. You may need to add files from different
locations depending on where your files are stored.
The Results Upgrade Tool will extract data from your selected files to verify them. A pro-
gress bar is displayed while this takes place.

376
Legion SpaceWorks R6.5.0 User Guide

If you have selected any files that do not need to be upgraded, you will be informed and
these files will not be added to your list of files to upgrade. All valid files are added to the
main 'Files to be upgraded' list and their status will be 'Pending'.

Summary of potential file statuses:

◊ Pending—ready to be upgraded
◊ Queued—waiting to be upgraded
◊ Processing—being upgraded
◊ Success—upgrade completed
◊ Failed to Start—failed before upgrade began
◊ Failed—failed during upgrade
◊ Cancelled—upgrade stopped by user
4. If you change your mind and wish to remove files, highlight it (or them) and click Remove
Selected.
5. If you want to upgrade your files one at a time rather than all at the same time (this
second method is automatically selected), check the box labelled 'Convert multiple items
sequentially'. Upgrading files at the same time can be demanding on PC resources, so you
may wish to try sequential upgrading if there are already large demands on your computer
(see the note below).
6. Click Upgrade pending files.
Processing will begin and, depending on system resources, files will be processed or
queued for processing later. Progress bars will indicate the percentage of work complete.
There is also a progress bar for 'Overall progress'. Successful upgrades will be highlighted
in green, failed upgrades in red.
7. If you decide to pause any upgrades, click each file's adjacent Pause button (if this button
reads 'Complete' instead, the upgrade has already finished).
8. If you wish to pause all upgrades, click Pause all. To resume, click Resume all.

© 2001–2017 Legion International Ltd 377

Legion SpaceWorks R6.5.0 User Guide

9. If you decide to cancel any upgrades, click each file's adjacent Cancel button (if this but-
ton reads 'Complete' instead, the upgrade has already finished).
10. If you wish to cancel all upgrades, click Cancel all.
11. To exit the Results Upgrade Tool, click the top right-hand X icon or press Alt+F4. If any
upgrades are still pending, you will be notified and given the option to continue exiting or
to cancel and finish the upgrade.

You can switch between 'sequential' and 'concurrent' processing during upgrades but be
aware of the following:
◊ When switching from sequential to concurrent, the tool will try to start as many queued
files as it can at the time. Any excess files will remain queued until an existing upgrade
completes, when the next item will be started.
◊ When switching from concurrent to sequential, the change is not immediate. Any
upgrades already being processed will continue to run concurrently. Only new
upgrades that will run sequentially

378
Legion SpaceWorks R6.5.0 User Guide

On-line and off-line analyses

The Analyser enables you to either run new simulations using the ‘ora’ file that you exported
from the Model Builder, or playback the simulation you recorded in the Simulator (the ‘res’
file). The former method is called ‘on-line analysis’; the latter ‘off-line analysis’. In both cases
you can interrogate your simulations using various Analysis Objects, metrics, maps and
graphs.
This part of the guide covers basic playback and recording; subsequent sections deal with
maps, graphs, analyses and the Timeline in greater detail.
This section deals with playing and recording a single simulation. Multiple simulation runs,
called ‘batch runs’, are also available and may save you time and effort. See Analyser batch
runs.

Choosing between on-line and off-line analysis

The advantage of on-line analysis is that it can save you time when sense-checking a model
because you can do so quickly without having to record a results (‘res’) file first. However,
each time you run an on-line analysis, the behaviour of Entities will be slightly different com-
pared to Entities in a ‘res’ file which are recorded and fixed.
You should save a ‘res’ file after you are satisfied that the model logic is robust and there are
no more modelling improvements you wish to make. Because large models may take time to
play back you are advised to save an accelerated ‘avi’ file at the same time. Saving a ‘res’
and ‘avi’ can be done in the Analyser or Simulator. When the analyses and maps in the Ana-
lyser have been deactivated, there will be no noticeable difference in performance between
the two applications. In this sense you can safely bypass using the Simulator.
If you decide to do an on-line analysis and record ‘res’ and/or ‘avi’ files in one go, then this is
likely to save a little time because processing is slightly more efficient than running a sim-
ulation first and then an off-line analysis. However, running an on-line analysis has the com-
bined memory requirements of simulation and off-line analysis so you should check that your
equipment’s physical memory limits are not reached–if they are, Windows will start using the
swap or ‘page’ file and the negative impact on performance will more than negate the small
initial saving.
In summary:
● Strictly speaking you don't ever have to use the Legion Simulator–everything it does can
also be done in the Analyser.
● If you want to use the Analyser just to record outputs, make sure to deactivate maps and
analyses to optimise performance.
● On-line analysis is most useful for sense-checking and finalising local modelling logic.
● You can save time by recording a ‘res’ and/or ‘avi’ file during an on-line analysis session
provided that you:
◊ Make sure that you are perfectly happy with your modelling logic first; otherwise you
will wait longer to discover an omission or error, compared to just saving an ‘avi’.
◊ Keep an eye on memory usage to ensure it does not exceed the available physical
memory on your computer.

On-line analysis
This form of analysis enables you to bypass the Legion Simulator by using your model’s ‘lgm’
and ‘ora’ files in the Analyser.

© 2001–2017 Legion International Ltd 379

Legion SpaceWorks R6.5.0 User Guide

Every time you run an on-line analysis, the Analyser runs the simulation anew, with vary-
ing results.

Starting an on-line analysis session

An on-line analysis uses your model file (‘lgm’) and an associated ‘ora’ file. The model file
provides the visual dimension of your model in the Analyser. When you start an on-line ana-
lysis session, you are required to open both files.

When starting a session, there is a chance you will be asked to choose between your
model's global Generalised Journey Time (GJT) weightings and the Analyser's
GJT weightings. This occurs if the settings don't match because the 'lgm' settings have
been changed, or if the 'lgm' was created in software earlier than SpaceWorks R5. The fol-
lowing dialog box will be displayed, where you can decide on which weightings to use in
your analysis session. Click one of the two buttons at the foot of the dialog.

To start an on-line analysis session:

1. Click or select File > New.

The ‘New Projects File’ dialog box is displayed.
2. Click the browse button to the right of the Model File box and select the appropriate ‘lgm’
file by navigating within the ‘Open’ dialog box.
3. Click the browse button to the right of the Data Source box and select the appropriate ‘ora’
file by navigating within the ‘Open’ dialog box.
4. If your simulation includes vehicles, check the box labelled ‘Load Aimsun simulation result
file’, click the related browse button and select the appropriate XML file.
See Showing vehicles in the Analyser for more information.
5. When you have selected your project files, click OK.
The model is displayed in the Analyser workspace.

6. Click or select File > Save and choose a name and location for the file. Make sure you
save it as an ‘ana’ file.
You are now ready to start your analysis session.

380
Legion SpaceWorks R6.5.0 User Guide

Off-line analysis
This form of analysis uses your model’s ‘lgm’ file and the ‘res’ file recorded in the Simulator.

Off-line analyses use the fixed, unchanging simulation that was recorded in the ‘res’ file
within the Analyser or Simulator.

Starting an off-line analysis session

The model file provides information about the model's visual elements and the ‘res’ file con-
tains information about Entity movement. When you start an off-line analysis session, you are
required to open both files.

When starting a session, there is a chance you will be asked to choose between your
model's global Generalised Journey Time (GJT) weightings and the Analyser's
GJT weightings. This occurs if the settings don't match because the 'lgm' settings have
been changed, or if the 'lgm' was created in software earlier than SpaceWorks R5. The fol-
lowing dialog box will be displayed, where you can decide on which weightings to use in
your analysis session. Click one of the two buttons at the foot of the dialog.

To start an off-line analysis session:

1. Click or select File > New.

The ‘New Projects File’ dialog box is displayed.

Ensure you load an ‘lgm’ file that was used to generate the ’res’ or ‘ora’ file that you are
using in your analysis session.
2. Click the browse button to the right of the Model File box and select the appropriate ‘lgm’
file by navigating within the ‘Open’ dialog box.
3. Click the browse button to the right of the Data Source box and select the appropriate ‘res’
file by navigating within the ‘Open’ dialog box.
4. If your simulation includes vehicles, check the box labelled ‘Load Aimsun simulation result
file’, click the related browse button and select the appropriate XML file.
See Showing vehicles in the Analyser for more information.

© 2001–2017 Legion International Ltd 381

Legion SpaceWorks R6.5.0 User Guide

5. When you have selected your project files, click OK on the ‘New Project Files’ dialog box.
The model is displayed in the Analyser workspace.

6. Click or select File > Save and choose a name and location for the file. Make sure you
save it as an ‘ana’ file.
7. You are now ready to start your analysis session.

382
Legion SpaceWorks R6.5.0 User Guide

Playing simulations
This section deals with topics concerning playing simulations within the Analyser.

Choosing a rendering engine

You can choose a rendering engine to guarantee the best quality display and highest per-
formance.

To choose a rendering engine:

1. Select Tools > Options.
2. The ‘Options’ dialog box is displayed.
3. Click to expand the tree labelled Display Preferences and click on Rendering Engine.
4. Select one of the two options:
◊ Render using native Windows renderer–uses your default Windows rendering
engine.
◊ Render using OpenGL–provides faster performance for PCs with new graphics cards
that support OpenGL hardware acceleration.
5. Click Apply or OK to save your changes.

Setting display preferences

Before running a simulation, you can specify certain preferences to ensure that it contains the
visual elements you want to display.

Default display preferences can also be set in Tools > Options > Display Preferences
Use the following icons to set display preferences.

Icon Name Use

Model Show or hide the border of your model

Scope

Accessible Show or hide the space accessible to Entities

Space (shaded grey)

Vehicles Show or hide Aimsun vehicles, if part of the sim-

ulation

Entities Show or hide Entities

Filled Fill the Entities with solid colour (easier to see but
Entities may slow down the simulation)

Preferred Show or hide indicators of Entities’ previous pos-

Direction ition and preferred direction from that position (see
the next topic “Last Step: Preferred Direction”)

Clones Show or hide cloned Entities (see Showing Clones)

© 2001–2017 Legion International Ltd 383

Legion SpaceWorks R6.5.0 User Guide

Last Step: Preferred Direction

When you choose to display the Last Step: Preferred Direction of Entities, the following ele-
ments are displayed.
● The cross marks the Entity’s position at the last time-step.
● The arrow to the centre of the Entity indicates the direction it would have preferred to take
at the last step.
● A yellow line joins the cross and the arrow (the longer the yellow line, the higher the walk-
ing speed of the Entity).

Playing a simulation
Use the following controls to play back a simulation file. Some controls are only available if
playback is paused or stopped.

Icon Name Use

Play Start the simulation at processing speed (fastest

possible)

Pause Pause the simulation (click again to resume)

Stop Stop the simulation

Record Begin recording files and data (see Playing and

recording using the Timeline)

Step For- Advance one time-step per click

ward

Step Back Go back one time-step per click

Accelerate Speed up the simulation

Decelerate Slow down the simulation (click this before starting

the simulation if you want to begin at slower than
processing speed)

Next Time Skip to the next Time Mark (if available, see Using
Mark Time Marks in Off-line simulations)

Previous Skip to the previous Time Mark (if available, see

Time Mark Using Time Marks in Off-line simulations)

Jump to Jump to the end of the simulation

end

384
Legion SpaceWorks R6.5.0 User Guide

Icon Name Use

Restart Return to the start of the simulation (you can only

do so after you have pressed Stop)

Saving computer memory

Occasionally, with very complex models, you may find the Simulator consumes almost all
your computer’s memory. To avoid this happening, you can put the Simulator into ‘Memory
saving mode’, which reduces the amount of memory needed by the Simulator.

To activate ‘Memory saving mode’:

1. Select Tools > Options > Application Settings.
2. Under ‘Memory saving mode’, check the box labelled Activate
The figure in the box labelled 'Flush Limit (MB)'.is the amount of memory that the soft-
ware will always have available for running SpaceWorks. There is no reason to change this
figure unless Legion support ask you to do so.
3. Click OK.

Logging playback information

You can record a log of every playback and recording you make. This log will save the key
information about each run, along with QA messages. The log is saved to a .'csv' file and can
be found in the same directory as the model you are analysing, with the same name as the
model in question. The logs apply to batch runs of more than one model too.

To set up logging:
1. Select Tools > Options > Logging

2. Check the box labelled 'Enable logging'.

© 2001–2017 Legion International Ltd 385

Legion SpaceWorks R6.5.0 User Guide

3. Click Apply to save your settings or OK to save and close the dialog.

Showing vehicles in the Analyser

If your simulation includes vehicles you need to load an Aimsun XML file when opening new
project files in order to display the vehicles. This XML file contains all vehicle positions over
time and enables Legion SpaceWorks to visualise traffic.
When loading project files, using the ‘Open Project Files’ (dialog box, you can now check the
box labelled ‘Load Aimsun simulation result file’, click the adjacent Browse button and nav-
igate to the appropriate Aimsun XML file.
With vehicle positions loaded, the Simulator can display traffic as part of the simulation.

Simulation Seed
As in the Simulator, you can specify a simulation seed to use while playing back or recording
from an ‘ora’ file. See Specifying the Simulation Seed for detailed information.

Tracking Entities
During a playback or a recording, you can select specific Entities to track within the sim-
ulation. This can be useful for checking that Entities are behaving as expected or intended.
You can set the length (and information conveyed by) of Entity Trails in Tools > Options (see
Setting the length of Entity Trails). You can also set up filters to track certain Entities.

To select Entities to track:

1. Click or select Playback > Play.

2. When Entities that you want to track enter the simulation, click or select Playback >
Pause.
3. Select Entities by holding down the Ctrl key and dragging the cursor around them. You
may need to pan or zoom within the display to isolate certain Entities.

386
Legion SpaceWorks R6.5.0 User Guide

Each selected Entity is now marked by yellow cross-hairs (to de-select Entities, hold down
the Shift key and draw around them to remove their cross hairs).

◊ If you also want to display the ‘trails’ of the Entities you are tracking, click or
select Display > Tracked Entity Trails. This displays a red trail behind each of the
Entities, which makes their pattern of progress easier to follow. If you want to change
the length of Entity trails, see Setting the length of Entity Trails.
4. Repeat step 3 for any other Entities you want to track.

5. Click or select Playback> Play to continue with the simulation.

To track Entities by filter:

1. Click the 'Track Entities by Filter' icon.
2. Create a filter as described in Entering advanced filters.
3. Click OK.
The software will automatically track any Entities captured by your filters.
4. If you want to exclude Entities captured by your filter, check the box labelled 'Stop track-
ing entities which satisfy this filter'.

Setting the length of Entity Trails

When tracking Entities, displaying their trails can help visualize their progress through models
and identify trends and problems with their journeys. Sometimes, however, the trails can
provide too much information. For example, you may find it useful to see where Entities have
just been, rather than where they've been over the last half hour. You can set the length
(meaning how many time-steps are visualised) of Entity Trails in Tools > Options.
To set the length of Entity Trails:
1. In the Simulator or Analyser, select Tools > Options > Entity Trail Options

© 2001–2017 Legion International Ltd 387

Legion SpaceWorks R6.5.0 User Guide

2. In the 'Entity Trail Length' box, select one of these options:

◊ Unlimited (entire trail will be shown for each tracked Entity)
◊ Not more than n steps (enter a number directly into the box or click the up and down
arrows to change the value – holding a click for longer will accelerate the progress of
numbers in either direction).
3. Click Apply or OK to save your changes.

Creating Entity Colour Schemes

Although Entity Types are assigned colours during the model building phase of a Legion pro-
ject, the Analyser enables you to create additional Colour Schemes based on pre- existing
value ranges.

Creating a Colour Scheme based on an available value range

This task enables you to set up an Entity Colour Scheme based on pre-existing value ranges,
which you have used in another Analysis or Map, or industry standards such as Fruin's Levels
of Service.

To use a Colour Scheme, you must activate it in the Object Directory.

To create a scheme based on an available value range:

1. Click or select Display > Entity Colour Schemes.

The ‘Edit Entity Colour Scheme’ dialog box is displayed.
2. Click New to add a new Colour Scheme to the left-hand list.
3. Type a name for the new scheme in the highlighted name box and press Enter.
4. Click on the Colours tab.

388
Legion SpaceWorks R6.5.0 User Guide

5. From the Metrics drop-down list near the bottom of the dialog box, select a desirable met-
ric.
6. From the adjacent Value Ranges drop-down list, select one of the available ranges.
7. Click the Create button.
This creates a range of named colours, which are listed in the main panel of the ‘Colours’
tab.
8. If required, you can rename these colours by double-clicking on their current names and
typing new descriptions. You may also change the colours by double-clicking their current
colours and selecting from the drop-down palette.
9. If you wish to refine the filtering for each colour, click on the Filters tab and for each col-
our in your range, add new filter settings. For more information, see 22: Advanced Fil-
tering.
10. Click Apply or OK to save your changes.

Creating a bespoke Colour Scheme

This section describes how to create your own Colour Scheme and apply filters to each colour.
The task is broken down into two procedures; the first describes how to create colours, the
second how to make them meaningful by applying filters.

To create the colours for a new Colour Scheme:

1. Follow steps 1 to 3 of To create a scheme based on an available value range:.
2. Click on the Colours tab.
3. For each colour you wish to add to the scheme, click the Add button once.
New colours with default names are added, under the headings Name and Colour.
4. To change the default name of a colour, double-click to select it and type a new name in its
place and press Enter. Repeat this step for as many names as you want to change.
5. To change the default colour, double-click on the colour to display a drop-down palette of
optional colours.
6. Select a colour from the palette and then click outside of the coloured box to apply the new
colour. Repeat this step for as many colours as you want to define.
7. If you want to add extra colours, remove colours or move them up or down in the list, high-
light the relevant colour or colours and click the Add, Remove, Up, or Down buttons.
See the next procedure.
This procedure briefly describes how to set up bespoke filtering criteria for each colour in a
colour range. For an in-depth discussion of advanced filtering techniques within the Analyser,
see 22: Advanced Filtering.

To apply filters to colours:

1. Click on the Filters tab.
2. In the Available Entity colours box, highlight one of the colours you just added. Notice
the four control boxes (plus Add button) beneath the Available Entity colours.

These enable you to define a bespoke filtering criterion to apply to a highlighted colour.
3. Set up a filter by either typing the conditions directly into the space below the control
boxes or by selecting options from their drop-down menus. Reading left to right:

© 2001–2017 Legion International Ltd 389

Legion SpaceWorks R6.5.0 User Guide

◊ Leave blank or select Not.

◊ Select an activity, metric or information type from the second menu (for example,
Activity, Density, Entity ID, etc.).
◊ Select equals (=), less than (<) or greater than (>).
◊ Depending on your selections so far, select an item from this menu or enter a specific
value if required (for example, a density level).
4. Click Add to verify the logic of your selections and to add them to the list of filters for that
colour.
If your criterion contains a logical error, a message is displayed beneath the list in red, for
example. You must correct any errors for your criterion to be saved.
5. Repeat step 3 to add more criteria to either the same colour or a new colour from your
range.
6. Click Apply to save your changes and OK to exit.

Please note that using colour schemes when playing back simulations can slow down per-
formance.

Viewing Entity details

During playback or recording you can view details of an individual Entity, including ID, Entity
Type, speed, direction, target and other details.

To view the details of an individual Entity:

1. Play or Record the simulation or analysis.

2. Click or select Playback > Pause.

3. Zoom into the Entity whose details you want to view.
4. Place the cursor over the Entity.
A pop-up panel displays detailed information for the Entity:

390
Legion SpaceWorks R6.5.0 User Guide

5. To close the pop-up, move the cursor away from the Entity.

Increasing simulation speed

Playback can be quite demanding on hardware resources; the more complex and detailed the
visuals are, the slower the simulation or analysis is likely to run.
There are several ways in which you can speed up the playback:
● Turn off all layers and objects in the Object Directory.
● Disable all unnecessary Maps and Analyses.
● Minimise visual elements using the options described in Setting display preferences.
● Minimise the Analyser while the simulation is running.
● Close down all other programs that might impinge on your hardware’s performance.

Saving the current view

While you are working with a simulation or analysis, you may wish to capture screenshots of
it for use in presentations or on web pages, etc. You can do so by saving your current view at
any time.

To save the current view:

1. Ensure the Analyser currently displays the view you want to save.
2. Right-click in the workspace and select File > Save Current View or select File > Save
Current View
The ‘Save As’ dialog box is displayed.
3. Select a location and type a name for the file.
4. Select BMP Files, JPEG Files or PNG Files in the Save as type field.

© 2001–2017 Legion International Ltd 391

Legion SpaceWorks R6.5.0 User Guide

5. Click the Save button.

Printing a view of an analysis

While you are working on an analysis, you may wish to print certain views of it.

To print a view of an analysis:

1. Ensure the analysis currently displays the elements you want to print.

2. Click or select File > Print

The ‘Print’ dialog box is displayed.
3. Specify any printing preferences you may need to change; select one of the following
options:
◊ Fit model to page–prints the full extent of the analysed model.
◊ Maintain current view–prints what you can currently see in the viewing window.
4. Click the Print button.
If you want to check how your printout will look before printing the analysis, use Print pre-
view.

To preview your printout:

1. Ensure the analysis currently displays the view you want to print.
2. Select File > Print preview.
3. A preview of your printout is displayed, with button-options to Print, Zoom and Close.
4. If you are happy with the preview, click the Print button to print the analysis.
If you want to change the contents of the printout, check or uncheck objects in the Object
Directory to the left of the preview.
5. Click the Close button to return to the Analyser.

Finding Objects in the simulation

The Find tool enables you to search for all objects and elements within the simulation accord-
ing to various criteria.
The Find tool within the Analyser works in exactly the way as it does within the Model Builder.
See The Find Tool for full details.

Renaming objects in the Analyser

As in the Model Builder, you can rename objects within the Analyser by using the Rename
tool. See Renaming Spatial Objects for full instructions.

392
Legion SpaceWorks R6.5.0 User Guide

Working with Analyser files

This section deals with files, objects, saving your work and related issues.

Auto-saving your work

The Analyser has an auto-save feature that you can configure to save your work in case of
power failures, unintentional exits from the software or system crashes. It can be found under
the Tools > Options menu.
This works in exactly the same way as the Model Builder’s auto-save feature, the only dif-
ference being that Auto-saved backup files in the Analyser have the extension “.ana_ as”.
Please see the topics starting with Auto-saving your work for full details.

When you exit the Analyser properly (regardless of whether you have saved your work or
not) any Auto-saved backup file for that session is deleted and will not be available for
recovery. The ’abk’ file will, however, still be available.

Checking for errors

In the same way that you can check for errors within a model in the Legion Model Builder, you
can check your analyses and Analysis Objects within the Analyser by using the QA (Quality
Assurance tool). See Checking for errors for full details.

Saving an analysis file (‘ana’)

When you have loaded model and data files, we recommend that you save your work in a new
analysis (‘ana’) file which will store analysis objects and results.

To save a new ‘ana’ file:

1. Select File > Save.
The ‘Save As’ dialog box is displayed.
2. Browse to a suitable location and enter a new name in the File name field.
3. Click the Save button.

Backups of Analyser files

The first time you save your an ‘ana’ file, Legion SpaceWorks automatically creates a backup
file called <filename>.abk (where <filename> is the name of your model) and saves it in
the same directory as your ‘ana’ file. This process works in the same way as that described
for the Model Builder in Backups of models.
Every subsequent time you save your ‘ana’ file, Legion SpaceWorks saves the earlier version
of it as an ’abk’ file and overwrites the previous ’abk’ file. This means that when you save
your model for the third time, the ’abk’ preserves the second saved version; when you save
for the fourth time, the ’abk’ overwrites the second ’abk’ file with the third saved version and
so on.

Remember that each saved ’abk’ overwrites the previous backup file.
This means you can restore previous versions of ‘ana’ files when needed: change the backup
file’s extension from ’abk’ to ‘ana’. and open within the Analyser in the usual fashion.
In the unlikely event that you want to turn this feature off, you can do so by following this pro-
cedure:

To turn off backups:

1. Select Tools > Options > Application Settings.
2. Uncheck the box labelled Generate backup when saving.

© 2001–2017 Legion International Ltd 393

Legion SpaceWorks R6.5.0 User Guide

3. Click Apply or OK to save your changes.

Opening an existing analysis file

This procedure describes how to open an analysis file (‘ana’) that you worked on, saved and
closed in an earlier session.

To open an existing analysis file:

1. Click or select File > Open.

The ‘Open Project Files’ dialog box is displayed with the relevant model and associated
files already selected.
2. If you want to change the pre-selected files, uncheck the box labelled Use embedded
data and go to step 3.
If you want to keep the pre-selected files, go to step 4.
3. Click the browse button to the right of the Model File and Data Source boxes and select the
appropriate ‘lgm’ and ‘res’ or ‘ora’ files.
4. Click OK to confirm.
Your simulation file is displayed within the analysis workspace.

Ana file properties

You can save important information about an ana file in the 'Properties' dialog box, which is
available on the File menu. This feature also provides a historical log of when the model was
saved and by whom. You can also set passwords to protect who can access and change the
file. The process is the same as for model files in the Model Builder; see Model File Properties
for full details.

Changing project files (model and data)

Whether you are running an on-line or off-line simulation, you can change the associated pro-
ject files at any point.

Make sure you save your work before changing project files.

To change project files:

1. Select File > Project files.
2. The ‘Project files’ dialog box is displayed, with the current project files listed.
3. Click the browse button to the right of the Model File or Data Source boxes and select the
appropriate ‘lgm’ and ‘res’ or ‘ora’ files.
4. Click OK to confirm. The Analyser is updated with the new files.

Using Help
Please see Using Help for full instructions.

Sending feedback
Please see Sending feedback for full instructions.

394
Legion SpaceWorks R6.5.0 User Guide

20: Analyses and Graphs

In this chapter
This part of the guide introduces you to the range of analyses and graphs you can apply to
your simulations in the Legion Analyser.
This section covers the following topics:
● About analyses
● About Analysis Objects
● Setting up analyses
● About graphs
● Customising graphs

© 2001–2017 Legion International Ltd 395

Legion SpaceWorks R6.5.0 User Guide

About analyses
The Legion Analyser enables you to interrogate a simulation by accessing the positions of all
Entities for every time-step in the simulation.
You can place Analysis Objects to specify areas of the space you want to ‘interrogate’ and then
link them to analyses and metrics that you have defined. The results of your analyses are dis-
played in the form of graphs, which you can save and print.

Fundamentals of Legion analyses

It is useful to think of Legion analyses as asking the following questions of a simulated space:
● Where do you want to analyse?
This is the ‘scope’ of the analysis and is defined by the Analysis Objects.
● Who do you want to analyse?
You can define this by filtering Entities in or out of the analysis.
● What do you want to measure?
You can apply a wide range of metrics to your defined analysis area and chosen Entities.
Once you have defined all these questions, you can then select graphs to display the results of
your analyses.
The following is a high-level procedure for running an analysis:

To run an analysis:
1. Identify the metrics you want to apply.
2. Place the relevant Analysis Objects.
3. Set up your analysis (including setting all parameters for the Analysis Objects.
4. Select graphs to display the results of your analysis.

Analysis metrics
The following metrics are available within the Legion Analyser (availability depends on the
Analysis Objects you place and whether you selected the bespoke Legion metrics within the
Simulator):
● Count Inside–the number of Entities inside an area.
● Egress–the number of Entities exiting an area.
● Ingress–the number of Entities entering an area
● Space Density–the size of an area divided by the number of Entities within it.
● Distance–Analysis Zone (distance travelled within the zone); two lines (distance travelled
from one line to the next); one line (distance between an Entity’s entrance into the model
and the moment they reach the line).
● Entity Count/Flow Rate–the number of Entities crossing a line.
● Entity Density–the density perceived by Entities within an area (the eventual figure is an
average of the perceived density of all Entities within a zone).
● Journey Time–the time taken for one or more Entities to cross two lines, one after the
other, or to cross an area defined by an Analysis Zone.
● Normalised Flow–the number of Entities crossing a line averaged over time and divided
by the length of the line.
● Speed–the speed of Entities crossing a line.

396
Legion SpaceWorks R6.5.0 User Guide

Space Density is potentially misleading because it is sensitive to the area over which it is
computed but insensitive to distribution patterns within the space. The metric Entity Dens-
ity is more accurate as it captures individual Entity density at all times.

In the Analyser, you can switch on 'Automated Flow Rate for Stairs and Escalators' to save
time during analyses. See Automated flow-rate analyses for Stair and Escalator objects.

Additional Legion metrics

If you exported the following ‘bespoke’ Legion metrics as part of a ‘res’ file, they are also
available in ‘off-line’ simulations.
● Inconvenience–a measure of walking experience comparing actual length of journey to
an Entity’s preferences.
● Frustration–a measure of walking experience comparing actual speed and time to an
Entity’s preferences.
● Discomfort–a measure of walking experience comparing perceived congestion to an
Entity’s preferences.
● Dissatisfaction–a ‘holistic’ measure of each Entity’s walking experience compared to
their respective preferences; it encompasses inconvenience, frustration and discomfort.

Journey Time metrics

If you enable Legion’s ‘Journey Time’ options, you can also use the following metric within
Analyses:
● Generalised Journey Time
See Journey Time and Generalised Journey Time reports for further information.

Analyses: metrics, objects, and outputs

This topic lists all the possible metrics and outputs for each of the Analysis Objects (including
'Entire model', which does not require an Analysis Object). Once you have decided on the met-
ric or metrics you wish to apply, you can work out which, and how many, Analysis Objects to
place.

Crowd Metrics
Click the following metrics to reveal a drop-down list of the Analysis Objects they require and
the types of graph which can be generated from the metrics.
Count Inside
Object: Analysis Zone
Graphs Available: Instantaneous, Average
Egress
Object: Analysis Zone
Graphs Available: Instantaneous, Cumulative, Average
Ingress
Object: Analysis Zone
Graphs Available: Instantaneous, Cumulative, Average
Space Density
Object: Analysis Zone
Graphs Available: Instantaneous, Average
Generalised Journey Time (GJT)
Object: Analysis Zone

© 2001–2017 Legion International Ltd 397

Legion SpaceWorks R6.5.0 User Guide

Graphs Available: Instantaneous, Average

Entity Count/Flow Rate
Objects: Analysis Line or Lines
Also, automated flow-rate analyses for Stair and Escalator objects.
Graphs Available: Instantaneous, Cumulative, Average
Normalised Flow Rate
Object: Analysis Line
Graphs Available: Instantaneous, Average

Entity Metrics
Click the following metrics to reveal a drop-down list of the Analysis Objects they require and
the types of graph which can be generated from the metrics.
Discomfort
Object: Analysis Zone
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Dissatisfaction
Object: Analysis Zone
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Distance
Objects: Analysis Zone, Analysis Line or Lines
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Entity Density
Object: Analysis Zone
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Frustration
Object: Analysis Zone
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Inconvenience
Object: Analysis Zone
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Journey Time
Objects: Analysis Zone, Analysis Line or Lines
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)
Speed
Objects: Analysis Zone, Analysis Line
Graphs Available : Instantaneous, Average, Advanced Average, Distribution (histogram),
Distribution over time (%), Distribution over time (values)

398
Legion SpaceWorks R6.5.0 User Guide

Count Remaining
If you are analysing a zone or the Entire model, the tab 'Count Remaining' is available. Here
you can instruct your analysis to generate a graph which displays the number of Entities
remaining in the zone or model over time. To do so, check the box labelled 'Enable the Count
Remaining statistic'.
If you are analysing the Entire model, all origin objects will be considered. If you are ana-
lysing a zone, you will be able to select a specific origin object. See Setting up analyses.

Notes
Journey Time replaces metrics previously known as Time Taken and Time Spent Inside..
Inconvenience, Frustration, Discomfort and Dissatisfaction are only available on-line or if
included as an option when the 'res' file was recorded.
Category definitions in histograms are dynamically adjusted when a Colour Range is used.
Histograms are now cumulative, not instantaneous as in earlier versions.

Showing or hiding Conditional Analyses and Graphs

In the Model Builder it is possible to set up one or many 'Conditional' analyses, which serve to
provide metrical data for Direction Modifiers using conditions, or other Spatial Objects that
use conditions to control their Availability. To de-clutter your workspace, you may like to hide
them from various areas of the Analyser to avoid confusion.
Hiding 'Conditional' analyses (and all associated graphs) will remove them from: the Object
Directory, the 'Edit ,<analysis>' dialog box, the Timeline's 'Save Graph' event dialog box, the
'Graphs' right-click menu, the 'Find' tool's results list, and the Legion Viewer export wizard.

To hide Conditional analyses:

1. Select Analysis > Project Settings.
2. To hide 'Conditional' analyses within the Object Directory, in the 'Edit <analysis>' dialog
box and from 'Find' search results, check the box labelled 'Hide conditional analyses'.
3. Click OK to close Project Settings

© 2001–2017 Legion International Ltd 399

Legion SpaceWorks R6.5.0 User Guide

About Analysis Objects

There are four types of Analysis Object in the Analyser (if you do not define Analysis Objects,
the Analyser assumes you want to analyse the ‘Whole Model’):
● Analysis Zone–this zone can be rectilinear or polygonal and encloses a defined space
within the simulation for analysis. In appearance it resembles a CAD object.
● Analysis Line–this is a single straight line with a ‘crossing-direction’ indicated by an
arrow (you can also specify that Entities crossing in both directions are considered).
● Analysis Poly-line–this is an angular line consisting of two or more straight lines, each
with a ‘crossing direction’ arrow (you can also specify that Entities crossing in both dir-
ections are considered).
● GJT Zone–this zone can be rectilinear or polygonal and encloses a defined space within
which Entity activities and their weightings are defined. It is used in the calculation of Gen-
eralised Journey Time in areas where the model's global weightings do not apply. For
information on using GJT Zones, see Generalised Journey Time Zones

The first three objects in this list also appear in the Model Builder to enable you to set up
Conditions for use with Direction Modifiers.
Analysis Objects are coloured orange to distinguish them from CAD lines and other types of
object. The illustration below shows, from left to right, an Analysis Zone, an Analysis Line and
an Analysis Poly-line:

A unique feature of Analysis Zones is that they can be drawn and placed according to 'vis-
ibility'. This means that, from a chosen viewpoint (a single point or a defined segment),
the shape and extent of an Analysis Zone can be calculated and placed according to how
visible an area of your model is from the chosen viewpoint.
This is useful if you want to analyse the impact of signs, information boards, cameras, or
advertisements within a site, while taking obstacles and interruptions to sight lines into
consideration. An Analysis Zone can be placed that covers just the area within which Entit-
ies can view a certain element of the venue, thus honing in on its effectiveness as a source
of information and influencer of movement. For more information, see Visibility-based
Analysis Zones.

400
Legion SpaceWorks R6.5.0 User Guide

Drawing and placing Analysis Objects

Analysis Objects are similar to the objects discussed in 11: Spatial Objects–Basics. You can
draw and place them in the same way that you would draw a CAD object or an Entrance, etc.
and the drawing tools are the same as described in To draw a Spatial Object: and Refining the
drawing of Spatial Objects. To draw a visibility-based Analysis Zone, see Visibility-based Ana-
lysis Zones.

To draw an Analysis Zone

1. Click the rectangular drawing icon , the polygonal drawing icon , or the visibility
drawing icon (if you click this, go to Visibility-based Analysis Zones).

2. Click the Analysis Zone icon .

3. Click in the workspace at the point where you would like to start drawing the object.
4. If you are drawing a rectangular object:
◊ Drag your cursor to define the size and shape of the object. When you are happy with
its proportions, release the left mouse button to complete and place the object.
If you are drawing a polygonal object:
◊ Move your cursor to the first vertex of the polygon you are drawing and click your
mouse. Now move the cursor to the next angle of the polygon and click to place that
point.
◊ Continue for as many points as the polygon contains and to complete the shape, right-
click your mouse and select Finish Boundary to complete and place the object.
The ‘Edit Analysis Zone’ dialog box is displayed.
5. Enter an appropriate name for the Analysis Zone and click OK.
The new zone appears in the Object Directory, in the Analysis Layer.
The following procedure describes how to draw and place Analysis Lines and Poly-lines.

To draw an Analysis Line or Poly-line:

1. Click either the Analysis Line or Analysis Poly-line icon.

2. Click in the workspace at the point you would like to start drawing the line.
3. If drawing a Line, drag the cursor to the point where you would like to place the other end
of the line and click.
or
If drawing a Poly-line, drag the cursor to the point where you would like to place the other
end of the first line and click; then move the cursor to the point where you would like to
place the end of the second line and click, and so on for each new line you would like to
place as part of the Poly-line.

Notice the direction of the arrow. Unless you specify otherwise, the line will only analyse
Entities moving across it in that direction. If you want the arrow to point to the left, start
drawing it from the bottom vertex; if you want the arrow to point to the right, start draw-
ing it from the top vertex.
The ‘Edit <Analysis Line/Poly-line>’ dialog box is displayed.
4. Enter an appropriate name for the Analysis Line or Poly-line.
5. If you want the line to analyse the movement of Entities crossing it in both directions,
check the box labelled Take into account entities crossing in both directions.

© 2001–2017 Legion International Ltd 401

Legion SpaceWorks R6.5.0 User Guide

6. Click OK.

Visibility-based Analysis Zones

A unique feature of Analysis Zones is that they can be drawn and placed according to 'vis-
ibility'. This means that, from a chosen viewpoint (a single point or a defined segment), the
shape and extent of an Analysis Zone can be calculated and placed according to how visible an
area of your model is from the chosen viewpoint.
This method limits the shape and size of the finished zone by viewing distance and viewing
angles: it stands to reason that physical objects can only be viewed within a certain distance
and between certain angles. This drawing method produces a shape, which reflects these phys-
ical and optical limitations.
This is useful when you want to analyse the impact of signs, information boards, or advert-
isements within a site, while taking obstacles and interruptions to sight lines into con-
sideration. An Analysis Zone can be placed that covers just the area in which Entities can view
a certain element of the venue, thus honing in on its effectiveness as a source of information
and influencer of movement.

When placing an Analysis Zone, you have the choice of calculating visibility from a single
point or a segment. A point is useful for small areas like a camera lens; a segment is bet-
ter for wider objects like information boards, or signs, or shop windows. The procedures
for both are slightly different.

To draw a visibility-based Analysis Zone for a point:

1. Click the visibility drawing icon (any icons and features not connected with visibility
drawing are disabled).

2. Click the Analysis Zone icon .

You are prompted to select 'Visibility for Point or Segment? [P]/S'
3. For a point, hit Return.
4. Click to place the visibility point. Choose the point whose visibility you want the Analysis
Zone to calculate and model. This should be the centre of the object (camera, small sign,
etc.). Use the pan and zoom tools as normal if required.

You can only place your point inside the model's accessible space. A dotted line is tem-
porarily imposed on the model, delineating areas of accessible space.
You are prompted to 'Move mouse to change distance'.
5. To set the distance from where you wish to calculate the visibility of the point, move the
mouse to the required place and left-click to fix it. By dragging the visibility arrow, you
can affect distance and direction. You can also type the distance coordinates (two figures
are needed) directly into the Command bar if you prefer. This screenshot shows the point
in the middle of a street Exit. The arrow has been extended to the required visibility dis-
tance.

402
Legion SpaceWorks R6.5.0 User Guide

You can now set the low and high angles from which your point can be seen.
6. To set the low angle, move your mouse to the required position and left-click.

7. To set the opposite (high) angle, move your mouse to the required position and left-click.

8. You can now review your settings and, if you need to make any adjustments, you can
'grab' the various distance and angle markers by clicking on them and moving them. They
are highlighted in red, as in this screenshot.

When you're happy with the shape of the Analysis Zone, hit Return. The ‘Edit Analysis
Zone’ dialog box is displayed.
9. Enter an appropriate name for the Analysis Zone and click OK.
The new zone appears in the workspace and in the Object Directory, in the Analysis Layer.
10. Repeat from step 2 for any more Visibility-based Analysis Zones you would like to place.
To exit 'visibility mode', click the icon again.

To draw a visibility-based Analysis Zone for a segment:

1. Click the visibility drawing icon .

© 2001–2017 Legion International Ltd 403

Legion SpaceWorks R6.5.0 User Guide

2. Click the Analysis Zone icon .

You are prompted to select 'Visibility for Point or Segment?'
3. For segment, type s and hit Return.
4. Draw the segment as you would draw a line of CAD or the side of any object. Use the pan
and zoom tools as normal if required. These screenshots illustrate the use of a segment
across a visible shopfront.

Drawing from left to right will create a directional arrow pointing up; drawing from right to
left will create a directional arrow pointing down; drawing top to bottom will create a dir-
ectional arrow pointing to the right; drawing bottom to top will create a directional arrow
pointing to the left. Also, you can only draw your segment inside the model's accessible
space. A dotted line is temporarily imposed on the model, delineating areas of accessible
space.
You are prompted to 'Move mouse to change distance'.
5. To set the distance from where you wish to calculate the visibility of the segment, move
the mouse to the required place and left-click to fix it. By dragging the visibility arrow, you
can affect distance and direction. You can also type the distance coordinates (two figures
are needed) directly into the Command bar if you prefer. This screenshot shows the seg-
ment drawn along one side of a retail unit. The arrow has been extended to the required
visibility distance.

You can now set the low and high angles from which your segment can be seen.
6. To set the low angle, move your mouse to the required position and left-click.

404
Legion SpaceWorks R6.5.0 User Guide

7. To set the opposite (high) angle, move your mouse to the required position and left-click.

8. You can now review your settings and, if you need to make any adjustments, you can
'grab' the various distance and angle markers by clicking on them and moving them. They
are highlighted in red, as in this screenshot.

© 2001–2017 Legion International Ltd 405

Legion SpaceWorks R6.5.0 User Guide

When you're happy with the shape of the Analysis Zone, hit Return. The ‘Edit Analysis
Zone’ dialog box is displayed.
9. Enter an appropriate name for the Analysis Zone and click OK.
The new zone appears in the workspace and in the Object Directory, in the Analysis Layer.
10. Repeat from step 2 for any more Visibility-based Analysis Zones you would like to place.
To exit 'visibility mode', click the icon again.

406
Legion SpaceWorks R6.5.0 User Guide

Setting up analyses
When you have identified the metrics you want to analyse and have placed your Analysis
Objects, you are ready to set up your analyses. You can set up many different analyses for
each simulation (or part of a simulation).
You set up analyses in the ‘Edit Analysis’ dialog box, which has three tabbed pages: ‘Scope’,
‘Entity Filter’ and ‘Metrics’. These pages correspond to the elements of an analysis mentioned
earlier in Fundamentals of Legion analyses.

To set up an analysis:

1. Click or select Analysis > Analyses to display the ‘Edit Analysis’ dialog box.
2. Click the New button in the top left-hand corner of the dialog box.
A new analysis is added to the left-hand pane.
3. Type a meaningful name for this new analysis in the highlighted name box and press
Enter.
4. On the ‘Scope’ panel, select one or more of the Space options:
◊ Entire Model–the analysis will apply to the whole of the simulated space.
◊ Zone–select the appropriate Analysis Zone from the drop-down menu.
◊ Line–select the appropriate Analysis Line from the drop-down menu.
◊ Two Lines–select the two Analysis Lines you want to include in this Analysis (one from
each of the two associated drop-down menus).

If you want to set up more complex filters, click the Advanced button. See 22: Advanced
Filtering for full details.
5. Click on the Entity Filter tab.
6. Filter for Entities in the manner explained in Specifying filter settings.
7. Click on the Metrics tab.
8. Enter a value (in seconds) for the Accumulation Interval . This value determines the
time period that values are averaged over when you display an ‘Average Values’ graph.
9. Tick as many Metrics options as you require from the available list.
Available metrics are dependent on the analysis options you selected on the ‘Scope’ tab
and whether you enabled Journey Time options. See also Analyses: metrics, objects, and
outputs.

The metrics in the top half of the 'Metrics' panel are those reported by the Analysis Object
or Objects (the space or environment demarcated by the objects), while those in the bot-
tom half are those reported by Entities within, or affected by, the Analysis Object(s).
These latter metrics may be associated with ranges. Link a metric to a range by double-
clicking on the Metric under the Value/Colour Range column heading and selecting one
from the drop-down menu.
10. If you would like to analyse the number of Entities remaining within your model, click the
'Count Remaining' tab (the tab is not available if you are using an Analysis Line or Lines).
If not, proceed to the final step.
11. Check the box labelled 'Enable the Count Remaining statistic'.

© 2001–2017 Legion International Ltd 407

Legion SpaceWorks R6.5.0 User Guide

12. Check the 'Origin Type's you would like to include in the count. If you selected 'Entire
Model', this list will not be available because all origins will be included automatically.
You can now generate a 'Count Remaining' graph for this analysis.
13. Click Apply or OK to save the analysis.

To generate 'Count Remaining' graphs for individual origins, you must add an analysis for
each (or select just one origin in step 12).

Deleting, renaming and copying analyses

This procedure describes how to delete, rename and copy analyses.

To delete, rename and copy analyses:

1. Click or select Analysis > Analyses to display the ‘Edit Analysis’ dialog box.
2. Click on the analysis you want to delete, rename or copy.
3. Click one of the available buttons in the top left-hand corner:
◊ Delete–removes the analysis from the list.
◊ Rename–enter the new name into the ‘Edit Name’ dialog box and click OK.
◊ Copy–adds a copy of the analysis to the list; type a meaningful name for this analysis
in the highlighted name box and press Enter.
4. Click Apply or OK to save your changes.

Automated flow-rate analyses for Stair and Escalator objects

Measuring and analysing flow rates on stairs and escalators is fundamental to most models.
Rather than manually drawing Analysis Lines and setting up analyses, you can tell the Ana-
lyser to automatically calculate flow rates for any Stair and Escalator objects in your model.
For each of these objects, a pair of Analysis Lines will be placed across the top and bottom
and an Analysis will be created. The Scope of such an automated Analysis will be the pair of
Analysis Lines, the Entity Filter will be 'All' Entities and the Metrics will be 'Entity Count/Flow
Rate' and 'Normalised Flow Rate'.
This procedure assumes you have a model open in the Analyser and that your model contains
stairs and/or escalators.

To set up automated flow-rate analyses:

1. Select Analysis > Create Stair and Escalator Analyses.
The 'Stair and Escalator Analysis Properties' dialog box is displayed.

2. Check one or both of the 'Analysis Line Placement' options (boarding and/or alighting),
depending on the focus of your analysis.

408
Legion SpaceWorks R6.5.0 User Guide

3. Set the 'Accumulation Interval'. This value determines the time period that values are
averaged over when you display an ‘Average Values’ graph.
4. Click OK.

© 2001–2017 Legion International Ltd 409

Legion SpaceWorks R6.5.0 User Guide

Journey Time and Generalised Journey Time reports

In the Analyser, you can produce detailed reports of Journey Time, Generalised Journey Time
and a summary of JT, GJT and Social Costs for each simulation run. Social cost in this context
is a monetised version of GJT in which pedestrian experience is given a financial value.
You can output JT and GJT results as 'csv' files or Excel files but summary files are always out-
put as Excel files. To read more about the content of the reports, see JT and GJT Reports.

To set up JT and GJT reports:

1. Select Analysis > Project Settings and click the 'JT and GJT Reports'.

2. To choose a location for your reports, click the 'Browse' button to the right of the field
labelled 'Path:'.
3. From the 'Open' dialog, navigate to the local or network drive where you would like to
save your reports and click OK.
4. Select the appropriate 'File type': csv or xls (note that Summary Reports are only saved
as xls files.
5. Select one or more of the available Report Types:
◊ Create a detailed Journey Time (JT) report during a run
◊ Create a detailed Generalised Journey Time (GJT) report during a run
◊ Create a summary GJT, JT and Social Cost report during a run
For more information about these reports, click the Describe Reports button.

410
Legion SpaceWorks R6.5.0 User Guide

6. You shouldn't need to change the 'Social Cost' values but if you wish to, enter new values
into the boxes:
◊ Multiplier (value of time) pence/minute
◊ Annualisation: Days in a year
7. Select a 'Time Format' for your reports:
◊ Second
◊ Day:Hour:Min:Sec
8. Click OK.

To view or change the Global GJT Activity Weightings, click on the tab labelled 'Global GJT
Weightings' and see GJT: Global Weightings.

JT and GJT Reports

Detailed and summary reports can be provided in 'csv' files or 'xls' files and are organised 'By
Activity', 'By Type' and 'By OD' (Origin‒Destination). Detailed reports can be saved as 'csv'
files but summary reports are always saved to 'csv' files.

Detailed Journey Time (JT) Report

An Entity-level report file containing:
● Entity ID
● Entity Type
● Final Destination
● Origin
● Time of entering the model
● Time of leaving the model
● For each Analysis with the JT metric enabled:
◊ First time an Entity is considered by the Analysis
◊ Journey Time calculated by the Analysis

In the case of two-line Analyses, wherever an Entity crosses the first line but leaves the
model before crossing the second line, its value will be reported as "n/a".

Detailed Generalised Journey Time (GJT) Report

An Entity-level report file containing:
● Entity ID
● Entity Type
● Final Destination
● Origin
● Time of entering the model
● Time of leaving the model
● Total journey time for each activity
● Total GJT for each activity
● Total visits to each GJT Zone
● Total journey time in each GJT Zone, per activity

© 2001–2017 Legion International Ltd 411

Legion SpaceWorks R6.5.0 User Guide

● Total GJT in each GJT Zone, per activity

Summary GJT, JT and Social Cost Report

This is a summary of JT, GJT and Social Cost arranged by Entity activity, Entity Type and Ori-
gin-Destination, containing:
● Number of Entities in each category
● JT
● GJT without CF (congestion factor)
● GJT with CF
● Journey cost
● Congestion cost
● Total cost
● Annualised total cost

Entity Types in the summary are the final Entity Types to which Entities leaving the model
belong. Be aware that during the course of a journey, an Entity may have its Entity Type
changed by a Direction Modifier.

412
Legion SpaceWorks R6.5.0 User Guide

GJT: Global Weightings

When calculating GJT, you can use Transport for London's (TFL) activity weightings, which are
the default values used by SpaceWorks, or you can use your own values. The TFL GJT weight-
ings for pedestrian activities are as follows:
● Walking—2.0 + CF ('CF' is an additional congestion factor)
● Waiting—2.5 + CF
● Delayed—2.5
● Queuing—3.4
● On Stairs Up—4.0
● On Stairs Down—2.5
● On Escalator Up—1.5
● On Escalator Down—1.5
You can change these weightings in your Analyser Project Settings (in the Model Builder and
the Analyser) but you cannot change the activities.

To change global GJT activity weightings:

1. Select Analysis > Project Settings.
In the Model Builder, this version of the 'Edit Project Settings' dialog box will be displayed.

In the Analyser, this version of the 'Edit Project Settings' dialog box will be displayed.

© 2001–2017 Legion International Ltd 413

Legion SpaceWorks R6.5.0 User Guide

2. Click on the 'Global GJT Weightings' tab.

3. Double click on the name of an activity.
The 'Set Activity GJT Weight' dialog is displayed.

4. Enter a new value in the box labelled 'Weighting='.

5. If you want to add the congestion factor, enter a value into the box labelled 'CF'.
6. Click OK.

The size of Journey Time files

Due to the limitations of spreadsheet packages like Excel, in rare instances generated Journey
Time files may exceed the possibilities of the data that can be contained within a single xls file
(or when Excel attempts to open a very large csv file). For instance, if a file contains more
than 256 columns or more than 65,536 rows, it cannot be opened within Excel.

414
Legion SpaceWorks R6.5.0 User Guide

Depending on the amount of analyses (columns) being run in a simulation and the number of
Entities (rows) involved, a Journey Time file may need to be split into two or more files.
Legion SpaceWorks handles this in the following ways.

Splitting csv files

The naming convention for a generated csv file is:
JT (.ana file name) HH-MM-SS DD-MM-YY_x_y.csv
where JT indicates that it is a Journey Time file, HH-MM-SS are Hours, Minutes and Seconds
and DD-MM-YY are Day, Month and Year. The element _x represents a split when there are too
many columns, _y represents a split when there are too many rows.
For a file named JT (Stairs.ana) 14-25-41 04-11-04_x_y.csv, the following files would
be generated, depending on the number of columns and rows it contains:

Number of files File names

One file, within maximum number of JT (Stairs.ana) 14-25-41

columns and rows permitted 04-11-04_1_1.csv

Two files due to excess columns JT (Stairs.ana) 14-25-41

04-11-04_1_1.csv
&
JT (Stairs.ana) 14-25-41
04-11-04_2_1.csv

Two files due to excess rows JT (Stairs.ana) 14-25-41

04-11-04_1_1.csv
&
JT (Stairs.ana) 14-25-41
04-11-04_1_2.csv

Four files due to excess columns and JT (Stairs.ana) 14-25-41

rows 04-11-04_1_1.csv
&
JT (Stairs.ana) 14-25-41
04-11-04_2_1.csv
&
JT (Stairs.ana) 14-25-41
04-11-04_1_2.csv
&
JT (Stairs.ana) 14-25-41
04-11-04_2_2.csv

The _x and _y indicators increase according to the number of extra files that are generated.

Large xls files

When an xls JT file exceeds the permissible amount of rows and columns, extra tabbed work-
sheets are automatically generated. These tabs are named Detail 1 Part 1 , Detail 2
Part 1, Detail 1 Part 2, Detail 2 Part 2 and so on, in a similar manner to the csv file
names listed above.

‘GJT Summary’ tab on the Output Bar

The Output Bar in the Analyser includes a tab named ‘GJT Summary’. This tabbed window dis-
plays Summary information in a grid similar to the following. The amount of details displayed
depends on the JT and GJT reports you chose to run. See Journey Time and Generalised

© 2001–2017 Legion International Ltd 415

Legion SpaceWorks R6.5.0 User Guide

Journey Time reports for more information.

The content of the grid is updated as a simulation is run or recorded but Entity data only
registers when they leave the model.

Generalised Journey Time Zones

When calculating the Generalised Journey Time for a model, GJT Zones can be useful when
the global GJT weightings are not applicable to certain types of Entity experience.
For example, you may need to model Entities waiting in a lift or held outside a station. For
these activities and areas within a model, you can place GJT Zones and define activities and
weightings. You can apply one weighting value to all activities within a GJT Zone of you can
add several different activities and define their weightings individually.
The following procedure assumes that you have drawn and placed a GJT in the relevant part of
a model.

To define a GJT Zone:

1. Enter a name for the GJT Zone in the 'Name' box.

416
Legion SpaceWorks R6.5.0 User Guide

2. Select either All activities (and proceed to step 3) or Selected activities (and proceed
to step 5).
3. If you want to apply your own defined weighting to every activity within the zone.select
All activities and enter a value in the box labelled 'Weighting='.
4. If you want to add a congestion factor for all activities, enter a value in the the box
labelled 'CF'. Proceed to step 11.
5. Click the Add activity button.
The Add a new GJT Activity dialog is displayed.

6. Select an activity from the drop-down list labelled 'Set the activity GJT weight for'.
7. Enter a value in the box labelled 'Weighting='.
8. If you want to add a congestion factor, enter a value in the box labelled 'CF'.
9. Click OK.

© 2001–2017 Legion International Ltd 417

Legion SpaceWorks R6.5.0 User Guide

10. Repeat steps 5 to 9 for any additional activities you'd like to add.
11. Set the zone's filters in the standard manner described in Specifying filter settings.
12. Click OK.

418
Legion SpaceWorks R6.5.0 User Guide

About graphs
The Legion Analyser enables you to view the results of your analyses in the form of dynamic
graphs, which you can customise, save and print. All graphs are stored on the ‘Analysis’ tab,
arranged in folders according to the analyses (incorporating their metrics) you may have
defined.
By default, the ‘Whole Model Ingress–Egress’ 'Reporting' analysis and its associated graphs
are always included in the Object Directory. The illustration also shows the analyses and
graphs associated with analyses (both 'Conditional' and 'Reporting') that were set up in the
Model Builder.
If you would like to hide 'Conditional' analyses, you can do so by following the instructions in
Showing or hiding Conditional Analyses and Graphs.

To display a graph, click on its adjacent red cross; this will open up a new graph window.
The following types of graph are available within the Analyser:
● Line graph

© 2001–2017 Legion International Ltd 419

Legion SpaceWorks R6.5.0 User Guide

● Column graph (histogram)

● Stacked column graph (stacked Histogram)

Line graph

In this type of graph the X axis represents Time; the Y axis varies. The graph updates itself at
every time-step, adding a line segment that joins the previous and current value.

Column graph (histogram)

The X axis represents a discrete number of ‘buckets’ defined within ranges; the Y axis shows
the percentage contribution of each category to the total number of Entities included in the
analysis.
The graph refreshes at each time-step, obtaining values for all Entities, mapping them onto
the range’s colours and creating bars that are proportional to the percentage calculated for
each bucket. The values in this kind of graph must relate to an Entity experience metric
(speed, density, etc.). If a colour range is selected then the categories are updated dynam-
ically by the software.

420
Legion SpaceWorks R6.5.0 User Guide

Stacked column graphs (100% and Values)

In the graph below, the X and Y axes represent the same values as those in the histogram
described previously but the values are stacked above each other up to a fixed total of 100%.
The values in this kind of graph must relate to an Entity-based metric (speed, density, etc.).

This kind of graph can also show the total number of Entities in each value range’s category as
a function of time:

Viewing graphs
Once you have placed your Analysis Objects and defined your analyses, you are ready to view
the results of your analysis in graph form. Graphs are viewed in the Analyser’s Graph Win-
dows, two of which are available when you first start the Analyser.

To view a graph:
1. In the Object Directory, click on the ‘Analysis’ tab.
2. Expand the Graph directory tree to locate the particular graph you want to view.
3. Click the white cross icon to the left of the graph’s name to display the graph.
4. A graph window opens below the workspace, displaying the graph you selected. If you
haven’t played back the simulation yet, the graph will not contain any data.
5. Play back or record the simulation. The graph is dynamically populated.

Zooming in and out of graphs

To zoom in on a specific area of a graph:
1. Click on the graph and drag a rectangle over the area you wish to enlarge.
The portion of the graph you selected will be expanded to fill the Graph Window. Try res-
izing the Graph Window to change the appearance of the enlarged section.
2. To return to the original view, click your mouse-wheel (or middle mouse button) once.

© 2001–2017 Legion International Ltd 421

Legion SpaceWorks R6.5.0 User Guide

Changing the type of graph

While a graph is displayed, you can change it to another type of graph, using the right-click
context menu.

To change a graph:
1. Right- click in the Graph Window of the graph you want to change. A menu containing
alternative types of graph is displayed, for example ‘Cumulative values’, ‘Average values
(over 30 seconds)’ or ‘Advanced Average values’ (3 line graph using Standard Deviation).
2. Select one of these alternatives.
The original graph is replaced by your chosen alternative, incorporating the existing data.

Clearing a graph
You can clear all data from a graph at any point while it is displayed.

To clear a graph:
● Right-click in the Graph Window of the graph you want to change and select Clear Graph
All data is removed from the graph. The Graph Window remains open and will display the
data of the next graph you activate.

Opening new Graph Windows

The first two graphs you display will occupy the default Graph Windows ‘Graph 1’ and ‘Graph
2’. If you wish to view more graphs you may need to open new windows to view them in.

To open a new Graph Window:

● Select File > New Graph Window.
or
Right-click in the Analyser’s workspace and select New Graph Window.
A new Graph Window is displayed.

Saving graphs
While you are working with graphs, you may wish to capture screenshots of them for use in
presentations or on web pages, etc. You also have the option to save them as data files.

Save graph events can also be set up on the Timeline; see Graphs track events.

To save a single graph:

1. Right-click in the Graph Window and select Save Graph.
The ‘Save As’ dialog box is displayed.
2. Browse to a suitable location and enter a name for the graph in the File name field.
3. Select an appropriate file type:
Data
◊ Comma separated Files (csv)
◊ Excel Files
Image
◊ JPEG (jpg)
◊ Bitmap (bmp)
◊ PNG (png)
4. Click OK.

422
Legion SpaceWorks R6.5.0 User Guide

Saving all graphs

This feature enables you to save all graphs as graphic files in a specified location. You also
have the option of saving their contents as data files. Even graphs that are not currently dis-
played in Graph Windows are saved and you can include or exclude specific graphs using the
Object Directory.

Save graph events can also be set up on the Timeline; see Graphs track events.

To save all graphs:

1. On the ‘Analysis’ tab of the Object Directory, select or de-select the graphs you want to
include or exclude.
2. Right-click in a Graph Window and select Save All Graphs or select File > Save All
Graphs.
The ‘Save All Graphs’ dialog box is displayed.
3. If you wish to generate data files, check the Generate data files box and select either
.xls file or .csv file from the adjacent options.
4. Click the browse button next to the Location box and specify a location for the saved files.

csv files can be loaded into the Analyser as graphs; xls files cannot be.
5. If you wish to generate image files, check the Generate image files box.
6. Select one of the available file formats:
◊ JPEG (jpg)–specify the adjacent Quality setting (10 is the highest quality and involves
the least compression).
◊ Bitmap (bmp)
◊ PNG (png)
7. Select the image Size parameters:
◊ Dimensions–choose from the adjacent drop-down list (includes User-defined, Fit A4
sheet and Fit PowerPoint Slide).
◊ Width–if you selected User-defined for Dimensions, select cm or pixels and enter a
value.
◊ Height–if you selected User-defined for Dimensions, select cm or pixels and enter a
value.
8. To save image files in the same place as the data files, check Use same location as for
data files.
To save image files in another location, ensure this box is unchecked and browse to a suit-
able location.
9. Click OK.
A progress bar is displayed as the graphs are saved.
If duplicate files are found, you will be asked whether you want to overwrite them.

Purging invalid graphs

The command 'Purge invalid graphs' can be used to remove any graphs that refer to missing
Analysis Objects. This situation can occur when a graph within an 'ana' file refers to Analysis
Objects in an 'lgm' file which have subsequently been removed. A QA message while loading
an 'ana' file will warn if such graphs are present. If so, type the command to remove the
graphs.

© 2001–2017 Legion International Ltd 423

Legion SpaceWorks R6.5.0 User Guide

Customising graphs
You can change the appearance and level of detail on existing graphs, create new graphs and
also combine different statistics and data on one Y-axis or by using a secondary Y-axis. The
things you can change, or define, are the following:
● Title
◊ Title
◊ Subtitle
◊ X-Axis title
◊ Primary Y-Axis title
◊ Secondary Y-axis
◊ Logo
◊ Time window
● Fonts
◊ Font type, size and colour for Titles, Subtitle, X and Y axis titles
● Appearance
◊ Legend–showing, hiding and placement
◊ Gridlines
◊ Y-axis scale
◊ Background colour
● Data series
◊ Series list
◊ Series details
These features fall into four categories: Titles, Fonts, Appearance and Data Series.

Changing the Titles of a graph

This procedure explains how to change the various titles associated with a graph. You can also
choose a different logo to display.

To change the titles of a graph:

1. In the appropriate Graph Window, right-click and select Properties.
or
In the Object Directory, click on the Analysis tab and double-click on the graph you want
to customise.
The ‘Edit Graph’ dialog box is displayed.
2. Type in new titles for the following, as required (or leave blank to use the default title for
each):
◊ Title
◊ Subtitle
◊ X-axis title
◊ Primary Y-axis title
◊ Secondary Y-axis title (if required)

424
Legion SpaceWorks R6.5.0 User Guide

3. If you want to change the logo displayed at the foot of the graph, click the Browse button,
navigate to the appropriate image file and click Open.
4. To change the period of time covered by the graph’s axes, select an option from the Time
Window drop-down list. These range from All simulation to 1 minute.
5. If you want to make further changes to the graph click Apply and then click on the 'Fonts',
'Appearance' or 'Data Series' tabs to continue.
Otherwise click OK to save your changes and close the ‘Edit Graph’ dialog box.

Changing the Fonts settings of a graph

This procedure explains how to specify fonts, colours and point sizes for the text in a graph’s
titles and axes.

To change the Fonts settings of a graph:

1. Follow steps 1 and 2 of Changing the Titles of a graph.
2. Click on the Fonts tab.
3. For each of the graph titles (Title, Subtitle, X-axis and Y-axis), select:
◊ Font
◊ Colour
◊ Size
from the adjacent drop-down lists.
4. If you want to make further changes to the graph click Apply and then click on the 'Titles',
'Appearance' or 'Data Series' tabs to continue.
Otherwise click OK to save your changes and close the ‘Edit Graph’ dialog box.

Changing the Appearance settings of a graph

This procedure explains how to show or hide a graph's legend and gridlines and how to change
its background colour. It also explains how to change the scale of the Y-axis.

To change the Appearance settings of a graph:

1. Follow steps 1 and 2 of Changing the Titles of a graph.
2. Click on the Appearance tab.
3. If you want to display a legend (or key) for the data series on your graph, check the 'Show
legend' box and select one of the placement options below: Left, Right, Top, Bottom.
4. To display gridlines along the graph’s axes, check 'X-axis', 'Y-axis' or both options.
5. To display a logarithmic scale along the Y-axis, check Logarithmic scale. This will create
a scale that increases in logarithmic intervals, which can be useful when plotting data that
increases rapidly or exponentially.

Creating a new custom graph

You can create and customise a brand new graph from the ‘Edit Graph’ dialog box. Once cre-
ated, you can define 'Titles', 'Fonts', 'Appearance' and 'Data Series'.

To create a new graph:

1. Right-click in a Graph Window and select Properties.
or
In the Object Directory, click on the Analysis tab and double-click on a graph.
The ‘Edit Graph’ dialog box is displayed.

© 2001–2017 Legion International Ltd 425

Legion SpaceWorks R6.5.0 User Guide

2. Click New. A new graph is created and added to the list of graphs.
3. Enter a suitable name for your new graph or leave the default name if preferred.
4. Define Titles, Fonts and Appearance as described in the previous three procedures.
5. To define Data Series, see Changing the Data Series of a graph.
6. Click Apply or OK to save your changes.

Changing the Data Series of a graph

This procedure explains how to plot different data series on the x and y-axes of a graph. You
cannot do this with any of Legion’s built-in graphs: you must create a new customised graph.
You can set data series by using available metrics and also by loading 'csv' data files from
other graphs (see Loading a graph from a csv file).

To change the Data Series of a graph:

1. Follow the steps in Creating a new custom graph.
2. Click on the 'Data Series' tab.

3. To add Data Series, click the Add button one or more times.
This adds one or more entries to the 'Series List' and makes certain associated fields avail-
able and active.

426
Legion SpaceWorks R6.5.0 User Guide

4. To set the parameters of a data series, first click on it in the Series List to highlight it.
5. If you would like the name of the data series to match the data on the axes, check the box
labelled 'Generate name from axes'. If you would like to name the series something else,
uncheck the box and type a different name into the 'Name' field.
6. Select a metric from the 'X-Axis' drop-down list ('Time' is usually the appropriate choice).
7. Select a metric from the 'Y-Axis' drop-down list.
8. If you want to plot data using the secondary y-axis, check the box labelled 'Use Secondary
Y-Axis'.
9. Select a 'Colour' for this data series to be plotted in.
10. Select a 'Series Type' for this data series (Step Line, Column, Bar).
11. If you wish to display 'Error Bars', check the associated box. Error bars are used on
graphs to indicate the full range of data from which each averaged plotted point is cal-
culated.
12. Select a colour for the error bars from the adjacent drop-down list.
13. For the graph's plot markers, select a style from the drop-down list labelled 'Markers'
(None, Square, Star).
14. Select a colour for the markers from the adjacent drop-down list.
15. If you would like to be able to hover your cursor over a line in the graph to see the value
at that point, check the 'Show Tooltips' box (this may slow down performance).
16. Click Apply to save your changes.
17. Repeat from step 4 for any further data series.
18. Click OK to close the dialog box.

© 2001–2017 Legion International Ltd 427

Legion SpaceWorks R6.5.0 User Guide

Loading a graph from a csv file

Any 'csv' file from a saved graph can be imported into the Analyser. This is useful when you
want to compare results from different analyses or venue designs.
The time interval of a loaded graph must match or fall within the time interval of the current
simulation. If a graph falls entirely outside this interval, no data will be loaded; if it falls
partly within this interval, only the data which does so will be displayed in the graph.

To load a graph from a 'csv' file:

1. Follow the steps in Creating a new custom graph.
2. Click the on Datasets tab.
3. Click the Load data.
The ‘Open’ dialog box is displayed.
4. Browse to the 'csv' file you want to load, highlight it and click Open.
5. The ‘Loading datasets’ dialog box is displayed.
6. Enter a start time for the loaded datasets.
7. From the drop-down list labelled ‘Define the names of the imported datasets’, select an
appropriate name.
The loaded datasets are listed in the ‘Available statistics’ pane.

Exporting Legion Viewer files

Once you have loaded a ‘res’ file and set up the analyses you require, you can export the
model CAD, entity positions, maps and graphs as a file that can be used in the Legion Viewer.
Legion Viewer files have the extension ‘.lgv’.

To export a Legion Viewer file:

1. Select File > Export Viewer File.
page 1/4 of the Legion Viewer Export wizard is displayed.
2. Click the ‘Browse’ button to open the ‘Save As’ dialog box.
3. Select a location for the Viewer file, enter a name in the ‘File name’ field and click Save to
return to the wizard.
4. For ‘Time Period’ select one of the following options:
◊ Export all–will export the whole simulation runtime
◊ Export section–enter ‘Start time’ and ‘End time’ to export a section of the simulation
runtime.
5. Click Next.
6. On page 2/4 of the wizard, indicate which maps you would like to export by highlighting
them and clicking the > button to move them into the ‘Selected’ pane (clicking >> will
move all maps at once).

Click < or << to remove items.

7. Click Next.
8. On page 3/4, expand the directory trees to indicate which graphs you would like to export
(you may need to expand several levels) and click > to move them into the ‘Selected’
pane (clicking >> will move all graphs at once).
9. On page 4/4, expand the directory trees to indicate which Entity colour schemes you would
like to export (you may need to expand several levels) and click > to move them into the
‘Selected’ pane (clicking >> will move all graphs at once).

428
Legion SpaceWorks R6.5.0 User Guide

10. Click Finish to begin the export.

11. A progress bar is displayed, indicating that the Analyser is ‘Exporting entity positions’.
The ‘lgv’ file can now be opened in the Legion Viewer.

© 2001–2017 Legion International Ltd 429

Legion SpaceWorks R6.5.0 User Guide

21: Analyser Timeline

In this chapter
This part of the guide describes how to how to use the Timeline to set up and schedule record-
ings and other important tasks like the generation of maps and the saving of graphs, images
and data.
This section covers the following topics:
● About the Timeline
● Default Tracks and Events
● Defining Events

430
Legion SpaceWorks R6.5.0 User Guide

About the Timeline

The Analyser’s Timeline works in the same way as the Simulator Timeline. For information on
the components of the Timeline and key tasks such as changing its appearance, etc. please
refer to the early sections of 17: Simulator Timeline.

Playing and recording using the Timeline

Once you have set up tracks and events on the Timeline you can decide to start the Timeline
running by pressing either ‘Play’ or ‘Record’. The two operations achieve different results.

When you press Play the Timeline simply plays back the simulation, reflecting any camera
events you may have set up and generating maps and graphs corresponding to your tracks
and events.

When you press Record the Timeline plays back the simulation as above but also saves
any Record .AVI or Record .RES events you may have set up along with saving images,
graphs, maps and data.

Disabling and enabling events before playback or recording

As you will see in the following pages, when setting up events you will have the option to
check a box labelled ‘Enable this event’. If checked, this option will ensure that the task will
be performed during playback or recording; if you leave the option unchecked, the task will be
ignored.
You can also enable or disable an event by right-clicking on it and selecting either Disable or
Enable. When doing so for instantaneous events, make sure you right-click on the vertical
bar to the left of the event icon before right-clicking.

Changing the Zoom level

You can zoom in and out from the Timeline to change the length of the labelled ticks running
along its length. You can set the ticks manually or by zooming in and out of the Timeline using
your mouse wheel.

To change the Zoom level:

1. Position your cursor over the Time-track and scroll the mouse button backwards and for-
wards to zoom in and out of the Timeline. Notice that the tick lengths change as you do so.
or
Right-click on the Time-track and select Set Zoom level.
The ‘Zoom Level’ dialog box is displayed.

© 2001–2017 Legion International Ltd 431

Legion SpaceWorks R6.5.0 User Guide

2. Select one of the available tick-length options (the smaller the time value, the closer the
zoom).
3. Click OK to save the new Zoom level.

432
Legion SpaceWorks R6.5.0 User Guide

Default Tracks and Events

Whenever you open a new model file with either an ‘ora’ or ‘res’ file in the Analyser, the fol-
lowing default tracks, with associated events, are added to the Timeline:
● Record .RES–this track contains a full-length Record .RES file event (only available if your
data source is an ‘ora’ file).
● Record .AVI–this track contains a full-length Record .AVI file event.
● Maps–this track contains a Save All Maps event in the last time-step.
● Graphs–this track contains a Save All Graphs event in the last time-step.
● Save 15-minute Underground maps–this track contains Save Map and Reset Map events at
15-minute stages.
● Save 60-minute Underground maps–this track contains a Save Map event at 60-minute
stages.
All valid track properties have been set and all you need to do to run these events is to press
the record button on the Timeline playback toolbar. All recorded files will be saved in the
same location as the current simulation data file.

The codec selected for the default Record .AVI event will produce a very large, uncom-
pressed file. You may wish to change this setting within the track’s properties.
You can change the properties of the default tracks and events, delete them, disable them,
change the default event colours and so on. These subjects are covered in the rest of this part
of the guide.

© 2001–2017 Legion International Ltd 433

Legion SpaceWorks R6.5.0 User Guide

Analyser Tracks
Tracks are the components of the Timeline that carry the events you want to occur in the
course of a simulation. An event may be, for example, the recording of analysis data, the
recording of an ‘avi’ or the saving of graphs.
Before you can add and specify an event, you need to add an appropriate track. There are six
tracks available within the Analyser’s Timeline:
● Maps–save or clear generated Maps at defined points within a simulation.
● Graphs–save graphs at defined points within a simulation.
● Screen Camera–change cameras during playback and also save ‘snapshot’ images of the
simulation at defined points.
● Record .AVI–record animated files for the whole or part of a simulation; also customise
the appearance of your ‘avi’ presentations.
● Record .RES–record ‘res’ files for the whole or part of a simulation.
● Record Entity Positions–record Entity Positions, for all or parts of a simulation, in an XML
file.

Setting Analyser 'Record .RES' and 'Record .AVI' Track Properties

The Record .RES and Record .AVI tracks enable you to name output files and specify where
they will be saved. The Record .AVI track properties are a little more complex than the Record
.RES properties.

Set the Record .RES track properties

To set properties for the Record .RES track:
1. Right-click on the Record .RES track header (in the area below the Playback toolbar) and
select Track properties.
The properties dialog box is displayed, open on the ‘Filename’ tab.
2. Click the browse button to the right of the box labelled ‘Filename to save to’.
The Windows ‘Save As’ dialog box is displayed.
3. Navigate to a location, enter a file name for the recorded ‘res’ file and Click Save.
4. Click on the 'Track info' tab to see a summary of this track. Using the checkbox labelled
'Enable this track' you can enable or disable it here (you can also do this on the track
header).
5. Click OK to save these settings.

Set the Record .AVI track properties

By setting Record .AVI track properties you can define the size and quality of the ‘avi’ file as
well as customise certain features of its layout and visual design, like logos, titles, fonts and
background colour.

To set properties of the Record .AVI track:

1. Follow steps 1 to 3 of Set the Record .RES track properties.
2. Click on the AVI tab.
The properties dialog box is displayed, open on the ‘Filename’ tab.
3. Click the browse button to the right of the box labelled ‘Filename to save to’.
The Windows ‘Save As’ dialog box is displayed.
4. Navigate to a location, enter a file name for the recorded ‘res’ file and Click Save.

434
Legion SpaceWorks R6.5.0 User Guide

5. Click on the 'AVI' tab.

6. Select one of the Video Size options:
◊ Standard size–if you select this option, choose one of the standard screen resolutions
from the associated drop-down list.
◊ Custom size–if you select this option, enter the required dimensions in pixels (e.g.
320 x 240) and select one of the three aspect ratios, which define the relationship
between height and width of the image: Free aspect, Lock aspect ratio to 4:3,
Lock aspect ratio to 16:9.
7. Select a codec from the Codec drop-down list (choose the one that best matches your
installed software).
8. Click and drag the Quality bar to set a value between 0 and 100 (100 being the best qual-
ity and least compression).
9. Click and drag the Speed bar to specify the speed you want the simulation to be recorded
at (the range is between 1x (real time) and 30x (30 times real time).
10. If you don’t want to change the layout of the avi, go to the next step.
If you want to change the layout of the avi, click the Layout button and see Designing the
Layout for the Analyser .AVI track.
11. Click on the 'Track info' tab to see a summary of this track. Using the checkbox labelled
'Enable this track' you can enable or disable it here (you can also do this on the track
header).
12. Click OK to apply these settings.

Designing the Layout for the Analyser .AVI track

The Layout Designer enables you to add and arrange visual elements to your avi files.

© 2001–2017 Legion International Ltd 435

Legion SpaceWorks R6.5.0 User Guide

To design the layout of your avi files:

1. To add any of the customisable items in the ‘Avi components’ toolbar, click and hold the
relevant icon and drag into the Layout Designer. Position and resize the items according to
preference.
2. To change the properties of a label, clock or logo, click on the item to select it and change
the properties in the left-hand panel of the dialog box. Change properties in the ‘Value’
column by entering text directly, browsing for files or selecting values from drop- down
lists.

Caption

Clock–change time format; font; text colour, contour line values and background col-
ours.

Logo–browse to select an alternative logo image; change logo colour, contour line val-
ues, background colour and transparency.

Legend–
◊ Legend–depending on which maps were selected for this event, and how many legends
they have, you can choose 'All' or specific legends from this drop-down list.
◊ Title–enter a 'Title'; choose 'Text Colour' and 'Font'
◊ Units–enter 'Units'; choose 'Text Colour' and 'Font'
◊ Labels– choose 'Text Colour' and 'Font'
◊ Contour–select 'yes' or 'no' to show or hide contour lines; choose 'Contour Line Colour'
◊ Background–choose a 'Background' colour and add a value for 'Background trans-
parency' (0 is opaque)

Graph–select the appropriate graph from the drop-down list labelled 'Value' in the
'Graph name' row.
3. To change the background colour of the workspace, select a colour from the drop-down
palette labelled Background Colour.
4. You can also align the various components in relation to each other; see Designing the Lay-
out for the Analyser .AVI track for details.
5. If you want to delete a removable item, click to select it and press Delete.
6. Click OK to save your layout settings.

Record .AVI events

This type of event records an ‘avi’ file from the point at which you place it along the Timeline.
You can also set up an event which records an ‘avi’ of the whole (‘full-length’) simulation.

Adding a Record .AVI event

To add a Record .AVI event:
1. Right-click on the relevant track at the point at which you want the event to start and
select Add a Record .AVI event.
The ‘Record AVI’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).

436
Legion SpaceWorks R6.5.0 User Guide

4. To record a map as part of the ‘avi’, select one from the drop-down list labelled Record
this map (or leave as ‘Entity Position Only’ if you don’t wish to record a map).
5. Select a camera perspective: either Active camera or Whole model.
6. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping
events.

Changing the start and end times of a Record .AVI event

Follow the procedure for Changing the start and end times of a Record .RES event.

Adding a full-length Record .AVI event

To add a full-length Record .AVI event:
1. Right-click on the relevant track and select Add a full-length Record .AVI event.
The ‘Record AVI’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. To record a map as part of the ‘avi’, select one from the drop-down list labelled Record
this map (or leave as ‘Entity Position Only’ if you don’t wish to record a map).
5. Select a camera perspective: either Active camera or Whole model.
6. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping
events.

Changing the start and end times of a Record .AVI event

Follow the procedure for Changing the start and end times of a Record .RES event.

Adding an Active Camera Record .AVI event

You can add one or more Active Cameras at any point along the Record .AVI track. These will
alter the views of the recorded ‘avi’ as the Timeline passes over them. Follow the procedure
in Setting an active camera.
Defining filename and location for the recorded ‘avi’
Follow the same procedure as Setting Track properties for Record .AVI and .RES tracks.

Specifying ‘avi’ settings for the Record .AVI event

See Setting Track properties for Record .AVI and .RES tracks for full details.

© 2001–2017 Legion International Ltd 437

Legion SpaceWorks R6.5.0 User Guide

Adding Tracks to the Timeline

To add events to the Timeline, you first need to add tracks. The following procedure deals with
adding a Record .AVI event but applies equally to the other types of track.

To add a track to the Timeline:

1. Right-click in the area below the Playback toolbar and select Create Track > Record
.AVI track.
The Track’s properties dialog box is displayed. For instructions on defining these prop-
erties, see the specific procedures for each track in Track Properties. You may set these
properties now or later.
2. Click OK. A new track called (in this case) ‘Record .AVI’ is added to the Timeline.
If you wish to change the name of the track, double-click on its name so that it is high-
lighted, type a new name and press Enter.

Track control icons

Each track in the Analyser Timeline has these three control icons:
Click to enable or disable the track. When the track is enabled, the green tick shows, when
disabled the tick is crossed out.
Click to lock or unlock the track. When a track is locked, you cannot make any changes to
it.
Click and select a colour from the pop-up palette for events on the track.

Status icons
Just to the right of the Track names, there is space for one of three icons which indicate its
status:

Ok to play back.

Warning issued which may need attention but will play back.

Error detected; will not play back until remedied.

Changing the position and height of tracks

● To reposition an event track, position the cursor over a track until it changes to this shape
then click and drag the track up or down within the list, and release.
● To change the height of a track, position the cursor over its lower boundary until it

changes to this shape and then click and drag downwards to change the height of the
track.

● To collapse the whole Timeline down to just the Time-track and Playback toolbar, click .
To restore it, click the icon again

Duplicating tracks
You can duplicate one of the tracks you have set up and add it to the list of tracks in the
Timeline. In the following procedure, a Save Graph track is used as an example.

To duplicate a track:
1. Right-click on the relevant track’s name and select Duplicate this track.
The duplicated track is added to the bottom of the list of tracks in the Timeline.

438
Legion SpaceWorks R6.5.0 User Guide

2. If you want to change the name of the duplicated track, double-click on its current name to
highlight, type a new name over it and press Enter.
3. If you want to change the properties of this duplicated track, right- click on its track
‘header’ (in the area below the Playback toolbar) to display its properties dialog box.

Deleting Tracks
To delete a track:
1. Right-click on a track and select Delete.
2. Confirm the action when prompted.
The track is deleted from the Timeline.

Track Properties
Each track you place on the Timeline has certain properties which need to be defined correctly
in order for playback and recording to occur and for specified events to run successfully. You
can access a track’s properties by right-clicking on it and selecting Track properties.
For instance, if you are saving data files (maps, graphs, snapshots, ‘avi’ files or ‘res’ files),
you need to define where you want to save the files, what you want to call the files and
whether you are saving one file or multiple files.
If these properties are undefined, or defined incorrectly, the track status icon will issue a
warning or an error, which will also be visible in the ‘QA’ portion of the Output Bar.
The following procedures describe how to set properties for the various Analyser Timeline
tracks.

Setting the Maps track properties

Maps track properties require you to define names and locations for any data files you want to
save for one or more Save Map events. This procedure assumes that you have the ‘Maps
Track Properties’ dialog box open.

To set Maps track properties:

1. Under ‘File Usage’, select one of the options:
◊ Save all data to a single file–select if you only intend to save a single map at one spe-
cific time within the simulation. Go to step 2.
◊ Save all data to multiple files–select if you intend to save two or more maps at one or
several times within the simulation. Go to step 5.
2. Next to ‘Single File Setup’, click the browse button to display the ‘Save As’ dialog box.
3. Navigate to the location you want to save the file, enter a name for the file and click Save.
4. Click OK to close the ‘Maps Track Properties’ dialog box.
5. Next to ‘Folder’, click the browse button and either select an existing folder or create a
new one. This is where your multiple files will be saved.
6. From the ‘Templates’ drop-down list, select one of the available combinations of inform-
ation to be saved as part of your filenames (these include Date, Time, Object Name, Event
Name, Model Time, Time). These template elements are added to the ‘Base filename’ box.

The ‘Example’ box at the bottom of the dialog box shows you how the files will be named.
7. If you wish to add your own filename prefix, enter it in the ‘Base filename’ box, taking
care not to overwrite the template elements which are listed there.
File iteration separators and numbering style are automatically defined.
8. Click OK to close the ‘Maps Track Properties’ dialog box.

© 2001–2017 Legion International Ltd 439

Legion SpaceWorks R6.5.0 User Guide

Setting the Graphs track properties

Graphs track properties require you to define names and locations for any data files you want
to save for one or more Save Graph events. The procedure is the same as that described in
Setting the Maps track properties.

Setting the Screen Camera track properties

Screen Camera track properties require you to define names and locations for any data files
you want to save for one or more Snapshot events. The procedure is the same as that
described in Setting the Maps track properties.

Setting Track properties for Record .AVI and ‘res’ tracks

The properties of these types of track can be set by following the procedures in Setting Ana-
lyser 'Record .RES' and 'Record .AVI' Track Properties.

Customising the ‘avi’ layout

The Layout Designer is accessible from the ‘AVI’ tab of the ‘Record .AVI Track Properties’ dia-
log box and enables you to organise the look of the recorded avi. Here you can change, resize
and reposition the model view, caption, clock, logo and legend. The layout here works as a
general template for all your avi files (and save map events; see Maps track events).
A Legend serves as the key to any map you may wish to display as part of the ‘avi’ and the
Statistical Component icon enables you to include graphs in the ‘avi’.
Legends will not be displayed if no map is displayed during simulation and for the Statistical
Component to work, you need to first generate the required graph (s) as part of the sim-
ulation.

To insert Legends or Statistical Components into an ‘avi’:

1. Ensure the Layout Designer is open.

2. To add map legends, click and drag into the Layout Designer; size and position as
required.
There are several legend attributes you can change:
◊ Legend–depending on which maps were selected for this event, and how many legends
they have, you can choose 'All' or specific legends from this drop-down list.
◊ Title–enter a 'Title'; choose 'Text Colour' and 'Font'
◊ Units–enter 'Units'; choose 'Text Colour' and 'Font'
◊ Labels– choose 'Text Colour' and 'Font'
◊ Contour–select 'yes' or 'no' to show or hide contour lines; choose 'Contour Line Colour'
◊ Background–choose a 'Background' colour and add a value for 'Background trans-
parency' (0 is opaque)

3. To add a Statistical Component (graph), click and drag into the Layout Designer; size
and position as required.
◊ From the 'Value' drop-down list, select a metric for the graph.
4. Make any other changes to the Layout Designer as required.
5. Click OK to save your changes.

Setting the Record Entity Positions track properties

Record Entity Positions track properties require you to define names and locations for any XML
files you want to save. This procedure assumes that you have the ‘Record Entity Positions
Properties’ dialog box open.

To set the Record Entity Positions track properties:

440
Legion SpaceWorks R6.5.0 User Guide

1. Next to ‘Filename to save to’, click the browse button to display the ‘Save As’ dialog box.
2. Navigate to the location where you would like to save the Entity position file, enter a
name, and click Save.
3. If you want to record Entity positions in a specified area covered by an Analysis Zone,
check the box labelled ‘Use region’ and select an area from the drop-down list labelled
‘Analysis Zone’.
4. If you want to change the default ‘Save frequency’ of 0.6 seconds, enter a new value in the
box labelled ‘Save entity positions every n seconds’.
5. Click OK. A new track called (in this case) ‘Record Entity Positions’ is added to the
Timeline.

Setting the Save 15-minute Underground Maps track properties

To set track properties:
1. Right-click on the Save 15-minute Underground maps track.
2. Under ‘File Usage’, select one of the options:
◊ Save all data to a single file–select if you only intend to save a single map at one
specific time within the simulation. Go to step 3.
◊ Save all data to multiple files–select if you intend to save two or more maps at
one or several times within the simulation. Go to step 7.
3. Under ‘Single File Setup’, click the browse button to display the 'Browse For Folder’ dialog
box.
4. Navigate to the location you want to save the file and click OK.
5. In the field labelled 'File title', enter your preferred name for the file.
6. Click OK to close the ‘Maps Track Properties’ dialog box.
7. Under ‘Multiple Files Setup’, to display the 'Browse For Folder’ dialog box.
8. Navigate to the location you want to save the file and click OK.
9. From the ‘Templates’ drop-down list, select one of the available combinations of inform-
ation to be saved as part of your filenames (these include Date, Time, Object Name, Event
Name, Model Time, Time). These template elements are added to the ‘Base filename’ box.

The ‘Example’ box at the bottom of the dialog box shows you how the files will be named.
10. If you wish to add your own filename prefix, enter it in the ‘Base filename’ box, taking
care not to overwrite the template elements which are listed there.
File iteration separators and numbering style are automatically defined.
11. Click the 'Track info' tab and check or uncheck the box labelled 'Enable this track' to
make the track active or inactive.
12. Click OK to save your changes.

Setting the Save 60-minute Underground Maps track properties

Follow the steps in Setting the Save 15-minute Underground Maps track properties.

© 2001–2017 Legion International Ltd 441

Legion SpaceWorks R6.5.0 User Guide

Defining Events
The following procedures show you how to set up events for each track in your Timeline. Note
that some tracks can hold more than one event, for example the Maps track enables you to
save maps and clear maps along the same track.
All procedures assume that you have already added the relevant type of track to the Timeline
(see Adding Tracks to the Timeline) and set all the necessary properties.
Events can be ‘instantaneous’ (lasting one time-step) or ‘ranged’ (having a longer duration).
Instantaneous events are represented by icons on the Timeline; ranged events are rep-
resented by solid horizontal bars of colour.

When placing events, check the red ToolTip for the exact time as you place your cursor
along the Time-track

Maps track events

You can set up events to save images of maps (and also to clear maps) at specified points
along the Timeline. For a map to be saved it must be currently available and active in the
Object Directory.

Adding a Save Map event

This procedure enables you to save all or selected Legion maps at a specified time in the sim-
ulation.

To add a Save Map event:

1. Right-click on the relevant Maps track at the point at which you want the event to start and
select Add a Save Map event.
The ‘Save Map’ dialog box is displayed.
2. If required, enter a name in the 'Event name' box.
3. To run this event when you next record using the Timeline, leave the Enable this event
box checked (if you don’t want to run this event in the next recording session, uncheck the
box).
4. Select one of the following option buttons: Save selected maps or Save all active
maps (if you choose the latter, proceed to step 7).
5. If you chose 'Save selected maps', click Select Maps.
6. In the 'Select Objects' dialog, select the maps you would like to save using the selection
buttons >, >>, <, << and click OK.
7. From the Use Camera drop-down list, select the camera from whose perspective you
wish to save your map or maps (see Creating a camera).
8. From the Image dimensions drop-down list, select one of the three options:
◊ Fit A4 sheet.
◊ Fit PowerPoint slide.
◊ User-defined–if you select this, enter 'Width' and 'Height' values (in pixels). The
default dimensions for this option are 1024 x 480 pixels. We recommend you keep
these, but you can enter different values.
9. Select one of the three Image Format options:
◊ JPEG
◊ Bitmap
◊ PNG

442
Legion SpaceWorks R6.5.0 User Guide

10. If you want to change the default layout of the saved map image, click the Layout button
and make any changes to the layout. See Designing the Layout for Map Events.
11. In the panel labelled 'Reuse map selection, camera, image dimensions and file format in
other Save Map events', select either:
◊ Apply to all maps – THIS track
◊ Apply to all maps – ALL tracks

Making a selection here means you can apply these Save Map instructions to either all
maps on this track alone or all maps on all tracks on the Timeline.
12. Click OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping
events.

Changing the start and end times of a Save Map event

Follow the procedure described in Changing the start and end times of a Record .RES event.

Adding a Clear Map event

This event will clear (reset) a generated map at a specified point within the simulation. This is
useful when you want to isolate maps for peak periods within a simulation or, for instance, if
you want to clear accumulated data between the arrival of trains.

To add a Clear Map event:

1. Right-click on the relevant Maps track at the point at which you want the event to start and
select Add a Clear Map event.
The ‘Clear Maps’ dialog box is displayed.
2. If required, enter a name in the Event name box.
3. To run this event when you next play back the simulation, leave the Enable this event
box checked (if you don’t want to run this event in the next session, uncheck the box).
4. To clear a single map, select Clear this map and from the adjacent drop-down list, select
the map you wish to clear.
or
Clear all active maps–this will clear all active maps.
5. Click OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping
events.

Designing the Layout for Map Events

The Layout Designer enables you to add and arrange visual elements to your saved map
images. When you are working with only one map, the saved results will match your designed
layout. When you are saving more than one map, the layout here works more as a general
template and your saved results should always be checked before including in a report.

To design the layout for Map Events:

1. From the 'Save Map' dialog, click the Layout button.
The 'Layout Designer' dialog is displayed.

© 2001–2017 Legion International Ltd 443

Legion SpaceWorks R6.5.0 User Guide

2. To add any of the customisable items in the ‘Avi components’ toolbar, click and hold the
relevant icon and drag into the Layout Designer. Position and resize the items according to
preference.
3. To change the properties of a label, clock or logo, click on the item to select it and change
the properties in the left-hand panel of the dialog box. Change properties in the ‘Value’
column by entering text directly, browsing for files or selecting values from drop- down
lists.

Caption

Clock–change time format; font; text colour, contour line values and background col-
ours.

Logo–browse to select an alternative logo image; change logo colour, contour line val-
ues, background colour and transparency.

Legend–
◊ Legend–depending on which maps were selected for this event, and how many legends
they have, you can choose 'All' or specific legends from this drop-down list.
◊ Title–enter a 'Title'; choose 'Text Colour' and 'Font'
◊ Units–enter 'Units'; choose 'Text Colour' and 'Font'
◊ Labels– choose 'Text Colour' and 'Font'
◊ Contour–select 'yes' or 'no' to show or hide contour lines; choose 'Contour Line Colour'
◊ Background–choose a 'Background' colour and add a value for 'Background trans-
parency' (0 is opaque)
4. To change the background colour of the workspace, select a colour from the drop-down
palette labelled Background Colour.

444
Legion SpaceWorks R6.5.0 User Guide

5. You can also align the various components in relation to each other; see Designing the Lay-
out for Map Events for details.
6. If you want to delete a removable item, click to select it and press Delete.
7. Click OK to save your layout settings.

Graphs track events

The Save Graphs event enables you to save generated graphs as images and also as data
files.

To set up a Save Graph event:

1. Right-click on the relevant track at the point at which you want the event to start and
select Add a Save Graph event.
The ‘Save Graphs’ dialog box is displayed.
2. If required, enter a name in the 'Event name' box.
3. To run this event when you next record using the Timeline, leave the Enable this event
box checked (if you don’t want to run this event in the next recording session, uncheck the
box).
4. Select one of the following option buttons: Save selected graphs or Save all graphs (if
you choose the latter, proceed to step 7.
5. If you chose 'Save selected maps', click Select graphs.
6. In the 'Select Objects' dialog, select the graphs you would like to save using the selection
buttons >, >>, <, << and click OK.
7. To save graphs as images, check the box labelled Save graph(s) image(s).
8. From the Image dimensions drop-down list, select one of the three options:
◊ Fit A4 sheet.
◊ Fit PowerPoint slide.
◊ User-defined–if you select this, enter Width and Height values (in pixels).
9. Select one of the three Image Format options:
◊ JPEG
◊ Bitmap
◊ PNG
10. To save graph data in data files, check the box labelled Save graph(s) data and select
from the following options:
◊ CSV file
◊ Excel file
11. If you want to apply these settings to all Save Graph events on this particular track, click
Apply To All.
12. Click Apply or OK to save the event.
If the event overlaps other events, an error message is displayed. See Overlapping events

Screen Camera track events

There are three events available on the Screen Camera track:
● Set Layer View–switch to a particular pre-defined Layer View at a defined point or points
along the Timeline.

© 2001–2017 Legion International Ltd 445

Legion SpaceWorks R6.5.0 User Guide

● Set active Camera–select a pre-defined camera from which to view the simulation play-
back.
● Add a Snapshot event–save ‘snapshots’ of the simulation as image files at specified points
along the Timeline.
Before you can set a Layer View, you need to have defined at least one in the Model Builder;
please see Layer Views.
Before you can set active Cameras, you need to define and name them, so they are available
for use. The next section explains how to do so.

Creating a camera
You can pan and zoom into specific areas of your simulation and save the view as a fixed cam-
era position. You can then use these cameras to make playback and recordings more
dynamic, pertinent and persuasive.
For example, when recording an ‘avi’ of your simulation, you could start from a wide camera
that shows the whole of your model, eventually zooming in on crucial areas of design or
examples of Entity movement.

Active Cameras can also be set on the Record. avi track, see Setting an active camera.

To create a camera:
1. Using the pan and zoom tools, arrange the view you would like the camera to show.

2. Click or right-click in the workspace and select Create camera based on the cur-
rent view.
The ‘Edit Camera’ dialog box is displayed with a new camera listed in the left-hand pane.
3. If you want to rename the camera, highlight the default name, type a new name and press
Enter.
4. To specify how the Analyser will switch to this camera during the course of a playback or
recording, select one of these options from the drop-down list labelled Mode of switch-
ing to this camera:
◊ Instant–the view will cut instantly to this camera.
◊ Coarse–the view will change gradually from the previous camera to this one.
◊ Smooth–the view will glide smoothly from the previous camera to this one.
5. Click Apply or OK to save your changes.
The Camera is added to the ‘Analysis’ tab of the Object Directory.
6. Repeat from step 1 to add any further cameras.

Activating a camera
To switch to a particular camera’s point of view within the workspace, right-click anywhere in
the workspace and select Activate Camera > Camera <name> . The workspace view will
change accordingly.

Updating an existing camera

If you want to change an existing camera’s viewpoint, first use the pan and zoom tools to
arrange the view that you would like the camera to show. Next, right-click in the workspace
and select Update Camera > Camera <name> . The existing camera whose name you
selected will now show the updated view when activated or used in a recording as an active
camera.
You can undo camera updates by pressing Ctrl + Z.

446
Legion SpaceWorks R6.5.0 User Guide

Setting a Layer View

If you created Layer Views in the Model Builder, you can create events on the Screen Camera
track which display these views during the course of playback. For instance you may have cre-
ated a Layer View containing Presentation CAD for trains or other vehicles.
If you want this Layer to be visible when passengers alight from trains in a simulation, you
may switch the Layer View on at times which match the arrival of trains. To turn the Layer
View off for the departure of trains, you will need to set Layer View events that revert to a
view which does not contain the vehicle CAD lines.

Layer Views are also visible in the recorded ‘avi’ file.

To set a Layer View:

1. Right-click on the Screen Camera track at the point at which you want the event to start
and select Set Layer View.
The ‘Layer View’ dialog box is displayed. The new event and time are displayed in the
Registered events box.
2. If required, enter a name in the Event name box.
3. To run this event when you next play back the simulation, leave the Enable this event
box checked (if you don’t want to run this event in the next session, uncheck the box).
4. From the Activate layer view drop-down list, select the relevant view.
5. Click OK to place the event on the track.
To switch to a different Layer View, repeat the process at the required point on the track.

Setting an active camera

Having created cameras, they are now available for use on the Screen Camera track and
Record .AVI events. You can set as many as you need on the respective tracks.
When you set active cameras on the Screen Camera track, the changes of camera are appar-
ent on screen as you play back or record the simulation.
When you set active cameras on a Record .AVI event, those particular camera transitions are
recorded only within the ‘avi’ rather than seen when you play back or record the simulation.
This procedure applies to Screen Camera tracks and Record .AVI events.

To set an active Camera:

1. Right-click on the relevant track at the point at which you want the event to start and
select Set active Camera.
The ‘Camera’ dialog box is displayed. The new event and time are displayed in the
Registered events box.
2. If required, enter a name in the Event name box.
3. To run this event when you next play back the simulation, leave the Enable this event
box checked (if you don’t want to run this event in the next session, uncheck the box).
4. From the Activate camera drop-down list, select the camera you would like to activate
at this point.
5. Click OK to save the event.
6. Repeat from Step 1 for any other active cameras you would like to set.

© 2001–2017 Legion International Ltd 447

Legion SpaceWorks R6.5.0 User Guide

Adding a Snapshot event

A Snapshot event is only available on the Screen Camera track. This event ‘takes a picture’ of
the simulation at a specified time and saves it as an image file. If you haven’t set any active
cameras on the Screen Camera track, the image taken will be of the whole model, otherwise
it will use the current active camera.

To add a Snapshot event:

1. Right-click on the relevant Screen Camera track at the point at which you want the event
to start and select Add a Snapshot event.
The ‘Snapshot’ dialog box is displayed. The new event and time are displayed in the
Registered events box.
2. If required, enter a name in the Event name box.
3. If you want this event to run in the next play or record session, check the box labelled
Enable this event (see also Disabling and enabling events before playback or
recording).
4. From the Image dimensions drop-down list, select one of the three options:
◊ Fit A4 sheet.
◊ Fit PowerPoint slide.
◊ User-defined–if you select this, enter Width and Height values (in pixels).
5. Select one of the three Image Format options:
◊ JPEG (jpg)
◊ Bitmap (bmp)
◊ PNG (png)
6. If you want to apply these image and format settings to all Snapshot events on this par-
ticular track, click Apply To All.
7. If you want to change the default layout of the saved map image, click the Layout button
and make any changes to the layout.
The Layout Designer works in the same way as the ‘avi’ Layout Designer, which is dealt
with in Customising the ‘avi’ layout.
8. Click Apply or OK to save the event.
9. Repeat from step 1 for any further Snapshot events you wish to run.

Record .RES track events

This type of event records a ‘res’ file from the point at which you place it along the Timeline.
For full details, see Record .RES events and related topics.

Changing the start and end times of a Record .RES event

You can change the range of an event by dragging and dropping or by specifying new start and
end times. See Changing the start and end times of a Record .RES event.

Adding a full-length Record .RES event

This feature enables you to add an event that will record the whole simulation. See Adding a
full-length Record .RES event.

Defining filename and location for the recorded ‘res’ file

Once you have placed a Record .RES track and scheduled an event, you can specify the name
and location of the saved file. See Setting Track properties for Record .AVI and .RES tracks.

448
Legion SpaceWorks R6.5.0 User Guide

Adding a Record Entity Positions event

When it comes to creating Record Entity Position events, you can choose to add a single event
that saves the positions for the entire runtime of the simulation, or you can add one or more
events that save positions for certain time periods within the simulation.
When adding an event to record a specific period of time, right-click on the track at the point
at which you want the event to start. However, you can change the start and end times of
events after you’ve placed them.

To create a ‘full length’ Record Entity positions event:

1. Right-click on the relevant track and select either:
◊ Add a full-length Record Entity Position event.
or
◊ Add a Record Entity Position event.
The ‘Record Entity Position’ dialog box is displayed.
2. If required, enter a name in the ‘Event name’ box.
3. If you want this event to run in the next record session, check the box labelled Enable
this event.
4. Click OK to save the event.
To run the event, click the ‘Record’ button on the Timeline and the XML file will be saved as
the playback runs. It is stored in the location you specified when setting up the track.

Overlapping events
If you attempt to add an event to a track within a time period that already contains similar
events, the ‘Resolve Event Overlap’ dialog box is displayed.

It lists the events that overlap and provides two solutions for resolving the conflict.

To resolve overlapping events:

1. Select one of the two following options:
◊ Merge the overlapping events into a single event–this consolidates the events into one.

© 2001–2017 Legion International Ltd 449

Legion SpaceWorks R6.5.0 User Guide

◊ Fit the new/moved/resized event around the conflicting event(s)–this resolves the
overlap problem by fitting the latter events around the existing event(s).
If you click Cancel the event or events you are attempting to place are not placed.
2. Click OK.

Selecting and moving instantaneous events

If you want to change the position of an instantaneous (one-off) event on the Timeline, click
and hold the vertical line to the left of the event’s icon and drag to a new position.

Specifying the colour of ranged events

To make different ranged events visually distinct, you can assign different colours to them.

To assign colours to events:

● To assign a colour to the ranged events in a track, click the Event Colour icon to the left
of the track and choose a colour from the available palette.
To define and use a custom colour, on the colour palette click on More to access the Win-
dows custom colour dialog box.

Deleting events
To delete an event:
1. Right-click on the event you want to delete and select Delete.
2. Confirm the action when prompted.
The event is deleted from the track.

Changing event properties

To change the properties of events, right-click on the relevant event on an event track and
select Properties to display the event’s properties dialog box

Setting the current time

When you are using a ‘res’ file as your data source, you are able to set the current time of the
Timeline by either dragging the Time-marker to the required point or by setting a specific
time through the ‘Set Current Time’ dialog box.

To set the current time:

1. Click and drag the green Time-marker to the required position along the Timeline and
release.
or
Right-click on the Time-track and select Set current time.
2. The ‘Set current time’ dialog box is displayed.
3. Enter a specific time in the box labelled Change current time to.

You can only set the time to one within the start and end times of the simulation.
4. Click OK.

Using Time Marks in Off-line simulations

When you have loaded a ‘res’ file as your data source, you are able to place ‘Time Marks’
along the Timeline. These function like bookmarks and enable you to jump forwards and back-
wards between them to focus on periods of particular interest within a simulation.

Adding Time Marks

To add Time Marks to the Timeline:

450
Legion SpaceWorks R6.5.0 User Guide

1. Right-click on the Time-track at the point at which you want to place a Time Mark and
select Add time mark.
A small blue clock face symbol is added to the Time-track.
2. Repeat step 1 to add further Time Marks.

3. To skip forwards or backwards between Time Marks, first press Stop and then click or
respectively. These buttons are only available when there are Time Marks ahead of
and/or behind the current position of your Time-pointer.

Deleting Time Marks

To delete one or more Time Marks:
● To delete a single Time Mark, right-click directly on it and select Remove time mark.
● serendipitideedoodaaTo delete all Time Marks at once, right-click anywhere along the Time-
track and select Remove all time marks.

Moving and docking the Timeline

You can move the Timeline by double-clicking on its side-label ‘Timeline’ and either leaving to
float or dragging it to the sides or top of the Simulator window; when you release the mouse
button, it will dock to the top or sides.

Closing the Timeline

You can close the Timeline by clicking the x icon on its side-label. To reopen the Timeline,
right-click on an empty area of the toolbar and select Timeline.

© 2001–2017 Legion International Ltd 451

Legion SpaceWorks R6.5.0 User Guide

22: Advanced Filtering

In this chapter
This part of the guide covers SpaceWork's advanced filtering capabilities. Advanced filtering
enables you to set up powerful bespoke filters to focus on precisely defined sets of Entities
within a Legion simulation.
This section covers the following topics:
● About advanced filtering
● Principles of advanced filtering
● Entering advanced filters

452
Legion SpaceWorks R6.5.0 User Guide

About advanced filtering

Advanced filtering enables you to enter very precise Entity filtering conditions, using Boolean
logic and operators. This precise filtering can be applied when setting up analyses and cre-
ating Entity Colour Schemes.
You can include or exclude very precise factors in order to pinpoint a certain condition, activ-
ity, or even a particular Entity.

The logic and techniques behind advanced filtering are similar to those discussed in Set-
ting up Conditions.

Principles of advanced filtering

Advanced filtering uses statements and three Boolean operators: AND, OR, NOT. Discrete
statements must be contained within square brackets and connected by one of the following
binary operators (listed here in increasing order of priority):
● OR–broadens a filter so that it contains any of the linked statements.
● AND–narrows a filter so that it contains only the linked statements.
In addition the operator NOT can be placed before any statement to exclude its findings from
the filter.
Statements can be nested within curved brackets to ensure they are processed in the correct
order, thereby providing accurate results. Nested statements work in the same manner as
mathematical equations that include parentheses. Terms inside the parentheses are searched
first, then terms outside the parentheses are added to the search (see the third example
below).

Examples of filters
Here are four possible filters.
◊ [Activity = "On Escalator"]
This will single out all Entities in the model using escalators at a particular moment.
◊ [Activity = "On Escalator"] And [Frustration > 10.0]
This will single out all Entities in the model using escalators and experiencing Frustration
greater than 10.0 at a particular moment.
◊ [Target = "Exit #002"]And Not ([Activity = "On Escalator"] Or [Activity =
"On Stairs"])
This will single out all Entities in the model at a particular moment which are targeted to
Exit #002, excluding those using escalators or stairs.
◊ [Target = "Exit #002"] And ([Activity = "On Escalator"] Or [Activity = "On
Stairs"])
This will filter for all Entities using escalators or stairs that are targeted to Exit #002.
If you were to omit the curved brackets from the fourth example, the filter would return all
Entities targeted to Exit #002 that are using stairs as well as ALL Entities that are using escal-
ators, regardless of their target.

Entering advanced filters

You may wish to apply advanced filtering when configuring a Spatial Object that filters; when
setting up an analysis (see Setting up analyses; when creating an Entity Colour Scheme (see
Creating Entity Colour Schemes or when tracking Entities by filter in a playback.

© 2001–2017 Legion International Ltd 453

Legion SpaceWorks R6.5.0 User Guide

All these tasks use dialog boxes which share the same tools, options and layout (this screen-
shot is taken from the ‘Edit Analysis’ dialog box).

There are two ways to enter an advanced filter: either use the four control boxes to build state-
ments, or type directly into the filter window.

A note on the Boolean constant "TRUE"

The word “TRUE” in the filter window means that if you don't set any particular filter at this
stage, the filter will capture all Entities. If you create a bespoke filter by using the filter con-
trol boxes and clicking the ‘Add’ button, then “TRUE” will be automatically deleted.
If you choose to type your filter directly (see Typing an advanced filter directly), we recom-
mend that you first delete “TRUE” from the filter window in order to avoid potential errors.

The filter control boxes

There are four control boxes containing the following possible selections from which filter
statements can be composed.

1st Box 2nd Box 3rd Box 4th Box

Blank/Not Activity = Delayed

454
Legion SpaceWorks R6.5.0 User Guide

On Escalator

On Escalator Down

On Escalator Up

On Stairs

On Stairs Down

On Stairs Up

Queuing

Waiting

Walking

Discomfort = Input box

Dissatisfaction <

Entity Density >

Entity Type = Input box

Final Destination = List of available objects

Frustration = Input box

<

>

Gender = Male

Female

ID = Input box

Inconvenience = Input box

<

>

Journey Time = Input box

Last Visited Target = List of available objects

Model Entry Time = Input box

Origin = List of available objects

Speed = Input box

© 2001–2017 Legion International Ltd 455

Legion SpaceWorks R6.5.0 User Guide

Target = List of available objects

Time in Model = Input box

Total Distance = Input box

Width = Input box

Entering a filter using the control boxes

This procedure describes how to enter the following filter using the control boxes:
[ Target = "Exit #002" ] And ([ Activity = "On Escalator" ] Or [ Activity = "On
Stairs"])

To enter a filter using the control boxes:

1. If the word “TRUE” is in the filter window, delete it.
2. From the second box, select Target. Note that the square bracket is automatically added.
3. In the third box, select the equals sign =
4. In the fourth box, select Exit #002.
5. Click the Add button to add the statement into the main filter window.
6. After the statement you just entered, type And followed by a space and an opening curved
bracket.
7. Using the boxes, select Activity = On Escalator and click Add.
8. Type OR followed by a space.
9. Using the boxes, select Activity = On Stairs and click Add.
10. Type the closing curved bracket.
11. Click OK or Apply to activate the filter. Please only do so when the statement is free of
errors; otherwise the statement will be discarded and replaced by “TRUE”.

Any errors are indicated below the filter window in red, with a hint as to the nature of the
error. Please remedy all errors as your filter statements will not be saved if errors exist.

Typing an advanced filter directly

To enter the filter setting directly, position your cursor in the filter window and type the con-
ditions using legitimate terms from the table here. There are certain conventions you should
follow:
● Each discrete statement should be contained within square brackets
● If you are nesting several statements, remember to open and close curved brackets in the
correct sequence
● Text strings (like “On Escalator”) need to be contained in quotation marks
● Enter a space between keywords, signs and values
● Use relevant and logical signs, for example it makes no sense to use a less-than sign when
selecting a Target
The ‘Advanced Filter’ dialog box automatically checks the syntax of your statements as you
enter them and highlights the place of any errors.

456
Legion SpaceWorks R6.5.0 User Guide

In the case of Gates, ensure that you enter the correct Gate Side as a Target ('Switch'
gates can have two sides: IN and OUT). A correctly formatted advanced filter for a Gate
with two sides would look like the following.

© 2001–2017 Legion International Ltd 457

Legion SpaceWorks R6.5.0 User Guide

23: Desire Plots and Desire-Line Diagrams

A Desire Plot is a data object within the Analyser, which enables you to set up the conditions
needed to visually track the preferred travel choices and routes of specified Entities. A Desire
Plot enables you to filter for a specific Entity Type (or Entities) give it (or them) a unique col-
our, and track their journey through your simulation, with its colour-coded, tracked trail dis-
played in the Analyser workplace within an associated Desire Line Diagram. This 'visual
journey' of Entities' most desired routes is known as a 'Desire Line Diagram'.
You can set up several Desire Plots but each plot must correspond to a particular route
through a model and it must be associated with a single user-defined colour for each Entity
captured by the Desire Plot's filter settings. The aim is to reveal preferred routes through a
model, which can help in focusing attention on the most crucial, or most utilised, areas of a
model.
You can associate a Desire Plot with several origin and destination objects (to indicate pos-
sible routes) and then set its filter to pick up Entities of interest. Once you have set up the
required Desire Plots, you can activate Desire Line Diagrams by selecting Analysis > Start
Desire Line Diagram Generation or clicking the icon. Desire-line diagrams use the
Entity colour scheme specified in desire plots and they display only the trails of Entities, not
the Entities themselves. To record the output of desire-line diagrams, you can set up a Screen
Camera track on the Analyser's Timeline, and add Snapshot events.

458
Legion SpaceWorks R6.5.0 User Guide

Creating Desire Plots

In order to start, and visualise, Desire Line Diagrams, you first need to set up one or more
Desire Plots. A Desire Plot is a data object that enables you to choose a unique colour for the
Entity journeys you wish to track in a Desire Line Diagram. It also enables you to filter which
journeys to track. The filters you can choose comprise one or more attributes from 'Entity
Type', 'Final Destination', 'Origin' and 'Target'. For example, if you want to view the journeys
of all Entities leaving your model through the 'West Exit', you would select this Exit under
'Final Destination'; if you wanted to view the journeys of all Entities entering from 'Street
Entrance 1', you would select this Entrance under 'Origin', and so on.
This procedure assumes that you have opened the Analyser and loaded model and data files.

To create a Desire Plot:

1. Click or select Analysis > Desire Plots.

The 'Edit Desire Plot' dialog box is displayed.
2. Click New to add a new Desire Plot to the left-hand list.
3. Type a meaningful name for the Desire Plot in the highlighted name box and press Enter.
4. On the 'Desire Plot' tab, choose a unique colour by selecting one of the two options:
◊ User defined–select a colour from the adjacent drop-down list.
◊ By Entity Type–select one of the colours already associated with one of your model's
Entity Types from the adjacent drop-down list.
The colour you select here will become the colour of all Entity trails tracked in the
Desire Line Diagram.
5. Click on the 'Entity Filter' tab.
6. If you have already created Named Filters, which you would like to use, select the 'Named
Filter' option and choose a filter from the drop-down list. You can now click OK to finish
and save your filter settings. If you do not have any Named Filters, either create them as
described in Creating Named Filters, or continue with the next step.
7. From the drop-down list labelled ‘Filtering Method’, select one of these two options:
◊ Selected attributes–you can now define further filtering criteria
◊ None–no attributes will be selected (this is equivalent to switching the Desire Plot 'off'
8. If you chose Selected attributes, select one or more attributes from the four categories
of ‘Entity Type’, ‘Final Destination’, ‘Origin’ and 'Target'.
9. To do this, expand the tree of ‘available’ attributes as you need and move them into the
‘selected’ pane using the > and >> buttons (to remove selected attributes, use < and
<<).
10. If you have selected more than one attribute in the previous step, the 'Logic method'
drop-down list becomes available. From this list, select one of the following:
◊ AND–only Entities with every selected attribute will be selected
◊ OR–Entities with any of the selected attributes will be selected
11. Click Apply to save your settings (you can now add more Desire Plots) or OK to save
your settings and close the dialog box.
The new Desire Plot object is created and listed in the Object Directory. Like other data
objects in the Directory, you can deactivate them and reactivate them by toggling the
white tick on and off.

© 2001–2017 Legion International Ltd 459

Legion SpaceWorks R6.5.0 User Guide

12. To add more Desire Plots, repeat from step 2.

460
Legion SpaceWorks R6.5.0 User Guide

Starting Desire Line Diagram generation

Once you have created one or more Desire Plots, you are ready to start running the Desire
Line Diagrams associated with them. These behave very much like Legion maps, except they
only show the uniquely coloured trails of those Entities whose journey(s) you have decided to
track and display by defining them in Desire Plots.
You will not be able to start Desire Line Diagrams until you have created at least one active
Screen Camera Track on the Analyser Timeline. This is so that the Analyser knows where and
how to generate the output from the diagram. For information on adding tracks, see Adding
Tracks to the Timeline and associated topics. When you have added and defined a Screen Cam-
era Track, you can also add Snapshot events to the track. These events 'take pictures' of the
Desire Line Diagram at specific times and save them as graphic files. See Screen Camera
track events for a recap on creating and defining these events.

To start Desire Line Diagram Generation:

1. Click or select Analysis > Start Desire Line Generation.

You are prompted to confirm this action because running Desire Line Diagrams changes
the Analyser's visualisation settings and suppresses all other operations

.
2. Click Yes to continue.
3. The Desire Line Diagram will be displayed in the workplace with all filtered Entity trails dis-
played. All data and screenshots will be saved to the locations and in the format you spe-
cify in the Screen Camera Track properties and any Snapshot events you may have added
to the track. This screenshot shows the purple Desire Lines of Entities from all Origins.

© 2001–2017 Legion International Ltd 461

Legion SpaceWorks R6.5.0 User Guide

4. If you wish to pause, stop, or reset the Desire Line Diagram, use the relevant icons on the
Timeline to do so.

462
Legion SpaceWorks R6.5.0 User Guide

24: Object Catalogues and the Object Store

In this chapter
This section describes how to create and manage catalogues into which you can save objects,
data and elements of analyses. The catalogues and Object Store work with the Model Builder
and the Analyser and enable you to share saved items between projects and among col-
leagues.
The Model Builder also contains an 'Object Template Catalogue', which contains example
objects and groups of objects to speed up modelling common features. See Object Template
Catalogue for more details.
This section covers the following topics:
● About Object Catalogues and the Object Store
● Making Catalogues Available
● Adding Objects to a Catalogue
● Using Stored Objects
● Importing and Exporting
● Object Template Catalogue
All procedures apply to the Model Builder and the Analyser alike.

© 2001–2017 Legion International Ltd 463

Legion SpaceWorks R6.5.0 User Guide

About Object Catalogues and the Object Store

Catalogues are places where you can store, reuse and share the following objects from the
Model Builder and Analyser:
● Spatial Objects
● Model Builder data objects (Entity Types, Supply Types, Arrival Profiles, Event Profiles,
Delay Profiles, Availability Profiles, Speed Profiles, Exit Profiles, Entity Colour Schemes
and Value Ranges).
● Analyser data objects (Map definitions, Analysis definitions, Thresholds, and Entity Colour
Schemes)
There is a default catalogue (‘DefaultCatalogue.lgd’), into which you can choose to save all
your objects, but you can also create as many catalogues as you require on local and shared
drives. After you have 'registered' them using Tools > Options > Catalogue Management, they
are available to use from your installation of SpaceWorks.
Once you have saved objects to your catalogue(s), you can reuse them in other lgm or ana
files. You can also import and export the contents of catalogues. All of this can be done using
the Object Store.

The Default Catalogue

When you install Legion SpaceWorks, a default catalogue named ‘DefaultCatalogue.lgd’ is
automatically created and will usually be located in the following place:
\Program Files\Legion International\Legion SpaceWorks\Data
This means you can immediately start adding objects to the default catalogue without having
to manually create and register any new ones.

Creating a Catalogue
If you would like to have different catalogues for different projects or for certain types of
object, you can create your own in addition to the default catalogue. This procedure assumes
you have a project open within the Model Builder or Analyser.

To create a catalogue:
1. Select Tools > Options > Catalogue Management.
The ‘Options’ dialog box is displayed.

464
Legion SpaceWorks R6.5.0 User Guide

2. Click the New Catalogue File icon and navigate to the local or network drive on
which you want to save the catalogue.
3. Enter a name for the catalogue in the ‘File name’ box.
4. Click Save.
The catalogue will be saved as a Legion Data file (extension ‘lgd’).
5. Repeat steps 2 to 4 to add any more catalogues you require.

6. Click OK.

Making Catalogues Available

If you have created new catalogues, you need to ‘register’ them within Tools > Options > Cata-
logue Management so that they are available when you want to save objects to them during
modelling.

© 2001–2017 Legion International Ltd 465

Legion SpaceWorks R6.5.0 User Guide

You must register catalogues in both the Model Builder and Analyser if you want them to
be available to each application.

To make catalogues available:

1. Select Tools > Options > Catalogue Management.
The ‘Options’ dialog box is displayed.

2. Click the ‘New’ icon .

A new empty row is created in the dialog box.
3. Click the small ‘Browse’ button at the end of the row.

The ‘Select the file’ dialog box is displayed.

4. Navigate to the catalogue (‘lgd’ file) you want to register, select it and click Open to add
the catalogue to the list of available items.

◊ To remove a catalogue, highlight it and click the ‘Delete’ button .

Adding Objects to a Catalogue
To add objects visible within the workspace, simply right-click on them and select Save to
catalogue. Objects that do not appear in the workspace, such as data objects, can be added
in the Object Directory.

To add objects to a catalogue:

1. Select one or more objects using the Object Directory or by selecting them in the work-
space.

466
Legion SpaceWorks R6.5.0 User Guide

2. Right-click and select Save to catalogue.

The ‘Save to catalogue’ dialog box is displayed.
3. From the box labelled ‘Catalogue’, select a catalogue from the drop-down list (this list
includes your 'Default Catalogue’.

If the catalogue you need does not appear in the list, you must ‘register’ it using Tools >
Options > Catalogue Management.
4. If you would like to give the saved object a different name to the one used in the model,
enter it in the ‘Name’ box.
5. If you would like to add a description of the saved object, do so in the ‘Description’ box.
6. Click OK to save the object to the catalogue.
If you selected several objects to save, you will need to repeat steps 4 to 7 for each of
them.
7. Click OK to close the ‘Save to catalogue’ dialog box.
A note on duplicate objects
If an object you are trying to save to a catalogue is already in the catalogue (all objects are
automatically added to the Default Catalogue by the way), the 'Name Clash' dialog box is dis-
played, where you can decide how to treat the object. Think of it as copying and pasting the
object into the catalogue.

Select one of the following options:

◊ Automatically rename the pasted object
◊ Use the existing object (Already present in model)
◊ Overwrite the existing (Use newly pasted)
and click the OK button.

Using Stored Objects

Once an object is stored in a catalogue it becomes available for use in other projects by any-
body with access to the drive on which a catalogue is stored. All catalogues must also be
‘registered’ in Tools > Options > Catalogue Management as described in Making Catalogues
Available. This procedure assumes that you have a model open in the Model Builder or Ana-
lyser.

To use an object from a catalogue:

1. Select Tools > Object Store.

© 2001–2017 Legion International Ltd 467

Legion SpaceWorks R6.5.0 User Guide

2. If you want to use objects in the default catalogue, it is already selected and the objects
are displayed in a tree structure within the 'Content' panel. Until you select one or more
items in the catalogue, they are marked with a white cross on red.

3. To select from another catalogue, select another option from the 'Catalogue file' drop-
down list. That catalogue's contents are now displayed.
4. Select one or more objects by clicking on them in the tree. All selected objects are marked
with a white tick on green.

5. Click Use to place the objects into the workspace.

SpaceWorks will place the selected objects into your model but you may well encounter
name clashes for certain items (like 'Default Entity Type') that already exist. In these
cases the 'Name Clash' dialog will be displayed for each clash.

468
Legion SpaceWorks R6.5.0 User Guide

Select one of the following options:

◊ Automatically rename the pasted object
◊ Use the existing object (Already present in model)
◊ Overwrite the existing (Use newly pasted)
If there are multiple instances of name clash, and you want to handle them in the same
way, check the box labelled 'Apply to all' and then click the OK button.
6. When you have added all the objects you require, click Close.

Removing Stored Objects

You can remove objects from catalogues by using the Object Store. This procedure assumes
that you have a model open in the Model Builder or Analyser.

To remove objects from catalogues:

1. Select Tools > Object Store.
2. If you want to remove objects from the default catalogue, it is already selected and the
objects are displayed in a tree structure within the 'Content' panel. Until you select one or
more items in the catalogue, they are marked with a white cross on red.

© 2001–2017 Legion International Ltd 469

Legion SpaceWorks R6.5.0 User Guide

3. To remove objects from another catalogue, select another option from the 'Catalogue file'
drop-down list. That catalogue's contents are now displayed.
4. Select one or more objects by clicking on them in the tree. All selected objects are marked
with a white tick on green.

5. Click Remove to remove the objects from the catalogue.

6. When prompted, confirm or cancel the deletion by clicking Yes or No.
7. When you have removed all the objects you want to, click Close.

Importing and Exporting

In the Object Store, you can import the entire contents of a catalogue into one of your other
pre-selected catalogues. You can also export selected objects from one of your catalogues to
new or alternative catalogues. These procedures assumes that you have a model open in the
Model Builder or Analyser.

470
Legion SpaceWorks R6.5.0 User Guide

To import a catalogue:
1. Select Tools > Object Store.
2. If you want to import objects into the default catalogue, it is already selected (proceed to
step 5).
3. To choose another catalogue to import into, select another option from the 'Catalogue file'
drop-down list.
4. From the ‘Open’ dialog, navigate to the catalogue you want, highlight it and click Open.
5. Click Import.
6. Navigate to the catalogue you would like to import, highlight it and click Open.
SpaceWorks will import the selected catalogue and its objects into your first catalogue but
you may well encounter name clashes for certain items (like 'Default Entity Type') that
already exist. In these cases the 'Name Clash' dialog will be displayed for each clash.

Select one of the following options:

◊ Automatically rename the pasted object
◊ Use the existing object (Already present in model)
◊ Overwrite the existing (Use newly pasted)
If there are multiple instances of name clash, and you want to handle them in the same
way, check the box labelled 'Apply to all' and then click the OK button.
7. The contents of the second catalogue are imported into your first catalogue.
8. Repeat from step 5 for any more imports.
9. When you have finished importing catalogues, click Close.

To export objects to catalogues:

1. Select Tools > Object Store.
2. If you want to export objects from the default catalogue, it is already selected (proceed to
step 5).
3. To choose another catalogue from which to export objects, select another option from the
'Catalogue file' drop-down list.
4. Select one or more objects to export by clicking on them in the tree. All selected objects
are marked with a white tick on green.

© 2001–2017 Legion International Ltd 471

Legion SpaceWorks R6.5.0 User Guide

5. Click Export.
The 'Export To' dialogue box is displayed.
6. Navigate to the catalogue to which you would like to export the objects.
◊ If you want to export them to a new catalogue, enter a name for the new catalogue in
the ‘File name’ box.
7. Click Save.
◊ If you added a new catalogue name, you will be prompted to ‘Create a new cata-
logue?’. Click Yes to do so.
The objects are exported to the selected or newly created catalogue.

Object Template Catalogue

As well as the Default Catalogue and your own bespoke catalogues, SpaceWorks comes with a
catalogue preloaded with ready-made objects. The aim of the catalogue is to provide working
examples of useful, complex objects, to help with modelling elements such as ATM and sales
machines; service points with associated queueing systems; spiral stairs, ticket gates and
gate lines.
Items in this catalogue are likely to consist of grouped objects along with their associated
data profiles. Like all catalogue objects, they are available for use in your models. Once they
have been introduced to your model you can alter them as you fit, using all of the tools and
functions in SpaceWorks. This catalogue is 'read only', meaning you cannot add or remove
objects. From time to time, Legion will upload new objects to this catalogue, which will
remain available to all users of SpaceWorks.
This procedure assumes that you have a model open in the Model Builder or Analyser.

To view and use the Object Template Catalogue:

1. Select Tools > Object Store.
2. From the 'Catalogue file' drop-down list, select Template Catalogue [Read Only].

472
Legion SpaceWorks R6.5.0 User Guide

3. Objects in this catalogue can be used and/or exported in the same way as objects
described in Using Stored Objects and To export objects to catalogues:.

© 2001–2017 Legion International Ltd 473

Legion SpaceWorks R6.5.0 User Guide

25: Batch Runs

In this chapter
This part of the guide discusses the use of batch runs, which apply both to the Simulator and
the Analyser. Batch runs enable you to schedule potentially time-consuming and repetitive
tasks without the need for further intervention.
In the Simulator, you can schedule the recording of multiple ‘res’ files and ‘avi’ files using vari-
ous model file and data source pairs. The Analyser enables you to schedule multiple analyses,
incorporating Timeline events or even multiple Timeline Settings.
This section covers the following topics:
● Simulator batch runs
● Analyser batch runs

474
Legion SpaceWorks R6.5.0 User Guide

Simulator batch runs

Imagine that you want to run five simulations of a model, recording five ‘res’ files and five
‘avi’ files. Then imagine that you needed to do this for three different data scenarios. This
workload would be very time-consuming, requiring you to intervene after every simulation
run to set the next one up, specify recording settings, select scenarios, etc.
Batch runs mean that you can set these events up once and then let Legion run them in
sequence without further intervention from you.

Defining batch output settings

Before setting up your batch runs, we recommend that you define your ‘res’ and ‘avi’ outputs
first. Once defined, these settings will apply to all batch runs in a session. You can only set up
a batch run within the Simulator if there are no project files open, so firstly close any files you
may have open.

To define batch output settings:

1. Select File > Batch Run.
2. The ‘Batch Run’ dialog box is displayed.

3. Click the Outputs button.

4. On the ’res file’ tab, check the requisite box for each metric that you would like to save in
the ‘res’ file (Discomfort, Dissatisfaction, Frustration, Inconvenience).
5. On the ‘avi file’ tab:
◊ From the Size drop-down list, select a video size.
◊ From the Codec drop-down list, select a codec (choose the one that best matches your
installed software).
◊ Click and drag the Quality bar to set a value between 0 and 100 (100 being the best
quality and least compression).
◊ Click and drag the Speed bar to specify the speed you want the simulation to be recor-
ded at (the range is between 1x (real time) and 30x (30 times real time).
6. Click OK to save your settings.

© 2001–2017 Legion International Ltd 475

Legion SpaceWorks R6.5.0 User Guide

Setting up a Simulator batch run

You can only set up a batch run within the Simulator if there are no project files open, so
firstly close any files you may have open.

To set up a Simulator batch run:

1. Select File > Batch Run.
The ‘Batch Run’ dialog box is displayed.
2. To add a new batch, click Add.
‘Batch 1’ is added to the dialog box. It contains ten cells, arranged vertically, in which you
can define the content of the batch.
3. Double-click in the Model cell, navigate to and select the appropriate ‘lgm’ file.
4. Double-click in the Source cell, navigate to and select the appropriate ‘ora’ file.
Start and end times for the ‘res’ and ‘avi’ files are automatically added to the batch, based
on the run-time of the ‘ora’ file.
5. Double-click in the No. of runs cell and enter the number of simulations you want to run
(at least 1).
6. Either leave the .res start time cell as it is, or double-click in the cell and manually
change the time.
7. Either leave the .res end time cell as it is, or double-click in the cell and manually
change the time.
8. If you want to record an ‘avi’ as part of this batch, check the box labelled Generate .avi.
9. Either leave the .avi start time cell as it is, or double- click in the cell and manually
change the time.
10. Either leave the .avi end time cell as it is, or double- click in the cell and manually
change the time.
11. To define a location for all files generated in the batch, double-click in the Output loc-
ation cell and select a location.
12. To run a simulation using a particular seed, double click in the Simulation seed box and
enter the number of the seed. For more information on simulation seeds, see Specifying
the Simulation Seed.
13. If you want to add more batches, do one of the following:
◊ If you want to add a completely different batch, return to step 2 of this procedure.
◊ If you want to use this batch as the basis for a further one, click Copy and return to
step 3 of this procedure to alter one or more of the settings.

To remove a batch, click once on its column header and then click the Remove button.
14. To run a batch (or batches), click Start.
The Batch Run progress indicator is displayed. It will close when all files are completed
and saved to your specified location.

Batch run progress

When you start a batch run, a progress indicator is displayed. It shows you which file is being
processed and how many runs in your batch have been processed, for example 2/12.
● To jump to the next run in the batch, click Skip.
● To stop the entire batch, click Stop.

476
Legion SpaceWorks R6.5.0 User Guide

Analyser batch runs

Analyser batch runs are slightly different to Simulator batch runs as you must have the appro-
priate project files open (an ‘ana’ file plus its associated ‘ora’ or ‘res’ file) before you set up a
batch run and furthermore, you can use the Timeline to set up events, rather than having to
define start and end times in the ‘Batch Run’ dialog box.
You can also use multiple Timelines to vary some events, which is useful for analysing dif-
ferent schemes where elements may have moved and analyses may need to be redefined.
Because the Timeline (or Timelines) is used, you don’t need to specify an ‘Output location’;
Timeline tracks already supply this information. However, you need to set up a subfolder
within this location for the results of Batch Runs. This is all explained below.

Setting up an Analyser batch run

This procedure assumes that you have opened up the relevant ‘ana’ file within the Analyser.

To set up an Analyser batch run:

1. Select File > Batch Run.
The ‘Batch Run’ dialog box is displayed, with the first batch 'Batch 1' column already
present. It contains eight cells, arranged vertically, which you can use to define the con-
tent of the batch.

2. Double-click in the Model cell, navigate to and select the appropriate ‘lgm’ file.
3. Double-click in the Source cell, navigate to and select the appropriate ‘ora’ or ‘res’ file.
4. Double-click in the No. of runs cell and enter the number of simulations you want to run
(at least 1).
5. Select one of the available Timeline Settings from the Timeline drop-down list.

The name cannot contain illegal characters (any of ?/*”<>|/).

6. To save the results of the Batch Run or Runs in a subfolder within the output location
already specified in the Timeline, double-click in the Subfolder box and type a name for
the folder. This box must contain a name for the process to continue.

© 2001–2017 Legion International Ltd 477

Legion SpaceWorks R6.5.0 User Guide

7. To run a simulation using a particular seed, double click in the Simulation seed box and
enter the number of the seed. For more information on simulation seeds, see Specifying
the Simulation Seed.
8. To instruct runs how to proceed when they have recorded all relevant maps and graphs,
from the After recording all maps & graphs drop-down list, select either:
◊ Skip to the next batch item
◊ Continue simulation/analysis

Making a selection here can save you time if you don't need to record video or res files
after the data for maps and graphs have been recorded.
9. To select which global GJT weightings to use (the lgm file's or the ana file's), from the
Global GJT weights source drop-down list, select either:
◊ Model – LGM
◊ Analysis – ANA

Making a selection here ensures that the Batch Runs continue without being interrupted by
the Analyser requesting to know, each run, which weightings to use.
10. If you want to add more batches, do one of the following:
◊ Click the Add button to add 'Batch 2' to the dialog and return to step 2 of this pro-
cedure.
◊ If you want to use this batch as the basis for a further one, click Copy and return to
step 3 of this procedure to alter one or more of the settings.

To remove a batch, click once on its column header and then click the Remove button.
11. To run a batch (or batches), click Start.
The Batch Run progress indicator is displayed. It will close when all files are completed
and saved to your specified location.

Analysing different schemes using multiple Timelines

If you want to analyse two different schemes (different design iterations of one site using dif-
ferent ‘lgm’ files) in a single batch run, you can duplicate the Timeline settings of one scheme,
change one or more of its outputs and use both Timelines within a batch run.

To analyse different schemes using multiple Timelines:

1. Load one of the schemes (Option A) and save its ‘ana’ file.
2. Define all pertinent maps and analyses for the scheme.
3. Set up a Timeline and call it something like ‘Timeline–A’.
4. In the ‘Edit Timeline Settings’ dialog box, copy this Timeline and rename it ‘Timeline–B’.
5. Identify any Analysis Zones or Lines whose position in the scheme Option B should be dif-
ferent (for example an Analysis Line placed to measure flow for a gateline in Option A
which has been moved in Option B).
6. Identify the corresponding Analyses for any of these, copy them and rename them to
identify them as belonging to Option B.
7. Create new Analysis Lines or Zones whose position is correct for the Option B scheme and
name them as belonging to Option B.
8. Associate the newly created Analyses Line with the Analyses you created in step 6.
9. In Timeline–B, identify the relevant Save Graph events and modify them so that they out-
put data from your Option B Analysis.

478
Legion SpaceWorks R6.5.0 User Guide

Ensure that any files you save for Option B are renamed accordingly so that you don’t over-
write any files you saved for Option A.
10. Finally, In the ‘Batch Run’ dialog box, associate Timelines A and B with the correct model
and source files batches.
11. Run the batch.

© 2001–2017 Legion International Ltd 479

Legion SpaceWorks R6.5.0 User Guide

Appendix: SpaceWorks Commands

This table contains a comprehensive list of all typed commands available in SpaceWorks. The
Command Bar will offer you 'auto- complete' options based on the letters you type. For
example, typing 'a' will bring up a list of all commands beginning with 'a' for you to highlight
and input.

Function Type this

Analysis Line analysisline

Analysis Polyline analysispolyline

Analysis Zone analysiszone

Arc arc

Circle circle

Copy copy

Copy Geometry copygeometry

Copy to Layer copytolayer

Cut cut

Delay Point delayp

Direction Modifier dirmod

Drift Zone dzone

Edit Object edit

Ellipse ellipse

Entrance entrance

Escalator escalator

Evacuation Zone evacuation

Exit exit

Export Conditions exportconditions

Export Model Data exportmodeldata

Export Supply Types exportst

FDZs: place automatically autofdz_batch

FDZs: place manually autofdz_interactive

Find Tool find

480
Legion SpaceWorks R6.5.0 User Guide

Function Type this

Focal Node fnode

Gate gate

Group Object group

Generalised Journey Time Zone gjtzone

Identify Free-standing Objects identify

Import Conditions importcon

Import Supply Types importst

Level Entrance lentrance

Level Exit lexit

Line line

List Analyses with Conditions listconditionalanalyses

Measure measure

Mesoscopic Transit Zone mesoscopictransitzone

Mirror mirror

Move move

Move Free-standing Objects movefree

Move to Layer movetolayer

Multipath Zone multipathzone

Paste paste

Polar Array polararray

Poly-line polyline

Populated Zone popzone

Purge invalid graph purge invalid graph

Queue queue

Queue Group queuegroup

Rectangle rect

© 2001–2017 Legion International Ltd 481

Legion SpaceWorks R6.5.0 User Guide

Function Type this

Rectangular Array rectarray

Regenerate Object(s) regenerate

Rotate Object(s) rotate

Route Guide routeguide

Route Guide: Create from CAD routeguidefromcad

line

Save to Catalogue savetocatalogue

Scale scale

Seed Point: Place seedpoint

Show FDZ Routes showfdzroute

Single Focal Drift Zone templatefdz

Stair stair

Trim Object(s) trim

Waiting Zone wzone

482
Legion SpaceWorks R6.5.0 User Guide

Index a Snapshot event 448

Focal Distribution Points 277

6
Layers 211
64-bit version 4
Record Entity Positions event 449
64-bit vs 32-bit version 4
Save Map event 442

A several links at once 225

About Time Marks 450

Availability Profiles 110 Adjusting a Focal Segment 180

Data Profiles 110 Advanced filtering

Demand Data 109 about 453

Accessible space 21 control boxes 454

Model Builder 92 entering advanced filter with con-

trol boxes 456
Accumulation Method 349
entering filters 453
Activating a camera 446
examples 453
Activating a network licence 12
principles 453
Activating a workstation licence 10
typing a filter 456
Active Layers toolbar 210-211, 213
Aimsun for Legion
Activity Object Layers 209
changing the Aimsun results
Activity Objects 24 file 320
described 173 showing vehicles 28
Adding showing vehicles in the
a link 224 Analyser 386

a model file to a managed showing vehicles in the

project 59 Simulator 319

a new file to a scenario 65 Aligning avi components 333

a new scenario to a managed pro- Alternative Value Ranges 361

ject 64 ana files
a new version to a managed backups 393
project 67
properties 394
a Record .AVI event 337
saving 393
a Scenario 168

© 2001–2017 Legion International Ltd 483

Legion SpaceWorks R6.5.0 User Guide

Analyse Layers 373

Desire Plots 459 logging playback information 385

Analyser Main menu bar 373

Analyses 396 Output Bar 373

Analysis metrics 396 overview 4

Analysis Objects 400 playing a simulation 384

Analysis questions 370 playing and recording an

Analysis 379
auto-saving your work 393
printing a view 392
basic concepts behind 369
renaming objects within 392
batch runs 477
saving an ana file 393
changing Graphs 422
saving Graphs 422
changing project files 394
sending feedback 394
choosing a rendering engine 383
setting Active Camera (Timeline)
colour ranges 350 447
components 373 setting display preferences 383
creating a new custom graph 425 setting up a batch run 477
creating Entity Colour setting up an Analysis 407
Schemes 388
Snapshot event (Timeline) 448
deleting events (Timeline) 450
Status Bar 375
described 368
Timeline Track Properties 439
Desire Line Diagrams 461
toolbars 373
drawing Analysis Lines and Poly-
lines 401 tracking Entities 386

drawing Analysis Objects 401 Tracks (Timeline) 434

fundamentals of Legion viewing Graphs 421

Analyses 396
viewing Maps 345
Graph windows 373
Analyses
Graphs 419
automated flow rates 408
increasing speed (Analyser) 391
batch runs using multiple
interface 372 Timelines 478

Layer Views in Timeline 447 choosing between on-line and off-

484
Legion SpaceWorks R6.5.0 User Guide

line 379 Analysis options for Underground

Maps 344
copying 408
Analysis questions 370
deleting 408
Analysis Zones
described 396
visibility-based 182, 402
Journey Time metrics 397
Appearance of graphs
metrics, objects, outputs 397
changing 425
off-line 381
Appearance of Links, Filters and Final
on-line 379 Destinations 234
opening existing file 394 Appendix
renaming 408 SpaceWorks commands 480
setting up 407 Applying
starting an off-line analysis 381 Interpolation 162
starting on-line analysis 380 modifications to data 158
Analyses Project Settings (Model Pulse 159
Builder) 94
Pulse Train 159
Analysis
Random Noise 164
Layers 209
Split 165
Line 401
Spread 160
Metrics 396
user-defined Speed Profile 100
Objects 400
Approach angles (Focal Segments)
Poly-line 401 177
running 396 Area of Spatial Objects 176
viewing window 373 Arranging windows 79
Zone 401 Arrival Profiles
Analysis Objects don’t import original Arrival Profiles
Analysis Line 401 with... 145

Analysis Poly-line 401 manually creating and editing 147

Analysis Zone 401 Auditing OD Matrix 113

GJT Zones 416 Auto-navigation 26

visibility-based zones 182, 402 disabling 88

© 2001–2017 Legion International Ltd 485

Legion SpaceWorks R6.5.0 User Guide

Auto-recover backup files avi layout

Model Builder 85 customising 332

Auto-Repeat tool 179 avi Layout Designer

Auto-save aligning components 333

Analyser 393
B
Model Builder 84
Background colour
notes on 85
changing 74
Auto Hide 80
Backups
Automated flow-rate analyses for
Stairs and Escalators 408 ana files 393

Availability Profiles models 84

about 110 recovering 85

applying Pulse 160 Base Scenario

applying Pulse Train 160 described 167

converting from Gate Control Pro- Batch FDZ Partitioning

files 132
Focal Drift Zones 295
converting to Gate Control
Batch Runs
Profiles 132
Analyser 477
Creating new 148
defining settings 475
Creating with Data Profiles work-
sheet 122 multiple Timelines 478

in connection with Gates 132 setting up (Analyser) 477

with CAD layers 212 setting up (Simulator) 476

avi Simulator 475

Layout Designer 332 skipping and continuing 477

avi files Blockages 88

customising layout 332 automatic detection 27

Record .AVI events 337, 436

C
recording properties 330
CAD
setting Record track
properties 331, 434 cleaning 31

concepts 23

486
Legion SpaceWorks R6.5.0 User Guide

drawing a circle 36 Catalogues 463

drawing a line 36 object templates 472

drawing a polygon 36 Cataloogues

drawing a rectangle 36 objects 463

drawing an arc 36 Change Logs 53

drawing an ellipse 36 exporting 55

drawing objects 36 viewing 54

exporting 35 Changing

handling multi-level space 38 Aimsun results file 320

IFC (industry file format) 40 background colour 74

importing 33, 87 data graph view 152

Importing IFC CAD 40 display model (lgm) 317

Layers 208 event properties 450

placing IFC layers into the Grid settings 189

model 46
name of Spatial Objects 205
saving imported CAD files 34
position and height of tracks 330,
transferring Entities between floor 438
plans 38
project files 394
using within Legion 30
start and end times of a Record
CAD layers .RES event 448

and availability profiles 212 start and end times of a Save Map
event 443
FDS 208
the algorithm (FDZ errors) 298
Camera
the start and end times of an
activating 446 event 336
adding to a Record .AVI track 436- type of Graph 422
437
Changing a model file in a managed
creating 446 project 61
setting active 447 Checking
updating 446 for errors 90
Camera Close-up 77 for updates 19

imported file properties 154

© 2001–2017 Legion International Ltd 487

Legion SpaceWorks R6.5.0 User Guide

location of files in a managed pro- Commands

ject 63
all SpaceWorks typed
routing with the Show Route com- commands 480
mand 299
auto-complete 78
Checking for free standing objects 32
drawing CAD objects 36
Cleaning
drawing Spatial Objects 181
CAD 31
moving and copying to layers 214
Clearing
searching with 202
a Graph 422
Components
current map 346
Analyser 373
Clones
Model Builder 74
described 257
Simulator 314
showing 257
Timeline 328
Closing
Condition Objects 241
a model 87
Conditional analyses
a window 80
hiding 94
the Timeline 339, 451
hiding (Analyser) 399
Colour-to-Value Assignment 351
Conditions
Colour of ranged events 338
about 237
Colour Ranges 350
Creating Condition Objects 241
Colour-to-Value Assignment 351
exporting 242
creating a custom range 357
importing 243
exporting 359
restrictions 240
importing 359
setting up 238
Colour schemes (Analyser) 388
Conditions Layers 209
Underground Cumulative High Dens-
ity Entity 359 Congestion in Level Exits and Level
Entrances 257
Colour schemes (Model Builder) 106
Continuing or skipping Batch
Column Graph 420 Runs 477

Command Bar 77 Converting Availability Profiles to

Gate Control Profiles 132

488
Legion SpaceWorks R6.5.0 User Guide

Converting Gate Control Profiles to Named Filters 233

Availability Profiles 132
new Arrival Profile 147
Copying
new Arrival, Availability and Event
a Data Profile 157 Profiles 147

Analyses 408 new Availability Profile 147

Demand Data 155 new Event Profile 147

geometry of Spatial Objects 199 new project to manage 58

Layers 214-215 Population Profiles (automatically)

122
links from another object 226
Population Profiles (manually) 127
Maps 367
Queues 278
objects to other Layers 214
Supply Type 104
Ranges 359
user-defined Speed Profile 148
Spatial Objects 191
Weighted Value Range 358
Corners and edges 27
Creating an origin-destination matrix
CPU memory
defining origins and
saving 321, 385 destinations 112
Creating Creating and editing
a camera view 446 Entity Types 98
a custom Map 353 Supply Types 104
a Delay Profile (1 period) 127 Creating Gate Control Profiles 129
a Delay Profile (3 periods) 128 Cumulative High Density Map 342
a new custom graph 425 Cumulative Max/Mean/Min Density
a Queue 278 Maps 342

a single stair 260 Customising avi layout 332

a stair with a landing 262 Customising toolbars 75

an Escalator 264 Cutting

an Exit Profile 249 Demand Data 155

an origin-destination matrix 112 Layers 214

Condition Objects 241 Spatial Objects 191

Desire Plots 459

© 2001–2017 Legion International Ltd 489

Legion SpaceWorks R6.5.0 User Guide

Exit Profiles 248

D
free drawing into a Graph 150
Data
importing data for a single Data Pro-
About Demand Data 109 file 153
Population Profiles 122, 127 manually creating and editing 147
Data Graphs modifying 158
changing views 152 renaming 157
editing cells 150 selecting entries in a data
graph 153
entering data 150
updating imported file
free drawing data into 150
properties 154
locking and unlocking 150
Data Scenarios 167
selecting entries 153
Data Template
Data Profiles 108
Population Profiles 127
about 110
Data Template Spreadsheet 115
Arrival 110
Datasets
changing data graph view 152
changing for graphs 426
checking imported file
Debugger error 10
properties 154
Default Tracks and Events
concepts 25
Timeline 330
copying 157
Defining
creating a new Arrival or Event Pro-
file 147 batch run settings 475
Delay Profiles 127 origins and destinations 112
deleting 157 Delay Points
deleting data from 156 and Queue Groups 283
demand 108 Delay Profiles 127
Edit Data Profile dialogue box 149 described 273
editing data in data graph cells 150 drawing 274
entering data into a Graph 150 Focal Distribution 276
entering into a Graph 150 setting parameters 274
Event Profiles 110 Target Parameters 278

490
Legion SpaceWorks R6.5.0 User Guide

Waiting Location parameters 275 copying 155

Delay Profiles 127 cutting 155

creating 127 deleting 156

Delays importing for a single Data

Profile 153
’Delay until’ 129
manipulating 159
deleting 129
modifying 158
fixed and variable 128
pasting 155
Deleted objects in Scenarios 170
Repeated Pasting 155
Deleting
Scenarios 167
a Scenario 169
updating imported file
Analyses 408 properties 154
data from a Data Profile 156 Demand profiles
Data Profile 157 Gate Control Profiles 129
events 339 Desire Line Diagrams 458
events (Timeline) 450 generating 461
Focal Distribution Points 277 Desire Plots
Layer Views 215 creating 459
Layers 214 Desire Plots and Desire Line
links 226 Diagrams 458

Maps 367 Desire Plots and Desire Lines 458

Ranges 359 Detaching a network licence 16

Spatial Objects 182 enabling 16

Time Marks 451 Detect blockages automatically 27,

88
tracks 439
Direction Change parameters 290
Deleting, renaming and copying Delay
Profiles 129 Direction Modifier

Demand Data Selection Segment 288

About 109 Direction Modifiers

applying Pulse 159 described 285

checking imported file Roles 285

properties 154

© 2001–2017 Legion International Ltd 491

Legion SpaceWorks R6.5.0 User Guide

Scope and influence 285 Drawing Spatial Objects

setting parameters 285 changing the shape of 193

Target Rules 287 copying geometry 199

Disabling and enabling events 329, Delay Points 274

431
Focal Segments 179
Disabling auto-navigation 88
mirroring 198
Display model
Polar Array 197
changing 317
Rectangular Array 196
Display preferences
refining 189
Analyser 383
rotating 194
Simulator 318
scaling 195
Displaying Links, Filters and Destin-
ations 234 the Grid 189

Distance trimming 195

measuring 198 using Snaps 189

Distance Estimation Error 87 Waiting Zones 283

Distance Factors 267 Drift Zones

Docking components 80 additional parameters 291

Dragging and dropping objects into described 289

other Layers 215 setting Direction Change para-
Drawing meters 290

an Analysis Zone 401 setting parameters 290

Analysis Line or Poly-line 401 setting Stairs and Escalators para-

meters 291
Analysis Objects 401
Speed Change parameters 290
Auto-Repeat tool 179
Duplicating
CAD objects 36
Layers 213
Polygon Mode 179
Tracks 438
Rectangle Mode 179

Spatial Objects 179 E

Drawing and placing Spatial Edit Data Profile dialogue box 149
Objects 179

492
Legion SpaceWorks R6.5.0 User Guide

Editing Record Entity Positions event 449

a Link 226 scanning ability 182

an Entity Type 103 setting trail length 323, 387

group-editing 204 Supply Types 22

Spatial Objects 204 tracking 322

Supply Type 105 tracking by filter 387

Editing data transferring between floor plans 38

data graph cells 150 Types 22

Entering data into a Graph 150 viewing details 324

Entities viewing details (Analyser) 390

Behaviour modification 272 Waiting Location parameters

(Delay Points) 275
changing direction in Stair
objects 262 Zone of Influence 348

Clones 257 Entity and Supply Types

Colour Schemes (Analyser) 388 described 97

Colour Schemes (Model Builder) Entity Behaviour Modification

106 Options 272

creating a Supply Type 104 Entity Colour Scheme

creating and editing Entity applying filters 107, 389

Types 98
based on available range 106
creating and editing Supply
Types 104 bespoke 106, 389

Distance Estimation Error 87 Entity Colour Scheme (Analyser)

editing a Supply Type 105 based on available range 388

editing an Entity Type 103 Entity Colour Schemes

exporting Supply Types 106 Simulator 314

facing direction 181 Entity details

importing Supply Types 106 Analyser 390

last step and preferred Entity facing direction 181

direction 318, 384 Entity Type
Population Profiles 122, 127 Linking by 221
Profiles 22

© 2001–2017 Legion International Ltd 493

Legion SpaceWorks R6.5.0 User Guide

Entity Types 22 Event Profiles

creating and editing 98 manually creating and editing 147

editing 103 Event properties

Entrances changing 450

described 246 Event tracks 329

setting parameters 246 duplicating 438

Environment Maps Events

creating using a Plot 3D file 355 adding a full-length event 335

creating using a Slice file 355 adding a Record .RES event 335

FDS files 93 adding Active Cameras to a Record

.AVI track 437
Errors
changing the start and end times of
checking for 90, 393 an event 336
checking for (Analyser) 393 defaults 330
debugger 10 defining 335
FDZs (changing the algorithm) 298 deleting 339
Escalators 263 disabling and enabling 329, 431
automated flow rates 408 overlapping 338
creating 264 Record .AVI 337
distance factors 267 Record Entity Positions 449
linking 267 specifying colour of ranged
splitting across separated CAD 264 events 338

Evacuation Map Excluding areas from Maps 352

described 342 Excluging Stairs, Escalators, areas,

from Maps 352
Evacuation Time map
Exit Profiles 248
Population Profiles 122
creating 249
Evacuation Zones 252
Exits
described 252
described 247
Pre-movement settings 254
Exit Profiles 248
summary 255
setting parameters 248

494
Legion SpaceWorks R6.5.0 User Guide

Export entering advanced filter with con-

trol boxes 456
Change Log 55
entering advanced filters 453
Export Model Data command 171
examples of advanced filtering 453
Exporting
principles of advanced filtering 453
CAD files 35
typing advanced filter 456
Legion Project Manager
information 70 Filters

Legion Viewer files 428 creating Named Filters 233

model as an ora file 92 tracking Entities 387

model as ora file with viewing 234

Scenarios 170
Final Destinations
model data 171
linking by 222
model for use with FDS 93
Find tool 200
OD Matrix for auditing 113
Analyser 392
Exporting Conditions 242
search commands 202

F search criteria 200

Facing position (Entities) 181 search results 204

Factors selecting criteria 200

distance 267 Finding network licences 14

FDS Fire settings

CAD layers 208 FDS 93

completing outputs 93 Fixed and Variable Delays 128

exporting 93 Flow Rate Limiting 245

files 93 Flow rates

fire settings 93 automated 408

Feedback 95 limiting 245

Filtering Focal Distribution Points

advanced 453 adding and deleting 277

advanced control boxes 454 described 276

described 231

© 2001–2017 Legion International Ltd 495

Legion SpaceWorks R6.5.0 User Guide

Focal Drift Zones

G
Batch partitioning 295
Gate Control Profiles
changing the algorithm 298
converting from Availability
described 293 Profiles 132
Interactive partitioning 293 converting to Availability
Profiles 132
partitioning 293
creating 129
placing individual 296
Gates 268
Potential problem 297
demand profiles 129
setting parameters 298
Gate Control Profiles 129
Focal Nodes
Gate Control Profiles and Avail-
described 288
ability Profiles 132
setting parameters 289
Gates, Gatelines, Gate Control Pro-
Focal Point files, Availability Profiles 132

target parameters tab 188 Generating Desire Line Diagrams 461

Focal Segments Geometry

adjusting 180 copying 199

approach angles 177 GJT

described 176 changing global weightings 413

Entity behaviour 177 global weightings 413

focal point 177 weightings 413

how they work 176 Zones 416

placing 179 GJT Reports 415

Fonts GJT Summary tab 415

changing on graphs 425 Global weightings (GJT) 413

Form of Spatial Objects 176 changing 413

Free drawing data into a graph 150 Graph windows 373

Free standing objects 32 Graphics

checking for 32 rendering engine 317

moving 32 rendering engine (Analyser) 383

496
Legion SpaceWorks R6.5.0 User Guide

Graphs
H
changing appearance of 425
HASP
changing Datasets 426
debugging error 10
changing font settings 425
licensing 10
changing type 422
Help
clearing 422
using 95
Column Graphs 420
Hiding and showing group objects 306
creating a new custom graph 425
Hiding Conditional analyses 94
described 419
Hiding Conditional analyses (Ana-
Histogram 420 lyser) 399
Line Graph 420 Histogram 420
loading from csv file 428 stacked 421
opening new Graph window 422
I
purging invalid 423
IFC (Industry file format) CAD 40
saving 422
colour support 44
saving all 423
importing 40
setting track properties 440
organising Legion layers 43
Stacked Column Graph 421
placing layers 46
Stacked Histogram 421
quickly selecting layers 45
viewing 421
selecting contents 41
zooming in and out 421
IFC CAD terminology 40
Grid
Imported file properties 154
changing settings 189
Importing
described 189
CAD 33
showing 189
Colour and Value Ranges 359
using 189
Completed Data Template 143
Group Objects
data for a single Data Profile 153
hiding and showing 306
IFC CAD 40

Importing Conditions 243

© 2001–2017 Legion International Ltd 497

Legion SpaceWorks R6.5.0 User Guide

Increasing simulation speed 324 Layer View

Analyser 391 Timeline 447

Inspecting links 229 Layers 24

statuses 229 Activity Object 209

Installing Legion SpaceWorks 7 adding 211

launching the installation wizard 7 Analyser 373

quick-start 7 Analysis 209

step-by-step 7 CAD Layers 208

wizard steps 7 Conditions 209

Instantaneous events copying 214-215

selecting and moving 450 copying objects to 214

Interactive partitioning cutting 214

Focal Drift Zones 293 defining views 215

Interpolating Demand Data 162 deleting 214-215

Interpolation described 208

applying 162 directory 210

described 162 dragging and dropping objects 215

Invalid graphs 423 duplicating 213

Layers Directory 79
J
loading older model files 216
Journey Time
locking and unlocking 210
metrics 397
making active 213
size of files 414
making snappable 210
JT and GJT
moving and copying using the Com-
Reports 410-411 mand Line 214

moving objects to 214

L
pasting 214
Large xls files 415
properties 209
Last step and preferred direction of
Entities 318 renaming 215

selecting target for Routing

Layer 213

498
Legion SpaceWorks R6.5.0 User Guide

showing and hiding 210 removing files, scenarios and ver-

sions 66
Stairs and Routing Layers 263
saving a project 68
the Layers Directory 210
Legion Project Manger
types 208
adding a new file to a scenario 65
views 215
Legion SpaceWorks
working with 210
concepts 20
Layout of avi files 332
fundamentals of Analyses 396
Legend
handling multi-level space 38
showing current map legend 345
installing 7
Legion concepts
Layers 79
Activity Objects 24
Model Builder basic tasks 82
CAD usage 23
Model Builder basics 71
Data Profiles 25
opening a new model 82
Entities and populations 22
overview 3
Entity Profiles 22
recommended specifications 6
Entity Types 22
starting the software 9
Layers 24
using CAD 30
principles of movement 26
Legion Viewer 428
Supply Types 22
exporting files 428
Legion Project Manager
Level Entrances
adding a new scenario 64
parameters 258
adding a new version 67
Level Exits
changing a file 61
parameters 257
checking location of files 63
Level Exits and Level Entrances 256
exporting information 70
congestion 257
opening 57
described 273
opening files from within 60
showing Clones 257
refreshing a project 69
lgm file
removing a model file 62
changing 317

© 2001–2017 Legion International Ltd 499

Legion SpaceWorks R6.5.0 User Guide

Licence not found 14 Linking methods 219

Licences by Entity Choice (Queue Groups)

222
activating 10, 12
by Entity Choice (Queues) 222
activating a network licence 12
by Entity Type 221
activating a workstation licence 10
by Final Destination 222
detaching a network licence 16
by Percentage Weighting 219
enable detaching of 16
Links
network 10
adding 224
returning detached network
licence 17 adding several at once 225

using and finding network copying from another object 226

licences 14
copying from objects 226
workstation 10
deleting 226
Licensing
described 224
enable detaching of 16
editing 226
introduction 10
inspecting 229
network licences 10
Queues to Delay Points 279
workstation licences 10
viewing 234
Line Graph 420
Links, Filters, Final Destinations
Link
specify how they appear 234
by Percentage Weighting 219
Loading graph from a csv file 428
Link operations 224
Locking and unlocking Layers 210
Linking 218
Locking Data Graphs 150
by Entity Choice (Queue Groups)
222 Logging playback information (Ana-
lyser) 385
by Entity Choice (Queues) 222
Logging playback information (Sim-
by Entity Type 221 ulator) 321

by Percentage Weighting 219 Logs

Escalators 267 changes to files 53

operations 224 exporting Change Log 55

stairs 263 Logs@ viewing Change Logs 54

500
Legion SpaceWorks R6.5.0 User Guide

creating a custom Value Range 357

M
Cumulative High Density 342
Main menu
Cumulative Max/Mean/Min
Analyser 373 Density 342
Model Builder 74 custom 353
Simulator 314 deleting 367
Managing Model Projects 56 described 341
Manipulating Demand Data 159 Evacuation 342
Interpolation 162 exporting ranges 359
Pulse 159 importing ranges 359
Pulse Train 159 Metric parameters 347
Pulse Train (Availability Profiles) parameters 347
160
printing 366
Random Noise 164
renaming 367
Split 165
reset interval 350
Spread 160
resolution 363
Manually creating and editing Arrival,
Availability and Event saving all 365
Profiles 147
setting resolution 363
Map Exclusions 352
showing current legend 345
Maps
Space Utilisation 342
Accumulation Method 349
standard 342
adding a Save Map event 442
Underground Cumulatie High Dens-
apply to an area 347 ity (15-minute) 343

Area parameter 347 Underground Cumulative High Dens-

ity (60 mins) 343
change start and end times of Save
Map event 443 Underground Cumulative Mean
Density (15 mins) 343
clearing current map 346
viewing 345
colour ranges 350
mbk files 84
copying 367
Measuring
creating a custom colour range 357
area 199
creating a custom Map 353

© 2001–2017 Legion International Ltd 501

Legion SpaceWorks R6.5.0 User Guide

cumulative length 199 Layers Directory 79

distance between two points 198 main menu bar 74

Memory Object Directory 75

saving 321 opening a new model 82

Mesoscopic navigation 301 opening an existing model 87

Mesoscopic Transition Zone (MTZ) Output Bar 77

300
overview 3
Metrics
panning and zooming 89
additional Legion metrics 397
printing a model 92
availability in analyses 396
QA 78
Journey Time 397
repositioning toolbars 74
objects and outputs 397
Saving a model 82
Minimum cost 26
saving the current view 90
Mirroring Spatial Objects 198
sending feedback 95
Model Builder
starting 9, 82
about the Model Builder 72
Status Bar 79
accessible space 92
toolbars 74
arranging windows 79
turning toolbars off 74
auto-recovering backups 85
workspace 74
auto-saving your work 84
Model data
basic tasks 82
exporting 171
basics 71
Model file properties 82
changing background colour 74
Model files
checking for errors 90
adding to managed project 59
closing a model 87
Model Properties
components 74
described 87
creating a custom toolbar 75
Distance Estimation Error 87
creating Entity Colour
Schemes 106 setting 87

Demand Data 109 Models

interface 72 and FDS files 93

502
Legion SpaceWorks R6.5.0 User Guide

backups 84 Multi-level space

checking for errors 90 handling 38

exporting as ora files 92 Multipath navigation 303

exporting for use with FDS 93 Multipath Zone (MPZ) 303

loading older files (Layers) 216

N
managing projects 56
Named Filters 233
measuring distances 198
Navigation
opening a new model 82
accessible space 21
opening existing 87
auto-navigation 26
opening for simulation 317
corners and edges 27
panning and zooming 89
minimum cost 26
print preview 92
Network licences 10
printing 92
enable detaching of 16
saving 82
not found 14
saving the current view 90
using and finding 14
setting properties 87
Note on 'Use Target Availability' 273
setting the size of 87
Note on Availability Profiles 110
Modifying Arrival or Event Profile
data 158 Note on importing Origin Settings
data 145
Moving

a window 79 O

objects to other Layers 214 Object Catalogues 463

Spatial Objects 192 Object Directory 75

Moving and copying to Layers using Object link statuses 229

the Command line 214
Object Store 463
Moving and docking the Timeline 339,
Object Template Catalogue 472
451
Objects
Moving and hiding components 80
finding 200
Moving free standing objects 32
OD Matrix
MPZ 303
export for auditing 113
MTZ 300

© 2001–2017 Legion International Ltd 503

Legion SpaceWorks R6.5.0 User Guide

Off-line Analysis simulator 315

starting 381 Outputs

On-line analysis objects and metrics 397

starting 380 Overlapping events 338

On-line Analysis 379 Overview

On-line and off-line analyses 379 Analyser 4

Opening Model Builder 3

a new model 82 Simulator 4

an existing model 87
P
files from within project
manager 60 Panning and zooming 89

Legion Project Manager 57 Parameters

model for simulation 317 Delay Points 274

new Graph windows 422 Direction Change parameters (Drift

Zones) 290
the Legion Data Template 117
Direction Modifiers 285
ora files
Drift Zones 290
exporting 92
Entrances 246
Origin-destination matrices
Escalator 265-266
creating 112
Evacuation Zones 252
Origin Settings data
Exits 248
a note 145
Focal Distribution Points 276
Origins and destinations
Focal Drift Zones 298
defining 112
Focal Nodes 289
matrices 112
Level Entrances 258
OD Matrix 374
Level Exits 257
Output Bar 77
Map 347
GJT Summary 415
Max/Mean/Min Density Maps 342
Information 77
Mesoscopic Transition Zone 301
QA 77
of Spatial Objects 187
Search Results 77
Populated Zones 251

504
Legion SpaceWorks R6.5.0 User Guide

Queue Groups 281 Selection Segment 288

Queues 279 Playback toolbar 316, 328

Speed Change (Drift Zones) 290 Playing

Stairs and Escalators parameters a simulation (Analyser) 384

(Drift Zones) 291
a simulation (Simulator) 317
Waiting Location (Delay Points)
275 Analysis 379

Waiting Zones 283 Playing and recording using the

Timeline 329
Partition Guides
Plot 3D (Environment Maps) 355
using 296
Polar Array
Partitioning
creating 197
Batch 295
Polygon Mode 179
Focal Drift Zones 293
Populated Zones
Interactive 293
described 250
Passwords
setting parameters 251
ana files 394
Population Profiles 122, 127
model files 82
Pre-movement settings for Evac-
Pasting uation Zones 254

between different models 192 Principles of movement

data into a graph 151 in Legion simulations 26

Demand Data 155 Print preview 92

Layers 214 Printing

naming pasted objects 191 a Map 366

Repeated Pasting 155 a model 92

Spatial Objects 191 a simulation 325

using coordinates 191 an Analysis 392

within same model 191 preview 92

Percentage Weighting Priority of Snaps 190

Linking by 219 Project files

Placing changing 394

a Focal Segment 179

© 2001–2017 Legion International Ltd 505

Legion SpaceWorks R6.5.0 User Guide

Project Management Pulse Train (other profiles) 159

adding a model file 59 Purging invalid graphs 423

adding a new file to a scenario 65

Q
adding a new scenario 64
Quality Assurance (QA) 78
adding a new version 67
checking for errors 90
changing a model file 61
Queue Groups
checking location of files 63
and Delay Points 283
creating new project 58
creating 280
exporting information 70
described 280
opening files 60
Priority settings 283
opening the Project Manager 57
Routing 283
refreshing a project 69
setting parameters 281
removing a file 62
Queues
removing files, scenarios and ver-
sions 66 described 278

saving a project 68 drawing 278

Projects linking to Delay Points 279

creaging new project to manage 58 setting parameters 279

managing 56
R
Properties
Random Noise
ana files 394
applying 164
model files 82
Ranged events
Properties of Layers 209
specifying colour 450
Protecting
Ranges
ana files 394
copying 359
model files 82
deleting 359
Pulse
exporting Colour and Value
applying 159 Ranges 359

with Availability Profiles 160 renaming 359

Pulse Train (Availability Profiles) 160 rdf files 337

506
Legion SpaceWorks R6.5.0 User Guide

Recommended specifications 6 objects in the Analyser 392

Record .AVI Ranges 359

set properties of event track 331, Spatial Objects 205

434
Rendering engine
Record .AVI and .RES tracks
settings 330 Analyser 383

Record .AVI events 436 choosing 317

Record .AVI tracks Simulator 317

adding an Active Camera 437 Repeated Pasting 155

Record Entity Positions event 449 Reports

Recording JT and GJT 410

Analysis 379 res files

setting up (Simulator) 321 adding a full-length Record .RES

event 335
Simulator 321
adding a Record .RES event 335
Rectangle Mode 179
buffering frames 337
Rectangular Array
Changing start and end times of a
creating 196 Record .RES event 448

Refining the drawing of Spatial excluding Legion metrics 337

Objects 189
performance 337
Refreshing a managed project 69
recording 335
Regenerating objects 90
recording properties 330
Removing a model file from a man-
aged project 62 splitting large files 337

Removing files, scenarios and ver- RES files

sions from a managed upgrading 376
project 66
upgrading per project 376
Renaming
upgrading with Results Upgrade
a Scenario 169 Tool 376
Analyses 408 Reset interval (Maps) 350
Data Profile 157 Resolving spatial conflicts (Focal Drift
Layers 215 Zones) 297

Maps 367 Restrictions (Conditions) 240

© 2001–2017 Legion International Ltd 507

Legion SpaceWorks R6.5.0 User Guide

Results files auto-saving your work (Analyser)

393
ugrading 376
auto-saving your work (Model
Results Upgrade Tool 376 Builder) 84
Returning a detached network current view
licence 17
(Analyser) 364
Rotating Spatial Objects 194
current view (Analyser) 391
Route by Entity Choice 221
current views 90
(Queue Groups) 222
current views (Simulator) 325
(Queues) 222
Graphs 422
Route by Entity Type 221
imported CAD files 34
Route by Percentage Weighting 219
Saving computer memory 321
Route Guides 299
Scaling Spatial Objects 195
Routing
Scanning ability of Entities 182
by Entity Choice 222
Scenario Manager 167
by Entity Type 221
opening 167
by Percentage Weighting 219
Scenarios 167
Routing Layer
adding 168
selecting target for 213
adding a new file to a managed
Running an Analysis 396 scenario 65

adding to a managed project 64

S
advanced modifications 169
Save 15-minute Underground Maps
track properties 441 Base Scenario 167

Save 60-minute Underground Maps deleted objects and 170

track properties 441
deleting 169
Save Snapshot events 448
described 167
Saving
exporting models as ora file 170
a managed project 68
general remark on using 169
a model 82
Manager 167
all graphs 423
renaming 169
all Maps 365

an ana file 393

508
Legion SpaceWorks R6.5.0 User Guide

Screen Camera track Setting key parameters

setting properties 440 for Max/Mean/Min Density

Maps 342
Screen Camera Track (Analyser) 445
Setting length of Entity Trails 323,
Search Results 78, 204 387
Searching Setting up a Simulator batch run 476
for Spatial Objects 200 Setting up Analyses 407
selecting criteria 200 Setting up Conditions 238
with the Command Bar 202 Shape of Spatial Objects
Selecting changing 193
entries in a data graph 153 Showing and hiding group objects 306
Spatial Objects 190 Showing and hiding Layers 210
Selection Segment Showing the Grid 189
Direction Modifier 288 Simulation Seed
placing 288 specifying 320
Sending feedback 95 Simulations
Sentinel HASP 10 playing 318
Set Record .AVI track properties 331, playing back 317
434
principles of movement 26
Set Record .RES track properties 331
Simulator
Setting
Batch runs 475
current time 385
choosing rendering engine 317
current time (Timeline) 450
components 314
Graph tracks properties 440
defining Events 335
Mesoscopic Transition Zone para-
meters 301 described 312

model properties 87 Entity Colour Schemes 314

parameters of Spatial Objects 187 Event tracks 329

Record Entity Positions track prop- increasing speed 324

erties 440
interface 313
Screen Camera track
properties 440 last step and preferred
direction 318

© 2001–2017 Legion International Ltd 509

Legion SpaceWorks R6.5.0 User Guide

logging playback information 321 SpaceWorks

main menu 314 64-bit version 4

opening a model 317 accessible space 21

Output Bar 315 SpaceWorks commands 480

overview 4 SpaceWorks components

Playback toolbar 316 docking 80

playing and recording using the moving and hiding 80

Timeline 329
Spatial conflicts 295
playing back a simulation 317
resolving 297
printing 325
Spatial Objects 24
sending feedback 325
Activity Objects 24, 173
setting display preferences 318
adding or deleting a vertex 194
setting up a recording 321
adding several links at once 225
specifying the simulation seed 320
Analysis Objects 24, 174
starting 312
area and Focal Segment 176
Status Bar 316
basics 172
Timeline 316, 327-328
catalogues 463
toolbars 314
changing the shape of 193
tracking Entities 322
comprehensive guide 246
viewing Entity details 324
copying 191
viewing window 314
copying geometry 199
Size of Spatial Objects 182
copying links from 226
Slice file (Environment Map) 355
cutting 191
Snaps
deleting 182
described 189
drawing and placing 179
priority of 190
editing 204
using 189
Entities’ scanning abilities 182
Snapshot event 448
Focal Segments 176
Space Utilisation Map 342
form of 176

Gates 268

510
Legion SpaceWorks R6.5.0 User Guide

group-editing 204 Spread

in detail 244 applying 160

mirroring 198 described 160

moving 192 undoing the last Spread 162

naming pasted objects 191 Stacked Column Graph 421

parameters described 245 Stacked Histogram 421

pasting 191 Stairs 259

Polar Array 197 automated flow rates 408

Rectangular Array 196 changing direction of Entities 262

refining the drawing of 189 creating a single stair 260

renaming 205 described 259

rotating 194 distance factors 267

scaling 195 links 263

selecting 190 Routing Layers 263

setting parameters of 187 splitting across separated CAD 259

size of 182 Stairs and Escalators parameters

(Drift Zones) 291
trimming 195
Standard Maps 342
Types of 173
Starting
using the Grid 189
Legion SpaceWorks 9
Specifying the Simulation Seed 320
the Analyser 371
Speed
the Model Builder 82
increasing in simulations 324
the Simulator 312
Speed Change parameters 290
Starting Desire Line Diagram gen-
Speed Profile eration 461
applying user-defined 100 Status Bar 79
Split Analyser 375
applying 165 Model Builder 79
described 165 Simulator 316
Splitting large res files 337 Statuses of links 229

© 2001–2017 Legion International Ltd 511

Legion SpaceWorks R6.5.0 User Guide

Store adding a full-length event 335

objects 463 adding a Record .RES event 335

Summary of Evacuation Zones 255 adding a Save Map event 442

Supply Type adding an Active Camera to a

Record .AVI track 437
creating 104
aligning avi components 333
editing 105
batch runs with multiple
Supply Types 22 Timelines 478
creating and editing 104 change start and end times of Save
exporting 106 Map event 443

importing 106 changing event properties 450

changing position and height of

T tracks 330, 438

Target Changing start and end times of a

Record .RES event 448
for Routing Layer 213
changing start and end times of an
Target Availability event 336
with Delay Points 273 changing the Zoom level 328, 431
with most objects 220 closing 339, 451
Target Parameters 278 components 328
Target Parameters tab 188 customising avi layout 332
Target Rules (Direction Modifiers) default Tracks and Events 330
287
defining events 335
Templates
deleting events 339, 450
object 472
deleting Tracks 439
Time-pointer 329
disabling and enabling events 329,
Time-track 328 431
Time Marks duplicating tracks 438
adding 450 Event Tracks 329
Deleting 451 moving and docking 339, 451
Timeline overlapping events 338
about 327 playback toolbar 328
About (Simulator) 327 playing and recording 329

512
Legion SpaceWorks R6.5.0 User Guide

Record .AVI and .RES tracks set- properties 439, 441

tings 330
Track properties
Record .AVI events 337, 436
Save 15-minute Maps 441
Record .RES events 335
Save 60-minute Maps 441
Save Snapshot events 448
Tracking Entities 322, 386
Screen Camera track events 445
length of trails 323, 387
selecting and moving instant-
aneous events 450 Tracking Entities by filter 387

setting a Layer View 447 Tracks

setting Active Camera 447 Analyser 434

setting current time 450 changing position and height 330,

438
setting properties for record
tracks 330 defaults 330

setting Zoom Level 328 setting Graphs track

properties 440
Snapshot event 448
setting properties for Record
specifying colour of ranged tracks 330
events 338, 450
the Record Entity Positions track
Time-pointer and Drag-marker 329 properties 440

Time-track 328 Tracks and Events 329

Time Marks 450 Transferring Entities between floor

plans 38
Track control icons 330, 438
Trimming Spatial Objects 195
Track Properties (Analyser) 439
Types of Layer 208
Toolbars

Analyser 373 U
creating a custom toolbar 75 Underground
Model Builder 74 Entity Colour Scheme 359
repositioning 74 options for Maps 344
simulator 314 Underground Cumulative High Density
(15-minute) Map 343
turning a toolbar off 74
Underground Cumulative High Density
Track
(60 mins) Map 343
control icons 330, 438
Underground Cumulative High Density
Entity Colour Scheme 359

© 2001–2017 Legion International Ltd 513

Legion SpaceWorks R6.5.0 User Guide

Underground Cumulative Mean Dens-

ity (15 mins) Map 343 V

Underground Cumulative Mean Dens- Value Ranges

ity (60 mins) Map 343
Alternative 361
Underground Map options 344
creating a custom range 357
Undoing the last Spread 162
described 341
Unlocking Data Graphs 150
exporting 359
Update software 19
importing 359
Updates
Weighted 358
checking for 19
Vehicles
Updating
changing Aimsun results file 320
camera 446
showing in simulations 28
imported file properties 154
showing in the Analyser 386
Upgrading results files 376
showing in the Simulator 319
per project 376
Viewer
with Results Upgrade Tool 376
exporting files 428
User-defined Speed Profile 148
Viewing
User interface
by Type or Layer 77
Analyser 372
Camera Close-up 77
arranging windows 79
Change Logs 54
closing a window 80
Entity details 324
Model Builder 72
Graphs 421
moving windows 79
Layers 215
reopening a window 80
links and filters 234
resizing windows 79
Maps 345
Simulator 313
Viewing accessible space in the Model
Using Alternative Value Ranges 361 Builder 92

Using Help 95 Visibility-based Analysis Zones 182,

402
Using network licences 14

Using Partition Guides 296

514
Legion SpaceWorks R6.5.0 User Guide

W
Waiting

Location parameters 275

Waiting Location parameters 275

Waiting Zones

described 283

drawing 283

setting parameters 283

Weighted Value Range 358

Wildcards 201

Windows

arranging 79

closing 80

moving 79

reopening a window 80

resizing 79

Workspace

Model Builder 74

Workstation licences 10

Z
Zone of Influence 348

Zoom level

changing (Timeline) 328, 431

Zooming 89

into graphs 421

© 2001–2017 Legion International Ltd 515