Skip to content

Getting started

This page gets a working "hello world" running against the SIDRA Intersection COM API.

Prerequisites

  • SIDRA Intersection installed (the API ships with the product). The installer registers the COM type library (SIDRASolutions.SI.API.tlb) and the .NET COM host (SIDRASolutions.SI.API.comhost.dll).
  • A 64-bit host process. The API is net8.0-windows x64-only and cannot be loaded into a 32-bit process. Set your project's Platform target to x64 (not AnyCPU).
  • .NET 8 runtime present on the machine. The SIDRA Intersection installer satisfies this.

[!NOTE] For developer machines without a full SIDRA Intersection install, see COM activation for the registration-free alternative that lets you ship the API with your own application.

Add the reference

C# / VB.NET (Visual Studio)

  1. Project → Add COM Reference → search SIDRA Intersection API 1.0 Type Library.
  2. Visual Studio creates an interop assembly. The types live in the SIDRASolutions.SI.API namespace.
  3. Make sure the project targets x64 and Embed Interop Types is True (recommended).

Python (pywin32)

pip install pywin32

import win32com.client
api = win32com.client.Dispatch("SIDRASolutions.SI.API")

Open a project and read its name

using SIDRASolutions.SI.API;

var api = (ISIAPI)Activator.CreateInstance(Type.GetTypeFromProgID("SIDRASolutions.SI.API"));
api.OpenProject(@"C:\Samples\MyProject.sip");

ISIAPIProject project = api.Project;
Console.WriteLine($"Opened: {project.Name}");
Console.WriteLine($"Sites:   {project.SiteFolders.Count}");

The entry interface is always ISIAPI. Once a project is open, ISIAPI.Project returns the ISIAPIProject wrapper which is your gateway to sites, networks, intersections, and analyses.

Next steps

  • COM activation — registered vs. registration-free hosting, plus deployment notes.
  • Object model — the Project → Site → Intersection → Leg → LaneMovement hierarchy.
  • C# sample — a runnable console app that opens a project and dumps results.