SIDRA API
Introduction
The SIDRA INTERSECTION Application Programming Interface (API) provides a programming interface that enables external applications to communicate with SIDRA INTERSECTION.
This API provides the following capabilities:
- Extensive programmatic access to the Site / Network input and output data contained in the SIDRA INTERSECTION Project file (extension
.sip) - Ability to create a Project file, add a Site / Network / Common Control Group (CCG) / Route, specify geometry data (e.g. add and remove intersection legs and lanes, specify lane configuration and lane disciplines), specify phasing and timing data, and more
- Provision for processing a Site or Network (running the program)
In addition to the API, full access is provided to input and output data that resides in the Project File database (extension .sip). This data can be accessed directly via SQL queries. Input and output data structures in the SIDRA INTERSECTION project file were developed for this purpose.
Supported Languages
The API assembly can be accessed natively from any .NET Framework (4.7 minimum) programming language, or it can be accessed via classes exposed by COM. The API defines a number of classes and objects which define a simple hierarchy for a SIDRA INTERSECTION Project.
Licence Required
A licensed version of SIDRA INTERSECTION must be installed on a computer before the API can be used.
-
Purchase a SIDRA INTERSECTION licence.
-
Have questions about the API or licensing?
Downloads
Files are available for programmers who want to develop API applications for SIDRA INTERSECTION:
| File | Description |
|---|---|
| Help | Detailed information about all parameters and the structure accessible in the SIDRA INTERSECTION API. |
| Late Binding DLL | A .NET Framework assembly. If your application uses SIDRA INTERSECTION API through .NET Framework, your application needs to reference this DLL file to ensure compatibility with future updates. If your application uses SIDRA INTERSECTION API through COM (e.g. Excel VBA, C++, Python), this file is not required. |
| Sample API programs | Example programs to help you get started with SIDRA INTERSECTION API. |
Important: Unblock the Help file
Before using the Help file for the first time, right-click the file name or icon, select Properties, then select the General tab. If an Unblock checkbox or button is shown, click it to unblock the file. Otherwise, various errors may occur.
All Versions
API applications must match your installed SIDRA INTERSECTION version.
| Version | Help | Late Binding DLL | Samples |
|---|---|---|---|
| SIDRA INTERSECTION 11 | Available at launch | Available at launch | Available at launch |
| SIDRA INTERSECTION 10 | Download | Download | Download |
| SIDRA INTERSECTION 9.1 | Download | Download | Download |
Note
SIDRA INTERSECTION 10 samples require version 10.0.6.236 or later.
Terms
We provide the SIDRA INTERSECTION API to allow development of programs that link to our software for use under the SIDRA SOLUTIONS software licence agreement.
Our provision of access to the SIDRA INTERSECTION API is a non-exclusive, limited right to access and use the API, and it does not create or imply any partnership, agency, or joint venture. The API is provided as is without any warranties, expressed or implied. In using the SIDRA INTERSECTION API, you agree to indemnify and hold us harmless from any losses that may result from third-party claims that relate to your use of the API.
Version Compatibility
The SIDRA INTERSECTION API is updated for each major version of the software. Accordingly, you will need to update your API program to provide a link to the latest version of SIDRA INTERSECTION.
API Workshop 2018
SIDRA SOLUTIONS hosted a half-day workshop to facilitate improved use of the SIDRA Application Programming Interface (API) in Melbourne on 26 November 2018.
The workshop included presentations by SIDRA INTERSECTION developers and users on practical API program examples, demonstrating integrations with major transport modelling software including Aimsun, EMME, DYNAMEQ, and TRACKS.
Downloads
| Resource | Description |
|---|---|
| Transcript of Presentations | Edited version of the audio recording of workshop presentations and discussions |
| Presentation Files | Slide presentation files in PDF format |
| SIDRA BATCH Python Samples | Complete set of SIDRA BATCH Python sample programs using SIDRA API |
Reading the materials
We recommend opening the corresponding presentation files when reading each section of the transcript.
Topics & Presenters
- Welcome and Introduction to SIDRA API Workshop
- Dr Rahmi Akçelik (SIDRA SOLUTIONS) — Leading scientist and software developer with 40 years of practical, research and training experience in road traffic operations, traffic engineering, management and control. Author of the SIDRA INTERSECTION and SIDRA TRIP software packages.
- An Introduction to Using API for SIDRA INTERSECTION 8 and VOLUMES Utility
- Mark Besley (SIDRA SOLUTIONS) — Scientist and software specialist who has worked in traffic management since the 1980s. Makes significant contributions to the development of SIDRA INTERSECTION software in collaboration with Dr Rahmi Akçelik.
- SIDRA BATCH Python Sample Program Using SIDRA API
- Harry Cai (SIDRA SOLUTIONS) — Software Engineer. Completed Master of Applied IT and Master of IT (Minor Thesis) degrees at Monash University. Contributes to the development and support of SIDRA SOLUTIONS software products.
- Aimsun – SIDRA Interface
- Mohammad Saifuzzaman (Aimsun Pty Ltd, A Siemens Company) — Product Specialist with a PhD in Traffic Engineering from Queensland University of Technology (QUT). Transport engineer with over seven years of international experience. Presented use cases and workflow for linking SIDRA with Aimsun Next, with a hands-on demonstration.
- TRACKS – SIDRA Link
- Grant Smith (Transportation and Traffic Systems Ltd) — Director and developer/owner of TRACKS, a land use and transport modelling system software package. Presented the TRACKS-LITE package that links the SIDRA INTERSECTION traffic model with a TRACKS transport model.
- Using SIDRA API for EMME and DYNAMEQ
- Paul van den Bos (Freelance Transport Modeller) — 30 years of traffic and transport modelling experience. Presented his experience linking SIDRA INTERSECTION with EMME and DYNAMEQ transport planning and simulation packages.
- GTASIDRA – A Process Integrator
- Luca Rosati and Rebecca Strachan (GTA Consultants) — Luca is a transport planner, modeller and data analyser with over 20 years of experience across more than 80 projects. Previously with the University of Rome 'Tor Vergata', he has published more than 30 international papers. Presented the GTASIDRA process integrator.
- Discussions on User Needs and API Development
- Group discussion between presenters and the audience on future directions and user requirements.