# SIDRA API - full documentation

> Developer documentation for the SIDRA Intersection COM API.

Concatenation of the markdown sources of this documentation site:
hand-authored guides and samples first, then one section per public
API type. Each document starts with a SOURCE line naming its path;
API pages are also available individually under api-md/.

==============================================================================
SOURCE: introduction.md
==============================================================================

---
title: Introduction
description: Create projects, work with Site and Network data, and run SIDRA INTERSECTION analyses from your own applications.
hide:
  - toc
---

<div class="sidra-introduction" markdown>

# Introduction

Use the SIDRA INTERSECTION API to create and update projects, work with Site
and Network data, run analyses, and read results from your own applications.

Windows 64-bit · .NET 8 · C# / VB.NET · C++ · Python
{ .sidra-intro-platform }

<div class="sidra-intro-cards" markdown>

-   :material-rocket-launch-outline:{ .sidra-intro-icon } [__Getting started__](getting-started.md)

    Set up your environment and open your first SIDRA project.

-   :material-file-tree:{ .sidra-intro-icon } [__Object model__](concepts/object-model.md)

    Understand Projects, Sites, Networks and the objects that connect them.

-   :material-code-braces:{ .sidra-intro-icon } [__Code samples__](samples/index.md)

    Explore C#, C++ and Python examples for opening projects, running analyses
    and reading results.

-   :material-book-open-variant:{ .sidra-intro-icon } [__API reference__](api/index.md)

    Find types, methods, properties and parameters for this API version.

-   :material-download:{ .sidra-intro-icon } [__Downloads__](downloads.md)

    API files, sample projects and workshop materials.

-   :material-shield-check-outline:{ .sidra-intro-icon } [__Licensing__](licensing.md)

    Check licence requirements, request a quote and review the terms of use.

</div>

<section class="sidra-intro-footer" id="licence-required" aria-labelledby="before-you-begin" markdown>

## Before you begin

These docs cover **SIDRA INTERSECTION 11.0.3**. Install and license
that version on the computer running your application. For another release,
use the documentation version that matches your installation.

<div class="sidra-intro-links" id="terms" markdown>

- [:material-shield-check-outline:{ aria-hidden="true" } Licensing and terms](licensing.md#licence-required)
- [:material-text-box-outline:{ aria-hidden="true" } Release notes](release-notes.md)
- [:material-robot-outline:{ aria-hidden="true" } For AI agents](AGENTS.md)
- [:material-email-outline:{ aria-hidden="true" } Contact](contact.md)

</div>

</section>

</div>

==============================================================================
SOURCE: getting-started.md
==============================================================================

---
title: Getting started
description: Install the SIDRA Intersection COM API and open your first project.
---

# Getting started

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

## Prerequisites

- **SIDRA INTERSECTION 11.0.3 installed and licensed** (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.
- **A SIDRA project (`.sipx`) file** to open. Save one from SIDRA Intersection,
  or point the samples at any existing project file.

Your application can check the installed copy with
[`ISIAPI.IsLicensed`](api/sidrasolutions.si.api.isiapi.md#islicensed), which
returns `false` for an unlicensed copy or one running in Trial Mode. See
[Licensing](licensing.md) for licence requirements.

## Supported languages

The API is a .NET 8 assembly for 64-bit Windows. The host process must be
64-bit in every language.

| Language | How it accesses the API |
| --- | --- |
| C# / VB.NET | Reference the late-binding wrapper `LB_SI11API.dll`, targeting `net8.0-windows` and x64. |
| C++ | Use the COM type library registered by the SIDRA INTERSECTION installer. |
| Python | Use Python.NET to host the .NET 8 runtime and load the API assembly directly. |

## Add the reference

### C# / VB.NET

The API ships with a late-binding wrapper assembly, `LB_SI11API.dll`, that
exposes the `SIDRASolutions.SI.API` types and loads the installed SIDRA
Intersection runtime at run time. Reference it directly instead of going
through COM:

1. Download the [Version 11 late-binding wrapper](downloads.md#sidra-intersection-11)
   and extract `LB_SI11API.dll` and its `LB_SI11API.deps.json` into your project.
2. Add an assembly reference to it (a `<Reference Include="LB_SI11API">` with a
   `<HintPath>`; see the [C# sample](samples/csharp.md)).
3. Target **`net8.0-windows`** and **x64** (not `AnyCPU`).

### C++

Use the installed `SIDRASolutions.SI.API.tlb` type library from a 64-bit
Visual C++ project with ATL. Initialise COM on an STA thread before creating
the API object. The [C++ sample](samples/cpp.md) includes the type-library
import, build instructions and cleanup.

### Python (Python.NET)

Python does not go through COM. Use [Python.NET](https://pythonnet.github.io/)
(`pythonnet`) to host the .NET 8 runtime and load the API assembly directly:

```bash
pip install pythonnet
```

```python
import os
from pythonnet import set_runtime
from clr_loader import get_coreclr

sidra = r"C:\Program Files\SIDRA SOLUTIONS\SIDRA INTERSECTION 11"

# Host the API's own .NET 8 runtime via its runtimeconfig, then load the DLL.
set_runtime(get_coreclr(
    runtime_config=os.path.join(sidra, "SIDRASolutions.SI.API.runtimeconfig.json")))

import clr
clr.AddReference(os.path.join(sidra, "SIDRASolutions.SI.API.dll"))

from SIDRASolutions.SI.API import SIAPI
api = SIAPI()
```

See the [Python sample](samples/python.md) for locating the install folder
from the registry and reading results.

## Open a project and read its name

```csharp
using System;
using SIDRASolutions.SI.API;

class Program
{
    [STAThread]
    static void Main()
    {
        var api = new SIAPI();
        try
        {
            if (!api.IsLicensed)
                throw new InvalidOperationException("SIDRA INTERSECTION must be licensed.");

            if (!api.OpenProject(@"C:\Samples\MyProject.sipx"))
                throw new InvalidOperationException(api.LastErrorMessage);

            ISIAPIProject project = api.Project;
            Console.WriteLine($"Opened: {project.Name}");
            Console.WriteLine($"Site folders: {project.SiteFolders.Count}");
        }
        finally
        {
            api.Close();
        }
    }
}
```

The entry interface is always [`ISIAPI`](api/sidrasolutions.si.api.isiapi.md).
Once a project is open, `ISIAPI.Project` returns the
[`ISIAPIProject`](api/sidrasolutions.si.api.isiapiproject.md) wrapper which is
your gateway to Sites (intersections), Networks and analyses.

## Next steps

- [Object model](concepts/object-model.md): the
  `Project -> Site -> Leg -> Lane` hierarchy.
- [Code samples](samples/index.md): choose a C#, C++ or Python walkthrough.
- [Downloads](downloads.md): API files and sample projects for your version.
- [Troubleshooting](troubleshooting.md): if the API fails to load,
  activate, or open your project.

==============================================================================
SOURCE: concepts/object-model.md
==============================================================================

---
title: Object model
description: The hierarchy of objects exposed by the SIDRA API.
---

# Object model

The COM API exposes a tree-shaped object model rooted at
[`ISIAPI`](../api/sidrasolutions.si.api.isiapi.md). Each level is a thin COM
wrapper over an internal SIDRA Intersection domain object.

## What you can do

The API provides programmatic access to Site and Network input and output
data in a SIDRA INTERSECTION Project file (`.sipx`). You can:

- Create or open a Project and add Sites, Networks, Common Control Groups
  (CCGs) and Routes.
- Specify geometry: add or remove intersection legs and lanes, configure
  lanes and set lane disciplines.
- Specify phasing and timing data and other analysis inputs.
- Process a Site or Network from your application and read its results
  through the output objects.

## Hierarchy

```
ISIAPI                                   (root, one per process)
  Project: ISIAPIProject
    SiteFolders: ISIAPISiteFolders
      <SiteFolder>: ISIAPISiteFolder
        Sites: ISIAPISites
          <Site>: ISIAPISite             (in SIDRA, a "site" is an intersection)
            Legs: ISIAPILegs
              <Leg>: ISIAPILeg
                LaneApproachs: ISIAPILaneApproachs
                LaneExits: ISIAPILaneExits
                Islands: ISIAPIIslands
            Analysis: ISIAPIAnalysis       (analysis parameters for the site)
            Outputset: ISIAPIOutputset     (results, populated by Site.Process())
            DiagnosticMsgs: ISIAPIDiagnosticMsgs
            ...
    NetworkFolders: ISIAPINetworkFolders
      <NetworkFolder>: ISIAPINetworkFolder
        Networks: ISIAPINetworks
          <Network>: ISIAPINetwork
            NetworkSites: ISIAPINetworkSites
            OutputNetwork: ISIAPIOutputNetwork  (results, populated by Network.Process())
            ...
```

!!! note
    There is no separate "intersection" object: an `ISIAPISite` **is** the
    intersection. Its `Legs`, `Analysis`, and `Outputset` describe that
    intersection directly.

## Conventions

- **`I...` singular** types model a single domain object
  (`ISIAPISite`, `ISIAPILeg`, ...).
- **`I...s` plural** types are indexed collections
  (`ISIAPISites`, `ISIAPILegs`, ...). They expose `Count` and an
  indexer; iterate with a plain `for` loop, because COM collections do not
  always implement `IEnumerable<T>` in a way that idiomatic C# `foreach`
  expects.
- **`I..._<variant>`** types model alternative parameter sets or analysis
  variants (e.g. `ISIAPILeg_roundabout`, `ISIAPILeg_rou_hcm`).
- **`...MC` types** are *Movement Class*-specific (heavy vehicles, buses,
  bicycles, etc.) versions of the corresponding non-MC type.

## Lifecycle

1. Activate the API. There is one `ISIAPI` per process.
2. Open or create a project (`ISIAPI.OpenProject`,
   `ISIAPI.CreateAndOpenProject`). Until then `ISIAPI.Project` and the rest of
   the navigation tree return `null`.
3. Read or mutate sites, networks, and parameters via the property tree.
   [`ISIAPISite.Analysis`](../api/sidrasolutions.si.api.isiapianalysis.md) holds
   the analysis parameters for a site.
4. Run the analysis with [`ISIAPISite.Process()`](../api/sidrasolutions.si.api.isiapisite.md)
   (or [`ISIAPINetwork.Process()`](../api/sidrasolutions.si.api.isiapinetwork.md)
   for a network).
5. Read outputs from [`ISIAPISite.Outputset`](../api/sidrasolutions.si.api.isiapioutputset.md)
   (`ISIAPINetwork.OutputNetwork` for networks) and the `ISIAPIOutput*` types.
6. Save with `ISIAPI.SaveProject()` and call `api.Close()` when finished.
   COM clients also release their interface references before uninitialising COM.

## Threading

The API is **single-threaded apartment (STA)**. Marshal calls back onto the
thread that activated `ISIAPI`, or use a dedicated STA helper thread. Calls
from a worker thread will throw `RPC_E_WRONG_THREAD` (`0x8001010E`).

==============================================================================
SOURCE: troubleshooting.md
==============================================================================

---
title: Troubleshooting
description: Diagnose bitness, runtime, COM activation, licensing, and project-file failures when driving the SIDRA Intersection API.
---

# Troubleshooting

Work through this page when the API fails to load, activate, open a
project, or return results. It applies to SIDRA INTERSECTION 11.0.3 and
the samples on this site.

## First checks

1. **Is your process 64-bit?** The single most common failure. See below.
2. **Is SIDRA Intersection 11 installed and licensed on this machine?**
   The API ships with the product and drives the installed runtime.
3. **Is the .NET 8 runtime present?** The installer satisfies this.
4. **Does the `.sipx` path you pass to `OpenProject` exist**, and is it a
   project saved by SIDRA Intersection?

## The host process must be 64-bit

The API is `net8.0-windows` and x64-only. It cannot be loaded into or
activated from a 32-bit process, whatever the language.

| Language | Requirement |
|---|---|
| C# / VB.NET | Set *Platform target* to `x64`. Do not rely on `AnyCPU`: it lets the host decide the bitness at load time, and a 32-bit host (or a "Prefer 32-bit" setting) fails to load the API. The [C# sample](samples/csharp.md) project file pins `<PlatformTarget>x64</PlatformTarget>`. |
| Python | Use a 64-bit Python interpreter. A 32-bit interpreter cannot load the assembly. |
| PowerShell | Use a 64-bit host. A 32-bit host fails to activate the COM class with `0x80040154 REGDB_E_CLASSNOTREG`. `powershell.exe` and `pwsh` are 64-bit on 64-bit Windows unless you launched the (x86) variant. |
| C++ | Build the x64 configuration. A 32-bit build fails at `CoCreateInstance`. |

To confirm at run time, read
[`ISIAPI.IntPtrSize`](api/sidrasolutions.si.api.isiapi.md): it reports the
host pointer size in bytes and should be `8` in a 64-bit process.

## .NET 8 runtime requirements

The API targets .NET 8 on Windows. The SIDRA Intersection installer puts
the required runtime on the machine; nothing extra is needed on a machine
with the product installed. If the runtime was removed or you are
diagnosing a bare machine, install the **.NET 8 Desktop Runtime (x64)**.
C# and VB.NET host projects must target `net8.0-windows`.

## COM registration and activation failures

C++ and PowerShell activate the API through COM. The SIDRA Intersection
installer registers the type library (`SIDRASolutions.SI.API.tlb`) and the
.NET COM host (`SIDRASolutions.SI.API.comhost.dll`).

`0x80040154 REGDB_E_CLASSNOTREG` (or "SIDRA Intersection COM API is not
registered") means one of:

- The host process is 32-bit (most common; see above). The registration
  is x64-only, so a 32-bit host cannot see it.
- SIDRA Intersection 11 is not installed on this machine.
- The registration is damaged. Reinstall or repair SIDRA Intersection to
  restore it.
  <!-- PRODUCT-OWNER: confirm the supported way to repair COM registration
       (installer repair vs full reinstall) for 11.0.3. -->

The SIDRA Intersection runtime requires a **single-threaded apartment**:
initialise COM with `CoInitialize` (STA, as the
[C++ sample](samples/cpp.md) does) and mark .NET entry points
`[STAThread]` (as the [C# sample](samples/csharp.md) does).

## Missing API or late-binding assemblies

**C# / VB.NET:** the project references the late-binding wrapper
`LB_SI11API.dll`, which must sit next to your executable together with its
`LB_SI11API.deps.json`. A `FileNotFoundException` for `LB_SI11API` at
startup means the DLL (or the deps file) was not copied or the
`<HintPath>` is wrong. The wrapper then locates and loads the installed
SIDRA Intersection runtime, so the product must be installed even though
you never reference its folder directly.

**Python:** the API assembly is loaded by full path from the install
folder, which holds `SIDRASolutions.SI.API.dll` alongside its
`SIDRASolutions.SI.API.runtimeconfig.json`. Read the folder from the
registry value
`HKLM\SOFTWARE\SIDRA SOLUTIONS\SIDRA INTERSECTION 11\InstallLocation`
(as the [Python sample](samples/python.md) does) rather than hard-coding
a path. If that key is missing, SIDRA Intersection 11 is not installed.

## Python.NET fails to initialize

Python.NET 3.x can host either .NET Framework or CoreCLR, and on Windows
it may default to .NET Framework. The API needs CoreCLR (.NET 8), so:

- Call `set_runtime(get_coreclr(runtime_config=...))` with the API's own
  `SIDRASolutions.SI.API.runtimeconfig.json` **before the first
  `import clr`**. Once `clr` has been imported the runtime choice is
  fixed for the process; restart the interpreter if you got it wrong.
- Errors about .NET Framework versions, or `clr.AddReference` failing on
  a valid path, usually mean the wrong runtime was selected.
- The [Python sample](samples/python.md) shows the full working sequence.

## Licensing failures

[`ISIAPI.IsLicensed`](api/sidrasolutions.si.api.isiapi.md) reports whether
the installed SIDRA Intersection is licensed. Check it after creating the
API object and before relying on results. If it returns `false`, resolve
licensing in SIDRA Intersection itself (run the product and confirm it is
activated) before using the API.
<!-- PRODUCT-OWNER: confirm exactly how API calls behave when unlicensed
     (which members fail, return values, LastErrorMessage text) for
     11.0.3, and document it here. -->

## Project file (.sipx) problems

`OpenProject` returns `false` on failure; read
[`ISIAPI.LastErrorMessage`](api/sidrasolutions.si.api.isiapi.md) for the
reason. Common causes:

- **The path does not exist** or the process cannot read it (network
  shares and permissions included). Check the exact string you passed.
- **The file is not a `.sipx` project.** SIDRA Intersection 11 projects
  use the `.sipx` extension, as do Version 10 projects. For legacy formats,
  follow the product's
  [project-file conversion instructions](https://docs.sidrasolutions.com/intersection/updates/project-file-format/)
  before opening the converted project through the API.
- **The file is locked or already open**, for example in the SIDRA
  Intersection application. Close it there first.
  <!-- PRODUCT-OWNER: confirm the exact behavior/error when opening a
       locked project file. -->

## Where the API reports errors

- Most operations (`OpenProject`, `SaveProject`, `Process`, ...) return a
  boolean: `true` on success and `false` on failure. They do not throw on
  ordinary failures, so **check every return value**.
- After a `false`, [`ISIAPI.LastErrorMessage`](api/sidrasolutions.si.api.isiapi.md)
  holds the failure text.
- In C++ every member additionally returns an `HRESULT`; a failed
  `HRESULT` signals a COM-level problem (activation, marshalling) rather
  than a SIDRA-level one.

## Diagnostics to collect before requesting support

Collect these before reporting a problem; they answer the first round of
questions in one pass:

1. SIDRA Intersection version (Help > About), and that the product runs
   and is licensed on the same machine.
2. The documentation version you followed (the version selector in the
   top bar, e.g. `11.0.3`).
3. Language and runtime: .NET SDK version, Python and `pythonnet`
   versions, PowerShell host and version, or Visual Studio toolset.
4. Process bitness (the `IntPtrSize` check above).
5. The exact error: full exception text or `HRESULT`, plus
   `LastErrorMessage` where available.
6. The smallest snippet that reproduces the problem, ideally one of the
   samples from this site with only the project path changed.
7. Whether the same `.sipx` opens normally in SIDRA Intersection itself.

## Versioned documentation and support

This documentation is versioned with the API. Each release is a full
snapshot under `/<version>/`, and the version selector in the top bar
switches between them.

- **Match the docs to your installation.** These docs cover SIDRA INTERSECTION
  11.0.3. Select the documentation version that matches your installation.
- **`latest` moves.** The `/latest/` alias always points at the newest
  release, so bookmark a specific version for long-lived references.
- **Corrections are republished in place.** Documentation fixes for an
  existing release update that version's snapshot without a new version
  number.
- **API contract changes never appear silently.** A changed or added
  member means a new API release with its own documentation version and
  [release notes](release-notes.md) entry.

To report a problem with the API or with this documentation,
[contact SIDRA SOLUTIONS](contact.md). Include
the diagnostics listed above and the documentation URL, with its version,
for anything that looks wrong on this site.

For licence requirements, quote requests and terms of use, see
[Licensing](licensing.md).

==============================================================================
SOURCE: samples/index.md
==============================================================================

---
title: Code samples
description: Choose a C#, C++ or Python walkthrough for opening SIDRA projects, processing Sites and reading results.
---

# Code samples

Choose a language to open a SIDRA project, process its Sites and read results.
Complete the [Getting started](../getting-started.md) prerequisites first:
a licensed SIDRA INTERSECTION installation, a 64-bit host and a project file.

| Language | Binding | Walkthrough |
| --- | --- | --- |
| C# | Late-binding wrapper, .NET 8, x64 | [Build a console application](csharp.md) |
| C++ | COM type library, Visual C++ with ATL, x64 | [Build a COM client](cpp.md) |
| Python | Python.NET with .NET 8 and 64-bit Python | [Run a Python script](python.md) |

VB.NET applications can use the same late-binding wrapper as C#. See
[C# / VB.NET setup](../getting-started.md#c-vbnet) for the reference and target
requirements.

For downloadable sample projects and previous-version samples, see
[Downloads](../downloads.md). If a sample fails to load the API or open your
project, see [Troubleshooting](../troubleshooting.md).

==============================================================================
SOURCE: samples/csharp.md
==============================================================================

---
title: C# sample
description: A runnable C# console application that opens a SIDRA Intersection project and reads results.
---

# C# sample

A minimal console app that opens a SIDRA project, processes every site, and
prints its level of service and degree of saturation.

!!! note
    Complete the [Getting started](../getting-started.md) prerequisites first
    (SIDRA Intersection installed, 64-bit, .NET 8). You also need a SIDRA
    project (`.sipx`) file to open. Save one from SIDRA Intersection, or point
    the sample at any existing project. Replace `C:\Samples\Demo.sipx` below with
    its path. If anything fails, see [Troubleshooting](../troubleshooting.md).

## 1. Create the project

```bash
dotnet new console -n SidraSample
cd SidraSample
```

Copy the late-binding wrapper assembly `LB_SI11API.dll` (and its
`LB_SI11API.deps.json`) into the project folder, then replace the generated
`SidraSample.csproj` with this. It targets x64 and references the wrapper:

```xml
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0-windows</TargetFramework>
    <UseWindowsForms>true</UseWindowsForms>
    <Platforms>x64</Platforms>
    <PlatformTarget>x64</PlatformTarget>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.CSharp" Version="4.7.0" />
  </ItemGroup>
  <ItemGroup>
    <Reference Include="LB_SI11API">
      <HintPath>LB_SI11API.dll</HintPath>
    </Reference>
  </ItemGroup>
</Project>
```

`LB_SI11API.dll` exposes the `SIDRASolutions.SI.API` types and loads the
installed SIDRA Intersection runtime for you at run time, so you instantiate
the API directly rather than activating it through COM. Download the wrapper
from [LB_SI11API.zip](https://www.sidrasolutions.com/downloads/si/11/api/LB_SI11API.zip).

## 2. Write the program

`Program.cs`:

```csharp
using System;
using SIDRASolutions.SI.API;

class Program
{
    [STAThread]   // the SIDRA Intersection runtime requires an STA thread
    static void Main()
    {
        // The wrapper loads the installed API; just instantiate SIAPI.
        var api = new SIAPI();

        try
        {
            if (!api.OpenProject(@"C:\Samples\Demo.sipx"))
                throw new InvalidOperationException($"Could not open project: {api.LastErrorMessage}");

            var project = api.Project;
            Console.WriteLine($"Project: {project.Name}");

            // Project -> SiteFolders -> Sites. In SIDRA a "site" is an intersection.
            var folders = project.SiteFolders;
            for (int f = 0; f < folders.Count; f++)
            {
                var sites = folders[f].Sites;
                for (int s = 0; s < sites.Count; s++)
                {
                    var site = sites[s];

                    site.Process();   // run the analysis for this site

                    // Site-level vehicle results live under Outputset.OutputSiteVehicle.
                    var result = site.Outputset.OutputSiteVehicle;
                    Console.WriteLine($"  {site.Name}: LOS {result.Level_of_service}, " +
                                      $"degree of saturation {result.Deg_satn:F3}");
                }
            }
        }
        finally
        {
            api.Close();   // shuts down the SIDRA Intersection runtime
        }
    }
}
```

## 3. Run it

```bash
dotnet run
```

Expected output (values depend on your project):

```text
Project: Demo
  North Rd / Main St: LOS B, degree of saturation 0.742
  East Ave / Main St: LOS C, degree of saturation 0.871
```

!!! warning "Important"
    Always call `api.Close()` when you are finished (a `try`/`finally` is the
    safest place). It shuts down the SIDRA Intersection runtime the wrapper
    started; skipping it can leave the process running in the background.

## Reading detailed outputs

Each site's results hang off [`ISIAPISite.Outputset`](../api/sidrasolutions.si.api.isiapioutputset.md):

- `Outputset.OutputSiteVehicle`: site totals (LOS, degree of saturation,
  delay, queues) used above.
- `Outputset.OutputLegs`: per-leg results.
- `Outputset.OutputMovementVehicleODs`: per-movement results.

See the [API reference](../api/index.md) for the full surface.

!!! note
    **VB.NET** consumes the API identically: same `net8.0-windows` x64 project,
    same `LB_SI11API.dll` reference, same `New SIAPI()` instantiation.
    Translate the snippet above to VB.NET syntax; the API surface and the
    per-member VB.NET tabs in the [API reference](../api/index.md) are unchanged.

==============================================================================
SOURCE: samples/cpp.md
==============================================================================

---
title: C++ sample
description: Drive the SIDRA Intersection API from C++ via COM and the type library (#import).
---

# C++ sample

C++ drives the API as a COM client. Import the type library with `#import` to
generate strongly typed interface wrappers in the `SIDRASolutions_SI_API`
namespace, then activate the API with `CoCreateInstance`. This sample opens a
SIDRA project, processes every site, and prints its level of service and degree
of saturation.

!!! note
    Complete the [Getting started](../getting-started.md) prerequisites first
    (SIDRA Intersection installed, 64-bit, .NET 8). You also need a SIDRA
    project (`.sipx`) file to open. Save one from SIDRA Intersection, or point
    the sample at any existing project. Replace `C:\Samples\Demo.sipx` below
    with its path. If anything fails, see [Troubleshooting](../troubleshooting.md).

!!! warning "Important"
    Build for **x64**. The SIDRA API is x64-only; a 32-bit build fails to
    activate it. The sample uses ATL helpers (`CComPtr`, `CComBSTR`), so build
    with the Microsoft Visual C++ toolset (Visual Studio with the ATL
    component installed).

## 1. Import the type library

The installer ships the type library `SIDRASolutions.SI.API.tlb` in the SIDRA
Intersection program folder. Import it with `#import` by using its GUID so the
compiler generates the interface declarations. The `raw_interfaces_only` attribute keeps the raw
`get_`/`put_` accessors (rather than throwing wrapper methods), which is what
this sample uses.

```cpp
#include <atlcomcli.h>   // CComPtr, CComBSTR
#include <iostream>

// Import the SI API v11 type library by using its GUID. Change the GUID for other versions.
#import "libid:a640d48f-577d-40a7-b91a-14c06a14f03b" raw_interfaces_only
using namespace SIDRASolutions_SI_API;
```

## 2. Write the program

```cpp
int main()
{
    if (FAILED(CoInitialize(nullptr)))
    {
        std::wcerr << L"Failed to initialize COM.\n";
        return 1;
    }

    {   // inner scope so every CComPtr releases before CoUninitialize()
        CComPtr<ISIAPI> api;
        if (FAILED(api.CoCreateInstance(__uuidof(SIAPI))))
        {
            std::wcerr << L"SIDRA Intersection COM API is not registered.\n";
            CoUninitialize();
            return 1;
        }

        VARIANT_BOOL opened = VARIANT_FALSE;
        api->OpenProject(CComBSTR(L"C:\\Samples\\Demo.sipx"), &opened);
        if (!opened)
        {
            CComBSTR error;
            api->get_LastErrorMessage(&error);
            std::wcerr << L"Could not open project: "
                       << (error.m_str ? error.m_str : L"") << L"\n";
            api->Close(&opened);
            CoUninitialize();
            return 1;
        }

        CComPtr<ISIAPIProject> project;
        api->get_Project(&project);

        CComBSTR projectName;
        project->get_Name(&projectName);
        std::wprintf(L"Project: %ls\n", projectName.m_str);

        // Project -> SiteFolders -> Sites. In SIDRA a "site" is an intersection.
        CComPtr<ISIAPISiteFolders> folders;
        project->get_SiteFolders(&folders);

        long folderCount = 0;
        folders->get_Count(&folderCount);
        for (long f = 0; f < folderCount; ++f)
        {
            CComPtr<ISIAPISiteFolder> folder;
            folders->get_Item_2(f, &folder);   // get_Item_2 retrieves by position

            CComPtr<ISIAPISites> sites;
            folder->get_Sites(&sites);

            long siteCount = 0;
            sites->get_Count(&siteCount);
            for (long s = 0; s < siteCount; ++s)
            {
                CComPtr<ISIAPISite> site;
                sites->get_Item_2(s, &site);

                VARIANT_BOOL processed = VARIANT_FALSE;
                site->Process(&processed);   // run the analysis for this site

                // Site-level vehicle results live under Outputset.OutputSiteVehicle.
                CComPtr<ISIAPIOutputset> outputset;
                site->get_Outputset(&outputset);

                CComPtr<ISIAPIOutputSiteVehicle> result;
                outputset->get_OutputSiteVehicle(&result);

                CComBSTR siteName, los;
                site->get_Name(&siteName);
                result->get_Level_of_service(&los);

                float degSatn = 0.0f;
                result->get_Deg_satn(&degSatn);

                std::wprintf(L"  %ls: LOS %ls, degree of saturation %.3f\n",
                             siteName.m_str, los.m_str, degSatn);
            }
        }

        api->Close(&opened);   // shuts down the SIDRA Intersection runtime
    }

    CoUninitialize();
    return 0;
}
```

## 3. Build and run

Build the project for the **x64** configuration in Visual Studio, then run the
resulting executable. The `#import` directive resolves at compile time and
generates the `.tlh`/`.tli` headers for the type library automatically.

Expected output (values depend on your project):

```text
Project: Demo
  North Rd / Main St: LOS B, degree of saturation 0.742
  East Ave / Main St: LOS C, degree of saturation 0.871
```

## Working with raw COM interfaces

With `raw_interfaces_only`, every member is a method that returns an `HRESULT`
and hands back its value through an out-parameter:

- **Properties** become `get_<Name>` / `put_<Name>` calls. `site.Name` in the
  other samples is `site->get_Name(&bstr)` here.
- **`CComPtr<I...>`** owns the interface pointer and calls `Release` for you
  when it goes out of scope. **`CComBSTR`** owns string values, and booleans are
  `VARIANT_BOOL` (`VARIANT_TRUE` / `VARIANT_FALSE`).
- **Collections** expose `get_Count` and two indexers: `get_Item` looks up by
  name and `get_Item_2` retrieves by position. This sample iterates by position
  with `get_Item_2`.

See the [API reference](../api/index.md) for the full surface. The per-member
pages show the C# and Python forms; for C++, read a documented
property `Foo` as `get_Foo` / `put_Foo` and call methods directly, each
returning an `HRESULT` with results passed back through out-parameters.

## Releasing the API

Call `Close()` when you are finished, then `CoUninitialize()`. Each `CComPtr`
releases its interface automatically when it leaves scope, so keep the API
objects in a narrower scope than the `CoUninitialize()` call, as the sample
does above. Releasing the COM objects after the apartment has already been torn
down is undefined behaviour.

==============================================================================
SOURCE: samples/python.md
==============================================================================

---
title: Python sample
description: Drive the SIDRA Intersection API from Python via Python.NET (pythonnet).
---

# Python sample

The SIDRA API is a .NET 8 assembly. From Python the supported path is
[Python.NET](https://pythonnet.github.io/) (`pythonnet`), which loads the
assembly straight into the CLR and exposes its types as Python objects. This
is **not** COM: there is no `pywin32`, no `win32com.client.Dispatch`, and no
COM registration involved.

This sample opens a SIDRA project, processes every site, and prints its level
of service and degree of saturation.

!!! note
    Complete the [Getting started](../getting-started.md) prerequisites first
    (SIDRA Intersection installed, .NET 8). You also need a SIDRA project
    (`.sipx`) file to open. Save one from SIDRA Intersection, or point the
    sample at any existing project. Replace `C:\Samples\Demo.sipx` below with
    its path. If anything fails, see [Troubleshooting](../troubleshooting.md).

## 1. Install Python.NET

```bash
pip install pythonnet
```

!!! warning "Important"
    Use 64-bit Python. The SIDRA API is `net8.0-windows` x64-only and will fail
    to load into a 32-bit interpreter.

!!! note
    The API targets .NET 8, so Python.NET must host the **CoreCLR** runtime, not
    .NET Framework. Select it *before* the first `import clr` (see
    [Selecting the runtime](#selecting-the-runtime)).

## 2. Write the program

`first_program.py`:

```python
import os
import winreg
from pythonnet import set_runtime
from clr_loader import get_coreclr


def sidra_install_path():
    """Read the SIDRA Intersection install folder from the registry."""
    key = r"SOFTWARE\SIDRA SOLUTIONS\SIDRA INTERSECTION 11"
    with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, key) as k:
        return winreg.QueryValueEx(k, "InstallLocation")[0]


sidra = sidra_install_path()

# Host the API's own .NET 8 runtime (via its runtimeconfig), then load the DLL.
# This must happen before the first `import clr`.
set_runtime(get_coreclr(
    runtime_config=os.path.join(sidra, "SIDRASolutions.SI.API.runtimeconfig.json")))

import clr
clr.AddReference(os.path.join(sidra, "SIDRASolutions.SI.API.dll"))

from SIDRASolutions.SI.API import SIAPI

api = SIAPI()
try:
    if not api.OpenProject(r"C:\Samples\Demo.sipx"):
        raise RuntimeError(f"Could not open project: {api.LastErrorMessage}")

    project = api.Project
    print(f"Project: {project.Name}")

    # Project -> SiteFolders -> Sites. In SIDRA a "site" is an intersection.
    # .NET indexers map to Python subscripting, so use [] (not COM-style ()).
    folders = project.SiteFolders
    for f in range(folders.Count):
        sites = folders[f].Sites
        for s in range(sites.Count):
            site = sites[s]

            site.Process()                      # run the analysis for this site

            # Site-level vehicle results live under Outputset.OutputSiteVehicle.
            result = site.Outputset.OutputSiteVehicle
            print(f"  {site.Name}: LOS {result.Level_of_service}, "
                  f"degree of saturation {result.Deg_satn:.3f}")
finally:
    api.Close()                                 # shuts down the SIDRA runtime
```

## 3. Run it

```bash
python first_program.py
```

Expected output (values depend on your project):

```text
Project: Demo
  North Rd / Main St: LOS B, degree of saturation 0.742
  East Ave / Main St: LOS C, degree of saturation 0.871
```

## Selecting the runtime

Python.NET 3.x can host either .NET Framework or .NET (CoreCLR), and on Windows
it may default to .NET Framework. The SIDRA API is .NET 8, so you must host
CoreCLR. Passing the API's own `SIDRASolutions.SI.API.runtimeconfig.json` to
`get_coreclr(...)` and calling `set_runtime(...)` before the first `import clr`
(as above) selects the correct .NET 8 runtime and the dependencies the API was
built against.

Python.NET also needs a .NET 8 runtime present on the machine. The SIDRA
Intersection installer satisfies this; otherwise install the
**.NET 8 Desktop Runtime**.

## Locating the assembly

The install folder holds `SIDRASolutions.SI.API.dll` alongside its
`SIDRASolutions.SI.API.runtimeconfig.json`. The sample reads that folder from
the registry value
`HKLM\SOFTWARE\SIDRA SOLUTIONS\SIDRA INTERSECTION 11\InstallLocation`, which
avoids hard-coding a path. You can also pass the folder explicitly, then load
the assembly by full path with
`clr.AddReference(os.path.join(folder, "SIDRASolutions.SI.API.dll"))`.

## Working with .NET types

Because Python.NET binds the managed types directly, you get the real
`SIDRASolutions.SI.API` classes rather than a late-bound COM wrapper.
Interfaces such as [`ISIAPIProject`](../api/sidrasolutions.si.api.isiapiproject.md)
and their members surface as ordinary Python attributes, collection indexers
are accessed with `[]`, and .NET enums import from the same namespace.

==============================================================================
SOURCE: downloads.md
==============================================================================

---
title: Downloads
description: SIDRA API files, sample projects, previous-version downloads and archived workshop materials.
---

# Downloads

Download API files and sample projects for your installed version of
SIDRA INTERSECTION. For setup instructions, see [Getting started](getting-started.md).

## SIDRA INTERSECTION 11

| File | Use |
| --- | --- |
| [Late-binding wrapper (ZIP)](https://www.sidrasolutions.com/downloads/si/11/api/LB_SI11API.zip) | C# and VB.NET applications reference `LB_SI11API.dll`. Include its `LB_SI11API.deps.json` alongside the DLL. |
| [Sample projects (ZIP)](https://www.sidrasolutions.com/downloads/si/11/api/SI11APISamples.zip) | Downloadable API projects. See also the [C#, C++ and Python walkthroughs](samples/index.md). |
| [Offline Help (CHM)](https://www.sidrasolutions.com/downloads/si/11/api/Help_SI11API.chm) | Downloadable API Help. Use the [online API reference](api/index.md) for the documentation version selected on this site. |

The API is included with SIDRA INTERSECTION. A licensed installation is
required even when you download the wrapper or sample projects separately.

C# and VB.NET use the late-binding wrapper with .NET 8 and x64. C++ uses the
installed COM type library, and Python uses Python.NET to load the installed
API assembly directly. C++ and Python do not need the late-binding wrapper.
Follow the setup instructions for your language in
[Getting started](getting-started.md#supported-languages).

!!! note "Opening offline Help"
    Before opening the CHM file for the first time, right-click it, select
    **Properties**, then select the **General** tab. If an **Unblock** checkbox
    or button is shown, select it and apply the change. Otherwise, Help
    content may not display correctly.

## Version compatibility

Match your API files and documentation to the SIDRA INTERSECTION version
installed on your computer. The API is updated for each major product
version, so your application may need changes when moving to a newer version.

Use the version selector in the header to choose an available documentation
release. The `latest` address follows the newest published release. See
[Release notes](release-notes.md) for API changes. Previous-version file
downloads below are separate from the releases available in the selector.

## Previous versions

These files are for the stated product versions. Follow their included Help
and samples; the Version 11 setup instructions on this site may not apply.

| Version | Offline Help | Late-binding wrapper | Sample projects |
| --- | --- | --- | --- |
| SIDRA INTERSECTION 10 | [CHM](https://www.sidrasolutions.com/downloads/si/10_0/api/Help_SI10API.chm) | [ZIP](https://www.sidrasolutions.com/downloads/si/10_0/api/LB_SI10API.zip) | [ZIP](https://www.sidrasolutions.com/downloads/si/10_0/api/SI10APISamples.zip) |
| SIDRA INTERSECTION 9.1 | [CHM](https://www.sidrasolutions.com/downloads/si/9_1/api/Help_SI91API.chm) | [ZIP](https://www.sidrasolutions.com/downloads/si/9_1/api/LB_SI91API.zip) | [ZIP](https://www.sidrasolutions.com/downloads/si/9_1/api/SI91APISamples.zip) |

SIDRA INTERSECTION 10 samples require **10.0.6.236 or later**.

## API Workshop 2018

This half-day workshop was held in Melbourne on 26 November 2018. It covered
practical API use and integrations with Aimsun, EMME, DYNAMEQ and TRACKS.
These materials are an archive, including examples for SIDRA INTERSECTION 8;
they are not current Version 11 setup instructions.

- [Transcript of presentations (PDF)](https://www.sidrasolutions.com/media/330/download):
  an edited transcript of the presentations and discussions.
- [Presentation files (ZIP)](https://www.sidrasolutions.com/media/331/download):
  slides in PDF format. Open the corresponding slides when reading the transcript.
- [SIDRA BATCH Python samples (ZIP)](https://www.sidrasolutions.com/media/332/download):
  the workshop's sample programs using SIDRA API.

??? note "Workshop topics and presenters"

    - **Welcome and Introduction to SIDRA API Workshop:** Dr Rahmi Akçelik
      (SIDRA SOLUTIONS).
    - **An Introduction to Using API for SIDRA INTERSECTION 8 and VOLUMES
      Utility:** Mark Besley (SIDRA SOLUTIONS).
    - **SIDRA BATCH Python Sample Program Using SIDRA API:** Harry Cai
      (SIDRA SOLUTIONS).
    - **Aimsun and SIDRA Interface:** Mohammad Saifuzzaman
      (Aimsun Pty Ltd, A Siemens Company).
    - **TRACKS and SIDRA Link:** Grant Smith
      (Transportation and Traffic Systems Ltd).
    - **Using SIDRA API for EMME and DYNAMEQ:** Paul van den Bos
      (Freelance Transport Modeller).
    - **GTASIDRA, A Process Integrator:** Luca Rosati and Rebecca Strachan
      (GTA Consultants).
    - **Discussions on User Needs and API Development:** group discussion
      on future directions and user requirements.

==============================================================================
SOURCE: licensing.md
==============================================================================

---
title: Licensing
description: Licence requirements, quote requests and terms for using the SIDRA INTERSECTION API.
---

# Licensing

Check the licence requirements and terms for applications that use the
SIDRA INTERSECTION API.

## Licence required

A licensed copy of SIDRA INTERSECTION must be installed on the computer before
the API can be used. The API drives the installed product; it does not run on
its own. Each end user of a program that links to SIDRA INTERSECTION through
the API needs a licensed copy, including where the link is provided in another
vendor's product.

[Request a quote](https://sidraintersection.com/licensing/quote) for a
SIDRA INTERSECTION licence, or [contact us](contact.md)
with licensing questions. For an existing installation that is not recognised
as licensed, see [Licensing failures](troubleshooting.md#licensing-failures).

## 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.

The full terms of use are set out in the
[SIDRA SOLUTIONS Terms of Use](https://www.sidrasolutions.com/terms#toc-sidra-api).

==============================================================================
SOURCE: release-notes.md
==============================================================================

---
title: Release notes
description: Versioned API changes for the SIDRA Intersection COM API.
---

# Release notes

Hand-authored release notes for the SIDRA Intersection COM API.

Use the **version selector** in the top bar to read the docs for a specific
release. Links below pin to a specific version's API reference so they stay
correct no matter which version you're viewing this page from.

## 11.0.3

Initial published release of the rewritten developer documentation. Full COM
API surface (~178 interfaces) documented with per-language code samples
(C#, VB.NET, Python, PowerShell) and cross-type navigation.

**Added**

Network convergence: the Two-Loop Convergence Method can be selected and
tuned per network, with new output properties reporting convergence
behaviour at network and site level.

**[`ISIAPINetwork`](/11.0.3/api/sidrasolutions.si.api.isiapinetwork/)**

- `int ConvergenceMethod`: 0 = One-Loop Convergence Method (default),
  1 = Two-Loop Convergence Method
- `int TwoLoops_OuterMaxIterations`
- `float TwoLoops_StoppingPercent`
- `bool TwoLoops_ApplyMinStoppingPercent`
- `int TwoLoops_InnerMaxIterations`
- `float TwoLoops_InnerStoppingPercent`

**[`ISIAPIOutputNetwork`](/11.0.3/api/sidrasolutions.si.api.isiapioutputnetwork/)**

- `int TwoLoops_TotalInnerIterations`
- `bool Is_settled`
- `bool Is_minPSC_regenerated`
- `float MinPSC`
- `int MinPSC_iteration`

**[`ISIAPIOutputNetworkVehicle`](/11.0.3/api/sidrasolutions.si.api.isiapioutputnetworkvehicle/)**

- `float DiffDelayControlAveragePct`
- `float DiffDelayControlAveragePctPrev`
- `float DiffDelayControlAveragePctPrev2`
- `float DiffSpeedEfficiencyPct`
- `float DiffSpeedEfficiencyPctPrev`
- `float DiffSpeedEfficiencyPctPrev2`

**[`ISIAPIOutputSiteVehicle`](/11.0.3/api/sidrasolutions.si.api.isiapioutputsitevehicle/)**

- `float MaxDxPct`
- `float MaxDxPctPrev`
- `float MaxDxPctPrev2`
- `float DiffDelayControlAveragePct`
- `float DiffDelayControlAveragePctPrev`
- `float DiffDelayControlAveragePctPrev2`
- `float DiffSpeedEfficiencyPct`
- `float DiffSpeedEfficiencyPctPrev`
- `float DiffSpeedEfficiencyPctPrev2`

[Full API reference for 11.0.3](/11.0.3/api/)

==============================================================================
SOURCE: AGENTS.md
==============================================================================

---
title: For AI agents
description: Orientation for AI coding agents working with the SIDRA API.
---

# For AI agents

This page is written for autonomous coding agents (LLMs, retrieval agents,
or developer tools that ground answers in this site). Humans are welcome
too, but it's terser than the rest of the documentation by design.

## Three places to look

| You want... | Fetch |
|---|---|
| A machine-friendly index of every page | `llms.txt` |
| The exact signature, parameter, return type of a member | `api-md/<full-uid>.md` |
| All useful pages concatenated into one document | `llms-full.txt` |
| A topical answer or a working snippet | the rendered guide pages (`getting-started/`, `samples/csharp/`, ...), or the same content inside `llms-full.txt` |

## URL conventions

- The site is versioned: each release is a snapshot under `/<version>/`,
  and the paths above live at each version root. Start from
  `https://api.sidrasolutions.com/latest/llms.txt` (or swap `latest` for
  a specific version) and resolve its relative links from there.
- Domain-root probes also work in production: `/llms.txt`,
  `/llms-full.txt` and `/api-md/*` redirect (302) to their `/latest/`
  equivalents.
- Every public type maps to `api-md/<full-uid>.md`. Example:
  `SIDRASolutions.SI.API.ISIAPILaneMovement` &rarr;
  `api-md/sidrasolutions.si.api.isiapilanemovement.md`.
  UIDs are lowercased; no other transformation.
- Members live in the same file as their owning type, not on separate
  pages. Use anchor links: `api-md/sidrasolutions.si.api.isiapi.md#openproject`.
- Every `api-md/` file has YAML frontmatter with `uid`, `name`, `type`,
  `namespace`, a `members` list, and (when the source XML docs provide
  one) a `summary`: parse these before reading prose.

## What the API actually is

- A .NET 8 COM-visible assembly: `SIDRASolutions.SI.API`.
- Root interface: `ISIAPI`. C# and VB.NET reference the late-binding
  wrapper `LB_SI11API.dll` and instantiate with `new SIAPI()`; COM hosts
  (C++, PowerShell) activate ProgID `SIDRASolutions.SI.API`.
- Object model is tree-shaped: `Project -> Site -> Leg -> LaneMovement`.
  A Site **is** an intersection (there is no separate intersection type);
  Sites are grouped in SiteFolders.
- See [Object model](concepts/object-model.md) for the full hierarchy
  and naming conventions (`I...` singular, `I...s` plural, `..._<variant>`
  for parameter-set variants, `...MC` for movement-class-specific types).
- x64 only. STA threading required.

## Heuristics for retrieval

- "How do I do X?" &rarr; start with `getting-started/` and
  `samples/csharp/`.
- "What does method/property X do?" &rarr; find the owning type in
  `api-md/`.
- "How are sites and networks related?" &rarr;
  `concepts/object-model/`.

## What is *not* on this site

- Behavioural specifics of the traffic-engineering models (HCM, roundabout
  capacity, gap acceptance). The API exposes inputs and outputs; the
  modelling itself is documented in the SIDRA Intersection User Guide,
  shipped with the product.
- Product installation and activation procedures. See the product's installer
  and licence portal. API licence requirements and terms are covered in
  [Licensing](licensing.md).

==============================================================================
SOURCE: contact.md
==============================================================================

---
title: Contact
description: Contact SIDRA SOLUTIONS about the SIDRA INTERSECTION API, licensing or technical support.
hide:
  - toc
---

<div class="sidra-contact" markdown>

# Contact

Send the SIDRA SOLUTIONS team a question about the API, licensing or your
application.

For API support, include your SIDRA INTERSECTION version, programming
language and the error message. The [troubleshooting checklist](troubleshooting.md#diagnostics-to-collect-before-requesting-support)
explains what else can help us investigate.
{ .sidra-contact-guidance }

<div id="sidra-contact-form" data-cognito-key="9UhUF1pbfUCjq6oHJNkSGw" data-cognito-form="28">
  <p class="sidra-contact-loading" role="status" hidden>Loading contact form...</p>
</div>

<noscript>Please enable JavaScript to use the contact form.</noscript>

</div>

==============================================================================
SOURCE: api/index.md
==============================================================================

---
title: All types (A-Z)
description: Alphabetical index of every public type in SIDRASolutions.SI.API.
hide:
  - toc
---

# API Reference - all types

178 public types in the `SIDRASolutions.SI.API` namespace.

For the common workflow, start at [ISIAPI](sidrasolutions.si.api.isiapi.md) and navigate via Project, Site, Intersection, and the lane hierarchy.

- [ISIAPI](sidrasolutions.si.api.isiapi.md) - SIDRA INTERSECTION API wrapper interface.
- [ISIAPIAnalysis](sidrasolutions.si.api.isiapianalysis.md)
- [ISIAPIDiagnosticMsg](sidrasolutions.si.api.isiapidiagnosticmsg.md)
- [ISIAPIDiagnosticMsgs](sidrasolutions.si.api.isiapidiagnosticmsgs.md)
- [ISIAPIGapAcceptanceSpecificApp](sidrasolutions.si.api.isiapigapacceptancespecificapp.md)
- [ISIAPIIsland](sidrasolutions.si.api.isiapiisland.md)
- [ISIAPIIslands](sidrasolutions.si.api.isiapiislands.md)
- [ISIAPILaneApproach](sidrasolutions.si.api.isiapilaneapproach.md)
- [ISIAPILaneApproachMovement](sidrasolutions.si.api.isiapilaneapproachmovement.md)
- [ISIAPILaneApproachMovementMC](sidrasolutions.si.api.isiapilaneapproachmovementmc.md)
- [ISIAPILaneApproachMovementMCs](sidrasolutions.si.api.isiapilaneapproachmovementmcs.md)
- [ISIAPILaneApproachMovements](sidrasolutions.si.api.isiapilaneapproachmovements.md)
- [ISIAPILaneApproachs](sidrasolutions.si.api.isiapilaneapproachs.md)
- [ISIAPILaneExit](sidrasolutions.si.api.isiapilaneexit.md)
- [ISIAPILaneExitMergeParam](sidrasolutions.si.api.isiapilaneexitmergeparam.md)
- [ISIAPILaneExits](sidrasolutions.si.api.isiapilaneexits.md)
- [ISIAPILaneMovement](sidrasolutions.si.api.isiapilanemovement.md)
- [ISIAPILaneMovementMC](sidrasolutions.si.api.isiapilanemovementmc.md)
- [ISIAPILaneMovementMCs](sidrasolutions.si.api.isiapilanemovementmcs.md)
- [ISIAPILaneMovements](sidrasolutions.si.api.isiapilanemovements.md)
- [ISIAPILaneSegment](sidrasolutions.si.api.isiapilanesegment.md)
- [ISIAPILaneSegmentMC](sidrasolutions.si.api.isiapilanesegmentmc.md)
- [ISIAPILaneSegmentMCs](sidrasolutions.si.api.isiapilanesegmentmcs.md)
- [ISIAPILeg](sidrasolutions.si.api.isiapileg.md)
- [ISIAPILegs](sidrasolutions.si.api.isiapilegs.md)
- [ISIAPILeg_roundabout](sidrasolutions.si.api.isiapileg_roundabout.md)
- [ISIAPILeg_rou_hcm](sidrasolutions.si.api.isiapileg_rou_hcm.md)
- [ISIAPILeg_rou_hcm6_extended](sidrasolutions.si.api.isiapileg_rou_hcm6_extended.md)
- [ISIAPIMapCoordinate](sidrasolutions.si.api.isiapimapcoordinate.md)
- [ISIAPIModelSetting](sidrasolutions.si.api.isiapimodelsetting.md) - SIDRA INTERSECTION Model Setting wrapper interface
- [ISIAPIMovementClass](sidrasolutions.si.api.isiapimovementclass.md)
- [ISIAPIMovementClasses](sidrasolutions.si.api.isiapimovementclasses.md)
- [ISIAPIMovementClassFuelEmission](sidrasolutions.si.api.isiapimovementclassfuelemission.md)
- [ISIAPIMovementClassFuelEmissions](sidrasolutions.si.api.isiapimovementclassfuelemissions.md)
- [ISIAPIMovementClassMergeParam](sidrasolutions.si.api.isiapimovementclassmergeparam.md)
- [ISIAPIMovement_ped](sidrasolutions.si.api.isiapimovement_ped.md) - SIDRA INTERSECTION Pedestrian Movement wrapper interface
- [ISIAPIMovement_peds](sidrasolutions.si.api.isiapimovement_peds.md)
- [ISIAPIMovement_vehicle_od](sidrasolutions.si.api.isiapimovement_vehicle_od.md) - SIDRA INTERSECTION Vehicle Approach Movement wrapper interface
- [ISIAPIMovement_vehicle_ods](sidrasolutions.si.api.isiapimovement_vehicle_ods.md)
- [ISIAPIMovement_vehicle_od_mc](sidrasolutions.si.api.isiapimovement_vehicle_od_mc.md) - SIDRA INTERSECTION Vehicle Approach Movement (per Movement Class) wrapper interface
- [ISIAPIMovement_vehicle_od_mcs](sidrasolutions.si.api.isiapimovement_vehicle_od_mcs.md)
- [ISIAPINetwork](sidrasolutions.si.api.isiapinetwork.md)
- [ISIAPINetworkCCG](sidrasolutions.si.api.isiapinetworkccg.md) - Wrapper interface for a Common Control Group (CCG) in a particular Network
- [ISIAPINetworkCCGPhase](sidrasolutions.si.api.isiapinetworkccgphase.md)
- [ISIAPINetworkCCGPhases](sidrasolutions.si.api.isiapinetworkccgphases.md)
- [ISIAPINetworkCCGs](sidrasolutions.si.api.isiapinetworkccgs.md)
- [ISIAPINetworkCCGSequence](sidrasolutions.si.api.isiapinetworkccgsequence.md)
- [ISIAPINetworkCCGSequences](sidrasolutions.si.api.isiapinetworkccgsequences.md)
- [ISIAPINetworkDemandSensitivity](sidrasolutions.si.api.isiapinetworkdemandsensitivity.md)
- [ISIAPINetworkFolder](sidrasolutions.si.api.isiapinetworkfolder.md) - NetworkFolder wrapper interface
- [ISIAPINetworkFolders](sidrasolutions.si.api.isiapinetworkfolders.md) - NetworkFolder collection wrapper interface
- [ISIAPINetworkLegConnection](sidrasolutions.si.api.isiapinetworklegconnection.md)
- [ISIAPINetworkLegConnections](sidrasolutions.si.api.isiapinetworklegconnections.md)
- [ISIAPINetworkMC](sidrasolutions.si.api.isiapinetworkmc.md)
- [ISIAPINetworkMCs](sidrasolutions.si.api.isiapinetworkmcs.md)
- [ISIAPINetworks](sidrasolutions.si.api.isiapinetworks.md) - Network collection wrapper interface
- [ISIAPINetworkScenario](sidrasolutions.si.api.isiapinetworkscenario.md)
- [ISIAPINetworkScenarios](sidrasolutions.si.api.isiapinetworkscenarios.md)
- [ISIAPINetworkSite](sidrasolutions.si.api.isiapinetworksite.md) - Wrapper interface for the Site in a particular Network
- [ISIAPINetworkSites](sidrasolutions.si.api.isiapinetworksites.md)
- [ISIAPINetworkSiteScenario](sidrasolutions.si.api.isiapinetworksitescenario.md)
- [ISIAPINetworkSiteScenarios](sidrasolutions.si.api.isiapinetworksitescenarios.md)
- [ISIAPIOpposingmovement_ped](sidrasolutions.si.api.isiapiopposingmovement_ped.md)
- [ISIAPIOpposingmovement_peds](sidrasolutions.si.api.isiapiopposingmovement_peds.md)
- [ISIAPIOpposingmovement_vehicle](sidrasolutions.si.api.isiapiopposingmovement_vehicle.md)
- [ISIAPIOpposingmovement_vehicles](sidrasolutions.si.api.isiapiopposingmovement_vehicles.md)
- [ISIAPIOutputAnalysis](sidrasolutions.si.api.isiapioutputanalysis.md)
- [ISIAPIOutputCirculatingLane](sidrasolutions.si.api.isiapioutputcirculatinglane.md)
- [ISIAPIOutputCirculatingLaneMC](sidrasolutions.si.api.isiapioutputcirculatinglanemc.md)
- [ISIAPIOutputCirculatingLaneMCs](sidrasolutions.si.api.isiapioutputcirculatinglanemcs.md)
- [ISIAPIOutputCirculatingLanes](sidrasolutions.si.api.isiapioutputcirculatinglanes.md)
- [ISIAPIOutputGraphTuple](sidrasolutions.si.api.isiapioutputgraphtuple.md)
- [ISIAPIOutputGraphTuples](sidrasolutions.si.api.isiapioutputgraphtuples.md)
- [ISIAPIOutputLane](sidrasolutions.si.api.isiapioutputlane.md) - SIDRA INTERSECTION Output Lane wrapper interface
- [ISIAPIOutputLaneExit](sidrasolutions.si.api.isiapioutputlaneexit.md) - SIDRA INTERSECTION Output Exit Lane wrapper interface
- [ISIAPIOutputLaneExitMC](sidrasolutions.si.api.isiapioutputlaneexitmc.md)
- [ISIAPIOutputLaneExitMCs](sidrasolutions.si.api.isiapioutputlaneexitmcs.md)
- [ISIAPIOutputLaneExits](sidrasolutions.si.api.isiapioutputlaneexits.md)
- [ISIAPIOutputLaneGreenPeriod](sidrasolutions.si.api.isiapioutputlanegreenperiod.md)
- [ISIAPIOutputLaneGreenPeriods](sidrasolutions.si.api.isiapioutputlanegreenperiods.md)
- [ISIAPIOutputLaneMC](sidrasolutions.si.api.isiapioutputlanemc.md)
- [ISIAPIOutputLaneMCs](sidrasolutions.si.api.isiapioutputlanemcs.md)
- [ISIAPIOutputLaneOD](sidrasolutions.si.api.isiapioutputlaneod.md)
- [ISIAPIOutputLaneODMC](sidrasolutions.si.api.isiapioutputlaneodmc.md)
- [ISIAPIOutputLaneODMCs](sidrasolutions.si.api.isiapioutputlaneodmcs.md)
- [ISIAPIOutputLaneODs](sidrasolutions.si.api.isiapioutputlaneods.md)
- [ISIAPIOutputLanes](sidrasolutions.si.api.isiapioutputlanes.md)
- [ISIAPIOutputLaneUnsignalPed](sidrasolutions.si.api.isiapioutputlaneunsignalped.md)
- [ISIAPIOutputLeg](sidrasolutions.si.api.isiapioutputleg.md) - SIDRA INTERSECTION Output Leg wrapper interface
- [ISIAPIOutputLegMC](sidrasolutions.si.api.isiapioutputlegmc.md)
- [ISIAPIOutputLegMCs](sidrasolutions.si.api.isiapioutputlegmcs.md)
- [ISIAPIOutputLegPerson](sidrasolutions.si.api.isiapioutputlegperson.md)
- [ISIAPIOutputLegPersons](sidrasolutions.si.api.isiapioutputlegpersons.md)
- [ISIAPIOutputLegs](sidrasolutions.si.api.isiapioutputlegs.md)
- [ISIAPIOutputMeteredRoundabout](sidrasolutions.si.api.isiapioutputmeteredroundabout.md)
- [ISIAPIOutputMovementPed](sidrasolutions.si.api.isiapioutputmovementped.md) - SIDRA INTERSECTION Pedestrian movement output wrapper interface.
- [ISIAPIOutputMovementPeds](sidrasolutions.si.api.isiapioutputmovementpeds.md)
- [ISIAPIOutputMovementPed_GreenPeriod](sidrasolutions.si.api.isiapioutputmovementped_greenperiod.md)
- [ISIAPIOutputMovementPed_GreenPeriods](sidrasolutions.si.api.isiapioutputmovementped_greenperiods.md)
- [ISIAPIOutputMovementPersonOD](sidrasolutions.si.api.isiapioutputmovementpersonod.md)
- [ISIAPIOutputMovementPersonODMC](sidrasolutions.si.api.isiapioutputmovementpersonodmc.md)
- [ISIAPIOutputMovementPersonODMCs](sidrasolutions.si.api.isiapioutputmovementpersonodmcs.md)
- [ISIAPIOutputMovementPersonODs](sidrasolutions.si.api.isiapioutputmovementpersonods.md)
- [ISIAPIOutputMovementVehicleOD](sidrasolutions.si.api.isiapioutputmovementvehicleod.md)
- [ISIAPIOutputMovementVehicleODMC](sidrasolutions.si.api.isiapioutputmovementvehicleodmc.md)
- [ISIAPIOutputMovementVehicleODMCs](sidrasolutions.si.api.isiapioutputmovementvehicleodmcs.md)
- [ISIAPIOutputMovementVehicleODMC_GreenPeriod](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiod.md)
- [ISIAPIOutputMovementVehicleODMC_GreenPeriods](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiods.md)
- [ISIAPIOutputMovementVehicleODs](sidrasolutions.si.api.isiapioutputmovementvehicleods.md)
- [ISIAPIOutputMultiSequenceAnalyses](sidrasolutions.si.api.isiapioutputmultisequenceanalyses.md)
- [ISIAPIOutputMultiSequenceAnalysis](sidrasolutions.si.api.isiapioutputmultisequenceanalysis.md)
- [ISIAPIOutputNetwork](sidrasolutions.si.api.isiapioutputnetwork.md)
- [ISIAPIOutputNetworkGraphTuple](sidrasolutions.si.api.isiapioutputnetworkgraphtuple.md)
- [ISIAPIOutputNetworkGraphTuples](sidrasolutions.si.api.isiapioutputnetworkgraphtuples.md)
- [ISIAPIOutputNetworkPedestrian](sidrasolutions.si.api.isiapioutputnetworkpedestrian.md)
- [ISIAPIOutputNetworkPerson](sidrasolutions.si.api.isiapioutputnetworkperson.md)
- [ISIAPIOutputNetworkVehicle](sidrasolutions.si.api.isiapioutputnetworkvehicle.md)
- [ISIAPIOutputNetworkVehicleMC](sidrasolutions.si.api.isiapioutputnetworkvehiclemc.md)
- [ISIAPIOutputNetworkVehicleMCs](sidrasolutions.si.api.isiapioutputnetworkvehiclemcs.md)
- [ISIAPIOutputPhase](sidrasolutions.si.api.isiapioutputphase.md)
- [ISIAPIOutputPhaseMovTimingPath](sidrasolutions.si.api.isiapioutputphasemovtimingpath.md)
- [ISIAPIOutputPhaseMovTimingPathMovement](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovement.md)
- [ISIAPIOutputPhaseMovTimingPathMovements](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovements.md)
- [ISIAPIOutputPhaseMovTimingPaths](sidrasolutions.si.api.isiapioutputphasemovtimingpaths.md)
- [ISIAPIOutputPhases](sidrasolutions.si.api.isiapioutputphases.md)
- [ISIAPIOutputRouteMovementBasedPerson](sidrasolutions.si.api.isiapioutputroutemovementbasedperson.md)
- [ISIAPIOutputRouteMovementBasedVehicle](sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md)
- [ISIAPIOutputRouteMovementBasedVehicleMC](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemc.md)
- [ISIAPIOutputRouteMovementBasedVehicleMCs](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemcs.md)
- [ISIAPIOutputSequence](sidrasolutions.si.api.isiapioutputsequence.md)
- [ISIAPIOutputset](sidrasolutions.si.api.isiapioutputset.md) - SIDRA INTERSECTION Outputset wrapper interface
- [ISIAPIOutputSitePedestrian](sidrasolutions.si.api.isiapioutputsitepedestrian.md) - SIDRA INTERSECTION Pedestrian specific site output wrapper interface.
- [ISIAPIOutputSitePerson](sidrasolutions.si.api.isiapioutputsiteperson.md) - SIDRA INTERSECTION Person specific site output wrapper interface.
- [ISIAPIOutputSiteRoute](sidrasolutions.si.api.isiapioutputsiteroute.md)
- [ISIAPIOutputSiteRoutes](sidrasolutions.si.api.isiapioutputsiteroutes.md)
- [ISIAPIOutputSiteVehicle](sidrasolutions.si.api.isiapioutputsitevehicle.md) - SIDRA INTERSECTION Vehicle specific site output wrapper class.
- [ISIAPIOutputSiteVehicleMC](sidrasolutions.si.api.isiapioutputsitevehiclemc.md)
- [ISIAPIOutputSiteVehicleMCs](sidrasolutions.si.api.isiapioutputsitevehiclemcs.md)
- [ISIAPIPhase](sidrasolutions.si.api.isiapiphase.md)
- [ISIAPIPhasemovement_ped](sidrasolutions.si.api.isiapiphasemovement_ped.md)
- [ISIAPIPhasemovement_peds](sidrasolutions.si.api.isiapiphasemovement_peds.md)
- [ISIAPIPhasemovement_vehicle](sidrasolutions.si.api.isiapiphasemovement_vehicle.md)
- [ISIAPIPhasemovement_vehicles](sidrasolutions.si.api.isiapiphasemovement_vehicles.md)
- [ISIAPIPhases](sidrasolutions.si.api.isiapiphases.md)
- [ISIAPIProject](sidrasolutions.si.api.isiapiproject.md) - SIDRA INTERSECTION Project wrapper interface
- [ISIAPIRoute](sidrasolutions.si.api.isiapiroute.md)
- [ISIAPIRouteMC](sidrasolutions.si.api.isiapiroutemc.md)
- [ISIAPIRouteMCs](sidrasolutions.si.api.isiapiroutemcs.md)
- [ISIAPIRouteNwSite](sidrasolutions.si.api.isiapiroutenwsite.md)
- [ISIAPIRouteNwSites](sidrasolutions.si.api.isiapiroutenwsites.md)
- [ISIAPIRoutes](sidrasolutions.si.api.isiapiroutes.md)
- [ISIAPISensitivity](sidrasolutions.si.api.isiapisensitivity.md)
- [ISIAPISequence](sidrasolutions.si.api.isiapisequence.md)
- [ISIAPISequences](sidrasolutions.si.api.isiapisequences.md)
- [ISIAPISite](sidrasolutions.si.api.isiapisite.md) - SIDRA INTERSECTION Site wrapper interface
- [ISIAPISiteFolder](sidrasolutions.si.api.isiapisitefolder.md) - SiteFolder wrapper interface
- [ISIAPISiteFolders](sidrasolutions.si.api.isiapisitefolders.md) - SiteFolder collection wrapper interface
- [ISIAPISites](sidrasolutions.si.api.isiapisites.md) - Site collection wrapper interface
- [ISIAPISiteScenario](sidrasolutions.si.api.isiapisitescenario.md)
- [ISIAPISiteScenarios](sidrasolutions.si.api.isiapisitescenarios.md)
- [ISIAPISiteVolumeBin](sidrasolutions.si.api.isiapisitevolumebin.md) - SiteVolumeBin wrapper interface
- [ISIAPISiteVolumeBinFolder](sidrasolutions.si.api.isiapisitevolumebinfolder.md) - SiteVolumeBinFolder wrapper interface
- [ISIAPISiteVolumeBinFolders](sidrasolutions.si.api.isiapisitevolumebinfolders.md) - SiteVolumeBinFolder collection wrapper interface
- [ISIAPISiteVolumeBins](sidrasolutions.si.api.isiapisitevolumebins.md) - SiteVolumeBin collection wrapper interface
- [ISIAPISiteVolumeLeg](sidrasolutions.si.api.isiapisitevolumeleg.md)
- [ISIAPISiteVolumeLegs](sidrasolutions.si.api.isiapisitevolumelegs.md)
- [ISIAPISiteVolumeMC](sidrasolutions.si.api.isiapisitevolumemc.md)
- [ISIAPISiteVolumeMCs](sidrasolutions.si.api.isiapisitevolumemcs.md)
- [ISIAPISiteVolumeMovPed](sidrasolutions.si.api.isiapisitevolumemovped.md)
- [ISIAPISiteVolumeMovPeds](sidrasolutions.si.api.isiapisitevolumemovpeds.md)
- [ISIAPISiteVolumeMovVehOD](sidrasolutions.si.api.isiapisitevolumemovvehod.md)
- [ISIAPISiteVolumeMovVehODMC](sidrasolutions.si.api.isiapisitevolumemovvehodmc.md)
- [ISIAPISiteVolumeMovVehODMCs](sidrasolutions.si.api.isiapisitevolumemovvehodmcs.md)
- [ISIAPISiteVolumeMovVehODs](sidrasolutions.si.api.isiapisitevolumemovvehods.md)
- [ISIAPITwoWaySignControlAdjGeometryControl](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrol.md)
- [ISIAPITwoWaySignControlAdjGeometryControls](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrols.md)
- [ISIAPITwoWaySignControlAdjMajorNumLane](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlane.md)
- [ISIAPITwoWaySignControlAdjMajorNumLanes](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlanes.md)

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapi.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPI
title: SIDRA API
name: ISIAPI
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 9C0B1932-3E16-4F86-9365-2E5F752328FC
summary: SIDRA INTERSECTION API wrapper interface.
members:
  - bool OpenProject(string filename)
  - bool CloseProject()
  - bool Close()
  - bool CreateAndOpenProject(string filename, string newProjectName)
  - bool SaveProject()
  - bool CloseProjectWithoutSaving()
  - ISIAPIProject Project
  - bool IsLicensed
  - string LastErrorMessage
  - int IntPtrSize
---

# SIDRA API

Type `ISIAPI` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `9C0B1932-3E16-4F86-9365-2E5F752328FC`

SIDRA INTERSECTION API wrapper interface.

## Declaration

```csharp
[Guid("9C0B1932-3E16-4F86-9365-2E5F752328FC")]
public interface ISIAPI
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) | Current open SIDRA INTERSECTION project. |
| [IsLicensed](#islicensed) | `bool` | Indicates whether the installed version of SIDRA INTERSECTION is licensed. |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [IntPtrSize](#intptrsize) | `int` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [OpenProject(string)](#openproject-string) | `bool` | Opens a SIDRA INTERSECTION Project. |
| [CloseProject()](#closeproject) | `bool` | Closes the SIDRA INTERSECTION Project and save it. |
| [Close()](#close) | `bool` |  |
| [CreateAndOpenProject(string, string)](#createandopenproject-string--string) | `bool` | Creates and opens a SIDRA INTERSECTION Project. |
| [SaveProject()](#saveproject) | `bool` | Save the SIDRA INTERSECTION Project. |
| [CloseProjectWithoutSaving()](#closeprojectwithoutsaving) | `bool` | Close the SIDRA INTERSECTION Project without saving it. |

</div>

## Get an instance

=== "C#"

    ```csharp
    // Add a reference to the SIDRA late-binding assembly (LB_SI<version>API.dll).
    using SIDRASolutions.SI.API;
    
    var api = new SIAPI();
    ```

=== "C++"

    ```cpp
    // Import the SI API v11 type library by using its GUID. Change the GUID for other versions.
    // #import "libid:a640d48f-577d-40a7-b91a-14c06a14f03b" raw_interfaces_only
    // using namespace SIDRASolutions_SI_API;
    
    CoInitialize(NULL);
    
    CComPtr<ISIAPI> api;
    api.CoCreateInstance(__uuidof(SIAPI));
    ```

=== "Python"

    ```python
    import os
    import winreg
    from pythonnet import set_runtime
    from clr_loader import get_coreclr
    
    def sidra_install_path():
        """Read the SIDRA Intersection install folder from the registry."""
        key = r"SOFTWARE\SIDRA SOLUTIONS\SIDRA INTERSECTION 11"
        with winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE, key) as k:
            return winreg.QueryValueEx(k, "InstallLocation")[0]
    
    sidra = sidra_install_path()
    
    # Host the API's own .NET 8 runtime (via its runtimeconfig), then load the DLL.
    # This must happen before the first `import clr`.
    set_runtime(get_coreclr(
        runtime_config=os.path.join(sidra, "SIDRASolutions.SI.API.runtimeconfig.json")))
    
    import clr
    clr.AddReference(os.path.join(sidra, "SIDRASolutions.SI.API.dll"))
    
    from SIDRASolutions.SI.API import SIAPI
    
    api = SIAPI()
    ```

## Properties

### Project {#project}

Current open SIDRA INTERSECTION project.

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

**Value**

If no project is open NULL is returned.

???- example "Code samples"

    === "C#"

        ```csharp
        var project = api.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        api->get_Project(&project);
        ```

    === "Python"

        ```python
        project = api.Project
        ```

### IsLicensed {#islicensed}

Indicates whether the installed version of SIDRA INTERSECTION is licensed.

```csharp
bool IsLicensed { get; }
```

**Type** `bool`

**Value**

True if licensed. False if unlicensed or in Trial Mode.

???- example "Code samples"

    === "C#"

        ```csharp
        bool isLicensed = api.IsLicensed;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isLicensed;
        api->get_IsLicensed(&isLicensed);
        ```

    === "Python"

        ```python
        is_licensed = api.IsLicensed
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = api.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        api->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = api.LastErrorMessage
        ```

### IntPtrSize {#intptrsize}

```csharp
int IntPtrSize { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int intPtrSize = api.IntPtrSize;
        ```

    === "C++"

        ```cpp
        long intPtrSize;
        api->get_IntPtrSize(&intPtrSize);
        ```

    === "Python"

        ```python
        int_ptr_size = api.IntPtrSize
        ```

## Methods

### OpenProject(string) {#openproject-string}

Opens a SIDRA INTERSECTION Project.

```csharp
bool OpenProject(string filename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `filename` | `string` | Path of the SIDRA INTERSECTION Project file to open |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.OpenProject(@"C:\path\to\project.sipx");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->OpenProject(CComBSTR(L"C:\\path\\to\\project.sipx"), &result);
        ```

    === "Python"

        ```python
        result = api.OpenProject(r"C:\path\to\project.sipx")
        ```

### CloseProject() {#closeproject}

Closes the SIDRA INTERSECTION Project and save it.

```csharp
bool CloseProject()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.CloseProject();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->CloseProject(&result);
        ```

    === "Python"

        ```python
        result = api.CloseProject()
        ```

### Close() {#close}

```csharp
bool Close()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.Close();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->Close(&result);
        ```

    === "Python"

        ```python
        result = api.Close()
        ```

### CreateAndOpenProject(string, string) {#createandopenproject-string--string}

Creates and opens a SIDRA INTERSECTION Project.

```csharp
bool CreateAndOpenProject(string filename, string newProjectName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `filename` | `string` | Path of the SIDRA INTERSECTION Project file to open |
| `newProjectName` | `string` | The Project name |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.CreateAndOpenProject(@"C:\path\to\project.sipx", @"Demo Project");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->CreateAndOpenProject(CComBSTR(L"C:\\path\\to\\project.sipx"), CComBSTR(L"Demo Project"), &result);
        ```

    === "Python"

        ```python
        result = api.CreateAndOpenProject(r"C:\path\to\project.sipx", r"Demo Project")
        ```

### SaveProject() {#saveproject}

Save the SIDRA INTERSECTION Project.

```csharp
bool SaveProject()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.SaveProject();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->SaveProject(&result);
        ```

    === "Python"

        ```python
        result = api.SaveProject()
        ```

### CloseProjectWithoutSaving() {#closeprojectwithoutsaving}

Close the SIDRA INTERSECTION Project without saving it.

```csharp
bool CloseProjectWithoutSaving()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = api.CloseProjectWithoutSaving();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        api->CloseProjectWithoutSaving(&result);
        ```

    === "Python"

        ```python
        result = api.CloseProjectWithoutSaving()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapianalysis.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIAnalysis
title: Analysis
name: ISIAPIAnalysis
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 7E3AF260-B181-4F2D-A974-FEE9F6888AE6
members:
  - ISIAPISite Site
  - int Analysis_option
  - int Selected_sensitivity_groupno
  - int Design_Life_Objective
  - int Design_Life_Growth_Model
  - int Design_Life_Years
  - bool Design_Life_Is_constant_num_years_applied
  - int Design_Life_Constant_num_years
  - int Flow_Scale_Objective
  - float Flow_Scale_Lower
  - float Flow_Scale_Upper
  - bool Flow_Scale_Is_constant_factor_applied
  - float Flow_Scale_Constant_factor
  - ISIAPISensitivity SensitivityGeneralParameterGroup
  - ISIAPISensitivity SensitivityRoundaboutParameterGroup
  - int Result_option
  - int Result_leg_origin
  - int Result_lane_origin
  - int Result_laneno
  - int Result_vehmov_origin
  - int Result_vehmov_dest
  - int Result_mc_class
  - int Result_pedmov_option
  - int Result_pedmov_origin
  - int Result_pedmov_type
  - int Result_pedmov_stage_no
---

# Analysis

Type `ISIAPIAnalysis` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `7E3AF260-B181-4F2D-A974-FEE9F6888AE6`

## Declaration

```csharp
[Guid("7E3AF260-B181-4F2D-A974-FEE9F6888AE6")]
public interface ISIAPIAnalysis
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Analysis_option](#analysis_option) | `int` | Analysis Option |
| [Selected_sensitivity_groupno](#selected_sensitivity_groupno) | `int` | Selected Sensitivity Parameter Group Number |
| [Design_Life_Objective](#design_life_objective) | `int` | Design Life Analysis Objective |
| [Design_Life_Growth_Model](#design_life_growth_model) | `int` | Design Life Analysis Growth Model |
| [Design_Life_Years](#design_life_years) | `int` |  |
| [Design_Life_Is_constant_num_years_applied](#design_life_is_constant_num_years_applied) | `bool` |  |
| [Design_Life_Constant_num_years](#design_life_constant_num_years) | `int` |  |
| [Flow_Scale_Objective](#flow_scale_objective) | `int` | Flow Scale Analysis Objective |
| [Flow_Scale_Lower](#flow_scale_lower) | `float` |  |
| [Flow_Scale_Upper](#flow_scale_upper) | `float` |  |
| [Flow_Scale_Is_constant_factor_applied](#flow_scale_is_constant_factor_applied) | `bool` |  |
| [Flow_Scale_Constant_factor](#flow_scale_constant_factor) | `float` |  |
| [SensitivityGeneralParameterGroup](#sensitivitygeneralparametergroup) | [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md) |  |
| [SensitivityRoundaboutParameterGroup](#sensitivityroundaboutparametergroup) | [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md) |  |
| [Result_option](#result_option) | `int` | Results For |
| [Result_leg_origin](#result_leg_origin) | `int` |  |
| [Result_lane_origin](#result_lane_origin) | `int` |  |
| [Result_laneno](#result_laneno) | `int` |  |
| [Result_vehmov_origin](#result_vehmov_origin) | `int` |  |
| [Result_vehmov_dest](#result_vehmov_dest) | `int` |  |
| [Result_mc_class](#result_mc_class) | `int` |  |
| [Result_pedmov_option](#result_pedmov_option) | `int` | Pedestrian Movement Results Option |
| [Result_pedmov_origin](#result_pedmov_origin) | `int` |  |
| [Result_pedmov_type](#result_pedmov_type) | `int` |  |
| [Result_pedmov_stage_no](#result_pedmov_stage_no) | `int` |  |

</div>

## Properties

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = analysis.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        analysis->get_Site(&site);
        ```

    === "Python"

        ```python
        site = analysis.Site
        ```

### Analysis_option {#analysis_option}

Analysis Option

```csharp
int Analysis_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Sensitivity
- `2` - Design Life
- `3` - Flow Scale

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_option = analysis.Analysis_option;
        analysis.Analysis_option = 0;
        ```

    === "C++"

        ```cpp
        long analysis_option;
        analysis->get_Analysis_option(&analysis_option);
        analysis->put_Analysis_option(0);
        ```

    === "Python"

        ```python
        analysis_option = analysis.Analysis_option
        analysis.Analysis_option = 0
        ```

### Selected_sensitivity_groupno {#selected_sensitivity_groupno}

Selected Sensitivity Parameter Group Number

```csharp
int Selected_sensitivity_groupno { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - General Parameter Group
- `1` - Roundabout Parameter Group

???- example "Code samples"

    === "C#"

        ```csharp
        int selected_sensitivity_groupno = analysis.Selected_sensitivity_groupno;
        analysis.Selected_sensitivity_groupno = 0;
        ```

    === "C++"

        ```cpp
        long selected_sensitivity_groupno;
        analysis->get_Selected_sensitivity_groupno(&selected_sensitivity_groupno);
        analysis->put_Selected_sensitivity_groupno(0);
        ```

    === "Python"

        ```python
        selected_sensitivity_groupno = analysis.Selected_sensitivity_groupno
        analysis.Selected_sensitivity_groupno = 0
        ```

### Design_Life_Objective {#design_life_objective}

Design Life Analysis Objective

```csharp
int Design_Life_Objective { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Capacity (v/c ratio = xp)
- `1` - Capacity (v/c ratio = 1)
- `2` - Worst Lane Level of Service Target
- `3` - Worst Movement Level of Service Target
- `4` - Final Year

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Objective = analysis.Design_Life_Objective;
        analysis.Design_Life_Objective = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Objective;
        analysis->get_Design_Life_Objective(&design_Life_Objective);
        analysis->put_Design_Life_Objective(0);
        ```

    === "Python"

        ```python
        design__life__objective = analysis.Design_Life_Objective
        analysis.Design_Life_Objective = 0
        ```

### Design_Life_Growth_Model {#design_life_growth_model}

Design Life Analysis Growth Model

```csharp
int Design_Life_Growth_Model { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Uniform
- `1` - Compound

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Growth_Model = analysis.Design_Life_Growth_Model;
        analysis.Design_Life_Growth_Model = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Growth_Model;
        analysis->get_Design_Life_Growth_Model(&design_Life_Growth_Model);
        analysis->put_Design_Life_Growth_Model(0);
        ```

    === "Python"

        ```python
        design__life__growth__model = analysis.Design_Life_Growth_Model
        analysis.Design_Life_Growth_Model = 0
        ```

### Design_Life_Years {#design_life_years}

```csharp
int Design_Life_Years { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Years = analysis.Design_Life_Years;
        analysis.Design_Life_Years = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Years;
        analysis->get_Design_Life_Years(&design_Life_Years);
        analysis->put_Design_Life_Years(0);
        ```

    === "Python"

        ```python
        design__life__years = analysis.Design_Life_Years
        analysis.Design_Life_Years = 0
        ```

### Design_Life_Is_constant_num_years_applied {#design_life_is_constant_num_years_applied}

```csharp
bool Design_Life_Is_constant_num_years_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool design_Life_Is_constant_num_years_applied = analysis.Design_Life_Is_constant_num_years_applied;
        analysis.Design_Life_Is_constant_num_years_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL design_Life_Is_constant_num_years_applied;
        analysis->get_Design_Life_Is_constant_num_years_applied(&design_Life_Is_constant_num_years_applied);
        analysis->put_Design_Life_Is_constant_num_years_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        design__life__is_constant_num_years_applied = analysis.Design_Life_Is_constant_num_years_applied
        analysis.Design_Life_Is_constant_num_years_applied = True
        ```

### Design_Life_Constant_num_years {#design_life_constant_num_years}

```csharp
int Design_Life_Constant_num_years { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Constant_num_years = analysis.Design_Life_Constant_num_years;
        analysis.Design_Life_Constant_num_years = 1;
        ```

    === "C++"

        ```cpp
        long design_Life_Constant_num_years;
        analysis->get_Design_Life_Constant_num_years(&design_Life_Constant_num_years);
        analysis->put_Design_Life_Constant_num_years(1);
        ```

    === "Python"

        ```python
        design__life__constant_num_years = analysis.Design_Life_Constant_num_years
        analysis.Design_Life_Constant_num_years = 1
        ```

### Flow_Scale_Objective {#flow_scale_objective}

Flow Scale Analysis Objective

```csharp
int Flow_Scale_Objective { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Capacity (v/c ratio = xp)
- `1` - Capacity (v/c ratio = 1)
- `2` - Worst Lane Level of Service Target
- `3` - Worst Movement Level of Service Target
- `4` - Upper Limit

???- example "Code samples"

    === "C#"

        ```csharp
        int flow_Scale_Objective = analysis.Flow_Scale_Objective;
        analysis.Flow_Scale_Objective = 0;
        ```

    === "C++"

        ```cpp
        long flow_Scale_Objective;
        analysis->get_Flow_Scale_Objective(&flow_Scale_Objective);
        analysis->put_Flow_Scale_Objective(0);
        ```

    === "Python"

        ```python
        flow__scale__objective = analysis.Flow_Scale_Objective
        analysis.Flow_Scale_Objective = 0
        ```

### Flow_Scale_Lower {#flow_scale_lower}

```csharp
float Flow_Scale_Lower { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Lower = analysis.Flow_Scale_Lower;
        analysis.Flow_Scale_Lower = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Lower;
        analysis->get_Flow_Scale_Lower(&flow_Scale_Lower);
        analysis->put_Flow_Scale_Lower(0.0);
        ```

    === "Python"

        ```python
        flow__scale__lower = analysis.Flow_Scale_Lower
        analysis.Flow_Scale_Lower = 0.0
        ```

### Flow_Scale_Upper {#flow_scale_upper}

```csharp
float Flow_Scale_Upper { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Upper = analysis.Flow_Scale_Upper;
        analysis.Flow_Scale_Upper = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Upper;
        analysis->get_Flow_Scale_Upper(&flow_Scale_Upper);
        analysis->put_Flow_Scale_Upper(0.0);
        ```

    === "Python"

        ```python
        flow__scale__upper = analysis.Flow_Scale_Upper
        analysis.Flow_Scale_Upper = 0.0
        ```

### Flow_Scale_Is_constant_factor_applied {#flow_scale_is_constant_factor_applied}

```csharp
bool Flow_Scale_Is_constant_factor_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool flow_Scale_Is_constant_factor_applied = analysis.Flow_Scale_Is_constant_factor_applied;
        analysis.Flow_Scale_Is_constant_factor_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL flow_Scale_Is_constant_factor_applied;
        analysis->get_Flow_Scale_Is_constant_factor_applied(&flow_Scale_Is_constant_factor_applied);
        analysis->put_Flow_Scale_Is_constant_factor_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        flow__scale__is_constant_factor_applied = analysis.Flow_Scale_Is_constant_factor_applied
        analysis.Flow_Scale_Is_constant_factor_applied = True
        ```

### Flow_Scale_Constant_factor {#flow_scale_constant_factor}

```csharp
float Flow_Scale_Constant_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Constant_factor = analysis.Flow_Scale_Constant_factor;
        analysis.Flow_Scale_Constant_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Constant_factor;
        analysis->get_Flow_Scale_Constant_factor(&flow_Scale_Constant_factor);
        analysis->put_Flow_Scale_Constant_factor(0.0);
        ```

    === "Python"

        ```python
        flow__scale__constant_factor = analysis.Flow_Scale_Constant_factor
        analysis.Flow_Scale_Constant_factor = 0.0
        ```

### SensitivityGeneralParameterGroup {#sensitivitygeneralparametergroup}

```csharp
ISIAPISensitivity SensitivityGeneralParameterGroup { get; }
```

**Type** [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var sensitivityGeneralParameterGroup = analysis.SensitivityGeneralParameterGroup;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISensitivity> sensitivityGeneralParameterGroup;
        analysis->get_SensitivityGeneralParameterGroup(&sensitivityGeneralParameterGroup);
        ```

    === "Python"

        ```python
        sensitivity_general_parameter_group = analysis.SensitivityGeneralParameterGroup
        ```

### SensitivityRoundaboutParameterGroup {#sensitivityroundaboutparametergroup}

```csharp
ISIAPISensitivity SensitivityRoundaboutParameterGroup { get; }
```

**Type** [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var sensitivityRoundaboutParameterGroup = analysis.SensitivityRoundaboutParameterGroup;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISensitivity> sensitivityRoundaboutParameterGroup;
        analysis->get_SensitivityRoundaboutParameterGroup(&sensitivityRoundaboutParameterGroup);
        ```

    === "Python"

        ```python
        sensitivity_roundabout_parameter_group = analysis.SensitivityRoundaboutParameterGroup
        ```

### Result_option {#result_option}

Results For

```csharp
int Result_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Intersection - Vehicles
- `2` - Intersection - Pedestrians
- `3` - Intersection - Persons
- `4` - Lane
- `5` - Vehicle Movement
- `6` - Pedestrian Movement
- `7` - Approach (All Movements / All Lanes)

???- example "Code samples"

    === "C#"

        ```csharp
        int result_option = analysis.Result_option;
        analysis.Result_option = 0;
        ```

    === "C++"

        ```cpp
        long result_option;
        analysis->get_Result_option(&result_option);
        analysis->put_Result_option(0);
        ```

    === "Python"

        ```python
        result_option = analysis.Result_option
        analysis.Result_option = 0
        ```

### Result_leg_origin {#result_leg_origin}

```csharp
int Result_leg_origin { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_leg_origin = analysis.Result_leg_origin;
        analysis.Result_leg_origin = 0;
        ```

    === "C++"

        ```cpp
        long result_leg_origin;
        analysis->get_Result_leg_origin(&result_leg_origin);
        analysis->put_Result_leg_origin(0);
        ```

    === "Python"

        ```python
        result_leg_origin = analysis.Result_leg_origin
        analysis.Result_leg_origin = 0
        ```

### Result_lane_origin {#result_lane_origin}

```csharp
int Result_lane_origin { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_lane_origin = analysis.Result_lane_origin;
        analysis.Result_lane_origin = 0;
        ```

    === "C++"

        ```cpp
        long result_lane_origin;
        analysis->get_Result_lane_origin(&result_lane_origin);
        analysis->put_Result_lane_origin(0);
        ```

    === "Python"

        ```python
        result_lane_origin = analysis.Result_lane_origin
        analysis.Result_lane_origin = 0
        ```

### Result_laneno {#result_laneno}

```csharp
int Result_laneno { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_laneno = analysis.Result_laneno;
        analysis.Result_laneno = 0;
        ```

    === "C++"

        ```cpp
        long result_laneno;
        analysis->get_Result_laneno(&result_laneno);
        analysis->put_Result_laneno(0);
        ```

    === "Python"

        ```python
        result_laneno = analysis.Result_laneno
        analysis.Result_laneno = 0
        ```

### Result_vehmov_origin {#result_vehmov_origin}

```csharp
int Result_vehmov_origin { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_vehmov_origin = analysis.Result_vehmov_origin;
        analysis.Result_vehmov_origin = 0;
        ```

    === "C++"

        ```cpp
        long result_vehmov_origin;
        analysis->get_Result_vehmov_origin(&result_vehmov_origin);
        analysis->put_Result_vehmov_origin(0);
        ```

    === "Python"

        ```python
        result_vehmov_origin = analysis.Result_vehmov_origin
        analysis.Result_vehmov_origin = 0
        ```

### Result_vehmov_dest {#result_vehmov_dest}

```csharp
int Result_vehmov_dest { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_vehmov_dest = analysis.Result_vehmov_dest;
        analysis.Result_vehmov_dest = 0;
        ```

    === "C++"

        ```cpp
        long result_vehmov_dest;
        analysis->get_Result_vehmov_dest(&result_vehmov_dest);
        analysis->put_Result_vehmov_dest(0);
        ```

    === "Python"

        ```python
        result_vehmov_dest = analysis.Result_vehmov_dest
        analysis.Result_vehmov_dest = 0
        ```

### Result_mc_class {#result_mc_class}

```csharp
int Result_mc_class { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_mc_class = analysis.Result_mc_class;
        analysis.Result_mc_class = 0;
        ```

    === "C++"

        ```cpp
        long result_mc_class;
        analysis->get_Result_mc_class(&result_mc_class);
        analysis->put_Result_mc_class(0);
        ```

    === "Python"

        ```python
        result_mc_class = analysis.Result_mc_class
        analysis.Result_mc_class = 0
        ```

### Result_pedmov_option {#result_pedmov_option}

Pedestrian Movement Results Option

```csharp
int Result_pedmov_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Movement in front of an Approach
- `2` - Diagonal Crossing Movement

???- example "Code samples"

    === "C#"

        ```csharp
        int result_pedmov_option = analysis.Result_pedmov_option;
        analysis.Result_pedmov_option = 0;
        ```

    === "C++"

        ```cpp
        long result_pedmov_option;
        analysis->get_Result_pedmov_option(&result_pedmov_option);
        analysis->put_Result_pedmov_option(0);
        ```

    === "Python"

        ```python
        result_pedmov_option = analysis.Result_pedmov_option
        analysis.Result_pedmov_option = 0
        ```

### Result_pedmov_origin {#result_pedmov_origin}

```csharp
int Result_pedmov_origin { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_pedmov_origin = analysis.Result_pedmov_origin;
        analysis.Result_pedmov_origin = 0;
        ```

    === "C++"

        ```cpp
        long result_pedmov_origin;
        analysis->get_Result_pedmov_origin(&result_pedmov_origin);
        analysis->put_Result_pedmov_origin(0);
        ```

    === "Python"

        ```python
        result_pedmov_origin = analysis.Result_pedmov_origin
        analysis.Result_pedmov_origin = 0
        ```

### Result_pedmov_type {#result_pedmov_type}

```csharp
int Result_pedmov_type { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_pedmov_type = analysis.Result_pedmov_type;
        analysis.Result_pedmov_type = 0;
        ```

    === "C++"

        ```cpp
        long result_pedmov_type;
        analysis->get_Result_pedmov_type(&result_pedmov_type);
        analysis->put_Result_pedmov_type(0);
        ```

    === "Python"

        ```python
        result_pedmov_type = analysis.Result_pedmov_type
        analysis.Result_pedmov_type = 0
        ```

### Result_pedmov_stage_no {#result_pedmov_stage_no}

```csharp
int Result_pedmov_stage_no { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int result_pedmov_stage_no = analysis.Result_pedmov_stage_no;
        analysis.Result_pedmov_stage_no = 0;
        ```

    === "C++"

        ```cpp
        long result_pedmov_stage_no;
        analysis->get_Result_pedmov_stage_no(&result_pedmov_stage_no);
        analysis->put_Result_pedmov_stage_no(0);
        ```

    === "Python"

        ```python
        result_pedmov_stage_no = analysis.Result_pedmov_stage_no
        analysis.Result_pedmov_stage_no = 0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapidiagnosticmsg.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIDiagnosticMsg
title: DiagnosticMsg
name: ISIAPIDiagnosticMsg
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D05D7D69-F792-4AF5-8257-E238582A4200
members:
  - string Message
  - int Message_type
  - DateTime Log_time
---

# DiagnosticMsg

Type `ISIAPIDiagnosticMsg` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D05D7D69-F792-4AF5-8257-E238582A4200`

## Declaration

```csharp
[Guid("D05D7D69-F792-4AF5-8257-E238582A4200")]
public interface ISIAPIDiagnosticMsg
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Message](#message) | `string` |  |
| [Message_type](#message_type) | `int` | Message Type |
| [Log_time](#log_time) | `DateTime` |  |

</div>

## Properties

### Message {#message}

```csharp
string Message { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string message = diagnosticMsg.Message;
        ```

    === "C++"

        ```cpp
        CComBSTR message;
        diagnosticMsg->get_Message(&message);
        ```

    === "Python"

        ```python
        message = diagnosticMsg.Message
        ```

### Message_type {#message_type}

Message Type

```csharp
int Message_type { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Information
- `1` - Warning
- `2` - Error

???- example "Code samples"

    === "C#"

        ```csharp
        int message_type = diagnosticMsg.Message_type;
        ```

    === "C++"

        ```cpp
        long message_type;
        diagnosticMsg->get_Message_type(&message_type);
        ```

    === "Python"

        ```python
        message_type = diagnosticMsg.Message_type
        ```

### Log_time {#log_time}

```csharp
DateTime Log_time { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var log_time = diagnosticMsg.Log_time;
        ```

    === "C++"

        ```cpp
        VARIANT log_time;
        diagnosticMsg->get_Log_time(&log_time);
        ```

    === "Python"

        ```python
        log_time = diagnosticMsg.Log_time
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapidiagnosticmsgs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIDiagnosticMsgs
title: DiagnosticMsgs
name: ISIAPIDiagnosticMsgs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: F6EF0DF4-4EA8-4A6D-B971-8F8787F60FE1
members:
  - ISIAPIDiagnosticMsg this[int index]
  - int Count
---

# DiagnosticMsgs

Type `ISIAPIDiagnosticMsgs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `F6EF0DF4-4EA8-4A6D-B971-8F8787F60FE1`

## Declaration

```csharp
[Guid("F6EF0DF4-4EA8-4A6D-B971-8F8787F60FE1")]
public interface ISIAPIDiagnosticMsgs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIDiagnosticMsg`](sidrasolutions.si.api.isiapidiagnosticmsg.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = diagnosticMsgs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        diagnosticMsgs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = diagnosticMsgs.Count
        ```

### this[] {#this}

```csharp
ISIAPIDiagnosticMsg this[] { get; }
```

**Type** [`ISIAPIDiagnosticMsg`](sidrasolutions.si.api.isiapidiagnosticmsg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = diagnosticMsgs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIDiagnosticMsg> this[];
        diagnosticMsgs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = diagnosticMsgs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapigapacceptancespecificapp.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIGapAcceptanceSpecificApp
title: GapAcceptanceSpecificApp
name: ISIAPIGapAcceptanceSpecificApp
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E07DF8C0-4F93-4DBD-B7F1-DB94A982C654
members:
  - float Critical_gap
  - float Followup_headway
  - float End_departures
  - float Exit_flow_effect
  - float Percent_opposed_by_nearest
---

# GapAcceptanceSpecificApp

Type `ISIAPIGapAcceptanceSpecificApp` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E07DF8C0-4F93-4DBD-B7F1-DB94A982C654`

## Declaration

```csharp
[Guid("E07DF8C0-4F93-4DBD-B7F1-DB94A982C654")]
public interface ISIAPIGapAcceptanceSpecificApp
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Critical_gap](#critical_gap) | `float` |  |
| [Followup_headway](#followup_headway) | `float` |  |
| [End_departures](#end_departures) | `float` |  |
| [Exit_flow_effect](#exit_flow_effect) | `float` |  |
| [Percent_opposed_by_nearest](#percent_opposed_by_nearest) | `float` |  |

</div>

## Properties

### Critical_gap {#critical_gap}

```csharp
float Critical_gap { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap = gapAcceptanceSpecificApp.Critical_gap;
        gapAcceptanceSpecificApp.Critical_gap = 0.0;
        ```

    === "C++"

        ```cpp
        double critical_gap;
        gapAcceptanceSpecificApp->get_Critical_gap(&critical_gap);
        gapAcceptanceSpecificApp->put_Critical_gap(0.0);
        ```

    === "Python"

        ```python
        critical_gap = gapAcceptanceSpecificApp.Critical_gap
        gapAcceptanceSpecificApp.Critical_gap = 0.0
        ```

### Followup_headway {#followup_headway}

```csharp
float Followup_headway { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway = gapAcceptanceSpecificApp.Followup_headway;
        gapAcceptanceSpecificApp.Followup_headway = 0.0;
        ```

    === "C++"

        ```cpp
        double followup_headway;
        gapAcceptanceSpecificApp->get_Followup_headway(&followup_headway);
        gapAcceptanceSpecificApp->put_Followup_headway(0.0);
        ```

    === "Python"

        ```python
        followup_headway = gapAcceptanceSpecificApp.Followup_headway
        gapAcceptanceSpecificApp.Followup_headway = 0.0
        ```

### End_departures {#end_departures}

```csharp
float End_departures { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_departures = gapAcceptanceSpecificApp.End_departures;
        gapAcceptanceSpecificApp.End_departures = 0.0;
        ```

    === "C++"

        ```cpp
        double end_departures;
        gapAcceptanceSpecificApp->get_End_departures(&end_departures);
        gapAcceptanceSpecificApp->put_End_departures(0.0);
        ```

    === "Python"

        ```python
        end_departures = gapAcceptanceSpecificApp.End_departures
        gapAcceptanceSpecificApp.End_departures = 0.0
        ```

### Exit_flow_effect {#exit_flow_effect}

```csharp
float Exit_flow_effect { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_flow_effect = gapAcceptanceSpecificApp.Exit_flow_effect;
        gapAcceptanceSpecificApp.Exit_flow_effect = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_flow_effect;
        gapAcceptanceSpecificApp->get_Exit_flow_effect(&exit_flow_effect);
        gapAcceptanceSpecificApp->put_Exit_flow_effect(0.0);
        ```

    === "Python"

        ```python
        exit_flow_effect = gapAcceptanceSpecificApp.Exit_flow_effect
        gapAcceptanceSpecificApp.Exit_flow_effect = 0.0
        ```

### Percent_opposed_by_nearest {#percent_opposed_by_nearest}

```csharp
float Percent_opposed_by_nearest { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_opposed_by_nearest = gapAcceptanceSpecificApp.Percent_opposed_by_nearest;
        gapAcceptanceSpecificApp.Percent_opposed_by_nearest = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_opposed_by_nearest;
        gapAcceptanceSpecificApp->get_Percent_opposed_by_nearest(&percent_opposed_by_nearest);
        gapAcceptanceSpecificApp->put_Percent_opposed_by_nearest(0.0);
        ```

    === "Python"

        ```python
        percent_opposed_by_nearest = gapAcceptanceSpecificApp.Percent_opposed_by_nearest
        gapAcceptanceSpecificApp.Percent_opposed_by_nearest = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiisland.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIIsland
title: Island
name: ISIAPIIsland
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4EA86703-B473-4058-9A24-A33E9FE35EDC
members:
  - int Island_no
  - int Position
  - bool Is_pedstage_separator
  - bool Is_rou_splitter
  - float Width
  - float Width_back
  - int Fill_style
  - ISIAPILeg Leg
  - bool Is_short
  - bool Is_for_freeway
  - ISIAPIIsland ConnectedIsland
---

# Island

Type `ISIAPIIsland` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4EA86703-B473-4058-9A24-A33E9FE35EDC`

## Declaration

```csharp
[Guid("4EA86703-B473-4058-9A24-A33E9FE35EDC")]
public interface ISIAPIIsland
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Island_no](#island_no) | `int` | Island Number, a one-based integer, counts Islands only from left to right looking to the centre of the Intersection. |
| [Position](#position) | `int` | Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |
| [Is_pedstage_separator](#is_pedstage_separator) | `bool` |  |
| [Is_rou_splitter](#is_rou_splitter) | `bool` |  |
| [Width](#width) | `float` | Island's Front Width. If this is a Roundabout Splitter Island, the Front Width value is ignore. |
| [Width_back](#width_back) | `float` | Island's Back Width |
| [Fill_style](#fill_style) | `int` | Island Fill Style |
| [Leg](#leg) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) |  |
| [Is_short](#is_short) | `bool` | Indicate if this Island is a Short Strip Island |
| [Is_for_freeway](#is_for_freeway) | `bool` | Indicate if this Island is a Median Island on a Freeway |
| [ConnectedIsland](#connectedisland) | [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) |  |

</div>

## Properties

### Island_no {#island_no}

Island Number, a one-based integer, counts Islands only from left to right looking to the centre of the Intersection.

```csharp
int Island_no { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int island_no = island.Island_no;
        ```

    === "C++"

        ```cpp
        long island_no;
        island->get_Island_no(&island_no);
        ```

    === "Python"

        ```python
        island_no = island.Island_no
        ```

### Position {#position}

Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = island.Position;
        ```

    === "C++"

        ```cpp
        long position;
        island->get_Position(&position);
        ```

    === "Python"

        ```python
        position = island.Position
        ```

### Is_pedstage_separator {#is_pedstage_separator}

```csharp
bool Is_pedstage_separator { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_pedstage_separator = island.Is_pedstage_separator;
        island.Is_pedstage_separator = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_pedstage_separator;
        island->get_Is_pedstage_separator(&is_pedstage_separator);
        island->put_Is_pedstage_separator(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_pedstage_separator = island.Is_pedstage_separator
        island.Is_pedstage_separator = True
        ```

### Is_rou_splitter {#is_rou_splitter}

```csharp
bool Is_rou_splitter { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_rou_splitter = island.Is_rou_splitter;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_rou_splitter;
        island->get_Is_rou_splitter(&is_rou_splitter);
        ```

    === "Python"

        ```python
        is_rou_splitter = island.Is_rou_splitter
        ```

### Width {#width}

Island's Front Width. If this is a Roundabout Splitter Island, the Front Width value is ignore.

```csharp
float Width { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width = island.Width;
        island.Width = 0.0;
        ```

    === "C++"

        ```cpp
        double width;
        island->get_Width(&width);
        island->put_Width(0.0);
        ```

    === "Python"

        ```python
        width = island.Width
        island.Width = 0.0
        ```

### Width_back {#width_back}

Island's Back Width

```csharp
float Width_back { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width_back = island.Width_back;
        island.Width_back = 0.0;
        ```

    === "C++"

        ```cpp
        double width_back;
        island->get_Width_back(&width_back);
        island->put_Width_back(0.0);
        ```

    === "Python"

        ```python
        width_back = island.Width_back
        island.Width_back = 0.0
        ```

### Fill_style {#fill_style}

Island Fill Style

```csharp
int Fill_style { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Solid
- `2` - Hatched
- `3` - Chevron
- `4` - Parking Strip

???- example "Code samples"

    === "C#"

        ```csharp
        int fill_style = island.Fill_style;
        island.Fill_style = 0;
        ```

    === "C++"

        ```cpp
        long fill_style;
        island->get_Fill_style(&fill_style);
        island->put_Fill_style(0);
        ```

    === "Python"

        ```python
        fill_style = island.Fill_style
        island.Fill_style = 0
        ```

### Leg {#leg}

```csharp
ISIAPILeg Leg { get; }
```

**Type** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg = island.Leg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> leg;
        island->get_Leg(&leg);
        ```

    === "Python"

        ```python
        leg = island.Leg
        ```

### Is_short {#is_short}

Indicate if this Island is a Short Strip Island

```csharp
bool Is_short { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_short = island.Is_short;
        island.Is_short = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_short;
        island->get_Is_short(&is_short);
        island->put_Is_short(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_short = island.Is_short
        island.Is_short = True
        ```

### Is_for_freeway {#is_for_freeway}

Indicate if this Island is a Median Island on a Freeway

```csharp
bool Is_for_freeway { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_for_freeway = island.Is_for_freeway;
        island.Is_for_freeway = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_for_freeway;
        island->get_Is_for_freeway(&is_for_freeway);
        island->put_Is_for_freeway(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_for_freeway = island.Is_for_freeway
        island.Is_for_freeway = True
        ```

### ConnectedIsland {#connectedisland}

```csharp
ISIAPIIsland ConnectedIsland { get; set; }
```

**Type** [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var connectedIsland = island.ConnectedIsland;
        island.ConnectedIsland = null;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIIsland> connectedIsland;
        island->get_ConnectedIsland(&connectedIsland);
        island->put_ConnectedIsland(NULL);
        ```

    === "Python"

        ```python
        connected_island = island.ConnectedIsland
        island.ConnectedIsland = None
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiislands.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIIslands
title: Islands
name: ISIAPIIslands
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 396351EE-ED25-48E9-BBE5-BD6D190589BC
members:
  - bool IslandExists(int island_no)
  - ISIAPIIsland this[int island_no]
  - int Count
---

# Islands

Type `ISIAPIIslands` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `396351EE-ED25-48E9-BBE5-BD6D190589BC`

## Declaration

```csharp
[Guid("396351EE-ED25-48E9-BBE5-BD6D190589BC")]
public interface ISIAPIIslands
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [IslandExists(int)](#islandexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = islands.Count;
        ```

    === "C++"

        ```cpp
        long count;
        islands->get_Count(&count);
        ```

    === "Python"

        ```python
        count = islands.Count
        ```

### this[] {#this}

```csharp
ISIAPIIsland this[] { get; }
```

**Type** [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = islands.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIIsland> this[];
        islands->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = islands.this[]
        ```

## Methods

### IslandExists(int) {#islandexists-int}

```csharp
bool IslandExists(int island_no)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `island_no` | `int` | Island Number, a one-based integer, counts Islands only from left to right looking to the centre of the Intersection. |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = islands.IslandExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        islands->IslandExists(0, &result);
        ```

    === "Python"

        ```python
        result = islands.IslandExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproach.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproach
title: LaneApproach
name: ISIAPILaneApproach
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0A26C311-D793-4562-87D2-C479DC7D4598
members:
  - bool RemoveDisciplines()
  - int Laneno
  - int Position
  - int Configuration
  - int Type
  - int Control_type
  - float Length
  - float Width
  - float Grade
  - int Slip_control_type
  - int Basic_saturation_flow
  - bool Utilisation_user
  - float Utilisation
  - bool Saturation_speed_user
  - float Saturation_speed
  - float Capacity_adjustment
  - bool Is_capacity_adj_for_network
  - bool Is_dominant_lane
  - bool Is_sliplane_included_in_entry_lane_count
  - bool Buses_stopping_user
  - int Buses_stopping
  - bool Parking_manoeuvres_user
  - int Parking_manoeuvres
  - bool Is_sliplane_excluded_from_signal_analysis
  - ISIAPILaneApproachMovements LaneApproachMovements
  - ISIAPILaneMovements LaneMovements
  - ISIAPILaneSegment Segment1
  - ISIAPILaneSegment Segment2
  - ISIAPILeg Leg
  - bool Is_departure_headway_awsc_applied
  - float Departure_headway_awsc
  - string LastErrorMessage
  - bool Is_satn_flow_estimation_applied
  - int Shortlane_capacity_option
  - float Shortlane_capacity_factor
  - bool Delay_model_param_user
  - float Delay_model_param
  - float Initial_demand_vol
  - float Width_midblock
  - float Width_slip
---

# LaneApproach

Type `ISIAPILaneApproach` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0A26C311-D793-4562-87D2-C479DC7D4598`

## Declaration

```csharp
[Guid("0A26C311-D793-4562-87D2-C479DC7D4598")]
public interface ISIAPILaneApproach
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Laneno](#laneno) | `int` | Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure. |
| [Position](#position) | `int` | Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |
| [Configuration](#configuration) | `int` | Lane Configuration |
| [Type](#type) | `int` | Lane Type |
| [Control_type](#control_type) | `int` | Lane Control Type |
| [Length](#length) | `float` | Lane Length |
| [Width](#width) | `float` |  |
| [Grade](#grade) | `float` |  |
| [Slip_control_type](#slip_control_type) | `int` | Slip/Bypass Lane Control Type, apply to exclusive Slip/Bypass Lane or the Slip/Bypass part of a Shared Slip/Bypass Lane. |
| [Basic_saturation_flow](#basic_saturation_flow) | `int` |  |
| [Utilisation_user](#utilisation_user) | `bool` |  |
| [Utilisation](#utilisation) | `float` |  |
| [Saturation_speed_user](#saturation_speed_user) | `bool` |  |
| [Saturation_speed](#saturation_speed) | `float` |  |
| [Capacity_adjustment](#capacity_adjustment) | `float` |  |
| [Is_capacity_adj_for_network](#is_capacity_adj_for_network) | `bool` |  |
| [Is_dominant_lane](#is_dominant_lane) | `bool` |  |
| [Is_sliplane_included_in_entry_lane_count](#is_sliplane_included_in_entry_lane_count) | `bool` |  |
| [Buses_stopping_user](#buses_stopping_user) | `bool` |  |
| [Buses_stopping](#buses_stopping) | `int` |  |
| [Parking_manoeuvres_user](#parking_manoeuvres_user) | `bool` |  |
| [Parking_manoeuvres](#parking_manoeuvres) | `int` |  |
| [Is_sliplane_excluded_from_signal_analysis](#is_sliplane_excluded_from_signal_analysis) | `bool` |  |
| [LaneApproachMovements](#laneapproachmovements) | [`ISIAPILaneApproachMovements`](sidrasolutions.si.api.isiapilaneapproachmovements.md) | Approach Lane Movements, defines the Vehicle Approach Movements (per Movement Class) running on this Approach Lane. It always returns eight Movements to the eight destinations (0: South, 1: South East, ... 7: South West). |
| [LaneMovements](#lanemovements) | [`ISIAPILaneMovements`](sidrasolutions.si.api.isiapilanemovements.md) |  |
| [Segment1](#segment1) | [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md) | Lane Segement 1 |
| [Segment2](#segment2) | [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md) | Lane Segement 2 |
| [Leg](#leg) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) |  |
| [Is_departure_headway_awsc_applied](#is_departure_headway_awsc_applied) | `bool` |  |
| [Departure_headway_awsc](#departure_headway_awsc) | `float` |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [Is_satn_flow_estimation_applied](#is_satn_flow_estimation_applied) | `bool` |  |
| [Shortlane_capacity_option](#shortlane_capacity_option) | `int` | Short Lane Capacity (Calibration Options) |
| [Shortlane_capacity_factor](#shortlane_capacity_factor) | `float` |  |
| [Delay_model_param_user](#delay_model_param_user) | `bool` |  |
| [Delay_model_param](#delay_model_param) | `float` |  |
| [Initial_demand_vol](#initial_demand_vol) | `float` |  |
| [Width_midblock](#width_midblock) | `float` | Lane Width (Upstream) of this Approach Lane |
| [Width_slip](#width_slip) | `float` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [RemoveDisciplines()](#removedisciplines) | `bool` | Clear all Disciplines on this Approach Lane, i.e. all ISIAPILaneApproachMovementMC data of this Approach Lane are set to not existing (ISIAPILaneApproachMovementMC.Exists = false). |

</div>

## Properties

### Laneno {#laneno}

Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure.

```csharp
int Laneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int laneno = laneApproach.Laneno;
        ```

    === "C++"

        ```cpp
        long laneno;
        laneApproach->get_Laneno(&laneno);
        ```

    === "Python"

        ```python
        laneno = laneApproach.Laneno
        ```

### Position {#position}

Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = laneApproach.Position;
        ```

    === "C++"

        ```cpp
        long position;
        laneApproach->get_Position(&position);
        ```

    === "Python"

        ```python
        position = laneApproach.Position
        ```

### Configuration {#configuration}

Lane Configuration

```csharp
int Configuration { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Full-Length Lane
- `2` - Short Lane
- `3` - Short Lane with Parking
- `4` - Two-Segment Lane

???- example "Code samples"

    === "C#"

        ```csharp
        int configuration = laneApproach.Configuration;
        laneApproach.Configuration = 0;
        ```

    === "C++"

        ```cpp
        long configuration;
        laneApproach->get_Configuration(&configuration);
        laneApproach->put_Configuration(0);
        ```

    === "Python"

        ```python
        configuration = laneApproach.Configuration
        laneApproach.Configuration = 0
        ```

### Type {#type}

Lane Type

```csharp
int Type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Normal
- `2` - Slip/Bypass (High Angle)
- `3` - Slip/Bypass (Low Angle)

???- example "Code samples"

    === "C#"

        ```csharp
        int type = laneApproach.Type;
        laneApproach.Type = 0;
        ```

    === "C++"

        ```cpp
        long type;
        laneApproach->get_Type(&type);
        laneApproach->put_Type(0);
        ```

    === "Python"

        ```python
        type = laneApproach.Type
        laneApproach.Type = 0
        ```

### Control_type {#control_type}

Lane Control Type

```csharp
int Control_type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Signals
- `2` - Giveway/Yield
- `3` - Stop
- `4` - Continuous

???- example "Code samples"

    === "C#"

        ```csharp
        int control_type = laneApproach.Control_type;
        laneApproach.Control_type = 0;
        ```

    === "C++"

        ```cpp
        long control_type;
        laneApproach->get_Control_type(&control_type);
        laneApproach->put_Control_type(0);
        ```

    === "Python"

        ```python
        control_type = laneApproach.Control_type
        laneApproach.Control_type = 0
        ```

### Length {#length}

Lane Length

```csharp
float Length { get; set; }
```

**Type** `float`

**Remarks**

For Full-Length Lane or Two-Segment Lane, this is the Length of the whole Lane; for Short Lane or Short Lane with Parking, this is synchronized with the Segment 1 Length

???- example "Code samples"

    === "C#"

        ```csharp
        float length = laneApproach.Length;
        laneApproach.Length = 0.0;
        ```

    === "C++"

        ```cpp
        double length;
        laneApproach->get_Length(&length);
        laneApproach->put_Length(0.0);
        ```

    === "Python"

        ```python
        length = laneApproach.Length
        laneApproach.Length = 0.0
        ```

### Width {#width}

```csharp
float Width { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width = laneApproach.Width;
        laneApproach.Width = 0.0;
        ```

    === "C++"

        ```cpp
        double width;
        laneApproach->get_Width(&width);
        laneApproach->put_Width(0.0);
        ```

    === "Python"

        ```python
        width = laneApproach.Width
        laneApproach.Width = 0.0
        ```

### Grade {#grade}

```csharp
float Grade { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float grade = laneApproach.Grade;
        laneApproach.Grade = 0.0;
        ```

    === "C++"

        ```cpp
        double grade;
        laneApproach->get_Grade(&grade);
        laneApproach->put_Grade(0.0);
        ```

    === "Python"

        ```python
        grade = laneApproach.Grade
        laneApproach.Grade = 0.0
        ```

### Slip_control_type {#slip_control_type}

Slip/Bypass Lane Control Type, apply to exclusive Slip/Bypass Lane or the Slip/Bypass part of a Shared Slip/Bypass Lane.

```csharp
int Slip_control_type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Signals
- `2` - Giveway/Yield
- `3` - Stop
- `4` - Continuous

???- example "Code samples"

    === "C#"

        ```csharp
        int slip_control_type = laneApproach.Slip_control_type;
        laneApproach.Slip_control_type = 0;
        ```

    === "C++"

        ```cpp
        long slip_control_type;
        laneApproach->get_Slip_control_type(&slip_control_type);
        laneApproach->put_Slip_control_type(0);
        ```

    === "Python"

        ```python
        slip_control_type = laneApproach.Slip_control_type
        laneApproach.Slip_control_type = 0
        ```

### Basic_saturation_flow {#basic_saturation_flow}

```csharp
int Basic_saturation_flow { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int basic_saturation_flow = laneApproach.Basic_saturation_flow;
        laneApproach.Basic_saturation_flow = 0;
        ```

    === "C++"

        ```cpp
        long basic_saturation_flow;
        laneApproach->get_Basic_saturation_flow(&basic_saturation_flow);
        laneApproach->put_Basic_saturation_flow(0);
        ```

    === "Python"

        ```python
        basic_saturation_flow = laneApproach.Basic_saturation_flow
        laneApproach.Basic_saturation_flow = 0
        ```

### Utilisation_user {#utilisation_user}

```csharp
bool Utilisation_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool utilisation_user = laneApproach.Utilisation_user;
        laneApproach.Utilisation_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL utilisation_user;
        laneApproach->get_Utilisation_user(&utilisation_user);
        laneApproach->put_Utilisation_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        utilisation_user = laneApproach.Utilisation_user
        laneApproach.Utilisation_user = True
        ```

### Utilisation {#utilisation}

```csharp
float Utilisation { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float utilisation = laneApproach.Utilisation;
        laneApproach.Utilisation = 0.0;
        ```

    === "C++"

        ```cpp
        double utilisation;
        laneApproach->get_Utilisation(&utilisation);
        laneApproach->put_Utilisation(0.0);
        ```

    === "Python"

        ```python
        utilisation = laneApproach.Utilisation
        laneApproach.Utilisation = 0.0
        ```

### Saturation_speed_user {#saturation_speed_user}

```csharp
bool Saturation_speed_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool saturation_speed_user = laneApproach.Saturation_speed_user;
        laneApproach.Saturation_speed_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL saturation_speed_user;
        laneApproach->get_Saturation_speed_user(&saturation_speed_user);
        laneApproach->put_Saturation_speed_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        saturation_speed_user = laneApproach.Saturation_speed_user
        laneApproach.Saturation_speed_user = True
        ```

### Saturation_speed {#saturation_speed}

```csharp
float Saturation_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float saturation_speed = laneApproach.Saturation_speed;
        laneApproach.Saturation_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double saturation_speed;
        laneApproach->get_Saturation_speed(&saturation_speed);
        laneApproach->put_Saturation_speed(0.0);
        ```

    === "Python"

        ```python
        saturation_speed = laneApproach.Saturation_speed
        laneApproach.Saturation_speed = 0.0
        ```

### Capacity_adjustment {#capacity_adjustment}

```csharp
float Capacity_adjustment { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adjustment = laneApproach.Capacity_adjustment;
        laneApproach.Capacity_adjustment = 0.0;
        ```

    === "C++"

        ```cpp
        double capacity_adjustment;
        laneApproach->get_Capacity_adjustment(&capacity_adjustment);
        laneApproach->put_Capacity_adjustment(0.0);
        ```

    === "Python"

        ```python
        capacity_adjustment = laneApproach.Capacity_adjustment
        laneApproach.Capacity_adjustment = 0.0
        ```

### Is_capacity_adj_for_network {#is_capacity_adj_for_network}

```csharp
bool Is_capacity_adj_for_network { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_capacity_adj_for_network = laneApproach.Is_capacity_adj_for_network;
        laneApproach.Is_capacity_adj_for_network = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_capacity_adj_for_network;
        laneApproach->get_Is_capacity_adj_for_network(&is_capacity_adj_for_network);
        laneApproach->put_Is_capacity_adj_for_network(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_capacity_adj_for_network = laneApproach.Is_capacity_adj_for_network
        laneApproach.Is_capacity_adj_for_network = True
        ```

### Is_dominant_lane {#is_dominant_lane}

```csharp
bool Is_dominant_lane { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_dominant_lane = laneApproach.Is_dominant_lane;
        laneApproach.Is_dominant_lane = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_dominant_lane;
        laneApproach->get_Is_dominant_lane(&is_dominant_lane);
        laneApproach->put_Is_dominant_lane(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_dominant_lane = laneApproach.Is_dominant_lane
        laneApproach.Is_dominant_lane = True
        ```

### Is_sliplane_included_in_entry_lane_count {#is_sliplane_included_in_entry_lane_count}

```csharp
bool Is_sliplane_included_in_entry_lane_count { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_sliplane_included_in_entry_lane_count = laneApproach.Is_sliplane_included_in_entry_lane_count;
        laneApproach.Is_sliplane_included_in_entry_lane_count = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_sliplane_included_in_entry_lane_count;
        laneApproach->get_Is_sliplane_included_in_entry_lane_count(&is_sliplane_included_in_entry_lane_count);
        laneApproach->put_Is_sliplane_included_in_entry_lane_count(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_sliplane_included_in_entry_lane_count = laneApproach.Is_sliplane_included_in_entry_lane_count
        laneApproach.Is_sliplane_included_in_entry_lane_count = True
        ```

### Buses_stopping_user {#buses_stopping_user}

```csharp
bool Buses_stopping_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool buses_stopping_user = laneApproach.Buses_stopping_user;
        laneApproach.Buses_stopping_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL buses_stopping_user;
        laneApproach->get_Buses_stopping_user(&buses_stopping_user);
        laneApproach->put_Buses_stopping_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        buses_stopping_user = laneApproach.Buses_stopping_user
        laneApproach.Buses_stopping_user = True
        ```

### Buses_stopping {#buses_stopping}

```csharp
int Buses_stopping { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int buses_stopping = laneApproach.Buses_stopping;
        laneApproach.Buses_stopping = 0;
        ```

    === "C++"

        ```cpp
        long buses_stopping;
        laneApproach->get_Buses_stopping(&buses_stopping);
        laneApproach->put_Buses_stopping(0);
        ```

    === "Python"

        ```python
        buses_stopping = laneApproach.Buses_stopping
        laneApproach.Buses_stopping = 0
        ```

### Parking_manoeuvres_user {#parking_manoeuvres_user}

```csharp
bool Parking_manoeuvres_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool parking_manoeuvres_user = laneApproach.Parking_manoeuvres_user;
        laneApproach.Parking_manoeuvres_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL parking_manoeuvres_user;
        laneApproach->get_Parking_manoeuvres_user(&parking_manoeuvres_user);
        laneApproach->put_Parking_manoeuvres_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        parking_manoeuvres_user = laneApproach.Parking_manoeuvres_user
        laneApproach.Parking_manoeuvres_user = True
        ```

### Parking_manoeuvres {#parking_manoeuvres}

```csharp
int Parking_manoeuvres { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int parking_manoeuvres = laneApproach.Parking_manoeuvres;
        laneApproach.Parking_manoeuvres = 0;
        ```

    === "C++"

        ```cpp
        long parking_manoeuvres;
        laneApproach->get_Parking_manoeuvres(&parking_manoeuvres);
        laneApproach->put_Parking_manoeuvres(0);
        ```

    === "Python"

        ```python
        parking_manoeuvres = laneApproach.Parking_manoeuvres
        laneApproach.Parking_manoeuvres = 0
        ```

### Is_sliplane_excluded_from_signal_analysis {#is_sliplane_excluded_from_signal_analysis}

```csharp
bool Is_sliplane_excluded_from_signal_analysis { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_sliplane_excluded_from_signal_analysis = laneApproach.Is_sliplane_excluded_from_signal_analysis;
        laneApproach.Is_sliplane_excluded_from_signal_analysis = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_sliplane_excluded_from_signal_analysis;
        laneApproach->get_Is_sliplane_excluded_from_signal_analysis(&is_sliplane_excluded_from_signal_analysis);
        laneApproach->put_Is_sliplane_excluded_from_signal_analysis(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_sliplane_excluded_from_signal_analysis = laneApproach.Is_sliplane_excluded_from_signal_analysis
        laneApproach.Is_sliplane_excluded_from_signal_analysis = True
        ```

### LaneApproachMovements {#laneapproachmovements}

Approach Lane Movements, defines the Vehicle Approach Movements (per Movement Class) running on this Approach Lane. It always returns eight Movements to the eight destinations (0: South, 1: South East, ... 7: South West).

```csharp
ISIAPILaneApproachMovements LaneApproachMovements { get; }
```

**Type** [`ISIAPILaneApproachMovements`](sidrasolutions.si.api.isiapilaneapproachmovements.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproachMovements = laneApproach.LaneApproachMovements;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachMovements> laneApproachMovements;
        laneApproach->get_LaneApproachMovements(&laneApproachMovements);
        ```

    === "Python"

        ```python
        lane_approach_movements = laneApproach.LaneApproachMovements
        ```

### LaneMovements {#lanemovements}

```csharp
ISIAPILaneMovements LaneMovements { get; }
```

**Type** [`ISIAPILaneMovements`](sidrasolutions.si.api.isiapilanemovements.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneMovements = laneApproach.LaneMovements;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovements> laneMovements;
        laneApproach->get_LaneMovements(&laneMovements);
        ```

    === "Python"

        ```python
        lane_movements = laneApproach.LaneMovements
        ```

### Segment1 {#segment1}

Lane Segement 1

```csharp
ISIAPILaneSegment Segment1 { get; }
```

**Type** [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var segment1 = laneApproach.Segment1;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegment> segment1;
        laneApproach->get_Segment1(&segment1);
        ```

    === "Python"

        ```python
        segment1 = laneApproach.Segment1
        ```

### Segment2 {#segment2}

Lane Segement 2

```csharp
ISIAPILaneSegment Segment2 { get; }
```

**Type** [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var segment2 = laneApproach.Segment2;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegment> segment2;
        laneApproach->get_Segment2(&segment2);
        ```

    === "Python"

        ```python
        segment2 = laneApproach.Segment2
        ```

### Leg {#leg}

```csharp
ISIAPILeg Leg { get; }
```

**Type** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg = laneApproach.Leg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> leg;
        laneApproach->get_Leg(&leg);
        ```

    === "Python"

        ```python
        leg = laneApproach.Leg
        ```

### Is_departure_headway_awsc_applied {#is_departure_headway_awsc_applied}

```csharp
bool Is_departure_headway_awsc_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_departure_headway_awsc_applied = laneApproach.Is_departure_headway_awsc_applied;
        laneApproach.Is_departure_headway_awsc_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_departure_headway_awsc_applied;
        laneApproach->get_Is_departure_headway_awsc_applied(&is_departure_headway_awsc_applied);
        laneApproach->put_Is_departure_headway_awsc_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_departure_headway_awsc_applied = laneApproach.Is_departure_headway_awsc_applied
        laneApproach.Is_departure_headway_awsc_applied = True
        ```

### Departure_headway_awsc {#departure_headway_awsc}

```csharp
float Departure_headway_awsc { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float departure_headway_awsc = laneApproach.Departure_headway_awsc;
        laneApproach.Departure_headway_awsc = 0.0;
        ```

    === "C++"

        ```cpp
        double departure_headway_awsc;
        laneApproach->get_Departure_headway_awsc(&departure_headway_awsc);
        laneApproach->put_Departure_headway_awsc(0.0);
        ```

    === "Python"

        ```python
        departure_headway_awsc = laneApproach.Departure_headway_awsc
        laneApproach.Departure_headway_awsc = 0.0
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = laneApproach.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        laneApproach->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = laneApproach.LastErrorMessage
        ```

### Is_satn_flow_estimation_applied {#is_satn_flow_estimation_applied}

```csharp
bool Is_satn_flow_estimation_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_satn_flow_estimation_applied = laneApproach.Is_satn_flow_estimation_applied;
        laneApproach.Is_satn_flow_estimation_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_satn_flow_estimation_applied;
        laneApproach->get_Is_satn_flow_estimation_applied(&is_satn_flow_estimation_applied);
        laneApproach->put_Is_satn_flow_estimation_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_satn_flow_estimation_applied = laneApproach.Is_satn_flow_estimation_applied
        laneApproach.Is_satn_flow_estimation_applied = True
        ```

### Shortlane_capacity_option {#shortlane_capacity_option}

Short Lane Capacity (Calibration Options)

```csharp
int Shortlane_capacity_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Program
- `1` - Do Not Apply
- `2` - Calibration Factor

???- example "Code samples"

    === "C#"

        ```csharp
        int shortlane_capacity_option = laneApproach.Shortlane_capacity_option;
        laneApproach.Shortlane_capacity_option = 0;
        ```

    === "C++"

        ```cpp
        long shortlane_capacity_option;
        laneApproach->get_Shortlane_capacity_option(&shortlane_capacity_option);
        laneApproach->put_Shortlane_capacity_option(0);
        ```

    === "Python"

        ```python
        shortlane_capacity_option = laneApproach.Shortlane_capacity_option
        laneApproach.Shortlane_capacity_option = 0
        ```

### Shortlane_capacity_factor {#shortlane_capacity_factor}

```csharp
float Shortlane_capacity_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float shortlane_capacity_factor = laneApproach.Shortlane_capacity_factor;
        laneApproach.Shortlane_capacity_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double shortlane_capacity_factor;
        laneApproach->get_Shortlane_capacity_factor(&shortlane_capacity_factor);
        laneApproach->put_Shortlane_capacity_factor(0.0);
        ```

    === "Python"

        ```python
        shortlane_capacity_factor = laneApproach.Shortlane_capacity_factor
        laneApproach.Shortlane_capacity_factor = 0.0
        ```

### Delay_model_param_user {#delay_model_param_user}

```csharp
bool Delay_model_param_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool delay_model_param_user = laneApproach.Delay_model_param_user;
        laneApproach.Delay_model_param_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL delay_model_param_user;
        laneApproach->get_Delay_model_param_user(&delay_model_param_user);
        laneApproach->put_Delay_model_param_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        delay_model_param_user = laneApproach.Delay_model_param_user
        laneApproach.Delay_model_param_user = True
        ```

### Delay_model_param {#delay_model_param}

```csharp
float Delay_model_param { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_model_param = laneApproach.Delay_model_param;
        laneApproach.Delay_model_param = 0.0;
        ```

    === "C++"

        ```cpp
        double delay_model_param;
        laneApproach->get_Delay_model_param(&delay_model_param);
        laneApproach->put_Delay_model_param(0.0);
        ```

    === "Python"

        ```python
        delay_model_param = laneApproach.Delay_model_param
        laneApproach.Delay_model_param = 0.0
        ```

### Initial_demand_vol {#initial_demand_vol}

```csharp
float Initial_demand_vol { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float initial_demand_vol = laneApproach.Initial_demand_vol;
        laneApproach.Initial_demand_vol = 0.0;
        ```

    === "C++"

        ```cpp
        double initial_demand_vol;
        laneApproach->get_Initial_demand_vol(&initial_demand_vol);
        laneApproach->put_Initial_demand_vol(0.0);
        ```

    === "Python"

        ```python
        initial_demand_vol = laneApproach.Initial_demand_vol
        laneApproach.Initial_demand_vol = 0.0
        ```

### Width_midblock {#width_midblock}

Lane Width (Upstream) of this Approach Lane

```csharp
float Width_midblock { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width_midblock = laneApproach.Width_midblock;
        laneApproach.Width_midblock = 0.0;
        ```

    === "C++"

        ```cpp
        double width_midblock;
        laneApproach->get_Width_midblock(&width_midblock);
        laneApproach->put_Width_midblock(0.0);
        ```

    === "Python"

        ```python
        width_midblock = laneApproach.Width_midblock
        laneApproach.Width_midblock = 0.0
        ```

### Width_slip {#width_slip}

```csharp
float Width_slip { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width_slip = laneApproach.Width_slip;
        laneApproach.Width_slip = 0.0;
        ```

    === "C++"

        ```cpp
        double width_slip;
        laneApproach->get_Width_slip(&width_slip);
        laneApproach->put_Width_slip(0.0);
        ```

    === "Python"

        ```python
        width_slip = laneApproach.Width_slip
        laneApproach.Width_slip = 0.0
        ```

## Methods

### RemoveDisciplines() {#removedisciplines}

Clear all Disciplines on this Approach Lane, i.e. all ISIAPILaneApproachMovementMC data of this Approach Lane are set to not existing (ISIAPILaneApproachMovementMC.Exists = false).

```csharp
bool RemoveDisciplines()
```

**Returns** `bool` - true if all Disciplines are removed successfully; otherwise, false.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = laneApproach.RemoveDisciplines();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        laneApproach->RemoveDisciplines(&result);
        ```

    === "Python"

        ```python
        result = laneApproach.RemoveDisciplines()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproachmovement.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproachMovement
title: LaneApproachMovement
name: ISIAPILaneApproachMovement
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1D1AD5FD-616C-441C-93B2-0792DCCDBEBF
members:
  - int Destination
  - float Free_queue
  - ISIAPILaneApproachMovementMCs LaneApproachMovementMCs
  - ISIAPILaneApproach LaneApproach
---

# LaneApproachMovement

Type `ISIAPILaneApproachMovement` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1D1AD5FD-616C-441C-93B2-0792DCCDBEBF`

## Declaration

```csharp
[Guid("1D1AD5FD-616C-441C-93B2-0792DCCDBEBF")]
public interface ISIAPILaneApproachMovement
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Destination](#destination) | `int` | Movement Destination Leg |
| [Free_queue](#free_queue) | `float` |  |
| [LaneApproachMovementMCs](#laneapproachmovementmcs) | [`ISIAPILaneApproachMovementMCs`](sidrasolutions.si.api.isiapilaneapproachmovementmcs.md) |  |
| [LaneApproach](#laneapproach) | [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) |  |

</div>

## Properties

### Destination {#destination}

Movement Destination Leg

```csharp
int Destination { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = laneApproachMovement.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        laneApproachMovement->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = laneApproachMovement.Destination
        ```

### Free_queue {#free_queue}

```csharp
float Free_queue { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float free_queue = laneApproachMovement.Free_queue;
        laneApproachMovement.Free_queue = 0.0;
        ```

    === "C++"

        ```cpp
        double free_queue;
        laneApproachMovement->get_Free_queue(&free_queue);
        laneApproachMovement->put_Free_queue(0.0);
        ```

    === "Python"

        ```python
        free_queue = laneApproachMovement.Free_queue
        laneApproachMovement.Free_queue = 0.0
        ```

### LaneApproachMovementMCs {#laneapproachmovementmcs}

```csharp
ISIAPILaneApproachMovementMCs LaneApproachMovementMCs { get; }
```

**Type** [`ISIAPILaneApproachMovementMCs`](sidrasolutions.si.api.isiapilaneapproachmovementmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproachMovementMCs = laneApproachMovement.LaneApproachMovementMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachMovementMCs> laneApproachMovementMCs;
        laneApproachMovement->get_LaneApproachMovementMCs(&laneApproachMovementMCs);
        ```

    === "Python"

        ```python
        lane_approach_movement_m_cs = laneApproachMovement.LaneApproachMovementMCs
        ```

### LaneApproach {#laneapproach}

```csharp
ISIAPILaneApproach LaneApproach { get; }
```

**Type** [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproach = laneApproachMovement.LaneApproach;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproach> laneApproach;
        laneApproachMovement->get_LaneApproach(&laneApproach);
        ```

    === "Python"

        ```python
        lane_approach = laneApproachMovement.LaneApproach
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproachmovementmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproachMovementMC
title: LaneApproachMovementMC
name: ISIAPILaneApproachMovementMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: F8915468-80E7-4CB9-8E45-F1E854E45FA0
members:
  - int MC_class
  - bool Exists
  - ISIAPILaneApproachMovement LaneApproachMovement
---

# LaneApproachMovementMC

Type `ISIAPILaneApproachMovementMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `F8915468-80E7-4CB9-8E45-F1E854E45FA0`

## Declaration

```csharp
[Guid("F8915468-80E7-4CB9-8E45-F1E854E45FA0")]
public interface ISIAPILaneApproachMovementMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [Exists](#exists) | `bool` | Flag indicating whether this Movement Class Approach Movement is running on this Approach Lane. The state of this property corresponds to the setting of the "Lane Discipline" checkbox in the SIDRA INTERSECTION "Lane Geometry" dialog - "Lane Disciplines" tab for the given Movement Class Approach Movement. |
| [LaneApproachMovement](#laneapproachmovement) | [`ISIAPILaneApproachMovement`](sidrasolutions.si.api.isiapilaneapproachmovement.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = laneApproachMovementMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        laneApproachMovementMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = laneApproachMovementMC.MC_class
        ```

### Exists {#exists}

Flag indicating whether this Movement Class Approach Movement is running on this Approach Lane. 

The state of this property corresponds to the setting of the "Lane Discipline" 
checkbox in the SIDRA INTERSECTION "Lane Geometry" dialog - "Lane Disciplines" tab for
the given Movement Class Approach Movement.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

**Remarks**

SIAPISite.ResetLaneMovements() needs to be called manually or the related SIAPILaneMovementMC.Flow_proportion need to be revised manually after Lane Discipline changes.

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = laneApproachMovementMC.Exists;
        laneApproachMovementMC.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        laneApproachMovementMC->get_Exists(&exists);
        laneApproachMovementMC->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = laneApproachMovementMC.Exists
        laneApproachMovementMC.Exists = True
        ```

### LaneApproachMovement {#laneapproachmovement}

```csharp
ISIAPILaneApproachMovement LaneApproachMovement { get; }
```

**Type** [`ISIAPILaneApproachMovement`](sidrasolutions.si.api.isiapilaneapproachmovement.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproachMovement = laneApproachMovementMC.LaneApproachMovement;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachMovement> laneApproachMovement;
        laneApproachMovementMC->get_LaneApproachMovement(&laneApproachMovement);
        ```

    === "Python"

        ```python
        lane_approach_movement = laneApproachMovementMC.LaneApproachMovement
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproachmovementmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproachMovementMCs
title: LaneApproachMovementMCs
name: ISIAPILaneApproachMovementMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 43649661-4D0E-4F64-BDCE-98C45BFD4E51
members:
  - ISIAPILaneApproachMovementMC this[int mcClass]
  - int Count
---

# LaneApproachMovementMCs

Type `ISIAPILaneApproachMovementMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `43649661-4D0E-4F64-BDCE-98C45BFD4E51`

## Declaration

```csharp
[Guid("43649661-4D0E-4F64-BDCE-98C45BFD4E51")]
public interface ISIAPILaneApproachMovementMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneApproachMovementMC`](sidrasolutions.si.api.isiapilaneapproachmovementmc.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneApproachMovementMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneApproachMovementMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneApproachMovementMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneApproachMovementMC this[] { get; }
```

**Type** [`ISIAPILaneApproachMovementMC`](sidrasolutions.si.api.isiapilaneapproachmovementmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneApproachMovementMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachMovementMC> this[];
        laneApproachMovementMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneApproachMovementMCs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproachmovements.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproachMovements
title: LaneApproachMovements
name: ISIAPILaneApproachMovements
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8DF96C87-43D0-4436-9BAB-1221FF7E1CFE
members:
  - ISIAPILaneApproachMovement this[int destination]
  - int Count
---

# LaneApproachMovements

Type `ISIAPILaneApproachMovements` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8DF96C87-43D0-4436-9BAB-1221FF7E1CFE`

## Declaration

```csharp
[Guid("8DF96C87-43D0-4436-9BAB-1221FF7E1CFE")]
public interface ISIAPILaneApproachMovements
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneApproachMovement`](sidrasolutions.si.api.isiapilaneapproachmovement.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneApproachMovements.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneApproachMovements->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneApproachMovements.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneApproachMovement this[] { get; }
```

**Type** [`ISIAPILaneApproachMovement`](sidrasolutions.si.api.isiapilaneapproachmovement.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneApproachMovements.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachMovement> this[];
        laneApproachMovements->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneApproachMovements.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneapproachs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneApproachs
title: LaneApproachs
name: ISIAPILaneApproachs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 7C5E3DE3-C295-478D-9061-88583D18826F
members:
  - bool LaneApproachExists(int laneno)
  - ISIAPILaneApproach AddLane()
  - void RemoveLane()
  - ISIAPILaneApproach this[int laneno]
  - int Count
---

# LaneApproachs

Type `ISIAPILaneApproachs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `7C5E3DE3-C295-478D-9061-88583D18826F`

## Declaration

```csharp
[Guid("7C5E3DE3-C295-478D-9061-88583D18826F")]
public interface ISIAPILaneApproachs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneApproachExists(int)](#laneapproachexists-int) | `bool` |  |
| [AddLane()](#addlane) | [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) | Add an Approach Lane If the Leg has Approach Lane(s), if driving-on-left, the rightmost Approach Lane is cloned. The cloned Lane is added to the right. If driving-on-right, the leftmost Approach Lane is cloned. The cloned Lane is added to the left. If the Leg does not have any Approach Lane, a new default Approach Lane is added. |
| [RemoveLane()](#removelane) | `void` | Remove an Approach Lane If driving-on-left, the rightmost Approach Lane is removed. If driving-on-right, the leftmost Approach Lane is removed. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneApproachs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneApproachs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneApproachs.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneApproach this[] { get; }
```

**Type** [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneApproachs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproach> this[];
        laneApproachs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneApproachs.this[]
        ```

## Methods

### LaneApproachExists(int) {#laneapproachexists-int}

```csharp
bool LaneApproachExists(int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `laneno` | `int` | Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure. |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = laneApproachs.LaneApproachExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        laneApproachs->LaneApproachExists(0, &result);
        ```

    === "Python"

        ```python
        result = laneApproachs.LaneApproachExists(0)
        ```

### AddLane() {#addlane}

Add an Approach Lane  
If the Leg has Approach Lane(s), if driving-on-left, the rightmost Approach Lane is cloned. The cloned Lane is added to the right. 
If driving-on-right, the leftmost Approach Lane is cloned. The cloned Lane is added to the left.  
If the Leg does not have any Approach Lane, a new default Approach Lane is added.

```csharp
ISIAPILaneApproach AddLane()
```

**Returns** [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) - The new added Approach Lane

**Remarks**

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. 
If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

???- example "Code samples"

    === "C#"

        ```csharp
        var result = laneApproachs.AddLane();
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproach> result;
        laneApproachs->AddLane(&result);
        ```

    === "Python"

        ```python
        result = laneApproachs.AddLane()
        ```

### RemoveLane() {#removelane}

Remove an Approach Lane 

If driving-on-left, the rightmost Approach Lane is removed. If driving-on-right, the leftmost Approach Lane is removed.

```csharp
void RemoveLane()
```

**Remarks**

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. 
If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

???- example "Code samples"

    === "C#"

        ```csharp
        laneApproachs.RemoveLane();
        ```

    === "C++"

        ```cpp
        laneApproachs->RemoveLane();
        ```

    === "Python"

        ```python
        laneApproachs.RemoveLane()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneexit.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneExit
title: LaneExit
name: ISIAPILaneExit
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 68B59D28-C877-4FDA-9110-D3CDCD5DBEFF
members:
  - int Laneno
  - int Position
  - int Configuration
  - float Length
  - float Width
  - float Grade
  - ISIAPILaneMovements LaneMovements
  - ISIAPILaneSegment Segment1
  - ISIAPILaneSegment Segment2
  - ISIAPILeg Leg
  - bool Is_merge_applied
  - int Merge_type
  - ISIAPILaneExitMergeParam PriorityMergeParam
  - ISIAPILaneExitMergeParam ZipperMergeParam
  - float Width_midblock
---

# LaneExit

Type `ISIAPILaneExit` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `68B59D28-C877-4FDA-9110-D3CDCD5DBEFF`

## Declaration

```csharp
[Guid("68B59D28-C877-4FDA-9110-D3CDCD5DBEFF")]
public interface ISIAPILaneExit
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Laneno](#laneno) | `int` | Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure. |
| [Position](#position) | `int` | Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |
| [Configuration](#configuration) | `int` | Lane Configuration |
| [Length](#length) | `float` | Lane Length |
| [Width](#width) | `float` |  |
| [Grade](#grade) | `float` |  |
| [LaneMovements](#lanemovements) | [`ISIAPILaneMovements`](sidrasolutions.si.api.isiapilanemovements.md) |  |
| [Segment1](#segment1) | [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md) | Lane Segement 1 |
| [Segment2](#segment2) | [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md) | Lane Segement 2 |
| [Leg](#leg) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) |  |
| [Is_merge_applied](#is_merge_applied) | `bool` |  |
| [Merge_type](#merge_type) | `int` | The Merge Type applied to this Exit Lane |
| [PriorityMergeParam](#prioritymergeparam) | [`ISIAPILaneExitMergeParam`](sidrasolutions.si.api.isiapilaneexitmergeparam.md) | Merge Parameters that apply when Merge_type = 1 (Priority Merge). |
| [ZipperMergeParam](#zippermergeparam) | [`ISIAPILaneExitMergeParam`](sidrasolutions.si.api.isiapilaneexitmergeparam.md) | Merge Parameters that apply when Merge_type = 2 (Zipper Merge). |
| [Width_midblock](#width_midblock) | `float` | Lane Width (Downstream) of this Exit Lane |

</div>

## Properties

### Laneno {#laneno}

Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure.

```csharp
int Laneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int laneno = laneExit.Laneno;
        ```

    === "C++"

        ```cpp
        long laneno;
        laneExit->get_Laneno(&laneno);
        ```

    === "Python"

        ```python
        laneno = laneExit.Laneno
        ```

### Position {#position}

Postion in the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = laneExit.Position;
        ```

    === "C++"

        ```cpp
        long position;
        laneExit->get_Position(&position);
        ```

    === "Python"

        ```python
        position = laneExit.Position
        ```

### Configuration {#configuration}

Lane Configuration

```csharp
int Configuration { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Full-Length Lane
- `2` - Short Lane
- `3` - Short Lane with Parking
- `4` - Two-Segment Lane

???- example "Code samples"

    === "C#"

        ```csharp
        int configuration = laneExit.Configuration;
        laneExit.Configuration = 0;
        ```

    === "C++"

        ```cpp
        long configuration;
        laneExit->get_Configuration(&configuration);
        laneExit->put_Configuration(0);
        ```

    === "Python"

        ```python
        configuration = laneExit.Configuration
        laneExit.Configuration = 0
        ```

### Length {#length}

Lane Length

```csharp
float Length { get; set; }
```

**Type** `float`

**Remarks**

For Full-Length Lane or Two-Segment Lane, this is the Full Lane Length; for Short Lane or Short Lane with Parking, this is synchronized with the Segment 1 Length

???- example "Code samples"

    === "C#"

        ```csharp
        float length = laneExit.Length;
        laneExit.Length = 0.0;
        ```

    === "C++"

        ```cpp
        double length;
        laneExit->get_Length(&length);
        laneExit->put_Length(0.0);
        ```

    === "Python"

        ```python
        length = laneExit.Length
        laneExit.Length = 0.0
        ```

### Width {#width}

```csharp
float Width { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width = laneExit.Width;
        laneExit.Width = 0.0;
        ```

    === "C++"

        ```cpp
        double width;
        laneExit->get_Width(&width);
        laneExit->put_Width(0.0);
        ```

    === "Python"

        ```python
        width = laneExit.Width
        laneExit.Width = 0.0
        ```

### Grade {#grade}

```csharp
float Grade { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float grade = laneExit.Grade;
        laneExit.Grade = 0.0;
        ```

    === "C++"

        ```cpp
        double grade;
        laneExit->get_Grade(&grade);
        laneExit->put_Grade(0.0);
        ```

    === "Python"

        ```python
        grade = laneExit.Grade
        laneExit.Grade = 0.0
        ```

### LaneMovements {#lanemovements}

```csharp
ISIAPILaneMovements LaneMovements { get; }
```

**Type** [`ISIAPILaneMovements`](sidrasolutions.si.api.isiapilanemovements.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneMovements = laneExit.LaneMovements;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovements> laneMovements;
        laneExit->get_LaneMovements(&laneMovements);
        ```

    === "Python"

        ```python
        lane_movements = laneExit.LaneMovements
        ```

### Segment1 {#segment1}

Lane Segement 1

```csharp
ISIAPILaneSegment Segment1 { get; }
```

**Type** [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var segment1 = laneExit.Segment1;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegment> segment1;
        laneExit->get_Segment1(&segment1);
        ```

    === "Python"

        ```python
        segment1 = laneExit.Segment1
        ```

### Segment2 {#segment2}

Lane Segement 2

```csharp
ISIAPILaneSegment Segment2 { get; }
```

**Type** [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var segment2 = laneExit.Segment2;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegment> segment2;
        laneExit->get_Segment2(&segment2);
        ```

    === "Python"

        ```python
        segment2 = laneExit.Segment2
        ```

### Leg {#leg}

```csharp
ISIAPILeg Leg { get; }
```

**Type** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg = laneExit.Leg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> leg;
        laneExit->get_Leg(&leg);
        ```

    === "Python"

        ```python
        leg = laneExit.Leg
        ```

### Is_merge_applied {#is_merge_applied}

```csharp
bool Is_merge_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_merge_applied = laneExit.Is_merge_applied;
        laneExit.Is_merge_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_merge_applied;
        laneExit->get_Is_merge_applied(&is_merge_applied);
        laneExit->put_Is_merge_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_merge_applied = laneExit.Is_merge_applied
        laneExit.Is_merge_applied = True
        ```

### Merge_type {#merge_type}

The Merge Type applied to this Exit Lane

```csharp
int Merge_type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Priority Merge
- `2` - Zipper Merge

???- example "Code samples"

    === "C#"

        ```csharp
        int merge_type = laneExit.Merge_type;
        laneExit.Merge_type = 0;
        ```

    === "C++"

        ```cpp
        long merge_type;
        laneExit->get_Merge_type(&merge_type);
        laneExit->put_Merge_type(0);
        ```

    === "Python"

        ```python
        merge_type = laneExit.Merge_type
        laneExit.Merge_type = 0
        ```

### PriorityMergeParam {#prioritymergeparam}

Merge Parameters that apply when Merge_type = 1 (Priority Merge).

```csharp
ISIAPILaneExitMergeParam PriorityMergeParam { get; }
```

**Type** [`ISIAPILaneExitMergeParam`](sidrasolutions.si.api.isiapilaneexitmergeparam.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var priorityMergeParam = laneExit.PriorityMergeParam;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExitMergeParam> priorityMergeParam;
        laneExit->get_PriorityMergeParam(&priorityMergeParam);
        ```

    === "Python"

        ```python
        priority_merge_param = laneExit.PriorityMergeParam
        ```

### ZipperMergeParam {#zippermergeparam}

Merge Parameters that apply when Merge_type = 2 (Zipper Merge).

```csharp
ISIAPILaneExitMergeParam ZipperMergeParam { get; }
```

**Type** [`ISIAPILaneExitMergeParam`](sidrasolutions.si.api.isiapilaneexitmergeparam.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var zipperMergeParam = laneExit.ZipperMergeParam;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExitMergeParam> zipperMergeParam;
        laneExit->get_ZipperMergeParam(&zipperMergeParam);
        ```

    === "Python"

        ```python
        zipper_merge_param = laneExit.ZipperMergeParam
        ```

### Width_midblock {#width_midblock}

Lane Width (Downstream) of this Exit Lane

```csharp
float Width_midblock { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float width_midblock = laneExit.Width_midblock;
        laneExit.Width_midblock = 0.0;
        ```

    === "C++"

        ```cpp
        double width_midblock;
        laneExit->get_Width_midblock(&width_midblock);
        laneExit->put_Width_midblock(0.0);
        ```

    === "Python"

        ```python
        width_midblock = laneExit.Width_midblock
        laneExit.Width_midblock = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneexitmergeparam.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneExitMergeParam
title: LaneExitMergeParam
name: ISIAPILaneExitMergeParam
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 111AD706-08F4-4711-892B-DBD25FAD5073
members:
  - float Percent_opposing_shortlane
  - float Percent_opposing_mergelane
  - float Critical_gap
  - float Followup_headway
  - float Minimum_departures
  - ISIAPILaneExit LaneExit
---

# LaneExitMergeParam

Type `ISIAPILaneExitMergeParam` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `111AD706-08F4-4711-892B-DBD25FAD5073`

## Declaration

```csharp
[Guid("111AD706-08F4-4711-892B-DBD25FAD5073")]
public interface ISIAPILaneExitMergeParam
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Percent_opposing_shortlane](#percent_opposing_shortlane) | `float` |  |
| [Percent_opposing_mergelane](#percent_opposing_mergelane) | `float` |  |
| [Critical_gap](#critical_gap) | `float` |  |
| [Followup_headway](#followup_headway) | `float` |  |
| [Minimum_departures](#minimum_departures) | `float` |  |
| [LaneExit](#laneexit) | [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) |  |

</div>

## Properties

### Percent_opposing_shortlane {#percent_opposing_shortlane}

```csharp
float Percent_opposing_shortlane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_opposing_shortlane = laneExitMergeParam.Percent_opposing_shortlane;
        laneExitMergeParam.Percent_opposing_shortlane = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_opposing_shortlane;
        laneExitMergeParam->get_Percent_opposing_shortlane(&percent_opposing_shortlane);
        laneExitMergeParam->put_Percent_opposing_shortlane(0.0);
        ```

    === "Python"

        ```python
        percent_opposing_shortlane = laneExitMergeParam.Percent_opposing_shortlane
        laneExitMergeParam.Percent_opposing_shortlane = 0.0
        ```

### Percent_opposing_mergelane {#percent_opposing_mergelane}

```csharp
float Percent_opposing_mergelane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_opposing_mergelane = laneExitMergeParam.Percent_opposing_mergelane;
        laneExitMergeParam.Percent_opposing_mergelane = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_opposing_mergelane;
        laneExitMergeParam->get_Percent_opposing_mergelane(&percent_opposing_mergelane);
        laneExitMergeParam->put_Percent_opposing_mergelane(0.0);
        ```

    === "Python"

        ```python
        percent_opposing_mergelane = laneExitMergeParam.Percent_opposing_mergelane
        laneExitMergeParam.Percent_opposing_mergelane = 0.0
        ```

### Critical_gap {#critical_gap}

```csharp
float Critical_gap { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap = laneExitMergeParam.Critical_gap;
        laneExitMergeParam.Critical_gap = 0.0;
        ```

    === "C++"

        ```cpp
        double critical_gap;
        laneExitMergeParam->get_Critical_gap(&critical_gap);
        laneExitMergeParam->put_Critical_gap(0.0);
        ```

    === "Python"

        ```python
        critical_gap = laneExitMergeParam.Critical_gap
        laneExitMergeParam.Critical_gap = 0.0
        ```

### Followup_headway {#followup_headway}

```csharp
float Followup_headway { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway = laneExitMergeParam.Followup_headway;
        laneExitMergeParam.Followup_headway = 0.0;
        ```

    === "C++"

        ```cpp
        double followup_headway;
        laneExitMergeParam->get_Followup_headway(&followup_headway);
        laneExitMergeParam->put_Followup_headway(0.0);
        ```

    === "Python"

        ```python
        followup_headway = laneExitMergeParam.Followup_headway
        laneExitMergeParam.Followup_headway = 0.0
        ```

### Minimum_departures {#minimum_departures}

```csharp
float Minimum_departures { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_departures = laneExitMergeParam.Minimum_departures;
        laneExitMergeParam.Minimum_departures = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_departures;
        laneExitMergeParam->get_Minimum_departures(&minimum_departures);
        laneExitMergeParam->put_Minimum_departures(0.0);
        ```

    === "Python"

        ```python
        minimum_departures = laneExitMergeParam.Minimum_departures
        laneExitMergeParam.Minimum_departures = 0.0
        ```

### LaneExit {#laneexit}

```csharp
ISIAPILaneExit LaneExit { get; }
```

**Type** [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneExit = laneExitMergeParam.LaneExit;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExit> laneExit;
        laneExitMergeParam->get_LaneExit(&laneExit);
        ```

    === "Python"

        ```python
        lane_exit = laneExitMergeParam.LaneExit
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilaneexits.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneExits
title: LaneExits
name: ISIAPILaneExits
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 84511E1A-C253-4CE4-B173-52633F23A593
members:
  - bool LaneExitExists(int laneno)
  - ISIAPILaneExit AddLane()
  - void RemoveLane()
  - ISIAPILaneExit this[int laneno]
  - int Count
---

# LaneExits

Type `ISIAPILaneExits` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `84511E1A-C253-4CE4-B173-52633F23A593`

## Declaration

```csharp
[Guid("84511E1A-C253-4CE4-B173-52633F23A593")]
public interface ISIAPILaneExits
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneExitExists(int)](#laneexitexists-int) | `bool` |  |
| [AddLane()](#addlane) | [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) | Add an Exit Lane If the Leg has Exit Lane(s), if driving-on-left, the rightmost (looking in the direction of departure) Exit Lane is cloned. The cloned Lane is added to the right. If driving-on-right, the leftmost Exit Lane is cloned. The cloned Lane is added to the left. If the Leg does not have any Exit Lane, a new default Exit Lane is added. |
| [RemoveLane()](#removelane) | `void` | Remove an Exit Lane If driving-on-left, the rightmost (looking in the direction of departure) Exit Lane is removed. If driving-on-right, the leftmost Exit Lane is removed. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneExits.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneExits->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneExits.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneExit this[] { get; }
```

**Type** [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneExits.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExit> this[];
        laneExits->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneExits.this[]
        ```

## Methods

### LaneExitExists(int) {#laneexitexists-int}

```csharp
bool LaneExitExists(int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `laneno` | `int` | Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure. |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = laneExits.LaneExitExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        laneExits->LaneExitExists(0, &result);
        ```

    === "Python"

        ```python
        result = laneExits.LaneExitExists(0)
        ```

### AddLane() {#addlane}

Add an Exit Lane  
If the Leg has Exit Lane(s), if driving-on-left, the rightmost (looking in the direction of departure) Exit Lane is cloned. The cloned Lane is added to the right. 
If driving-on-right, the leftmost Exit Lane is cloned. The cloned Lane is added to the left.  
If the Leg does not have any Exit Lane, a new default Exit Lane is added.

```csharp
ISIAPILaneExit AddLane()
```

**Returns** [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) - The new added Exit Lane

**Remarks**

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. 
If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

???- example "Code samples"

    === "C#"

        ```csharp
        var result = laneExits.AddLane();
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExit> result;
        laneExits->AddLane(&result);
        ```

    === "Python"

        ```python
        result = laneExits.AddLane()
        ```

### RemoveLane() {#removelane}

Remove an Exit Lane 

If driving-on-left, the rightmost (looking in the direction of departure) Exit Lane is removed. If driving-on-right, the leftmost Exit Lane is removed.

```csharp
void RemoveLane()
```

**Remarks**

Call SIAPISite.ResetLaneMovements() manually after adding / removing Lanes. 
If Leg(s) has been added or removed, call SIAPISite.UpdateGeometryData() instead of ResetLaneMovements().

???- example "Code samples"

    === "C#"

        ```csharp
        laneExits.RemoveLane();
        ```

    === "C++"

        ```cpp
        laneExits->RemoveLane();
        ```

    === "Python"

        ```python
        laneExits.RemoveLane()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanemovement.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneMovement
title: LaneMovement
name: ISIAPILaneMovement
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8E0CDB51-CDFA-4ACB-8D95-72DD0FA3ACB3
members:
  - int Origin
  - int OriginLaneno
  - int Destination
  - int DestinationLaneno
  - float Lane_blockage_calib_factor
  - ISIAPILaneMovementMCs LaneMovementMCs
---

# LaneMovement

Type `ISIAPILaneMovement` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8E0CDB51-CDFA-4ACB-8D95-72DD0FA3ACB3`

## Declaration

```csharp
[Guid("8E0CDB51-CDFA-4ACB-8D95-72DD0FA3ACB3")]
public interface ISIAPILaneMovement
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` |  |
| [OriginLaneno](#originlaneno) | `int` |  |
| [Destination](#destination) | `int` |  |
| [DestinationLaneno](#destinationlaneno) | `int` |  |
| [Lane_blockage_calib_factor](#lane_blockage_calib_factor) | `float` |  |
| [LaneMovementMCs](#lanemovementmcs) | [`ISIAPILaneMovementMCs`](sidrasolutions.si.api.isiapilanemovementmcs.md) |  |

</div>

## Properties

### Origin {#origin}

```csharp
int Origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = laneMovement.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        laneMovement->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = laneMovement.Origin
        ```

### OriginLaneno {#originlaneno}

```csharp
int OriginLaneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int originLaneno = laneMovement.OriginLaneno;
        ```

    === "C++"

        ```cpp
        long originLaneno;
        laneMovement->get_OriginLaneno(&originLaneno);
        ```

    === "Python"

        ```python
        origin_laneno = laneMovement.OriginLaneno
        ```

### Destination {#destination}

```csharp
int Destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = laneMovement.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        laneMovement->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = laneMovement.Destination
        ```

### DestinationLaneno {#destinationlaneno}

```csharp
int DestinationLaneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destinationLaneno = laneMovement.DestinationLaneno;
        ```

    === "C++"

        ```cpp
        long destinationLaneno;
        laneMovement->get_DestinationLaneno(&destinationLaneno);
        ```

    === "Python"

        ```python
        destination_laneno = laneMovement.DestinationLaneno
        ```

### Lane_blockage_calib_factor {#lane_blockage_calib_factor}

```csharp
float Lane_blockage_calib_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_blockage_calib_factor = laneMovement.Lane_blockage_calib_factor;
        laneMovement.Lane_blockage_calib_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double lane_blockage_calib_factor;
        laneMovement->get_Lane_blockage_calib_factor(&lane_blockage_calib_factor);
        laneMovement->put_Lane_blockage_calib_factor(0.0);
        ```

    === "Python"

        ```python
        lane_blockage_calib_factor = laneMovement.Lane_blockage_calib_factor
        laneMovement.Lane_blockage_calib_factor = 0.0
        ```

### LaneMovementMCs {#lanemovementmcs}

```csharp
ISIAPILaneMovementMCs LaneMovementMCs { get; }
```

**Type** [`ISIAPILaneMovementMCs`](sidrasolutions.si.api.isiapilanemovementmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneMovementMCs = laneMovement.LaneMovementMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovementMCs> laneMovementMCs;
        laneMovement->get_LaneMovementMCs(&laneMovementMCs);
        ```

    === "Python"

        ```python
        lane_movement_m_cs = laneMovement.LaneMovementMCs
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanemovementmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneMovementMC
title: LaneMovementMC
name: ISIAPILaneMovementMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FEF9F3D4-CD1C-4F5A-A01D-3EF6DCCB60C1
members:
  - int MC_class
  - float Flow_proportion
  - ISIAPILaneMovement LaneMovement
---

# LaneMovementMC

Type `ISIAPILaneMovementMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FEF9F3D4-CD1C-4F5A-A01D-3EF6DCCB60C1`

## Declaration

```csharp
[Guid("FEF9F3D4-CD1C-4F5A-A01D-3EF6DCCB60C1")]
public interface ISIAPILaneMovementMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [Flow_proportion](#flow_proportion) | `float` |  |
| [LaneMovement](#lanemovement) | [`ISIAPILaneMovement`](sidrasolutions.si.api.isiapilanemovement.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = laneMovementMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        laneMovementMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = laneMovementMC.MC_class
        ```

### Flow_proportion {#flow_proportion}

```csharp
float Flow_proportion { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_proportion = laneMovementMC.Flow_proportion;
        laneMovementMC.Flow_proportion = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_proportion;
        laneMovementMC->get_Flow_proportion(&flow_proportion);
        laneMovementMC->put_Flow_proportion(0.0);
        ```

    === "Python"

        ```python
        flow_proportion = laneMovementMC.Flow_proportion
        laneMovementMC.Flow_proportion = 0.0
        ```

### LaneMovement {#lanemovement}

```csharp
ISIAPILaneMovement LaneMovement { get; }
```

**Type** [`ISIAPILaneMovement`](sidrasolutions.si.api.isiapilanemovement.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneMovement = laneMovementMC.LaneMovement;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovement> laneMovement;
        laneMovementMC->get_LaneMovement(&laneMovement);
        ```

    === "Python"

        ```python
        lane_movement = laneMovementMC.LaneMovement
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanemovementmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneMovementMCs
title: LaneMovementMCs
name: ISIAPILaneMovementMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 6645C118-C95E-4E91-BEEB-720B4A3F78AF
members:
  - ISIAPILaneMovementMC this[int mcClass]
  - int Count
---

# LaneMovementMCs

Type `ISIAPILaneMovementMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `6645C118-C95E-4E91-BEEB-720B4A3F78AF`

## Declaration

```csharp
[Guid("6645C118-C95E-4E91-BEEB-720B4A3F78AF")]
public interface ISIAPILaneMovementMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneMovementMC`](sidrasolutions.si.api.isiapilanemovementmc.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneMovementMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneMovementMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneMovementMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneMovementMC this[] { get; }
```

**Type** [`ISIAPILaneMovementMC`](sidrasolutions.si.api.isiapilanemovementmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneMovementMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovementMC> this[];
        laneMovementMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneMovementMCs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanemovements.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneMovements
title: LaneMovements
name: ISIAPILaneMovements
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1C23F111-F832-4E95-8B43-70D3492F8DDF
members:
  - bool LaneMovementExists(int leg, int laneno)
  - ISIAPILaneMovement this[int leg, int laneno]
  - int Count
---

# LaneMovements

Type `ISIAPILaneMovements` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1C23F111-F832-4E95-8B43-70D3492F8DDF`

## Declaration

```csharp
[Guid("1C23F111-F832-4E95-8B43-70D3492F8DDF")]
public interface ISIAPILaneMovements
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneMovement`](sidrasolutions.si.api.isiapilanemovement.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneMovementExists(int, int)](#lanemovementexists-int--int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneMovements.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneMovements->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneMovements.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneMovement this[] { get; }
```

**Type** [`ISIAPILaneMovement`](sidrasolutions.si.api.isiapilanemovement.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneMovements.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneMovement> this[];
        laneMovements->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneMovements.this[]
        ```

## Methods

### LaneMovementExists(int, int) {#lanemovementexists-int--int}

```csharp
bool LaneMovementExists(int leg, int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `leg` | `int` |  |
| `laneno` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = laneMovements.LaneMovementExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        laneMovements->LaneMovementExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = laneMovements.LaneMovementExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanesegment.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneSegment
title: LaneSegment
name: ISIAPILaneSegment
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 46D3CDE9-1A72-4B36-BA8E-42AC1299389F
members:
  - int Segment_no
  - int Type
  - float Length
  - int Colour
  - string Display_id
  - int Overflow_merge_lane_num_1
  - ISIAPILaneSegmentMCs LaneSegmentMCs
  - ISIAPILaneApproach LaneApproach
  - ISIAPILaneExit LaneExit
---

# LaneSegment

Type `ISIAPILaneSegment` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `46D3CDE9-1A72-4B36-BA8E-42AC1299389F`

## Declaration

```csharp
[Guid("46D3CDE9-1A72-4B36-BA8E-42AC1299389F")]
public interface ISIAPILaneSegment
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Segment_no](#segment_no) | `int` |  |
| [Type](#type) | `int` | Lane Segment Type |
| [Length](#length) | `float` |  |
| [Colour](#colour) | `int` |  |
| [Display_id](#display_id) | `string` |  |
| [Overflow_merge_lane_num_1](#overflow_merge_lane_num_1) | `int` |  |
| [LaneSegmentMCs](#lanesegmentmcs) | [`ISIAPILaneSegmentMCs`](sidrasolutions.si.api.isiapilanesegmentmcs.md) |  |
| [LaneApproach](#laneapproach) | [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) |  |
| [LaneExit](#laneexit) | [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) |  |

</div>

## Properties

### Segment_no {#segment_no}

```csharp
int Segment_no { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int segment_no = laneSegment.Segment_no;
        ```

    === "C++"

        ```cpp
        long segment_no;
        laneSegment->get_Segment_no(&segment_no);
        ```

    === "Python"

        ```python
        segment_no = laneSegment.Segment_no
        ```

### Type {#type}

Lane Segment Type

```csharp
int Type { get; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Short Lane
- `2` - Parking

???- example "Code samples"

    === "C#"

        ```csharp
        int type = laneSegment.Type;
        ```

    === "C++"

        ```cpp
        long type;
        laneSegment->get_Type(&type);
        ```

    === "Python"

        ```python
        type = laneSegment.Type
        ```

### Length {#length}

```csharp
float Length { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float length = laneSegment.Length;
        laneSegment.Length = 0.0;
        ```

    === "C++"

        ```cpp
        double length;
        laneSegment->get_Length(&length);
        laneSegment->put_Length(0.0);
        ```

    === "Python"

        ```python
        length = laneSegment.Length
        laneSegment.Length = 0.0
        ```

### Colour {#colour}

```csharp
int Colour { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int colour = laneSegment.Colour;
        laneSegment.Colour = 0;
        ```

    === "C++"

        ```cpp
        long colour;
        laneSegment->get_Colour(&colour);
        laneSegment->put_Colour(0);
        ```

    === "Python"

        ```python
        colour = laneSegment.Colour
        laneSegment.Colour = 0
        ```

### Display_id {#display_id}

```csharp
string Display_id { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string display_id = laneSegment.Display_id;
        laneSegment.Display_id = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR display_id;
        laneSegment->get_Display_id(&display_id);
        laneSegment->put_Display_id(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        display_id = laneSegment.Display_id
        laneSegment.Display_id = r"id-1"
        ```

### Overflow_merge_lane_num_1 {#overflow_merge_lane_num_1}

```csharp
int Overflow_merge_lane_num_1 { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int overflow_merge_lane_num_1 = laneSegment.Overflow_merge_lane_num_1;
        laneSegment.Overflow_merge_lane_num_1 = 1;
        ```

    === "C++"

        ```cpp
        long overflow_merge_lane_num_1;
        laneSegment->get_Overflow_merge_lane_num_1(&overflow_merge_lane_num_1);
        laneSegment->put_Overflow_merge_lane_num_1(1);
        ```

    === "Python"

        ```python
        overflow_merge_lane_num_1 = laneSegment.Overflow_merge_lane_num_1
        laneSegment.Overflow_merge_lane_num_1 = 1
        ```

### LaneSegmentMCs {#lanesegmentmcs}

```csharp
ISIAPILaneSegmentMCs LaneSegmentMCs { get; }
```

**Type** [`ISIAPILaneSegmentMCs`](sidrasolutions.si.api.isiapilanesegmentmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneSegmentMCs = laneSegment.LaneSegmentMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegmentMCs> laneSegmentMCs;
        laneSegment->get_LaneSegmentMCs(&laneSegmentMCs);
        ```

    === "Python"

        ```python
        lane_segment_m_cs = laneSegment.LaneSegmentMCs
        ```

### LaneApproach {#laneapproach}

```csharp
ISIAPILaneApproach LaneApproach { get; }
```

**Type** [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproach = laneSegment.LaneApproach;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproach> laneApproach;
        laneSegment->get_LaneApproach(&laneApproach);
        ```

    === "Python"

        ```python
        lane_approach = laneSegment.LaneApproach
        ```

### LaneExit {#laneexit}

```csharp
ISIAPILaneExit LaneExit { get; }
```

**Type** [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneExit = laneSegment.LaneExit;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExit> laneExit;
        laneSegment->get_LaneExit(&laneExit);
        ```

    === "Python"

        ```python
        lane_exit = laneSegment.LaneExit
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanesegmentmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneSegmentMC
title: LaneSegmentMC
name: ISIAPILaneSegmentMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: DC8841C8-B63F-4FB9-B26B-F8C032743C3E
members:
  - int MC_class
  - bool Exists
  - float Percent_change_to_left
  - float Percent_change_to_right
  - ISIAPILaneSegment LaneSegment
---

# LaneSegmentMC

Type `ISIAPILaneSegmentMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `DC8841C8-B63F-4FB9-B26B-F8C032743C3E`

## Declaration

```csharp
[Guid("DC8841C8-B63F-4FB9-B26B-F8C032743C3E")]
public interface ISIAPILaneSegmentMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [Exists](#exists) | `bool` | Flag indicating whether the Movement Class is running on this Lane Segment. This only applies to Approach Lane Segment 2. This value in Approach Lane Segment 1, Exit Lane Segment 1 or 2 is ignored. |
| [Percent_change_to_left](#percent_change_to_left) | `float` | Percent Lane Change to the Left (looking in the direction of departure), only applies to the Exit Lane Segment 1. |
| [Percent_change_to_right](#percent_change_to_right) | `float` | Percent Lane Change to the Right (looking in the direction of departure), only applies to the Exit Lane Segment 1. |
| [LaneSegment](#lanesegment) | [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = laneSegmentMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        laneSegmentMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = laneSegmentMC.MC_class
        ```

### Exists {#exists}

Flag indicating whether the Movement Class is running on this Lane Segment. This only applies to Approach Lane Segment 2. This value in Approach Lane Segment 1, Exit Lane Segment 1 or 2 is ignored.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = laneSegmentMC.Exists;
        laneSegmentMC.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        laneSegmentMC->get_Exists(&exists);
        laneSegmentMC->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = laneSegmentMC.Exists
        laneSegmentMC.Exists = True
        ```

### Percent_change_to_left {#percent_change_to_left}

Percent Lane Change to the Left (looking in the direction of departure), only applies to the Exit Lane Segment 1.

```csharp
float Percent_change_to_left { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_change_to_left = laneSegmentMC.Percent_change_to_left;
        laneSegmentMC.Percent_change_to_left = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_change_to_left;
        laneSegmentMC->get_Percent_change_to_left(&percent_change_to_left);
        laneSegmentMC->put_Percent_change_to_left(0.0);
        ```

    === "Python"

        ```python
        percent_change_to_left = laneSegmentMC.Percent_change_to_left
        laneSegmentMC.Percent_change_to_left = 0.0
        ```

### Percent_change_to_right {#percent_change_to_right}

Percent Lane Change to the Right (looking in the direction of departure), only applies to the Exit Lane Segment 1.

```csharp
float Percent_change_to_right { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_change_to_right = laneSegmentMC.Percent_change_to_right;
        laneSegmentMC.Percent_change_to_right = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_change_to_right;
        laneSegmentMC->get_Percent_change_to_right(&percent_change_to_right);
        laneSegmentMC->put_Percent_change_to_right(0.0);
        ```

    === "Python"

        ```python
        percent_change_to_right = laneSegmentMC.Percent_change_to_right
        laneSegmentMC.Percent_change_to_right = 0.0
        ```

### LaneSegment {#lanesegment}

```csharp
ISIAPILaneSegment LaneSegment { get; }
```

**Type** [`ISIAPILaneSegment`](sidrasolutions.si.api.isiapilanesegment.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneSegment = laneSegmentMC.LaneSegment;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegment> laneSegment;
        laneSegmentMC->get_LaneSegment(&laneSegment);
        ```

    === "Python"

        ```python
        lane_segment = laneSegmentMC.LaneSegment
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilanesegmentmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILaneSegmentMCs
title: LaneSegmentMCs
name: ISIAPILaneSegmentMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: AB521E7C-9CD1-43E3-8EE9-93B61DD64661
members:
  - ISIAPILaneSegmentMC this[int mcClass]
  - int Count
---

# LaneSegmentMCs

Type `ISIAPILaneSegmentMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `AB521E7C-9CD1-43E3-8EE9-93B61DD64661`

## Declaration

```csharp
[Guid("AB521E7C-9CD1-43E3-8EE9-93B61DD64661")]
public interface ISIAPILaneSegmentMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILaneSegmentMC`](sidrasolutions.si.api.isiapilanesegmentmc.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = laneSegmentMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        laneSegmentMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = laneSegmentMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPILaneSegmentMC this[] { get; }
```

**Type** [`ISIAPILaneSegmentMC`](sidrasolutions.si.api.isiapilanesegmentmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = laneSegmentMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneSegmentMC> this[];
        laneSegmentMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = laneSegmentMCs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapileg.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILeg
title: Leg
name: ISIAPILeg
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 98300C8A-D0D4-4078-BB07-9CA446AA4D14
members:
  - ISIAPILaneApproach InsertApproachLane(int positionOnLeg)
  - ISIAPILaneExit InsertExitLane(int positionOnLeg)
  - ISIAPIIsland InsertIsland(int positionOnLeg)
  - ISIAPIIsland InsertIsland_RoundaboutSplitter(int positionOnLeg)
  - bool RemoveItem(int positionOnLeg)
  - int Orientation
  - string Name
  - float Approach_distance
  - bool Exit_distance_user
  - float Exit_distance
  - bool Extra_bunching_user
  - float Extra_bunching
  - float Area_type_factor
  - int Approach_control
  - bool Is_departure_headway_awsc_applied
  - int LegGeometry
  - string LastErrorMessage
  - ISIAPISite Site
  - ISIAPILeg_roundabout Leg_roundabout
  - ISIAPILaneApproachs LaneApproachs
  - ISIAPILaneExits LaneExits
  - ISIAPIIslands Islands
  - ISIAPIMovement_ped MovementPedSlipLane_Existing
  - bool Is_uturn_before_intersection
  - bool Is_uturn_before_intersection_excluded_from_signal_analysis
  - bool Extra_bunching_nw_user
  - float Extra_bunching_nw
  - ISIAPIMapCoordinate Approach_start_point
  - bool Exit_start_point_user
  - ISIAPIMapCoordinate Exit_start_point
  - ISIAPIMapCoordinate Approach_end_point
  - bool Exit_end_point_user
  - ISIAPIMapCoordinate Exit_end_point
  - int PedMainCrossingVolumeOption
  - float PedMainCrossingVolume
  - float PedMainCrossingPeakFlowFactor
  - float PedMainCrossingFlowScale
  - float PedMainCrossingGrowthRate
---

# Leg

Type `ISIAPILeg` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `98300C8A-D0D4-4078-BB07-9CA446AA4D14`

## Declaration

```csharp
[Guid("98300C8A-D0D4-4078-BB07-9CA446AA4D14")]
public interface ISIAPILeg
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` | Leg Orientation |
| [Name](#name) | `string` |  |
| [Approach_distance](#approach_distance) | `float` |  |
| [Exit_distance_user](#exit_distance_user) | `bool` |  |
| [Exit_distance](#exit_distance) | `float` |  |
| [Extra_bunching_user](#extra_bunching_user) | `bool` |  |
| [Extra_bunching](#extra_bunching) | `float` |  |
| [Area_type_factor](#area_type_factor) | `float` | Area Type Factor, for Legs in Signalised Site only |
| [Approach_control](#approach_control) | `int` | Approach Control Type, for Legs in Sign Controlled Site only |
| [Is_departure_headway_awsc_applied](#is_departure_headway_awsc_applied) | `bool` |  |
| [LegGeometry](#leggeometry) | `int` | Leg Geometry |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Leg_roundabout](#leg_roundabout) | [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md) |  |
| [LaneApproachs](#laneapproachs) | [`ISIAPILaneApproachs`](sidrasolutions.si.api.isiapilaneapproachs.md) |  |
| [LaneExits](#laneexits) | [`ISIAPILaneExits`](sidrasolutions.si.api.isiapilaneexits.md) |  |
| [Islands](#islands) | [`ISIAPIIslands`](sidrasolutions.si.api.isiapiislands.md) |  |
| [MovementPedSlipLane_Existing](#movementpedsliplane_existing) | [`ISIAPIMovement_ped`](sidrasolutions.si.api.isiapimovement_ped.md) |  |
| [Is_uturn_before_intersection](#is_uturn_before_intersection) | `bool` |  |
| [Is_uturn_before_intersection_excluded_from_signal_analysis](#is_uturn_before_intersection_excluded_from_signal_analysis) | `bool` |  |
| [Extra_bunching_nw_user](#extra_bunching_nw_user) | `bool` |  |
| [Extra_bunching_nw](#extra_bunching_nw) | `float` |  |
| [Approach_start_point](#approach_start_point) | [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md) |  |
| [Exit_start_point_user](#exit_start_point_user) | `bool` |  |
| [Exit_start_point](#exit_start_point) | [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md) |  |
| [Approach_end_point](#approach_end_point) | [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md) |  |
| [Exit_end_point_user](#exit_end_point_user) | `bool` |  |
| [Exit_end_point](#exit_end_point) | [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md) |  |
| [PedMainCrossingVolumeOption](#pedmaincrossingvolumeoption) | `int` | Pedestrian Volume Data Option for Main Crossing (Full and Staged) |
| [PedMainCrossingVolume](#pedmaincrossingvolume) | `float` |  |
| [PedMainCrossingPeakFlowFactor](#pedmaincrossingpeakflowfactor) | `float` |  |
| [PedMainCrossingFlowScale](#pedmaincrossingflowscale) | `float` |  |
| [PedMainCrossingGrowthRate](#pedmaincrossinggrowthrate) | `float` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [InsertApproachLane(int)](#insertapproachlane-int) | [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) | Insert an new Approach Lane to the Leg at the specified position. The Approach Lane is created automatically. |
| [InsertExitLane(int)](#insertexitlane-int) | [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) | Insert an new Exit Lane to the Leg at the specified position. The Exit Lane is created automatically. |
| [InsertIsland(int)](#insertisland-int) | [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) | Insert an new Island to the Leg at the specified position. The Island is created automatically. |
| [InsertIsland_RoundaboutSplitter(int)](#insertisland_roundaboutsplitter-int) | [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) | Insert an new Roundabout Splitter Island to the Leg at the specified position. The Island is created automatically. |
| [RemoveItem(int)](#removeitem-int) | `bool` | Remove the item at the specified position on the Leg. The item could be an Approach Lane, Exit Lane or Island. |

</div>

## Properties

### Orientation {#orientation}

Leg Orientation

```csharp
int Orientation { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = leg.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        leg->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = leg.Orientation
        ```

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = leg.Name;
        leg.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        leg->get_Name(&name);
        leg->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = leg.Name
        leg.Name = r"Example"
        ```

### Approach_distance {#approach_distance}

```csharp
float Approach_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float approach_distance = leg.Approach_distance;
        leg.Approach_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double approach_distance;
        leg->get_Approach_distance(&approach_distance);
        leg->put_Approach_distance(0.0);
        ```

    === "Python"

        ```python
        approach_distance = leg.Approach_distance
        leg.Approach_distance = 0.0
        ```

### Exit_distance_user {#exit_distance_user}

```csharp
bool Exit_distance_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exit_distance_user = leg.Exit_distance_user;
        leg.Exit_distance_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exit_distance_user;
        leg->get_Exit_distance_user(&exit_distance_user);
        leg->put_Exit_distance_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exit_distance_user = leg.Exit_distance_user
        leg.Exit_distance_user = True
        ```

### Exit_distance {#exit_distance}

```csharp
float Exit_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_distance = leg.Exit_distance;
        leg.Exit_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_distance;
        leg->get_Exit_distance(&exit_distance);
        leg->put_Exit_distance(0.0);
        ```

    === "Python"

        ```python
        exit_distance = leg.Exit_distance
        leg.Exit_distance = 0.0
        ```

### Extra_bunching_user {#extra_bunching_user}

```csharp
bool Extra_bunching_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool extra_bunching_user = leg.Extra_bunching_user;
        leg.Extra_bunching_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL extra_bunching_user;
        leg->get_Extra_bunching_user(&extra_bunching_user);
        leg->put_Extra_bunching_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        extra_bunching_user = leg.Extra_bunching_user
        leg.Extra_bunching_user = True
        ```

### Extra_bunching {#extra_bunching}

```csharp
float Extra_bunching { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float extra_bunching = leg.Extra_bunching;
        leg.Extra_bunching = 0.0;
        ```

    === "C++"

        ```cpp
        double extra_bunching;
        leg->get_Extra_bunching(&extra_bunching);
        leg->put_Extra_bunching(0.0);
        ```

    === "Python"

        ```python
        extra_bunching = leg.Extra_bunching
        leg.Extra_bunching = 0.0
        ```

### Area_type_factor {#area_type_factor}

Area Type Factor, for Legs in Signalised Site only

```csharp
float Area_type_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float area_type_factor = leg.Area_type_factor;
        leg.Area_type_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double area_type_factor;
        leg->get_Area_type_factor(&area_type_factor);
        leg->put_Area_type_factor(0.0);
        ```

    === "Python"

        ```python
        area_type_factor = leg.Area_type_factor
        leg.Area_type_factor = 0.0
        ```

### Approach_control {#approach_control}

Approach Control Type, for Legs in Sign Controlled Site only

```csharp
int Approach_control { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Major Road
- `2` - Giveway
- `3` - Stop

???- example "Code samples"

    === "C#"

        ```csharp
        int approach_control = leg.Approach_control;
        leg.Approach_control = 0;
        ```

    === "C++"

        ```cpp
        long approach_control;
        leg->get_Approach_control(&approach_control);
        leg->put_Approach_control(0);
        ```

    === "Python"

        ```python
        approach_control = leg.Approach_control
        leg.Approach_control = 0
        ```

### Is_departure_headway_awsc_applied {#is_departure_headway_awsc_applied}

```csharp
bool Is_departure_headway_awsc_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_departure_headway_awsc_applied = leg.Is_departure_headway_awsc_applied;
        leg.Is_departure_headway_awsc_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_departure_headway_awsc_applied;
        leg->get_Is_departure_headway_awsc_applied(&is_departure_headway_awsc_applied);
        leg->put_Is_departure_headway_awsc_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_departure_headway_awsc_applied = leg.Is_departure_headway_awsc_applied
        leg.Is_departure_headway_awsc_applied = True
        ```

### LegGeometry {#leggeometry}

Leg Geometry

```csharp
int LegGeometry { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - No Leg
- `1` - Two Way
- `2` - One-Way Approach
- `3` - One-Way Exit

**Remarks**

Cannot remove a Leg by setting LegGeometry to 0. Call ISIAPILegs.RemoveLeg() method to remove a Leg.

???- example "Code samples"

    === "C#"

        ```csharp
        int legGeometry = leg.LegGeometry;
        leg.LegGeometry = 0;
        ```

    === "C++"

        ```cpp
        long legGeometry;
        leg->get_LegGeometry(&legGeometry);
        leg->put_LegGeometry(0);
        ```

    === "Python"

        ```python
        leg_geometry = leg.LegGeometry
        leg.LegGeometry = 0
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = leg.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        leg->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = leg.LastErrorMessage
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = leg.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        leg->get_Site(&site);
        ```

    === "Python"

        ```python
        site = leg.Site
        ```

### Leg_roundabout {#leg_roundabout}

```csharp
ISIAPILeg_roundabout Leg_roundabout { get; }
```

**Type** [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg_roundabout = leg.Leg_roundabout;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_roundabout> leg_roundabout;
        leg->get_Leg_roundabout(&leg_roundabout);
        ```

    === "Python"

        ```python
        leg_roundabout = leg.Leg_roundabout
        ```

### LaneApproachs {#laneapproachs}

```csharp
ISIAPILaneApproachs LaneApproachs { get; }
```

**Type** [`ISIAPILaneApproachs`](sidrasolutions.si.api.isiapilaneapproachs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneApproachs = leg.LaneApproachs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproachs> laneApproachs;
        leg->get_LaneApproachs(&laneApproachs);
        ```

    === "Python"

        ```python
        lane_approachs = leg.LaneApproachs
        ```

### LaneExits {#laneexits}

```csharp
ISIAPILaneExits LaneExits { get; }
```

**Type** [`ISIAPILaneExits`](sidrasolutions.si.api.isiapilaneexits.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var laneExits = leg.LaneExits;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExits> laneExits;
        leg->get_LaneExits(&laneExits);
        ```

    === "Python"

        ```python
        lane_exits = leg.LaneExits
        ```

### Islands {#islands}

```csharp
ISIAPIIslands Islands { get; }
```

**Type** [`ISIAPIIslands`](sidrasolutions.si.api.isiapiislands.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var islands = leg.Islands;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIIslands> islands;
        leg->get_Islands(&islands);
        ```

    === "Python"

        ```python
        islands = leg.Islands
        ```

### MovementPedSlipLane_Existing {#movementpedsliplane_existing}

```csharp
ISIAPIMovement_ped MovementPedSlipLane_Existing { get; }
```

**Type** [`ISIAPIMovement_ped`](sidrasolutions.si.api.isiapimovement_ped.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementPedSlipLane_Existing = leg.MovementPedSlipLane_Existing;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_ped> movementPedSlipLane_Existing;
        leg->get_MovementPedSlipLane_Existing(&movementPedSlipLane_Existing);
        ```

    === "Python"

        ```python
        movement_ped_slip_lane__existing = leg.MovementPedSlipLane_Existing
        ```

### Is_uturn_before_intersection {#is_uturn_before_intersection}

```csharp
bool Is_uturn_before_intersection { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_uturn_before_intersection = leg.Is_uturn_before_intersection;
        leg.Is_uturn_before_intersection = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_uturn_before_intersection;
        leg->get_Is_uturn_before_intersection(&is_uturn_before_intersection);
        leg->put_Is_uturn_before_intersection(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_uturn_before_intersection = leg.Is_uturn_before_intersection
        leg.Is_uturn_before_intersection = True
        ```

### Is_uturn_before_intersection_excluded_from_signal_analysis {#is_uturn_before_intersection_excluded_from_signal_analysis}

```csharp
bool Is_uturn_before_intersection_excluded_from_signal_analysis { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_uturn_before_intersection_excluded_from_signal_analysis = leg.Is_uturn_before_intersection_excluded_from_signal_analysis;
        leg.Is_uturn_before_intersection_excluded_from_signal_analysis = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_uturn_before_intersection_excluded_from_signal_analysis;
        leg->get_Is_uturn_before_intersection_excluded_from_signal_analysis(&is_uturn_before_intersection_excluded_from_signal_analysis);
        leg->put_Is_uturn_before_intersection_excluded_from_signal_analysis(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_uturn_before_intersection_excluded_from_signal_analysis = leg.Is_uturn_before_intersection_excluded_from_signal_analysis
        leg.Is_uturn_before_intersection_excluded_from_signal_analysis = True
        ```

### Extra_bunching_nw_user {#extra_bunching_nw_user}

```csharp
bool Extra_bunching_nw_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool extra_bunching_nw_user = leg.Extra_bunching_nw_user;
        leg.Extra_bunching_nw_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL extra_bunching_nw_user;
        leg->get_Extra_bunching_nw_user(&extra_bunching_nw_user);
        leg->put_Extra_bunching_nw_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        extra_bunching_nw_user = leg.Extra_bunching_nw_user
        leg.Extra_bunching_nw_user = True
        ```

### Extra_bunching_nw {#extra_bunching_nw}

```csharp
float Extra_bunching_nw { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float extra_bunching_nw = leg.Extra_bunching_nw;
        leg.Extra_bunching_nw = 0.0;
        ```

    === "C++"

        ```cpp
        double extra_bunching_nw;
        leg->get_Extra_bunching_nw(&extra_bunching_nw);
        leg->put_Extra_bunching_nw(0.0);
        ```

    === "Python"

        ```python
        extra_bunching_nw = leg.Extra_bunching_nw
        leg.Extra_bunching_nw = 0.0
        ```

### Approach_start_point {#approach_start_point}

```csharp
ISIAPIMapCoordinate Approach_start_point { get; }
```

**Type** [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var approach_start_point = leg.Approach_start_point;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMapCoordinate> approach_start_point;
        leg->get_Approach_start_point(&approach_start_point);
        ```

    === "Python"

        ```python
        approach_start_point = leg.Approach_start_point
        ```

### Exit_start_point_user {#exit_start_point_user}

```csharp
bool Exit_start_point_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exit_start_point_user = leg.Exit_start_point_user;
        leg.Exit_start_point_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exit_start_point_user;
        leg->get_Exit_start_point_user(&exit_start_point_user);
        leg->put_Exit_start_point_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exit_start_point_user = leg.Exit_start_point_user
        leg.Exit_start_point_user = True
        ```

### Exit_start_point {#exit_start_point}

```csharp
ISIAPIMapCoordinate Exit_start_point { get; }
```

**Type** [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var exit_start_point = leg.Exit_start_point;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMapCoordinate> exit_start_point;
        leg->get_Exit_start_point(&exit_start_point);
        ```

    === "Python"

        ```python
        exit_start_point = leg.Exit_start_point
        ```

### Approach_end_point {#approach_end_point}

```csharp
ISIAPIMapCoordinate Approach_end_point { get; }
```

**Type** [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var approach_end_point = leg.Approach_end_point;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMapCoordinate> approach_end_point;
        leg->get_Approach_end_point(&approach_end_point);
        ```

    === "Python"

        ```python
        approach_end_point = leg.Approach_end_point
        ```

### Exit_end_point_user {#exit_end_point_user}

```csharp
bool Exit_end_point_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exit_end_point_user = leg.Exit_end_point_user;
        leg.Exit_end_point_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exit_end_point_user;
        leg->get_Exit_end_point_user(&exit_end_point_user);
        leg->put_Exit_end_point_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exit_end_point_user = leg.Exit_end_point_user
        leg.Exit_end_point_user = True
        ```

### Exit_end_point {#exit_end_point}

```csharp
ISIAPIMapCoordinate Exit_end_point { get; }
```

**Type** [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var exit_end_point = leg.Exit_end_point;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMapCoordinate> exit_end_point;
        leg->get_Exit_end_point(&exit_end_point);
        ```

    === "Python"

        ```python
        exit_end_point = leg.Exit_end_point
        ```

### PedMainCrossingVolumeOption {#pedmaincrossingvolumeoption}

Pedestrian Volume Data Option for Main Crossing (Full and Staged)

```csharp
int PedMainCrossingVolumeOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Overall Value for Full and Staged Crossings (All Stages)
- `1` - Separate Value for Full and Staged Crossings

The default is 0.

**Remarks**

When this Option is set to 0 (Overall Value), the overall pedestrian volume data (Volume, Peak Flow Factor, Flow Scale and 
Growth Rate) in the ISIAPILeg object are applied for the Pedestrian Full and Staged Crossing Movements. 
The volume data in the corresponding ISIAPIMovement_ped objects are ignored.

When this Option is set to 1 (Separate Value), the volume data in the corresponding ISIAPIMovement_ped objects are applied.

This option does not affect the volume data of Slip/Bypass Lane Crossing. The volume data in the corresponding 
ISIAPIMovement_ped object for the Slip/Bypass Lane Crossing are applied.

This option does not affect the Pedestrian Movement Data (e.g. Exists or not, Crossing Distance, Opposing Pedestrian 
Factor, Walking Speed, etc.). These data in the corresponding ISIAPIMovement_ped object are applied.

???- example "Code samples"

    === "C#"

        ```csharp
        int pedMainCrossingVolumeOption = leg.PedMainCrossingVolumeOption;
        leg.PedMainCrossingVolumeOption = 0;
        ```

    === "C++"

        ```cpp
        long pedMainCrossingVolumeOption;
        leg->get_PedMainCrossingVolumeOption(&pedMainCrossingVolumeOption);
        leg->put_PedMainCrossingVolumeOption(0);
        ```

    === "Python"

        ```python
        ped_main_crossing_volume_option = leg.PedMainCrossingVolumeOption
        leg.PedMainCrossingVolumeOption = 0
        ```

### PedMainCrossingVolume {#pedmaincrossingvolume}

```csharp
float PedMainCrossingVolume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingVolume = leg.PedMainCrossingVolume;
        leg.PedMainCrossingVolume = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingVolume;
        leg->get_PedMainCrossingVolume(&pedMainCrossingVolume);
        leg->put_PedMainCrossingVolume(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_volume = leg.PedMainCrossingVolume
        leg.PedMainCrossingVolume = 0.0
        ```

### PedMainCrossingPeakFlowFactor {#pedmaincrossingpeakflowfactor}

```csharp
float PedMainCrossingPeakFlowFactor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingPeakFlowFactor = leg.PedMainCrossingPeakFlowFactor;
        leg.PedMainCrossingPeakFlowFactor = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingPeakFlowFactor;
        leg->get_PedMainCrossingPeakFlowFactor(&pedMainCrossingPeakFlowFactor);
        leg->put_PedMainCrossingPeakFlowFactor(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_peak_flow_factor = leg.PedMainCrossingPeakFlowFactor
        leg.PedMainCrossingPeakFlowFactor = 0.0
        ```

### PedMainCrossingFlowScale {#pedmaincrossingflowscale}

```csharp
float PedMainCrossingFlowScale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingFlowScale = leg.PedMainCrossingFlowScale;
        leg.PedMainCrossingFlowScale = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingFlowScale;
        leg->get_PedMainCrossingFlowScale(&pedMainCrossingFlowScale);
        leg->put_PedMainCrossingFlowScale(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_flow_scale = leg.PedMainCrossingFlowScale
        leg.PedMainCrossingFlowScale = 0.0
        ```

### PedMainCrossingGrowthRate {#pedmaincrossinggrowthrate}

```csharp
float PedMainCrossingGrowthRate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingGrowthRate = leg.PedMainCrossingGrowthRate;
        leg.PedMainCrossingGrowthRate = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingGrowthRate;
        leg->get_PedMainCrossingGrowthRate(&pedMainCrossingGrowthRate);
        leg->put_PedMainCrossingGrowthRate(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_growth_rate = leg.PedMainCrossingGrowthRate
        leg.PedMainCrossingGrowthRate = 0.0
        ```

## Methods

### InsertApproachLane(int) {#insertapproachlane-int}

Insert an new Approach Lane to the Leg at the specified position. The Approach Lane is created automatically.

```csharp
ISIAPILaneApproach InsertApproachLane(int positionOnLeg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `positionOnLeg` | `int` | Postion on the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |

**Returns** [`ISIAPILaneApproach`](sidrasolutions.si.api.isiapilaneapproach.md) - The new Approach Lane

???- example "Code samples"

    === "C#"

        ```csharp
        var result = leg.InsertApproachLane(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneApproach> result;
        leg->InsertApproachLane(0, &result);
        ```

    === "Python"

        ```python
        result = leg.InsertApproachLane(0)
        ```

### InsertExitLane(int) {#insertexitlane-int}

Insert an new Exit Lane to the Leg at the specified position. The Exit Lane is created automatically.

```csharp
ISIAPILaneExit InsertExitLane(int positionOnLeg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `positionOnLeg` | `int` | Postion on the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |

**Returns** [`ISIAPILaneExit`](sidrasolutions.si.api.isiapilaneexit.md) - The new Exit Lane

???- example "Code samples"

    === "C#"

        ```csharp
        var result = leg.InsertExitLane(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILaneExit> result;
        leg->InsertExitLane(0, &result);
        ```

    === "Python"

        ```python
        result = leg.InsertExitLane(0)
        ```

### InsertIsland(int) {#insertisland-int}

Insert an new Island to the Leg at the specified position. The Island is created automatically.

```csharp
ISIAPIIsland InsertIsland(int positionOnLeg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `positionOnLeg` | `int` | Postion on the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |

**Returns** [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) - The new Island

???- example "Code samples"

    === "C#"

        ```csharp
        var result = leg.InsertIsland(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIIsland> result;
        leg->InsertIsland(0, &result);
        ```

    === "Python"

        ```python
        result = leg.InsertIsland(0)
        ```

### InsertIsland_RoundaboutSplitter(int) {#insertisland_roundaboutsplitter-int}

Insert an new Roundabout Splitter Island to the Leg at the specified position. The Island is created automatically.

```csharp
ISIAPIIsland InsertIsland_RoundaboutSplitter(int positionOnLeg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `positionOnLeg` | `int` | Postion on the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |

**Returns** [`ISIAPIIsland`](sidrasolutions.si.api.isiapiisland.md) - The new Roundabout Splitter Island

???- example "Code samples"

    === "C#"

        ```csharp
        var result = leg.InsertIsland_RoundaboutSplitter(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIIsland> result;
        leg->InsertIsland_RoundaboutSplitter(0, &result);
        ```

    === "Python"

        ```python
        result = leg.InsertIsland_RoundaboutSplitter(0)
        ```

### RemoveItem(int) {#removeitem-int}

Remove the item at the specified position on the Leg. The item could be an Approach Lane, Exit Lane or Island.

```csharp
bool RemoveItem(int positionOnLeg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `positionOnLeg` | `int` | Postion on the Leg, a one-based integer, counts Approach Lanes, Exit Lanes and Islands from left to right looking to the centre of the Intersection. |

**Returns** `bool` - true if the item is successfully removed. This method returns false if the item does not exist in this Leg.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = leg.RemoveItem(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        leg->RemoveItem(0, &result);
        ```

    === "Python"

        ```python
        result = leg.RemoveItem(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapileg_rou_hcm.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILeg_rou_hcm
title: Leg_rou_hcm
name: ISIAPILeg_rou_hcm
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2113618B-9955-432B-8812-90061721048D
members:
  - int Hcm_model
  - float Model_calib_factor
  - int Entry_circ_adj
  - float Single_circ_single_entry_param_a
  - float Single_circ_single_entry_param_b
  - float Single_circ_multi_entry_param_a
  - float Single_circ_multi_entry_param_b
  - float Multi_circ_single_entry_param_a
  - float Multi_circ_single_entry_param_b
  - float Multi_circ_multi_entry_dominant_param_a
  - float Multi_circ_multi_entry_dominant_param_b
  - float Multi_circ_multi_entry_subdominant_param_a
  - float Multi_circ_multi_entry_subdominant_param_b
  - ISIAPILeg_roundabout Leg_roundabout
---

# Leg_rou_hcm

Type `ISIAPILeg_rou_hcm` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2113618B-9955-432B-8812-90061721048D`

## Declaration

```csharp
[Guid("2113618B-9955-432B-8812-90061721048D")]
public interface ISIAPILeg_rou_hcm
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Hcm_model](#hcm_model) | `int` | HCM Model |
| [Model_calib_factor](#model_calib_factor) | `float` |  |
| [Entry_circ_adj](#entry_circ_adj) | `int` | Roundabout Entry/Circulating Flow Adjustment (HCM) |
| [Single_circ_single_entry_param_a](#single_circ_single_entry_param_a) | `float` |  |
| [Single_circ_single_entry_param_b](#single_circ_single_entry_param_b) | `float` |  |
| [Single_circ_multi_entry_param_a](#single_circ_multi_entry_param_a) | `float` |  |
| [Single_circ_multi_entry_param_b](#single_circ_multi_entry_param_b) | `float` |  |
| [Multi_circ_single_entry_param_a](#multi_circ_single_entry_param_a) | `float` |  |
| [Multi_circ_single_entry_param_b](#multi_circ_single_entry_param_b) | `float` |  |
| [Multi_circ_multi_entry_dominant_param_a](#multi_circ_multi_entry_dominant_param_a) | `float` |  |
| [Multi_circ_multi_entry_dominant_param_b](#multi_circ_multi_entry_dominant_param_b) | `float` |  |
| [Multi_circ_multi_entry_subdominant_param_a](#multi_circ_multi_entry_subdominant_param_a) | `float` |  |
| [Multi_circ_multi_entry_subdominant_param_b](#multi_circ_multi_entry_subdominant_param_b) | `float` |  |
| [Leg_roundabout](#leg_roundabout) | [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md) |  |

</div>

## Properties

### Hcm_model {#hcm_model}

HCM Model

```csharp
int Hcm_model { get; }
```

**Type** `int`

**Value**

One of:

- `1` - HCM 2010
- `2` - HCM 6

???- example "Code samples"

    === "C#"

        ```csharp
        int hcm_model = leg_rou_hcm.Hcm_model;
        ```

    === "C++"

        ```cpp
        long hcm_model;
        leg_rou_hcm->get_Hcm_model(&hcm_model);
        ```

    === "Python"

        ```python
        hcm_model = leg_rou_hcm.Hcm_model
        ```

### Model_calib_factor {#model_calib_factor}

```csharp
float Model_calib_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float model_calib_factor = leg_rou_hcm.Model_calib_factor;
        leg_rou_hcm.Model_calib_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double model_calib_factor;
        leg_rou_hcm->get_Model_calib_factor(&model_calib_factor);
        leg_rou_hcm->put_Model_calib_factor(0.0);
        ```

    === "Python"

        ```python
        model_calib_factor = leg_rou_hcm.Model_calib_factor
        leg_rou_hcm.Model_calib_factor = 0.0
        ```

### Entry_circ_adj {#entry_circ_adj}

Roundabout Entry/Circulating Flow Adjustment (HCM)

```csharp
int Entry_circ_adj { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Low
- `2` - Medium
- `3` - High

???- example "Code samples"

    === "C#"

        ```csharp
        int entry_circ_adj = leg_rou_hcm.Entry_circ_adj;
        leg_rou_hcm.Entry_circ_adj = 0;
        ```

    === "C++"

        ```cpp
        long entry_circ_adj;
        leg_rou_hcm->get_Entry_circ_adj(&entry_circ_adj);
        leg_rou_hcm->put_Entry_circ_adj(0);
        ```

    === "Python"

        ```python
        entry_circ_adj = leg_rou_hcm.Entry_circ_adj
        leg_rou_hcm.Entry_circ_adj = 0
        ```

### Single_circ_single_entry_param_a {#single_circ_single_entry_param_a}

```csharp
float Single_circ_single_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_single_entry_param_a = leg_rou_hcm.Single_circ_single_entry_param_a;
        leg_rou_hcm.Single_circ_single_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_single_entry_param_a;
        leg_rou_hcm->get_Single_circ_single_entry_param_a(&single_circ_single_entry_param_a);
        leg_rou_hcm->put_Single_circ_single_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_single_entry_param_a = leg_rou_hcm.Single_circ_single_entry_param_a
        leg_rou_hcm.Single_circ_single_entry_param_a = 0.0
        ```

### Single_circ_single_entry_param_b {#single_circ_single_entry_param_b}

```csharp
float Single_circ_single_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_single_entry_param_b = leg_rou_hcm.Single_circ_single_entry_param_b;
        leg_rou_hcm.Single_circ_single_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_single_entry_param_b;
        leg_rou_hcm->get_Single_circ_single_entry_param_b(&single_circ_single_entry_param_b);
        leg_rou_hcm->put_Single_circ_single_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_single_entry_param_b = leg_rou_hcm.Single_circ_single_entry_param_b
        leg_rou_hcm.Single_circ_single_entry_param_b = 0.0
        ```

### Single_circ_multi_entry_param_a {#single_circ_multi_entry_param_a}

```csharp
float Single_circ_multi_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_multi_entry_param_a = leg_rou_hcm.Single_circ_multi_entry_param_a;
        leg_rou_hcm.Single_circ_multi_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_multi_entry_param_a;
        leg_rou_hcm->get_Single_circ_multi_entry_param_a(&single_circ_multi_entry_param_a);
        leg_rou_hcm->put_Single_circ_multi_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_multi_entry_param_a = leg_rou_hcm.Single_circ_multi_entry_param_a
        leg_rou_hcm.Single_circ_multi_entry_param_a = 0.0
        ```

### Single_circ_multi_entry_param_b {#single_circ_multi_entry_param_b}

```csharp
float Single_circ_multi_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_multi_entry_param_b = leg_rou_hcm.Single_circ_multi_entry_param_b;
        leg_rou_hcm.Single_circ_multi_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_multi_entry_param_b;
        leg_rou_hcm->get_Single_circ_multi_entry_param_b(&single_circ_multi_entry_param_b);
        leg_rou_hcm->put_Single_circ_multi_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_multi_entry_param_b = leg_rou_hcm.Single_circ_multi_entry_param_b
        leg_rou_hcm.Single_circ_multi_entry_param_b = 0.0
        ```

### Multi_circ_single_entry_param_a {#multi_circ_single_entry_param_a}

```csharp
float Multi_circ_single_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_single_entry_param_a = leg_rou_hcm.Multi_circ_single_entry_param_a;
        leg_rou_hcm.Multi_circ_single_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_single_entry_param_a;
        leg_rou_hcm->get_Multi_circ_single_entry_param_a(&multi_circ_single_entry_param_a);
        leg_rou_hcm->put_Multi_circ_single_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_single_entry_param_a = leg_rou_hcm.Multi_circ_single_entry_param_a
        leg_rou_hcm.Multi_circ_single_entry_param_a = 0.0
        ```

### Multi_circ_single_entry_param_b {#multi_circ_single_entry_param_b}

```csharp
float Multi_circ_single_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_single_entry_param_b = leg_rou_hcm.Multi_circ_single_entry_param_b;
        leg_rou_hcm.Multi_circ_single_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_single_entry_param_b;
        leg_rou_hcm->get_Multi_circ_single_entry_param_b(&multi_circ_single_entry_param_b);
        leg_rou_hcm->put_Multi_circ_single_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_single_entry_param_b = leg_rou_hcm.Multi_circ_single_entry_param_b
        leg_rou_hcm.Multi_circ_single_entry_param_b = 0.0
        ```

### Multi_circ_multi_entry_dominant_param_a {#multi_circ_multi_entry_dominant_param_a}

```csharp
float Multi_circ_multi_entry_dominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_multi_entry_dominant_param_a = leg_rou_hcm.Multi_circ_multi_entry_dominant_param_a;
        leg_rou_hcm.Multi_circ_multi_entry_dominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_multi_entry_dominant_param_a;
        leg_rou_hcm->get_Multi_circ_multi_entry_dominant_param_a(&multi_circ_multi_entry_dominant_param_a);
        leg_rou_hcm->put_Multi_circ_multi_entry_dominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_multi_entry_dominant_param_a = leg_rou_hcm.Multi_circ_multi_entry_dominant_param_a
        leg_rou_hcm.Multi_circ_multi_entry_dominant_param_a = 0.0
        ```

### Multi_circ_multi_entry_dominant_param_b {#multi_circ_multi_entry_dominant_param_b}

```csharp
float Multi_circ_multi_entry_dominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_multi_entry_dominant_param_b = leg_rou_hcm.Multi_circ_multi_entry_dominant_param_b;
        leg_rou_hcm.Multi_circ_multi_entry_dominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_multi_entry_dominant_param_b;
        leg_rou_hcm->get_Multi_circ_multi_entry_dominant_param_b(&multi_circ_multi_entry_dominant_param_b);
        leg_rou_hcm->put_Multi_circ_multi_entry_dominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_multi_entry_dominant_param_b = leg_rou_hcm.Multi_circ_multi_entry_dominant_param_b
        leg_rou_hcm.Multi_circ_multi_entry_dominant_param_b = 0.0
        ```

### Multi_circ_multi_entry_subdominant_param_a {#multi_circ_multi_entry_subdominant_param_a}

```csharp
float Multi_circ_multi_entry_subdominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_multi_entry_subdominant_param_a = leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_a;
        leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_multi_entry_subdominant_param_a;
        leg_rou_hcm->get_Multi_circ_multi_entry_subdominant_param_a(&multi_circ_multi_entry_subdominant_param_a);
        leg_rou_hcm->put_Multi_circ_multi_entry_subdominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_multi_entry_subdominant_param_a = leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_a
        leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_a = 0.0
        ```

### Multi_circ_multi_entry_subdominant_param_b {#multi_circ_multi_entry_subdominant_param_b}

```csharp
float Multi_circ_multi_entry_subdominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_multi_entry_subdominant_param_b = leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_b;
        leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_multi_entry_subdominant_param_b;
        leg_rou_hcm->get_Multi_circ_multi_entry_subdominant_param_b(&multi_circ_multi_entry_subdominant_param_b);
        leg_rou_hcm->put_Multi_circ_multi_entry_subdominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_multi_entry_subdominant_param_b = leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_b
        leg_rou_hcm.Multi_circ_multi_entry_subdominant_param_b = 0.0
        ```

### Leg_roundabout {#leg_roundabout}

```csharp
ISIAPILeg_roundabout Leg_roundabout { get; }
```

**Type** [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg_roundabout = leg_rou_hcm.Leg_roundabout;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_roundabout> leg_roundabout;
        leg_rou_hcm->get_Leg_roundabout(&leg_roundabout);
        ```

    === "Python"

        ```python
        leg_roundabout = leg_rou_hcm.Leg_roundabout
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapileg_rou_hcm6_extended.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILeg_rou_hcm6_extended
title: Leg_rou_hcm6_extended
name: ISIAPILeg_rou_hcm6_extended
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: A1EEF860-52BB-49B1-9CDB-5EC4D791732F
members:
  - float Model_calib_factor
  - int Entry_circ_adj
  - float Single_circ_single_entry_param_a
  - float Single_circ_single_entry_param_b
  - float Single_circ_two_entry_dominant_param_a
  - float Single_circ_two_entry_dominant_param_b
  - float Single_circ_two_entry_subdominant_param_a
  - float Single_circ_two_entry_subdominant_param_b
  - float Single_circ_slip_entry_param_a
  - float Single_circ_slip_entry_param_b
  - float Multi_circ_single_entry_param_a
  - float Multi_circ_single_entry_param_b
  - float Multi_circ_two_entry_dominant_param_a
  - float Multi_circ_two_entry_dominant_param_b
  - float Multi_circ_two_entry_subdominant_param_a
  - float Multi_circ_two_entry_subdominant_param_b
  - float Multi_circ_three_entry_dominant_param_a
  - float Multi_circ_three_entry_dominant_param_b
  - float Multi_circ_three_entry_subdominant_param_a
  - float Multi_circ_three_entry_subdominant_param_b
  - float Multi_circ_slip_entry_param_a
  - float Multi_circ_slip_entry_param_b
  - ISIAPILeg_roundabout Leg_roundabout
---

# Leg_rou_hcm6_extended

Type `ISIAPILeg_rou_hcm6_extended` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `A1EEF860-52BB-49B1-9CDB-5EC4D791732F`

## Declaration

```csharp
[Guid("A1EEF860-52BB-49B1-9CDB-5EC4D791732F")]
public interface ISIAPILeg_rou_hcm6_extended
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Model_calib_factor](#model_calib_factor) | `float` |  |
| [Entry_circ_adj](#entry_circ_adj) | `int` | Roundabout Entry/Circulating Flow Adjustment (HCM) |
| [Single_circ_single_entry_param_a](#single_circ_single_entry_param_a) | `float` |  |
| [Single_circ_single_entry_param_b](#single_circ_single_entry_param_b) | `float` |  |
| [Single_circ_two_entry_dominant_param_a](#single_circ_two_entry_dominant_param_a) | `float` |  |
| [Single_circ_two_entry_dominant_param_b](#single_circ_two_entry_dominant_param_b) | `float` |  |
| [Single_circ_two_entry_subdominant_param_a](#single_circ_two_entry_subdominant_param_a) | `float` |  |
| [Single_circ_two_entry_subdominant_param_b](#single_circ_two_entry_subdominant_param_b) | `float` |  |
| [Single_circ_slip_entry_param_a](#single_circ_slip_entry_param_a) | `float` |  |
| [Single_circ_slip_entry_param_b](#single_circ_slip_entry_param_b) | `float` |  |
| [Multi_circ_single_entry_param_a](#multi_circ_single_entry_param_a) | `float` |  |
| [Multi_circ_single_entry_param_b](#multi_circ_single_entry_param_b) | `float` |  |
| [Multi_circ_two_entry_dominant_param_a](#multi_circ_two_entry_dominant_param_a) | `float` |  |
| [Multi_circ_two_entry_dominant_param_b](#multi_circ_two_entry_dominant_param_b) | `float` |  |
| [Multi_circ_two_entry_subdominant_param_a](#multi_circ_two_entry_subdominant_param_a) | `float` |  |
| [Multi_circ_two_entry_subdominant_param_b](#multi_circ_two_entry_subdominant_param_b) | `float` |  |
| [Multi_circ_three_entry_dominant_param_a](#multi_circ_three_entry_dominant_param_a) | `float` |  |
| [Multi_circ_three_entry_dominant_param_b](#multi_circ_three_entry_dominant_param_b) | `float` |  |
| [Multi_circ_three_entry_subdominant_param_a](#multi_circ_three_entry_subdominant_param_a) | `float` |  |
| [Multi_circ_three_entry_subdominant_param_b](#multi_circ_three_entry_subdominant_param_b) | `float` |  |
| [Multi_circ_slip_entry_param_a](#multi_circ_slip_entry_param_a) | `float` |  |
| [Multi_circ_slip_entry_param_b](#multi_circ_slip_entry_param_b) | `float` |  |
| [Leg_roundabout](#leg_roundabout) | [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md) |  |

</div>

## Properties

### Model_calib_factor {#model_calib_factor}

```csharp
float Model_calib_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float model_calib_factor = leg_rou_hcm6_extended.Model_calib_factor;
        leg_rou_hcm6_extended.Model_calib_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double model_calib_factor;
        leg_rou_hcm6_extended->get_Model_calib_factor(&model_calib_factor);
        leg_rou_hcm6_extended->put_Model_calib_factor(0.0);
        ```

    === "Python"

        ```python
        model_calib_factor = leg_rou_hcm6_extended.Model_calib_factor
        leg_rou_hcm6_extended.Model_calib_factor = 0.0
        ```

### Entry_circ_adj {#entry_circ_adj}

Roundabout Entry/Circulating Flow Adjustment (HCM)

```csharp
int Entry_circ_adj { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Low
- `2` - Medium
- `3` - High

???- example "Code samples"

    === "C#"

        ```csharp
        int entry_circ_adj = leg_rou_hcm6_extended.Entry_circ_adj;
        leg_rou_hcm6_extended.Entry_circ_adj = 0;
        ```

    === "C++"

        ```cpp
        long entry_circ_adj;
        leg_rou_hcm6_extended->get_Entry_circ_adj(&entry_circ_adj);
        leg_rou_hcm6_extended->put_Entry_circ_adj(0);
        ```

    === "Python"

        ```python
        entry_circ_adj = leg_rou_hcm6_extended.Entry_circ_adj
        leg_rou_hcm6_extended.Entry_circ_adj = 0
        ```

### Single_circ_single_entry_param_a {#single_circ_single_entry_param_a}

```csharp
float Single_circ_single_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_single_entry_param_a = leg_rou_hcm6_extended.Single_circ_single_entry_param_a;
        leg_rou_hcm6_extended.Single_circ_single_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_single_entry_param_a;
        leg_rou_hcm6_extended->get_Single_circ_single_entry_param_a(&single_circ_single_entry_param_a);
        leg_rou_hcm6_extended->put_Single_circ_single_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_single_entry_param_a = leg_rou_hcm6_extended.Single_circ_single_entry_param_a
        leg_rou_hcm6_extended.Single_circ_single_entry_param_a = 0.0
        ```

### Single_circ_single_entry_param_b {#single_circ_single_entry_param_b}

```csharp
float Single_circ_single_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_single_entry_param_b = leg_rou_hcm6_extended.Single_circ_single_entry_param_b;
        leg_rou_hcm6_extended.Single_circ_single_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_single_entry_param_b;
        leg_rou_hcm6_extended->get_Single_circ_single_entry_param_b(&single_circ_single_entry_param_b);
        leg_rou_hcm6_extended->put_Single_circ_single_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_single_entry_param_b = leg_rou_hcm6_extended.Single_circ_single_entry_param_b
        leg_rou_hcm6_extended.Single_circ_single_entry_param_b = 0.0
        ```

### Single_circ_two_entry_dominant_param_a {#single_circ_two_entry_dominant_param_a}

```csharp
float Single_circ_two_entry_dominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_two_entry_dominant_param_a = leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_a;
        leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_two_entry_dominant_param_a;
        leg_rou_hcm6_extended->get_Single_circ_two_entry_dominant_param_a(&single_circ_two_entry_dominant_param_a);
        leg_rou_hcm6_extended->put_Single_circ_two_entry_dominant_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_two_entry_dominant_param_a = leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_a
        leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_a = 0.0
        ```

### Single_circ_two_entry_dominant_param_b {#single_circ_two_entry_dominant_param_b}

```csharp
float Single_circ_two_entry_dominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_two_entry_dominant_param_b = leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_b;
        leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_two_entry_dominant_param_b;
        leg_rou_hcm6_extended->get_Single_circ_two_entry_dominant_param_b(&single_circ_two_entry_dominant_param_b);
        leg_rou_hcm6_extended->put_Single_circ_two_entry_dominant_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_two_entry_dominant_param_b = leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_b
        leg_rou_hcm6_extended.Single_circ_two_entry_dominant_param_b = 0.0
        ```

### Single_circ_two_entry_subdominant_param_a {#single_circ_two_entry_subdominant_param_a}

```csharp
float Single_circ_two_entry_subdominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_two_entry_subdominant_param_a = leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_a;
        leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_two_entry_subdominant_param_a;
        leg_rou_hcm6_extended->get_Single_circ_two_entry_subdominant_param_a(&single_circ_two_entry_subdominant_param_a);
        leg_rou_hcm6_extended->put_Single_circ_two_entry_subdominant_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_two_entry_subdominant_param_a = leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_a
        leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_a = 0.0
        ```

### Single_circ_two_entry_subdominant_param_b {#single_circ_two_entry_subdominant_param_b}

```csharp
float Single_circ_two_entry_subdominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_two_entry_subdominant_param_b = leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_b;
        leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_two_entry_subdominant_param_b;
        leg_rou_hcm6_extended->get_Single_circ_two_entry_subdominant_param_b(&single_circ_two_entry_subdominant_param_b);
        leg_rou_hcm6_extended->put_Single_circ_two_entry_subdominant_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_two_entry_subdominant_param_b = leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_b
        leg_rou_hcm6_extended.Single_circ_two_entry_subdominant_param_b = 0.0
        ```

### Single_circ_slip_entry_param_a {#single_circ_slip_entry_param_a}

```csharp
float Single_circ_slip_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_slip_entry_param_a = leg_rou_hcm6_extended.Single_circ_slip_entry_param_a;
        leg_rou_hcm6_extended.Single_circ_slip_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_slip_entry_param_a;
        leg_rou_hcm6_extended->get_Single_circ_slip_entry_param_a(&single_circ_slip_entry_param_a);
        leg_rou_hcm6_extended->put_Single_circ_slip_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        single_circ_slip_entry_param_a = leg_rou_hcm6_extended.Single_circ_slip_entry_param_a
        leg_rou_hcm6_extended.Single_circ_slip_entry_param_a = 0.0
        ```

### Single_circ_slip_entry_param_b {#single_circ_slip_entry_param_b}

```csharp
float Single_circ_slip_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float single_circ_slip_entry_param_b = leg_rou_hcm6_extended.Single_circ_slip_entry_param_b;
        leg_rou_hcm6_extended.Single_circ_slip_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double single_circ_slip_entry_param_b;
        leg_rou_hcm6_extended->get_Single_circ_slip_entry_param_b(&single_circ_slip_entry_param_b);
        leg_rou_hcm6_extended->put_Single_circ_slip_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        single_circ_slip_entry_param_b = leg_rou_hcm6_extended.Single_circ_slip_entry_param_b
        leg_rou_hcm6_extended.Single_circ_slip_entry_param_b = 0.0
        ```

### Multi_circ_single_entry_param_a {#multi_circ_single_entry_param_a}

```csharp
float Multi_circ_single_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_single_entry_param_a = leg_rou_hcm6_extended.Multi_circ_single_entry_param_a;
        leg_rou_hcm6_extended.Multi_circ_single_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_single_entry_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_single_entry_param_a(&multi_circ_single_entry_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_single_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_single_entry_param_a = leg_rou_hcm6_extended.Multi_circ_single_entry_param_a
        leg_rou_hcm6_extended.Multi_circ_single_entry_param_a = 0.0
        ```

### Multi_circ_single_entry_param_b {#multi_circ_single_entry_param_b}

```csharp
float Multi_circ_single_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_single_entry_param_b = leg_rou_hcm6_extended.Multi_circ_single_entry_param_b;
        leg_rou_hcm6_extended.Multi_circ_single_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_single_entry_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_single_entry_param_b(&multi_circ_single_entry_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_single_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_single_entry_param_b = leg_rou_hcm6_extended.Multi_circ_single_entry_param_b
        leg_rou_hcm6_extended.Multi_circ_single_entry_param_b = 0.0
        ```

### Multi_circ_two_entry_dominant_param_a {#multi_circ_two_entry_dominant_param_a}

```csharp
float Multi_circ_two_entry_dominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_two_entry_dominant_param_a = leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_a;
        leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_two_entry_dominant_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_two_entry_dominant_param_a(&multi_circ_two_entry_dominant_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_two_entry_dominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_two_entry_dominant_param_a = leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_a
        leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_a = 0.0
        ```

### Multi_circ_two_entry_dominant_param_b {#multi_circ_two_entry_dominant_param_b}

```csharp
float Multi_circ_two_entry_dominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_two_entry_dominant_param_b = leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_b;
        leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_two_entry_dominant_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_two_entry_dominant_param_b(&multi_circ_two_entry_dominant_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_two_entry_dominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_two_entry_dominant_param_b = leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_b
        leg_rou_hcm6_extended.Multi_circ_two_entry_dominant_param_b = 0.0
        ```

### Multi_circ_two_entry_subdominant_param_a {#multi_circ_two_entry_subdominant_param_a}

```csharp
float Multi_circ_two_entry_subdominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_two_entry_subdominant_param_a = leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_a;
        leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_two_entry_subdominant_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_two_entry_subdominant_param_a(&multi_circ_two_entry_subdominant_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_two_entry_subdominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_two_entry_subdominant_param_a = leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_a
        leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_a = 0.0
        ```

### Multi_circ_two_entry_subdominant_param_b {#multi_circ_two_entry_subdominant_param_b}

```csharp
float Multi_circ_two_entry_subdominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_two_entry_subdominant_param_b = leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_b;
        leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_two_entry_subdominant_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_two_entry_subdominant_param_b(&multi_circ_two_entry_subdominant_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_two_entry_subdominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_two_entry_subdominant_param_b = leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_b
        leg_rou_hcm6_extended.Multi_circ_two_entry_subdominant_param_b = 0.0
        ```

### Multi_circ_three_entry_dominant_param_a {#multi_circ_three_entry_dominant_param_a}

```csharp
float Multi_circ_three_entry_dominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_three_entry_dominant_param_a = leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_a;
        leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_three_entry_dominant_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_three_entry_dominant_param_a(&multi_circ_three_entry_dominant_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_three_entry_dominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_three_entry_dominant_param_a = leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_a
        leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_a = 0.0
        ```

### Multi_circ_three_entry_dominant_param_b {#multi_circ_three_entry_dominant_param_b}

```csharp
float Multi_circ_three_entry_dominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_three_entry_dominant_param_b = leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_b;
        leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_three_entry_dominant_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_three_entry_dominant_param_b(&multi_circ_three_entry_dominant_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_three_entry_dominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_three_entry_dominant_param_b = leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_b
        leg_rou_hcm6_extended.Multi_circ_three_entry_dominant_param_b = 0.0
        ```

### Multi_circ_three_entry_subdominant_param_a {#multi_circ_three_entry_subdominant_param_a}

```csharp
float Multi_circ_three_entry_subdominant_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_three_entry_subdominant_param_a = leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_a;
        leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_three_entry_subdominant_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_three_entry_subdominant_param_a(&multi_circ_three_entry_subdominant_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_three_entry_subdominant_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_three_entry_subdominant_param_a = leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_a
        leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_a = 0.0
        ```

### Multi_circ_three_entry_subdominant_param_b {#multi_circ_three_entry_subdominant_param_b}

```csharp
float Multi_circ_three_entry_subdominant_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_three_entry_subdominant_param_b = leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_b;
        leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_three_entry_subdominant_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_three_entry_subdominant_param_b(&multi_circ_three_entry_subdominant_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_three_entry_subdominant_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_three_entry_subdominant_param_b = leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_b
        leg_rou_hcm6_extended.Multi_circ_three_entry_subdominant_param_b = 0.0
        ```

### Multi_circ_slip_entry_param_a {#multi_circ_slip_entry_param_a}

```csharp
float Multi_circ_slip_entry_param_a { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_slip_entry_param_a = leg_rou_hcm6_extended.Multi_circ_slip_entry_param_a;
        leg_rou_hcm6_extended.Multi_circ_slip_entry_param_a = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_slip_entry_param_a;
        leg_rou_hcm6_extended->get_Multi_circ_slip_entry_param_a(&multi_circ_slip_entry_param_a);
        leg_rou_hcm6_extended->put_Multi_circ_slip_entry_param_a(0.0);
        ```

    === "Python"

        ```python
        multi_circ_slip_entry_param_a = leg_rou_hcm6_extended.Multi_circ_slip_entry_param_a
        leg_rou_hcm6_extended.Multi_circ_slip_entry_param_a = 0.0
        ```

### Multi_circ_slip_entry_param_b {#multi_circ_slip_entry_param_b}

```csharp
float Multi_circ_slip_entry_param_b { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float multi_circ_slip_entry_param_b = leg_rou_hcm6_extended.Multi_circ_slip_entry_param_b;
        leg_rou_hcm6_extended.Multi_circ_slip_entry_param_b = 0.0;
        ```

    === "C++"

        ```cpp
        double multi_circ_slip_entry_param_b;
        leg_rou_hcm6_extended->get_Multi_circ_slip_entry_param_b(&multi_circ_slip_entry_param_b);
        leg_rou_hcm6_extended->put_Multi_circ_slip_entry_param_b(0.0);
        ```

    === "Python"

        ```python
        multi_circ_slip_entry_param_b = leg_rou_hcm6_extended.Multi_circ_slip_entry_param_b
        leg_rou_hcm6_extended.Multi_circ_slip_entry_param_b = 0.0
        ```

### Leg_roundabout {#leg_roundabout}

```csharp
ISIAPILeg_roundabout Leg_roundabout { get; }
```

**Type** [`ISIAPILeg_roundabout`](sidrasolutions.si.api.isiapileg_roundabout.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg_roundabout = leg_rou_hcm6_extended.Leg_roundabout;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_roundabout> leg_roundabout;
        leg_rou_hcm6_extended->get_Leg_roundabout(&leg_roundabout);
        ```

    === "Python"

        ```python
        leg_roundabout = leg_rou_hcm6_extended.Leg_roundabout
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapileg_roundabout.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILeg_roundabout
title: Leg_roundabout
name: ISIAPILeg_roundabout
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: A56E67A1-5C26-47EF-9437-D40DBF1369CA
members:
  - int Num_circulating_lanes
  - bool Num_downstream_circulating_lanes_user
  - int Num_downstream_circulating_lanes
  - float Circulating_width
  - float Island_diameter
  - bool Inscribed_diameter_user
  - float Inscribed_diameter
  - float Entry_radius
  - float Entry_angle
  - bool Is_raindrop_design
  - bool Circulating_transition_line
  - bool Environment_factor_user
  - float Environment_factor
  - bool Entry_circ_adj_user
  - int Entry_circ_adj
  - float App_half_width
  - float Flare_length
  - bool Capacity_at_zero_flow_user
  - float Capacity_at_zero_flow
  - bool Grade_separated
  - ISIAPILeg Leg
  - ISIAPILeg_rou_hcm LegRouHCM2010
  - ISIAPILeg_rou_hcm LegRouHCM6
  - ISIAPILeg_rou_hcm6_extended LegRouHCM6Extended
  - bool Is_turbo_island
---

# Leg_roundabout

Type `ISIAPILeg_roundabout` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `A56E67A1-5C26-47EF-9437-D40DBF1369CA`

## Declaration

```csharp
[Guid("A56E67A1-5C26-47EF-9437-D40DBF1369CA")]
public interface ISIAPILeg_roundabout
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Num_circulating_lanes](#num_circulating_lanes) | `int` |  |
| [Num_downstream_circulating_lanes_user](#num_downstream_circulating_lanes_user) | `bool` |  |
| [Num_downstream_circulating_lanes](#num_downstream_circulating_lanes) | `int` |  |
| [Circulating_width](#circulating_width) | `float` |  |
| [Island_diameter](#island_diameter) | `float` |  |
| [Inscribed_diameter_user](#inscribed_diameter_user) | `bool` |  |
| [Inscribed_diameter](#inscribed_diameter) | `float` |  |
| [Entry_radius](#entry_radius) | `float` |  |
| [Entry_angle](#entry_angle) | `float` |  |
| [Is_raindrop_design](#is_raindrop_design) | `bool` |  |
| [Circulating_transition_line](#circulating_transition_line) | `bool` |  |
| [Environment_factor_user](#environment_factor_user) | `bool` | Flag indicating whether the Environment Factor is given by user or program. This flag is not in use anymore. Environment Factor user-given value "Environment_factor" is applied when SIDRA Standard Roundabout Capacity Model is selected. |
| [Environment_factor](#environment_factor) | `float` |  |
| [Entry_circ_adj_user](#entry_circ_adj_user) | `bool` | Flag indicating whether the Roundabout Entry/Circulating Flow Adjustment Option is given by user or program. This flag is not in use anymore. Entry/Circulating Flow Adjustment Option user-given value "Entry_circ_adj" is applied when SIDRA Standard Roundabout Capacity Model is selected. |
| [Entry_circ_adj](#entry_circ_adj) | `int` | Roundabout Entry/Circulating Flow Adjustment |
| [App_half_width](#app_half_width) | `float` |  |
| [Flare_length](#flare_length) | `float` |  |
| [Capacity_at_zero_flow_user](#capacity_at_zero_flow_user) | `bool` |  |
| [Capacity_at_zero_flow](#capacity_at_zero_flow) | `float` |  |
| [Grade_separated](#grade_separated) | `bool` |  |
| [Leg](#leg) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) |  |
| [LegRouHCM2010](#legrouhcm2010) | [`ISIAPILeg_rou_hcm`](sidrasolutions.si.api.isiapileg_rou_hcm.md) |  |
| [LegRouHCM6](#legrouhcm6) | [`ISIAPILeg_rou_hcm`](sidrasolutions.si.api.isiapileg_rou_hcm.md) |  |
| [LegRouHCM6Extended](#legrouhcm6extended) | [`ISIAPILeg_rou_hcm6_extended`](sidrasolutions.si.api.isiapileg_rou_hcm6_extended.md) |  |
| [Is_turbo_island](#is_turbo_island) | `bool` | Flag indicating whether a Turbo Island design applies to this Leg. |

</div>

## Properties

### Num_circulating_lanes {#num_circulating_lanes}

```csharp
int Num_circulating_lanes { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int num_circulating_lanes = leg_roundabout.Num_circulating_lanes;
        leg_roundabout.Num_circulating_lanes = 1;
        ```

    === "C++"

        ```cpp
        long num_circulating_lanes;
        leg_roundabout->get_Num_circulating_lanes(&num_circulating_lanes);
        leg_roundabout->put_Num_circulating_lanes(1);
        ```

    === "Python"

        ```python
        num_circulating_lanes = leg_roundabout.Num_circulating_lanes
        leg_roundabout.Num_circulating_lanes = 1
        ```

### Num_downstream_circulating_lanes_user {#num_downstream_circulating_lanes_user}

```csharp
bool Num_downstream_circulating_lanes_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool num_downstream_circulating_lanes_user = leg_roundabout.Num_downstream_circulating_lanes_user;
        leg_roundabout.Num_downstream_circulating_lanes_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL num_downstream_circulating_lanes_user;
        leg_roundabout->get_Num_downstream_circulating_lanes_user(&num_downstream_circulating_lanes_user);
        leg_roundabout->put_Num_downstream_circulating_lanes_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        num_downstream_circulating_lanes_user = leg_roundabout.Num_downstream_circulating_lanes_user
        leg_roundabout.Num_downstream_circulating_lanes_user = True
        ```

### Num_downstream_circulating_lanes {#num_downstream_circulating_lanes}

```csharp
int Num_downstream_circulating_lanes { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int num_downstream_circulating_lanes = leg_roundabout.Num_downstream_circulating_lanes;
        leg_roundabout.Num_downstream_circulating_lanes = 1;
        ```

    === "C++"

        ```cpp
        long num_downstream_circulating_lanes;
        leg_roundabout->get_Num_downstream_circulating_lanes(&num_downstream_circulating_lanes);
        leg_roundabout->put_Num_downstream_circulating_lanes(1);
        ```

    === "Python"

        ```python
        num_downstream_circulating_lanes = leg_roundabout.Num_downstream_circulating_lanes
        leg_roundabout.Num_downstream_circulating_lanes = 1
        ```

### Circulating_width {#circulating_width}

```csharp
float Circulating_width { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float circulating_width = leg_roundabout.Circulating_width;
        leg_roundabout.Circulating_width = 0.0;
        ```

    === "C++"

        ```cpp
        double circulating_width;
        leg_roundabout->get_Circulating_width(&circulating_width);
        leg_roundabout->put_Circulating_width(0.0);
        ```

    === "Python"

        ```python
        circulating_width = leg_roundabout.Circulating_width
        leg_roundabout.Circulating_width = 0.0
        ```

### Island_diameter {#island_diameter}

```csharp
float Island_diameter { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float island_diameter = leg_roundabout.Island_diameter;
        leg_roundabout.Island_diameter = 0.0;
        ```

    === "C++"

        ```cpp
        double island_diameter;
        leg_roundabout->get_Island_diameter(&island_diameter);
        leg_roundabout->put_Island_diameter(0.0);
        ```

    === "Python"

        ```python
        island_diameter = leg_roundabout.Island_diameter
        leg_roundabout.Island_diameter = 0.0
        ```

### Inscribed_diameter_user {#inscribed_diameter_user}

```csharp
bool Inscribed_diameter_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool inscribed_diameter_user = leg_roundabout.Inscribed_diameter_user;
        leg_roundabout.Inscribed_diameter_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL inscribed_diameter_user;
        leg_roundabout->get_Inscribed_diameter_user(&inscribed_diameter_user);
        leg_roundabout->put_Inscribed_diameter_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        inscribed_diameter_user = leg_roundabout.Inscribed_diameter_user
        leg_roundabout.Inscribed_diameter_user = True
        ```

### Inscribed_diameter {#inscribed_diameter}

```csharp
float Inscribed_diameter { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float inscribed_diameter = leg_roundabout.Inscribed_diameter;
        leg_roundabout.Inscribed_diameter = 0.0;
        ```

    === "C++"

        ```cpp
        double inscribed_diameter;
        leg_roundabout->get_Inscribed_diameter(&inscribed_diameter);
        leg_roundabout->put_Inscribed_diameter(0.0);
        ```

    === "Python"

        ```python
        inscribed_diameter = leg_roundabout.Inscribed_diameter
        leg_roundabout.Inscribed_diameter = 0.0
        ```

### Entry_radius {#entry_radius}

```csharp
float Entry_radius { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float entry_radius = leg_roundabout.Entry_radius;
        leg_roundabout.Entry_radius = 0.0;
        ```

    === "C++"

        ```cpp
        double entry_radius;
        leg_roundabout->get_Entry_radius(&entry_radius);
        leg_roundabout->put_Entry_radius(0.0);
        ```

    === "Python"

        ```python
        entry_radius = leg_roundabout.Entry_radius
        leg_roundabout.Entry_radius = 0.0
        ```

### Entry_angle {#entry_angle}

```csharp
float Entry_angle { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float entry_angle = leg_roundabout.Entry_angle;
        leg_roundabout.Entry_angle = 0.0;
        ```

    === "C++"

        ```cpp
        double entry_angle;
        leg_roundabout->get_Entry_angle(&entry_angle);
        leg_roundabout->put_Entry_angle(0.0);
        ```

    === "Python"

        ```python
        entry_angle = leg_roundabout.Entry_angle
        leg_roundabout.Entry_angle = 0.0
        ```

### Is_raindrop_design {#is_raindrop_design}

```csharp
bool Is_raindrop_design { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_raindrop_design = leg_roundabout.Is_raindrop_design;
        leg_roundabout.Is_raindrop_design = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_raindrop_design;
        leg_roundabout->get_Is_raindrop_design(&is_raindrop_design);
        leg_roundabout->put_Is_raindrop_design(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_raindrop_design = leg_roundabout.Is_raindrop_design
        leg_roundabout.Is_raindrop_design = True
        ```

### Circulating_transition_line {#circulating_transition_line}

```csharp
bool Circulating_transition_line { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool circulating_transition_line = leg_roundabout.Circulating_transition_line;
        leg_roundabout.Circulating_transition_line = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL circulating_transition_line;
        leg_roundabout->get_Circulating_transition_line(&circulating_transition_line);
        leg_roundabout->put_Circulating_transition_line(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        circulating_transition_line = leg_roundabout.Circulating_transition_line
        leg_roundabout.Circulating_transition_line = True
        ```

### Environment_factor_user {#environment_factor_user}

Flag indicating whether the Environment Factor is given by user or program.  
This flag is not in use anymore. Environment Factor user-given value "Environment_factor" is applied 
when SIDRA Standard Roundabout Capacity Model is selected.

```csharp
bool Environment_factor_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool environment_factor_user = leg_roundabout.Environment_factor_user;
        leg_roundabout.Environment_factor_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL environment_factor_user;
        leg_roundabout->get_Environment_factor_user(&environment_factor_user);
        leg_roundabout->put_Environment_factor_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        environment_factor_user = leg_roundabout.Environment_factor_user
        leg_roundabout.Environment_factor_user = True
        ```

### Environment_factor {#environment_factor}

```csharp
float Environment_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float environment_factor = leg_roundabout.Environment_factor;
        leg_roundabout.Environment_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double environment_factor;
        leg_roundabout->get_Environment_factor(&environment_factor);
        leg_roundabout->put_Environment_factor(0.0);
        ```

    === "Python"

        ```python
        environment_factor = leg_roundabout.Environment_factor
        leg_roundabout.Environment_factor = 0.0
        ```

### Entry_circ_adj_user {#entry_circ_adj_user}

Flag indicating whether the Roundabout Entry/Circulating Flow Adjustment Option is given by user or program.  
This flag is not in use anymore. Entry/Circulating Flow Adjustment Option user-given value "Entry_circ_adj" is applied 
when SIDRA Standard Roundabout Capacity Model is selected.

```csharp
bool Entry_circ_adj_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool entry_circ_adj_user = leg_roundabout.Entry_circ_adj_user;
        leg_roundabout.Entry_circ_adj_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL entry_circ_adj_user;
        leg_roundabout->get_Entry_circ_adj_user(&entry_circ_adj_user);
        leg_roundabout->put_Entry_circ_adj_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        entry_circ_adj_user = leg_roundabout.Entry_circ_adj_user
        leg_roundabout.Entry_circ_adj_user = True
        ```

### Entry_circ_adj {#entry_circ_adj}

Roundabout Entry/Circulating Flow Adjustment

```csharp
int Entry_circ_adj { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Low
- `2` - Medium
- `3` - High

???- example "Code samples"

    === "C#"

        ```csharp
        int entry_circ_adj = leg_roundabout.Entry_circ_adj;
        leg_roundabout.Entry_circ_adj = 0;
        ```

    === "C++"

        ```cpp
        long entry_circ_adj;
        leg_roundabout->get_Entry_circ_adj(&entry_circ_adj);
        leg_roundabout->put_Entry_circ_adj(0);
        ```

    === "Python"

        ```python
        entry_circ_adj = leg_roundabout.Entry_circ_adj
        leg_roundabout.Entry_circ_adj = 0
        ```

### App_half_width {#app_half_width}

```csharp
float App_half_width { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float app_half_width = leg_roundabout.App_half_width;
        leg_roundabout.App_half_width = 0.0;
        ```

    === "C++"

        ```cpp
        double app_half_width;
        leg_roundabout->get_App_half_width(&app_half_width);
        leg_roundabout->put_App_half_width(0.0);
        ```

    === "Python"

        ```python
        app_half_width = leg_roundabout.App_half_width
        leg_roundabout.App_half_width = 0.0
        ```

### Flare_length {#flare_length}

```csharp
float Flare_length { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flare_length = leg_roundabout.Flare_length;
        leg_roundabout.Flare_length = 0.0;
        ```

    === "C++"

        ```cpp
        double flare_length;
        leg_roundabout->get_Flare_length(&flare_length);
        leg_roundabout->put_Flare_length(0.0);
        ```

    === "Python"

        ```python
        flare_length = leg_roundabout.Flare_length
        leg_roundabout.Flare_length = 0.0
        ```

### Capacity_at_zero_flow_user {#capacity_at_zero_flow_user}

```csharp
bool Capacity_at_zero_flow_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool capacity_at_zero_flow_user = leg_roundabout.Capacity_at_zero_flow_user;
        leg_roundabout.Capacity_at_zero_flow_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL capacity_at_zero_flow_user;
        leg_roundabout->get_Capacity_at_zero_flow_user(&capacity_at_zero_flow_user);
        leg_roundabout->put_Capacity_at_zero_flow_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        capacity_at_zero_flow_user = leg_roundabout.Capacity_at_zero_flow_user
        leg_roundabout.Capacity_at_zero_flow_user = True
        ```

### Capacity_at_zero_flow {#capacity_at_zero_flow}

```csharp
float Capacity_at_zero_flow { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_at_zero_flow = leg_roundabout.Capacity_at_zero_flow;
        leg_roundabout.Capacity_at_zero_flow = 0.0;
        ```

    === "C++"

        ```cpp
        double capacity_at_zero_flow;
        leg_roundabout->get_Capacity_at_zero_flow(&capacity_at_zero_flow);
        leg_roundabout->put_Capacity_at_zero_flow(0.0);
        ```

    === "Python"

        ```python
        capacity_at_zero_flow = leg_roundabout.Capacity_at_zero_flow
        leg_roundabout.Capacity_at_zero_flow = 0.0
        ```

### Grade_separated {#grade_separated}

```csharp
bool Grade_separated { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool grade_separated = leg_roundabout.Grade_separated;
        leg_roundabout.Grade_separated = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL grade_separated;
        leg_roundabout->get_Grade_separated(&grade_separated);
        leg_roundabout->put_Grade_separated(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        grade_separated = leg_roundabout.Grade_separated
        leg_roundabout.Grade_separated = True
        ```

### Leg {#leg}

```csharp
ISIAPILeg Leg { get; }
```

**Type** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var leg = leg_roundabout.Leg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> leg;
        leg_roundabout->get_Leg(&leg);
        ```

    === "Python"

        ```python
        leg = leg_roundabout.Leg
        ```

### LegRouHCM2010 {#legrouhcm2010}

```csharp
ISIAPILeg_rou_hcm LegRouHCM2010 { get; }
```

**Type** [`ISIAPILeg_rou_hcm`](sidrasolutions.si.api.isiapileg_rou_hcm.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var legRouHCM2010 = leg_roundabout.LegRouHCM2010;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_rou_hcm> legRouHCM2010;
        leg_roundabout->get_LegRouHCM2010(&legRouHCM2010);
        ```

    === "Python"

        ```python
        leg_rou_hcm2010 = leg_roundabout.LegRouHCM2010
        ```

### LegRouHCM6 {#legrouhcm6}

```csharp
ISIAPILeg_rou_hcm LegRouHCM6 { get; }
```

**Type** [`ISIAPILeg_rou_hcm`](sidrasolutions.si.api.isiapileg_rou_hcm.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var legRouHCM6 = leg_roundabout.LegRouHCM6;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_rou_hcm> legRouHCM6;
        leg_roundabout->get_LegRouHCM6(&legRouHCM6);
        ```

    === "Python"

        ```python
        leg_rou_hcm6 = leg_roundabout.LegRouHCM6
        ```

### LegRouHCM6Extended {#legrouhcm6extended}

```csharp
ISIAPILeg_rou_hcm6_extended LegRouHCM6Extended { get; }
```

**Type** [`ISIAPILeg_rou_hcm6_extended`](sidrasolutions.si.api.isiapileg_rou_hcm6_extended.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var legRouHCM6Extended = leg_roundabout.LegRouHCM6Extended;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg_rou_hcm6_extended> legRouHCM6Extended;
        leg_roundabout->get_LegRouHCM6Extended(&legRouHCM6Extended);
        ```

    === "Python"

        ```python
        leg_rou_hcm6_extended = leg_roundabout.LegRouHCM6Extended
        ```

### Is_turbo_island {#is_turbo_island}

Flag indicating whether a Turbo Island design applies to this Leg.

```csharp
bool Is_turbo_island { get; set; }
```

**Type** `bool`

**Remarks**

This flag can be changed only in a Turbo Roundabout Site.

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_turbo_island = leg_roundabout.Is_turbo_island;
        leg_roundabout.Is_turbo_island = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_turbo_island;
        leg_roundabout->get_Is_turbo_island(&is_turbo_island);
        leg_roundabout->put_Is_turbo_island(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_turbo_island = leg_roundabout.Is_turbo_island
        leg_roundabout.Is_turbo_island = True
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapilegs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPILegs
title: Legs
name: ISIAPILegs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2FE4DC80-7A11-44B8-8785-5456BDB7CA76
members:
  - bool LegExists(int orientation)
  - ISIAPILeg this[int orientation]
  - int Count
---

# Legs

Type `ISIAPILegs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2FE4DC80-7A11-44B8-8785-5456BDB7CA76`

## Declaration

```csharp
[Guid("2FE4DC80-7A11-44B8-8785-5456BDB7CA76")]
public interface ISIAPILegs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) | Get a Leg. Return a Leg if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LegExists(int)](#legexists-int) | `bool` | Get a value indicating whether a Leg exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = legs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        legs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = legs.Count
        ```

### this[] {#this}

Get a Leg.  
Return a Leg if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPILeg this[] { get; }
```

**Type** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = legs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> this[];
        legs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = legs.this[]
        ```

## Methods

### LegExists(int) {#legexists-int}

Get a value indicating whether a Leg exists in the data storage.

```csharp
bool LegExists(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = legs.LegExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        legs->LegExists(0, &result);
        ```

    === "Python"

        ```python
        result = legs.LegExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimapcoordinate.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMapCoordinate
title: MapCoordinate
name: ISIAPIMapCoordinate
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 94D6A286-EDD1-4B53-B777-C74D9BED9909
members:
  - double Latitude
  - double Longitude
---

# MapCoordinate

Type `ISIAPIMapCoordinate` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `94D6A286-EDD1-4B53-B777-C74D9BED9909`

## Declaration

```csharp
[Guid("94D6A286-EDD1-4B53-B777-C74D9BED9909")]
public interface ISIAPIMapCoordinate
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Latitude](#latitude) | `double` |  |
| [Longitude](#longitude) | `double` |  |

</div>

## Properties

### Latitude {#latitude}

```csharp
double Latitude { get; set; }
```

**Type** `double`

???- example "Code samples"

    === "C#"

        ```csharp
        double latitude = mapCoordinate.Latitude;
        mapCoordinate.Latitude = 0.0;
        ```

    === "C++"

        ```cpp
        double latitude;
        mapCoordinate->get_Latitude(&latitude);
        mapCoordinate->put_Latitude(0.0);
        ```

    === "Python"

        ```python
        latitude = mapCoordinate.Latitude
        mapCoordinate.Latitude = 0.0
        ```

### Longitude {#longitude}

```csharp
double Longitude { get; set; }
```

**Type** `double`

???- example "Code samples"

    === "C#"

        ```csharp
        double longitude = mapCoordinate.Longitude;
        mapCoordinate.Longitude = 0.0;
        ```

    === "C++"

        ```cpp
        double longitude;
        mapCoordinate->get_Longitude(&longitude);
        mapCoordinate->put_Longitude(0.0);
        ```

    === "Python"

        ```python
        longitude = mapCoordinate.Longitude
        mapCoordinate.Longitude = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimodelsetting.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIModelSetting
title: ModelSetting
name: ISIAPIModelSetting
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4B40EE6F-F715-40BB-857A-7DF9E7335AA9
summary: SIDRA INTERSECTION Model Setting wrapper interface
members:
  - int LOS_Method
  - int LOS_Target
  - int Performance_Measure
  - int Percentile_Queue
  - int Hours_per_Year
  - int Reduct_opposing_flow_rate_level
  - float Major_road_turn_flow_factor
  - int Gap_Acceptance_Capacity
  - int Rou_Capacity_Model
  - int Rou_LOS_Method
  - bool Rou_HCM_2010_OD_pattern_effects_included
  - bool Rou_FHWA_2000_model_applied
  - bool Rou_FHWA_2000_Urban_compact_applied
  - bool Rou_HCM_2000_model_applied
  - bool Rou_NAASRA_1986_model_applied
  - bool Is_ped_cost_included
  - float Ped_average_income
  - float Ped_time_value_factor
  - bool Shortlane_queue_storage_ratio_incl
  - float Min_prob_blockage
  - bool Is_geometric_delay_excluded
  - bool Is_hcm_delay_formula_applied
  - float Downstream_SL_Util_Ratio_Min
  - float Downstream_SL_Distance_Min
  - float Downstream_SL_Distance_FullLaneUtil
  - float Downstream_SL_CalibrationParameter
  - int Ped_los_target
  - int Percentile_queue_option
  - bool Rou_HCM_6_OD_pattern_effects_included
  - bool Is_hcm_queue_formula_applied
  - float Platoon_front_factor
  - float Platoon_disp_factor_min
  - float Platoon_disp_factor_max
  - float Platoon_disp_distance_min
  - float Platoon_disp_distance_max
  - float Platoon_disp_n
  - int Ped_LOS_Method
  - string Calibration_note
  - float Midblock_eff_det_zone_len
  - bool Is_hcm6_extended_applied
  - bool Shortlane_upstream_delay_stops_included
---

# ModelSetting

Type `ISIAPIModelSetting` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4B40EE6F-F715-40BB-857A-7DF9E7335AA9`

SIDRA INTERSECTION Model Setting wrapper interface

## Declaration

```csharp
[Guid("4B40EE6F-F715-40BB-857A-7DF9E7335AA9")]
public interface ISIAPIModelSetting
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [LOS_Method](#los_method) | `int` | Level of Service Method |
| [LOS_Target](#los_target) | `int` | Level of Service Target |
| [Performance_Measure](#performance_measure) | `int` | Performance Measure |
| [Percentile_Queue](#percentile_queue) | `int` |  |
| [Hours_per_Year](#hours_per_year) | `int` |  |
| [Reduct_opposing_flow_rate_level](#reduct_opposing_flow_rate_level) | `int` | Level of Reduction with Opposing Flow Rate (for Two-Way Sign Control Calibration) |
| [Major_road_turn_flow_factor](#major_road_turn_flow_factor) | `float` |  |
| [Gap_Acceptance_Capacity](#gap_acceptance_capacity) | `int` | Gap Acceptance Capacity |
| [Rou_Capacity_Model](#rou_capacity_model) | `int` | Roundabout Capacity Model |
| [Rou_LOS_Method](#rou_los_method) | `int` | Roundabout LOS Method |
| [Rou_HCM_2010_OD_pattern_effects_included](#rou_hcm_2010_od_pattern_effects_included) | `bool` |  |
| [Rou_FHWA_2000_model_applied](#rou_fhwa_2000_model_applied) | `bool` |  |
| [Rou_FHWA_2000_Urban_compact_applied](#rou_fhwa_2000_urban_compact_applied) | `bool` |  |
| [Rou_HCM_2000_model_applied](#rou_hcm_2000_model_applied) | `bool` |  |
| [Rou_NAASRA_1986_model_applied](#rou_naasra_1986_model_applied) | `bool` |  |
| [Is_ped_cost_included](#is_ped_cost_included) | `bool` |  |
| [Ped_average_income](#ped_average_income) | `float` |  |
| [Ped_time_value_factor](#ped_time_value_factor) | `float` |  |
| [Shortlane_queue_storage_ratio_incl](#shortlane_queue_storage_ratio_incl) | `bool` |  |
| [Min_prob_blockage](#min_prob_blockage) | `float` |  |
| [Is_geometric_delay_excluded](#is_geometric_delay_excluded) | `bool` |  |
| [Is_hcm_delay_formula_applied](#is_hcm_delay_formula_applied) | `bool` |  |
| [Downstream_SL_Util_Ratio_Min](#downstream_sl_util_ratio_min) | `float` |  |
| [Downstream_SL_Distance_Min](#downstream_sl_distance_min) | `float` |  |
| [Downstream_SL_Distance_FullLaneUtil](#downstream_sl_distance_fulllaneutil) | `float` |  |
| [Downstream_SL_CalibrationParameter](#downstream_sl_calibrationparameter) | `float` |  |
| [Ped_los_target](#ped_los_target) | `int` | Pedestrian Level of Service Target |
| [Percentile_queue_option](#percentile_queue_option) | `int` | Percentile Queue Option |
| [Rou_HCM_6_OD_pattern_effects_included](#rou_hcm_6_od_pattern_effects_included) | `bool` |  |
| [Is_hcm_queue_formula_applied](#is_hcm_queue_formula_applied) | `bool` |  |
| [Platoon_front_factor](#platoon_front_factor) | `float` |  |
| [Platoon_disp_factor_min](#platoon_disp_factor_min) | `float` |  |
| [Platoon_disp_factor_max](#platoon_disp_factor_max) | `float` |  |
| [Platoon_disp_distance_min](#platoon_disp_distance_min) | `float` |  |
| [Platoon_disp_distance_max](#platoon_disp_distance_max) | `float` |  |
| [Platoon_disp_n](#platoon_disp_n) | `float` |  |
| [Ped_LOS_Method](#ped_los_method) | `int` |  |
| [Calibration_note](#calibration_note) | `string` |  |
| [Midblock_eff_det_zone_len](#midblock_eff_det_zone_len) | `float` | Midblock Effective Detection Zone Length |
| [Is_hcm6_extended_applied](#is_hcm6_extended_applied) | `bool` |  |
| [Shortlane_upstream_delay_stops_included](#shortlane_upstream_delay_stops_included) | `bool` |  |

</div>

## Properties

### LOS_Method {#los_method}

Level of Service Method

```csharp
int LOS_Method { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Delay (SIDRA)
- `1` - Degree of Saturation (SIDRA)
- `2` - Delay and v/c (HCM 2010)
- `3` - Delay (NSW)
- `4` - Degree of Saturation (ICU)
- `5` - Delay and Degree of Saturation (SIDRA)
- `6` - Delay and v/c (HCM 6)

???- example "Code samples"

    === "C#"

        ```csharp
        int lOS_Method = modelSetting.LOS_Method;
        modelSetting.LOS_Method = 0;
        ```

    === "C++"

        ```cpp
        long lOS_Method;
        modelSetting->get_LOS_Method(&lOS_Method);
        modelSetting->put_LOS_Method(0);
        ```

    === "Python"

        ```python
        los__method = modelSetting.LOS_Method
        modelSetting.LOS_Method = 0
        ```

### LOS_Target {#los_target}

Level of Service Target

```csharp
int LOS_Target { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - LOS A
- `2` - LOS B
- `3` - LOS C
- `4` - LOS D
- `5` - LOS E
- `6` - LOS F

???- example "Code samples"

    === "C#"

        ```csharp
        int lOS_Target = modelSetting.LOS_Target;
        modelSetting.LOS_Target = 0;
        ```

    === "C++"

        ```cpp
        long lOS_Target;
        modelSetting->get_LOS_Target(&lOS_Target);
        modelSetting->put_LOS_Target(0);
        ```

    === "Python"

        ```python
        los__target = modelSetting.LOS_Target
        modelSetting.LOS_Target = 0
        ```

### Performance_Measure {#performance_measure}

Performance Measure

```csharp
int Performance_Measure { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Delay
- `1` - Queue
- `2` - Stop Rate
- `3` - Performance Index
- `4` - Degree of Saturation
- `5` - Capacity
- `6` - Spare Capacity
- `7` - Cost
- `8` - Fuel
- `9` - CO2
- `10` - HC
- `11` - CO
- `12` - NOx

???- example "Code samples"

    === "C#"

        ```csharp
        int performance_Measure = modelSetting.Performance_Measure;
        modelSetting.Performance_Measure = 0;
        ```

    === "C++"

        ```cpp
        long performance_Measure;
        modelSetting->get_Performance_Measure(&performance_Measure);
        modelSetting->put_Performance_Measure(0);
        ```

    === "Python"

        ```python
        performance__measure = modelSetting.Performance_Measure
        modelSetting.Performance_Measure = 0
        ```

### Percentile_Queue {#percentile_queue}

```csharp
int Percentile_Queue { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int percentile_Queue = modelSetting.Percentile_Queue;
        modelSetting.Percentile_Queue = 0;
        ```

    === "C++"

        ```cpp
        long percentile_Queue;
        modelSetting->get_Percentile_Queue(&percentile_Queue);
        modelSetting->put_Percentile_Queue(0);
        ```

    === "Python"

        ```python
        percentile__queue = modelSetting.Percentile_Queue
        modelSetting.Percentile_Queue = 0
        ```

### Hours_per_Year {#hours_per_year}

```csharp
int Hours_per_Year { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int hours_per_Year = modelSetting.Hours_per_Year;
        modelSetting.Hours_per_Year = 0;
        ```

    === "C++"

        ```cpp
        long hours_per_Year;
        modelSetting->get_Hours_per_Year(&hours_per_Year);
        modelSetting->put_Hours_per_Year(0);
        ```

    === "Python"

        ```python
        hours_per__year = modelSetting.Hours_per_Year
        modelSetting.Hours_per_Year = 0
        ```

### Reduct_opposing_flow_rate_level {#reduct_opposing_flow_rate_level}

Level of Reduction with Opposing Flow Rate (for Two-Way Sign Control Calibration)

```csharp
int Reduct_opposing_flow_rate_level { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Low
- `2` - Medium
- `3` - High

???- example "Code samples"

    === "C#"

        ```csharp
        int reduct_opposing_flow_rate_level = modelSetting.Reduct_opposing_flow_rate_level;
        modelSetting.Reduct_opposing_flow_rate_level = 0;
        ```

    === "C++"

        ```cpp
        long reduct_opposing_flow_rate_level;
        modelSetting->get_Reduct_opposing_flow_rate_level(&reduct_opposing_flow_rate_level);
        modelSetting->put_Reduct_opposing_flow_rate_level(0);
        ```

    === "Python"

        ```python
        reduct_opposing_flow_rate_level = modelSetting.Reduct_opposing_flow_rate_level
        modelSetting.Reduct_opposing_flow_rate_level = 0
        ```

### Major_road_turn_flow_factor {#major_road_turn_flow_factor}

```csharp
float Major_road_turn_flow_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float major_road_turn_flow_factor = modelSetting.Major_road_turn_flow_factor;
        modelSetting.Major_road_turn_flow_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double major_road_turn_flow_factor;
        modelSetting->get_Major_road_turn_flow_factor(&major_road_turn_flow_factor);
        modelSetting->put_Major_road_turn_flow_factor(0.0);
        ```

    === "Python"

        ```python
        major_road_turn_flow_factor = modelSetting.Major_road_turn_flow_factor
        modelSetting.Major_road_turn_flow_factor = 0.0
        ```

### Gap_Acceptance_Capacity {#gap_acceptance_capacity}

Gap Acceptance Capacity

```csharp
int Gap_Acceptance_Capacity { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - SIDRA Standard (Akcelik M3D)
- `1` - Akcelik M1
- `2` - Siegloch M1
- `3` - Traditional M1

???- example "Code samples"

    === "C#"

        ```csharp
        int gap_Acceptance_Capacity = modelSetting.Gap_Acceptance_Capacity;
        modelSetting.Gap_Acceptance_Capacity = 0;
        ```

    === "C++"

        ```cpp
        long gap_Acceptance_Capacity;
        modelSetting->get_Gap_Acceptance_Capacity(&gap_Acceptance_Capacity);
        modelSetting->put_Gap_Acceptance_Capacity(0);
        ```

    === "Python"

        ```python
        gap__acceptance__capacity = modelSetting.Gap_Acceptance_Capacity
        modelSetting.Gap_Acceptance_Capacity = 0
        ```

### Rou_Capacity_Model {#rou_capacity_model}

Roundabout Capacity Model

```csharp
int Rou_Capacity_Model { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - SIDRA Standard
- `1` - HCM 2010

???- example "Code samples"

    === "C#"

        ```csharp
        int rou_Capacity_Model = modelSetting.Rou_Capacity_Model;
        modelSetting.Rou_Capacity_Model = 0;
        ```

    === "C++"

        ```cpp
        long rou_Capacity_Model;
        modelSetting->get_Rou_Capacity_Model(&rou_Capacity_Model);
        modelSetting->put_Rou_Capacity_Model(0);
        ```

    === "Python"

        ```python
        rou__capacity__model = modelSetting.Rou_Capacity_Model
        modelSetting.Rou_Capacity_Model = 0
        ```

### Rou_LOS_Method {#rou_los_method}

Roundabout LOS Method

```csharp
int Rou_LOS_Method { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - SIDRA Roundabout LOS
- `1` - Same as Signalised Intersections
- `2` - Same as Sign Control

???- example "Code samples"

    === "C#"

        ```csharp
        int rou_LOS_Method = modelSetting.Rou_LOS_Method;
        modelSetting.Rou_LOS_Method = 0;
        ```

    === "C++"

        ```cpp
        long rou_LOS_Method;
        modelSetting->get_Rou_LOS_Method(&rou_LOS_Method);
        modelSetting->put_Rou_LOS_Method(0);
        ```

    === "Python"

        ```python
        rou_los__method = modelSetting.Rou_LOS_Method
        modelSetting.Rou_LOS_Method = 0
        ```

### Rou_HCM_2010_OD_pattern_effects_included {#rou_hcm_2010_od_pattern_effects_included}

```csharp
bool Rou_HCM_2010_OD_pattern_effects_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_HCM_2010_OD_pattern_effects_included = modelSetting.Rou_HCM_2010_OD_pattern_effects_included;
        modelSetting.Rou_HCM_2010_OD_pattern_effects_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_HCM_2010_OD_pattern_effects_included;
        modelSetting->get_Rou_HCM_2010_OD_pattern_effects_included(&rou_HCM_2010_OD_pattern_effects_included);
        modelSetting->put_Rou_HCM_2010_OD_pattern_effects_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_hcm_2010_od_pattern_effects_included = modelSetting.Rou_HCM_2010_OD_pattern_effects_included
        modelSetting.Rou_HCM_2010_OD_pattern_effects_included = True
        ```

### Rou_FHWA_2000_model_applied {#rou_fhwa_2000_model_applied}

```csharp
bool Rou_FHWA_2000_model_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_FHWA_2000_model_applied = modelSetting.Rou_FHWA_2000_model_applied;
        modelSetting.Rou_FHWA_2000_model_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_FHWA_2000_model_applied;
        modelSetting->get_Rou_FHWA_2000_model_applied(&rou_FHWA_2000_model_applied);
        modelSetting->put_Rou_FHWA_2000_model_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_fhwa_2000_model_applied = modelSetting.Rou_FHWA_2000_model_applied
        modelSetting.Rou_FHWA_2000_model_applied = True
        ```

### Rou_FHWA_2000_Urban_compact_applied {#rou_fhwa_2000_urban_compact_applied}

```csharp
bool Rou_FHWA_2000_Urban_compact_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_FHWA_2000_Urban_compact_applied = modelSetting.Rou_FHWA_2000_Urban_compact_applied;
        modelSetting.Rou_FHWA_2000_Urban_compact_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_FHWA_2000_Urban_compact_applied;
        modelSetting->get_Rou_FHWA_2000_Urban_compact_applied(&rou_FHWA_2000_Urban_compact_applied);
        modelSetting->put_Rou_FHWA_2000_Urban_compact_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_fhwa_2000__urban_compact_applied = modelSetting.Rou_FHWA_2000_Urban_compact_applied
        modelSetting.Rou_FHWA_2000_Urban_compact_applied = True
        ```

### Rou_HCM_2000_model_applied {#rou_hcm_2000_model_applied}

```csharp
bool Rou_HCM_2000_model_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_HCM_2000_model_applied = modelSetting.Rou_HCM_2000_model_applied;
        modelSetting.Rou_HCM_2000_model_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_HCM_2000_model_applied;
        modelSetting->get_Rou_HCM_2000_model_applied(&rou_HCM_2000_model_applied);
        modelSetting->put_Rou_HCM_2000_model_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_hcm_2000_model_applied = modelSetting.Rou_HCM_2000_model_applied
        modelSetting.Rou_HCM_2000_model_applied = True
        ```

### Rou_NAASRA_1986_model_applied {#rou_naasra_1986_model_applied}

```csharp
bool Rou_NAASRA_1986_model_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_NAASRA_1986_model_applied = modelSetting.Rou_NAASRA_1986_model_applied;
        modelSetting.Rou_NAASRA_1986_model_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_NAASRA_1986_model_applied;
        modelSetting->get_Rou_NAASRA_1986_model_applied(&rou_NAASRA_1986_model_applied);
        modelSetting->put_Rou_NAASRA_1986_model_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_naasra_1986_model_applied = modelSetting.Rou_NAASRA_1986_model_applied
        modelSetting.Rou_NAASRA_1986_model_applied = True
        ```

### Is_ped_cost_included {#is_ped_cost_included}

```csharp
bool Is_ped_cost_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_ped_cost_included = modelSetting.Is_ped_cost_included;
        modelSetting.Is_ped_cost_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_ped_cost_included;
        modelSetting->get_Is_ped_cost_included(&is_ped_cost_included);
        modelSetting->put_Is_ped_cost_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_ped_cost_included = modelSetting.Is_ped_cost_included
        modelSetting.Is_ped_cost_included = True
        ```

### Ped_average_income {#ped_average_income}

```csharp
float Ped_average_income { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float ped_average_income = modelSetting.Ped_average_income;
        modelSetting.Ped_average_income = 0.0;
        ```

    === "C++"

        ```cpp
        double ped_average_income;
        modelSetting->get_Ped_average_income(&ped_average_income);
        modelSetting->put_Ped_average_income(0.0);
        ```

    === "Python"

        ```python
        ped_average_income = modelSetting.Ped_average_income
        modelSetting.Ped_average_income = 0.0
        ```

### Ped_time_value_factor {#ped_time_value_factor}

```csharp
float Ped_time_value_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float ped_time_value_factor = modelSetting.Ped_time_value_factor;
        modelSetting.Ped_time_value_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double ped_time_value_factor;
        modelSetting->get_Ped_time_value_factor(&ped_time_value_factor);
        modelSetting->put_Ped_time_value_factor(0.0);
        ```

    === "Python"

        ```python
        ped_time_value_factor = modelSetting.Ped_time_value_factor
        modelSetting.Ped_time_value_factor = 0.0
        ```

### Shortlane_queue_storage_ratio_incl {#shortlane_queue_storage_ratio_incl}

```csharp
bool Shortlane_queue_storage_ratio_incl { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool shortlane_queue_storage_ratio_incl = modelSetting.Shortlane_queue_storage_ratio_incl;
        modelSetting.Shortlane_queue_storage_ratio_incl = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL shortlane_queue_storage_ratio_incl;
        modelSetting->get_Shortlane_queue_storage_ratio_incl(&shortlane_queue_storage_ratio_incl);
        modelSetting->put_Shortlane_queue_storage_ratio_incl(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        shortlane_queue_storage_ratio_incl = modelSetting.Shortlane_queue_storage_ratio_incl
        modelSetting.Shortlane_queue_storage_ratio_incl = True
        ```

### Min_prob_blockage {#min_prob_blockage}

```csharp
float Min_prob_blockage { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_prob_blockage = modelSetting.Min_prob_blockage;
        modelSetting.Min_prob_blockage = 0.0;
        ```

    === "C++"

        ```cpp
        double min_prob_blockage;
        modelSetting->get_Min_prob_blockage(&min_prob_blockage);
        modelSetting->put_Min_prob_blockage(0.0);
        ```

    === "Python"

        ```python
        min_prob_blockage = modelSetting.Min_prob_blockage
        modelSetting.Min_prob_blockage = 0.0
        ```

### Is_geometric_delay_excluded {#is_geometric_delay_excluded}

```csharp
bool Is_geometric_delay_excluded { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_geometric_delay_excluded = modelSetting.Is_geometric_delay_excluded;
        modelSetting.Is_geometric_delay_excluded = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_geometric_delay_excluded;
        modelSetting->get_Is_geometric_delay_excluded(&is_geometric_delay_excluded);
        modelSetting->put_Is_geometric_delay_excluded(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_geometric_delay_excluded = modelSetting.Is_geometric_delay_excluded
        modelSetting.Is_geometric_delay_excluded = True
        ```

### Is_hcm_delay_formula_applied {#is_hcm_delay_formula_applied}

```csharp
bool Is_hcm_delay_formula_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_hcm_delay_formula_applied = modelSetting.Is_hcm_delay_formula_applied;
        modelSetting.Is_hcm_delay_formula_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_hcm_delay_formula_applied;
        modelSetting->get_Is_hcm_delay_formula_applied(&is_hcm_delay_formula_applied);
        modelSetting->put_Is_hcm_delay_formula_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_hcm_delay_formula_applied = modelSetting.Is_hcm_delay_formula_applied
        modelSetting.Is_hcm_delay_formula_applied = True
        ```

### Downstream_SL_Util_Ratio_Min {#downstream_sl_util_ratio_min}

```csharp
float Downstream_SL_Util_Ratio_Min { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float downstream_SL_Util_Ratio_Min = modelSetting.Downstream_SL_Util_Ratio_Min;
        modelSetting.Downstream_SL_Util_Ratio_Min = 0.0;
        ```

    === "C++"

        ```cpp
        double downstream_SL_Util_Ratio_Min;
        modelSetting->get_Downstream_SL_Util_Ratio_Min(&downstream_SL_Util_Ratio_Min);
        modelSetting->put_Downstream_SL_Util_Ratio_Min(0.0);
        ```

    === "Python"

        ```python
        downstream_sl__util__ratio__min = modelSetting.Downstream_SL_Util_Ratio_Min
        modelSetting.Downstream_SL_Util_Ratio_Min = 0.0
        ```

### Downstream_SL_Distance_Min {#downstream_sl_distance_min}

```csharp
float Downstream_SL_Distance_Min { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float downstream_SL_Distance_Min = modelSetting.Downstream_SL_Distance_Min;
        modelSetting.Downstream_SL_Distance_Min = 0.0;
        ```

    === "C++"

        ```cpp
        double downstream_SL_Distance_Min;
        modelSetting->get_Downstream_SL_Distance_Min(&downstream_SL_Distance_Min);
        modelSetting->put_Downstream_SL_Distance_Min(0.0);
        ```

    === "Python"

        ```python
        downstream_sl__distance__min = modelSetting.Downstream_SL_Distance_Min
        modelSetting.Downstream_SL_Distance_Min = 0.0
        ```

### Downstream_SL_Distance_FullLaneUtil {#downstream_sl_distance_fulllaneutil}

```csharp
float Downstream_SL_Distance_FullLaneUtil { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float downstream_SL_Distance_FullLaneUtil = modelSetting.Downstream_SL_Distance_FullLaneUtil;
        modelSetting.Downstream_SL_Distance_FullLaneUtil = 0.0;
        ```

    === "C++"

        ```cpp
        double downstream_SL_Distance_FullLaneUtil;
        modelSetting->get_Downstream_SL_Distance_FullLaneUtil(&downstream_SL_Distance_FullLaneUtil);
        modelSetting->put_Downstream_SL_Distance_FullLaneUtil(0.0);
        ```

    === "Python"

        ```python
        downstream_sl__distance__full_lane_util = modelSetting.Downstream_SL_Distance_FullLaneUtil
        modelSetting.Downstream_SL_Distance_FullLaneUtil = 0.0
        ```

### Downstream_SL_CalibrationParameter {#downstream_sl_calibrationparameter}

```csharp
float Downstream_SL_CalibrationParameter { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float downstream_SL_CalibrationParameter = modelSetting.Downstream_SL_CalibrationParameter;
        modelSetting.Downstream_SL_CalibrationParameter = 0.0;
        ```

    === "C++"

        ```cpp
        double downstream_SL_CalibrationParameter;
        modelSetting->get_Downstream_SL_CalibrationParameter(&downstream_SL_CalibrationParameter);
        modelSetting->put_Downstream_SL_CalibrationParameter(0.0);
        ```

    === "Python"

        ```python
        downstream_sl__calibration_parameter = modelSetting.Downstream_SL_CalibrationParameter
        modelSetting.Downstream_SL_CalibrationParameter = 0.0
        ```

### Ped_los_target {#ped_los_target}

Pedestrian Level of Service Target

```csharp
int Ped_los_target { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - LOS A
- `2` - LOS B
- `3` - LOS C
- `4` - LOS D
- `5` - LOS E
- `6` - LOS F

???- example "Code samples"

    === "C#"

        ```csharp
        int ped_los_target = modelSetting.Ped_los_target;
        modelSetting.Ped_los_target = 0;
        ```

    === "C++"

        ```cpp
        long ped_los_target;
        modelSetting->get_Ped_los_target(&ped_los_target);
        modelSetting->put_Ped_los_target(0);
        ```

    === "Python"

        ```python
        ped_los_target = modelSetting.Ped_los_target
        modelSetting.Ped_los_target = 0
        ```

### Percentile_queue_option {#percentile_queue_option}

Percentile Queue Option

```csharp
int Percentile_queue_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Percentile
- `2` - Average

???- example "Code samples"

    === "C#"

        ```csharp
        int percentile_queue_option = modelSetting.Percentile_queue_option;
        modelSetting.Percentile_queue_option = 0;
        ```

    === "C++"

        ```cpp
        long percentile_queue_option;
        modelSetting->get_Percentile_queue_option(&percentile_queue_option);
        modelSetting->put_Percentile_queue_option(0);
        ```

    === "Python"

        ```python
        percentile_queue_option = modelSetting.Percentile_queue_option
        modelSetting.Percentile_queue_option = 0
        ```

### Rou_HCM_6_OD_pattern_effects_included {#rou_hcm_6_od_pattern_effects_included}

```csharp
bool Rou_HCM_6_OD_pattern_effects_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool rou_HCM_6_OD_pattern_effects_included = modelSetting.Rou_HCM_6_OD_pattern_effects_included;
        modelSetting.Rou_HCM_6_OD_pattern_effects_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL rou_HCM_6_OD_pattern_effects_included;
        modelSetting->get_Rou_HCM_6_OD_pattern_effects_included(&rou_HCM_6_OD_pattern_effects_included);
        modelSetting->put_Rou_HCM_6_OD_pattern_effects_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        rou_hcm_6_od_pattern_effects_included = modelSetting.Rou_HCM_6_OD_pattern_effects_included
        modelSetting.Rou_HCM_6_OD_pattern_effects_included = True
        ```

### Is_hcm_queue_formula_applied {#is_hcm_queue_formula_applied}

```csharp
bool Is_hcm_queue_formula_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_hcm_queue_formula_applied = modelSetting.Is_hcm_queue_formula_applied;
        modelSetting.Is_hcm_queue_formula_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_hcm_queue_formula_applied;
        modelSetting->get_Is_hcm_queue_formula_applied(&is_hcm_queue_formula_applied);
        modelSetting->put_Is_hcm_queue_formula_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_hcm_queue_formula_applied = modelSetting.Is_hcm_queue_formula_applied
        modelSetting.Is_hcm_queue_formula_applied = True
        ```

### Platoon_front_factor {#platoon_front_factor}

```csharp
float Platoon_front_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_front_factor = modelSetting.Platoon_front_factor;
        modelSetting.Platoon_front_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_front_factor;
        modelSetting->get_Platoon_front_factor(&platoon_front_factor);
        modelSetting->put_Platoon_front_factor(0.0);
        ```

    === "Python"

        ```python
        platoon_front_factor = modelSetting.Platoon_front_factor
        modelSetting.Platoon_front_factor = 0.0
        ```

### Platoon_disp_factor_min {#platoon_disp_factor_min}

```csharp
float Platoon_disp_factor_min { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_disp_factor_min = modelSetting.Platoon_disp_factor_min;
        modelSetting.Platoon_disp_factor_min = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_disp_factor_min;
        modelSetting->get_Platoon_disp_factor_min(&platoon_disp_factor_min);
        modelSetting->put_Platoon_disp_factor_min(0.0);
        ```

    === "Python"

        ```python
        platoon_disp_factor_min = modelSetting.Platoon_disp_factor_min
        modelSetting.Platoon_disp_factor_min = 0.0
        ```

### Platoon_disp_factor_max {#platoon_disp_factor_max}

```csharp
float Platoon_disp_factor_max { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_disp_factor_max = modelSetting.Platoon_disp_factor_max;
        modelSetting.Platoon_disp_factor_max = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_disp_factor_max;
        modelSetting->get_Platoon_disp_factor_max(&platoon_disp_factor_max);
        modelSetting->put_Platoon_disp_factor_max(0.0);
        ```

    === "Python"

        ```python
        platoon_disp_factor_max = modelSetting.Platoon_disp_factor_max
        modelSetting.Platoon_disp_factor_max = 0.0
        ```

### Platoon_disp_distance_min {#platoon_disp_distance_min}

```csharp
float Platoon_disp_distance_min { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_disp_distance_min = modelSetting.Platoon_disp_distance_min;
        modelSetting.Platoon_disp_distance_min = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_disp_distance_min;
        modelSetting->get_Platoon_disp_distance_min(&platoon_disp_distance_min);
        modelSetting->put_Platoon_disp_distance_min(0.0);
        ```

    === "Python"

        ```python
        platoon_disp_distance_min = modelSetting.Platoon_disp_distance_min
        modelSetting.Platoon_disp_distance_min = 0.0
        ```

### Platoon_disp_distance_max {#platoon_disp_distance_max}

```csharp
float Platoon_disp_distance_max { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_disp_distance_max = modelSetting.Platoon_disp_distance_max;
        modelSetting.Platoon_disp_distance_max = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_disp_distance_max;
        modelSetting->get_Platoon_disp_distance_max(&platoon_disp_distance_max);
        modelSetting->put_Platoon_disp_distance_max(0.0);
        ```

    === "Python"

        ```python
        platoon_disp_distance_max = modelSetting.Platoon_disp_distance_max
        modelSetting.Platoon_disp_distance_max = 0.0
        ```

### Platoon_disp_n {#platoon_disp_n}

```csharp
float Platoon_disp_n { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_disp_n = modelSetting.Platoon_disp_n;
        modelSetting.Platoon_disp_n = 0.0;
        ```

    === "C++"

        ```cpp
        double platoon_disp_n;
        modelSetting->get_Platoon_disp_n(&platoon_disp_n);
        modelSetting->put_Platoon_disp_n(0.0);
        ```

    === "Python"

        ```python
        platoon_disp_n = modelSetting.Platoon_disp_n
        modelSetting.Platoon_disp_n = 0.0
        ```

### Ped_LOS_Method {#ped_los_method}

```csharp
int Ped_LOS_Method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int ped_LOS_Method = modelSetting.Ped_LOS_Method;
        modelSetting.Ped_LOS_Method = 0;
        ```

    === "C++"

        ```cpp
        long ped_LOS_Method;
        modelSetting->get_Ped_LOS_Method(&ped_LOS_Method);
        modelSetting->put_Ped_LOS_Method(0);
        ```

    === "Python"

        ```python
        ped_los__method = modelSetting.Ped_LOS_Method
        modelSetting.Ped_LOS_Method = 0
        ```

### Calibration_note {#calibration_note}

```csharp
string Calibration_note { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string calibration_note = modelSetting.Calibration_note;
        modelSetting.Calibration_note = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR calibration_note;
        modelSetting->get_Calibration_note(&calibration_note);
        modelSetting->put_Calibration_note(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        calibration_note = modelSetting.Calibration_note
        modelSetting.Calibration_note = r"value"
        ```

### Midblock_eff_det_zone_len {#midblock_eff_det_zone_len}

Midblock Effective Detection Zone Length

```csharp
float Midblock_eff_det_zone_len { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float midblock_eff_det_zone_len = modelSetting.Midblock_eff_det_zone_len;
        modelSetting.Midblock_eff_det_zone_len = 0.0;
        ```

    === "C++"

        ```cpp
        double midblock_eff_det_zone_len;
        modelSetting->get_Midblock_eff_det_zone_len(&midblock_eff_det_zone_len);
        modelSetting->put_Midblock_eff_det_zone_len(0.0);
        ```

    === "Python"

        ```python
        midblock_eff_det_zone_len = modelSetting.Midblock_eff_det_zone_len
        modelSetting.Midblock_eff_det_zone_len = 0.0
        ```

### Is_hcm6_extended_applied {#is_hcm6_extended_applied}

```csharp
bool Is_hcm6_extended_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_hcm6_extended_applied = modelSetting.Is_hcm6_extended_applied;
        modelSetting.Is_hcm6_extended_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_hcm6_extended_applied;
        modelSetting->get_Is_hcm6_extended_applied(&is_hcm6_extended_applied);
        modelSetting->put_Is_hcm6_extended_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_hcm6_extended_applied = modelSetting.Is_hcm6_extended_applied
        modelSetting.Is_hcm6_extended_applied = True
        ```

### Shortlane_upstream_delay_stops_included {#shortlane_upstream_delay_stops_included}

```csharp
bool Shortlane_upstream_delay_stops_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool shortlane_upstream_delay_stops_included = modelSetting.Shortlane_upstream_delay_stops_included;
        modelSetting.Shortlane_upstream_delay_stops_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL shortlane_upstream_delay_stops_included;
        modelSetting->get_Shortlane_upstream_delay_stops_included(&shortlane_upstream_delay_stops_included);
        modelSetting->put_Shortlane_upstream_delay_stops_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        shortlane_upstream_delay_stops_included = modelSetting.Shortlane_upstream_delay_stops_included
        modelSetting.Shortlane_upstream_delay_stops_included = True
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_ped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_ped
title: Movement_ped
name: ISIAPIMovement_ped
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BE5BC694-3D12-4F23-993B-96695CF219FA
summary: SIDRA INTERSECTION Pedestrian Movement wrapper interface
members:
  - int Type
  - int Origin
  - int Stage
  - ISIAPISite Site
  - bool Exists
  - string Display_id
  - float Volume
  - float Peak_flow_factor
  - float Flow_scale
  - float Growth_rate
  - float Opposing_ped_factor
  - bool Practical_degree_of_saturation_user
  - float Practical_degree_of_saturation
  - float Approach_distance
  - float Queue_space
  - float Walking_speed
  - float Exit_distance
  - int Saturation_flow_rate
  - bool Crossing_distance_user
  - float Crossing_distance
  - bool Minimum_green_time_user
  - float Minimum_green_time
  - bool Maximum_green_time_user
  - float Maximum_green_time
  - bool Is_walk_time_extended
  - float Crossing_speed
  - float Minimum_walk_time
  - float Minimum_clearance_time
  - bool Clearance1_time_user
  - float Clearance1_time
  - int Clearance2_time_option
  - float Clearance2_time
  - float Start_loss
  - float End_gain
  - int Actuation_option
  - float Actuation_percent
  - bool Is_high_priority
  - float Crosswalk_space
  - bool Conflict_zone_length_user
  - float Conflict_zone_length
  - int Control_type
---

# Movement_ped

Type `ISIAPIMovement_ped` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BE5BC694-3D12-4F23-993B-96695CF219FA`

SIDRA INTERSECTION Pedestrian Movement wrapper interface

## Declaration

```csharp
[Guid("BE5BC694-3D12-4F23-993B-96695CF219FA")]
public interface ISIAPIMovement_ped
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Type](#type) | `int` | The type of a Pedestrian Movement |
| [Origin](#origin) | `int` | Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs |
| [Stage](#stage) | `int` | Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian Movements on each Leg allowing modelling of "staged" pedestrian crossings. |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Exists](#exists) | `bool` | Flag indicating whether this Pedestrian Movement "exists" (not banned) in the current Site. |
| [Display_id](#display_id) | `string` | Movement ID, a simple text descriptor for the movement used in many SIDRA INTERSECTION reports to signify the movement. |
| [Volume](#volume) | `float` | Pedestrian Volume |
| [Peak_flow_factor](#peak_flow_factor) | `float` | Peak Flow Factor (%) |
| [Flow_scale](#flow_scale) | `float` | Flow Scale (Constant) (%) |
| [Growth_rate](#growth_rate) | `float` | Growth Rate (%/year) |
| [Opposing_ped_factor](#opposing_ped_factor) | `float` |  |
| [Practical_degree_of_saturation_user](#practical_degree_of_saturation_user) | `bool` | Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_ped.Practical_degree_of_saturation` or an automatically calculated value in processing. |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` | Practical degree of saturation |
| [Approach_distance](#approach_distance) | `float` | Approach Travel Distance |
| [Queue_space](#queue_space) | `float` | Queue Space |
| [Walking_speed](#walking_speed) | `float` | Walking Speed (Average) |
| [Exit_distance](#exit_distance) | `float` | Exit (Downstream) Distance |
| [Saturation_flow_rate](#saturation_flow_rate) | `int` | Saturation Flow (ped/h) |
| [Crossing_distance_user](#crossing_distance_user) | `bool` | Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_ped.Crossing_distance` or an automatically calculated value in processing. |
| [Crossing_distance](#crossing_distance) | `float` | Crossing Distance |
| [Minimum_green_time_user](#minimum_green_time_user) | `bool` |  |
| [Minimum_green_time](#minimum_green_time) | `float` |  |
| [Maximum_green_time_user](#maximum_green_time_user) | `bool` |  |
| [Maximum_green_time](#maximum_green_time) | `float` |  |
| [Is_walk_time_extended](#is_walk_time_extended) | `bool` |  |
| [Crossing_speed](#crossing_speed) | `float` |  |
| [Minimum_walk_time](#minimum_walk_time) | `float` |  |
| [Minimum_clearance_time](#minimum_clearance_time) | `float` |  |
| [Clearance1_time_user](#clearance1_time_user) | `bool` |  |
| [Clearance1_time](#clearance1_time) | `float` |  |
| [Clearance2_time_option](#clearance2_time_option) | `int` | Clearance 2 Time Option |
| [Clearance2_time](#clearance2_time) | `float` |  |
| [Start_loss](#start_loss) | `float` |  |
| [End_gain](#end_gain) | `float` |  |
| [Actuation_option](#actuation_option) | `int` |  |
| [Actuation_percent](#actuation_percent) | `float` |  |
| [Is_high_priority](#is_high_priority) | `bool` | High Priority for Green Splits |
| [Crosswalk_space](#crosswalk_space) | `float` |  |
| [Conflict_zone_length_user](#conflict_zone_length_user) | `bool` |  |
| [Conflict_zone_length](#conflict_zone_length) | `float` |  |
| [Control_type](#control_type) | `int` |  |

</div>

## Properties

### Type {#type}

The type of a Pedestrian Movement

```csharp
int Type { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Full Crossing
- `2` - Slip Lane
- `3` - Staged
- `4` - Diagonal

???- example "Code samples"

    === "C#"

        ```csharp
        int type = movement_ped.Type;
        ```

    === "C++"

        ```cpp
        long type;
        movement_ped->get_Type(&type);
        ```

    === "Python"

        ```python
        type = movement_ped.Type
        ```

### Origin {#origin}

Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = movement_ped.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        movement_ped->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = movement_ped.Origin
        ```

### Stage {#stage}

Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian
Movements on each Leg allowing modelling of "staged" pedestrian crossings.

```csharp
int Stage { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Stage 1 (Approach-side crossing)
- `2` - Stage 2 (Exit-side crossing)

???- example "Code samples"

    === "C#"

        ```csharp
        int stage = movement_ped.Stage;
        ```

    === "C++"

        ```cpp
        long stage;
        movement_ped->get_Stage(&stage);
        ```

    === "Python"

        ```python
        stage = movement_ped.Stage
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = movement_ped.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        movement_ped->get_Site(&site);
        ```

    === "Python"

        ```python
        site = movement_ped.Site
        ```

### Exists {#exists}

Flag indicating whether this Pedestrian Movement "exists" (not banned) in
the current Site.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = movement_ped.Exists;
        movement_ped.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        movement_ped->get_Exists(&exists);
        movement_ped->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = movement_ped.Exists
        movement_ped.Exists = True
        ```

### Display_id {#display_id}

Movement ID, a simple text descriptor for the movement used in many SIDRA
INTERSECTION reports to signify the movement.

```csharp
string Display_id { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string display_id = movement_ped.Display_id;
        movement_ped.Display_id = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR display_id;
        movement_ped->get_Display_id(&display_id);
        movement_ped->put_Display_id(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        display_id = movement_ped.Display_id
        movement_ped.Display_id = r"id-1"
        ```

### Volume {#volume}

Pedestrian Volume

```csharp
float Volume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float volume = movement_ped.Volume;
        movement_ped.Volume = 0.0;
        ```

    === "C++"

        ```cpp
        double volume;
        movement_ped->get_Volume(&volume);
        movement_ped->put_Volume(0.0);
        ```

    === "Python"

        ```python
        volume = movement_ped.Volume
        movement_ped.Volume = 0.0
        ```

### Peak_flow_factor {#peak_flow_factor}

Peak Flow Factor (%)

```csharp
float Peak_flow_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float peak_flow_factor = movement_ped.Peak_flow_factor;
        movement_ped.Peak_flow_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double peak_flow_factor;
        movement_ped->get_Peak_flow_factor(&peak_flow_factor);
        movement_ped->put_Peak_flow_factor(0.0);
        ```

    === "Python"

        ```python
        peak_flow_factor = movement_ped.Peak_flow_factor
        movement_ped.Peak_flow_factor = 0.0
        ```

### Flow_scale {#flow_scale}

Flow Scale (Constant) (%)

```csharp
float Flow_scale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_scale = movement_ped.Flow_scale;
        movement_ped.Flow_scale = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_scale;
        movement_ped->get_Flow_scale(&flow_scale);
        movement_ped->put_Flow_scale(0.0);
        ```

    === "Python"

        ```python
        flow_scale = movement_ped.Flow_scale
        movement_ped.Flow_scale = 0.0
        ```

### Growth_rate {#growth_rate}

Growth Rate (%/year)

```csharp
float Growth_rate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float growth_rate = movement_ped.Growth_rate;
        movement_ped.Growth_rate = 0.0;
        ```

    === "C++"

        ```cpp
        double growth_rate;
        movement_ped->get_Growth_rate(&growth_rate);
        movement_ped->put_Growth_rate(0.0);
        ```

    === "Python"

        ```python
        growth_rate = movement_ped.Growth_rate
        movement_ped.Growth_rate = 0.0
        ```

### Opposing_ped_factor {#opposing_ped_factor}

```csharp
float Opposing_ped_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_ped_factor = movement_ped.Opposing_ped_factor;
        movement_ped.Opposing_ped_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double opposing_ped_factor;
        movement_ped->get_Opposing_ped_factor(&opposing_ped_factor);
        movement_ped->put_Opposing_ped_factor(0.0);
        ```

    === "Python"

        ```python
        opposing_ped_factor = movement_ped.Opposing_ped_factor
        movement_ped.Opposing_ped_factor = 0.0
        ```

### Practical_degree_of_saturation_user {#practical_degree_of_saturation_user}

Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_ped.Practical_degree_of_saturation` or an
automatically calculated value in processing.

```csharp
bool Practical_degree_of_saturation_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_degree_of_saturation_user = movement_ped.Practical_degree_of_saturation_user;
        movement_ped.Practical_degree_of_saturation_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_degree_of_saturation_user;
        movement_ped->get_Practical_degree_of_saturation_user(&practical_degree_of_saturation_user);
        movement_ped->put_Practical_degree_of_saturation_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation_user = movement_ped.Practical_degree_of_saturation_user
        movement_ped.Practical_degree_of_saturation_user = True
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

Practical degree of saturation

```csharp
float Practical_degree_of_saturation { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = movement_ped.Practical_degree_of_saturation;
        movement_ped.Practical_degree_of_saturation = 0.0;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        movement_ped->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        movement_ped->put_Practical_degree_of_saturation(0.0);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = movement_ped.Practical_degree_of_saturation
        movement_ped.Practical_degree_of_saturation = 0.0
        ```

### Approach_distance {#approach_distance}

Approach Travel Distance

```csharp
float Approach_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float approach_distance = movement_ped.Approach_distance;
        movement_ped.Approach_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double approach_distance;
        movement_ped->get_Approach_distance(&approach_distance);
        movement_ped->put_Approach_distance(0.0);
        ```

    === "Python"

        ```python
        approach_distance = movement_ped.Approach_distance
        movement_ped.Approach_distance = 0.0
        ```

### Queue_space {#queue_space}

Queue Space

```csharp
float Queue_space { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_space = movement_ped.Queue_space;
        movement_ped.Queue_space = 0.0;
        ```

    === "C++"

        ```cpp
        double queue_space;
        movement_ped->get_Queue_space(&queue_space);
        movement_ped->put_Queue_space(0.0);
        ```

    === "Python"

        ```python
        queue_space = movement_ped.Queue_space
        movement_ped.Queue_space = 0.0
        ```

### Walking_speed {#walking_speed}

Walking Speed (Average)

```csharp
float Walking_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float walking_speed = movement_ped.Walking_speed;
        movement_ped.Walking_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double walking_speed;
        movement_ped->get_Walking_speed(&walking_speed);
        movement_ped->put_Walking_speed(0.0);
        ```

    === "Python"

        ```python
        walking_speed = movement_ped.Walking_speed
        movement_ped.Walking_speed = 0.0
        ```

### Exit_distance {#exit_distance}

Exit (Downstream) Distance

```csharp
float Exit_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_distance = movement_ped.Exit_distance;
        movement_ped.Exit_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_distance;
        movement_ped->get_Exit_distance(&exit_distance);
        movement_ped->put_Exit_distance(0.0);
        ```

    === "Python"

        ```python
        exit_distance = movement_ped.Exit_distance
        movement_ped.Exit_distance = 0.0
        ```

### Saturation_flow_rate {#saturation_flow_rate}

Saturation Flow (ped/h)

```csharp
int Saturation_flow_rate { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int saturation_flow_rate = movement_ped.Saturation_flow_rate;
        movement_ped.Saturation_flow_rate = 0;
        ```

    === "C++"

        ```cpp
        long saturation_flow_rate;
        movement_ped->get_Saturation_flow_rate(&saturation_flow_rate);
        movement_ped->put_Saturation_flow_rate(0);
        ```

    === "Python"

        ```python
        saturation_flow_rate = movement_ped.Saturation_flow_rate
        movement_ped.Saturation_flow_rate = 0
        ```

### Crossing_distance_user {#crossing_distance_user}

Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_ped.Crossing_distance` or an automatically calculated value in
processing.

```csharp
bool Crossing_distance_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool crossing_distance_user = movement_ped.Crossing_distance_user;
        movement_ped.Crossing_distance_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL crossing_distance_user;
        movement_ped->get_Crossing_distance_user(&crossing_distance_user);
        movement_ped->put_Crossing_distance_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        crossing_distance_user = movement_ped.Crossing_distance_user
        movement_ped.Crossing_distance_user = True
        ```

### Crossing_distance {#crossing_distance}

Crossing Distance

```csharp
float Crossing_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float crossing_distance = movement_ped.Crossing_distance;
        movement_ped.Crossing_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double crossing_distance;
        movement_ped->get_Crossing_distance(&crossing_distance);
        movement_ped->put_Crossing_distance(0.0);
        ```

    === "Python"

        ```python
        crossing_distance = movement_ped.Crossing_distance
        movement_ped.Crossing_distance = 0.0
        ```

### Minimum_green_time_user {#minimum_green_time_user}

```csharp
bool Minimum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool minimum_green_time_user = movement_ped.Minimum_green_time_user;
        movement_ped.Minimum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL minimum_green_time_user;
        movement_ped->get_Minimum_green_time_user(&minimum_green_time_user);
        movement_ped->put_Minimum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        minimum_green_time_user = movement_ped.Minimum_green_time_user
        movement_ped.Minimum_green_time_user = True
        ```

### Minimum_green_time {#minimum_green_time}

```csharp
float Minimum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_green_time = movement_ped.Minimum_green_time;
        movement_ped.Minimum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_green_time;
        movement_ped->get_Minimum_green_time(&minimum_green_time);
        movement_ped->put_Minimum_green_time(0.0);
        ```

    === "Python"

        ```python
        minimum_green_time = movement_ped.Minimum_green_time
        movement_ped.Minimum_green_time = 0.0
        ```

### Maximum_green_time_user {#maximum_green_time_user}

```csharp
bool Maximum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool maximum_green_time_user = movement_ped.Maximum_green_time_user;
        movement_ped.Maximum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL maximum_green_time_user;
        movement_ped->get_Maximum_green_time_user(&maximum_green_time_user);
        movement_ped->put_Maximum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        maximum_green_time_user = movement_ped.Maximum_green_time_user
        movement_ped.Maximum_green_time_user = True
        ```

### Maximum_green_time {#maximum_green_time}

```csharp
float Maximum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float maximum_green_time = movement_ped.Maximum_green_time;
        movement_ped.Maximum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double maximum_green_time;
        movement_ped->get_Maximum_green_time(&maximum_green_time);
        movement_ped->put_Maximum_green_time(0.0);
        ```

    === "Python"

        ```python
        maximum_green_time = movement_ped.Maximum_green_time
        movement_ped.Maximum_green_time = 0.0
        ```

### Is_walk_time_extended {#is_walk_time_extended}

```csharp
bool Is_walk_time_extended { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_walk_time_extended = movement_ped.Is_walk_time_extended;
        movement_ped.Is_walk_time_extended = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_walk_time_extended;
        movement_ped->get_Is_walk_time_extended(&is_walk_time_extended);
        movement_ped->put_Is_walk_time_extended(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_walk_time_extended = movement_ped.Is_walk_time_extended
        movement_ped.Is_walk_time_extended = True
        ```

### Crossing_speed {#crossing_speed}

```csharp
float Crossing_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float crossing_speed = movement_ped.Crossing_speed;
        movement_ped.Crossing_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double crossing_speed;
        movement_ped->get_Crossing_speed(&crossing_speed);
        movement_ped->put_Crossing_speed(0.0);
        ```

    === "Python"

        ```python
        crossing_speed = movement_ped.Crossing_speed
        movement_ped.Crossing_speed = 0.0
        ```

### Minimum_walk_time {#minimum_walk_time}

```csharp
float Minimum_walk_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_walk_time = movement_ped.Minimum_walk_time;
        movement_ped.Minimum_walk_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_walk_time;
        movement_ped->get_Minimum_walk_time(&minimum_walk_time);
        movement_ped->put_Minimum_walk_time(0.0);
        ```

    === "Python"

        ```python
        minimum_walk_time = movement_ped.Minimum_walk_time
        movement_ped.Minimum_walk_time = 0.0
        ```

### Minimum_clearance_time {#minimum_clearance_time}

```csharp
float Minimum_clearance_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_clearance_time = movement_ped.Minimum_clearance_time;
        movement_ped.Minimum_clearance_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_clearance_time;
        movement_ped->get_Minimum_clearance_time(&minimum_clearance_time);
        movement_ped->put_Minimum_clearance_time(0.0);
        ```

    === "Python"

        ```python
        minimum_clearance_time = movement_ped.Minimum_clearance_time
        movement_ped.Minimum_clearance_time = 0.0
        ```

### Clearance1_time_user {#clearance1_time_user}

```csharp
bool Clearance1_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool clearance1_time_user = movement_ped.Clearance1_time_user;
        movement_ped.Clearance1_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL clearance1_time_user;
        movement_ped->get_Clearance1_time_user(&clearance1_time_user);
        movement_ped->put_Clearance1_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        clearance1_time_user = movement_ped.Clearance1_time_user
        movement_ped.Clearance1_time_user = True
        ```

### Clearance1_time {#clearance1_time}

```csharp
float Clearance1_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float clearance1_time = movement_ped.Clearance1_time;
        movement_ped.Clearance1_time = 0.0;
        ```

    === "C++"

        ```cpp
        double clearance1_time;
        movement_ped->get_Clearance1_time(&clearance1_time);
        movement_ped->put_Clearance1_time(0.0);
        ```

    === "Python"

        ```python
        clearance1_time = movement_ped.Clearance1_time
        movement_ped.Clearance1_time = 0.0
        ```

### Clearance2_time_option {#clearance2_time_option}

Clearance 2 Time Option

```csharp
int Clearance2_time_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input (default)
- `1` - Yellow Time
- `2` - Intergreen Time

???- example "Code samples"

    === "C#"

        ```csharp
        int clearance2_time_option = movement_ped.Clearance2_time_option;
        movement_ped.Clearance2_time_option = 0;
        ```

    === "C++"

        ```cpp
        long clearance2_time_option;
        movement_ped->get_Clearance2_time_option(&clearance2_time_option);
        movement_ped->put_Clearance2_time_option(0);
        ```

    === "Python"

        ```python
        clearance2_time_option = movement_ped.Clearance2_time_option
        movement_ped.Clearance2_time_option = 0
        ```

### Clearance2_time {#clearance2_time}

```csharp
float Clearance2_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float clearance2_time = movement_ped.Clearance2_time;
        movement_ped.Clearance2_time = 0.0;
        ```

    === "C++"

        ```cpp
        double clearance2_time;
        movement_ped->get_Clearance2_time(&clearance2_time);
        movement_ped->put_Clearance2_time(0.0);
        ```

    === "Python"

        ```python
        clearance2_time = movement_ped.Clearance2_time
        movement_ped.Clearance2_time = 0.0
        ```

### Start_loss {#start_loss}

```csharp
float Start_loss { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_loss = movement_ped.Start_loss;
        movement_ped.Start_loss = 0.0;
        ```

    === "C++"

        ```cpp
        double start_loss;
        movement_ped->get_Start_loss(&start_loss);
        movement_ped->put_Start_loss(0.0);
        ```

    === "Python"

        ```python
        start_loss = movement_ped.Start_loss
        movement_ped.Start_loss = 0.0
        ```

### End_gain {#end_gain}

```csharp
float End_gain { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_gain = movement_ped.End_gain;
        movement_ped.End_gain = 0.0;
        ```

    === "C++"

        ```cpp
        double end_gain;
        movement_ped->get_End_gain(&end_gain);
        movement_ped->put_End_gain(0.0);
        ```

    === "Python"

        ```python
        end_gain = movement_ped.End_gain
        movement_ped.End_gain = 0.0
        ```

### Actuation_option {#actuation_option}

```csharp
int Actuation_option { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int actuation_option = movement_ped.Actuation_option;
        movement_ped.Actuation_option = 0;
        ```

    === "C++"

        ```cpp
        long actuation_option;
        movement_ped->get_Actuation_option(&actuation_option);
        movement_ped->put_Actuation_option(0);
        ```

    === "Python"

        ```python
        actuation_option = movement_ped.Actuation_option
        movement_ped.Actuation_option = 0
        ```

### Actuation_percent {#actuation_percent}

```csharp
float Actuation_percent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuation_percent = movement_ped.Actuation_percent;
        movement_ped.Actuation_percent = 0.0;
        ```

    === "C++"

        ```cpp
        double actuation_percent;
        movement_ped->get_Actuation_percent(&actuation_percent);
        movement_ped->put_Actuation_percent(0.0);
        ```

    === "Python"

        ```python
        actuation_percent = movement_ped.Actuation_percent
        movement_ped.Actuation_percent = 0.0
        ```

### Is_high_priority {#is_high_priority}

High Priority for Green Splits

```csharp
bool Is_high_priority { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_high_priority = movement_ped.Is_high_priority;
        movement_ped.Is_high_priority = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_high_priority;
        movement_ped->get_Is_high_priority(&is_high_priority);
        movement_ped->put_Is_high_priority(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_high_priority = movement_ped.Is_high_priority
        movement_ped.Is_high_priority = True
        ```

### Crosswalk_space {#crosswalk_space}

```csharp
float Crosswalk_space { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float crosswalk_space = movement_ped.Crosswalk_space;
        movement_ped.Crosswalk_space = 0.0;
        ```

    === "C++"

        ```cpp
        double crosswalk_space;
        movement_ped->get_Crosswalk_space(&crosswalk_space);
        movement_ped->put_Crosswalk_space(0.0);
        ```

    === "Python"

        ```python
        crosswalk_space = movement_ped.Crosswalk_space
        movement_ped.Crosswalk_space = 0.0
        ```

### Conflict_zone_length_user {#conflict_zone_length_user}

```csharp
bool Conflict_zone_length_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool conflict_zone_length_user = movement_ped.Conflict_zone_length_user;
        movement_ped.Conflict_zone_length_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL conflict_zone_length_user;
        movement_ped->get_Conflict_zone_length_user(&conflict_zone_length_user);
        movement_ped->put_Conflict_zone_length_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        conflict_zone_length_user = movement_ped.Conflict_zone_length_user
        movement_ped.Conflict_zone_length_user = True
        ```

### Conflict_zone_length {#conflict_zone_length}

```csharp
float Conflict_zone_length { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float conflict_zone_length = movement_ped.Conflict_zone_length;
        movement_ped.Conflict_zone_length = 0.0;
        ```

    === "C++"

        ```cpp
        double conflict_zone_length;
        movement_ped->get_Conflict_zone_length(&conflict_zone_length);
        movement_ped->put_Conflict_zone_length(0.0);
        ```

    === "Python"

        ```python
        conflict_zone_length = movement_ped.Conflict_zone_length
        movement_ped.Conflict_zone_length = 0.0
        ```

### Control_type {#control_type}

```csharp
int Control_type { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int control_type = movement_ped.Control_type;
        movement_ped.Control_type = 0;
        ```

    === "C++"

        ```cpp
        long control_type;
        movement_ped->get_Control_type(&control_type);
        movement_ped->put_Control_type(0);
        ```

    === "Python"

        ```python
        control_type = movement_ped.Control_type
        movement_ped.Control_type = 0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_peds.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_peds
title: Movement_peds
name: ISIAPIMovement_peds
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E5AB577B-30AF-4B51-8EED-33D34974A2A7
members:
  - bool MovementExists(int type, int origin, int stage)
  - ISIAPIMovement_ped this[int type, int origin, int stage]
  - int Count
---

# Movement_peds

Type `ISIAPIMovement_peds` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E5AB577B-30AF-4B51-8EED-33D34974A2A7`

## Declaration

```csharp
[Guid("E5AB577B-30AF-4B51-8EED-33D34974A2A7")]
public interface ISIAPIMovement_peds
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIMovement_ped`](sidrasolutions.si.api.isiapimovement_ped.md) | Get a Pedestrian Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int, int)](#movementexists-int--int--int) | `bool` | Get a value indicating whether a Pedestrian Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = movement_peds.Count;
        ```

    === "C++"

        ```cpp
        long count;
        movement_peds->get_Count(&count);
        ```

    === "Python"

        ```python
        count = movement_peds.Count
        ```

### this[] {#this}

Get a Pedestrian Movement.

```csharp
ISIAPIMovement_ped this[] { get; }
```

**Type** [`ISIAPIMovement_ped`](sidrasolutions.si.api.isiapimovement_ped.md) - Return a Pedestrian Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = movement_peds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_ped> this[];
        movement_peds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = movement_peds.this[]
        ```

## Methods

### MovementExists(int, int, int) {#movementexists-int--int--int}

Get a value indicating whether a Pedestrian Movement exists in the data storage.

```csharp
bool MovementExists(int type, int origin, int stage)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `type` | `int` | One of: - `1` - Full Crossing - `2` - Slip Lane - `3` - Staged - `4` - Diagonal |
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `stage` | `int` | One of: - `1` - Stage 1 (Approach-side crossing) - `2` - Stage 2 (Exit-side crossing) |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = movement_peds.MovementExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        movement_peds->MovementExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = movement_peds.MovementExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_vehicle_od.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od
title: Movement_vehicle_od
name: ISIAPIMovement_vehicle_od
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FCE0F299-3272-4D64-A0F6-8D591EE0B5E9
summary: SIDRA INTERSECTION Vehicle Approach Movement wrapper interface
members:
  - int Origin
  - int Destination
  - int ODMovDesignation
  - bool IsPossible
  - ISIAPIMovement_vehicle_od_mcs MovementVehicleODMCs
  - ISIAPISite Site
  - ISIAPIOpposingmovement_vehicles Opposingmovement_vehicles
  - ISIAPIOpposingmovement_peds Opposingmovement_peds
  - bool Exists
  - int Turndesignation
  - string Display_od_id
  - string Display_ltr_id
  - bool Is_TWSC_adj_applied
  - bool Is_gap_acceptance_usergiven
  - float Critical_gap
  - float Followup_headway
  - float End_departures
  - float Minimum_departures
  - float Exit_flow_effect
  - float Percent_opposed_by_nearest
  - int Opposing_ped_effect_option_signals
  - int Opposing_ped_effect_option
  - float Opposing_ped_effect_start_loss
  - float Total_volume
  - int Zebra_ped_gap_acceptance_option
  - float Zebra_ped_critical_gap
  - float Zebra_ped_followup_headway
  - float Zebra_ped_minimum_departures
---

# Movement_vehicle_od

Type `ISIAPIMovement_vehicle_od` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FCE0F299-3272-4D64-A0F6-8D591EE0B5E9`

SIDRA INTERSECTION Vehicle Approach Movement wrapper interface

## Declaration

```csharp
[Guid("FCE0F299-3272-4D64-A0F6-8D591EE0B5E9")]
public interface ISIAPIMovement_vehicle_od
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` | Approach Movement Origin Leg |
| [Destination](#destination) | `int` | Approach Movement Destination Leg |
| [ODMovDesignation](#odmovdesignation) | `int` | Approach Movement Designation |
| [IsPossible](#ispossible) | `bool` | Flag indicating whether this Approach Movement is Geometry Possible, i.e. the Origin Leg has Approach Lanes and the Destination Leg has Exit Lanes. |
| [MovementVehicleODMCs](#movementvehicleodmcs) | [`ISIAPIMovement_vehicle_od_mcs`](sidrasolutions.si.api.isiapimovement_vehicle_od_mcs.md) |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Opposingmovement_vehicles](#opposingmovement_vehicles) | [`ISIAPIOpposingmovement_vehicles`](sidrasolutions.si.api.isiapiopposingmovement_vehicles.md) |  |
| [Opposingmovement_peds](#opposingmovement_peds) | [`ISIAPIOpposingmovement_peds`](sidrasolutions.si.api.isiapiopposingmovement_peds.md) |  |
| [Exists](#exists) | `bool` | Flag indicating whether this Approach Movement "exists" (not banned) in the current site. The state of this property corresponds to the setting of the "Movement Exists" checkbox in the SIDRA INTERSECTION "Movement Definitions" dialog - "Approach Movements" tab for the given Approach Movement. |
| [Turndesignation](#turndesignation) | `int` | Approach Movement turn designation |
| [Display_od_id](#display_od_id) | `string` |  |
| [Display_ltr_id](#display_ltr_id) | `string` |  |
| [Is_TWSC_adj_applied](#is_twsc_adj_applied) | `bool` |  |
| [Is_gap_acceptance_usergiven](#is_gap_acceptance_usergiven) | `bool` |  |
| [Critical_gap](#critical_gap) | `float` |  |
| [Followup_headway](#followup_headway) | `float` |  |
| [End_departures](#end_departures) | `float` |  |
| [Minimum_departures](#minimum_departures) | `float` |  |
| [Exit_flow_effect](#exit_flow_effect) | `float` |  |
| [Percent_opposed_by_nearest](#percent_opposed_by_nearest) | `float` |  |
| [Opposing_ped_effect_option_signals](#opposing_ped_effect_option_signals) | `int` | Opposing Pedestrian Effect Option (Signalised) |
| [Opposing_ped_effect_option](#opposing_ped_effect_option) | `int` | Opposing Pedestrian Effect Option |
| [Opposing_ped_effect_start_loss](#opposing_ped_effect_start_loss) | `float` |  |
| [Total_volume](#total_volume) | `float` |  |
| [Zebra_ped_gap_acceptance_option](#zebra_ped_gap_acceptance_option) | `int` | Gap Acceptance Option for opposing Zebra Crossing Pedestrians |
| [Zebra_ped_critical_gap](#zebra_ped_critical_gap) | `float` |  |
| [Zebra_ped_followup_headway](#zebra_ped_followup_headway) | `float` |  |
| [Zebra_ped_minimum_departures](#zebra_ped_minimum_departures) | `float` |  |

</div>

## Properties

### Origin {#origin}

Approach Movement Origin Leg

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = movement_vehicle_od.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        movement_vehicle_od->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = movement_vehicle_od.Origin
        ```

### Destination {#destination}

Approach Movement Destination Leg

```csharp
int Destination { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = movement_vehicle_od.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        movement_vehicle_od->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = movement_vehicle_od.Destination
        ```

### ODMovDesignation {#odmovdesignation}

Approach Movement Designation

```csharp
int ODMovDesignation { get; }
```

**Type** `int`

**Value**

One of:

- `0` - U
- `1` - L3
- `2` - L2
- `3` - L1
- `4` - T1
- `5` - R1
- `6` - R2
- `7` - R3

???- example "Code samples"

    === "C#"

        ```csharp
        int oDMovDesignation = movement_vehicle_od.ODMovDesignation;
        ```

    === "C++"

        ```cpp
        long oDMovDesignation;
        movement_vehicle_od->get_ODMovDesignation(&oDMovDesignation);
        ```

    === "Python"

        ```python
        od_mov_designation = movement_vehicle_od.ODMovDesignation
        ```

### IsPossible {#ispossible}

Flag indicating whether this Approach Movement is Geometry Possible, i.e. the Origin Leg has Approach Lanes and the Destination Leg has Exit Lanes.

```csharp
bool IsPossible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isPossible = movement_vehicle_od.IsPossible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isPossible;
        movement_vehicle_od->get_IsPossible(&isPossible);
        ```

    === "Python"

        ```python
        is_possible = movement_vehicle_od.IsPossible
        ```

### MovementVehicleODMCs {#movementvehicleodmcs}

```csharp
ISIAPIMovement_vehicle_od_mcs MovementVehicleODMCs { get; }
```

**Type** [`ISIAPIMovement_vehicle_od_mcs`](sidrasolutions.si.api.isiapimovement_vehicle_od_mcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementVehicleODMCs = movement_vehicle_od.MovementVehicleODMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od_mcs> movementVehicleODMCs;
        movement_vehicle_od->get_MovementVehicleODMCs(&movementVehicleODMCs);
        ```

    === "Python"

        ```python
        movement_vehicle_odm_cs = movement_vehicle_od.MovementVehicleODMCs
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = movement_vehicle_od.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        movement_vehicle_od->get_Site(&site);
        ```

    === "Python"

        ```python
        site = movement_vehicle_od.Site
        ```

### Opposingmovement_vehicles {#opposingmovement_vehicles}

```csharp
ISIAPIOpposingmovement_vehicles Opposingmovement_vehicles { get; }
```

**Type** [`ISIAPIOpposingmovement_vehicles`](sidrasolutions.si.api.isiapiopposingmovement_vehicles.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var opposingmovement_vehicles = movement_vehicle_od.Opposingmovement_vehicles;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_vehicles> opposingmovement_vehicles;
        movement_vehicle_od->get_Opposingmovement_vehicles(&opposingmovement_vehicles);
        ```

    === "Python"

        ```python
        opposingmovement_vehicles = movement_vehicle_od.Opposingmovement_vehicles
        ```

### Opposingmovement_peds {#opposingmovement_peds}

```csharp
ISIAPIOpposingmovement_peds Opposingmovement_peds { get; }
```

**Type** [`ISIAPIOpposingmovement_peds`](sidrasolutions.si.api.isiapiopposingmovement_peds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var opposingmovement_peds = movement_vehicle_od.Opposingmovement_peds;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_peds> opposingmovement_peds;
        movement_vehicle_od->get_Opposingmovement_peds(&opposingmovement_peds);
        ```

    === "Python"

        ```python
        opposingmovement_peds = movement_vehicle_od.Opposingmovement_peds
        ```

### Exists {#exists}

Flag indicating whether this Approach Movement "exists" (not banned) in the current site.

The state of this property corresponds to the setting of the "Movement Exists" checkbox in the 
SIDRA INTERSECTION "Movement Definitions" dialog - "Approach Movements" tab for the given Approach Movement.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = movement_vehicle_od.Exists;
        movement_vehicle_od.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        movement_vehicle_od->get_Exists(&exists);
        movement_vehicle_od->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = movement_vehicle_od.Exists
        movement_vehicle_od.Exists = True
        ```

### Turndesignation {#turndesignation}

Approach Movement turn designation

```csharp
int Turndesignation { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Left
- `2` - Through
- `3` - Right

???- example "Code samples"

    === "C#"

        ```csharp
        int turndesignation = movement_vehicle_od.Turndesignation;
        movement_vehicle_od.Turndesignation = 0;
        ```

    === "C++"

        ```cpp
        long turndesignation;
        movement_vehicle_od->get_Turndesignation(&turndesignation);
        movement_vehicle_od->put_Turndesignation(0);
        ```

    === "Python"

        ```python
        turndesignation = movement_vehicle_od.Turndesignation
        movement_vehicle_od.Turndesignation = 0
        ```

### Display_od_id {#display_od_id}

```csharp
string Display_od_id { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string display_od_id = movement_vehicle_od.Display_od_id;
        movement_vehicle_od.Display_od_id = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR display_od_id;
        movement_vehicle_od->get_Display_od_id(&display_od_id);
        movement_vehicle_od->put_Display_od_id(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        display_od_id = movement_vehicle_od.Display_od_id
        movement_vehicle_od.Display_od_id = r"id-1"
        ```

### Display_ltr_id {#display_ltr_id}

```csharp
string Display_ltr_id { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string display_ltr_id = movement_vehicle_od.Display_ltr_id;
        movement_vehicle_od.Display_ltr_id = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR display_ltr_id;
        movement_vehicle_od->get_Display_ltr_id(&display_ltr_id);
        movement_vehicle_od->put_Display_ltr_id(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        display_ltr_id = movement_vehicle_od.Display_ltr_id
        movement_vehicle_od.Display_ltr_id = r"id-1"
        ```

### Is_TWSC_adj_applied {#is_twsc_adj_applied}

```csharp
bool Is_TWSC_adj_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_TWSC_adj_applied = movement_vehicle_od.Is_TWSC_adj_applied;
        movement_vehicle_od.Is_TWSC_adj_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_TWSC_adj_applied;
        movement_vehicle_od->get_Is_TWSC_adj_applied(&is_TWSC_adj_applied);
        movement_vehicle_od->put_Is_TWSC_adj_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_twsc_adj_applied = movement_vehicle_od.Is_TWSC_adj_applied
        movement_vehicle_od.Is_TWSC_adj_applied = True
        ```

### Is_gap_acceptance_usergiven {#is_gap_acceptance_usergiven}

```csharp
bool Is_gap_acceptance_usergiven { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_gap_acceptance_usergiven = movement_vehicle_od.Is_gap_acceptance_usergiven;
        movement_vehicle_od.Is_gap_acceptance_usergiven = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_gap_acceptance_usergiven;
        movement_vehicle_od->get_Is_gap_acceptance_usergiven(&is_gap_acceptance_usergiven);
        movement_vehicle_od->put_Is_gap_acceptance_usergiven(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_gap_acceptance_usergiven = movement_vehicle_od.Is_gap_acceptance_usergiven
        movement_vehicle_od.Is_gap_acceptance_usergiven = True
        ```

### Critical_gap {#critical_gap}

```csharp
float Critical_gap { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap = movement_vehicle_od.Critical_gap;
        movement_vehicle_od.Critical_gap = 0.0;
        ```

    === "C++"

        ```cpp
        double critical_gap;
        movement_vehicle_od->get_Critical_gap(&critical_gap);
        movement_vehicle_od->put_Critical_gap(0.0);
        ```

    === "Python"

        ```python
        critical_gap = movement_vehicle_od.Critical_gap
        movement_vehicle_od.Critical_gap = 0.0
        ```

### Followup_headway {#followup_headway}

```csharp
float Followup_headway { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway = movement_vehicle_od.Followup_headway;
        movement_vehicle_od.Followup_headway = 0.0;
        ```

    === "C++"

        ```cpp
        double followup_headway;
        movement_vehicle_od->get_Followup_headway(&followup_headway);
        movement_vehicle_od->put_Followup_headway(0.0);
        ```

    === "Python"

        ```python
        followup_headway = movement_vehicle_od.Followup_headway
        movement_vehicle_od.Followup_headway = 0.0
        ```

### End_departures {#end_departures}

```csharp
float End_departures { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_departures = movement_vehicle_od.End_departures;
        movement_vehicle_od.End_departures = 0.0;
        ```

    === "C++"

        ```cpp
        double end_departures;
        movement_vehicle_od->get_End_departures(&end_departures);
        movement_vehicle_od->put_End_departures(0.0);
        ```

    === "Python"

        ```python
        end_departures = movement_vehicle_od.End_departures
        movement_vehicle_od.End_departures = 0.0
        ```

### Minimum_departures {#minimum_departures}

```csharp
float Minimum_departures { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_departures = movement_vehicle_od.Minimum_departures;
        movement_vehicle_od.Minimum_departures = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_departures;
        movement_vehicle_od->get_Minimum_departures(&minimum_departures);
        movement_vehicle_od->put_Minimum_departures(0.0);
        ```

    === "Python"

        ```python
        minimum_departures = movement_vehicle_od.Minimum_departures
        movement_vehicle_od.Minimum_departures = 0.0
        ```

### Exit_flow_effect {#exit_flow_effect}

```csharp
float Exit_flow_effect { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_flow_effect = movement_vehicle_od.Exit_flow_effect;
        movement_vehicle_od.Exit_flow_effect = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_flow_effect;
        movement_vehicle_od->get_Exit_flow_effect(&exit_flow_effect);
        movement_vehicle_od->put_Exit_flow_effect(0.0);
        ```

    === "Python"

        ```python
        exit_flow_effect = movement_vehicle_od.Exit_flow_effect
        movement_vehicle_od.Exit_flow_effect = 0.0
        ```

### Percent_opposed_by_nearest {#percent_opposed_by_nearest}

```csharp
float Percent_opposed_by_nearest { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_opposed_by_nearest = movement_vehicle_od.Percent_opposed_by_nearest;
        movement_vehicle_od.Percent_opposed_by_nearest = 0.0;
        ```

    === "C++"

        ```cpp
        double percent_opposed_by_nearest;
        movement_vehicle_od->get_Percent_opposed_by_nearest(&percent_opposed_by_nearest);
        movement_vehicle_od->put_Percent_opposed_by_nearest(0.0);
        ```

    === "Python"

        ```python
        percent_opposed_by_nearest = movement_vehicle_od.Percent_opposed_by_nearest
        movement_vehicle_od.Percent_opposed_by_nearest = 0.0
        ```

### Opposing_ped_effect_option_signals {#opposing_ped_effect_option_signals}

Opposing Pedestrian Effect Option (Signalised)

```csharp
int Opposing_ped_effect_option_signals { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `4` - Start Loss (Program)
- `5` - Saturation Flow Adjustment
- `6` - Start Loss (Input)

???- example "Code samples"

    === "C#"

        ```csharp
        int opposing_ped_effect_option_signals = movement_vehicle_od.Opposing_ped_effect_option_signals;
        movement_vehicle_od.Opposing_ped_effect_option_signals = 0;
        ```

    === "C++"

        ```cpp
        long opposing_ped_effect_option_signals;
        movement_vehicle_od->get_Opposing_ped_effect_option_signals(&opposing_ped_effect_option_signals);
        movement_vehicle_od->put_Opposing_ped_effect_option_signals(0);
        ```

    === "Python"

        ```python
        opposing_ped_effect_option_signals = movement_vehicle_od.Opposing_ped_effect_option_signals
        movement_vehicle_od.Opposing_ped_effect_option_signals = 0
        ```

### Opposing_ped_effect_option {#opposing_ped_effect_option}

Opposing Pedestrian Effect Option

```csharp
int Opposing_ped_effect_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Program (Flow)

???- example "Code samples"

    === "C#"

        ```csharp
        int opposing_ped_effect_option = movement_vehicle_od.Opposing_ped_effect_option;
        movement_vehicle_od.Opposing_ped_effect_option = 0;
        ```

    === "C++"

        ```cpp
        long opposing_ped_effect_option;
        movement_vehicle_od->get_Opposing_ped_effect_option(&opposing_ped_effect_option);
        movement_vehicle_od->put_Opposing_ped_effect_option(0);
        ```

    === "Python"

        ```python
        opposing_ped_effect_option = movement_vehicle_od.Opposing_ped_effect_option
        movement_vehicle_od.Opposing_ped_effect_option = 0
        ```

### Opposing_ped_effect_start_loss {#opposing_ped_effect_start_loss}

```csharp
float Opposing_ped_effect_start_loss { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_ped_effect_start_loss = movement_vehicle_od.Opposing_ped_effect_start_loss;
        movement_vehicle_od.Opposing_ped_effect_start_loss = 0.0;
        ```

    === "C++"

        ```cpp
        double opposing_ped_effect_start_loss;
        movement_vehicle_od->get_Opposing_ped_effect_start_loss(&opposing_ped_effect_start_loss);
        movement_vehicle_od->put_Opposing_ped_effect_start_loss(0.0);
        ```

    === "Python"

        ```python
        opposing_ped_effect_start_loss = movement_vehicle_od.Opposing_ped_effect_start_loss
        movement_vehicle_od.Opposing_ped_effect_start_loss = 0.0
        ```

### Total_volume {#total_volume}

```csharp
float Total_volume { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_volume = movement_vehicle_od.Total_volume;
        ```

    === "C++"

        ```cpp
        double total_volume;
        movement_vehicle_od->get_Total_volume(&total_volume);
        ```

    === "Python"

        ```python
        total_volume = movement_vehicle_od.Total_volume
        ```

### Zebra_ped_gap_acceptance_option {#zebra_ped_gap_acceptance_option}

Gap Acceptance Option for opposing Zebra Crossing Pedestrians

```csharp
int Zebra_ped_gap_acceptance_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Program
- `2` - User Input

???- example "Code samples"

    === "C#"

        ```csharp
        int zebra_ped_gap_acceptance_option = movement_vehicle_od.Zebra_ped_gap_acceptance_option;
        movement_vehicle_od.Zebra_ped_gap_acceptance_option = 0;
        ```

    === "C++"

        ```cpp
        long zebra_ped_gap_acceptance_option;
        movement_vehicle_od->get_Zebra_ped_gap_acceptance_option(&zebra_ped_gap_acceptance_option);
        movement_vehicle_od->put_Zebra_ped_gap_acceptance_option(0);
        ```

    === "Python"

        ```python
        zebra_ped_gap_acceptance_option = movement_vehicle_od.Zebra_ped_gap_acceptance_option
        movement_vehicle_od.Zebra_ped_gap_acceptance_option = 0
        ```

### Zebra_ped_critical_gap {#zebra_ped_critical_gap}

```csharp
float Zebra_ped_critical_gap { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float zebra_ped_critical_gap = movement_vehicle_od.Zebra_ped_critical_gap;
        movement_vehicle_od.Zebra_ped_critical_gap = 0.0;
        ```

    === "C++"

        ```cpp
        double zebra_ped_critical_gap;
        movement_vehicle_od->get_Zebra_ped_critical_gap(&zebra_ped_critical_gap);
        movement_vehicle_od->put_Zebra_ped_critical_gap(0.0);
        ```

    === "Python"

        ```python
        zebra_ped_critical_gap = movement_vehicle_od.Zebra_ped_critical_gap
        movement_vehicle_od.Zebra_ped_critical_gap = 0.0
        ```

### Zebra_ped_followup_headway {#zebra_ped_followup_headway}

```csharp
float Zebra_ped_followup_headway { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float zebra_ped_followup_headway = movement_vehicle_od.Zebra_ped_followup_headway;
        movement_vehicle_od.Zebra_ped_followup_headway = 0.0;
        ```

    === "C++"

        ```cpp
        double zebra_ped_followup_headway;
        movement_vehicle_od->get_Zebra_ped_followup_headway(&zebra_ped_followup_headway);
        movement_vehicle_od->put_Zebra_ped_followup_headway(0.0);
        ```

    === "Python"

        ```python
        zebra_ped_followup_headway = movement_vehicle_od.Zebra_ped_followup_headway
        movement_vehicle_od.Zebra_ped_followup_headway = 0.0
        ```

### Zebra_ped_minimum_departures {#zebra_ped_minimum_departures}

```csharp
float Zebra_ped_minimum_departures { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float zebra_ped_minimum_departures = movement_vehicle_od.Zebra_ped_minimum_departures;
        movement_vehicle_od.Zebra_ped_minimum_departures = 0.0;
        ```

    === "C++"

        ```cpp
        double zebra_ped_minimum_departures;
        movement_vehicle_od->get_Zebra_ped_minimum_departures(&zebra_ped_minimum_departures);
        movement_vehicle_od->put_Zebra_ped_minimum_departures(0.0);
        ```

    === "Python"

        ```python
        zebra_ped_minimum_departures = movement_vehicle_od.Zebra_ped_minimum_departures
        movement_vehicle_od.Zebra_ped_minimum_departures = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_vehicle_od_mc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc
title: Movement_vehicle_od_mc
name: ISIAPIMovement_vehicle_od_mc
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 88FA3F41-A9A6-43DA-9097-FCD3CEE310B8
summary: SIDRA INTERSECTION Vehicle Approach Movement (per Movement Class) wrapper interface
members:
  - int MC_class
  - bool Exists
  - ISIAPIMovement_vehicle_od Movement_vehicle_od
  - float Volume
  - float Occupancy
  - float Growth_rate
  - float Flow_scale
  - float Peak_flow_factor
  - float Approach_speed
  - float Exit_speed
  - bool Exit_distance_user
  - float Exit_distance
  - bool Negotiation_distance_user
  - float Negotiation_distance
  - int Negotiation_radius_option
  - float Negotiation_radius
  - bool Negotiation_speed_user
  - float Negotiation_speed
  - float Queue_space
  - float Vehicle_length
  - int Turn_veh_effect_option
  - float Turning_veh_factor
  - float Turn_radius
  - float Gap_acceptance_factor
  - float Opposing_veh_factor
  - bool Practical_degree_of_saturation_user
  - float Practical_degree_of_saturation
  - int Coordination_type
  - int Arrival_type
  - float Arrival_percentage
  - bool Non_actuated
  - bool Turn_on_red
  - float Start_loss
  - float End_gain
  - bool Minimum_green_time_user
  - float Minimum_green_time
  - bool Maximum_green_time_user
  - float Maximum_green_time
  - bool Stopline_travel_time_user
  - float Stopline_travel_time
  - int Phase_actuation_option
  - float Phase_actuation_percent
  - bool Is_high_priority
  - bool Has_extra_midblock_delay
  - float Extra_midblock_delay
---

# Movement_vehicle_od_mc

Type `ISIAPIMovement_vehicle_od_mc` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `88FA3F41-A9A6-43DA-9097-FCD3CEE310B8`

SIDRA INTERSECTION Vehicle Approach Movement (per Movement Class) wrapper interface

## Declaration

```csharp
[Guid("88FA3F41-A9A6-43DA-9097-FCD3CEE310B8")]
public interface ISIAPIMovement_vehicle_od_mc
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [Exists](#exists) | `bool` | Flag indicating whether this OD MC movement "exists" or is running (not banned) in the current site. |
| [Movement_vehicle_od](#movement_vehicle_od) | [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md) |  |
| [Volume](#volume) | `float` | Volume (veh) |
| [Occupancy](#occupancy) | `float` | Vehicle Occupancy (persons/veh) |
| [Growth_rate](#growth_rate) | `float` | Growth rate (%/year) |
| [Flow_scale](#flow_scale) | `float` | Flow Scale (Constant) (%) |
| [Peak_flow_factor](#peak_flow_factor) | `float` | Peak Flow Factor (%) |
| [Approach_speed](#approach_speed) | `float` | Approach Cruise Speed |
| [Exit_speed](#exit_speed) | `float` | Exit Cruise Speed |
| [Exit_distance_user](#exit_distance_user) | `bool` | Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Exit_distance` or an automatically calculated value in processing. |
| [Exit_distance](#exit_distance) | `float` | User given Exit distance (Downstream Distance). This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Exit_distance_user` is set to True, otherwise SIDRA INTERSECTION calculates the value automatically. |
| [Negotiation_distance_user](#negotiation_distance_user) | `bool` | Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_distance` or an automatically calculated value in processing. |
| [Negotiation_distance](#negotiation_distance) | `float` | User given Negotiation distance. This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_distance_user` is set to True, otherwise SIDRA INTERSECTION calculates the value automatically. |
| [Negotiation_radius_option](#negotiation_radius_option) | `int` | User given Negotiation Radius option. |
| [Negotiation_radius](#negotiation_radius) | `float` | User given Negotiation radius. This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_radius_option` is set to Radius, otherwise SIDRA INTERSECTION calculates the value automatically. |
| [Negotiation_speed_user](#negotiation_speed_user) | `bool` | Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_speed` or an automatically calculated value in processing. |
| [Negotiation_speed](#negotiation_speed) | `float` | User given Negotiation speed. This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_speed_user` is set to True, otherwise SIDRA INTERSECTION calculates the value automatically. |
| [Queue_space](#queue_space) | `float` |  |
| [Vehicle_length](#vehicle_length) | `float` |  |
| [Turn_veh_effect_option](#turn_veh_effect_option) | `int` | Turning Vehicle Effect |
| [Turning_veh_factor](#turning_veh_factor) | `float` |  |
| [Turn_radius](#turn_radius) | `float` |  |
| [Gap_acceptance_factor](#gap_acceptance_factor) | `float` |  |
| [Opposing_veh_factor](#opposing_veh_factor) | `float` |  |
| [Practical_degree_of_saturation_user](#practical_degree_of_saturation_user) | `bool` |  |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` |  |
| [Coordination_type](#coordination_type) | `int` | Signal Coordination |
| [Arrival_type](#arrival_type) | `int` | Arrival Type |
| [Arrival_percentage](#arrival_percentage) | `float` |  |
| [Non_actuated](#non_actuated) | `bool` |  |
| [Turn_on_red](#turn_on_red) | `bool` |  |
| [Start_loss](#start_loss) | `float` |  |
| [End_gain](#end_gain) | `float` |  |
| [Minimum_green_time_user](#minimum_green_time_user) | `bool` |  |
| [Minimum_green_time](#minimum_green_time) | `float` |  |
| [Maximum_green_time_user](#maximum_green_time_user) | `bool` |  |
| [Maximum_green_time](#maximum_green_time) | `float` |  |
| [Stopline_travel_time_user](#stopline_travel_time_user) | `bool` |  |
| [Stopline_travel_time](#stopline_travel_time) | `float` |  |
| [Phase_actuation_option](#phase_actuation_option) | `int` |  |
| [Phase_actuation_percent](#phase_actuation_percent) | `float` |  |
| [Is_high_priority](#is_high_priority) | `bool` | High Priority for Green Splits |
| [Has_extra_midblock_delay](#has_extra_midblock_delay) | `bool` |  |
| [Extra_midblock_delay](#extra_midblock_delay) | `float` |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = movement_vehicle_od_mc.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        movement_vehicle_od_mc->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = movement_vehicle_od_mc.MC_class
        ```

### Exists {#exists}

Flag indicating whether this OD MC movement "exists" or is running (not banned)
in the current site.

```csharp
bool Exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = movement_vehicle_od_mc.Exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        movement_vehicle_od_mc->get_Exists(&exists);
        ```

    === "Python"

        ```python
        exists = movement_vehicle_od_mc.Exists
        ```

### Movement_vehicle_od {#movement_vehicle_od}

```csharp
ISIAPIMovement_vehicle_od Movement_vehicle_od { get; }
```

**Type** [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movement_vehicle_od = movement_vehicle_od_mc.Movement_vehicle_od;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od> movement_vehicle_od;
        movement_vehicle_od_mc->get_Movement_vehicle_od(&movement_vehicle_od);
        ```

    === "Python"

        ```python
        movement_vehicle_od = movement_vehicle_od_mc.Movement_vehicle_od
        ```

### Volume {#volume}

Volume (veh)

```csharp
float Volume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float volume = movement_vehicle_od_mc.Volume;
        movement_vehicle_od_mc.Volume = 0.0;
        ```

    === "C++"

        ```cpp
        double volume;
        movement_vehicle_od_mc->get_Volume(&volume);
        movement_vehicle_od_mc->put_Volume(0.0);
        ```

    === "Python"

        ```python
        volume = movement_vehicle_od_mc.Volume
        movement_vehicle_od_mc.Volume = 0.0
        ```

### Occupancy {#occupancy}

Vehicle Occupancy (persons/veh)

```csharp
float Occupancy { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float occupancy = movement_vehicle_od_mc.Occupancy;
        movement_vehicle_od_mc.Occupancy = 0.0;
        ```

    === "C++"

        ```cpp
        double occupancy;
        movement_vehicle_od_mc->get_Occupancy(&occupancy);
        movement_vehicle_od_mc->put_Occupancy(0.0);
        ```

    === "Python"

        ```python
        occupancy = movement_vehicle_od_mc.Occupancy
        movement_vehicle_od_mc.Occupancy = 0.0
        ```

### Growth_rate {#growth_rate}

Growth rate (%/year)

```csharp
float Growth_rate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float growth_rate = movement_vehicle_od_mc.Growth_rate;
        movement_vehicle_od_mc.Growth_rate = 0.0;
        ```

    === "C++"

        ```cpp
        double growth_rate;
        movement_vehicle_od_mc->get_Growth_rate(&growth_rate);
        movement_vehicle_od_mc->put_Growth_rate(0.0);
        ```

    === "Python"

        ```python
        growth_rate = movement_vehicle_od_mc.Growth_rate
        movement_vehicle_od_mc.Growth_rate = 0.0
        ```

### Flow_scale {#flow_scale}

Flow Scale (Constant) (%)

```csharp
float Flow_scale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_scale = movement_vehicle_od_mc.Flow_scale;
        movement_vehicle_od_mc.Flow_scale = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_scale;
        movement_vehicle_od_mc->get_Flow_scale(&flow_scale);
        movement_vehicle_od_mc->put_Flow_scale(0.0);
        ```

    === "Python"

        ```python
        flow_scale = movement_vehicle_od_mc.Flow_scale
        movement_vehicle_od_mc.Flow_scale = 0.0
        ```

### Peak_flow_factor {#peak_flow_factor}

Peak Flow Factor (%)

```csharp
float Peak_flow_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float peak_flow_factor = movement_vehicle_od_mc.Peak_flow_factor;
        movement_vehicle_od_mc.Peak_flow_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double peak_flow_factor;
        movement_vehicle_od_mc->get_Peak_flow_factor(&peak_flow_factor);
        movement_vehicle_od_mc->put_Peak_flow_factor(0.0);
        ```

    === "Python"

        ```python
        peak_flow_factor = movement_vehicle_od_mc.Peak_flow_factor
        movement_vehicle_od_mc.Peak_flow_factor = 0.0
        ```

### Approach_speed {#approach_speed}

Approach Cruise Speed

```csharp
float Approach_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float approach_speed = movement_vehicle_od_mc.Approach_speed;
        movement_vehicle_od_mc.Approach_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double approach_speed;
        movement_vehicle_od_mc->get_Approach_speed(&approach_speed);
        movement_vehicle_od_mc->put_Approach_speed(0.0);
        ```

    === "Python"

        ```python
        approach_speed = movement_vehicle_od_mc.Approach_speed
        movement_vehicle_od_mc.Approach_speed = 0.0
        ```

### Exit_speed {#exit_speed}

Exit Cruise Speed

```csharp
float Exit_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_speed = movement_vehicle_od_mc.Exit_speed;
        movement_vehicle_od_mc.Exit_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_speed;
        movement_vehicle_od_mc->get_Exit_speed(&exit_speed);
        movement_vehicle_od_mc->put_Exit_speed(0.0);
        ```

    === "Python"

        ```python
        exit_speed = movement_vehicle_od_mc.Exit_speed
        movement_vehicle_od_mc.Exit_speed = 0.0
        ```

### Exit_distance_user {#exit_distance_user}

Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Exit_distance` or an automatically calculated value in
processing.

```csharp
bool Exit_distance_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exit_distance_user = movement_vehicle_od_mc.Exit_distance_user;
        movement_vehicle_od_mc.Exit_distance_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exit_distance_user;
        movement_vehicle_od_mc->get_Exit_distance_user(&exit_distance_user);
        movement_vehicle_od_mc->put_Exit_distance_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exit_distance_user = movement_vehicle_od_mc.Exit_distance_user
        movement_vehicle_od_mc.Exit_distance_user = True
        ```

### Exit_distance {#exit_distance}

User given Exit distance (Downstream Distance).

This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Exit_distance_user` is set to True, otherwise SIDRA
INTERSECTION calculates the value automatically.

```csharp
float Exit_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_distance = movement_vehicle_od_mc.Exit_distance;
        movement_vehicle_od_mc.Exit_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double exit_distance;
        movement_vehicle_od_mc->get_Exit_distance(&exit_distance);
        movement_vehicle_od_mc->put_Exit_distance(0.0);
        ```

    === "Python"

        ```python
        exit_distance = movement_vehicle_od_mc.Exit_distance
        movement_vehicle_od_mc.Exit_distance = 0.0
        ```

### Negotiation_distance_user {#negotiation_distance_user}

Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_distance` or an automatically calculated
value in processing.

```csharp
bool Negotiation_distance_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool negotiation_distance_user = movement_vehicle_od_mc.Negotiation_distance_user;
        movement_vehicle_od_mc.Negotiation_distance_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL negotiation_distance_user;
        movement_vehicle_od_mc->get_Negotiation_distance_user(&negotiation_distance_user);
        movement_vehicle_od_mc->put_Negotiation_distance_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        negotiation_distance_user = movement_vehicle_od_mc.Negotiation_distance_user
        movement_vehicle_od_mc.Negotiation_distance_user = True
        ```

### Negotiation_distance {#negotiation_distance}

User given Negotiation distance.

This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_distance_user` is set to True,
otherwise SIDRA INTERSECTION calculates the value automatically.

```csharp
float Negotiation_distance { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float negotiation_distance = movement_vehicle_od_mc.Negotiation_distance;
        movement_vehicle_od_mc.Negotiation_distance = 0.0;
        ```

    === "C++"

        ```cpp
        double negotiation_distance;
        movement_vehicle_od_mc->get_Negotiation_distance(&negotiation_distance);
        movement_vehicle_od_mc->put_Negotiation_distance(0.0);
        ```

    === "Python"

        ```python
        negotiation_distance = movement_vehicle_od_mc.Negotiation_distance
        movement_vehicle_od_mc.Negotiation_distance = 0.0
        ```

### Negotiation_radius_option {#negotiation_radius_option}

User given Negotiation Radius option.

```csharp
int Negotiation_radius_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Program
- `2` - Radius
- `3` - Straight

???- example "Code samples"

    === "C#"

        ```csharp
        int negotiation_radius_option = movement_vehicle_od_mc.Negotiation_radius_option;
        movement_vehicle_od_mc.Negotiation_radius_option = 0;
        ```

    === "C++"

        ```cpp
        long negotiation_radius_option;
        movement_vehicle_od_mc->get_Negotiation_radius_option(&negotiation_radius_option);
        movement_vehicle_od_mc->put_Negotiation_radius_option(0);
        ```

    === "Python"

        ```python
        negotiation_radius_option = movement_vehicle_od_mc.Negotiation_radius_option
        movement_vehicle_od_mc.Negotiation_radius_option = 0
        ```

### Negotiation_radius {#negotiation_radius}

User given Negotiation radius.  
This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_radius_option` is set to
Radius, otherwise SIDRA INTERSECTION calculates the value
automatically.

```csharp
float Negotiation_radius { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float negotiation_radius = movement_vehicle_od_mc.Negotiation_radius;
        movement_vehicle_od_mc.Negotiation_radius = 0.0;
        ```

    === "C++"

        ```cpp
        double negotiation_radius;
        movement_vehicle_od_mc->get_Negotiation_radius(&negotiation_radius);
        movement_vehicle_od_mc->put_Negotiation_radius(0.0);
        ```

    === "Python"

        ```python
        negotiation_radius = movement_vehicle_od_mc.Negotiation_radius
        movement_vehicle_od_mc.Negotiation_radius = 0.0
        ```

### Negotiation_speed_user {#negotiation_speed_user}

Flag indicating whether to use the value specified by `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_speed` or an automatically calculated value in
processing.

```csharp
bool Negotiation_speed_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool negotiation_speed_user = movement_vehicle_od_mc.Negotiation_speed_user;
        movement_vehicle_od_mc.Negotiation_speed_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL negotiation_speed_user;
        movement_vehicle_od_mc->get_Negotiation_speed_user(&negotiation_speed_user);
        movement_vehicle_od_mc->put_Negotiation_speed_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        negotiation_speed_user = movement_vehicle_od_mc.Negotiation_speed_user
        movement_vehicle_od_mc.Negotiation_speed_user = True
        ```

### Negotiation_speed {#negotiation_speed}

User given Negotiation speed.

This value is used in processing if `SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mc.Negotiation_speed_user` is set to True, otherwise
SIDRA INTERSECTION calculates the value automatically.

```csharp
float Negotiation_speed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float negotiation_speed = movement_vehicle_od_mc.Negotiation_speed;
        movement_vehicle_od_mc.Negotiation_speed = 0.0;
        ```

    === "C++"

        ```cpp
        double negotiation_speed;
        movement_vehicle_od_mc->get_Negotiation_speed(&negotiation_speed);
        movement_vehicle_od_mc->put_Negotiation_speed(0.0);
        ```

    === "Python"

        ```python
        negotiation_speed = movement_vehicle_od_mc.Negotiation_speed
        movement_vehicle_od_mc.Negotiation_speed = 0.0
        ```

### Queue_space {#queue_space}

```csharp
float Queue_space { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_space = movement_vehicle_od_mc.Queue_space;
        movement_vehicle_od_mc.Queue_space = 0.0;
        ```

    === "C++"

        ```cpp
        double queue_space;
        movement_vehicle_od_mc->get_Queue_space(&queue_space);
        movement_vehicle_od_mc->put_Queue_space(0.0);
        ```

    === "Python"

        ```python
        queue_space = movement_vehicle_od_mc.Queue_space
        movement_vehicle_od_mc.Queue_space = 0.0
        ```

### Vehicle_length {#vehicle_length}

```csharp
float Vehicle_length { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float vehicle_length = movement_vehicle_od_mc.Vehicle_length;
        movement_vehicle_od_mc.Vehicle_length = 0.0;
        ```

    === "C++"

        ```cpp
        double vehicle_length;
        movement_vehicle_od_mc->get_Vehicle_length(&vehicle_length);
        movement_vehicle_od_mc->put_Vehicle_length(0.0);
        ```

    === "Python"

        ```python
        vehicle_length = movement_vehicle_od_mc.Vehicle_length
        movement_vehicle_od_mc.Vehicle_length = 0.0
        ```

### Turn_veh_effect_option {#turn_veh_effect_option}

Turning Vehicle Effect

```csharp
int Turn_veh_effect_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Turning Vehicle Factor
- `2` - Radius

???- example "Code samples"

    === "C#"

        ```csharp
        int turn_veh_effect_option = movement_vehicle_od_mc.Turn_veh_effect_option;
        movement_vehicle_od_mc.Turn_veh_effect_option = 0;
        ```

    === "C++"

        ```cpp
        long turn_veh_effect_option;
        movement_vehicle_od_mc->get_Turn_veh_effect_option(&turn_veh_effect_option);
        movement_vehicle_od_mc->put_Turn_veh_effect_option(0);
        ```

    === "Python"

        ```python
        turn_veh_effect_option = movement_vehicle_od_mc.Turn_veh_effect_option
        movement_vehicle_od_mc.Turn_veh_effect_option = 0
        ```

### Turning_veh_factor {#turning_veh_factor}

```csharp
float Turning_veh_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float turning_veh_factor = movement_vehicle_od_mc.Turning_veh_factor;
        movement_vehicle_od_mc.Turning_veh_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double turning_veh_factor;
        movement_vehicle_od_mc->get_Turning_veh_factor(&turning_veh_factor);
        movement_vehicle_od_mc->put_Turning_veh_factor(0.0);
        ```

    === "Python"

        ```python
        turning_veh_factor = movement_vehicle_od_mc.Turning_veh_factor
        movement_vehicle_od_mc.Turning_veh_factor = 0.0
        ```

### Turn_radius {#turn_radius}

```csharp
float Turn_radius { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float turn_radius = movement_vehicle_od_mc.Turn_radius;
        movement_vehicle_od_mc.Turn_radius = 0.0;
        ```

    === "C++"

        ```cpp
        double turn_radius;
        movement_vehicle_od_mc->get_Turn_radius(&turn_radius);
        movement_vehicle_od_mc->put_Turn_radius(0.0);
        ```

    === "Python"

        ```python
        turn_radius = movement_vehicle_od_mc.Turn_radius
        movement_vehicle_od_mc.Turn_radius = 0.0
        ```

### Gap_acceptance_factor {#gap_acceptance_factor}

```csharp
float Gap_acceptance_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acceptance_factor = movement_vehicle_od_mc.Gap_acceptance_factor;
        movement_vehicle_od_mc.Gap_acceptance_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double gap_acceptance_factor;
        movement_vehicle_od_mc->get_Gap_acceptance_factor(&gap_acceptance_factor);
        movement_vehicle_od_mc->put_Gap_acceptance_factor(0.0);
        ```

    === "Python"

        ```python
        gap_acceptance_factor = movement_vehicle_od_mc.Gap_acceptance_factor
        movement_vehicle_od_mc.Gap_acceptance_factor = 0.0
        ```

### Opposing_veh_factor {#opposing_veh_factor}

```csharp
float Opposing_veh_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_veh_factor = movement_vehicle_od_mc.Opposing_veh_factor;
        movement_vehicle_od_mc.Opposing_veh_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double opposing_veh_factor;
        movement_vehicle_od_mc->get_Opposing_veh_factor(&opposing_veh_factor);
        movement_vehicle_od_mc->put_Opposing_veh_factor(0.0);
        ```

    === "Python"

        ```python
        opposing_veh_factor = movement_vehicle_od_mc.Opposing_veh_factor
        movement_vehicle_od_mc.Opposing_veh_factor = 0.0
        ```

### Practical_degree_of_saturation_user {#practical_degree_of_saturation_user}

```csharp
bool Practical_degree_of_saturation_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_degree_of_saturation_user = movement_vehicle_od_mc.Practical_degree_of_saturation_user;
        movement_vehicle_od_mc.Practical_degree_of_saturation_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_degree_of_saturation_user;
        movement_vehicle_od_mc->get_Practical_degree_of_saturation_user(&practical_degree_of_saturation_user);
        movement_vehicle_od_mc->put_Practical_degree_of_saturation_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation_user = movement_vehicle_od_mc.Practical_degree_of_saturation_user
        movement_vehicle_od_mc.Practical_degree_of_saturation_user = True
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

```csharp
float Practical_degree_of_saturation { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = movement_vehicle_od_mc.Practical_degree_of_saturation;
        movement_vehicle_od_mc.Practical_degree_of_saturation = 0.0;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        movement_vehicle_od_mc->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        movement_vehicle_od_mc->put_Practical_degree_of_saturation(0.0);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = movement_vehicle_od_mc.Practical_degree_of_saturation
        movement_vehicle_od_mc.Practical_degree_of_saturation = 0.0
        ```

### Coordination_type {#coordination_type}

Signal Coordination

```csharp
int Coordination_type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Arrival Type
- `2` - Arrivals % During Green
- `3` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int coordination_type = movement_vehicle_od_mc.Coordination_type;
        movement_vehicle_od_mc.Coordination_type = 0;
        ```

    === "C++"

        ```cpp
        long coordination_type;
        movement_vehicle_od_mc->get_Coordination_type(&coordination_type);
        movement_vehicle_od_mc->put_Coordination_type(0);
        ```

    === "Python"

        ```python
        coordination_type = movement_vehicle_od_mc.Coordination_type
        movement_vehicle_od_mc.Coordination_type = 0
        ```

### Arrival_type {#arrival_type}

Arrival Type

```csharp
int Arrival_type { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Very Poor
- `2` - Non-favourable
- `3` - Isolated (not coord)
- `4` - Favourable
- `5` - Highly Favourable
- `6` - Exceptional

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_type = movement_vehicle_od_mc.Arrival_type;
        movement_vehicle_od_mc.Arrival_type = 0;
        ```

    === "C++"

        ```cpp
        long arrival_type;
        movement_vehicle_od_mc->get_Arrival_type(&arrival_type);
        movement_vehicle_od_mc->put_Arrival_type(0);
        ```

    === "Python"

        ```python
        arrival_type = movement_vehicle_od_mc.Arrival_type
        movement_vehicle_od_mc.Arrival_type = 0
        ```

### Arrival_percentage {#arrival_percentage}

```csharp
float Arrival_percentage { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_percentage = movement_vehicle_od_mc.Arrival_percentage;
        movement_vehicle_od_mc.Arrival_percentage = 0.0;
        ```

    === "C++"

        ```cpp
        double arrival_percentage;
        movement_vehicle_od_mc->get_Arrival_percentage(&arrival_percentage);
        movement_vehicle_od_mc->put_Arrival_percentage(0.0);
        ```

    === "Python"

        ```python
        arrival_percentage = movement_vehicle_od_mc.Arrival_percentage
        movement_vehicle_od_mc.Arrival_percentage = 0.0
        ```

### Non_actuated {#non_actuated}

```csharp
bool Non_actuated { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool non_actuated = movement_vehicle_od_mc.Non_actuated;
        movement_vehicle_od_mc.Non_actuated = false;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL non_actuated;
        movement_vehicle_od_mc->get_Non_actuated(&non_actuated);
        movement_vehicle_od_mc->put_Non_actuated(VARIANT_FALSE);
        ```

    === "Python"

        ```python
        non_actuated = movement_vehicle_od_mc.Non_actuated
        movement_vehicle_od_mc.Non_actuated = False
        ```

### Turn_on_red {#turn_on_red}

```csharp
bool Turn_on_red { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool turn_on_red = movement_vehicle_od_mc.Turn_on_red;
        movement_vehicle_od_mc.Turn_on_red = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL turn_on_red;
        movement_vehicle_od_mc->get_Turn_on_red(&turn_on_red);
        movement_vehicle_od_mc->put_Turn_on_red(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        turn_on_red = movement_vehicle_od_mc.Turn_on_red
        movement_vehicle_od_mc.Turn_on_red = True
        ```

### Start_loss {#start_loss}

```csharp
float Start_loss { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_loss = movement_vehicle_od_mc.Start_loss;
        movement_vehicle_od_mc.Start_loss = 0.0;
        ```

    === "C++"

        ```cpp
        double start_loss;
        movement_vehicle_od_mc->get_Start_loss(&start_loss);
        movement_vehicle_od_mc->put_Start_loss(0.0);
        ```

    === "Python"

        ```python
        start_loss = movement_vehicle_od_mc.Start_loss
        movement_vehicle_od_mc.Start_loss = 0.0
        ```

### End_gain {#end_gain}

```csharp
float End_gain { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_gain = movement_vehicle_od_mc.End_gain;
        movement_vehicle_od_mc.End_gain = 0.0;
        ```

    === "C++"

        ```cpp
        double end_gain;
        movement_vehicle_od_mc->get_End_gain(&end_gain);
        movement_vehicle_od_mc->put_End_gain(0.0);
        ```

    === "Python"

        ```python
        end_gain = movement_vehicle_od_mc.End_gain
        movement_vehicle_od_mc.End_gain = 0.0
        ```

### Minimum_green_time_user {#minimum_green_time_user}

```csharp
bool Minimum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool minimum_green_time_user = movement_vehicle_od_mc.Minimum_green_time_user;
        movement_vehicle_od_mc.Minimum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL minimum_green_time_user;
        movement_vehicle_od_mc->get_Minimum_green_time_user(&minimum_green_time_user);
        movement_vehicle_od_mc->put_Minimum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        minimum_green_time_user = movement_vehicle_od_mc.Minimum_green_time_user
        movement_vehicle_od_mc.Minimum_green_time_user = True
        ```

### Minimum_green_time {#minimum_green_time}

```csharp
float Minimum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_green_time = movement_vehicle_od_mc.Minimum_green_time;
        movement_vehicle_od_mc.Minimum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_green_time;
        movement_vehicle_od_mc->get_Minimum_green_time(&minimum_green_time);
        movement_vehicle_od_mc->put_Minimum_green_time(0.0);
        ```

    === "Python"

        ```python
        minimum_green_time = movement_vehicle_od_mc.Minimum_green_time
        movement_vehicle_od_mc.Minimum_green_time = 0.0
        ```

### Maximum_green_time_user {#maximum_green_time_user}

```csharp
bool Maximum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool maximum_green_time_user = movement_vehicle_od_mc.Maximum_green_time_user;
        movement_vehicle_od_mc.Maximum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL maximum_green_time_user;
        movement_vehicle_od_mc->get_Maximum_green_time_user(&maximum_green_time_user);
        movement_vehicle_od_mc->put_Maximum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        maximum_green_time_user = movement_vehicle_od_mc.Maximum_green_time_user
        movement_vehicle_od_mc.Maximum_green_time_user = True
        ```

### Maximum_green_time {#maximum_green_time}

```csharp
float Maximum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float maximum_green_time = movement_vehicle_od_mc.Maximum_green_time;
        movement_vehicle_od_mc.Maximum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double maximum_green_time;
        movement_vehicle_od_mc->get_Maximum_green_time(&maximum_green_time);
        movement_vehicle_od_mc->put_Maximum_green_time(0.0);
        ```

    === "Python"

        ```python
        maximum_green_time = movement_vehicle_od_mc.Maximum_green_time
        movement_vehicle_od_mc.Maximum_green_time = 0.0
        ```

### Stopline_travel_time_user {#stopline_travel_time_user}

```csharp
bool Stopline_travel_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool stopline_travel_time_user = movement_vehicle_od_mc.Stopline_travel_time_user;
        movement_vehicle_od_mc.Stopline_travel_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL stopline_travel_time_user;
        movement_vehicle_od_mc->get_Stopline_travel_time_user(&stopline_travel_time_user);
        movement_vehicle_od_mc->put_Stopline_travel_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        stopline_travel_time_user = movement_vehicle_od_mc.Stopline_travel_time_user
        movement_vehicle_od_mc.Stopline_travel_time_user = True
        ```

### Stopline_travel_time {#stopline_travel_time}

```csharp
float Stopline_travel_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopline_travel_time = movement_vehicle_od_mc.Stopline_travel_time;
        movement_vehicle_od_mc.Stopline_travel_time = 0.0;
        ```

    === "C++"

        ```cpp
        double stopline_travel_time;
        movement_vehicle_od_mc->get_Stopline_travel_time(&stopline_travel_time);
        movement_vehicle_od_mc->put_Stopline_travel_time(0.0);
        ```

    === "Python"

        ```python
        stopline_travel_time = movement_vehicle_od_mc.Stopline_travel_time
        movement_vehicle_od_mc.Stopline_travel_time = 0.0
        ```

### Phase_actuation_option {#phase_actuation_option}

```csharp
int Phase_actuation_option { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int phase_actuation_option = movement_vehicle_od_mc.Phase_actuation_option;
        movement_vehicle_od_mc.Phase_actuation_option = 0;
        ```

    === "C++"

        ```cpp
        long phase_actuation_option;
        movement_vehicle_od_mc->get_Phase_actuation_option(&phase_actuation_option);
        movement_vehicle_od_mc->put_Phase_actuation_option(0);
        ```

    === "Python"

        ```python
        phase_actuation_option = movement_vehicle_od_mc.Phase_actuation_option
        movement_vehicle_od_mc.Phase_actuation_option = 0
        ```

### Phase_actuation_percent {#phase_actuation_percent}

```csharp
float Phase_actuation_percent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_actuation_percent = movement_vehicle_od_mc.Phase_actuation_percent;
        movement_vehicle_od_mc.Phase_actuation_percent = 0.0;
        ```

    === "C++"

        ```cpp
        double phase_actuation_percent;
        movement_vehicle_od_mc->get_Phase_actuation_percent(&phase_actuation_percent);
        movement_vehicle_od_mc->put_Phase_actuation_percent(0.0);
        ```

    === "Python"

        ```python
        phase_actuation_percent = movement_vehicle_od_mc.Phase_actuation_percent
        movement_vehicle_od_mc.Phase_actuation_percent = 0.0
        ```

### Is_high_priority {#is_high_priority}

High Priority for Green Splits

```csharp
bool Is_high_priority { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_high_priority = movement_vehicle_od_mc.Is_high_priority;
        movement_vehicle_od_mc.Is_high_priority = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_high_priority;
        movement_vehicle_od_mc->get_Is_high_priority(&is_high_priority);
        movement_vehicle_od_mc->put_Is_high_priority(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_high_priority = movement_vehicle_od_mc.Is_high_priority
        movement_vehicle_od_mc.Is_high_priority = True
        ```

### Has_extra_midblock_delay {#has_extra_midblock_delay}

```csharp
bool Has_extra_midblock_delay { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_extra_midblock_delay = movement_vehicle_od_mc.Has_extra_midblock_delay;
        movement_vehicle_od_mc.Has_extra_midblock_delay = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_extra_midblock_delay;
        movement_vehicle_od_mc->get_Has_extra_midblock_delay(&has_extra_midblock_delay);
        movement_vehicle_od_mc->put_Has_extra_midblock_delay(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        has_extra_midblock_delay = movement_vehicle_od_mc.Has_extra_midblock_delay
        movement_vehicle_od_mc.Has_extra_midblock_delay = True
        ```

### Extra_midblock_delay {#extra_midblock_delay}

```csharp
float Extra_midblock_delay { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float extra_midblock_delay = movement_vehicle_od_mc.Extra_midblock_delay;
        movement_vehicle_od_mc.Extra_midblock_delay = 0.0;
        ```

    === "C++"

        ```cpp
        double extra_midblock_delay;
        movement_vehicle_od_mc->get_Extra_midblock_delay(&extra_midblock_delay);
        movement_vehicle_od_mc->put_Extra_midblock_delay(0.0);
        ```

    === "Python"

        ```python
        extra_midblock_delay = movement_vehicle_od_mc.Extra_midblock_delay
        movement_vehicle_od_mc.Extra_midblock_delay = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_vehicle_od_mcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_vehicle_od_mcs
title: Movement_vehicle_od_mcs
name: ISIAPIMovement_vehicle_od_mcs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5C5CE4B6-7865-41CA-A40F-D77074101350
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIMovement_vehicle_od_mc this[int mcClass]
  - int Count
---

# Movement_vehicle_od_mcs

Type `ISIAPIMovement_vehicle_od_mcs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5C5CE4B6-7865-41CA-A40F-D77074101350`

## Declaration

```csharp
[Guid("5C5CE4B6-7865-41CA-A40F-D77074101350")]
public interface ISIAPIMovement_vehicle_od_mcs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIMovement_vehicle_od_mc`](sidrasolutions.si.api.isiapimovement_vehicle_od_mc.md) | Get a Vehicle Movement by Movement Class. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` | Get a value indicating whether a Vehicle Movement by Movement Class exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = movement_vehicle_od_mcs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        movement_vehicle_od_mcs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = movement_vehicle_od_mcs.Count
        ```

### this[] {#this}

Get a Vehicle Movement by Movement Class.

```csharp
ISIAPIMovement_vehicle_od_mc this[] { get; }
```

**Type** [`ISIAPIMovement_vehicle_od_mc`](sidrasolutions.si.api.isiapimovement_vehicle_od_mc.md) - Return a Vehicle Movement by Movement Class if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = movement_vehicle_od_mcs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od_mc> this[];
        movement_vehicle_od_mcs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = movement_vehicle_od_mcs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

Get a value indicating whether a Vehicle Movement by Movement Class exists in the data storage.

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` | One of: - `1` - Light Vehicles - `2` - Heavy Vehicles - `3` - Buses - `4` - Bicycles - `5` - Large Trucks - `6` - Trams - `7` - User Class 1 - `8` - User Class 2 - `9` - User Class 3 - `10` - User Class 4 - `11` - User Class 5 - `12` - User Class 6 |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = movement_vehicle_od_mcs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        movement_vehicle_od_mcs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = movement_vehicle_od_mcs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovement_vehicle_ods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovement_vehicle_ods
title: Movement_vehicle_ods
name: ISIAPIMovement_vehicle_ods
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 12E07B7C-149F-4A13-8545-C0E2628C4BCA
members:
  - bool MovementExists(int origin, int destination)
  - ISIAPIMovement_vehicle_od this[int origin, int destination]
  - int Count
---

# Movement_vehicle_ods

Type `ISIAPIMovement_vehicle_ods` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `12E07B7C-149F-4A13-8545-C0E2628C4BCA`

## Declaration

```csharp
[Guid("12E07B7C-149F-4A13-8545-C0E2628C4BCA")]
public interface ISIAPIMovement_vehicle_ods
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md) | Get a Vehicle Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int)](#movementexists-int--int) | `bool` | Get a value indicating whether a Vehicle Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = movement_vehicle_ods.Count;
        ```

    === "C++"

        ```cpp
        long count;
        movement_vehicle_ods->get_Count(&count);
        ```

    === "Python"

        ```python
        count = movement_vehicle_ods.Count
        ```

### this[] {#this}

Get a Vehicle Movement.

```csharp
ISIAPIMovement_vehicle_od this[] { get; }
```

**Type** [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md) - Return a Vehicle Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = movement_vehicle_ods.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od> this[];
        movement_vehicle_ods->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = movement_vehicle_ods.this[]
        ```

## Methods

### MovementExists(int, int) {#movementexists-int--int}

Get a value indicating whether a Vehicle Movement exists in the data storage.

```csharp
bool MovementExists(int origin, int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `destination` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = movement_vehicle_ods.MovementExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        movement_vehicle_ods->MovementExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = movement_vehicle_ods.MovementExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovementclass.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovementClass
title: MovementClass
name: ISIAPIMovementClass
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: DFDEB358-FB26-4A07-BDE9-134E0DEDC1C3
members:
  - int MC_class
  - bool Is_included
  - bool Is_userclass
  - string Name
  - string Display_id
  - int Base_class
  - int Model_designation
  - ISIAPIMovementClassFuelEmissions MovementClassFuelEmissions
  - ISIAPISite Site
  - float Pc_equivalent
  - bool Is_cost_included
  - int Cost_method
  - float Fuel_pump_price
  - float Resource_cost_factor
  - float Run_cost_fuel_ratio
  - float Average_income
  - float Time_value_factor
  - float Mass
  - float Max_power
  - float Co2_to_fuel_ratio
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float LowerLimitOfSpeedEfficiency
  - float Gap_acceptance_factor_sliplane_zebra
  - float Gap_acceptance_factor_midblock_zebra
  - ISIAPIMovementClassMergeParam MergeParam
---

# MovementClass

Type `ISIAPIMovementClass` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `DFDEB358-FB26-4A07-BDE9-134E0DEDC1C3`

## Declaration

```csharp
[Guid("DFDEB358-FB26-4A07-BDE9-134E0DEDC1C3")]
public interface ISIAPIMovementClass
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [Is_included](#is_included) | `bool` | Flag indicating whether this Movement Class is included in the Site. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included into any Site. |
| [Is_userclass](#is_userclass) | `bool` |  |
| [Name](#name) | `string` | Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true. |
| [Display_id](#display_id) | `string` | Movement Class Display ID, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true. |
| [Base_class](#base_class) | `int` | The Standard Movement Class that this Movement Class is based on. This Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true. |
| [Model_designation](#model_designation) | `int` | Model Designation |
| [MovementClassFuelEmissions](#movementclassfuelemissions) | [`ISIAPIMovementClassFuelEmissions`](sidrasolutions.si.api.isiapimovementclassfuelemissions.md) |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Pc_equivalent](#pc_equivalent) | `float` | Passenger Car Equivalent |
| [Is_cost_included](#is_cost_included) | `bool` |  |
| [Cost_method](#cost_method) | `int` | Cost Method |
| [Fuel_pump_price](#fuel_pump_price) | `float` | Pump Price of Fuel |
| [Resource_cost_factor](#resource_cost_factor) | `float` | Fuel Resource Cost Factor |
| [Run_cost_fuel_ratio](#run_cost_fuel_ratio) | `float` | Ratio of Running Cost to Fuel Cost |
| [Average_income](#average_income) | `float` |  |
| [Time_value_factor](#time_value_factor) | `float` |  |
| [Mass](#mass) | `float` |  |
| [Max_power](#max_power) | `float` |  |
| [Co2_to_fuel_ratio](#co2_to_fuel_ratio) | `float` | CO2 to Fuel Consumption Rate |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [LowerLimitOfSpeedEfficiency](#lowerlimitofspeedefficiency) | `float` |  |
| [Gap_acceptance_factor_sliplane_zebra](#gap_acceptance_factor_sliplane_zebra) | `float` | Gap Acceptance Factor for Zebra Crossing on Slip Lane |
| [Gap_acceptance_factor_midblock_zebra](#gap_acceptance_factor_midblock_zebra) | `float` | Gap Acceptance Factor for Midblock Zebra Crossing |
| [MergeParam](#mergeparam) | [`ISIAPIMovementClassMergeParam`](sidrasolutions.si.api.isiapimovementclassmergeparam.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = movementClass.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        movementClass->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = movementClass.MC_class
        ```

### Is_included {#is_included}

Flag indicating whether this Movement Class is included in the Site. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included into any Site.

```csharp
bool Is_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_included = movementClass.Is_included;
        movementClass.Is_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_included;
        movementClass->get_Is_included(&is_included);
        movementClass->put_Is_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included = movementClass.Is_included
        movementClass.Is_included = True
        ```

### Is_userclass {#is_userclass}

```csharp
bool Is_userclass { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_userclass = movementClass.Is_userclass;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_userclass;
        movementClass->get_Is_userclass(&is_userclass);
        ```

    === "Python"

        ```python
        is_userclass = movementClass.Is_userclass
        ```

### Name {#name}

Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = movementClass.Name;
        movementClass.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        movementClass->get_Name(&name);
        movementClass->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = movementClass.Name
        movementClass.Name = r"Example"
        ```

### Display_id {#display_id}

Movement Class Display ID, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

```csharp
string Display_id { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string display_id = movementClass.Display_id;
        movementClass.Display_id = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR display_id;
        movementClass->get_Display_id(&display_id);
        movementClass->put_Display_id(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        display_id = movementClass.Display_id
        movementClass.Display_id = r"id-1"
        ```

### Base_class {#base_class}

The Standard Movement Class that this Movement Class is based on. This Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

```csharp
int Base_class { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int base_class = movementClass.Base_class;
        movementClass.Base_class = 0;
        ```

    === "C++"

        ```cpp
        long base_class;
        movementClass->get_Base_class(&base_class);
        movementClass->put_Base_class(0);
        ```

    === "Python"

        ```python
        base_class = movementClass.Base_class
        movementClass.Base_class = 0
        ```

### Model_designation {#model_designation}

Model Designation

```csharp
int Model_designation { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicle
- `2` - Heavy Vehicle

???- example "Code samples"

    === "C#"

        ```csharp
        int model_designation = movementClass.Model_designation;
        ```

    === "C++"

        ```cpp
        long model_designation;
        movementClass->get_Model_designation(&model_designation);
        ```

    === "Python"

        ```python
        model_designation = movementClass.Model_designation
        ```

### MovementClassFuelEmissions {#movementclassfuelemissions}

```csharp
ISIAPIMovementClassFuelEmissions MovementClassFuelEmissions { get; }
```

**Type** [`ISIAPIMovementClassFuelEmissions`](sidrasolutions.si.api.isiapimovementclassfuelemissions.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementClassFuelEmissions = movementClass.MovementClassFuelEmissions;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClassFuelEmissions> movementClassFuelEmissions;
        movementClass->get_MovementClassFuelEmissions(&movementClassFuelEmissions);
        ```

    === "Python"

        ```python
        movement_class_fuel_emissions = movementClass.MovementClassFuelEmissions
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = movementClass.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        movementClass->get_Site(&site);
        ```

    === "Python"

        ```python
        site = movementClass.Site
        ```

### Pc_equivalent {#pc_equivalent}

Passenger Car Equivalent

```csharp
float Pc_equivalent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pc_equivalent = movementClass.Pc_equivalent;
        movementClass.Pc_equivalent = 0.0;
        ```

    === "C++"

        ```cpp
        double pc_equivalent;
        movementClass->get_Pc_equivalent(&pc_equivalent);
        movementClass->put_Pc_equivalent(0.0);
        ```

    === "Python"

        ```python
        pc_equivalent = movementClass.Pc_equivalent
        movementClass.Pc_equivalent = 0.0
        ```

### Is_cost_included {#is_cost_included}

```csharp
bool Is_cost_included { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_cost_included = movementClass.Is_cost_included;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_cost_included;
        movementClass->get_Is_cost_included(&is_cost_included);
        ```

    === "Python"

        ```python
        is_cost_included = movementClass.Is_cost_included
        ```

### Cost_method {#cost_method}

Cost Method

```csharp
int Cost_method { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Operating Cost
- `2` - User Cost

???- example "Code samples"

    === "C#"

        ```csharp
        int cost_method = movementClass.Cost_method;
        movementClass.Cost_method = 0;
        ```

    === "C++"

        ```cpp
        long cost_method;
        movementClass->get_Cost_method(&cost_method);
        movementClass->put_Cost_method(0);
        ```

    === "Python"

        ```python
        cost_method = movementClass.Cost_method
        movementClass.Cost_method = 0
        ```

### Fuel_pump_price {#fuel_pump_price}

Pump Price of Fuel

```csharp
float Fuel_pump_price { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_pump_price = movementClass.Fuel_pump_price;
        movementClass.Fuel_pump_price = 0.0;
        ```

    === "C++"

        ```cpp
        double fuel_pump_price;
        movementClass->get_Fuel_pump_price(&fuel_pump_price);
        movementClass->put_Fuel_pump_price(0.0);
        ```

    === "Python"

        ```python
        fuel_pump_price = movementClass.Fuel_pump_price
        movementClass.Fuel_pump_price = 0.0
        ```

### Resource_cost_factor {#resource_cost_factor}

Fuel Resource Cost Factor

```csharp
float Resource_cost_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float resource_cost_factor = movementClass.Resource_cost_factor;
        movementClass.Resource_cost_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double resource_cost_factor;
        movementClass->get_Resource_cost_factor(&resource_cost_factor);
        movementClass->put_Resource_cost_factor(0.0);
        ```

    === "Python"

        ```python
        resource_cost_factor = movementClass.Resource_cost_factor
        movementClass.Resource_cost_factor = 0.0
        ```

### Run_cost_fuel_ratio {#run_cost_fuel_ratio}

Ratio of Running Cost to Fuel Cost

```csharp
float Run_cost_fuel_ratio { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float run_cost_fuel_ratio = movementClass.Run_cost_fuel_ratio;
        movementClass.Run_cost_fuel_ratio = 0.0;
        ```

    === "C++"

        ```cpp
        double run_cost_fuel_ratio;
        movementClass->get_Run_cost_fuel_ratio(&run_cost_fuel_ratio);
        movementClass->put_Run_cost_fuel_ratio(0.0);
        ```

    === "Python"

        ```python
        run_cost_fuel_ratio = movementClass.Run_cost_fuel_ratio
        movementClass.Run_cost_fuel_ratio = 0.0
        ```

### Average_income {#average_income}

```csharp
float Average_income { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float average_income = movementClass.Average_income;
        movementClass.Average_income = 0.0;
        ```

    === "C++"

        ```cpp
        double average_income;
        movementClass->get_Average_income(&average_income);
        movementClass->put_Average_income(0.0);
        ```

    === "Python"

        ```python
        average_income = movementClass.Average_income
        movementClass.Average_income = 0.0
        ```

### Time_value_factor {#time_value_factor}

```csharp
float Time_value_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_value_factor = movementClass.Time_value_factor;
        movementClass.Time_value_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double time_value_factor;
        movementClass->get_Time_value_factor(&time_value_factor);
        movementClass->put_Time_value_factor(0.0);
        ```

    === "Python"

        ```python
        time_value_factor = movementClass.Time_value_factor
        movementClass.Time_value_factor = 0.0
        ```

### Mass {#mass}

```csharp
float Mass { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float mass = movementClass.Mass;
        movementClass.Mass = 0.0;
        ```

    === "C++"

        ```cpp
        double mass;
        movementClass->get_Mass(&mass);
        movementClass->put_Mass(0.0);
        ```

    === "Python"

        ```python
        mass = movementClass.Mass
        movementClass.Mass = 0.0
        ```

### Max_power {#max_power}

```csharp
float Max_power { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_power = movementClass.Max_power;
        movementClass.Max_power = 0.0;
        ```

    === "C++"

        ```cpp
        double max_power;
        movementClass->get_Max_power(&max_power);
        movementClass->put_Max_power(0.0);
        ```

    === "Python"

        ```python
        max_power = movementClass.Max_power
        movementClass.Max_power = 0.0
        ```

### Co2_to_fuel_ratio {#co2_to_fuel_ratio}

CO2 to Fuel Consumption Rate

```csharp
float Co2_to_fuel_ratio { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float co2_to_fuel_ratio = movementClass.Co2_to_fuel_ratio;
        movementClass.Co2_to_fuel_ratio = 0.0;
        ```

    === "C++"

        ```cpp
        double co2_to_fuel_ratio;
        movementClass->get_Co2_to_fuel_ratio(&co2_to_fuel_ratio);
        movementClass->put_Co2_to_fuel_ratio(0.0);
        ```

    === "Python"

        ```python
        co2_to_fuel_ratio = movementClass.Co2_to_fuel_ratio
        movementClass.Co2_to_fuel_ratio = 0.0
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = movementClass.DesiredSpeedMethod;
        movementClass.DesiredSpeedMethod = 0;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        movementClass->get_DesiredSpeedMethod(&desiredSpeedMethod);
        movementClass->put_DesiredSpeedMethod(0);
        ```

    === "Python"

        ```python
        desired_speed_method = movementClass.DesiredSpeedMethod
        movementClass.DesiredSpeedMethod = 0
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = movementClass.DesiredSpeed;
        movementClass.DesiredSpeed = 0.0;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        movementClass->get_DesiredSpeed(&desiredSpeed);
        movementClass->put_DesiredSpeed(0.0);
        ```

    === "Python"

        ```python
        desired_speed = movementClass.DesiredSpeed
        movementClass.DesiredSpeed = 0.0
        ```

### LowerLimitOfSpeedEfficiency {#lowerlimitofspeedefficiency}

```csharp
float LowerLimitOfSpeedEfficiency { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lowerLimitOfSpeedEfficiency = movementClass.LowerLimitOfSpeedEfficiency;
        movementClass.LowerLimitOfSpeedEfficiency = 0.0;
        ```

    === "C++"

        ```cpp
        double lowerLimitOfSpeedEfficiency;
        movementClass->get_LowerLimitOfSpeedEfficiency(&lowerLimitOfSpeedEfficiency);
        movementClass->put_LowerLimitOfSpeedEfficiency(0.0);
        ```

    === "Python"

        ```python
        lower_limit_of_speed_efficiency = movementClass.LowerLimitOfSpeedEfficiency
        movementClass.LowerLimitOfSpeedEfficiency = 0.0
        ```

### Gap_acceptance_factor_sliplane_zebra {#gap_acceptance_factor_sliplane_zebra}

Gap Acceptance Factor for Zebra Crossing on Slip Lane

```csharp
float Gap_acceptance_factor_sliplane_zebra { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acceptance_factor_sliplane_zebra = movementClass.Gap_acceptance_factor_sliplane_zebra;
        movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0;
        ```

    === "C++"

        ```cpp
        double gap_acceptance_factor_sliplane_zebra;
        movementClass->get_Gap_acceptance_factor_sliplane_zebra(&gap_acceptance_factor_sliplane_zebra);
        movementClass->put_Gap_acceptance_factor_sliplane_zebra(0.0);
        ```

    === "Python"

        ```python
        gap_acceptance_factor_sliplane_zebra = movementClass.Gap_acceptance_factor_sliplane_zebra
        movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0
        ```

### Gap_acceptance_factor_midblock_zebra {#gap_acceptance_factor_midblock_zebra}

Gap Acceptance Factor for Midblock Zebra Crossing

```csharp
float Gap_acceptance_factor_midblock_zebra { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acceptance_factor_midblock_zebra = movementClass.Gap_acceptance_factor_midblock_zebra;
        movementClass.Gap_acceptance_factor_midblock_zebra = 0.0;
        ```

    === "C++"

        ```cpp
        double gap_acceptance_factor_midblock_zebra;
        movementClass->get_Gap_acceptance_factor_midblock_zebra(&gap_acceptance_factor_midblock_zebra);
        movementClass->put_Gap_acceptance_factor_midblock_zebra(0.0);
        ```

    === "Python"

        ```python
        gap_acceptance_factor_midblock_zebra = movementClass.Gap_acceptance_factor_midblock_zebra
        movementClass.Gap_acceptance_factor_midblock_zebra = 0.0
        ```

### MergeParam {#mergeparam}

```csharp
ISIAPIMovementClassMergeParam MergeParam { get; }
```

**Type** [`ISIAPIMovementClassMergeParam`](sidrasolutions.si.api.isiapimovementclassmergeparam.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var mergeParam = movementClass.MergeParam;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClassMergeParam> mergeParam;
        movementClass->get_MergeParam(&mergeParam);
        ```

    === "Python"

        ```python
        merge_param = movementClass.MergeParam
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovementclasses.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovementClasses
title: MovementClasses
name: ISIAPIMovementClasses
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BB0704D0-5295-4EF2-A6B1-1DF3324E23BF
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIMovementClass this[int mcClass]
  - int Count
---

# MovementClasses

Type `ISIAPIMovementClasses` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BB0704D0-5295-4EF2-A6B1-1DF3324E23BF`

## Declaration

```csharp
[Guid("BB0704D0-5295-4EF2-A6B1-1DF3324E23BF")]
public interface ISIAPIMovementClasses
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md) | Get a Movement Class. Return a Movement Class if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` | Get a value indicating whether a Movement Class exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = movementClasses.Count;
        ```

    === "C++"

        ```cpp
        long count;
        movementClasses->get_Count(&count);
        ```

    === "Python"

        ```python
        count = movementClasses.Count
        ```

### this[] {#this}

Get a Movement Class.  
Return a Movement Class if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIMovementClass this[] { get; }
```

**Type** [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = movementClasses.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClass> this[];
        movementClasses->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = movementClasses.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

Get a value indicating whether a Movement Class exists in the data storage.

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` | One of: - `1` - Light Vehicles - `2` - Heavy Vehicles - `3` - Buses - `4` - Bicycles - `5` - Large Trucks - `6` - Trams - `7` - User Class 1 - `8` - User Class 2 - `9` - User Class 3 - `10` - User Class 4 - `11` - User Class 5 - `12` - User Class 6 |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = movementClasses.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        movementClasses->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = movementClasses.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovementclassfuelemission.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovementClassFuelEmission
title: MovementClassFuelEmission
name: ISIAPIMovementClassFuelEmission
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1C48B5B0-CEFC-468E-8467-713A7F975F2A
members:
  - int Emission_class
  - float Idle
  - float A
  - float B
  - float Beta1
  - ISIAPIMovementClass MovementClass
---

# MovementClassFuelEmission

Type `ISIAPIMovementClassFuelEmission` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1C48B5B0-CEFC-468E-8467-713A7F975F2A`

## Declaration

```csharp
[Guid("1C48B5B0-CEFC-468E-8467-713A7F975F2A")]
public interface ISIAPIMovementClassFuelEmission
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Emission_class](#emission_class) | `int` | Emission Class |
| [Idle](#idle) | `float` |  |
| [A](#a) | `float` |  |
| [B](#b) | `float` |  |
| [Beta1](#beta1) | `float` |  |
| [MovementClass](#movementclass) | [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md) |  |

</div>

## Properties

### Emission_class {#emission_class}

Emission Class

```csharp
int Emission_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Fuel
- `2` - CO
- `3` - HC
- `4` - NOx

???- example "Code samples"

    === "C#"

        ```csharp
        int emission_class = movementClassFuelEmission.Emission_class;
        ```

    === "C++"

        ```cpp
        long emission_class;
        movementClassFuelEmission->get_Emission_class(&emission_class);
        ```

    === "Python"

        ```python
        emission_class = movementClassFuelEmission.Emission_class
        ```

### Idle {#idle}

```csharp
float Idle { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idle = movementClassFuelEmission.Idle;
        movementClassFuelEmission.Idle = 0.0;
        ```

    === "C++"

        ```cpp
        double idle;
        movementClassFuelEmission->get_Idle(&idle);
        movementClassFuelEmission->put_Idle(0.0);
        ```

    === "Python"

        ```python
        idle = movementClassFuelEmission.Idle
        movementClassFuelEmission.Idle = 0.0
        ```

### A {#a}

```csharp
float A { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float a = movementClassFuelEmission.A;
        movementClassFuelEmission.A = 0.0;
        ```

    === "C++"

        ```cpp
        double a;
        movementClassFuelEmission->get_A(&a);
        movementClassFuelEmission->put_A(0.0);
        ```

    === "Python"

        ```python
        a = movementClassFuelEmission.A
        movementClassFuelEmission.A = 0.0
        ```

### B {#b}

```csharp
float B { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float b = movementClassFuelEmission.B;
        movementClassFuelEmission.B = 0.0;
        ```

    === "C++"

        ```cpp
        double b;
        movementClassFuelEmission->get_B(&b);
        movementClassFuelEmission->put_B(0.0);
        ```

    === "Python"

        ```python
        b = movementClassFuelEmission.B
        movementClassFuelEmission.B = 0.0
        ```

### Beta1 {#beta1}

```csharp
float Beta1 { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float beta1 = movementClassFuelEmission.Beta1;
        movementClassFuelEmission.Beta1 = 0.0;
        ```

    === "C++"

        ```cpp
        double beta1;
        movementClassFuelEmission->get_Beta1(&beta1);
        movementClassFuelEmission->put_Beta1(0.0);
        ```

    === "Python"

        ```python
        beta1 = movementClassFuelEmission.Beta1
        movementClassFuelEmission.Beta1 = 0.0
        ```

### MovementClass {#movementclass}

```csharp
ISIAPIMovementClass MovementClass { get; }
```

**Type** [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementClass = movementClassFuelEmission.MovementClass;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClass> movementClass;
        movementClassFuelEmission->get_MovementClass(&movementClass);
        ```

    === "Python"

        ```python
        movement_class = movementClassFuelEmission.MovementClass
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovementclassfuelemissions.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovementClassFuelEmissions
title: MovementClassFuelEmissions
name: ISIAPIMovementClassFuelEmissions
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 49B3C935-B47C-49D4-B0DA-15BF3F90C0B3
members:
  - bool Exists(int emissionClass)
  - ISIAPIMovementClassFuelEmission this[int emissionClass]
  - int Count
---

# MovementClassFuelEmissions

Type `ISIAPIMovementClassFuelEmissions` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `49B3C935-B47C-49D4-B0DA-15BF3F90C0B3`

## Declaration

```csharp
[Guid("49B3C935-B47C-49D4-B0DA-15BF3F90C0B3")]
public interface ISIAPIMovementClassFuelEmissions
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIMovementClassFuelEmission`](sidrasolutions.si.api.isiapimovementclassfuelemission.md) | Get a Movement Class Fuel Emission. Return a Movement Class Fuel Emission if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Exists(int)](#exists-int) | `bool` | Get a value indicating whether a Movement Class Fuel Emission exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = movementClassFuelEmissions.Count;
        ```

    === "C++"

        ```cpp
        long count;
        movementClassFuelEmissions->get_Count(&count);
        ```

    === "Python"

        ```python
        count = movementClassFuelEmissions.Count
        ```

### this[] {#this}

Get a Movement Class Fuel Emission.  
Return a Movement Class Fuel Emission if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIMovementClassFuelEmission this[] { get; }
```

**Type** [`ISIAPIMovementClassFuelEmission`](sidrasolutions.si.api.isiapimovementclassfuelemission.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = movementClassFuelEmissions.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClassFuelEmission> this[];
        movementClassFuelEmissions->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = movementClassFuelEmissions.this[]
        ```

## Methods

### Exists(int) {#exists-int}

Get a value indicating whether a Movement Class Fuel Emission exists in the data storage.

```csharp
bool Exists(int emissionClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `emissionClass` | `int` | One of: - `1` - Fuel - `2` - CO - `3` - HC - `4` - NOx |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = movementClassFuelEmissions.Exists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        movementClassFuelEmissions->Exists(0, &result);
        ```

    === "Python"

        ```python
        result = movementClassFuelEmissions.Exists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapimovementclassmergeparam.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIMovementClassMergeParam
title: MovementClassMergeParam
name: ISIAPIMovementClassMergeParam
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B7C2EB9E-F12C-424E-AA65-972B67C4A4DE
members:
  - float Gap_acceptance_factor_shortlane
  - float Opposing_veh_factor_shortlane
  - float Contlane_cap_shortlane
  - float Gap_acceptance_factor_mergelane
  - float Opposing_veh_factor_mergelane
  - float Contlane_cap_mergelane
  - ISIAPIMovementClass MovementClass
---

# MovementClassMergeParam

Type `ISIAPIMovementClassMergeParam` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B7C2EB9E-F12C-424E-AA65-972B67C4A4DE`

## Declaration

```csharp
[Guid("B7C2EB9E-F12C-424E-AA65-972B67C4A4DE")]
public interface ISIAPIMovementClassMergeParam
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Gap_acceptance_factor_shortlane](#gap_acceptance_factor_shortlane) | `float` |  |
| [Opposing_veh_factor_shortlane](#opposing_veh_factor_shortlane) | `float` |  |
| [Contlane_cap_shortlane](#contlane_cap_shortlane) | `float` |  |
| [Gap_acceptance_factor_mergelane](#gap_acceptance_factor_mergelane) | `float` |  |
| [Opposing_veh_factor_mergelane](#opposing_veh_factor_mergelane) | `float` |  |
| [Contlane_cap_mergelane](#contlane_cap_mergelane) | `float` |  |
| [MovementClass](#movementclass) | [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md) |  |

</div>

## Properties

### Gap_acceptance_factor_shortlane {#gap_acceptance_factor_shortlane}

```csharp
float Gap_acceptance_factor_shortlane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acceptance_factor_shortlane = movementClassMergeParam.Gap_acceptance_factor_shortlane;
        movementClassMergeParam.Gap_acceptance_factor_shortlane = 0.0;
        ```

    === "C++"

        ```cpp
        double gap_acceptance_factor_shortlane;
        movementClassMergeParam->get_Gap_acceptance_factor_shortlane(&gap_acceptance_factor_shortlane);
        movementClassMergeParam->put_Gap_acceptance_factor_shortlane(0.0);
        ```

    === "Python"

        ```python
        gap_acceptance_factor_shortlane = movementClassMergeParam.Gap_acceptance_factor_shortlane
        movementClassMergeParam.Gap_acceptance_factor_shortlane = 0.0
        ```

### Opposing_veh_factor_shortlane {#opposing_veh_factor_shortlane}

```csharp
float Opposing_veh_factor_shortlane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_veh_factor_shortlane = movementClassMergeParam.Opposing_veh_factor_shortlane;
        movementClassMergeParam.Opposing_veh_factor_shortlane = 0.0;
        ```

    === "C++"

        ```cpp
        double opposing_veh_factor_shortlane;
        movementClassMergeParam->get_Opposing_veh_factor_shortlane(&opposing_veh_factor_shortlane);
        movementClassMergeParam->put_Opposing_veh_factor_shortlane(0.0);
        ```

    === "Python"

        ```python
        opposing_veh_factor_shortlane = movementClassMergeParam.Opposing_veh_factor_shortlane
        movementClassMergeParam.Opposing_veh_factor_shortlane = 0.0
        ```

### Contlane_cap_shortlane {#contlane_cap_shortlane}

```csharp
float Contlane_cap_shortlane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float contlane_cap_shortlane = movementClassMergeParam.Contlane_cap_shortlane;
        movementClassMergeParam.Contlane_cap_shortlane = 0.0;
        ```

    === "C++"

        ```cpp
        double contlane_cap_shortlane;
        movementClassMergeParam->get_Contlane_cap_shortlane(&contlane_cap_shortlane);
        movementClassMergeParam->put_Contlane_cap_shortlane(0.0);
        ```

    === "Python"

        ```python
        contlane_cap_shortlane = movementClassMergeParam.Contlane_cap_shortlane
        movementClassMergeParam.Contlane_cap_shortlane = 0.0
        ```

### Gap_acceptance_factor_mergelane {#gap_acceptance_factor_mergelane}

```csharp
float Gap_acceptance_factor_mergelane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acceptance_factor_mergelane = movementClassMergeParam.Gap_acceptance_factor_mergelane;
        movementClassMergeParam.Gap_acceptance_factor_mergelane = 0.0;
        ```

    === "C++"

        ```cpp
        double gap_acceptance_factor_mergelane;
        movementClassMergeParam->get_Gap_acceptance_factor_mergelane(&gap_acceptance_factor_mergelane);
        movementClassMergeParam->put_Gap_acceptance_factor_mergelane(0.0);
        ```

    === "Python"

        ```python
        gap_acceptance_factor_mergelane = movementClassMergeParam.Gap_acceptance_factor_mergelane
        movementClassMergeParam.Gap_acceptance_factor_mergelane = 0.0
        ```

### Opposing_veh_factor_mergelane {#opposing_veh_factor_mergelane}

```csharp
float Opposing_veh_factor_mergelane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_veh_factor_mergelane = movementClassMergeParam.Opposing_veh_factor_mergelane;
        movementClassMergeParam.Opposing_veh_factor_mergelane = 0.0;
        ```

    === "C++"

        ```cpp
        double opposing_veh_factor_mergelane;
        movementClassMergeParam->get_Opposing_veh_factor_mergelane(&opposing_veh_factor_mergelane);
        movementClassMergeParam->put_Opposing_veh_factor_mergelane(0.0);
        ```

    === "Python"

        ```python
        opposing_veh_factor_mergelane = movementClassMergeParam.Opposing_veh_factor_mergelane
        movementClassMergeParam.Opposing_veh_factor_mergelane = 0.0
        ```

### Contlane_cap_mergelane {#contlane_cap_mergelane}

```csharp
float Contlane_cap_mergelane { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float contlane_cap_mergelane = movementClassMergeParam.Contlane_cap_mergelane;
        movementClassMergeParam.Contlane_cap_mergelane = 0.0;
        ```

    === "C++"

        ```cpp
        double contlane_cap_mergelane;
        movementClassMergeParam->get_Contlane_cap_mergelane(&contlane_cap_mergelane);
        movementClassMergeParam->put_Contlane_cap_mergelane(0.0);
        ```

    === "Python"

        ```python
        contlane_cap_mergelane = movementClassMergeParam.Contlane_cap_mergelane
        movementClassMergeParam.Contlane_cap_mergelane = 0.0
        ```

### MovementClass {#movementclass}

```csharp
ISIAPIMovementClass MovementClass { get; }
```

**Type** [`ISIAPIMovementClass`](sidrasolutions.si.api.isiapimovementclass.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementClass = movementClassMergeParam.MovementClass;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClass> movementClass;
        movementClassMergeParam->get_MovementClass(&movementClass);
        ```

    === "Python"

        ```python
        movement_class = movementClassMergeParam.MovementClass
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetwork.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetwork
title: Network
name: ISIAPINetwork
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 6D6D19FC-A076-43CE-BBCB-003F18F1A852
members:
  - bool Process()
  - bool UpdateModifiedInfo()
  - ISIAPINetworkSite AddNetworkSite(ISIAPISite site, float layoutX, float layoutY)
  - bool RemoveNetworkSite(ISIAPINetworkSite networkSite)
  - ISIAPINetworkLegConnection AddNetworkLegConnection(ISIAPINetworkSite nwSite1, int legOrientation1, ISIAPINetworkSite nwSite2, int legOrientation2)
  - bool RemoveNetworkLegConnection(ISIAPINetworkLegConnection nwLegConn)
  - ISIAPINetworkCCG AddNetworkCCG()
  - bool RemoveNetworkCCG(ISIAPINetworkCCG ccg)
  - ISIAPIRoute AddRoute()
  - bool RemoveRoute(ISIAPIRoute route)
  - bool ProcessByRoutes()
  - bool MoveNetworkCCGTo(ISIAPINetworkCCG ccg, int newPosition)
  - bool ResetRouteSignalOffsetPriority()
  - ISIAPIRoute CloneRoute(ISIAPIRoute route)
  - bool MoveRouteTo(ISIAPIRoute route, int newPosition)
  - byte[] CreateLayoutPngData()
  - bool CreateLayoutPngFile(string filename)
  - bool RemoveOutputData()
  - ISIAPINetworkScenario AddNetworkScenario()
  - bool RemoveNetworkScenario(ISIAPINetworkScenario networkScenario)
  - ISIAPINetworkScenario CloneNetworkScenario(ISIAPINetworkScenario networkScenario)
  - bool MoveNetworkScenarioTo(ISIAPINetworkScenario networkScenario, int newPosition)
  - string Network_id
  - string Name
  - string NetworkID
  - int Position
  - string Title
  - string ModelSignature
  - string ModelName
  - bool DriveOnLeft
  - int Units
  - string Description
  - string CostUnit
  - bool IsShortlaneQueueStorageRatioIncl
  - int LOSMethod
  - int LOSTarget
  - int HoursPerYear
  - int MaxIterations
  - float StoppingDxPercent
  - int SignalOffsetOption
  - int OffsetDefinition
  - bool IsPlatoonDispersionApplied
  - int Cycle_time_option
  - float NetworkCycleTime
  - float Practical_max_cycle_time
  - bool Practical_cycle_rounding_applied
  - int Practical_cycle_rounding
  - int SitePhaseTimesOption
  - int MultiRoutesSummaryOption
  - DateTime Created_date
  - string Created_by
  - string Created_by_company
  - string Created_version
  - DateTime Modified_date
  - string Modified_by
  - string Modified_by_company
  - string Modified_version
  - string ProcessingError
  - ISIAPINetworkSites NetworkSites
  - ISIAPINetworkLegConnections NetworkLegConnections
  - ISIAPIOutputNetwork OutputNetwork
  - ISIAPIOutputNetwork OutputNetworkByRoutes
  - int Site_los_method
  - int Performance_measure
  - int Percentile_queue_option
  - int Percentile_queue
  - string LastErrorMessage
  - int DiagnosticStatus
  - ISIAPIDiagnosticMsgs DiagnosticMsgs
  - ISIAPIProject Project
  - ISIAPINetworkCCGs NetworkCCGs
  - ISIAPIRoutes Routes
  - string Category
  - int Peakflowperiod
  - int Lane_blockage_effect_option
  - bool Optimum_cycle_time_lower_user
  - int Optimum_cycle_time_lower
  - int Optimum_cycle_time_upper
  - int Optimum_cycle_time_increment
  - int Optimum_cycle_time_perf_measure
  - int Optimum_cycle_time_optim_method
  - int Optimum_max_green_percent_lower
  - int Optimum_max_green_percent_upper
  - int Optimum_max_green_percent_increment
  - int Optimum_max_green_perf_measure
  - int Optimum_max_green_optim_method
  - int Variable_phasing_perf_measure
  - int Green_split_priority_option
  - bool Is_timing_optimised_for_selected_result
  - bool IsIncludedInProjectSummary
  - ISIAPINetworkDemandSensitivity DemandSensitivity
  - ISIAPINetworkFolder NetworkFolder
  - float SpeedEfficiencyLOSUpperLimit_B
  - float SpeedEfficiencyLOSUpperLimit_C
  - float SpeedEfficiencyLOSUpperLimit_D
  - float SpeedEfficiencyLOSUpperLimit_E
  - float SpeedEfficiencyLOSUpperLimit_F
  - bool Is_geometric_delay_excluded
  - bool Is_hcm_delay_formula_applied
  - bool Is_hcm_queue_formula_applied
  - bool IsLaneBlockageModelApplied
  - ISIAPINetworkMCs NetworkMCs
  - bool IsUserModel
  - int NetworkType
  - ISIAPINetworkScenarios NetworkScenarios
  - bool IsInputDataCompatible
  - bool IsOutputDataCompatible
  - string MinViableVersionL1
  - string MinViableVersionL2
  - string MinViableVersionL3
  - int ConvergenceMethod
  - int TwoLoops_OuterMaxIterations
  - int TwoLoops_InnerMaxIterations
  - float TwoLoops_StoppingPercent
  - bool TwoLoops_ApplyMinStoppingPercent
  - float TwoLoops_InnerStoppingPercent
---

# Network

Type `ISIAPINetwork` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `6D6D19FC-A076-43CE-BBCB-003F18F1A852`

## Declaration

```csharp
[Guid("6D6D19FC-A076-43CE-BBCB-003F18F1A852")]
public interface ISIAPINetwork
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Network_id](#network_id) | `string` | The GUID of the Network object. |
| [Name](#name) | `string` |  |
| [NetworkID](#networkid) | `string` | Network ID in the Network Data dialog and reports. |
| [Position](#position) | `int` | The Network Position in the Network Folder's Networks collection. It is a zero-base integer. |
| [Title](#title) | `string` |  |
| [ModelSignature](#modelsignature) | `string` |  |
| [ModelName](#modelname) | `string` |  |
| [DriveOnLeft](#driveonleft) | `bool` |  |
| [Units](#units) | `int` | General unit system used for data within the Network |
| [Description](#description) | `string` |  |
| [CostUnit](#costunit) | `string` |  |
| [IsShortlaneQueueStorageRatioIncl](#isshortlanequeuestorageratioincl) | `bool` | Flag indicating if Short Lanes are included in determining Queue Storage Ratio |
| [LOSMethod](#losmethod) | `int` | Network Level of Service Method |
| [LOSTarget](#lostarget) | `int` | Network Level of Service Target |
| [HoursPerYear](#hoursperyear) | `int` |  |
| [MaxIterations](#maxiterations) | `int` |  |
| [StoppingDxPercent](#stoppingdxpercent) | `float` | Percentage Stopping Condition for the One-Loop Convergence Method. |
| [SignalOffsetOption](#signaloffsetoption) | `int` | Signal Offset Option |
| [OffsetDefinition](#offsetdefinition) | `int` | Signal Offset Definition |
| [IsPlatoonDispersionApplied](#isplatoondispersionapplied) | `bool` |  |
| [Cycle_time_option](#cycle_time_option) | `int` | Cycle Time Option |
| [NetworkCycleTime](#networkcycletime) | `float` |  |
| [Practical_max_cycle_time](#practical_max_cycle_time) | `float` |  |
| [Practical_cycle_rounding_applied](#practical_cycle_rounding_applied) | `bool` |  |
| [Practical_cycle_rounding](#practical_cycle_rounding) | `int` |  |
| [SitePhaseTimesOption](#sitephasetimesoption) | `int` | Site or CCG Phase Times Option. It is applied when Cycle Time Option is User-Given Cycle Time. |
| [MultiRoutesSummaryOption](#multiroutessummaryoption) | `int` | Network Output by Routes Option |
| [Created_date](#created_date) | `DateTime` |  |
| [Created_by](#created_by) | `string` |  |
| [Created_by_company](#created_by_company) | `string` |  |
| [Created_version](#created_version) | `string` |  |
| [Modified_date](#modified_date) | `DateTime` |  |
| [Modified_by](#modified_by) | `string` |  |
| [Modified_by_company](#modified_by_company) | `string` |  |
| [Modified_version](#modified_version) | `string` |  |
| [ProcessingError](#processingerror) | `string` | Error nessage after a failed call to Process |
| [NetworkSites](#networksites) | [`ISIAPINetworkSites`](sidrasolutions.si.api.isiapinetworksites.md) | Collection of Sites in the Network |
| [NetworkLegConnections](#networklegconnections) | [`ISIAPINetworkLegConnections`](sidrasolutions.si.api.isiapinetworklegconnections.md) | Collection of Leg Connections between the Sites in the Network |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) | Network Output Data for the summary of the Whole Network |
| [OutputNetworkByRoutes](#outputnetworkbyroutes) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) | Network Output Data for the statistics summary of the selected Routes |
| [Site_los_method](#site_los_method) | `int` |  |
| [Performance_measure](#performance_measure) | `int` |  |
| [Percentile_queue_option](#percentile_queue_option) | `int` |  |
| [Percentile_queue](#percentile_queue) | `int` |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [DiagnosticStatus](#diagnosticstatus) | `int` | Diagnostic Status |
| [DiagnosticMsgs](#diagnosticmsgs) | [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md) |  |
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) |  |
| [NetworkCCGs](#networkccgs) | [`ISIAPINetworkCCGs`](sidrasolutions.si.api.isiapinetworkccgs.md) | Collection of Common Control Group (CCG) in the Network |
| [Routes](#routes) | [`ISIAPIRoutes`](sidrasolutions.si.api.isiapiroutes.md) | Collection of Routes in the Network |
| [Category](#category) | `string` | Network Category |
| [Peakflowperiod](#peakflowperiod) | `int` |  |
| [Lane_blockage_effect_option](#lane_blockage_effect_option) | `int` | Lane Blockage Effect Option: In Network analysis, include Lane Blockage effects in determining Phase Times. |
| [Optimum_cycle_time_lower_user](#optimum_cycle_time_lower_user) | `bool` |  |
| [Optimum_cycle_time_lower](#optimum_cycle_time_lower) | `int` |  |
| [Optimum_cycle_time_upper](#optimum_cycle_time_upper) | `int` |  |
| [Optimum_cycle_time_increment](#optimum_cycle_time_increment) | `int` |  |
| [Optimum_cycle_time_perf_measure](#optimum_cycle_time_perf_measure) | `int` |  |
| [Optimum_cycle_time_optim_method](#optimum_cycle_time_optim_method) | `int` |  |
| [Optimum_max_green_percent_lower](#optimum_max_green_percent_lower) | `int` |  |
| [Optimum_max_green_percent_upper](#optimum_max_green_percent_upper) | `int` |  |
| [Optimum_max_green_percent_increment](#optimum_max_green_percent_increment) | `int` |  |
| [Optimum_max_green_perf_measure](#optimum_max_green_perf_measure) | `int` |  |
| [Optimum_max_green_optim_method](#optimum_max_green_optim_method) | `int` |  |
| [Variable_phasing_perf_measure](#variable_phasing_perf_measure) | `int` |  |
| [Green_split_priority_option](#green_split_priority_option) | `int` | Green Split Priority |
| [Is_timing_optimised_for_selected_result](#is_timing_optimised_for_selected_result) | `bool` |  |
| [IsIncludedInProjectSummary](#isincludedinprojectsummary) | `bool` |  |
| [DemandSensitivity](#demandsensitivity) | [`ISIAPINetworkDemandSensitivity`](sidrasolutions.si.api.isiapinetworkdemandsensitivity.md) |  |
| [NetworkFolder](#networkfolder) | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) |  |
| [SpeedEfficiencyLOSUpperLimit_B](#speedefficiencylosupperlimit_b) | `float` |  |
| [SpeedEfficiencyLOSUpperLimit_C](#speedefficiencylosupperlimit_c) | `float` |  |
| [SpeedEfficiencyLOSUpperLimit_D](#speedefficiencylosupperlimit_d) | `float` |  |
| [SpeedEfficiencyLOSUpperLimit_E](#speedefficiencylosupperlimit_e) | `float` |  |
| [SpeedEfficiencyLOSUpperLimit_F](#speedefficiencylosupperlimit_f) | `float` |  |
| [Is_geometric_delay_excluded](#is_geometric_delay_excluded) | `bool` |  |
| [Is_hcm_delay_formula_applied](#is_hcm_delay_formula_applied) | `bool` |  |
| [Is_hcm_queue_formula_applied](#is_hcm_queue_formula_applied) | `bool` |  |
| [IsLaneBlockageModelApplied](#islaneblockagemodelapplied) | `bool` |  |
| [NetworkMCs](#networkmcs) | [`ISIAPINetworkMCs`](sidrasolutions.si.api.isiapinetworkmcs.md) |  |
| [IsUserModel](#isusermodel) | `bool` | Flag indicating whether the internal SIDRA INTERSECTION Software Setup that is used by this Network is a User Software Setup or a Standard Software Setup. |
| [NetworkType](#networktype) | `int` | Network Type |
| [NetworkScenarios](#networkscenarios) | [`ISIAPINetworkScenarios`](sidrasolutions.si.api.isiapinetworkscenarios.md) | Collection of the Network Scenarios |
| [IsInputDataCompatible](#isinputdatacompatible) | `bool` |  |
| [IsOutputDataCompatible](#isoutputdatacompatible) | `bool` |  |
| [MinViableVersionL1](#minviableversionl1) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Network's Level 1 Compatibility |
| [MinViableVersionL2](#minviableversionl2) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Network's Level 2 Compatibility |
| [MinViableVersionL3](#minviableversionl3) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Network's Level 3 Compatibility |
| [ConvergenceMethod](#convergencemethod) | `int` | Network Convergence Method |
| [TwoLoops_OuterMaxIterations](#twoloops_outermaxiterations) | `int` | Maximum number of iterations for the Outer Loop in the Two-Loop Convergence Method. |
| [TwoLoops_InnerMaxIterations](#twoloops_innermaxiterations) | `int` | Maximum number of iterations for the Inner Loop in the Two-Loop Convergence Method. |
| [TwoLoops_StoppingPercent](#twoloops_stoppingpercent) | `float` | Percentage Stopping Condition for the Outer Loop in the Two-Loop Convergence Method. |
| [TwoLoops_ApplyMinStoppingPercent](#twoloops_applyminstoppingpercent) | `bool` | Flag indicating if the Outer Loop's Minimum Percentage Stopping Condition is applied in the Two-Loop Convergence Method. If true, the result of the Outer Iteration with the Minimum Percentage Stopping Condition is provided when the Iterations do not settle. |
| [TwoLoops_InnerStoppingPercent](#twoloops_innerstoppingpercent) | `float` | Percentage Stopping Condition for the Inner Loop in the Two-Loop Convergence Method. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Process()](#process) | `bool` | Processes the Whole Network This method generates the `SIDRASolutions.SI.API.ISIAPINetwork.OutputNetwork` data. |
| [UpdateModifiedInfo()](#updatemodifiedinfo) | `bool` | Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number |
| [AddNetworkSite(ISIAPISite, float, float)](#addnetworksite-isiapisite--float--float) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) | Add a Site into the Network. The Site's Drive Rule and Units must match this Network's ones. |
| [RemoveNetworkSite(ISIAPINetworkSite)](#removenetworksite-isiapinetworksite) | `bool` | Remove a NetworkSite from the Network. If the NetworkSite is used in any Route(s), remove the Route(s) before removing the NetworkSite. |
| [AddNetworkLegConnection(ISIAPINetworkSite, int, ISIAPINetworkSite, int)](#addnetworklegconnection-isiapinetworksite--int--isiapinetworksite--int) | [`ISIAPINetworkLegConnection`](sidrasolutions.si.api.isiapinetworklegconnection.md) |  |
| [RemoveNetworkLegConnection(ISIAPINetworkLegConnection)](#removenetworklegconnection-isiapinetworklegconnection) | `bool` |  |
| [AddNetworkCCG()](#addnetworkccg) | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) | Add a new Common Control Group (CCG) into the Network. |
| [RemoveNetworkCCG(ISIAPINetworkCCG)](#removenetworkccg-isiapinetworkccg) | `bool` | Remove a Common Control Group (CCG) from the Network. |
| [AddRoute()](#addroute) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) | Add a new Route into the Network. |
| [RemoveRoute(ISIAPIRoute)](#removeroute-isiapiroute) | `bool` | Remove a Route from the Network. |
| [ProcessByRoutes()](#processbyroutes) | `bool` | Process this Network by selected Routes. The Whole Network needs to be processed before Network by selected Routes statistics can be calculated. If the Network has not been processed, process the Network. The Network by selected Routes statistics will be calculated as well. It is not required to call this method again. If Route(s) are set to be included into Network by Routes after the Network is processed, call this method to calculate the Network by selected Routes statistics. This method generates the `SIDRASolutions.SI.API.ISIAPINetwork.OutputNetworkByRoutes` data. |
| [MoveNetworkCCGTo(ISIAPINetworkCCG, int)](#movenetworkccgto-isiapinetworkccg--int) | `bool` | Move a Common Control Group (CCG) to a new position. |
| [ResetRouteSignalOffsetPriority()](#resetroutesignaloffsetpriority) | `bool` | Reset the Offset Priority of all valid Routes for the program calculation of Signal Offsets. |
| [CloneRoute(ISIAPIRoute)](#cloneroute-isiapiroute) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) | Clone a Route. |
| [MoveRouteTo(ISIAPIRoute, int)](#moverouteto-isiapiroute--int) | `bool` | Move a Route to a new position. |
| [CreateLayoutPngData()](#createlayoutpngdata) | `byte[]` |  |
| [CreateLayoutPngFile(string)](#createlayoutpngfile-string) | `bool` |  |
| [RemoveOutputData()](#removeoutputdata) | `bool` | Remove this Network and its Routes Output data. |
| [AddNetworkScenario()](#addnetworkscenario) | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | Add a new Network Scenario. |
| [RemoveNetworkScenario(ISIAPINetworkScenario)](#removenetworkscenario-isiapinetworkscenario) | `bool` | Remove a Network Scenario from this Network. |
| [CloneNetworkScenario(ISIAPINetworkScenario)](#clonenetworkscenario-isiapinetworkscenario) | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | Clone a Network Scenario. |
| [MoveNetworkScenarioTo(ISIAPINetworkScenario, int)](#movenetworkscenarioto-isiapinetworkscenario--int) | `bool` | Move a Network Scenario to a new position in the collection. |

</div>

## Properties

### Network_id {#network_id}

The GUID of the Network object.

```csharp
string Network_id { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string network_id = network.Network_id;
        ```

    === "C++"

        ```cpp
        CComBSTR network_id;
        network->get_Network_id(&network_id);
        ```

    === "Python"

        ```python
        network_id = network.Network_id
        ```

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = network.Name;
        network.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        network->get_Name(&name);
        network->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = network.Name
        network.Name = r"Example"
        ```

### NetworkID {#networkid}

Network ID in the Network Data dialog and reports.

```csharp
string NetworkID { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string networkID = network.NetworkID;
        network.NetworkID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR networkID;
        network->get_NetworkID(&networkID);
        network->put_NetworkID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        network_id = network.NetworkID
        network.NetworkID = r"id-1"
        ```

### Position {#position}

The Network Position in the Network Folder's Networks collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = network.Position;
        ```

    === "C++"

        ```cpp
        long position;
        network->get_Position(&position);
        ```

    === "Python"

        ```python
        position = network.Position
        ```

### Title {#title}

```csharp
string Title { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string title = network.Title;
        network.Title = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR title;
        network->get_Title(&title);
        network->put_Title(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        title = network.Title
        network.Title = r"value"
        ```

### ModelSignature {#modelsignature}

```csharp
string ModelSignature { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modelSignature = network.ModelSignature;
        ```

    === "C++"

        ```cpp
        CComBSTR modelSignature;
        network->get_ModelSignature(&modelSignature);
        ```

    === "Python"

        ```python
        model_signature = network.ModelSignature
        ```

### ModelName {#modelname}

```csharp
string ModelName { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modelName = network.ModelName;
        ```

    === "C++"

        ```cpp
        CComBSTR modelName;
        network->get_ModelName(&modelName);
        ```

    === "Python"

        ```python
        model_name = network.ModelName
        ```

### DriveOnLeft {#driveonleft}

```csharp
bool DriveOnLeft { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool driveOnLeft = network.DriveOnLeft;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL driveOnLeft;
        network->get_DriveOnLeft(&driveOnLeft);
        ```

    === "Python"

        ```python
        drive_on_left = network.DriveOnLeft
        ```

### Units {#units}

General unit system used for data within the Network

```csharp
int Units { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Metric
- `1` - US Units

???- example "Code samples"

    === "C#"

        ```csharp
        int units = network.Units;
        ```

    === "C++"

        ```cpp
        long units;
        network->get_Units(&units);
        ```

    === "Python"

        ```python
        units = network.Units
        ```

### Description {#description}

```csharp
string Description { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string description = network.Description;
        network.Description = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR description;
        network->get_Description(&description);
        network->put_Description(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        description = network.Description
        network.Description = r"value"
        ```

### CostUnit {#costunit}

```csharp
string CostUnit { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string costUnit = network.CostUnit;
        network.CostUnit = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR costUnit;
        network->get_CostUnit(&costUnit);
        network->put_CostUnit(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        cost_unit = network.CostUnit
        network.CostUnit = r"value"
        ```

### IsShortlaneQueueStorageRatioIncl {#isshortlanequeuestorageratioincl}

Flag indicating if Short Lanes are included in determining Queue Storage Ratio

```csharp
bool IsShortlaneQueueStorageRatioIncl { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isShortlaneQueueStorageRatioIncl = network.IsShortlaneQueueStorageRatioIncl;
        network.IsShortlaneQueueStorageRatioIncl = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isShortlaneQueueStorageRatioIncl;
        network->get_IsShortlaneQueueStorageRatioIncl(&isShortlaneQueueStorageRatioIncl);
        network->put_IsShortlaneQueueStorageRatioIncl(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_shortlane_queue_storage_ratio_incl = network.IsShortlaneQueueStorageRatioIncl
        network.IsShortlaneQueueStorageRatioIncl = True
        ```

### LOSMethod {#losmethod}

Network Level of Service Method

```csharp
int LOSMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - SIDRA Speed Efficiency
- `2` - HCM 2010 Speed Efficiency
- `3` - HCM 6 Speed Efficiency

???- example "Code samples"

    === "C#"

        ```csharp
        int lOSMethod = network.LOSMethod;
        network.LOSMethod = 0;
        ```

    === "C++"

        ```cpp
        long lOSMethod;
        network->get_LOSMethod(&lOSMethod);
        network->put_LOSMethod(0);
        ```

    === "Python"

        ```python
        los_method = network.LOSMethod
        network.LOSMethod = 0
        ```

### LOSTarget {#lostarget}

Network Level of Service Target

```csharp
int LOSTarget { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - LOS A
- `2` - LOS B
- `3` - LOS C
- `4` - LOS D
- `5` - LOS E
- `6` - LOS F

???- example "Code samples"

    === "C#"

        ```csharp
        int lOSTarget = network.LOSTarget;
        network.LOSTarget = 0;
        ```

    === "C++"

        ```cpp
        long lOSTarget;
        network->get_LOSTarget(&lOSTarget);
        network->put_LOSTarget(0);
        ```

    === "Python"

        ```python
        los_target = network.LOSTarget
        network.LOSTarget = 0
        ```

### HoursPerYear {#hoursperyear}

```csharp
int HoursPerYear { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int hoursPerYear = network.HoursPerYear;
        network.HoursPerYear = 0;
        ```

    === "C++"

        ```cpp
        long hoursPerYear;
        network->get_HoursPerYear(&hoursPerYear);
        network->put_HoursPerYear(0);
        ```

    === "Python"

        ```python
        hours_per_year = network.HoursPerYear
        network.HoursPerYear = 0
        ```

### MaxIterations {#maxiterations}

```csharp
int MaxIterations { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int maxIterations = network.MaxIterations;
        network.MaxIterations = 0;
        ```

    === "C++"

        ```cpp
        long maxIterations;
        network->get_MaxIterations(&maxIterations);
        network->put_MaxIterations(0);
        ```

    === "Python"

        ```python
        max_iterations = network.MaxIterations
        network.MaxIterations = 0
        ```

### StoppingDxPercent {#stoppingdxpercent}

Percentage Stopping Condition for the One-Loop Convergence Method.

```csharp
float StoppingDxPercent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoppingDxPercent = network.StoppingDxPercent;
        network.StoppingDxPercent = 0.0;
        ```

    === "C++"

        ```cpp
        double stoppingDxPercent;
        network->get_StoppingDxPercent(&stoppingDxPercent);
        network->put_StoppingDxPercent(0.0);
        ```

    === "Python"

        ```python
        stopping_dx_percent = network.StoppingDxPercent
        network.StoppingDxPercent = 0.0
        ```

### SignalOffsetOption {#signaloffsetoption}

Signal Offset Option

```csharp
int SignalOffsetOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Program
- `1` - User-Given

???- example "Code samples"

    === "C#"

        ```csharp
        int signalOffsetOption = network.SignalOffsetOption;
        network.SignalOffsetOption = 0;
        ```

    === "C++"

        ```cpp
        long signalOffsetOption;
        network->get_SignalOffsetOption(&signalOffsetOption);
        network->put_SignalOffsetOption(0);
        ```

    === "Python"

        ```python
        signal_offset_option = network.SignalOffsetOption
        network.SignalOffsetOption = 0
        ```

### OffsetDefinition {#offsetdefinition}

Signal Offset Definition

```csharp
int OffsetDefinition { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Offsets (Phase Start)
- `1` - Offsets (Green Start)

???- example "Code samples"

    === "C#"

        ```csharp
        int offsetDefinition = network.OffsetDefinition;
        network.OffsetDefinition = 0;
        ```

    === "C++"

        ```cpp
        long offsetDefinition;
        network->get_OffsetDefinition(&offsetDefinition);
        network->put_OffsetDefinition(0);
        ```

    === "Python"

        ```python
        offset_definition = network.OffsetDefinition
        network.OffsetDefinition = 0
        ```

### IsPlatoonDispersionApplied {#isplatoondispersionapplied}

```csharp
bool IsPlatoonDispersionApplied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isPlatoonDispersionApplied = network.IsPlatoonDispersionApplied;
        network.IsPlatoonDispersionApplied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isPlatoonDispersionApplied;
        network->get_IsPlatoonDispersionApplied(&isPlatoonDispersionApplied);
        network->put_IsPlatoonDispersionApplied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_platoon_dispersion_applied = network.IsPlatoonDispersionApplied
        network.IsPlatoonDispersionApplied = True
        ```

### Cycle_time_option {#cycle_time_option}

Cycle Time Option

```csharp
int Cycle_time_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Program
- `2` - User-Given Cycle Time

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option = network.Cycle_time_option;
        network.Cycle_time_option = 0;
        ```

    === "C++"

        ```cpp
        long cycle_time_option;
        network->get_Cycle_time_option(&cycle_time_option);
        network->put_Cycle_time_option(0);
        ```

    === "Python"

        ```python
        cycle_time_option = network.Cycle_time_option
        network.Cycle_time_option = 0
        ```

### NetworkCycleTime {#networkcycletime}

```csharp
float NetworkCycleTime { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float networkCycleTime = network.NetworkCycleTime;
        network.NetworkCycleTime = 0.0;
        ```

    === "C++"

        ```cpp
        double networkCycleTime;
        network->get_NetworkCycleTime(&networkCycleTime);
        network->put_NetworkCycleTime(0.0);
        ```

    === "Python"

        ```python
        network_cycle_time = network.NetworkCycleTime
        network.NetworkCycleTime = 0.0
        ```

### Practical_max_cycle_time {#practical_max_cycle_time}

```csharp
float Practical_max_cycle_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_max_cycle_time = network.Practical_max_cycle_time;
        network.Practical_max_cycle_time = 0.0;
        ```

    === "C++"

        ```cpp
        double practical_max_cycle_time;
        network->get_Practical_max_cycle_time(&practical_max_cycle_time);
        network->put_Practical_max_cycle_time(0.0);
        ```

    === "Python"

        ```python
        practical_max_cycle_time = network.Practical_max_cycle_time
        network.Practical_max_cycle_time = 0.0
        ```

### Practical_cycle_rounding_applied {#practical_cycle_rounding_applied}

```csharp
bool Practical_cycle_rounding_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_cycle_rounding_applied = network.Practical_cycle_rounding_applied;
        network.Practical_cycle_rounding_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_cycle_rounding_applied;
        network->get_Practical_cycle_rounding_applied(&practical_cycle_rounding_applied);
        network->put_Practical_cycle_rounding_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        practical_cycle_rounding_applied = network.Practical_cycle_rounding_applied
        network.Practical_cycle_rounding_applied = True
        ```

### Practical_cycle_rounding {#practical_cycle_rounding}

```csharp
int Practical_cycle_rounding { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int practical_cycle_rounding = network.Practical_cycle_rounding;
        network.Practical_cycle_rounding = 0;
        ```

    === "C++"

        ```cpp
        long practical_cycle_rounding;
        network->get_Practical_cycle_rounding(&practical_cycle_rounding);
        network->put_Practical_cycle_rounding(0);
        ```

    === "Python"

        ```python
        practical_cycle_rounding = network.Practical_cycle_rounding
        network.Practical_cycle_rounding = 0
        ```

### SitePhaseTimesOption {#sitephasetimesoption}

Site or CCG Phase Times Option. It is applied when Cycle Time Option is User-Given Cycle Time.

```csharp
int SitePhaseTimesOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Program
- `1` - User-Given

???- example "Code samples"

    === "C#"

        ```csharp
        int sitePhaseTimesOption = network.SitePhaseTimesOption;
        network.SitePhaseTimesOption = 0;
        ```

    === "C++"

        ```cpp
        long sitePhaseTimesOption;
        network->get_SitePhaseTimesOption(&sitePhaseTimesOption);
        network->put_SitePhaseTimesOption(0);
        ```

    === "Python"

        ```python
        site_phase_times_option = network.SitePhaseTimesOption
        network.SitePhaseTimesOption = 0
        ```

### MultiRoutesSummaryOption {#multiroutessummaryoption}

Network Output by Routes Option

```csharp
int MultiRoutesSummaryOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `2` - Approaches
- `3` - Sites

???- example "Code samples"

    === "C#"

        ```csharp
        int multiRoutesSummaryOption = network.MultiRoutesSummaryOption;
        network.MultiRoutesSummaryOption = 0;
        ```

    === "C++"

        ```cpp
        long multiRoutesSummaryOption;
        network->get_MultiRoutesSummaryOption(&multiRoutesSummaryOption);
        network->put_MultiRoutesSummaryOption(0);
        ```

    === "Python"

        ```python
        multi_routes_summary_option = network.MultiRoutesSummaryOption
        network.MultiRoutesSummaryOption = 0
        ```

### Created_date {#created_date}

```csharp
DateTime Created_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var created_date = network.Created_date;
        ```

    === "C++"

        ```cpp
        VARIANT created_date;
        network->get_Created_date(&created_date);
        ```

    === "Python"

        ```python
        created_date = network.Created_date
        ```

### Created_by {#created_by}

```csharp
string Created_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by = network.Created_by;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by;
        network->get_Created_by(&created_by);
        ```

    === "Python"

        ```python
        created_by = network.Created_by
        ```

### Created_by_company {#created_by_company}

```csharp
string Created_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by_company = network.Created_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by_company;
        network->get_Created_by_company(&created_by_company);
        ```

    === "Python"

        ```python
        created_by_company = network.Created_by_company
        ```

### Created_version {#created_version}

```csharp
string Created_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_version = network.Created_version;
        ```

    === "C++"

        ```cpp
        CComBSTR created_version;
        network->get_Created_version(&created_version);
        ```

    === "Python"

        ```python
        created_version = network.Created_version
        ```

### Modified_date {#modified_date}

```csharp
DateTime Modified_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var modified_date = network.Modified_date;
        ```

    === "C++"

        ```cpp
        VARIANT modified_date;
        network->get_Modified_date(&modified_date);
        ```

    === "Python"

        ```python
        modified_date = network.Modified_date
        ```

### Modified_by {#modified_by}

```csharp
string Modified_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by = network.Modified_by;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by;
        network->get_Modified_by(&modified_by);
        ```

    === "Python"

        ```python
        modified_by = network.Modified_by
        ```

### Modified_by_company {#modified_by_company}

```csharp
string Modified_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by_company = network.Modified_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by_company;
        network->get_Modified_by_company(&modified_by_company);
        ```

    === "Python"

        ```python
        modified_by_company = network.Modified_by_company
        ```

### Modified_version {#modified_version}

```csharp
string Modified_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_version = network.Modified_version;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_version;
        network->get_Modified_version(&modified_version);
        ```

    === "Python"

        ```python
        modified_version = network.Modified_version
        ```

### ProcessingError {#processingerror}

Error nessage after a failed call to Process

```csharp
string ProcessingError { get; }
```

**Type** `string`

**Value**

Error message

???- example "Code samples"

    === "C#"

        ```csharp
        string processingError = network.ProcessingError;
        ```

    === "C++"

        ```cpp
        CComBSTR processingError;
        network->get_ProcessingError(&processingError);
        ```

    === "Python"

        ```python
        processing_error = network.ProcessingError
        ```

### NetworkSites {#networksites}

Collection of Sites in the Network

```csharp
ISIAPINetworkSites NetworkSites { get; }
```

**Type** [`ISIAPINetworkSites`](sidrasolutions.si.api.isiapinetworksites.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSites = network.NetworkSites;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSites> networkSites;
        network->get_NetworkSites(&networkSites);
        ```

    === "Python"

        ```python
        network_sites = network.NetworkSites
        ```

### NetworkLegConnections {#networklegconnections}

Collection of Leg Connections between the Sites in the Network

```csharp
ISIAPINetworkLegConnections NetworkLegConnections { get; }
```

**Type** [`ISIAPINetworkLegConnections`](sidrasolutions.si.api.isiapinetworklegconnections.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkLegConnections = network.NetworkLegConnections;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkLegConnections> networkLegConnections;
        network->get_NetworkLegConnections(&networkLegConnections);
        ```

    === "Python"

        ```python
        network_leg_connections = network.NetworkLegConnections
        ```

### OutputNetwork {#outputnetwork}

Network Output Data for the summary of the Whole Network

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = network.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        network->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = network.OutputNetwork
        ```

### OutputNetworkByRoutes {#outputnetworkbyroutes}

Network Output Data for the statistics summary of the selected Routes

```csharp
ISIAPIOutputNetwork OutputNetworkByRoutes { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkByRoutes = network.OutputNetworkByRoutes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetworkByRoutes;
        network->get_OutputNetworkByRoutes(&outputNetworkByRoutes);
        ```

    === "Python"

        ```python
        output_network_by_routes = network.OutputNetworkByRoutes
        ```

### Site_los_method {#site_los_method}

```csharp
int Site_los_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int site_los_method = network.Site_los_method;
        network.Site_los_method = 0;
        ```

    === "C++"

        ```cpp
        long site_los_method;
        network->get_Site_los_method(&site_los_method);
        network->put_Site_los_method(0);
        ```

    === "Python"

        ```python
        site_los_method = network.Site_los_method
        network.Site_los_method = 0
        ```

### Performance_measure {#performance_measure}

```csharp
int Performance_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int performance_measure = network.Performance_measure;
        network.Performance_measure = 0;
        ```

    === "C++"

        ```cpp
        long performance_measure;
        network->get_Performance_measure(&performance_measure);
        network->put_Performance_measure(0);
        ```

    === "Python"

        ```python
        performance_measure = network.Performance_measure
        network.Performance_measure = 0
        ```

### Percentile_queue_option {#percentile_queue_option}

```csharp
int Percentile_queue_option { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int percentile_queue_option = network.Percentile_queue_option;
        network.Percentile_queue_option = 0;
        ```

    === "C++"

        ```cpp
        long percentile_queue_option;
        network->get_Percentile_queue_option(&percentile_queue_option);
        network->put_Percentile_queue_option(0);
        ```

    === "Python"

        ```python
        percentile_queue_option = network.Percentile_queue_option
        network.Percentile_queue_option = 0
        ```

### Percentile_queue {#percentile_queue}

```csharp
int Percentile_queue { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int percentile_queue = network.Percentile_queue;
        network.Percentile_queue = 0;
        ```

    === "C++"

        ```cpp
        long percentile_queue;
        network->get_Percentile_queue(&percentile_queue);
        network->put_Percentile_queue(0);
        ```

    === "Python"

        ```python
        percentile_queue = network.Percentile_queue
        network.Percentile_queue = 0
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = network.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        network->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = network.LastErrorMessage
        ```

### DiagnosticStatus {#diagnosticstatus}

Diagnostic Status

```csharp
int DiagnosticStatus { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Processed
- `2` - Not Processed
- `3` - Input Warning
- `4` - Processing Warning
- `5` - Error

???- example "Code samples"

    === "C#"

        ```csharp
        int diagnosticStatus = network.DiagnosticStatus;
        ```

    === "C++"

        ```cpp
        long diagnosticStatus;
        network->get_DiagnosticStatus(&diagnosticStatus);
        ```

    === "Python"

        ```python
        diagnostic_status = network.DiagnosticStatus
        ```

### DiagnosticMsgs {#diagnosticmsgs}

```csharp
ISIAPIDiagnosticMsgs DiagnosticMsgs { get; }
```

**Type** [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var diagnosticMsgs = network.DiagnosticMsgs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIDiagnosticMsgs> diagnosticMsgs;
        network->get_DiagnosticMsgs(&diagnosticMsgs);
        ```

    === "Python"

        ```python
        diagnostic_msgs = network.DiagnosticMsgs
        ```

### Project {#project}

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var project = network.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        network->get_Project(&project);
        ```

    === "Python"

        ```python
        project = network.Project
        ```

### NetworkCCGs {#networkccgs}

Collection of Common Control Group (CCG) in the Network

```csharp
ISIAPINetworkCCGs NetworkCCGs { get; }
```

**Type** [`ISIAPINetworkCCGs`](sidrasolutions.si.api.isiapinetworkccgs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkCCGs = network.NetworkCCGs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGs> networkCCGs;
        network->get_NetworkCCGs(&networkCCGs);
        ```

    === "Python"

        ```python
        network_cc_gs = network.NetworkCCGs
        ```

### Routes {#routes}

Collection of Routes in the Network

```csharp
ISIAPIRoutes Routes { get; }
```

**Type** [`ISIAPIRoutes`](sidrasolutions.si.api.isiapiroutes.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var routes = network.Routes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoutes> routes;
        network->get_Routes(&routes);
        ```

    === "Python"

        ```python
        routes = network.Routes
        ```

### Category {#category}

Network Category

```csharp
string Category { get; set; }
```

**Type** `string`

**Value**

Network Category, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string category = network.Category;
        network.Category = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR category;
        network->get_Category(&category);
        network->put_Category(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        category = network.Category
        network.Category = r"value"
        ```

### Peakflowperiod {#peakflowperiod}

```csharp
int Peakflowperiod { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int peakflowperiod = network.Peakflowperiod;
        network.Peakflowperiod = 0;
        ```

    === "C++"

        ```cpp
        long peakflowperiod;
        network->get_Peakflowperiod(&peakflowperiod);
        network->put_Peakflowperiod(0);
        ```

    === "Python"

        ```python
        peakflowperiod = network.Peakflowperiod
        network.Peakflowperiod = 0
        ```

### Lane_blockage_effect_option {#lane_blockage_effect_option}

Lane Blockage Effect Option:  
In Network analysis, include Lane Blockage effects in determining Phase Times.

```csharp
int Lane_blockage_effect_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Without Lane Blockage Effects
- `1` - With Lane Blockage Effects

???- example "Code samples"

    === "C#"

        ```csharp
        int lane_blockage_effect_option = network.Lane_blockage_effect_option;
        network.Lane_blockage_effect_option = 0;
        ```

    === "C++"

        ```cpp
        long lane_blockage_effect_option;
        network->get_Lane_blockage_effect_option(&lane_blockage_effect_option);
        network->put_Lane_blockage_effect_option(0);
        ```

    === "Python"

        ```python
        lane_blockage_effect_option = network.Lane_blockage_effect_option
        network.Lane_blockage_effect_option = 0
        ```

### Optimum_cycle_time_lower_user {#optimum_cycle_time_lower_user}

```csharp
bool Optimum_cycle_time_lower_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool optimum_cycle_time_lower_user = network.Optimum_cycle_time_lower_user;
        network.Optimum_cycle_time_lower_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL optimum_cycle_time_lower_user;
        network->get_Optimum_cycle_time_lower_user(&optimum_cycle_time_lower_user);
        network->put_Optimum_cycle_time_lower_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower_user = network.Optimum_cycle_time_lower_user
        network.Optimum_cycle_time_lower_user = True
        ```

### Optimum_cycle_time_lower {#optimum_cycle_time_lower}

```csharp
int Optimum_cycle_time_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_lower = network.Optimum_cycle_time_lower;
        network.Optimum_cycle_time_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_lower;
        network->get_Optimum_cycle_time_lower(&optimum_cycle_time_lower);
        network->put_Optimum_cycle_time_lower(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower = network.Optimum_cycle_time_lower
        network.Optimum_cycle_time_lower = 0
        ```

### Optimum_cycle_time_upper {#optimum_cycle_time_upper}

```csharp
int Optimum_cycle_time_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_upper = network.Optimum_cycle_time_upper;
        network.Optimum_cycle_time_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_upper;
        network->get_Optimum_cycle_time_upper(&optimum_cycle_time_upper);
        network->put_Optimum_cycle_time_upper(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_upper = network.Optimum_cycle_time_upper
        network.Optimum_cycle_time_upper = 0
        ```

### Optimum_cycle_time_increment {#optimum_cycle_time_increment}

```csharp
int Optimum_cycle_time_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_increment = network.Optimum_cycle_time_increment;
        network.Optimum_cycle_time_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_increment;
        network->get_Optimum_cycle_time_increment(&optimum_cycle_time_increment);
        network->put_Optimum_cycle_time_increment(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_increment = network.Optimum_cycle_time_increment
        network.Optimum_cycle_time_increment = 0
        ```

### Optimum_cycle_time_perf_measure {#optimum_cycle_time_perf_measure}

```csharp
int Optimum_cycle_time_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_perf_measure = network.Optimum_cycle_time_perf_measure;
        network.Optimum_cycle_time_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_perf_measure;
        network->get_Optimum_cycle_time_perf_measure(&optimum_cycle_time_perf_measure);
        network->put_Optimum_cycle_time_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_perf_measure = network.Optimum_cycle_time_perf_measure
        network.Optimum_cycle_time_perf_measure = 0
        ```

### Optimum_cycle_time_optim_method {#optimum_cycle_time_optim_method}

```csharp
int Optimum_cycle_time_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_optim_method = network.Optimum_cycle_time_optim_method;
        network.Optimum_cycle_time_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_optim_method;
        network->get_Optimum_cycle_time_optim_method(&optimum_cycle_time_optim_method);
        network->put_Optimum_cycle_time_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_optim_method = network.Optimum_cycle_time_optim_method
        network.Optimum_cycle_time_optim_method = 0
        ```

### Optimum_max_green_percent_lower {#optimum_max_green_percent_lower}

```csharp
int Optimum_max_green_percent_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_lower = network.Optimum_max_green_percent_lower;
        network.Optimum_max_green_percent_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_lower;
        network->get_Optimum_max_green_percent_lower(&optimum_max_green_percent_lower);
        network->put_Optimum_max_green_percent_lower(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_lower = network.Optimum_max_green_percent_lower
        network.Optimum_max_green_percent_lower = 0
        ```

### Optimum_max_green_percent_upper {#optimum_max_green_percent_upper}

```csharp
int Optimum_max_green_percent_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_upper = network.Optimum_max_green_percent_upper;
        network.Optimum_max_green_percent_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_upper;
        network->get_Optimum_max_green_percent_upper(&optimum_max_green_percent_upper);
        network->put_Optimum_max_green_percent_upper(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_upper = network.Optimum_max_green_percent_upper
        network.Optimum_max_green_percent_upper = 0
        ```

### Optimum_max_green_percent_increment {#optimum_max_green_percent_increment}

```csharp
int Optimum_max_green_percent_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_increment = network.Optimum_max_green_percent_increment;
        network.Optimum_max_green_percent_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_increment;
        network->get_Optimum_max_green_percent_increment(&optimum_max_green_percent_increment);
        network->put_Optimum_max_green_percent_increment(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_increment = network.Optimum_max_green_percent_increment
        network.Optimum_max_green_percent_increment = 0
        ```

### Optimum_max_green_perf_measure {#optimum_max_green_perf_measure}

```csharp
int Optimum_max_green_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_perf_measure = network.Optimum_max_green_perf_measure;
        network.Optimum_max_green_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_perf_measure;
        network->get_Optimum_max_green_perf_measure(&optimum_max_green_perf_measure);
        network->put_Optimum_max_green_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_max_green_perf_measure = network.Optimum_max_green_perf_measure
        network.Optimum_max_green_perf_measure = 0
        ```

### Optimum_max_green_optim_method {#optimum_max_green_optim_method}

```csharp
int Optimum_max_green_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_optim_method = network.Optimum_max_green_optim_method;
        network.Optimum_max_green_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_optim_method;
        network->get_Optimum_max_green_optim_method(&optimum_max_green_optim_method);
        network->put_Optimum_max_green_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_max_green_optim_method = network.Optimum_max_green_optim_method
        network.Optimum_max_green_optim_method = 0
        ```

### Variable_phasing_perf_measure {#variable_phasing_perf_measure}

```csharp
int Variable_phasing_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int variable_phasing_perf_measure = network.Variable_phasing_perf_measure;
        network.Variable_phasing_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long variable_phasing_perf_measure;
        network->get_Variable_phasing_perf_measure(&variable_phasing_perf_measure);
        network->put_Variable_phasing_perf_measure(0);
        ```

    === "Python"

        ```python
        variable_phasing_perf_measure = network.Variable_phasing_perf_measure
        network.Variable_phasing_perf_measure = 0
        ```

### Green_split_priority_option {#green_split_priority_option}

Green Split Priority

```csharp
int Green_split_priority_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Coordinated Movements
- `2` - User-Specified Movements

???- example "Code samples"

    === "C#"

        ```csharp
        int green_split_priority_option = network.Green_split_priority_option;
        network.Green_split_priority_option = 0;
        ```

    === "C++"

        ```cpp
        long green_split_priority_option;
        network->get_Green_split_priority_option(&green_split_priority_option);
        network->put_Green_split_priority_option(0);
        ```

    === "Python"

        ```python
        green_split_priority_option = network.Green_split_priority_option
        network.Green_split_priority_option = 0
        ```

### Is_timing_optimised_for_selected_result {#is_timing_optimised_for_selected_result}

```csharp
bool Is_timing_optimised_for_selected_result { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_timing_optimised_for_selected_result = network.Is_timing_optimised_for_selected_result;
        network.Is_timing_optimised_for_selected_result = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_timing_optimised_for_selected_result;
        network->get_Is_timing_optimised_for_selected_result(&is_timing_optimised_for_selected_result);
        network->put_Is_timing_optimised_for_selected_result(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_timing_optimised_for_selected_result = network.Is_timing_optimised_for_selected_result
        network.Is_timing_optimised_for_selected_result = True
        ```

### IsIncludedInProjectSummary {#isincludedinprojectsummary}

```csharp
bool IsIncludedInProjectSummary { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInProjectSummary = network.IsIncludedInProjectSummary;
        network.IsIncludedInProjectSummary = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInProjectSummary;
        network->get_IsIncludedInProjectSummary(&isIncludedInProjectSummary);
        network->put_IsIncludedInProjectSummary(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_project_summary = network.IsIncludedInProjectSummary
        network.IsIncludedInProjectSummary = True
        ```

### DemandSensitivity {#demandsensitivity}

```csharp
ISIAPINetworkDemandSensitivity DemandSensitivity { get; }
```

**Type** [`ISIAPINetworkDemandSensitivity`](sidrasolutions.si.api.isiapinetworkdemandsensitivity.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var demandSensitivity = network.DemandSensitivity;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkDemandSensitivity> demandSensitivity;
        network->get_DemandSensitivity(&demandSensitivity);
        ```

    === "Python"

        ```python
        demand_sensitivity = network.DemandSensitivity
        ```

### NetworkFolder {#networkfolder}

```csharp
ISIAPINetworkFolder NetworkFolder { get; }
```

**Type** [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkFolder = network.NetworkFolder;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkFolder> networkFolder;
        network->get_NetworkFolder(&networkFolder);
        ```

    === "Python"

        ```python
        network_folder = network.NetworkFolder
        ```

### SpeedEfficiencyLOSUpperLimit_B {#speedefficiencylosupperlimit_b}

```csharp
float SpeedEfficiencyLOSUpperLimit_B { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiencyLOSUpperLimit_B = network.SpeedEfficiencyLOSUpperLimit_B;
        network.SpeedEfficiencyLOSUpperLimit_B = 0.0;
        ```

    === "C++"

        ```cpp
        double speedEfficiencyLOSUpperLimit_B;
        network->get_SpeedEfficiencyLOSUpperLimit_B(&speedEfficiencyLOSUpperLimit_B);
        network->put_SpeedEfficiencyLOSUpperLimit_B(0.0);
        ```

    === "Python"

        ```python
        speed_efficiency_los_upper_limit_b = network.SpeedEfficiencyLOSUpperLimit_B
        network.SpeedEfficiencyLOSUpperLimit_B = 0.0
        ```

### SpeedEfficiencyLOSUpperLimit_C {#speedefficiencylosupperlimit_c}

```csharp
float SpeedEfficiencyLOSUpperLimit_C { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiencyLOSUpperLimit_C = network.SpeedEfficiencyLOSUpperLimit_C;
        network.SpeedEfficiencyLOSUpperLimit_C = 0.0;
        ```

    === "C++"

        ```cpp
        double speedEfficiencyLOSUpperLimit_C;
        network->get_SpeedEfficiencyLOSUpperLimit_C(&speedEfficiencyLOSUpperLimit_C);
        network->put_SpeedEfficiencyLOSUpperLimit_C(0.0);
        ```

    === "Python"

        ```python
        speed_efficiency_los_upper_limit_c = network.SpeedEfficiencyLOSUpperLimit_C
        network.SpeedEfficiencyLOSUpperLimit_C = 0.0
        ```

### SpeedEfficiencyLOSUpperLimit_D {#speedefficiencylosupperlimit_d}

```csharp
float SpeedEfficiencyLOSUpperLimit_D { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiencyLOSUpperLimit_D = network.SpeedEfficiencyLOSUpperLimit_D;
        network.SpeedEfficiencyLOSUpperLimit_D = 0.0;
        ```

    === "C++"

        ```cpp
        double speedEfficiencyLOSUpperLimit_D;
        network->get_SpeedEfficiencyLOSUpperLimit_D(&speedEfficiencyLOSUpperLimit_D);
        network->put_SpeedEfficiencyLOSUpperLimit_D(0.0);
        ```

    === "Python"

        ```python
        speed_efficiency_los_upper_limit_d = network.SpeedEfficiencyLOSUpperLimit_D
        network.SpeedEfficiencyLOSUpperLimit_D = 0.0
        ```

### SpeedEfficiencyLOSUpperLimit_E {#speedefficiencylosupperlimit_e}

```csharp
float SpeedEfficiencyLOSUpperLimit_E { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiencyLOSUpperLimit_E = network.SpeedEfficiencyLOSUpperLimit_E;
        network.SpeedEfficiencyLOSUpperLimit_E = 0.0;
        ```

    === "C++"

        ```cpp
        double speedEfficiencyLOSUpperLimit_E;
        network->get_SpeedEfficiencyLOSUpperLimit_E(&speedEfficiencyLOSUpperLimit_E);
        network->put_SpeedEfficiencyLOSUpperLimit_E(0.0);
        ```

    === "Python"

        ```python
        speed_efficiency_los_upper_limit_e = network.SpeedEfficiencyLOSUpperLimit_E
        network.SpeedEfficiencyLOSUpperLimit_E = 0.0
        ```

### SpeedEfficiencyLOSUpperLimit_F {#speedefficiencylosupperlimit_f}

```csharp
float SpeedEfficiencyLOSUpperLimit_F { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiencyLOSUpperLimit_F = network.SpeedEfficiencyLOSUpperLimit_F;
        network.SpeedEfficiencyLOSUpperLimit_F = 0.0;
        ```

    === "C++"

        ```cpp
        double speedEfficiencyLOSUpperLimit_F;
        network->get_SpeedEfficiencyLOSUpperLimit_F(&speedEfficiencyLOSUpperLimit_F);
        network->put_SpeedEfficiencyLOSUpperLimit_F(0.0);
        ```

    === "Python"

        ```python
        speed_efficiency_los_upper_limit_f = network.SpeedEfficiencyLOSUpperLimit_F
        network.SpeedEfficiencyLOSUpperLimit_F = 0.0
        ```

### Is_geometric_delay_excluded {#is_geometric_delay_excluded}

```csharp
bool Is_geometric_delay_excluded { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_geometric_delay_excluded = network.Is_geometric_delay_excluded;
        network.Is_geometric_delay_excluded = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_geometric_delay_excluded;
        network->get_Is_geometric_delay_excluded(&is_geometric_delay_excluded);
        network->put_Is_geometric_delay_excluded(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_geometric_delay_excluded = network.Is_geometric_delay_excluded
        network.Is_geometric_delay_excluded = True
        ```

### Is_hcm_delay_formula_applied {#is_hcm_delay_formula_applied}

```csharp
bool Is_hcm_delay_formula_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_hcm_delay_formula_applied = network.Is_hcm_delay_formula_applied;
        network.Is_hcm_delay_formula_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_hcm_delay_formula_applied;
        network->get_Is_hcm_delay_formula_applied(&is_hcm_delay_formula_applied);
        network->put_Is_hcm_delay_formula_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_hcm_delay_formula_applied = network.Is_hcm_delay_formula_applied
        network.Is_hcm_delay_formula_applied = True
        ```

### Is_hcm_queue_formula_applied {#is_hcm_queue_formula_applied}

```csharp
bool Is_hcm_queue_formula_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_hcm_queue_formula_applied = network.Is_hcm_queue_formula_applied;
        network.Is_hcm_queue_formula_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_hcm_queue_formula_applied;
        network->get_Is_hcm_queue_formula_applied(&is_hcm_queue_formula_applied);
        network->put_Is_hcm_queue_formula_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_hcm_queue_formula_applied = network.Is_hcm_queue_formula_applied
        network.Is_hcm_queue_formula_applied = True
        ```

### IsLaneBlockageModelApplied {#islaneblockagemodelapplied}

```csharp
bool IsLaneBlockageModelApplied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isLaneBlockageModelApplied = network.IsLaneBlockageModelApplied;
        network.IsLaneBlockageModelApplied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isLaneBlockageModelApplied;
        network->get_IsLaneBlockageModelApplied(&isLaneBlockageModelApplied);
        network->put_IsLaneBlockageModelApplied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_lane_blockage_model_applied = network.IsLaneBlockageModelApplied
        network.IsLaneBlockageModelApplied = True
        ```

### NetworkMCs {#networkmcs}

```csharp
ISIAPINetworkMCs NetworkMCs { get; }
```

**Type** [`ISIAPINetworkMCs`](sidrasolutions.si.api.isiapinetworkmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkMCs = network.NetworkMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkMCs> networkMCs;
        network->get_NetworkMCs(&networkMCs);
        ```

    === "Python"

        ```python
        network_m_cs = network.NetworkMCs
        ```

### IsUserModel {#isusermodel}

Flag indicating whether the internal SIDRA INTERSECTION Software Setup that is used by this Network 
is a User Software Setup or a Standard Software Setup.

```csharp
bool IsUserModel { get; }
```

**Type** `bool`

**Value**

True if the Software Setup is a User Software Setup. False if the Software Setup is a Standard Software Setup.

???- example "Code samples"

    === "C#"

        ```csharp
        bool isUserModel = network.IsUserModel;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isUserModel;
        network->get_IsUserModel(&isUserModel);
        ```

    === "Python"

        ```python
        is_user_model = network.IsUserModel
        ```

### NetworkType {#networktype}

Network Type

```csharp
int NetworkType { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Basic Network
- `1` - Assign Network

???- example "Code samples"

    === "C#"

        ```csharp
        int networkType = network.NetworkType;
        ```

    === "C++"

        ```cpp
        long networkType;
        network->get_NetworkType(&networkType);
        ```

    === "Python"

        ```python
        network_type = network.NetworkType
        ```

### NetworkScenarios {#networkscenarios}

Collection of the Network Scenarios

```csharp
ISIAPINetworkScenarios NetworkScenarios { get; }
```

**Type** [`ISIAPINetworkScenarios`](sidrasolutions.si.api.isiapinetworkscenarios.md)

**Remarks**

The first Network Local Scenario is created when creating a Network. This Scenario's Volume Type == 0 (Local). The Local 
Site Scenario of each Site in this Network is applied.

More Network Scenarios that link to different Site Scenarios can be added into a Network.

???- example "Code samples"

    === "C#"

        ```csharp
        var networkScenarios = network.NetworkScenarios;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenarios> networkScenarios;
        network->get_NetworkScenarios(&networkScenarios);
        ```

    === "Python"

        ```python
        network_scenarios = network.NetworkScenarios
        ```

### IsInputDataCompatible {#isinputdatacompatible}

```csharp
bool IsInputDataCompatible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isInputDataCompatible = network.IsInputDataCompatible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isInputDataCompatible;
        network->get_IsInputDataCompatible(&isInputDataCompatible);
        ```

    === "Python"

        ```python
        is_input_data_compatible = network.IsInputDataCompatible
        ```

### IsOutputDataCompatible {#isoutputdatacompatible}

```csharp
bool IsOutputDataCompatible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isOutputDataCompatible = network.IsOutputDataCompatible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isOutputDataCompatible;
        network->get_IsOutputDataCompatible(&isOutputDataCompatible);
        ```

    === "Python"

        ```python
        is_output_data_compatible = network.IsOutputDataCompatible
        ```

### MinViableVersionL1 {#minviableversionl1}

Minimum Viable SIDRA INTERSECTION Version for this Network's Level 1 Compatibility

```csharp
string MinViableVersionL1 { get; }
```

**Type** `string`

**Remarks**

Level 1 Compatibility means that this Network's Input and Output data are fully compatible with 
the current SIDRA INTERSECTION version.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL1 = network.MinViableVersionL1;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL1;
        network->get_MinViableVersionL1(&minViableVersionL1);
        ```

    === "Python"

        ```python
        min_viable_version_l1 = network.MinViableVersionL1
        ```

### MinViableVersionL2 {#minviableversionl2}

Minimum Viable SIDRA INTERSECTION Version for this Network's Level 2 Compatibility

```csharp
string MinViableVersionL2 { get; }
```

**Type** `string`

**Remarks**

Level 2 Compatibility means that some of this Network's Input and Output data are incompatible with 
the current SIDRA INTERSECTION version but the current version is still able to edit these Input data, proccess the Network,  
and access the Output data.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL2, 
ISIAPINetwork.IsInputDataCompatible return false.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL2 = network.MinViableVersionL2;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL2;
        network->get_MinViableVersionL2(&minViableVersionL2);
        ```

    === "Python"

        ```python
        min_viable_version_l2 = network.MinViableVersionL2
        ```

### MinViableVersionL3 {#minviableversionl3}

Minimum Viable SIDRA INTERSECTION Version for this Network's Level 3 Compatibility

```csharp
string MinViableVersionL3 { get; }
```

**Type** `string`

**Remarks**

Level 3 Compatibility means that this Network's Input data are not compatible with the current SIDRA INTERSECTION version 
but the Output data are compatible. The current version cannot access the Input data or process the Network but can access 
the Output data that were prepared by a later version of SIDRA INTERSECTION.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL3, this Network's Input and Output data 
are not accessible. The Network cannot be processed. ISIAPINetwork.IsOutputDataCompatible return false.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL3 = network.MinViableVersionL3;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL3;
        network->get_MinViableVersionL3(&minViableVersionL3);
        ```

    === "Python"

        ```python
        min_viable_version_l3 = network.MinViableVersionL3
        ```

### ConvergenceMethod {#convergencemethod}

Network Convergence Method

```csharp
int ConvergenceMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - One-Loop Convergence Method (Default)
- `1` - Two-Loop Convergence Method

???- example "Code samples"

    === "C#"

        ```csharp
        int convergenceMethod = network.ConvergenceMethod;
        network.ConvergenceMethod = 0;
        ```

    === "C++"

        ```cpp
        long convergenceMethod;
        network->get_ConvergenceMethod(&convergenceMethod);
        network->put_ConvergenceMethod(0);
        ```

    === "Python"

        ```python
        convergence_method = network.ConvergenceMethod
        network.ConvergenceMethod = 0
        ```

### TwoLoops_OuterMaxIterations {#twoloops_outermaxiterations}

Maximum number of iterations for the Outer Loop in the Two-Loop Convergence Method.

```csharp
int TwoLoops_OuterMaxIterations { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int twoLoops_OuterMaxIterations = network.TwoLoops_OuterMaxIterations;
        network.TwoLoops_OuterMaxIterations = 0;
        ```

    === "C++"

        ```cpp
        long twoLoops_OuterMaxIterations;
        network->get_TwoLoops_OuterMaxIterations(&twoLoops_OuterMaxIterations);
        network->put_TwoLoops_OuterMaxIterations(0);
        ```

    === "Python"

        ```python
        two_loops__outer_max_iterations = network.TwoLoops_OuterMaxIterations
        network.TwoLoops_OuterMaxIterations = 0
        ```

### TwoLoops_InnerMaxIterations {#twoloops_innermaxiterations}

Maximum number of iterations for the Inner Loop in the Two-Loop Convergence Method.

```csharp
int TwoLoops_InnerMaxIterations { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int twoLoops_InnerMaxIterations = network.TwoLoops_InnerMaxIterations;
        network.TwoLoops_InnerMaxIterations = 0;
        ```

    === "C++"

        ```cpp
        long twoLoops_InnerMaxIterations;
        network->get_TwoLoops_InnerMaxIterations(&twoLoops_InnerMaxIterations);
        network->put_TwoLoops_InnerMaxIterations(0);
        ```

    === "Python"

        ```python
        two_loops__inner_max_iterations = network.TwoLoops_InnerMaxIterations
        network.TwoLoops_InnerMaxIterations = 0
        ```

### TwoLoops_StoppingPercent {#twoloops_stoppingpercent}

Percentage Stopping Condition for the Outer Loop in the Two-Loop Convergence Method.

```csharp
float TwoLoops_StoppingPercent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float twoLoops_StoppingPercent = network.TwoLoops_StoppingPercent;
        network.TwoLoops_StoppingPercent = 0.0;
        ```

    === "C++"

        ```cpp
        double twoLoops_StoppingPercent;
        network->get_TwoLoops_StoppingPercent(&twoLoops_StoppingPercent);
        network->put_TwoLoops_StoppingPercent(0.0);
        ```

    === "Python"

        ```python
        two_loops__stopping_percent = network.TwoLoops_StoppingPercent
        network.TwoLoops_StoppingPercent = 0.0
        ```

### TwoLoops_ApplyMinStoppingPercent {#twoloops_applyminstoppingpercent}

Flag indicating if the Outer Loop's Minimum Percentage Stopping Condition is applied in the Two-Loop Convergence Method. 
If true, the result of the Outer Iteration with the Minimum Percentage Stopping Condition is provided when the Iterations do not settle.

```csharp
bool TwoLoops_ApplyMinStoppingPercent { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool twoLoops_ApplyMinStoppingPercent = network.TwoLoops_ApplyMinStoppingPercent;
        network.TwoLoops_ApplyMinStoppingPercent = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL twoLoops_ApplyMinStoppingPercent;
        network->get_TwoLoops_ApplyMinStoppingPercent(&twoLoops_ApplyMinStoppingPercent);
        network->put_TwoLoops_ApplyMinStoppingPercent(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        two_loops__apply_min_stopping_percent = network.TwoLoops_ApplyMinStoppingPercent
        network.TwoLoops_ApplyMinStoppingPercent = True
        ```

### TwoLoops_InnerStoppingPercent {#twoloops_innerstoppingpercent}

Percentage Stopping Condition for the Inner Loop in the Two-Loop Convergence Method.

```csharp
float TwoLoops_InnerStoppingPercent { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float twoLoops_InnerStoppingPercent = network.TwoLoops_InnerStoppingPercent;
        network.TwoLoops_InnerStoppingPercent = 0.0;
        ```

    === "C++"

        ```cpp
        double twoLoops_InnerStoppingPercent;
        network->get_TwoLoops_InnerStoppingPercent(&twoLoops_InnerStoppingPercent);
        network->put_TwoLoops_InnerStoppingPercent(0.0);
        ```

    === "Python"

        ```python
        two_loops__inner_stopping_percent = network.TwoLoops_InnerStoppingPercent
        network.TwoLoops_InnerStoppingPercent = 0.0
        ```

## Methods

### Process() {#process}

Processes the Whole Network

This method generates the `SIDRASolutions.SI.API.ISIAPINetwork.OutputNetwork` data.

```csharp
bool Process()
```

**Returns** `bool` - True, if processing was successful. False, if errors were generated during processing - check `SIDRASolutions.SI.API.ISIAPINetwork.ProcessingError` for details.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.Process();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->Process(&result);
        ```

    === "Python"

        ```python
        result = network.Process()
        ```

### UpdateModifiedInfo() {#updatemodifiedinfo}

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

```csharp
bool UpdateModifiedInfo()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.UpdateModifiedInfo();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->UpdateModifiedInfo(&result);
        ```

    === "Python"

        ```python
        result = network.UpdateModifiedInfo()
        ```

### AddNetworkSite(ISIAPISite, float, float) {#addnetworksite-isiapisite--float--float}

Add a Site into the Network. The Site's Drive Rule and Units must match this Network's ones.

```csharp
ISIAPINetworkSite AddNetworkSite(ISIAPISite site, float layoutX, float layoutY)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `site` | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | The Site to add. |
| `layoutX` | `float` | The X-coordinate value of the Site position in the Network Configuration Layout. |
| `layoutY` | `float` | The Y-coordinate value of the Site position in the Network Configuration Layout. |

**Returns** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) - The new added NetworkSite.

**Remarks**

The Network Configuration Layout is used in the Network Configuration Dialog in the SIDRA INTERSECTION program. 
The dimension of any Site in the Network Configuration Layout is 200 x 200 pixels. In the Network Configuration Dialog, the start point of view is (5000, 5000). 
So the NetworkSites created through this dialog are usually located around the point (5000, 5000). For example, Site1 (5200, 5100), Site2 (5550, 5100). 
The Sites' positions in the detailed Network Layout Display are based on the relative ratio of the Sites' positions in the Network Configuration Layout.

We suggest the layoutX and layoutY values to be around 5000, and between 0 and 10000.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.AddNetworkSite(null, 0.0, 0.0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> result;
        network->AddNetworkSite(NULL, 0.0, 0.0, &result);
        ```

    === "Python"

        ```python
        result = network.AddNetworkSite(None, 0.0, 0.0)
        ```

### RemoveNetworkSite(ISIAPINetworkSite) {#removenetworksite-isiapinetworksite}

Remove a NetworkSite from the Network. If the NetworkSite is used in any Route(s), remove the Route(s) before removing the NetworkSite.

```csharp
bool RemoveNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) | The NetworkSite to remove. |

**Returns** `bool` - true if the NetworkSite is successfully removed; otherwise, false. This method also returns false if the NetworkSite does not exist in this Network.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveNetworkSite(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.RemoveNetworkSite(None)
        ```

### AddNetworkLegConnection(ISIAPINetworkSite, int, ISIAPINetworkSite, int) {#addnetworklegconnection-isiapinetworksite--int--isiapinetworksite--int}

```csharp
ISIAPINetworkLegConnection AddNetworkLegConnection(ISIAPINetworkSite nwSite1, int legOrientation1, ISIAPINetworkSite nwSite2, int legOrientation2)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `nwSite1` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| `legOrientation1` | `int` |  |
| `nwSite2` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| `legOrientation2` | `int` |  |

**Returns** [`ISIAPINetworkLegConnection`](sidrasolutions.si.api.isiapinetworklegconnection.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.AddNetworkLegConnection(null, 0, null, 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkLegConnection> result;
        network->AddNetworkLegConnection(NULL, 0, NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = network.AddNetworkLegConnection(None, 0, None, 0)
        ```

### RemoveNetworkLegConnection(ISIAPINetworkLegConnection) {#removenetworklegconnection-isiapinetworklegconnection}

```csharp
bool RemoveNetworkLegConnection(ISIAPINetworkLegConnection nwLegConn)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `nwLegConn` | [`ISIAPINetworkLegConnection`](sidrasolutions.si.api.isiapinetworklegconnection.md) |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveNetworkLegConnection(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveNetworkLegConnection(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.RemoveNetworkLegConnection(None)
        ```

### AddNetworkCCG() {#addnetworkccg}

Add a new Common Control Group (CCG) into the Network.

```csharp
ISIAPINetworkCCG AddNetworkCCG()
```

**Returns** [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) - The new added Common Control Group (CCG).

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.AddNetworkCCG();
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCG> result;
        network->AddNetworkCCG(&result);
        ```

    === "Python"

        ```python
        result = network.AddNetworkCCG()
        ```

### RemoveNetworkCCG(ISIAPINetworkCCG) {#removenetworkccg-isiapinetworkccg}

Remove a Common Control Group (CCG) from the Network.

```csharp
bool RemoveNetworkCCG(ISIAPINetworkCCG ccg)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccg` | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) | The Common Control Group (CCG) to remove. |

**Returns** `bool` - true if the Common Control Group (CCG) is successfully removed; otherwise, false. This method also returns false if the CCG does not exist in this Network.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveNetworkCCG(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveNetworkCCG(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.RemoveNetworkCCG(None)
        ```

### AddRoute() {#addroute}

Add a new Route into the Network.

```csharp
ISIAPIRoute AddRoute()
```

**Returns** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) - The new added Route

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.AddRoute();
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> result;
        network->AddRoute(&result);
        ```

    === "Python"

        ```python
        result = network.AddRoute()
        ```

### RemoveRoute(ISIAPIRoute) {#removeroute-isiapiroute}

Remove a Route from the Network.

```csharp
bool RemoveRoute(ISIAPIRoute route)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `route` | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) | The Route to remove. |

**Returns** `bool` - true if the Route is successfully removed; otherwise, false. This method also returns false if the Route does not exist in this Network.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveRoute(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveRoute(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.RemoveRoute(None)
        ```

### ProcessByRoutes() {#processbyroutes}

Process this Network by selected Routes. The Whole Network needs to be processed before Network by selected Routes statistics can be calculated.  
If the Network has not been processed, process the Network. The Network by selected Routes statistics will be calculated as well. It is not required to call this method again.  
If Route(s) are set to be included into Network by Routes after the Network is processed, call this method to calculate the Network by selected Routes statistics.

This method generates the `SIDRASolutions.SI.API.ISIAPINetwork.OutputNetworkByRoutes` data.

```csharp
bool ProcessByRoutes()
```

**Returns** `bool` - true if this is processed successfully.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.ProcessByRoutes();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->ProcessByRoutes(&result);
        ```

    === "Python"

        ```python
        result = network.ProcessByRoutes()
        ```

### MoveNetworkCCGTo(ISIAPINetworkCCG, int) {#movenetworkccgto-isiapinetworkccg--int}

Move a Common Control Group (CCG) to a new position.

```csharp
bool MoveNetworkCCGTo(ISIAPINetworkCCG ccg, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccg` | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) | The Common Control Group to move. |
| `newPosition` | `int` | The zero-based position that the CCG should be moved to. |

**Returns** `bool` - true if the CCG is successfully moved; otherwise, false. This method also returns false if the CCG does not exist in this Network.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.MoveNetworkCCGTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->MoveNetworkCCGTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = network.MoveNetworkCCGTo(None, 0)
        ```

### ResetRouteSignalOffsetPriority() {#resetroutesignaloffsetpriority}

Reset the Offset Priority of all valid Routes for the program calculation of Signal Offsets.

```csharp
bool ResetRouteSignalOffsetPriority()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.ResetRouteSignalOffsetPriority();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->ResetRouteSignalOffsetPriority(&result);
        ```

    === "Python"

        ```python
        result = network.ResetRouteSignalOffsetPriority()
        ```

### CloneRoute(ISIAPIRoute) {#cloneroute-isiapiroute}

Clone a Route.

```csharp
ISIAPIRoute CloneRoute(ISIAPIRoute route)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `route` | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) | The Route to be cloned. |

**Returns** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) - The new cloned Route.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.CloneRoute(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> result;
        network->CloneRoute(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.CloneRoute(None)
        ```

### MoveRouteTo(ISIAPIRoute, int) {#moverouteto-isiapiroute--int}

Move a Route to a new position.

```csharp
bool MoveRouteTo(ISIAPIRoute route, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `route` | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) | The Route to move. |
| `newPosition` | `int` | The zero-based position that the Route should be moved to. |

**Returns** `bool` - true if the Route is successfully moved; otherwise, false. This method also returns false if the Route does not exist in this Network.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.MoveRouteTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->MoveRouteTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = network.MoveRouteTo(None, 0)
        ```

### CreateLayoutPngData() {#createlayoutpngdata}

```csharp
byte[] CreateLayoutPngData()
```

**Returns** `byte[]`

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.CreateLayoutPngData();
        ```

    === "C++"

        ```cpp
        VARIANT result;
        network->CreateLayoutPngData(&result);
        ```

    === "Python"

        ```python
        result = network.CreateLayoutPngData()
        ```

### CreateLayoutPngFile(string) {#createlayoutpngfile-string}

```csharp
bool CreateLayoutPngFile(string filename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `filename` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.CreateLayoutPngFile(@"C:\path\to\project.sipx");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->CreateLayoutPngFile(CComBSTR(L"C:\\path\\to\\project.sipx"), &result);
        ```

    === "Python"

        ```python
        result = network.CreateLayoutPngFile(r"C:\path\to\project.sipx")
        ```

### RemoveOutputData() {#removeoutputdata}

Remove this Network and its Routes Output data.

```csharp
bool RemoveOutputData()
```

**Returns** `bool` - true if the Output data are successfully removed

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveOutputData();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveOutputData(&result);
        ```

    === "Python"

        ```python
        result = network.RemoveOutputData()
        ```

### AddNetworkScenario() {#addnetworkscenario}

Add a new Network Scenario.

```csharp
ISIAPINetworkScenario AddNetworkScenario()
```

**Returns** [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) - The new added Network Scenario. Its Volume Type is 2 = Custom, the Site Scenarios defined in the ISIAPINetworkScenario.NetworkSiteScenarios collection are applied.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.AddNetworkScenario();
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenario> result;
        network->AddNetworkScenario(&result);
        ```

    === "Python"

        ```python
        result = network.AddNetworkScenario()
        ```

### RemoveNetworkScenario(ISIAPINetworkScenario) {#removenetworkscenario-isiapinetworkscenario}

Remove a Network Scenario from this Network.

```csharp
bool RemoveNetworkScenario(ISIAPINetworkScenario networkScenario)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkScenario` | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | The Network Scenario to remove. |

**Returns** `bool` - true if the Network Scenario is successfully removed; otherwise, false. This method also returns false if the Network Scenario does not exist in this Network.

**Remarks**

The first Network Local Scenario that links to the Sites' Local Scenarios cannot be removed.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.RemoveNetworkScenario(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->RemoveNetworkScenario(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.RemoveNetworkScenario(None)
        ```

### CloneNetworkScenario(ISIAPINetworkScenario) {#clonenetworkscenario-isiapinetworkscenario}

Clone a Network Scenario.

```csharp
ISIAPINetworkScenario CloneNetworkScenario(ISIAPINetworkScenario networkScenario)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkScenario` | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | The Network Scenario to be cloned. |

**Returns** [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) - The new cloned Network Scenario.

**Remarks**

The first Network Local Scenario that links to the Sites' Local Scenarios cannot be cloned.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = network.CloneNetworkScenario(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenario> result;
        network->CloneNetworkScenario(NULL, &result);
        ```

    === "Python"

        ```python
        result = network.CloneNetworkScenario(None)
        ```

### MoveNetworkScenarioTo(ISIAPINetworkScenario, int) {#movenetworkscenarioto-isiapinetworkscenario--int}

Move a Network Scenario to a new position in the collection.

```csharp
bool MoveNetworkScenarioTo(ISIAPINetworkScenario networkScenario, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkScenario` | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | The Network Scenario to move. |
| `newPosition` | `int` | The zero-based position that the Network Scenario should be moved to. The newPosition cannot be 0 because it is for the Network Local Scenario that links to the Site Local Scenarios. |

**Returns** `bool` - true if the Network Scenario is successfully moved; otherwise, false. This method also returns false if the Network Scenario does not exist in this Network.

**Remarks**

The first Network Local Scenario that links to the Sites' Local Scenarios cannot be moved. The other Scenarios cannot be moved to the first, i.e. Position 0.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = network.MoveNetworkScenarioTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        network->MoveNetworkScenarioTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = network.MoveNetworkScenarioTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccg.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCG
title: NetworkCCG
name: ISIAPINetworkCCG
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 19F00866-DA77-4C33-8A2C-B433B45AA65F
summary: Wrapper interface for a Common Control Group (CCG) in a particular Network
members:
  - bool AddNetworkSite(ISIAPINetworkSite networkSite)
  - bool RemoveNetworkSite(ISIAPINetworkSite networkSite)
  - ISIAPINetworkCCGSequence AddCCGSequence(string name)
  - bool RemoveCCGSequence(ISIAPINetworkCCGSequence ccgSequence)
  - ISIAPINetworkCCGSequence CloneCCGSequence(ISIAPINetworkCCGSequence ccgSequence)
  - bool MoveCCGSequenceTo(ISIAPINetworkCCGSequence ccgSequence, int newPosition)
  - string Name
  - string NetworkCCGID
  - int Position
  - bool IsReference
  - int Offset
  - int CoordinatedOption
  - int Signal_analysis_method
  - ISIAPINetwork Network
  - ISIAPINetworkSites NetworkSites
  - ISIAPINetworkCCGSequences CCGSequences
  - string LastErrorMessage
  - bool Is_multi_sequence_enabled
---

# NetworkCCG

Type `ISIAPINetworkCCG` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `19F00866-DA77-4C33-8A2C-B433B45AA65F`

Wrapper interface for a Common Control Group (CCG) in a particular Network

## Declaration

```csharp
[Guid("19F00866-DA77-4C33-8A2C-B433B45AA65F")]
public interface ISIAPINetworkCCG
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [NetworkCCGID](#networkccgid) | `string` | Network Common Control Group (CCG) ID for displaying in reports. |
| [Position](#position) | `int` | The Common Control Group (CCG) Position in the Network's CCGs collection. It is a zero-base integer. |
| [IsReference](#isreference) | `bool` |  |
| [Offset](#offset) | `int` |  |
| [CoordinatedOption](#coordinatedoption) | `int` | Coordinated Option |
| [Signal_analysis_method](#signal_analysis_method) | `int` | Signalised analysis method, applied to the Sites in this Common Control Group (CCG). |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [NetworkSites](#networksites) | [`ISIAPINetworkSites`](sidrasolutions.si.api.isiapinetworksites.md) |  |
| [CCGSequences](#ccgsequences) | [`ISIAPINetworkCCGSequences`](sidrasolutions.si.api.isiapinetworkccgsequences.md) |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [Is_multi_sequence_enabled](#is_multi_sequence_enabled) | `bool` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddNetworkSite(ISIAPINetworkSite)](#addnetworksite-isiapinetworksite) | `bool` | Add a Network Site into this Network CCG. |
| [RemoveNetworkSite(ISIAPINetworkSite)](#removenetworksite-isiapinetworksite) | `bool` | Remove a Network Site from this Network CCG. |
| [AddCCGSequence(string)](#addccgsequence-string) | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) | Add a Sequence. A new Sequence is created and added to this Network CCG. |
| [RemoveCCGSequence(ISIAPINetworkCCGSequence)](#removeccgsequence-isiapinetworkccgsequence) | `bool` | Remove a Sequence from this Network CCG. |
| [CloneCCGSequence(ISIAPINetworkCCGSequence)](#cloneccgsequence-isiapinetworkccgsequence) | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) | Clone a Sequence. |
| [MoveCCGSequenceTo(ISIAPINetworkCCGSequence, int)](#moveccgsequenceto-isiapinetworkccgsequence--int) | `bool` | Move a Sequence to a new position. |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = networkCCG.Name;
        networkCCG.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        networkCCG->get_Name(&name);
        networkCCG->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = networkCCG.Name
        networkCCG.Name = r"Example"
        ```

### NetworkCCGID {#networkccgid}

Network Common Control Group (CCG) ID for displaying in reports.

```csharp
string NetworkCCGID { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string networkCCGID = networkCCG.NetworkCCGID;
        networkCCG.NetworkCCGID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR networkCCGID;
        networkCCG->get_NetworkCCGID(&networkCCGID);
        networkCCG->put_NetworkCCGID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        network_ccgid = networkCCG.NetworkCCGID
        networkCCG.NetworkCCGID = r"id-1"
        ```

### Position {#position}

The Common Control Group (CCG) Position in the Network's CCGs collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = networkCCG.Position;
        ```

    === "C++"

        ```cpp
        long position;
        networkCCG->get_Position(&position);
        ```

    === "Python"

        ```python
        position = networkCCG.Position
        ```

### IsReference {#isreference}

```csharp
bool IsReference { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isReference = networkCCG.IsReference;
        networkCCG.IsReference = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isReference;
        networkCCG->get_IsReference(&isReference);
        networkCCG->put_IsReference(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_reference = networkCCG.IsReference
        networkCCG.IsReference = True
        ```

### Offset {#offset}

```csharp
int Offset { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int offset = networkCCG.Offset;
        networkCCG.Offset = 0;
        ```

    === "C++"

        ```cpp
        long offset;
        networkCCG->get_Offset(&offset);
        networkCCG->put_Offset(0);
        ```

    === "Python"

        ```python
        offset = networkCCG.Offset
        networkCCG.Offset = 0
        ```

### CoordinatedOption {#coordinatedoption}

Coordinated Option

```csharp
int CoordinatedOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - NA
- `1` - Yes
- `2` - No

???- example "Code samples"

    === "C#"

        ```csharp
        int coordinatedOption = networkCCG.CoordinatedOption;
        networkCCG.CoordinatedOption = 0;
        ```

    === "C++"

        ```cpp
        long coordinatedOption;
        networkCCG->get_CoordinatedOption(&coordinatedOption);
        networkCCG->put_CoordinatedOption(0);
        ```

    === "Python"

        ```python
        coordinated_option = networkCCG.CoordinatedOption
        networkCCG.CoordinatedOption = 0
        ```

### Signal_analysis_method {#signal_analysis_method}

Signalised analysis method, applied to the Sites in this Common Control Group (CCG).

```csharp
int Signal_analysis_method { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Fixed-Time/Pretimed
- `1` - Actuated

???- example "Code samples"

    === "C#"

        ```csharp
        int signal_analysis_method = networkCCG.Signal_analysis_method;
        networkCCG.Signal_analysis_method = 0;
        ```

    === "C++"

        ```cpp
        long signal_analysis_method;
        networkCCG->get_Signal_analysis_method(&signal_analysis_method);
        networkCCG->put_Signal_analysis_method(0);
        ```

    === "Python"

        ```python
        signal_analysis_method = networkCCG.Signal_analysis_method
        networkCCG.Signal_analysis_method = 0
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkCCG.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkCCG->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkCCG.Network
        ```

### NetworkSites {#networksites}

```csharp
ISIAPINetworkSites NetworkSites { get; }
```

**Type** [`ISIAPINetworkSites`](sidrasolutions.si.api.isiapinetworksites.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSites = networkCCG.NetworkSites;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSites> networkSites;
        networkCCG->get_NetworkSites(&networkSites);
        ```

    === "Python"

        ```python
        network_sites = networkCCG.NetworkSites
        ```

### CCGSequences {#ccgsequences}

```csharp
ISIAPINetworkCCGSequences CCGSequences { get; }
```

**Type** [`ISIAPINetworkCCGSequences`](sidrasolutions.si.api.isiapinetworkccgsequences.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var cCGSequences = networkCCG.CCGSequences;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequences> cCGSequences;
        networkCCG->get_CCGSequences(&cCGSequences);
        ```

    === "Python"

        ```python
        ccg_sequences = networkCCG.CCGSequences
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = networkCCG.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        networkCCG->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = networkCCG.LastErrorMessage
        ```

### Is_multi_sequence_enabled {#is_multi_sequence_enabled}

```csharp
bool Is_multi_sequence_enabled { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_multi_sequence_enabled = networkCCG.Is_multi_sequence_enabled;
        networkCCG.Is_multi_sequence_enabled = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_multi_sequence_enabled;
        networkCCG->get_Is_multi_sequence_enabled(&is_multi_sequence_enabled);
        networkCCG->put_Is_multi_sequence_enabled(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_multi_sequence_enabled = networkCCG.Is_multi_sequence_enabled
        networkCCG.Is_multi_sequence_enabled = True
        ```

## Methods

### AddNetworkSite(ISIAPINetworkSite) {#addnetworksite-isiapinetworksite}

Add a Network Site into this Network CCG.

```csharp
bool AddNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) | The Network Site to add. |

**Returns** `bool` - true if the Network Site is successfully added; otherwise, false.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCG.AddNetworkSite(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCG->AddNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCG.AddNetworkSite(None)
        ```

### RemoveNetworkSite(ISIAPINetworkSite) {#removenetworksite-isiapinetworksite}

Remove a Network Site from this Network CCG.

```csharp
bool RemoveNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) | The Network Site to remove. |

**Returns** `bool` - true if the Network Site is successfully removed; otherwise, false. This method also returns false if the Network Site does not exist in this Network CCG.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCG.RemoveNetworkSite(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCG->RemoveNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCG.RemoveNetworkSite(None)
        ```

### AddCCGSequence(string) {#addccgsequence-string}

Add a Sequence. A new Sequence is created and added to this Network CCG.

```csharp
ISIAPINetworkCCGSequence AddCCGSequence(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | The name of the new Sequence. |

**Returns** [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) - The new Sequence

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCG.AddCCGSequence(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequence> result;
        networkCCG->AddCCGSequence(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCG.AddCCGSequence(r"Example")
        ```

### RemoveCCGSequence(ISIAPINetworkCCGSequence) {#removeccgsequence-isiapinetworkccgsequence}

Remove a Sequence from this Network CCG.

```csharp
bool RemoveCCGSequence(ISIAPINetworkCCGSequence ccgSequence)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgSequence` | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) | The Sequence to remove. |

**Returns** `bool` - true if the Sequence is successfully removed; otherwise, false. This method also returns false if the Sequence does not exist in this Network CCG.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCG.RemoveCCGSequence(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCG->RemoveCCGSequence(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCG.RemoveCCGSequence(None)
        ```

### CloneCCGSequence(ISIAPINetworkCCGSequence) {#cloneccgsequence-isiapinetworkccgsequence}

Clone a Sequence.

```csharp
ISIAPINetworkCCGSequence CloneCCGSequence(ISIAPINetworkCCGSequence ccgSequence)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgSequence` | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) | The Sequence to be cloned. |

**Returns** [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) - The new cloned Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCG.CloneCCGSequence(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequence> result;
        networkCCG->CloneCCGSequence(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCG.CloneCCGSequence(None)
        ```

### MoveCCGSequenceTo(ISIAPINetworkCCGSequence, int) {#moveccgsequenceto-isiapinetworkccgsequence--int}

Move a Sequence to a new position.

```csharp
bool MoveCCGSequenceTo(ISIAPINetworkCCGSequence ccgSequence, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgSequence` | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) | The Sequence to move. |
| `newPosition` | `int` | The zero-based position that the Sequence should be moved to. |

**Returns** `bool` - true if the Sequence is successfully moved; otherwise, false. This method also returns false if the Sequence does not exist in this Network CCG.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCG.MoveCCGSequenceTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCG->MoveCCGSequenceTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = networkCCG.MoveCCGSequenceTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccgphase.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCGPhase
title: NetworkCCGPhase
name: ISIAPINetworkCCGPhase
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: CAC91D4A-8EF0-4329-8B51-2FDFF7E90EDB
members:
  - ISIAPIPhasemovement_vehicles GetPhasemovementVehiclesByNetworkSite(ISIAPINetworkSite networkSite)
  - ISIAPIPhasemovement_peds GetPhasemovementPedsByNetworkSite(ISIAPINetworkSite networkSite)
  - string Name
  - int Position
  - bool Is_variable
  - bool IsReferencePhase
  - float Phase_time
  - float Yellow_time
  - float All_red_time
  - bool Has_dummy
  - bool Dummy_minimum_green_time_user
  - float Dummy_minimum_green_time
  - bool Dummy_maximum_green_time_user
  - float Dummy_maximum_green_time
  - float Minimum_time
  - bool Phase_frequency_user
  - float Phase_frequency
  - ISIAPINetworkCCGSequence CCGSequence
---

# NetworkCCGPhase

Type `ISIAPINetworkCCGPhase` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `CAC91D4A-8EF0-4329-8B51-2FDFF7E90EDB`

## Declaration

```csharp
[Guid("CAC91D4A-8EF0-4329-8B51-2FDFF7E90EDB")]
public interface ISIAPINetworkCCGPhase
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [Position](#position) | `int` | The Phase Position in the Sequence's Phases collection. It is a zero-base integer. |
| [Is_variable](#is_variable) | `bool` |  |
| [IsReferencePhase](#isreferencephase) | `bool` |  |
| [Phase_time](#phase_time) | `float` |  |
| [Yellow_time](#yellow_time) | `float` |  |
| [All_red_time](#all_red_time) | `float` |  |
| [Has_dummy](#has_dummy) | `bool` |  |
| [Dummy_minimum_green_time_user](#dummy_minimum_green_time_user) | `bool` |  |
| [Dummy_minimum_green_time](#dummy_minimum_green_time) | `float` |  |
| [Dummy_maximum_green_time_user](#dummy_maximum_green_time_user) | `bool` |  |
| [Dummy_maximum_green_time](#dummy_maximum_green_time) | `float` |  |
| [Minimum_time](#minimum_time) | `float` |  |
| [Phase_frequency_user](#phase_frequency_user) | `bool` |  |
| [Phase_frequency](#phase_frequency) | `float` |  |
| [CCGSequence](#ccgsequence) | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [GetPhasemovementVehiclesByNetworkSite(ISIAPINetworkSite)](#getphasemovementvehiclesbynetworksite-isiapinetworksite) | [`ISIAPIPhasemovement_vehicles`](sidrasolutions.si.api.isiapiphasemovement_vehicles.md) |  |
| [GetPhasemovementPedsByNetworkSite(ISIAPINetworkSite)](#getphasemovementpedsbynetworksite-isiapinetworksite) | [`ISIAPIPhasemovement_peds`](sidrasolutions.si.api.isiapiphasemovement_peds.md) |  |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = networkCCGPhase.Name;
        networkCCGPhase.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        networkCCGPhase->get_Name(&name);
        networkCCGPhase->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = networkCCGPhase.Name
        networkCCGPhase.Name = r"Example"
        ```

### Position {#position}

The Phase Position in the Sequence's Phases collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = networkCCGPhase.Position;
        ```

    === "C++"

        ```cpp
        long position;
        networkCCGPhase->get_Position(&position);
        ```

    === "Python"

        ```python
        position = networkCCGPhase.Position
        ```

### Is_variable {#is_variable}

```csharp
bool Is_variable { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_variable = networkCCGPhase.Is_variable;
        networkCCGPhase.Is_variable = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_variable;
        networkCCGPhase->get_Is_variable(&is_variable);
        networkCCGPhase->put_Is_variable(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_variable = networkCCGPhase.Is_variable
        networkCCGPhase.Is_variable = True
        ```

### IsReferencePhase {#isreferencephase}

```csharp
bool IsReferencePhase { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isReferencePhase = networkCCGPhase.IsReferencePhase;
        networkCCGPhase.IsReferencePhase = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isReferencePhase;
        networkCCGPhase->get_IsReferencePhase(&isReferencePhase);
        networkCCGPhase->put_IsReferencePhase(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_reference_phase = networkCCGPhase.IsReferencePhase
        networkCCGPhase.IsReferencePhase = True
        ```

### Phase_time {#phase_time}

```csharp
float Phase_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_time = networkCCGPhase.Phase_time;
        networkCCGPhase.Phase_time = 0.0;
        ```

    === "C++"

        ```cpp
        double phase_time;
        networkCCGPhase->get_Phase_time(&phase_time);
        networkCCGPhase->put_Phase_time(0.0);
        ```

    === "Python"

        ```python
        phase_time = networkCCGPhase.Phase_time
        networkCCGPhase.Phase_time = 0.0
        ```

### Yellow_time {#yellow_time}

```csharp
float Yellow_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float yellow_time = networkCCGPhase.Yellow_time;
        networkCCGPhase.Yellow_time = 0.0;
        ```

    === "C++"

        ```cpp
        double yellow_time;
        networkCCGPhase->get_Yellow_time(&yellow_time);
        networkCCGPhase->put_Yellow_time(0.0);
        ```

    === "Python"

        ```python
        yellow_time = networkCCGPhase.Yellow_time
        networkCCGPhase.Yellow_time = 0.0
        ```

### All_red_time {#all_red_time}

```csharp
float All_red_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float all_red_time = networkCCGPhase.All_red_time;
        networkCCGPhase.All_red_time = 0.0;
        ```

    === "C++"

        ```cpp
        double all_red_time;
        networkCCGPhase->get_All_red_time(&all_red_time);
        networkCCGPhase->put_All_red_time(0.0);
        ```

    === "Python"

        ```python
        all_red_time = networkCCGPhase.All_red_time
        networkCCGPhase.All_red_time = 0.0
        ```

### Has_dummy {#has_dummy}

```csharp
bool Has_dummy { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_dummy = networkCCGPhase.Has_dummy;
        networkCCGPhase.Has_dummy = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_dummy;
        networkCCGPhase->get_Has_dummy(&has_dummy);
        networkCCGPhase->put_Has_dummy(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        has_dummy = networkCCGPhase.Has_dummy
        networkCCGPhase.Has_dummy = True
        ```

### Dummy_minimum_green_time_user {#dummy_minimum_green_time_user}

```csharp
bool Dummy_minimum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool dummy_minimum_green_time_user = networkCCGPhase.Dummy_minimum_green_time_user;
        networkCCGPhase.Dummy_minimum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL dummy_minimum_green_time_user;
        networkCCGPhase->get_Dummy_minimum_green_time_user(&dummy_minimum_green_time_user);
        networkCCGPhase->put_Dummy_minimum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        dummy_minimum_green_time_user = networkCCGPhase.Dummy_minimum_green_time_user
        networkCCGPhase.Dummy_minimum_green_time_user = True
        ```

### Dummy_minimum_green_time {#dummy_minimum_green_time}

```csharp
float Dummy_minimum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_minimum_green_time = networkCCGPhase.Dummy_minimum_green_time;
        networkCCGPhase.Dummy_minimum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double dummy_minimum_green_time;
        networkCCGPhase->get_Dummy_minimum_green_time(&dummy_minimum_green_time);
        networkCCGPhase->put_Dummy_minimum_green_time(0.0);
        ```

    === "Python"

        ```python
        dummy_minimum_green_time = networkCCGPhase.Dummy_minimum_green_time
        networkCCGPhase.Dummy_minimum_green_time = 0.0
        ```

### Dummy_maximum_green_time_user {#dummy_maximum_green_time_user}

```csharp
bool Dummy_maximum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool dummy_maximum_green_time_user = networkCCGPhase.Dummy_maximum_green_time_user;
        networkCCGPhase.Dummy_maximum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL dummy_maximum_green_time_user;
        networkCCGPhase->get_Dummy_maximum_green_time_user(&dummy_maximum_green_time_user);
        networkCCGPhase->put_Dummy_maximum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        dummy_maximum_green_time_user = networkCCGPhase.Dummy_maximum_green_time_user
        networkCCGPhase.Dummy_maximum_green_time_user = True
        ```

### Dummy_maximum_green_time {#dummy_maximum_green_time}

```csharp
float Dummy_maximum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_maximum_green_time = networkCCGPhase.Dummy_maximum_green_time;
        networkCCGPhase.Dummy_maximum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double dummy_maximum_green_time;
        networkCCGPhase->get_Dummy_maximum_green_time(&dummy_maximum_green_time);
        networkCCGPhase->put_Dummy_maximum_green_time(0.0);
        ```

    === "Python"

        ```python
        dummy_maximum_green_time = networkCCGPhase.Dummy_maximum_green_time
        networkCCGPhase.Dummy_maximum_green_time = 0.0
        ```

### Minimum_time {#minimum_time}

```csharp
float Minimum_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_time = networkCCGPhase.Minimum_time;
        networkCCGPhase.Minimum_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_time;
        networkCCGPhase->get_Minimum_time(&minimum_time);
        networkCCGPhase->put_Minimum_time(0.0);
        ```

    === "Python"

        ```python
        minimum_time = networkCCGPhase.Minimum_time
        networkCCGPhase.Minimum_time = 0.0
        ```

### Phase_frequency_user {#phase_frequency_user}

```csharp
bool Phase_frequency_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool phase_frequency_user = networkCCGPhase.Phase_frequency_user;
        networkCCGPhase.Phase_frequency_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL phase_frequency_user;
        networkCCGPhase->get_Phase_frequency_user(&phase_frequency_user);
        networkCCGPhase->put_Phase_frequency_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        phase_frequency_user = networkCCGPhase.Phase_frequency_user
        networkCCGPhase.Phase_frequency_user = True
        ```

### Phase_frequency {#phase_frequency}

```csharp
float Phase_frequency { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_frequency = networkCCGPhase.Phase_frequency;
        networkCCGPhase.Phase_frequency = 0.0;
        ```

    === "C++"

        ```cpp
        double phase_frequency;
        networkCCGPhase->get_Phase_frequency(&phase_frequency);
        networkCCGPhase->put_Phase_frequency(0.0);
        ```

    === "Python"

        ```python
        phase_frequency = networkCCGPhase.Phase_frequency
        networkCCGPhase.Phase_frequency = 0.0
        ```

### CCGSequence {#ccgsequence}

```csharp
ISIAPINetworkCCGSequence CCGSequence { get; }
```

**Type** [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var cCGSequence = networkCCGPhase.CCGSequence;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequence> cCGSequence;
        networkCCGPhase->get_CCGSequence(&cCGSequence);
        ```

    === "Python"

        ```python
        ccg_sequence = networkCCGPhase.CCGSequence
        ```

## Methods

### GetPhasemovementVehiclesByNetworkSite(ISIAPINetworkSite) {#getphasemovementvehiclesbynetworksite-isiapinetworksite}

```csharp
ISIAPIPhasemovement_vehicles GetPhasemovementVehiclesByNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |

**Returns** [`ISIAPIPhasemovement_vehicles`](sidrasolutions.si.api.isiapiphasemovement_vehicles.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCGPhase.GetPhasemovementVehiclesByNetworkSite(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_vehicles> result;
        networkCCGPhase->GetPhasemovementVehiclesByNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCGPhase.GetPhasemovementVehiclesByNetworkSite(None)
        ```

### GetPhasemovementPedsByNetworkSite(ISIAPINetworkSite) {#getphasemovementpedsbynetworksite-isiapinetworksite}

```csharp
ISIAPIPhasemovement_peds GetPhasemovementPedsByNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |

**Returns** [`ISIAPIPhasemovement_peds`](sidrasolutions.si.api.isiapiphasemovement_peds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCGPhase.GetPhasemovementPedsByNetworkSite(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_peds> result;
        networkCCGPhase->GetPhasemovementPedsByNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCGPhase.GetPhasemovementPedsByNetworkSite(None)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccgphases.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCGPhases
title: NetworkCCGPhases
name: ISIAPINetworkCCGPhases
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: AE75B0D9-D7CB-4A0B-9550-03C659B6EC7A
members:
  - bool PhaseExists(string phasename)
  - ISIAPINetworkCCGPhase this[string phasename]
  - ISIAPINetworkCCGPhase this[int index]
  - int Count
---

# NetworkCCGPhases

Type `ISIAPINetworkCCGPhases` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `AE75B0D9-D7CB-4A0B-9550-03C659B6EC7A`

## Declaration

```csharp
[Guid("AE75B0D9-D7CB-4A0B-9550-03C659B6EC7A")]
public interface ISIAPINetworkCCGPhases
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) |  |
| [this[]](#this) | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [PhaseExists(string)](#phaseexists-string) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkCCGPhases.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkCCGPhases->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkCCGPhases.Count
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCGPhase this[] { get; }
```

**Type** [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGPhases.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhase> this[];
        networkCCGPhases->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGPhases.this[]
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCGPhase this[] { get; }
```

**Type** [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGPhases.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhase> this[];
        networkCCGPhases->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGPhases.this[]
        ```

## Methods

### PhaseExists(string) {#phaseexists-string}

```csharp
bool PhaseExists(string phasename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `phasename` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCGPhases.PhaseExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCGPhases->PhaseExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCGPhases.PhaseExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccgs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCGs
title: NetworkCCGs
name: ISIAPINetworkCCGs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5C05363F-32D4-4D9D-9E06-1A7C0550447D
members:
  - bool NetworkCCGExists(string ccgName)
  - ISIAPINetworkCCG this[string ccgName]
  - ISIAPINetworkCCG this[int index]
  - int Count
---

# NetworkCCGs

Type `ISIAPINetworkCCGs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5C05363F-32D4-4D9D-9E06-1A7C0550447D`

## Declaration

```csharp
[Guid("5C05363F-32D4-4D9D-9E06-1A7C0550447D")]
public interface ISIAPINetworkCCGs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) |  |
| [this[]](#this) | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [NetworkCCGExists(string)](#networkccgexists-string) | `bool` | Queries whether a particular Network Common Control Group (CCG) exists in the collection |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkCCGs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkCCGs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkCCGs.Count
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCG this[] { get; }
```

**Type** [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCG> this[];
        networkCCGs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGs.this[]
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCG this[] { get; }
```

**Type** [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCG> this[];
        networkCCGs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGs.this[]
        ```

## Methods

### NetworkCCGExists(string) {#networkccgexists-string}

Queries whether a particular Network Common Control Group (CCG) exists in the collection

```csharp
bool NetworkCCGExists(string ccgName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgName` | `string` | CCG name to query |

**Returns** `bool` - True, if a Network CCG with the given CCG name exists in the collection. False otherwise

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCGs.NetworkCCGExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCGs->NetworkCCGExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCGs.NetworkCCGExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccgsequence.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCGSequence
title: NetworkCCGSequence
name: ISIAPINetworkCCGSequence
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BF82040F-AE5D-4968-8776-7EF476FF4940
members:
  - ISIAPINetworkCCGPhase AddCCGPhase(string name)
  - ISIAPINetworkCCGPhase InsertCCGPhase(int position, string name)
  - bool RemoveCCGPhase(ISIAPINetworkCCGPhase ccgPhase)
  - ISIAPINetworkCCGPhase CloneCCGPhase(ISIAPINetworkCCGPhase ccgPhase)
  - bool MoveCCGPhaseTo(ISIAPINetworkCCGPhase ccgPhase, int newPosition)
  - string Name
  - int Position
  - bool Is_selected
  - int Cycle_time_option
  - float Practical_max_cycle_time
  - bool Practical_cycle_rounding_applied
  - int Practical_cycle_rounding
  - bool Optimum_cycle_time_lower_user
  - int Optimum_cycle_time_lower
  - int Optimum_cycle_time_upper
  - int Optimum_cycle_time_increment
  - int Optimum_cycle_time_perf_measure
  - int Optimum_cycle_time_optim_method
  - int Optimum_max_green_percent_lower
  - int Optimum_max_green_percent_upper
  - int Optimum_max_green_percent_increment
  - int Optimum_max_green_perf_measure
  - int Optimum_max_green_optim_method
  - int Variable_phasing_perf_measure
  - float Usergiven_cycle_time
  - int Green_split_priority_option
  - float Actuated_max_green_major_mov
  - float Actuated_max_green_minor_mov
  - float Actuated_gap_major_mov
  - float Actuated_gap_minor_mov
  - float Eff_det_zone_len_major_mov
  - float Eff_det_zone_len_minor_mov
  - ISIAPINetworkCCG NetworkCCG
  - ISIAPINetworkCCGPhases CCGPhases
  - string LastErrorMessage
---

# NetworkCCGSequence

Type `ISIAPINetworkCCGSequence` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BF82040F-AE5D-4968-8776-7EF476FF4940`

## Declaration

```csharp
[Guid("BF82040F-AE5D-4968-8776-7EF476FF4940")]
public interface ISIAPINetworkCCGSequence
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [Position](#position) | `int` | The Sequence Position in the Netowrk CCG's Sequences collection. It is a zero-base integer. |
| [Is_selected](#is_selected) | `bool` |  |
| [Cycle_time_option](#cycle_time_option) | `int` | Cycle Time Option |
| [Practical_max_cycle_time](#practical_max_cycle_time) | `float` |  |
| [Practical_cycle_rounding_applied](#practical_cycle_rounding_applied) | `bool` |  |
| [Practical_cycle_rounding](#practical_cycle_rounding) | `int` |  |
| [Optimum_cycle_time_lower_user](#optimum_cycle_time_lower_user) | `bool` |  |
| [Optimum_cycle_time_lower](#optimum_cycle_time_lower) | `int` |  |
| [Optimum_cycle_time_upper](#optimum_cycle_time_upper) | `int` |  |
| [Optimum_cycle_time_increment](#optimum_cycle_time_increment) | `int` |  |
| [Optimum_cycle_time_perf_measure](#optimum_cycle_time_perf_measure) | `int` |  |
| [Optimum_cycle_time_optim_method](#optimum_cycle_time_optim_method) | `int` |  |
| [Optimum_max_green_percent_lower](#optimum_max_green_percent_lower) | `int` |  |
| [Optimum_max_green_percent_upper](#optimum_max_green_percent_upper) | `int` |  |
| [Optimum_max_green_percent_increment](#optimum_max_green_percent_increment) | `int` |  |
| [Optimum_max_green_perf_measure](#optimum_max_green_perf_measure) | `int` |  |
| [Optimum_max_green_optim_method](#optimum_max_green_optim_method) | `int` |  |
| [Variable_phasing_perf_measure](#variable_phasing_perf_measure) | `int` |  |
| [Usergiven_cycle_time](#usergiven_cycle_time) | `float` |  |
| [Green_split_priority_option](#green_split_priority_option) | `int` |  |
| [Actuated_max_green_major_mov](#actuated_max_green_major_mov) | `float` |  |
| [Actuated_max_green_minor_mov](#actuated_max_green_minor_mov) | `float` |  |
| [Actuated_gap_major_mov](#actuated_gap_major_mov) | `float` |  |
| [Actuated_gap_minor_mov](#actuated_gap_minor_mov) | `float` |  |
| [Eff_det_zone_len_major_mov](#eff_det_zone_len_major_mov) | `float` |  |
| [Eff_det_zone_len_minor_mov](#eff_det_zone_len_minor_mov) | `float` |  |
| [NetworkCCG](#networkccg) | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) |  |
| [CCGPhases](#ccgphases) | [`ISIAPINetworkCCGPhases`](sidrasolutions.si.api.isiapinetworkccgphases.md) |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddCCGPhase(string)](#addccgphase-string) | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | Add a new Phase to the end of this Sequence. |
| [InsertCCGPhase(int, string)](#insertccgphase-int--string) | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | Insert a new Phase into this Sequence at the specified position. |
| [RemoveCCGPhase(ISIAPINetworkCCGPhase)](#removeccgphase-isiapinetworkccgphase) | `bool` | Remove a Phase from this Sequence. |
| [CloneCCGPhase(ISIAPINetworkCCGPhase)](#cloneccgphase-isiapinetworkccgphase) | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | Clone a Phase. |
| [MoveCCGPhaseTo(ISIAPINetworkCCGPhase, int)](#moveccgphaseto-isiapinetworkccgphase--int) | `bool` | Move a Phase to a new position. |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = networkCCGSequence.Name;
        networkCCGSequence.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        networkCCGSequence->get_Name(&name);
        networkCCGSequence->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = networkCCGSequence.Name
        networkCCGSequence.Name = r"Example"
        ```

### Position {#position}

The Sequence Position in the Netowrk CCG's Sequences collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = networkCCGSequence.Position;
        ```

    === "C++"

        ```cpp
        long position;
        networkCCGSequence->get_Position(&position);
        ```

    === "Python"

        ```python
        position = networkCCGSequence.Position
        ```

### Is_selected {#is_selected}

```csharp
bool Is_selected { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_selected = networkCCGSequence.Is_selected;
        networkCCGSequence.Is_selected = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_selected;
        networkCCGSequence->get_Is_selected(&is_selected);
        networkCCGSequence->put_Is_selected(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_selected = networkCCGSequence.Is_selected
        networkCCGSequence.Is_selected = True
        ```

### Cycle_time_option {#cycle_time_option}

Cycle Time Option

```csharp
int Cycle_time_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Cycle Time
- `1` - Optimum Cycle Time
- `2` - User-Given Cycle Time
- `3` - User-Given Phase Time
- `4` - Optimum Maximum Green Settings

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option = networkCCGSequence.Cycle_time_option;
        networkCCGSequence.Cycle_time_option = 0;
        ```

    === "C++"

        ```cpp
        long cycle_time_option;
        networkCCGSequence->get_Cycle_time_option(&cycle_time_option);
        networkCCGSequence->put_Cycle_time_option(0);
        ```

    === "Python"

        ```python
        cycle_time_option = networkCCGSequence.Cycle_time_option
        networkCCGSequence.Cycle_time_option = 0
        ```

### Practical_max_cycle_time {#practical_max_cycle_time}

```csharp
float Practical_max_cycle_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_max_cycle_time = networkCCGSequence.Practical_max_cycle_time;
        networkCCGSequence.Practical_max_cycle_time = 0.0;
        ```

    === "C++"

        ```cpp
        double practical_max_cycle_time;
        networkCCGSequence->get_Practical_max_cycle_time(&practical_max_cycle_time);
        networkCCGSequence->put_Practical_max_cycle_time(0.0);
        ```

    === "Python"

        ```python
        practical_max_cycle_time = networkCCGSequence.Practical_max_cycle_time
        networkCCGSequence.Practical_max_cycle_time = 0.0
        ```

### Practical_cycle_rounding_applied {#practical_cycle_rounding_applied}

```csharp
bool Practical_cycle_rounding_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_cycle_rounding_applied = networkCCGSequence.Practical_cycle_rounding_applied;
        networkCCGSequence.Practical_cycle_rounding_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_cycle_rounding_applied;
        networkCCGSequence->get_Practical_cycle_rounding_applied(&practical_cycle_rounding_applied);
        networkCCGSequence->put_Practical_cycle_rounding_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        practical_cycle_rounding_applied = networkCCGSequence.Practical_cycle_rounding_applied
        networkCCGSequence.Practical_cycle_rounding_applied = True
        ```

### Practical_cycle_rounding {#practical_cycle_rounding}

```csharp
int Practical_cycle_rounding { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int practical_cycle_rounding = networkCCGSequence.Practical_cycle_rounding;
        networkCCGSequence.Practical_cycle_rounding = 0;
        ```

    === "C++"

        ```cpp
        long practical_cycle_rounding;
        networkCCGSequence->get_Practical_cycle_rounding(&practical_cycle_rounding);
        networkCCGSequence->put_Practical_cycle_rounding(0);
        ```

    === "Python"

        ```python
        practical_cycle_rounding = networkCCGSequence.Practical_cycle_rounding
        networkCCGSequence.Practical_cycle_rounding = 0
        ```

### Optimum_cycle_time_lower_user {#optimum_cycle_time_lower_user}

```csharp
bool Optimum_cycle_time_lower_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool optimum_cycle_time_lower_user = networkCCGSequence.Optimum_cycle_time_lower_user;
        networkCCGSequence.Optimum_cycle_time_lower_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL optimum_cycle_time_lower_user;
        networkCCGSequence->get_Optimum_cycle_time_lower_user(&optimum_cycle_time_lower_user);
        networkCCGSequence->put_Optimum_cycle_time_lower_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower_user = networkCCGSequence.Optimum_cycle_time_lower_user
        networkCCGSequence.Optimum_cycle_time_lower_user = True
        ```

### Optimum_cycle_time_lower {#optimum_cycle_time_lower}

```csharp
int Optimum_cycle_time_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_lower = networkCCGSequence.Optimum_cycle_time_lower;
        networkCCGSequence.Optimum_cycle_time_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_lower;
        networkCCGSequence->get_Optimum_cycle_time_lower(&optimum_cycle_time_lower);
        networkCCGSequence->put_Optimum_cycle_time_lower(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower = networkCCGSequence.Optimum_cycle_time_lower
        networkCCGSequence.Optimum_cycle_time_lower = 0
        ```

### Optimum_cycle_time_upper {#optimum_cycle_time_upper}

```csharp
int Optimum_cycle_time_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_upper = networkCCGSequence.Optimum_cycle_time_upper;
        networkCCGSequence.Optimum_cycle_time_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_upper;
        networkCCGSequence->get_Optimum_cycle_time_upper(&optimum_cycle_time_upper);
        networkCCGSequence->put_Optimum_cycle_time_upper(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_upper = networkCCGSequence.Optimum_cycle_time_upper
        networkCCGSequence.Optimum_cycle_time_upper = 0
        ```

### Optimum_cycle_time_increment {#optimum_cycle_time_increment}

```csharp
int Optimum_cycle_time_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_increment = networkCCGSequence.Optimum_cycle_time_increment;
        networkCCGSequence.Optimum_cycle_time_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_increment;
        networkCCGSequence->get_Optimum_cycle_time_increment(&optimum_cycle_time_increment);
        networkCCGSequence->put_Optimum_cycle_time_increment(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_increment = networkCCGSequence.Optimum_cycle_time_increment
        networkCCGSequence.Optimum_cycle_time_increment = 0
        ```

### Optimum_cycle_time_perf_measure {#optimum_cycle_time_perf_measure}

```csharp
int Optimum_cycle_time_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_perf_measure = networkCCGSequence.Optimum_cycle_time_perf_measure;
        networkCCGSequence.Optimum_cycle_time_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_perf_measure;
        networkCCGSequence->get_Optimum_cycle_time_perf_measure(&optimum_cycle_time_perf_measure);
        networkCCGSequence->put_Optimum_cycle_time_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_perf_measure = networkCCGSequence.Optimum_cycle_time_perf_measure
        networkCCGSequence.Optimum_cycle_time_perf_measure = 0
        ```

### Optimum_cycle_time_optim_method {#optimum_cycle_time_optim_method}

```csharp
int Optimum_cycle_time_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_optim_method = networkCCGSequence.Optimum_cycle_time_optim_method;
        networkCCGSequence.Optimum_cycle_time_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_optim_method;
        networkCCGSequence->get_Optimum_cycle_time_optim_method(&optimum_cycle_time_optim_method);
        networkCCGSequence->put_Optimum_cycle_time_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_optim_method = networkCCGSequence.Optimum_cycle_time_optim_method
        networkCCGSequence.Optimum_cycle_time_optim_method = 0
        ```

### Optimum_max_green_percent_lower {#optimum_max_green_percent_lower}

```csharp
int Optimum_max_green_percent_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_lower = networkCCGSequence.Optimum_max_green_percent_lower;
        networkCCGSequence.Optimum_max_green_percent_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_lower;
        networkCCGSequence->get_Optimum_max_green_percent_lower(&optimum_max_green_percent_lower);
        networkCCGSequence->put_Optimum_max_green_percent_lower(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_lower = networkCCGSequence.Optimum_max_green_percent_lower
        networkCCGSequence.Optimum_max_green_percent_lower = 0
        ```

### Optimum_max_green_percent_upper {#optimum_max_green_percent_upper}

```csharp
int Optimum_max_green_percent_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_upper = networkCCGSequence.Optimum_max_green_percent_upper;
        networkCCGSequence.Optimum_max_green_percent_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_upper;
        networkCCGSequence->get_Optimum_max_green_percent_upper(&optimum_max_green_percent_upper);
        networkCCGSequence->put_Optimum_max_green_percent_upper(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_upper = networkCCGSequence.Optimum_max_green_percent_upper
        networkCCGSequence.Optimum_max_green_percent_upper = 0
        ```

### Optimum_max_green_percent_increment {#optimum_max_green_percent_increment}

```csharp
int Optimum_max_green_percent_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_increment = networkCCGSequence.Optimum_max_green_percent_increment;
        networkCCGSequence.Optimum_max_green_percent_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_increment;
        networkCCGSequence->get_Optimum_max_green_percent_increment(&optimum_max_green_percent_increment);
        networkCCGSequence->put_Optimum_max_green_percent_increment(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_increment = networkCCGSequence.Optimum_max_green_percent_increment
        networkCCGSequence.Optimum_max_green_percent_increment = 0
        ```

### Optimum_max_green_perf_measure {#optimum_max_green_perf_measure}

```csharp
int Optimum_max_green_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_perf_measure = networkCCGSequence.Optimum_max_green_perf_measure;
        networkCCGSequence.Optimum_max_green_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_perf_measure;
        networkCCGSequence->get_Optimum_max_green_perf_measure(&optimum_max_green_perf_measure);
        networkCCGSequence->put_Optimum_max_green_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_max_green_perf_measure = networkCCGSequence.Optimum_max_green_perf_measure
        networkCCGSequence.Optimum_max_green_perf_measure = 0
        ```

### Optimum_max_green_optim_method {#optimum_max_green_optim_method}

```csharp
int Optimum_max_green_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_optim_method = networkCCGSequence.Optimum_max_green_optim_method;
        networkCCGSequence.Optimum_max_green_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_optim_method;
        networkCCGSequence->get_Optimum_max_green_optim_method(&optimum_max_green_optim_method);
        networkCCGSequence->put_Optimum_max_green_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_max_green_optim_method = networkCCGSequence.Optimum_max_green_optim_method
        networkCCGSequence.Optimum_max_green_optim_method = 0
        ```

### Variable_phasing_perf_measure {#variable_phasing_perf_measure}

```csharp
int Variable_phasing_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int variable_phasing_perf_measure = networkCCGSequence.Variable_phasing_perf_measure;
        networkCCGSequence.Variable_phasing_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long variable_phasing_perf_measure;
        networkCCGSequence->get_Variable_phasing_perf_measure(&variable_phasing_perf_measure);
        networkCCGSequence->put_Variable_phasing_perf_measure(0);
        ```

    === "Python"

        ```python
        variable_phasing_perf_measure = networkCCGSequence.Variable_phasing_perf_measure
        networkCCGSequence.Variable_phasing_perf_measure = 0
        ```

### Usergiven_cycle_time {#usergiven_cycle_time}

```csharp
float Usergiven_cycle_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float usergiven_cycle_time = networkCCGSequence.Usergiven_cycle_time;
        networkCCGSequence.Usergiven_cycle_time = 0.0;
        ```

    === "C++"

        ```cpp
        double usergiven_cycle_time;
        networkCCGSequence->get_Usergiven_cycle_time(&usergiven_cycle_time);
        networkCCGSequence->put_Usergiven_cycle_time(0.0);
        ```

    === "Python"

        ```python
        usergiven_cycle_time = networkCCGSequence.Usergiven_cycle_time
        networkCCGSequence.Usergiven_cycle_time = 0.0
        ```

### Green_split_priority_option {#green_split_priority_option}

```csharp
int Green_split_priority_option { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int green_split_priority_option = networkCCGSequence.Green_split_priority_option;
        networkCCGSequence.Green_split_priority_option = 0;
        ```

    === "C++"

        ```cpp
        long green_split_priority_option;
        networkCCGSequence->get_Green_split_priority_option(&green_split_priority_option);
        networkCCGSequence->put_Green_split_priority_option(0);
        ```

    === "Python"

        ```python
        green_split_priority_option = networkCCGSequence.Green_split_priority_option
        networkCCGSequence.Green_split_priority_option = 0
        ```

### Actuated_max_green_major_mov {#actuated_max_green_major_mov}

```csharp
float Actuated_max_green_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_max_green_major_mov = networkCCGSequence.Actuated_max_green_major_mov;
        networkCCGSequence.Actuated_max_green_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_max_green_major_mov;
        networkCCGSequence->get_Actuated_max_green_major_mov(&actuated_max_green_major_mov);
        networkCCGSequence->put_Actuated_max_green_major_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_max_green_major_mov = networkCCGSequence.Actuated_max_green_major_mov
        networkCCGSequence.Actuated_max_green_major_mov = 0.0
        ```

### Actuated_max_green_minor_mov {#actuated_max_green_minor_mov}

```csharp
float Actuated_max_green_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_max_green_minor_mov = networkCCGSequence.Actuated_max_green_minor_mov;
        networkCCGSequence.Actuated_max_green_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_max_green_minor_mov;
        networkCCGSequence->get_Actuated_max_green_minor_mov(&actuated_max_green_minor_mov);
        networkCCGSequence->put_Actuated_max_green_minor_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_max_green_minor_mov = networkCCGSequence.Actuated_max_green_minor_mov
        networkCCGSequence.Actuated_max_green_minor_mov = 0.0
        ```

### Actuated_gap_major_mov {#actuated_gap_major_mov}

```csharp
float Actuated_gap_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_gap_major_mov = networkCCGSequence.Actuated_gap_major_mov;
        networkCCGSequence.Actuated_gap_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_gap_major_mov;
        networkCCGSequence->get_Actuated_gap_major_mov(&actuated_gap_major_mov);
        networkCCGSequence->put_Actuated_gap_major_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_gap_major_mov = networkCCGSequence.Actuated_gap_major_mov
        networkCCGSequence.Actuated_gap_major_mov = 0.0
        ```

### Actuated_gap_minor_mov {#actuated_gap_minor_mov}

```csharp
float Actuated_gap_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_gap_minor_mov = networkCCGSequence.Actuated_gap_minor_mov;
        networkCCGSequence.Actuated_gap_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_gap_minor_mov;
        networkCCGSequence->get_Actuated_gap_minor_mov(&actuated_gap_minor_mov);
        networkCCGSequence->put_Actuated_gap_minor_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_gap_minor_mov = networkCCGSequence.Actuated_gap_minor_mov
        networkCCGSequence.Actuated_gap_minor_mov = 0.0
        ```

### Eff_det_zone_len_major_mov {#eff_det_zone_len_major_mov}

```csharp
float Eff_det_zone_len_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_det_zone_len_major_mov = networkCCGSequence.Eff_det_zone_len_major_mov;
        networkCCGSequence.Eff_det_zone_len_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double eff_det_zone_len_major_mov;
        networkCCGSequence->get_Eff_det_zone_len_major_mov(&eff_det_zone_len_major_mov);
        networkCCGSequence->put_Eff_det_zone_len_major_mov(0.0);
        ```

    === "Python"

        ```python
        eff_det_zone_len_major_mov = networkCCGSequence.Eff_det_zone_len_major_mov
        networkCCGSequence.Eff_det_zone_len_major_mov = 0.0
        ```

### Eff_det_zone_len_minor_mov {#eff_det_zone_len_minor_mov}

```csharp
float Eff_det_zone_len_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_det_zone_len_minor_mov = networkCCGSequence.Eff_det_zone_len_minor_mov;
        networkCCGSequence.Eff_det_zone_len_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double eff_det_zone_len_minor_mov;
        networkCCGSequence->get_Eff_det_zone_len_minor_mov(&eff_det_zone_len_minor_mov);
        networkCCGSequence->put_Eff_det_zone_len_minor_mov(0.0);
        ```

    === "Python"

        ```python
        eff_det_zone_len_minor_mov = networkCCGSequence.Eff_det_zone_len_minor_mov
        networkCCGSequence.Eff_det_zone_len_minor_mov = 0.0
        ```

### NetworkCCG {#networkccg}

```csharp
ISIAPINetworkCCG NetworkCCG { get; }
```

**Type** [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkCCG = networkCCGSequence.NetworkCCG;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCG> networkCCG;
        networkCCGSequence->get_NetworkCCG(&networkCCG);
        ```

    === "Python"

        ```python
        network_ccg = networkCCGSequence.NetworkCCG
        ```

### CCGPhases {#ccgphases}

```csharp
ISIAPINetworkCCGPhases CCGPhases { get; }
```

**Type** [`ISIAPINetworkCCGPhases`](sidrasolutions.si.api.isiapinetworkccgphases.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var cCGPhases = networkCCGSequence.CCGPhases;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhases> cCGPhases;
        networkCCGSequence->get_CCGPhases(&cCGPhases);
        ```

    === "Python"

        ```python
        ccg_phases = networkCCGSequence.CCGPhases
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = networkCCGSequence.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        networkCCGSequence->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = networkCCGSequence.LastErrorMessage
        ```

## Methods

### AddCCGPhase(string) {#addccgphase-string}

Add a new Phase to the end of this Sequence.

```csharp
ISIAPINetworkCCGPhase AddCCGPhase(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | The name of the new Phase. |

**Returns** [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) - The new added Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCGSequence.AddCCGPhase(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhase> result;
        networkCCGSequence->AddCCGPhase(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequence.AddCCGPhase(r"Example")
        ```

### InsertCCGPhase(int, string) {#insertccgphase-int--string}

Insert a new Phase into this Sequence at the specified position.

```csharp
ISIAPINetworkCCGPhase InsertCCGPhase(int position, string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `position` | `int` | The zero-based position at which the new Phase should be inserted. |
| `name` | `string` | The name of the new Phase. |

**Returns** [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) - The new added Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCGSequence.InsertCCGPhase(0, @"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhase> result;
        networkCCGSequence->InsertCCGPhase(0, CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequence.InsertCCGPhase(0, r"Example")
        ```

### RemoveCCGPhase(ISIAPINetworkCCGPhase) {#removeccgphase-isiapinetworkccgphase}

Remove a Phase from this Sequence.

```csharp
bool RemoveCCGPhase(ISIAPINetworkCCGPhase ccgPhase)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgPhase` | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | The Phase to remove. |

**Returns** `bool` - true if the Phase is successfully removed; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCGSequence.RemoveCCGPhase(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCGSequence->RemoveCCGPhase(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequence.RemoveCCGPhase(None)
        ```

### CloneCCGPhase(ISIAPINetworkCCGPhase) {#cloneccgphase-isiapinetworkccgphase}

Clone a Phase.

```csharp
ISIAPINetworkCCGPhase CloneCCGPhase(ISIAPINetworkCCGPhase ccgPhase)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgPhase` | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | The Phase to clone. |

**Returns** [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) - The new cloned Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkCCGSequence.CloneCCGPhase(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGPhase> result;
        networkCCGSequence->CloneCCGPhase(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequence.CloneCCGPhase(None)
        ```

### MoveCCGPhaseTo(ISIAPINetworkCCGPhase, int) {#moveccgphaseto-isiapinetworkccgphase--int}

Move a Phase to a new position.

```csharp
bool MoveCCGPhaseTo(ISIAPINetworkCCGPhase ccgPhase, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `ccgPhase` | [`ISIAPINetworkCCGPhase`](sidrasolutions.si.api.isiapinetworkccgphase.md) | The Phase to move. |
| `newPosition` | `int` | The zero-based position that the Phase should be moved to. |

**Returns** `bool` - true if the Phase is successfully moved; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCGSequence.MoveCCGPhaseTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCGSequence->MoveCCGPhaseTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequence.MoveCCGPhaseTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkccgsequences.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkCCGSequences
title: NetworkCCGSequences
name: ISIAPINetworkCCGSequences
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5B04C297-4D76-4CD4-B6EC-94F5CFA1DA78
members:
  - bool SequenceExists(string name)
  - ISIAPINetworkCCGSequence this[string name]
  - ISIAPINetworkCCGSequence this[int index]
  - int Count
---

# NetworkCCGSequences

Type `ISIAPINetworkCCGSequences` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5B04C297-4D76-4CD4-B6EC-94F5CFA1DA78`

## Declaration

```csharp
[Guid("5B04C297-4D76-4CD4-B6EC-94F5CFA1DA78")]
public interface ISIAPINetworkCCGSequences
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) |  |
| [this[]](#this) | [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SequenceExists(string)](#sequenceexists-string) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkCCGSequences.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkCCGSequences->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkCCGSequences.Count
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCGSequence this[] { get; }
```

**Type** [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGSequences.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequence> this[];
        networkCCGSequences->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGSequences.this[]
        ```

### this[] {#this}

```csharp
ISIAPINetworkCCGSequence this[] { get; }
```

**Type** [`ISIAPINetworkCCGSequence`](sidrasolutions.si.api.isiapinetworkccgsequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkCCGSequences.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCGSequence> this[];
        networkCCGSequences->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkCCGSequences.this[]
        ```

## Methods

### SequenceExists(string) {#sequenceexists-string}

```csharp
bool SequenceExists(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkCCGSequences.SequenceExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkCCGSequences->SequenceExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkCCGSequences.SequenceExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkdemandsensitivity.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkDemandSensitivity
title: NetworkDemandSensitivity
name: ISIAPINetworkDemandSensitivity
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4105474F-FC8D-468B-BBE0-1F6ED986505B
members:
  - ISIAPINetwork Network
  - int Analysis_option
  - int Design_Life_Objective
  - int Design_Life_Growth_Model
  - int Design_Life_Years
  - bool Design_Life_Is_constant_num_years_applied
  - int Design_Life_Constant_num_years
  - int Flow_Scale_Objective
  - float Flow_Scale_Lower
  - float Flow_Scale_Upper
  - bool Flow_Scale_Is_constant_factor_applied
  - float Flow_Scale_Constant_factor
  - ISIAPISensitivity SensitivityGeneralParameterGroup
  - int Result_option
---

# NetworkDemandSensitivity

Type `ISIAPINetworkDemandSensitivity` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4105474F-FC8D-468B-BBE0-1F6ED986505B`

## Declaration

```csharp
[Guid("4105474F-FC8D-468B-BBE0-1F6ED986505B")]
public interface ISIAPINetworkDemandSensitivity
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [Analysis_option](#analysis_option) | `int` | Analysis Option |
| [Design_Life_Objective](#design_life_objective) | `int` | Design Life Analysis Objective |
| [Design_Life_Growth_Model](#design_life_growth_model) | `int` | Design Life Analysis Growth Model |
| [Design_Life_Years](#design_life_years) | `int` |  |
| [Design_Life_Is_constant_num_years_applied](#design_life_is_constant_num_years_applied) | `bool` |  |
| [Design_Life_Constant_num_years](#design_life_constant_num_years) | `int` |  |
| [Flow_Scale_Objective](#flow_scale_objective) | `int` | Flow Scale Analysis Objective |
| [Flow_Scale_Lower](#flow_scale_lower) | `float` |  |
| [Flow_Scale_Upper](#flow_scale_upper) | `float` |  |
| [Flow_Scale_Is_constant_factor_applied](#flow_scale_is_constant_factor_applied) | `bool` |  |
| [Flow_Scale_Constant_factor](#flow_scale_constant_factor) | `float` |  |
| [SensitivityGeneralParameterGroup](#sensitivitygeneralparametergroup) | [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md) |  |
| [Result_option](#result_option) | `int` | Results For |

</div>

## Properties

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkDemandSensitivity.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkDemandSensitivity->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkDemandSensitivity.Network
        ```

### Analysis_option {#analysis_option}

Analysis Option

```csharp
int Analysis_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Sensitivity
- `2` - Design Life
- `3` - Flow Scale

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_option = networkDemandSensitivity.Analysis_option;
        networkDemandSensitivity.Analysis_option = 0;
        ```

    === "C++"

        ```cpp
        long analysis_option;
        networkDemandSensitivity->get_Analysis_option(&analysis_option);
        networkDemandSensitivity->put_Analysis_option(0);
        ```

    === "Python"

        ```python
        analysis_option = networkDemandSensitivity.Analysis_option
        networkDemandSensitivity.Analysis_option = 0
        ```

### Design_Life_Objective {#design_life_objective}

Design Life Analysis Objective

```csharp
int Design_Life_Objective { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Capacity (v/c ratio = xp)
- `1` - Capacity (v/c ratio = 1)
- `4` - Final Year
- `5` - Network Level of Service Target

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Objective = networkDemandSensitivity.Design_Life_Objective;
        networkDemandSensitivity.Design_Life_Objective = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Objective;
        networkDemandSensitivity->get_Design_Life_Objective(&design_Life_Objective);
        networkDemandSensitivity->put_Design_Life_Objective(0);
        ```

    === "Python"

        ```python
        design__life__objective = networkDemandSensitivity.Design_Life_Objective
        networkDemandSensitivity.Design_Life_Objective = 0
        ```

### Design_Life_Growth_Model {#design_life_growth_model}

Design Life Analysis Growth Model

```csharp
int Design_Life_Growth_Model { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Uniform
- `1` - Compound

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Growth_Model = networkDemandSensitivity.Design_Life_Growth_Model;
        networkDemandSensitivity.Design_Life_Growth_Model = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Growth_Model;
        networkDemandSensitivity->get_Design_Life_Growth_Model(&design_Life_Growth_Model);
        networkDemandSensitivity->put_Design_Life_Growth_Model(0);
        ```

    === "Python"

        ```python
        design__life__growth__model = networkDemandSensitivity.Design_Life_Growth_Model
        networkDemandSensitivity.Design_Life_Growth_Model = 0
        ```

### Design_Life_Years {#design_life_years}

```csharp
int Design_Life_Years { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Years = networkDemandSensitivity.Design_Life_Years;
        networkDemandSensitivity.Design_Life_Years = 0;
        ```

    === "C++"

        ```cpp
        long design_Life_Years;
        networkDemandSensitivity->get_Design_Life_Years(&design_Life_Years);
        networkDemandSensitivity->put_Design_Life_Years(0);
        ```

    === "Python"

        ```python
        design__life__years = networkDemandSensitivity.Design_Life_Years
        networkDemandSensitivity.Design_Life_Years = 0
        ```

### Design_Life_Is_constant_num_years_applied {#design_life_is_constant_num_years_applied}

```csharp
bool Design_Life_Is_constant_num_years_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool design_Life_Is_constant_num_years_applied = networkDemandSensitivity.Design_Life_Is_constant_num_years_applied;
        networkDemandSensitivity.Design_Life_Is_constant_num_years_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL design_Life_Is_constant_num_years_applied;
        networkDemandSensitivity->get_Design_Life_Is_constant_num_years_applied(&design_Life_Is_constant_num_years_applied);
        networkDemandSensitivity->put_Design_Life_Is_constant_num_years_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        design__life__is_constant_num_years_applied = networkDemandSensitivity.Design_Life_Is_constant_num_years_applied
        networkDemandSensitivity.Design_Life_Is_constant_num_years_applied = True
        ```

### Design_Life_Constant_num_years {#design_life_constant_num_years}

```csharp
int Design_Life_Constant_num_years { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Constant_num_years = networkDemandSensitivity.Design_Life_Constant_num_years;
        networkDemandSensitivity.Design_Life_Constant_num_years = 1;
        ```

    === "C++"

        ```cpp
        long design_Life_Constant_num_years;
        networkDemandSensitivity->get_Design_Life_Constant_num_years(&design_Life_Constant_num_years);
        networkDemandSensitivity->put_Design_Life_Constant_num_years(1);
        ```

    === "Python"

        ```python
        design__life__constant_num_years = networkDemandSensitivity.Design_Life_Constant_num_years
        networkDemandSensitivity.Design_Life_Constant_num_years = 1
        ```

### Flow_Scale_Objective {#flow_scale_objective}

Flow Scale Analysis Objective

```csharp
int Flow_Scale_Objective { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Capacity (v/c ratio = xp)
- `1` - Capacity (v/c ratio = 1)
- `4` - Final Year
- `5` - Network Level of Service Target

???- example "Code samples"

    === "C#"

        ```csharp
        int flow_Scale_Objective = networkDemandSensitivity.Flow_Scale_Objective;
        networkDemandSensitivity.Flow_Scale_Objective = 0;
        ```

    === "C++"

        ```cpp
        long flow_Scale_Objective;
        networkDemandSensitivity->get_Flow_Scale_Objective(&flow_Scale_Objective);
        networkDemandSensitivity->put_Flow_Scale_Objective(0);
        ```

    === "Python"

        ```python
        flow__scale__objective = networkDemandSensitivity.Flow_Scale_Objective
        networkDemandSensitivity.Flow_Scale_Objective = 0
        ```

### Flow_Scale_Lower {#flow_scale_lower}

```csharp
float Flow_Scale_Lower { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Lower = networkDemandSensitivity.Flow_Scale_Lower;
        networkDemandSensitivity.Flow_Scale_Lower = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Lower;
        networkDemandSensitivity->get_Flow_Scale_Lower(&flow_Scale_Lower);
        networkDemandSensitivity->put_Flow_Scale_Lower(0.0);
        ```

    === "Python"

        ```python
        flow__scale__lower = networkDemandSensitivity.Flow_Scale_Lower
        networkDemandSensitivity.Flow_Scale_Lower = 0.0
        ```

### Flow_Scale_Upper {#flow_scale_upper}

```csharp
float Flow_Scale_Upper { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Upper = networkDemandSensitivity.Flow_Scale_Upper;
        networkDemandSensitivity.Flow_Scale_Upper = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Upper;
        networkDemandSensitivity->get_Flow_Scale_Upper(&flow_Scale_Upper);
        networkDemandSensitivity->put_Flow_Scale_Upper(0.0);
        ```

    === "Python"

        ```python
        flow__scale__upper = networkDemandSensitivity.Flow_Scale_Upper
        networkDemandSensitivity.Flow_Scale_Upper = 0.0
        ```

### Flow_Scale_Is_constant_factor_applied {#flow_scale_is_constant_factor_applied}

```csharp
bool Flow_Scale_Is_constant_factor_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool flow_Scale_Is_constant_factor_applied = networkDemandSensitivity.Flow_Scale_Is_constant_factor_applied;
        networkDemandSensitivity.Flow_Scale_Is_constant_factor_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL flow_Scale_Is_constant_factor_applied;
        networkDemandSensitivity->get_Flow_Scale_Is_constant_factor_applied(&flow_Scale_Is_constant_factor_applied);
        networkDemandSensitivity->put_Flow_Scale_Is_constant_factor_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        flow__scale__is_constant_factor_applied = networkDemandSensitivity.Flow_Scale_Is_constant_factor_applied
        networkDemandSensitivity.Flow_Scale_Is_constant_factor_applied = True
        ```

### Flow_Scale_Constant_factor {#flow_scale_constant_factor}

```csharp
float Flow_Scale_Constant_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Constant_factor = networkDemandSensitivity.Flow_Scale_Constant_factor;
        networkDemandSensitivity.Flow_Scale_Constant_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Constant_factor;
        networkDemandSensitivity->get_Flow_Scale_Constant_factor(&flow_Scale_Constant_factor);
        networkDemandSensitivity->put_Flow_Scale_Constant_factor(0.0);
        ```

    === "Python"

        ```python
        flow__scale__constant_factor = networkDemandSensitivity.Flow_Scale_Constant_factor
        networkDemandSensitivity.Flow_Scale_Constant_factor = 0.0
        ```

### SensitivityGeneralParameterGroup {#sensitivitygeneralparametergroup}

```csharp
ISIAPISensitivity SensitivityGeneralParameterGroup { get; }
```

**Type** [`ISIAPISensitivity`](sidrasolutions.si.api.isiapisensitivity.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var sensitivityGeneralParameterGroup = networkDemandSensitivity.SensitivityGeneralParameterGroup;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISensitivity> sensitivityGeneralParameterGroup;
        networkDemandSensitivity->get_SensitivityGeneralParameterGroup(&sensitivityGeneralParameterGroup);
        ```

    === "Python"

        ```python
        sensitivity_general_parameter_group = networkDemandSensitivity.SensitivityGeneralParameterGroup
        ```

### Result_option {#result_option}

Results For

```csharp
int Result_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Network (Vehicles)
- `2` - Network (Pedestrians)
- `3` - Network (Persons)

???- example "Code samples"

    === "C#"

        ```csharp
        int result_option = networkDemandSensitivity.Result_option;
        networkDemandSensitivity.Result_option = 0;
        ```

    === "C++"

        ```cpp
        long result_option;
        networkDemandSensitivity->get_Result_option(&result_option);
        networkDemandSensitivity->put_Result_option(0);
        ```

    === "Python"

        ```python
        result_option = networkDemandSensitivity.Result_option
        networkDemandSensitivity.Result_option = 0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkfolder.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkFolder
title: NetworkFolder
name: ISIAPINetworkFolder
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: C9D53985-EBE9-45CC-8880-3A5684768C62
summary: NetworkFolder wrapper interface
members:
  - ISIAPINetwork AddNetwork(int softwareSetup)
  - ISIAPINetwork AddNetwork(string softwareSetupSignature)
  - bool RemoveNetwork(ISIAPINetwork network)
  - ISIAPINetwork CloneNetwork(ISIAPINetwork network)
  - ISIAPINetwork CloneNetworkWithSites(ISIAPINetwork network)
  - bool MoveNetworkTo(ISIAPINetwork network, int newPosition)
  - int MoveNetworksToFolder(string networkNames, ISIAPINetworkFolder destFolder)
  - string Name
  - int Position
  - ISIAPINetworks Networks
  - ISIAPIProject Project
---

# NetworkFolder

Type `ISIAPINetworkFolder` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `C9D53985-EBE9-45CC-8880-3A5684768C62`

NetworkFolder wrapper interface

## Declaration

```csharp
[Guid("C9D53985-EBE9-45CC-8880-3A5684768C62")]
public interface ISIAPINetworkFolder
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | NetworkFolder name |
| [Position](#position) | `int` | This NetworkFolder Position in the collection. It is a zero-base integer. |
| [Networks](#networks) | [`ISIAPINetworks`](sidrasolutions.si.api.isiapinetworks.md) | Collection of Networks in this NetworkFolder |
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddNetwork(int)](#addnetwork-int) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Add a new Network into this NetworkFolder. The new Network does not include any Sites. It is created by using a Standard Software Setup. |
| [AddNetwork(string)](#addnetwork-string) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Add a new Network into this NetworkFolder. The new Network does not include any Sites. It is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature. |
| [RemoveNetwork(ISIAPINetwork)](#removenetwork-isiapinetwork) | `bool` | Remove a Network from this NetworkFolder. |
| [CloneNetwork(ISIAPINetwork)](#clonenetwork-isiapinetwork) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Clone a Network. |
| [CloneNetworkWithSites(ISIAPINetwork)](#clonenetworkwithsites-isiapinetwork) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Clone a Network with its Sites. |
| [MoveNetworkTo(ISIAPINetwork, int)](#movenetworkto-isiapinetwork--int) | `bool` | Move a Network to a new position in the same NetworkFolder. |
| [MoveNetworksToFolder(string, ISIAPINetworkFolder)](#movenetworkstofolder-string--isiapinetworkfolder) | `int` | Move Network(s) from this Network Folder to another Network Folder in this Project. |

</div>

## Properties

### Name {#name}

NetworkFolder name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The NetworkFolder name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = networkFolder.Name;
        networkFolder.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        networkFolder->get_Name(&name);
        networkFolder->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = networkFolder.Name
        networkFolder.Name = r"Example"
        ```

### Position {#position}

This NetworkFolder Position in the collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = networkFolder.Position;
        ```

    === "C++"

        ```cpp
        long position;
        networkFolder->get_Position(&position);
        ```

    === "Python"

        ```python
        position = networkFolder.Position
        ```

### Networks {#networks}

Collection of Networks in this NetworkFolder

```csharp
ISIAPINetworks Networks { get; }
```

**Type** [`ISIAPINetworks`](sidrasolutions.si.api.isiapinetworks.md)

**Value**

Networks collection

???- example "Code samples"

    === "C#"

        ```csharp
        var networks = networkFolder.Networks;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworks> networks;
        networkFolder->get_Networks(&networks);
        ```

    === "Python"

        ```python
        networks = networkFolder.Networks
        ```

### Project {#project}

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var project = networkFolder.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        networkFolder->get_Project(&project);
        ```

    === "Python"

        ```python
        project = networkFolder.Project
        ```

## Methods

### AddNetwork(int) {#addnetwork-int}

Add a new Network into this NetworkFolder. The new Network does not include any Sites. It is created by using a Standard Software Setup.

```csharp
ISIAPINetwork AddNetwork(int softwareSetup)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `softwareSetup` | `int` | One of: - Standard Software Setup that is used to create the Network - `1` - Standard Left - `2` - New Zealand - `3` - New South Wales - `4` - Standard Right - `5` - US HCM (Metric) - `6` - US HCM (Customary) |

**Returns** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) - The new added Network.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkFolder.AddNetwork(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> result;
        networkFolder->AddNetwork(0, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.AddNetwork(0)
        ```

### AddNetwork(string) {#addnetwork-string}

Add a new Network into this NetworkFolder. The new Network does not include any Sites. 
It is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.

```csharp
ISIAPINetwork AddNetwork(string softwareSetupSignature)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `softwareSetupSignature` | `string` | The signature string of a User Software Setup or a Standard Software Setup. |

**Returns** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) - The new added Network.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkFolder.AddNetwork(@"value");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> result;
        networkFolder->AddNetwork(CComBSTR(L"value"), &result);
        ```

    === "Python"

        ```python
        result = networkFolder.AddNetwork(r"value")
        ```

### RemoveNetwork(ISIAPINetwork) {#removenetwork-isiapinetwork}

Remove a Network from this NetworkFolder.

```csharp
bool RemoveNetwork(ISIAPINetwork network)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `network` | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | The Network to remove. |

**Returns** `bool` - true if the Network is successfully removed; otherwise, false. This method also returns false if the Network does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkFolder.RemoveNetwork(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkFolder->RemoveNetwork(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.RemoveNetwork(None)
        ```

### CloneNetwork(ISIAPINetwork) {#clonenetwork-isiapinetwork}

Clone a Network.

```csharp
ISIAPINetwork CloneNetwork(ISIAPINetwork network)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `network` | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | The Network to be cloned. |

**Returns** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) - The new cloned Network.

**Remarks**

This funciton will create a new Network with the same Sites as those in the original Network, i.e. the Sites will not be cloned.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkFolder.CloneNetwork(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> result;
        networkFolder->CloneNetwork(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.CloneNetwork(None)
        ```

### CloneNetworkWithSites(ISIAPINetwork) {#clonenetworkwithsites-isiapinetwork}

Clone a Network with its Sites.

```csharp
ISIAPINetwork CloneNetworkWithSites(ISIAPINetwork network)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `network` | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | The Network to be cloned. |

**Returns** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) - The new cloned Network.

**Remarks**

This function will clone the Network and its Sites as well, i.e. there will be new cloned Sites in the new cloned Network.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkFolder.CloneNetworkWithSites(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> result;
        networkFolder->CloneNetworkWithSites(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.CloneNetworkWithSites(None)
        ```

### MoveNetworkTo(ISIAPINetwork, int) {#movenetworkto-isiapinetwork--int}

Move a Network to a new position in the same NetworkFolder.

```csharp
bool MoveNetworkTo(ISIAPINetwork network, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `network` | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | The Network to move. |
| `newPosition` | `int` | The zero-based position that the Network should be moved to. |

**Returns** `bool` - true if the Network is successfully moved; otherwise, false. This method also returns false if the Network does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkFolder.MoveNetworkTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkFolder->MoveNetworkTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.MoveNetworkTo(None, 0)
        ```

### MoveNetworksToFolder(string, ISIAPINetworkFolder) {#movenetworkstofolder-string--isiapinetworkfolder}

Move Network(s) from this Network Folder to another Network Folder in this Project.

```csharp
int MoveNetworksToFolder(string networkNames, ISIAPINetworkFolder destFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkNames` | `string` | The name(s) of the Network(s) to move. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples: |
| `destFolder` | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | The destination Network Folder |

**Returns** `int` - The number of successfully moved Networks

???- example "Code samples"

    === "C#"

        ```csharp
        int result = networkFolder.MoveNetworksToFolder(@"City Network", null);
        ```

    === "C++"

        ```cpp
        long result;
        networkFolder->MoveNetworksToFolder(CComBSTR(L"City Network"), NULL, &result);
        ```

    === "Python"

        ```python
        result = networkFolder.MoveNetworksToFolder(r"City Network", None)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkfolders.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkFolders
title: NetworkFolders
name: ISIAPINetworkFolders
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FD0AEE9A-9E4B-4E45-806B-5D808CCBCBE8
summary: NetworkFolder collection wrapper interface
members:
  - bool NetworkFolderExists(string name)
  - ISIAPINetworkFolder this[string name]
  - ISIAPINetworkFolder this[int index]
  - int Count
---

# NetworkFolders

Type `ISIAPINetworkFolders` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FD0AEE9A-9E4B-4E45-806B-5D808CCBCBE8`

NetworkFolder collection wrapper interface

## Declaration

```csharp
[Guid("FD0AEE9A-9E4B-4E45-806B-5D808CCBCBE8")]
public interface ISIAPINetworkFolders
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of NetworkFolders contained in the collection. |
| [this[]](#this) | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | Get the NetworkFolder from the collection by the NetworkFolder name. |
| [this[]](#this) | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | Get the NetworkFolder at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [NetworkFolderExists(string)](#networkfolderexists-string) | `bool` | Queries whether a particular NetworkFolder exists in the collection |

</div>

## Properties

### Count {#count}

Gets the number of NetworkFolders contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkFolders.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkFolders->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkFolders.Count
        ```

### this[] {#this}

Get the NetworkFolder from the collection by the NetworkFolder name.

```csharp
ISIAPINetworkFolder this[] { get; }
```

**Type** [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md)

**Remarks**

The NetworkFolder name is not unique in the collection. It is possible that more than one NetworkFolder has the same name. 
The first NetworkFolder found by name is returned. If no NetworkFolder is found, null / Nothing is returned.

In C#, use ISIAPINetworkFolders[] to get a NetworkFolder by its name or its position in the collection.  
In VBA, use Item() to get a NetworkFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a NetworkFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkFolder> this[];
        networkFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkFolders.this[]
        ```

### this[] {#this}

Get the NetworkFolder at the specified index.

```csharp
ISIAPINetworkFolder this[] { get; }
```

**Type** [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md)

**Remarks**

In C#, use ISIAPINetworkFolders[] to get a NetworkFolder by its name or its position in the collection.  
In VBA, use Item() to get a NetworkFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a NetworkFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkFolder> this[];
        networkFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkFolders.this[]
        ```

## Methods

### NetworkFolderExists(string) {#networkfolderexists-string}

Queries whether a particular NetworkFolder exists in the collection

```csharp
bool NetworkFolderExists(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | NetworkFolder name to query |

**Returns** `bool` - True, if any NetworkFolder with the given name exists in the collection. False otherwise

**Remarks**

The NetworkFolder name is not unique in the collection. It is possible that more than one NetworkFolder has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkFolders.NetworkFolderExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkFolders->NetworkFolderExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkFolders.NetworkFolderExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworklegconnection.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkLegConnection
title: NetworkLegConnection
name: ISIAPINetworkLegConnection
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 99F63CB1-320B-4AAD-A19D-2FFBF7C0DFAF
members:
  - string Site1_Name
  - int Leg1_Orientation
  - string Site2_Name
  - int Leg2_Orientation
  - ISIAPINetwork Network
  - ISIAPINetworkSite NetworkSite1
  - ISIAPINetworkSite NetworkSite2
  - int ConnectionType
  - int ZIndex
---

# NetworkLegConnection

Type `ISIAPINetworkLegConnection` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `99F63CB1-320B-4AAD-A19D-2FFBF7C0DFAF`

## Declaration

```csharp
[Guid("99F63CB1-320B-4AAD-A19D-2FFBF7C0DFAF")]
public interface ISIAPINetworkLegConnection
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Site1_Name](#site1_name) | `string` |  |
| [Leg1_Orientation](#leg1_orientation) | `int` |  |
| [Site2_Name](#site2_name) | `string` |  |
| [Leg2_Orientation](#leg2_orientation) | `int` |  |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [NetworkSite1](#networksite1) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| [NetworkSite2](#networksite2) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| [ConnectionType](#connectiontype) | `int` |  |
| [ZIndex](#zindex) | `int` |  |

</div>

## Properties

### Site1_Name {#site1_name}

```csharp
string Site1_Name { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string site1_Name = networkLegConnection.Site1_Name;
        ```

    === "C++"

        ```cpp
        CComBSTR site1_Name;
        networkLegConnection->get_Site1_Name(&site1_Name);
        ```

    === "Python"

        ```python
        site1__name = networkLegConnection.Site1_Name
        ```

### Leg1_Orientation {#leg1_orientation}

```csharp
int Leg1_Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int leg1_Orientation = networkLegConnection.Leg1_Orientation;
        ```

    === "C++"

        ```cpp
        long leg1_Orientation;
        networkLegConnection->get_Leg1_Orientation(&leg1_Orientation);
        ```

    === "Python"

        ```python
        leg1__orientation = networkLegConnection.Leg1_Orientation
        ```

### Site2_Name {#site2_name}

```csharp
string Site2_Name { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string site2_Name = networkLegConnection.Site2_Name;
        ```

    === "C++"

        ```cpp
        CComBSTR site2_Name;
        networkLegConnection->get_Site2_Name(&site2_Name);
        ```

    === "Python"

        ```python
        site2__name = networkLegConnection.Site2_Name
        ```

### Leg2_Orientation {#leg2_orientation}

```csharp
int Leg2_Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int leg2_Orientation = networkLegConnection.Leg2_Orientation;
        ```

    === "C++"

        ```cpp
        long leg2_Orientation;
        networkLegConnection->get_Leg2_Orientation(&leg2_Orientation);
        ```

    === "Python"

        ```python
        leg2__orientation = networkLegConnection.Leg2_Orientation
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkLegConnection.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkLegConnection->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkLegConnection.Network
        ```

### NetworkSite1 {#networksite1}

```csharp
ISIAPINetworkSite NetworkSite1 { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSite1 = networkLegConnection.NetworkSite1;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> networkSite1;
        networkLegConnection->get_NetworkSite1(&networkSite1);
        ```

    === "Python"

        ```python
        network_site1 = networkLegConnection.NetworkSite1
        ```

### NetworkSite2 {#networksite2}

```csharp
ISIAPINetworkSite NetworkSite2 { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSite2 = networkLegConnection.NetworkSite2;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> networkSite2;
        networkLegConnection->get_NetworkSite2(&networkSite2);
        ```

    === "Python"

        ```python
        network_site2 = networkLegConnection.NetworkSite2
        ```

### ConnectionType {#connectiontype}

```csharp
int ConnectionType { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int connectionType = networkLegConnection.ConnectionType;
        networkLegConnection.ConnectionType = 0;
        ```

    === "C++"

        ```cpp
        long connectionType;
        networkLegConnection->get_ConnectionType(&connectionType);
        networkLegConnection->put_ConnectionType(0);
        ```

    === "Python"

        ```python
        connection_type = networkLegConnection.ConnectionType
        networkLegConnection.ConnectionType = 0
        ```

### ZIndex {#zindex}

```csharp
int ZIndex { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int zIndex = networkLegConnection.ZIndex;
        networkLegConnection.ZIndex = 0;
        ```

    === "C++"

        ```cpp
        long zIndex;
        networkLegConnection->get_ZIndex(&zIndex);
        networkLegConnection->put_ZIndex(0);
        ```

    === "Python"

        ```python
        z_index = networkLegConnection.ZIndex
        networkLegConnection.ZIndex = 0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworklegconnections.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkLegConnections
title: NetworkLegConnections
name: ISIAPINetworkLegConnections
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 258ADC3B-0211-4E32-A9E2-34CF44BA43D7
members:
  - ISIAPINetworkLegConnection this[int index]
  - int Count
---

# NetworkLegConnections

Type `ISIAPINetworkLegConnections` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `258ADC3B-0211-4E32-A9E2-34CF44BA43D7`

## Declaration

```csharp
[Guid("258ADC3B-0211-4E32-A9E2-34CF44BA43D7")]
public interface ISIAPINetworkLegConnections
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of elements contained in the collection |
| [this[]](#this) | [`ISIAPINetworkLegConnection`](sidrasolutions.si.api.isiapinetworklegconnection.md) | Gets the element at the specified index. |

</div>

## Properties

### Count {#count}

Gets the number of elements contained in the collection

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkLegConnections.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkLegConnections->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkLegConnections.Count
        ```

### this[] {#this}

Gets the element at the specified index.

```csharp
ISIAPINetworkLegConnection this[] { get; }
```

**Type** [`ISIAPINetworkLegConnection`](sidrasolutions.si.api.isiapinetworklegconnection.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkLegConnections.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkLegConnection> this[];
        networkLegConnections->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkLegConnections.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkMC
title: NetworkMC
name: ISIAPINetworkMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 68E9501D-A37F-40DC-9B5D-200CA57ABAB3
members:
  - int MC_class
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float LowerLimitOfSpeedEfficiency
  - ISIAPINetwork Network
---

# NetworkMC

Type `ISIAPINetworkMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `68E9501D-A37F-40DC-9B5D-200CA57ABAB3`

## Declaration

```csharp
[Guid("68E9501D-A37F-40DC-9B5D-200CA57ABAB3")]
public interface ISIAPINetworkMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [LowerLimitOfSpeedEfficiency](#lowerlimitofspeedefficiency) | `float` |  |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = networkMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        networkMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = networkMC.MC_class
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = networkMC.DesiredSpeedMethod;
        networkMC.DesiredSpeedMethod = 0;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        networkMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        networkMC->put_DesiredSpeedMethod(0);
        ```

    === "Python"

        ```python
        desired_speed_method = networkMC.DesiredSpeedMethod
        networkMC.DesiredSpeedMethod = 0
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = networkMC.DesiredSpeed;
        networkMC.DesiredSpeed = 0.0;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        networkMC->get_DesiredSpeed(&desiredSpeed);
        networkMC->put_DesiredSpeed(0.0);
        ```

    === "Python"

        ```python
        desired_speed = networkMC.DesiredSpeed
        networkMC.DesiredSpeed = 0.0
        ```

### LowerLimitOfSpeedEfficiency {#lowerlimitofspeedefficiency}

```csharp
float LowerLimitOfSpeedEfficiency { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lowerLimitOfSpeedEfficiency = networkMC.LowerLimitOfSpeedEfficiency;
        networkMC.LowerLimitOfSpeedEfficiency = 0.0;
        ```

    === "C++"

        ```cpp
        double lowerLimitOfSpeedEfficiency;
        networkMC->get_LowerLimitOfSpeedEfficiency(&lowerLimitOfSpeedEfficiency);
        networkMC->put_LowerLimitOfSpeedEfficiency(0.0);
        ```

    === "Python"

        ```python
        lower_limit_of_speed_efficiency = networkMC.LowerLimitOfSpeedEfficiency
        networkMC.LowerLimitOfSpeedEfficiency = 0.0
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkMC.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkMC->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkMC.Network
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkMCs
title: NetworkMCs
name: ISIAPINetworkMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1DF4C454-28DD-4DFD-AC8C-9EBB96228EF3
members:
  - ISIAPINetworkMC this[int mcClass]
  - int Count
---

# NetworkMCs

Type `ISIAPINetworkMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1DF4C454-28DD-4DFD-AC8C-9EBB96228EF3`

## Declaration

```csharp
[Guid("1DF4C454-28DD-4DFD-AC8C-9EBB96228EF3")]
public interface ISIAPINetworkMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPINetworkMC`](sidrasolutions.si.api.isiapinetworkmc.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPINetworkMC this[] { get; }
```

**Type** [`ISIAPINetworkMC`](sidrasolutions.si.api.isiapinetworkmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkMC> this[];
        networkMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkMCs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworks.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworks
title: Networks
name: ISIAPINetworks
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B2DE2D3C-39F6-4587-85FC-E2827F9C5A05
summary: Network collection wrapper interface
members:
  - bool NetworkExists(string networkname)
  - ISIAPINetwork GetNetworkByID(string network_id)
  - ISIAPINetwork this[string networkname]
  - ISIAPINetwork this[int index]
  - int Count
---

# Networks

Type `ISIAPINetworks` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B2DE2D3C-39F6-4587-85FC-E2827F9C5A05`

Network collection wrapper interface

## Declaration

```csharp
[Guid("B2DE2D3C-39F6-4587-85FC-E2827F9C5A05")]
public interface ISIAPINetworks
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of Networks contained in the collection. |
| [this[]](#this) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Get the Network from the collection by the Network name. |
| [this[]](#this) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Get the Network at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [NetworkExists(string)](#networkexists-string) | `bool` | Queries whether a particular Network exists in the collection |
| [GetNetworkByID(string)](#getnetworkbyid-string) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) | Get the Network by its GUID. |

</div>

## Properties

### Count {#count}

Gets the number of Networks contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networks.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networks->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networks.Count
        ```

### this[] {#this}

Get the Network from the collection by the Network name.

```csharp
ISIAPINetwork this[] { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

**Remarks**

The Network name is not unique in the collection. It is possible that more than one Network has the same name. 
The first Network found by name is returned. If no Network is found, null / Nothing is returned.

In C#, use ISIAPINetworks[] to get a Network by its name or its position in the collection.  
In VBA, use Item() to get a Network by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a Network by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networks.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> this[];
        networks->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networks.this[]
        ```

### this[] {#this}

Get the Network at the specified index.

```csharp
ISIAPINetwork this[] { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

**Remarks**

In C#, use ISIAPINetworks[] to get a Network by its name or its position in the collection.  
In VBA, use Item() to get a Network by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a Network by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networks.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> this[];
        networks->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networks.this[]
        ```

## Methods

### NetworkExists(string) {#networkexists-string}

Queries whether a particular Network exists in the collection

```csharp
bool NetworkExists(string networkname)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkname` | `string` | Network name to query |

**Returns** `bool` - True, if any Network with the given name exists in the collection. False otherwise

**Remarks**

The Network name is not unique in the collection. It is possible that more than one Network has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networks.NetworkExists(@"City Network");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networks->NetworkExists(CComBSTR(L"City Network"), &result);
        ```

    === "Python"

        ```python
        result = networks.NetworkExists(r"City Network")
        ```

### GetNetworkByID(string) {#getnetworkbyid-string}

Get the Network by its GUID.

```csharp
ISIAPINetwork GetNetworkByID(string network_id)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `network_id` | `string` | The GUID of the Network object, i.e. ISIAPINetwork.Network_id. This is different from the "Network ID" in the Network Data dialog, i.e. ISIAPINetwork.NetworkID. |

**Returns** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networks.GetNetworkByID(@"id-1");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> result;
        networks->GetNetworkByID(CComBSTR(L"id-1"), &result);
        ```

    === "Python"

        ```python
        result = networks.GetNetworkByID(r"id-1")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkscenario.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkScenario
title: NetworkScenario
name: ISIAPINetworkScenario
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: ACE73758-FDD9-4C77-8349-BB5846E313A9
members:
  - string Name
  - string ID
  - int Position
  - int VolumeType
  - bool Analyse
  - ISIAPINetwork Network
  - ISIAPINetworkSiteScenarios NetworkSiteScenarios
---

# NetworkScenario

Type `ISIAPINetworkScenario` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `ACE73758-FDD9-4C77-8349-BB5846E313A9`

## Declaration

```csharp
[Guid("ACE73758-FDD9-4C77-8349-BB5846E313A9")]
public interface ISIAPINetworkScenario
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | Network Scenario name |
| [ID](#id) | `string` | Network Scenario ID in the Network Scenarios dialog and reports. |
| [Position](#position) | `int` |  |
| [VolumeType](#volumetype) | `int` | Network Scenario Volume Type |
| [Analyse](#analyse) | `bool` | Flag indicating this Network Scenario is applied to the Network. |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [NetworkSiteScenarios](#networksitescenarios) | [`ISIAPINetworkSiteScenarios`](sidrasolutions.si.api.isiapinetworksitescenarios.md) | NetworkSiteScenarios collection for this Scenario. |

</div>

## Properties

### Name {#name}

Network Scenario name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The Network Scenario name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = networkScenario.Name;
        networkScenario.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        networkScenario->get_Name(&name);
        networkScenario->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = networkScenario.Name
        networkScenario.Name = r"Example"
        ```

### ID {#id}

Network Scenario ID in the Network Scenarios dialog and reports.

```csharp
string ID { get; set; }
```

**Type** `string`

**Value**

Network Scenario ID, max length = 10.

???- example "Code samples"

    === "C#"

        ```csharp
        string iD = networkScenario.ID;
        networkScenario.ID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR iD;
        networkScenario->get_ID(&iD);
        networkScenario->put_ID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        id = networkScenario.ID
        networkScenario.ID = r"id-1"
        ```

### Position {#position}

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = networkScenario.Position;
        ```

    === "C++"

        ```cpp
        long position;
        networkScenario->get_Position(&position);
        ```

    === "Python"

        ```python
        position = networkScenario.Position
        ```

### VolumeType {#volumetype}

Network Scenario Volume Type

```csharp
int VolumeType { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Local, the local volumes of the Sites in the Network are applied
- `2` - Custom, the Site Scenarios defined in the property NetworkSiteScenarios collection are applied

???- example "Code samples"

    === "C#"

        ```csharp
        int volumeType = networkScenario.VolumeType;
        ```

    === "C++"

        ```cpp
        long volumeType;
        networkScenario->get_VolumeType(&volumeType);
        ```

    === "Python"

        ```python
        volume_type = networkScenario.VolumeType
        ```

### Analyse {#analyse}

Flag indicating this Network Scenario is applied to the Network.

```csharp
bool Analyse { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool analyse = networkScenario.Analyse;
        networkScenario.Analyse = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL analyse;
        networkScenario->get_Analyse(&analyse);
        networkScenario->put_Analyse(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        analyse = networkScenario.Analyse
        networkScenario.Analyse = True
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkScenario.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkScenario->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkScenario.Network
        ```

### NetworkSiteScenarios {#networksitescenarios}

NetworkSiteScenarios collection for this Scenario.

```csharp
ISIAPINetworkSiteScenarios NetworkSiteScenarios { get; }
```

**Type** [`ISIAPINetworkSiteScenarios`](sidrasolutions.si.api.isiapinetworksitescenarios.md)

**Remarks**

This NetworkSiteScenarios property only applies to the Network Scenario which VolumeType == 2 (Custom).

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSiteScenarios = networkScenario.NetworkSiteScenarios;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSiteScenarios> networkSiteScenarios;
        networkScenario->get_NetworkSiteScenarios(&networkSiteScenarios);
        ```

    === "Python"

        ```python
        network_site_scenarios = networkScenario.NetworkSiteScenarios
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworkscenarios.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkScenarios
title: NetworkScenarios
name: ISIAPINetworkScenarios
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: F0E121B8-4E03-407A-9B19-501D014A9950
members:
  - bool NetworkScenarioExists(string networkScenarioName)
  - ISIAPINetworkScenario this[string networkScenarioName]
  - ISIAPINetworkScenario this[int index]
  - int Count
---

# NetworkScenarios

Type `ISIAPINetworkScenarios` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `F0E121B8-4E03-407A-9B19-501D014A9950`

## Declaration

```csharp
[Guid("F0E121B8-4E03-407A-9B19-501D014A9950")]
public interface ISIAPINetworkScenarios
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of NetworkScenarios contained in the collection. |
| [this[]](#this) | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | Get the NetworkScenario from the collection by its name. |
| [this[]](#this) | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) | Get the NetworkScenario at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [NetworkScenarioExists(string)](#networkscenarioexists-string) | `bool` | Queries whether a particular NetworkScenario exists in the collection by its name. |

</div>

## Properties

### Count {#count}

Gets the number of NetworkScenarios contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkScenarios.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkScenarios->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkScenarios.Count
        ```

### this[] {#this}

Get the NetworkScenario from the collection by its name.

```csharp
ISIAPINetworkScenario this[] { get; }
```

**Type** [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md)

**Remarks**

The NetworkScenario name is not unique in the collection. It is possible that more than one NetworkScenario has the same name. 
The first NetworkScenario found by name is returned. If no NetworkScenario is found, null / Nothing is returned.

In C#, use ISIAPINetworkScenarios[] to get a NetworkScenario by its name or its position in the collection.  
In VBA, use Item() to get a NetworkScenario by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a NetworkScenario by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkScenarios.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenario> this[];
        networkScenarios->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkScenarios.this[]
        ```

### this[] {#this}

Get the NetworkScenario at the specified index.

```csharp
ISIAPINetworkScenario this[] { get; }
```

**Type** [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md)

**Remarks**

In C#, use ISIAPINetworkScenarios[] to get a NetworkScenario by its name or its position in the collection.  
In VBA, use Item() to get a NetworkScenario by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a NetworkScenario by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkScenarios.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenario> this[];
        networkScenarios->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkScenarios.this[]
        ```

## Methods

### NetworkScenarioExists(string) {#networkscenarioexists-string}

Queries whether a particular NetworkScenario exists in the collection by its name.

```csharp
bool NetworkScenarioExists(string networkScenarioName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkScenarioName` | `string` | NetworkScenario name to query |

**Returns** `bool` - True, if any NetworkScenario with the given name exists in the collection. False otherwise

**Remarks**

The NetworkScenario name is not unique in the collection. It is possible that more than one NetworkScenario has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkScenarios.NetworkScenarioExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkScenarios->NetworkScenarioExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = networkScenarios.NetworkScenarioExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworksite.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkSite
title: NetworkSite
name: ISIAPINetworkSite
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0ECC347C-09B4-4EDE-9E11-F710F96F903F
summary: Wrapper interface for the Site in a particular Network
members:
  - string NetworkSite_id
  - ISIAPINetwork Network
  - string SiteName
  - ISIAPIOutputset SiteOutputset
  - bool IsReference
  - int Offset
  - float LayoutX
  - float LayoutY
  - int CoordinatedOption
  - ISIAPINetworkLegConnections NetworkLegConnections
  - ISIAPINetworkCCG NetworkCCG
  - ISIAPISite Site
  - int DiagnosticStatus
  - ISIAPIDiagnosticMsgs DiagnosticMsgs
  - bool IsIncludedInProjectSummary
---

# NetworkSite

Type `ISIAPINetworkSite` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0ECC347C-09B4-4EDE-9E11-F710F96F903F`

Wrapper interface for the Site in a particular Network

## Declaration

```csharp
[Guid("0ECC347C-09B4-4EDE-9E11-F710F96F903F")]
public interface ISIAPINetworkSite
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [NetworkSite_id](#networksite_id) | `string` | The unique ID of the NetworkSite object. |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [SiteName](#sitename) | `string` |  |
| [SiteOutputset](#siteoutputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) | Site output data of this Site in the particular Network |
| [IsReference](#isreference) | `bool` |  |
| [Offset](#offset) | `int` |  |
| [LayoutX](#layoutx) | `float` |  |
| [LayoutY](#layouty) | `float` |  |
| [CoordinatedOption](#coordinatedoption) | `int` | Coordinated Option |
| [NetworkLegConnections](#networklegconnections) | [`ISIAPINetworkLegConnections`](sidrasolutions.si.api.isiapinetworklegconnections.md) |  |
| [NetworkCCG](#networkccg) | [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md) |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [DiagnosticStatus](#diagnosticstatus) | `int` | Diagnostic Status |
| [DiagnosticMsgs](#diagnosticmsgs) | [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md) |  |
| [IsIncludedInProjectSummary](#isincludedinprojectsummary) | `bool` |  |

</div>

## Properties

### NetworkSite_id {#networksite_id}

The unique ID of the NetworkSite object.

```csharp
string NetworkSite_id { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string networkSite_id = networkSite.NetworkSite_id;
        ```

    === "C++"

        ```cpp
        CComBSTR networkSite_id;
        networkSite->get_NetworkSite_id(&networkSite_id);
        ```

    === "Python"

        ```python
        network_site_id = networkSite.NetworkSite_id
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = networkSite.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        networkSite->get_Network(&network);
        ```

    === "Python"

        ```python
        network = networkSite.Network
        ```

### SiteName {#sitename}

```csharp
string SiteName { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string siteName = networkSite.SiteName;
        ```

    === "C++"

        ```cpp
        CComBSTR siteName;
        networkSite->get_SiteName(&siteName);
        ```

    === "Python"

        ```python
        site_name = networkSite.SiteName
        ```

### SiteOutputset {#siteoutputset}

Site output data of this Site in the particular Network

```csharp
ISIAPIOutputset SiteOutputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteOutputset = networkSite.SiteOutputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> siteOutputset;
        networkSite->get_SiteOutputset(&siteOutputset);
        ```

    === "Python"

        ```python
        site_outputset = networkSite.SiteOutputset
        ```

### IsReference {#isreference}

```csharp
bool IsReference { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isReference = networkSite.IsReference;
        networkSite.IsReference = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isReference;
        networkSite->get_IsReference(&isReference);
        networkSite->put_IsReference(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_reference = networkSite.IsReference
        networkSite.IsReference = True
        ```

### Offset {#offset}

```csharp
int Offset { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int offset = networkSite.Offset;
        networkSite.Offset = 0;
        ```

    === "C++"

        ```cpp
        long offset;
        networkSite->get_Offset(&offset);
        networkSite->put_Offset(0);
        ```

    === "Python"

        ```python
        offset = networkSite.Offset
        networkSite.Offset = 0
        ```

### LayoutX {#layoutx}

```csharp
float LayoutX { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float layoutX = networkSite.LayoutX;
        networkSite.LayoutX = 0.0;
        ```

    === "C++"

        ```cpp
        double layoutX;
        networkSite->get_LayoutX(&layoutX);
        networkSite->put_LayoutX(0.0);
        ```

    === "Python"

        ```python
        layout_x = networkSite.LayoutX
        networkSite.LayoutX = 0.0
        ```

### LayoutY {#layouty}

```csharp
float LayoutY { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float layoutY = networkSite.LayoutY;
        networkSite.LayoutY = 0.0;
        ```

    === "C++"

        ```cpp
        double layoutY;
        networkSite->get_LayoutY(&layoutY);
        networkSite->put_LayoutY(0.0);
        ```

    === "Python"

        ```python
        layout_y = networkSite.LayoutY
        networkSite.LayoutY = 0.0
        ```

### CoordinatedOption {#coordinatedoption}

Coordinated Option

```csharp
int CoordinatedOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - NA
- `1` - Yes
- `2` - No

???- example "Code samples"

    === "C#"

        ```csharp
        int coordinatedOption = networkSite.CoordinatedOption;
        networkSite.CoordinatedOption = 0;
        ```

    === "C++"

        ```cpp
        long coordinatedOption;
        networkSite->get_CoordinatedOption(&coordinatedOption);
        networkSite->put_CoordinatedOption(0);
        ```

    === "Python"

        ```python
        coordinated_option = networkSite.CoordinatedOption
        networkSite.CoordinatedOption = 0
        ```

### NetworkLegConnections {#networklegconnections}

```csharp
ISIAPINetworkLegConnections NetworkLegConnections { get; }
```

**Type** [`ISIAPINetworkLegConnections`](sidrasolutions.si.api.isiapinetworklegconnections.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkLegConnections = networkSite.NetworkLegConnections;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkLegConnections> networkLegConnections;
        networkSite->get_NetworkLegConnections(&networkLegConnections);
        ```

    === "Python"

        ```python
        network_leg_connections = networkSite.NetworkLegConnections
        ```

### NetworkCCG {#networkccg}

```csharp
ISIAPINetworkCCG NetworkCCG { get; }
```

**Type** [`ISIAPINetworkCCG`](sidrasolutions.si.api.isiapinetworkccg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkCCG = networkSite.NetworkCCG;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkCCG> networkCCG;
        networkSite->get_NetworkCCG(&networkCCG);
        ```

    === "Python"

        ```python
        network_ccg = networkSite.NetworkCCG
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = networkSite.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        networkSite->get_Site(&site);
        ```

    === "Python"

        ```python
        site = networkSite.Site
        ```

### DiagnosticStatus {#diagnosticstatus}

Diagnostic Status

```csharp
int DiagnosticStatus { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Processed
- `2` - Not Processed
- `3` - Input Warning
- `4` - Processing Warning
- `5` - Error

???- example "Code samples"

    === "C#"

        ```csharp
        int diagnosticStatus = networkSite.DiagnosticStatus;
        ```

    === "C++"

        ```cpp
        long diagnosticStatus;
        networkSite->get_DiagnosticStatus(&diagnosticStatus);
        ```

    === "Python"

        ```python
        diagnostic_status = networkSite.DiagnosticStatus
        ```

### DiagnosticMsgs {#diagnosticmsgs}

```csharp
ISIAPIDiagnosticMsgs DiagnosticMsgs { get; }
```

**Type** [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var diagnosticMsgs = networkSite.DiagnosticMsgs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIDiagnosticMsgs> diagnosticMsgs;
        networkSite->get_DiagnosticMsgs(&diagnosticMsgs);
        ```

    === "Python"

        ```python
        diagnostic_msgs = networkSite.DiagnosticMsgs
        ```

### IsIncludedInProjectSummary {#isincludedinprojectsummary}

```csharp
bool IsIncludedInProjectSummary { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInProjectSummary = networkSite.IsIncludedInProjectSummary;
        networkSite.IsIncludedInProjectSummary = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInProjectSummary;
        networkSite->get_IsIncludedInProjectSummary(&isIncludedInProjectSummary);
        networkSite->put_IsIncludedInProjectSummary(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_project_summary = networkSite.IsIncludedInProjectSummary
        networkSite.IsIncludedInProjectSummary = True
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworksites.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkSites
title: NetworkSites
name: ISIAPINetworkSites
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 45ACCED4-517A-4F53-A2FA-43BB38839E88
members:
  - bool NetworkSiteExists(string sitename)
  - ISIAPINetworkSite this[string sitename]
  - ISIAPINetworkSite this[int index]
  - int Count
---

# NetworkSites

Type `ISIAPINetworkSites` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `45ACCED4-517A-4F53-A2FA-43BB38839E88`

## Declaration

```csharp
[Guid("45ACCED4-517A-4F53-A2FA-43BB38839E88")]
public interface ISIAPINetworkSites
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| [this[]](#this) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [NetworkSiteExists(string)](#networksiteexists-string) | `bool` | Queries whether a particular Network Site exists in the collection |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkSites.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkSites->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkSites.Count
        ```

### this[] {#this}

```csharp
ISIAPINetworkSite this[] { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkSites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> this[];
        networkSites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkSites.this[]
        ```

### this[] {#this}

```csharp
ISIAPINetworkSite this[] { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkSites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> this[];
        networkSites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkSites.this[]
        ```

## Methods

### NetworkSiteExists(string) {#networksiteexists-string}

Queries whether a particular Network Site exists in the collection

```csharp
bool NetworkSiteExists(string sitename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sitename` | `string` | Site name to query |

**Returns** `bool` - True, if a Network Site with the given Site name exists in the collection. False otherwise

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = networkSites.NetworkSiteExists(@"Main Intersection");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        networkSites->NetworkSiteExists(CComBSTR(L"Main Intersection"), &result);
        ```

    === "Python"

        ```python
        result = networkSites.NetworkSiteExists(r"Main Intersection")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworksitescenario.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkSiteScenario
title: NetworkSiteScenario
name: ISIAPINetworkSiteScenario
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: A69D1684-9E96-408B-84AC-8F5FBA995E9A
members:
  - ISIAPINetworkScenario NetworkScenario
  - ISIAPINetworkSite NetworkSite
  - ISIAPISiteScenario SiteScenario
---

# NetworkSiteScenario

Type `ISIAPINetworkSiteScenario` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `A69D1684-9E96-408B-84AC-8F5FBA995E9A`

## Declaration

```csharp
[Guid("A69D1684-9E96-408B-84AC-8F5FBA995E9A")]
public interface ISIAPINetworkSiteScenario
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [NetworkScenario](#networkscenario) | [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md) |  |
| [NetworkSite](#networksite) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| [SiteScenario](#sitescenario) | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) |  |

</div>

## Properties

### NetworkScenario {#networkscenario}

```csharp
ISIAPINetworkScenario NetworkScenario { get; }
```

**Type** [`ISIAPINetworkScenario`](sidrasolutions.si.api.isiapinetworkscenario.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkScenario = networkSiteScenario.NetworkScenario;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkScenario> networkScenario;
        networkSiteScenario->get_NetworkScenario(&networkScenario);
        ```

    === "Python"

        ```python
        network_scenario = networkSiteScenario.NetworkScenario
        ```

### NetworkSite {#networksite}

```csharp
ISIAPINetworkSite NetworkSite { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSite = networkSiteScenario.NetworkSite;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> networkSite;
        networkSiteScenario->get_NetworkSite(&networkSite);
        ```

    === "Python"

        ```python
        network_site = networkSiteScenario.NetworkSite
        ```

### SiteScenario {#sitescenario}

```csharp
ISIAPISiteScenario SiteScenario { get; set; }
```

**Type** [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteScenario = networkSiteScenario.SiteScenario;
        networkSiteScenario.SiteScenario = null;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenario> siteScenario;
        networkSiteScenario->get_SiteScenario(&siteScenario);
        networkSiteScenario->put_SiteScenario(NULL);
        ```

    === "Python"

        ```python
        site_scenario = networkSiteScenario.SiteScenario
        networkSiteScenario.SiteScenario = None
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapinetworksitescenarios.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPINetworkSiteScenarios
title: NetworkSiteScenarios
name: ISIAPINetworkSiteScenarios
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D43818A2-FBE7-4795-93D7-A9274F93D8CD
members:
  - ISIAPINetworkSiteScenario GetNetworkSiteScenarioByNetworkSite(ISIAPINetworkSite networkSite)
  - ISIAPINetworkSiteScenario this[int index]
  - int Count
---

# NetworkSiteScenarios

Type `ISIAPINetworkSiteScenarios` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D43818A2-FBE7-4795-93D7-A9274F93D8CD`

## Declaration

```csharp
[Guid("D43818A2-FBE7-4795-93D7-A9274F93D8CD")]
public interface ISIAPINetworkSiteScenarios
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of NetworkSiteScenarios contained in the collection. |
| [this[]](#this) | [`ISIAPINetworkSiteScenario`](sidrasolutions.si.api.isiapinetworksitescenario.md) | Get the NetworkSiteScenario at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [GetNetworkSiteScenarioByNetworkSite(ISIAPINetworkSite)](#getnetworksitescenariobynetworksite-isiapinetworksite) | [`ISIAPINetworkSiteScenario`](sidrasolutions.si.api.isiapinetworksitescenario.md) | Get the NetworkSiteScenario that links to the NetworkSite. |

</div>

## Properties

### Count {#count}

Gets the number of NetworkSiteScenarios contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = networkSiteScenarios.Count;
        ```

    === "C++"

        ```cpp
        long count;
        networkSiteScenarios->get_Count(&count);
        ```

    === "Python"

        ```python
        count = networkSiteScenarios.Count
        ```

### this[] {#this}

Get the NetworkSiteScenario at the specified index.

```csharp
ISIAPINetworkSiteScenario this[] { get; }
```

**Type** [`ISIAPINetworkSiteScenario`](sidrasolutions.si.api.isiapinetworksitescenario.md)

**Remarks**

In C#, use ISIAPISiteScenarios[] to get a NetworkSiteScenario by its position in the collection.  
In VBA, use Item() to get a NetworkSiteScenario by its position.  
In C++, use get_Item() to get a SiteScenario by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = networkSiteScenarios.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSiteScenario> this[];
        networkSiteScenarios->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = networkSiteScenarios.this[]
        ```

## Methods

### GetNetworkSiteScenarioByNetworkSite(ISIAPINetworkSite) {#getnetworksitescenariobynetworksite-isiapinetworksite}

Get the NetworkSiteScenario that links to the NetworkSite.

```csharp
ISIAPINetworkSiteScenario GetNetworkSiteScenarioByNetworkSite(ISIAPINetworkSite networkSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |

**Returns** [`ISIAPINetworkSiteScenario`](sidrasolutions.si.api.isiapinetworksitescenario.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = networkSiteScenarios.GetNetworkSiteScenarioByNetworkSite(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSiteScenario> result;
        networkSiteScenarios->GetNetworkSiteScenarioByNetworkSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = networkSiteScenarios.GetNetworkSiteScenarioByNetworkSite(None)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiopposingmovement_ped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOpposingmovement_ped
title: Opposingmovement_ped
name: ISIAPIOpposingmovement_ped
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 333947B5-D55A-489D-87B2-D6E477CD2D1F
members:
  - int Opposingmovement_ped_type
  - int Opposingmovement_ped_origin
  - int Opposingmovement_ped_stage
  - bool Opposing
  - ISIAPIMovement_vehicle_od Movement_vehicle_od
---

# Opposingmovement_ped

Type `ISIAPIOpposingmovement_ped` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `333947B5-D55A-489D-87B2-D6E477CD2D1F`

## Declaration

```csharp
[Guid("333947B5-D55A-489D-87B2-D6E477CD2D1F")]
public interface ISIAPIOpposingmovement_ped
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Opposingmovement_ped_type](#opposingmovement_ped_type) | `int` |  |
| [Opposingmovement_ped_origin](#opposingmovement_ped_origin) | `int` |  |
| [Opposingmovement_ped_stage](#opposingmovement_ped_stage) | `int` |  |
| [Opposing](#opposing) | `bool` |  |
| [Movement_vehicle_od](#movement_vehicle_od) | [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md) |  |

</div>

## Properties

### Opposingmovement_ped_type {#opposingmovement_ped_type}

```csharp
int Opposingmovement_ped_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposingmovement_ped_type = opposingmovement_ped.Opposingmovement_ped_type;
        ```

    === "C++"

        ```cpp
        long opposingmovement_ped_type;
        opposingmovement_ped->get_Opposingmovement_ped_type(&opposingmovement_ped_type);
        ```

    === "Python"

        ```python
        opposingmovement_ped_type = opposingmovement_ped.Opposingmovement_ped_type
        ```

### Opposingmovement_ped_origin {#opposingmovement_ped_origin}

```csharp
int Opposingmovement_ped_origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposingmovement_ped_origin = opposingmovement_ped.Opposingmovement_ped_origin;
        ```

    === "C++"

        ```cpp
        long opposingmovement_ped_origin;
        opposingmovement_ped->get_Opposingmovement_ped_origin(&opposingmovement_ped_origin);
        ```

    === "Python"

        ```python
        opposingmovement_ped_origin = opposingmovement_ped.Opposingmovement_ped_origin
        ```

### Opposingmovement_ped_stage {#opposingmovement_ped_stage}

```csharp
int Opposingmovement_ped_stage { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposingmovement_ped_stage = opposingmovement_ped.Opposingmovement_ped_stage;
        ```

    === "C++"

        ```cpp
        long opposingmovement_ped_stage;
        opposingmovement_ped->get_Opposingmovement_ped_stage(&opposingmovement_ped_stage);
        ```

    === "Python"

        ```python
        opposingmovement_ped_stage = opposingmovement_ped.Opposingmovement_ped_stage
        ```

### Opposing {#opposing}

```csharp
bool Opposing { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool opposing = opposingmovement_ped.Opposing;
        opposingmovement_ped.Opposing = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL opposing;
        opposingmovement_ped->get_Opposing(&opposing);
        opposingmovement_ped->put_Opposing(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        opposing = opposingmovement_ped.Opposing
        opposingmovement_ped.Opposing = True
        ```

### Movement_vehicle_od {#movement_vehicle_od}

```csharp
ISIAPIMovement_vehicle_od Movement_vehicle_od { get; }
```

**Type** [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movement_vehicle_od = opposingmovement_ped.Movement_vehicle_od;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od> movement_vehicle_od;
        opposingmovement_ped->get_Movement_vehicle_od(&movement_vehicle_od);
        ```

    === "Python"

        ```python
        movement_vehicle_od = opposingmovement_ped.Movement_vehicle_od
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiopposingmovement_peds.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOpposingmovement_peds
title: Opposingmovement_peds
name: ISIAPIOpposingmovement_peds
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8B5B722F-35DA-4EE8-AAF4-569A021FA576
members:
  - bool OpposingmovementPedExists(int opposing_ped_type, int opposing_ped_origin, int opposin_ped_stage)
  - ISIAPIOpposingmovement_ped this[int opposing_ped_type, int opposing_ped_origin, int opposin_ped_stage]
  - ISIAPIOpposingmovement_ped this[int index]
  - int Count
---

# Opposingmovement_peds

Type `ISIAPIOpposingmovement_peds` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8B5B722F-35DA-4EE8-AAF4-569A021FA576`

## Declaration

```csharp
[Guid("8B5B722F-35DA-4EE8-AAF4-569A021FA576")]
public interface ISIAPIOpposingmovement_peds
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOpposingmovement_ped`](sidrasolutions.si.api.isiapiopposingmovement_ped.md) |  |
| [this[]](#this) | [`ISIAPIOpposingmovement_ped`](sidrasolutions.si.api.isiapiopposingmovement_ped.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [OpposingmovementPedExists(int, int, int)](#opposingmovementpedexists-int--int--int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = opposingmovement_peds.Count;
        ```

    === "C++"

        ```cpp
        long count;
        opposingmovement_peds->get_Count(&count);
        ```

    === "Python"

        ```python
        count = opposingmovement_peds.Count
        ```

### this[] {#this}

```csharp
ISIAPIOpposingmovement_ped this[] { get; }
```

**Type** [`ISIAPIOpposingmovement_ped`](sidrasolutions.si.api.isiapiopposingmovement_ped.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = opposingmovement_peds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_ped> this[];
        opposingmovement_peds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = opposingmovement_peds.this[]
        ```

### this[] {#this}

```csharp
ISIAPIOpposingmovement_ped this[] { get; }
```

**Type** [`ISIAPIOpposingmovement_ped`](sidrasolutions.si.api.isiapiopposingmovement_ped.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = opposingmovement_peds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_ped> this[];
        opposingmovement_peds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = opposingmovement_peds.this[]
        ```

## Methods

### OpposingmovementPedExists(int, int, int) {#opposingmovementpedexists-int--int--int}

```csharp
bool OpposingmovementPedExists(int opposing_ped_type, int opposing_ped_origin, int opposin_ped_stage)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `opposing_ped_type` | `int` |  |
| `opposing_ped_origin` | `int` |  |
| `opposin_ped_stage` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = opposingmovement_peds.OpposingmovementPedExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        opposingmovement_peds->OpposingmovementPedExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = opposingmovement_peds.OpposingmovementPedExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiopposingmovement_vehicle.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOpposingmovement_vehicle
title: Opposingmovement_vehicle
name: ISIAPIOpposingmovement_vehicle
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2E7E715C-8A62-4F95-9AA6-FFA71F75BD67
members:
  - int Opposingmovement_vehicle_origin
  - int Opposingmovement_vehicle_destination
  - bool Opposing
  - ISIAPIMovement_vehicle_od Movement_vehicle_od
---

# Opposingmovement_vehicle

Type `ISIAPIOpposingmovement_vehicle` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2E7E715C-8A62-4F95-9AA6-FFA71F75BD67`

## Declaration

```csharp
[Guid("2E7E715C-8A62-4F95-9AA6-FFA71F75BD67")]
public interface ISIAPIOpposingmovement_vehicle
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Opposingmovement_vehicle_origin](#opposingmovement_vehicle_origin) | `int` |  |
| [Opposingmovement_vehicle_destination](#opposingmovement_vehicle_destination) | `int` |  |
| [Opposing](#opposing) | `bool` |  |
| [Movement_vehicle_od](#movement_vehicle_od) | [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md) |  |

</div>

## Properties

### Opposingmovement_vehicle_origin {#opposingmovement_vehicle_origin}

```csharp
int Opposingmovement_vehicle_origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposingmovement_vehicle_origin = opposingmovement_vehicle.Opposingmovement_vehicle_origin;
        ```

    === "C++"

        ```cpp
        long opposingmovement_vehicle_origin;
        opposingmovement_vehicle->get_Opposingmovement_vehicle_origin(&opposingmovement_vehicle_origin);
        ```

    === "Python"

        ```python
        opposingmovement_vehicle_origin = opposingmovement_vehicle.Opposingmovement_vehicle_origin
        ```

### Opposingmovement_vehicle_destination {#opposingmovement_vehicle_destination}

```csharp
int Opposingmovement_vehicle_destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposingmovement_vehicle_destination = opposingmovement_vehicle.Opposingmovement_vehicle_destination;
        ```

    === "C++"

        ```cpp
        long opposingmovement_vehicle_destination;
        opposingmovement_vehicle->get_Opposingmovement_vehicle_destination(&opposingmovement_vehicle_destination);
        ```

    === "Python"

        ```python
        opposingmovement_vehicle_destination = opposingmovement_vehicle.Opposingmovement_vehicle_destination
        ```

### Opposing {#opposing}

```csharp
bool Opposing { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool opposing = opposingmovement_vehicle.Opposing;
        opposingmovement_vehicle.Opposing = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL opposing;
        opposingmovement_vehicle->get_Opposing(&opposing);
        opposingmovement_vehicle->put_Opposing(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        opposing = opposingmovement_vehicle.Opposing
        opposingmovement_vehicle.Opposing = True
        ```

### Movement_vehicle_od {#movement_vehicle_od}

```csharp
ISIAPIMovement_vehicle_od Movement_vehicle_od { get; }
```

**Type** [`ISIAPIMovement_vehicle_od`](sidrasolutions.si.api.isiapimovement_vehicle_od.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movement_vehicle_od = opposingmovement_vehicle.Movement_vehicle_od;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_od> movement_vehicle_od;
        opposingmovement_vehicle->get_Movement_vehicle_od(&movement_vehicle_od);
        ```

    === "Python"

        ```python
        movement_vehicle_od = opposingmovement_vehicle.Movement_vehicle_od
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiopposingmovement_vehicles.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOpposingmovement_vehicles
title: Opposingmovement_vehicles
name: ISIAPIOpposingmovement_vehicles
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D066A4E6-657C-4F60-8E6C-31897846E965
members:
  - bool OpposingmovementVehicleExists(int opposing_veh_origin, int opposing_veh_destination)
  - ISIAPIOpposingmovement_vehicle this[int opposing_veh_origin, int opposing_veh_destination]
  - ISIAPIOpposingmovement_vehicle this[int index]
  - int Count
---

# Opposingmovement_vehicles

Type `ISIAPIOpposingmovement_vehicles` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D066A4E6-657C-4F60-8E6C-31897846E965`

## Declaration

```csharp
[Guid("D066A4E6-657C-4F60-8E6C-31897846E965")]
public interface ISIAPIOpposingmovement_vehicles
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOpposingmovement_vehicle`](sidrasolutions.si.api.isiapiopposingmovement_vehicle.md) |  |
| [this[]](#this) | [`ISIAPIOpposingmovement_vehicle`](sidrasolutions.si.api.isiapiopposingmovement_vehicle.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [OpposingmovementVehicleExists(int, int)](#opposingmovementvehicleexists-int--int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = opposingmovement_vehicles.Count;
        ```

    === "C++"

        ```cpp
        long count;
        opposingmovement_vehicles->get_Count(&count);
        ```

    === "Python"

        ```python
        count = opposingmovement_vehicles.Count
        ```

### this[] {#this}

```csharp
ISIAPIOpposingmovement_vehicle this[] { get; }
```

**Type** [`ISIAPIOpposingmovement_vehicle`](sidrasolutions.si.api.isiapiopposingmovement_vehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = opposingmovement_vehicles.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_vehicle> this[];
        opposingmovement_vehicles->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = opposingmovement_vehicles.this[]
        ```

### this[] {#this}

```csharp
ISIAPIOpposingmovement_vehicle this[] { get; }
```

**Type** [`ISIAPIOpposingmovement_vehicle`](sidrasolutions.si.api.isiapiopposingmovement_vehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = opposingmovement_vehicles.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOpposingmovement_vehicle> this[];
        opposingmovement_vehicles->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = opposingmovement_vehicles.this[]
        ```

## Methods

### OpposingmovementVehicleExists(int, int) {#opposingmovementvehicleexists-int--int}

```csharp
bool OpposingmovementVehicleExists(int opposing_veh_origin, int opposing_veh_destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `opposing_veh_origin` | `int` |  |
| `opposing_veh_destination` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = opposingmovement_vehicles.OpposingmovementVehicleExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        opposingmovement_vehicles->OpposingmovementVehicleExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = opposingmovement_vehicles.OpposingmovementVehicleExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputanalysis.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputAnalysis
title: OutputAnalysis
name: ISIAPIOutputAnalysis
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 264A9C9D-52AA-4812-9266-B632B1449E16
members:
  - int Design_Life_Selected_future_year
  - int Design_Life_Analysis_status
  - float Flow_Scale_Largest_movement_flow_scale
  - int Flow_Scale_Analysis_status
  - float Sensitivity_Selected_parameter_scale
  - int Sensitivity_Analysis_status
---

# OutputAnalysis

Type `ISIAPIOutputAnalysis` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `264A9C9D-52AA-4812-9266-B632B1449E16`

## Declaration

```csharp
[Guid("264A9C9D-52AA-4812-9266-B632B1449E16")]
public interface ISIAPIOutputAnalysis
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Design_Life_Selected_future_year](#design_life_selected_future_year) | `int` |  |
| [Design_Life_Analysis_status](#design_life_analysis_status) | `int` | Design Life Analysis Status |
| [Flow_Scale_Largest_movement_flow_scale](#flow_scale_largest_movement_flow_scale) | `float` |  |
| [Flow_Scale_Analysis_status](#flow_scale_analysis_status) | `int` | Flow Scale Analysis Status |
| [Sensitivity_Selected_parameter_scale](#sensitivity_selected_parameter_scale) | `float` |  |
| [Sensitivity_Analysis_status](#sensitivity_analysis_status) | `int` | Sensitivity Analysis Status |

</div>

## Properties

### Design_Life_Selected_future_year {#design_life_selected_future_year}

```csharp
int Design_Life_Selected_future_year { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Selected_future_year = outputAnalysis.Design_Life_Selected_future_year;
        ```

    === "C++"

        ```cpp
        long design_Life_Selected_future_year;
        outputAnalysis->get_Design_Life_Selected_future_year(&design_Life_Selected_future_year);
        ```

    === "Python"

        ```python
        design__life__selected_future_year = outputAnalysis.Design_Life_Selected_future_year
        ```

### Design_Life_Analysis_status {#design_life_analysis_status}

Design Life Analysis Status

```csharp
int Design_Life_Analysis_status { get; }
```

**Type** `int`

**Value**

One of:

- `0` - No comment
- `1` - As a result of the specified Intersection / Worst Movement LOS Target, LOS F, results are reported for the final year
- `2` - The specified Design Life Target was exceeded in all future years
- `3` - The specified Design Life Target was not reached by the final year in the Design Life Analysis

???- example "Code samples"

    === "C#"

        ```csharp
        int design_Life_Analysis_status = outputAnalysis.Design_Life_Analysis_status;
        ```

    === "C++"

        ```cpp
        long design_Life_Analysis_status;
        outputAnalysis->get_Design_Life_Analysis_status(&design_Life_Analysis_status);
        ```

    === "Python"

        ```python
        design__life__analysis_status = outputAnalysis.Design_Life_Analysis_status
        ```

### Flow_Scale_Largest_movement_flow_scale {#flow_scale_largest_movement_flow_scale}

```csharp
float Flow_Scale_Largest_movement_flow_scale { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_Scale_Largest_movement_flow_scale = outputAnalysis.Flow_Scale_Largest_movement_flow_scale;
        ```

    === "C++"

        ```cpp
        double flow_Scale_Largest_movement_flow_scale;
        outputAnalysis->get_Flow_Scale_Largest_movement_flow_scale(&flow_Scale_Largest_movement_flow_scale);
        ```

    === "Python"

        ```python
        flow__scale__largest_movement_flow_scale = outputAnalysis.Flow_Scale_Largest_movement_flow_scale
        ```

### Flow_Scale_Analysis_status {#flow_scale_analysis_status}

Flow Scale Analysis Status

```csharp
int Flow_Scale_Analysis_status { get; }
```

**Type** `int`

**Value**

One of:

- `0` - No comment
- `1` - As a result of the specified Intersection / Worst Movement LOS Target, LOS F, results are reported for the final year
- `2` - The specified Flow Scale Analysis Target was exceeded in all future years or upper limit was too low
- `3` - The specified Flow Scale Analysis Target was not reached by the final year in the Flow Scale Analysis
- `4` - Only one run was made as Flow Scale Lower Limit = Upper Limit was specified in the Site Demand & Sensitivity dialog

???- example "Code samples"

    === "C#"

        ```csharp
        int flow_Scale_Analysis_status = outputAnalysis.Flow_Scale_Analysis_status;
        ```

    === "C++"

        ```cpp
        long flow_Scale_Analysis_status;
        outputAnalysis->get_Flow_Scale_Analysis_status(&flow_Scale_Analysis_status);
        ```

    === "Python"

        ```python
        flow__scale__analysis_status = outputAnalysis.Flow_Scale_Analysis_status
        ```

### Sensitivity_Selected_parameter_scale {#sensitivity_selected_parameter_scale}

```csharp
float Sensitivity_Selected_parameter_scale { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float sensitivity_Selected_parameter_scale = outputAnalysis.Sensitivity_Selected_parameter_scale;
        ```

    === "C++"

        ```cpp
        double sensitivity_Selected_parameter_scale;
        outputAnalysis->get_Sensitivity_Selected_parameter_scale(&sensitivity_Selected_parameter_scale);
        ```

    === "Python"

        ```python
        sensitivity__selected_parameter_scale = outputAnalysis.Sensitivity_Selected_parameter_scale
        ```

### Sensitivity_Analysis_status {#sensitivity_analysis_status}

Sensitivity Analysis Status

```csharp
int Sensitivity_Analysis_status { get; }
```

**Type** `int`

**Value**

One of:

- `0` - No comment
- `1` - Only one run was made as Lower Limit = Upper Limit was specified in the Site Demand & Sensitivity dialog
- `2` - This value was chosen to achieve intersection degree of saturation (v/c ratio) close to 1.0. Short lanes with degree of saturation = 1.0 were ignored in this process
- `3` - All scaled parameter values gave degrees of saturation (v/c ratios) less than 1.0
- `4` - All scaled parameter values gave degrees of saturation (v/c ratios) greater than 1.0

???- example "Code samples"

    === "C#"

        ```csharp
        int sensitivity_Analysis_status = outputAnalysis.Sensitivity_Analysis_status;
        ```

    === "C++"

        ```cpp
        long sensitivity_Analysis_status;
        outputAnalysis->get_Sensitivity_Analysis_status(&sensitivity_Analysis_status);
        ```

    === "Python"

        ```python
        sensitivity__analysis_status = outputAnalysis.Sensitivity_Analysis_status
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputcirculatinglane.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputCirculatingLane
title: OutputCirculatingLane
name: ISIAPIOutputCirculatingLane
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 14EE3EC1-0AFA-4495-A006-AEE1617A5E61
members:
  - int Orientation
  - int Laneno
  - float Roucircf_veh
  - float Roucircf_pcu
  - float Roucircf_percent
  - ISIAPIOutputLeg OutputLeg
  - ISIAPIOutputCirculatingLaneMCs OutputCirculatingLaneMCs
---

# OutputCirculatingLane

Type `ISIAPIOutputCirculatingLane` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `14EE3EC1-0AFA-4495-A006-AEE1617A5E61`

## Declaration

```csharp
[Guid("14EE3EC1-0AFA-4495-A006-AEE1617A5E61")]
public interface ISIAPIOutputCirculatingLane
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` |  |
| [Laneno](#laneno) | `int` |  |
| [Roucircf_veh](#roucircf_veh) | `float` |  |
| [Roucircf_pcu](#roucircf_pcu) | `float` |  |
| [Roucircf_percent](#roucircf_percent) | `float` |  |
| [OutputLeg](#outputleg) | [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md) |  |
| [OutputCirculatingLaneMCs](#outputcirculatinglanemcs) | [`ISIAPIOutputCirculatingLaneMCs`](sidrasolutions.si.api.isiapioutputcirculatinglanemcs.md) |  |

</div>

## Properties

### Orientation {#orientation}

```csharp
int Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = outputCirculatingLane.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        outputCirculatingLane->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = outputCirculatingLane.Orientation
        ```

### Laneno {#laneno}

```csharp
int Laneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int laneno = outputCirculatingLane.Laneno;
        ```

    === "C++"

        ```cpp
        long laneno;
        outputCirculatingLane->get_Laneno(&laneno);
        ```

    === "Python"

        ```python
        laneno = outputCirculatingLane.Laneno
        ```

### Roucircf_veh {#roucircf_veh}

```csharp
float Roucircf_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_veh = outputCirculatingLane.Roucircf_veh;
        ```

    === "C++"

        ```cpp
        double roucircf_veh;
        outputCirculatingLane->get_Roucircf_veh(&roucircf_veh);
        ```

    === "Python"

        ```python
        roucircf_veh = outputCirculatingLane.Roucircf_veh
        ```

### Roucircf_pcu {#roucircf_pcu}

```csharp
float Roucircf_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_pcu = outputCirculatingLane.Roucircf_pcu;
        ```

    === "C++"

        ```cpp
        double roucircf_pcu;
        outputCirculatingLane->get_Roucircf_pcu(&roucircf_pcu);
        ```

    === "Python"

        ```python
        roucircf_pcu = outputCirculatingLane.Roucircf_pcu
        ```

### Roucircf_percent {#roucircf_percent}

```csharp
float Roucircf_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_percent = outputCirculatingLane.Roucircf_percent;
        ```

    === "C++"

        ```cpp
        double roucircf_percent;
        outputCirculatingLane->get_Roucircf_percent(&roucircf_percent);
        ```

    === "Python"

        ```python
        roucircf_percent = outputCirculatingLane.Roucircf_percent
        ```

### OutputLeg {#outputleg}

```csharp
ISIAPIOutputLeg OutputLeg { get; }
```

**Type** [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLeg = outputCirculatingLane.OutputLeg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLeg> outputLeg;
        outputCirculatingLane->get_OutputLeg(&outputLeg);
        ```

    === "Python"

        ```python
        output_leg = outputCirculatingLane.OutputLeg
        ```

### OutputCirculatingLaneMCs {#outputcirculatinglanemcs}

```csharp
ISIAPIOutputCirculatingLaneMCs OutputCirculatingLaneMCs { get; }
```

**Type** [`ISIAPIOutputCirculatingLaneMCs`](sidrasolutions.si.api.isiapioutputcirculatinglanemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputCirculatingLaneMCs = outputCirculatingLane.OutputCirculatingLaneMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputCirculatingLaneMCs> outputCirculatingLaneMCs;
        outputCirculatingLane->get_OutputCirculatingLaneMCs(&outputCirculatingLaneMCs);
        ```

    === "Python"

        ```python
        output_circulating_lane_m_cs = outputCirculatingLane.OutputCirculatingLaneMCs
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputcirculatinglanemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputCirculatingLaneMC
title: OutputCirculatingLaneMC
name: ISIAPIOutputCirculatingLaneMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E367178E-48D7-473F-8939-203CEF5C9489
members:
  - int MC_class
  - float Roucircf_veh
  - float Roucircf_pcu
  - float Roucircf_percent
  - ISIAPIOutputCirculatingLane OutputCirculatingLane
---

# OutputCirculatingLaneMC

Type `ISIAPIOutputCirculatingLaneMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E367178E-48D7-473F-8939-203CEF5C9489`

## Declaration

```csharp
[Guid("E367178E-48D7-473F-8939-203CEF5C9489")]
public interface ISIAPIOutputCirculatingLaneMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Roucircf_veh](#roucircf_veh) | `float` |  |
| [Roucircf_pcu](#roucircf_pcu) | `float` |  |
| [Roucircf_percent](#roucircf_percent) | `float` |  |
| [OutputCirculatingLane](#outputcirculatinglane) | [`ISIAPIOutputCirculatingLane`](sidrasolutions.si.api.isiapioutputcirculatinglane.md) |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputCirculatingLaneMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputCirculatingLaneMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputCirculatingLaneMC.MC_class
        ```

### Roucircf_veh {#roucircf_veh}

```csharp
float Roucircf_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_veh = outputCirculatingLaneMC.Roucircf_veh;
        ```

    === "C++"

        ```cpp
        double roucircf_veh;
        outputCirculatingLaneMC->get_Roucircf_veh(&roucircf_veh);
        ```

    === "Python"

        ```python
        roucircf_veh = outputCirculatingLaneMC.Roucircf_veh
        ```

### Roucircf_pcu {#roucircf_pcu}

```csharp
float Roucircf_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_pcu = outputCirculatingLaneMC.Roucircf_pcu;
        ```

    === "C++"

        ```cpp
        double roucircf_pcu;
        outputCirculatingLaneMC->get_Roucircf_pcu(&roucircf_pcu);
        ```

    === "Python"

        ```python
        roucircf_pcu = outputCirculatingLaneMC.Roucircf_pcu
        ```

### Roucircf_percent {#roucircf_percent}

```csharp
float Roucircf_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float roucircf_percent = outputCirculatingLaneMC.Roucircf_percent;
        ```

    === "C++"

        ```cpp
        double roucircf_percent;
        outputCirculatingLaneMC->get_Roucircf_percent(&roucircf_percent);
        ```

    === "Python"

        ```python
        roucircf_percent = outputCirculatingLaneMC.Roucircf_percent
        ```

### OutputCirculatingLane {#outputcirculatinglane}

```csharp
ISIAPIOutputCirculatingLane OutputCirculatingLane { get; }
```

**Type** [`ISIAPIOutputCirculatingLane`](sidrasolutions.si.api.isiapioutputcirculatinglane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputCirculatingLane = outputCirculatingLaneMC.OutputCirculatingLane;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputCirculatingLane> outputCirculatingLane;
        outputCirculatingLaneMC->get_OutputCirculatingLane(&outputCirculatingLane);
        ```

    === "Python"

        ```python
        output_circulating_lane = outputCirculatingLaneMC.OutputCirculatingLane
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputcirculatinglanemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputCirculatingLaneMCs
title: OutputCirculatingLaneMCs
name: ISIAPIOutputCirculatingLaneMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8084CCAB-2A97-435A-B0E2-12155480EB9C
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputCirculatingLaneMC this[int mcClass]
  - int Count
---

# OutputCirculatingLaneMCs

Type `ISIAPIOutputCirculatingLaneMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8084CCAB-2A97-435A-B0E2-12155480EB9C`

## Declaration

```csharp
[Guid("8084CCAB-2A97-435A-B0E2-12155480EB9C")]
public interface ISIAPIOutputCirculatingLaneMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputCirculatingLaneMC`](sidrasolutions.si.api.isiapioutputcirculatinglanemc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputCirculatingLaneMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputCirculatingLaneMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputCirculatingLaneMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputCirculatingLaneMC this[] { get; }
```

**Type** [`ISIAPIOutputCirculatingLaneMC`](sidrasolutions.si.api.isiapioutputcirculatinglanemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputCirculatingLaneMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputCirculatingLaneMC> this[];
        outputCirculatingLaneMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputCirculatingLaneMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputCirculatingLaneMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputCirculatingLaneMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputCirculatingLaneMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputcirculatinglanes.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputCirculatingLanes
title: OutputCirculatingLanes
name: ISIAPIOutputCirculatingLanes
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 44EF2BED-DD7D-4A80-9895-769D9F82B9E6
members:
  - bool LaneExists(int laneno)
  - ISIAPIOutputCirculatingLane this[int laneno]
  - int Count
---

# OutputCirculatingLanes

Type `ISIAPIOutputCirculatingLanes` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `44EF2BED-DD7D-4A80-9895-769D9F82B9E6`

## Declaration

```csharp
[Guid("44EF2BED-DD7D-4A80-9895-769D9F82B9E6")]
public interface ISIAPIOutputCirculatingLanes
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputCirculatingLane`](sidrasolutions.si.api.isiapioutputcirculatinglane.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneExists(int)](#laneexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputCirculatingLanes.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputCirculatingLanes->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputCirculatingLanes.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputCirculatingLane this[] { get; }
```

**Type** [`ISIAPIOutputCirculatingLane`](sidrasolutions.si.api.isiapioutputcirculatinglane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputCirculatingLanes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputCirculatingLane> this[];
        outputCirculatingLanes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputCirculatingLanes.this[]
        ```

## Methods

### LaneExists(int) {#laneexists-int}

```csharp
bool LaneExists(int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `laneno` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputCirculatingLanes.LaneExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputCirculatingLanes->LaneExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputCirculatingLanes.LaneExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputgraphtuple.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputGraphTuple
title: OutputGraphTuple
name: ISIAPIOutputGraphTuple
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8F5D0CE8-0EFF-44A9-B35E-20FF6CC19AF2
members:
  - float X_value
  - float Demand_flow_total
  - float Capacity_effective
  - float Deg_satn
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Stop_rate
  - float Queue_maxback_percentile
  - float Queue_dist_maxback_percentile
  - float Performance_index
  - float Travel_speed
  - float Cycle_time
  - float Fuel_consumption_total
  - float Hydrocarbons_total
  - float Nox_total
  - float Carbon_monoxide_total
  - float Carbon_dioxide_total
  - float Operating_cost_total
  - bool Unsettled
  - float Demand_flow_total_ped
  - float Demand_flow_total_person
  - float Perc_heavy_veh
  - float Deg_satn_ped
  - float Delay_control_total_veh
  - float Delay_control_total_ped
  - float Delay_control_total_person
  - float Delay_control_average_veh
  - float Delay_control_average_ped
  - float Delay_control_average_worstlane
  - float Delay_control_average_worstmov_ped
  - float Delay_control_average_worstmov_person
  - float Delay_geometric_average
  - float Delay_stopline_average
  - int Level_of_service_veh
  - int Level_of_service_ped
  - float Total_stops_veh
  - float Total_stops_ped
  - float Total_stops_person
  - float Stop_rate_veh
  - float Stop_rate_ped
  - float Prop_queued_veh
  - float Prop_queued_ped
  - float Prop_queued_person
  - float Performance_index_veh
  - float Performance_index_ped
  - float Travel_dist_total_veh
  - float Travel_dist_total_ped
  - float Travel_dist_total_person
  - float Travel_dist_av_veh
  - float Travel_dist_av_ped
  - float Travel_dist_av_person
  - float Travel_time_total_veh
  - float Travel_time_total_ped
  - float Travel_time_total_person
  - float Travel_time_av_veh
  - float Travel_time_av_ped
  - float Travel_time_av_person
  - float Travel_speed_ped
  - float Travel_speed_person
  - float Operating_cost_total_veh
  - float Operating_cost_total_ped
  - float Arrival_flow_total
  - float Arrival_flow_total_person
  - float SpeedEfficiency
  - int Level_of_service
---

# OutputGraphTuple

Type `ISIAPIOutputGraphTuple` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8F5D0CE8-0EFF-44A9-B35E-20FF6CC19AF2`

## Declaration

```csharp
[Guid("8F5D0CE8-0EFF-44A9-B35E-20FF6CC19AF2")]
public interface ISIAPIOutputGraphTuple
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [X_value](#x_value) | `float` |  |
| [Demand_flow_total](#demand_flow_total) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Cycle_time](#cycle_time) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Unsettled](#unsettled) | `bool` |  |
| [Demand_flow_total_ped](#demand_flow_total_ped) | `float` |  |
| [Demand_flow_total_person](#demand_flow_total_person) | `float` |  |
| [Perc_heavy_veh](#perc_heavy_veh) | `float` |  |
| [Deg_satn_ped](#deg_satn_ped) | `float` |  |
| [Delay_control_total_veh](#delay_control_total_veh) | `float` |  |
| [Delay_control_total_ped](#delay_control_total_ped) | `float` |  |
| [Delay_control_total_person](#delay_control_total_person) | `float` |  |
| [Delay_control_average_veh](#delay_control_average_veh) | `float` |  |
| [Delay_control_average_ped](#delay_control_average_ped) | `float` |  |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` |  |
| [Delay_control_average_worstmov_ped](#delay_control_average_worstmov_ped) | `float` |  |
| [Delay_control_average_worstmov_person](#delay_control_average_worstmov_person) | `float` |  |
| [Delay_geometric_average](#delay_geometric_average) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Level_of_service_veh](#level_of_service_veh) | `int` |  |
| [Level_of_service_ped](#level_of_service_ped) | `int` |  |
| [Total_stops_veh](#total_stops_veh) | `float` |  |
| [Total_stops_ped](#total_stops_ped) | `float` |  |
| [Total_stops_person](#total_stops_person) | `float` |  |
| [Stop_rate_veh](#stop_rate_veh) | `float` |  |
| [Stop_rate_ped](#stop_rate_ped) | `float` |  |
| [Prop_queued_veh](#prop_queued_veh) | `float` |  |
| [Prop_queued_ped](#prop_queued_ped) | `float` |  |
| [Prop_queued_person](#prop_queued_person) | `float` |  |
| [Performance_index_veh](#performance_index_veh) | `float` |  |
| [Performance_index_ped](#performance_index_ped) | `float` |  |
| [Travel_dist_total_veh](#travel_dist_total_veh) | `float` |  |
| [Travel_dist_total_ped](#travel_dist_total_ped) | `float` |  |
| [Travel_dist_total_person](#travel_dist_total_person) | `float` |  |
| [Travel_dist_av_veh](#travel_dist_av_veh) | `float` |  |
| [Travel_dist_av_ped](#travel_dist_av_ped) | `float` |  |
| [Travel_dist_av_person](#travel_dist_av_person) | `float` |  |
| [Travel_time_total_veh](#travel_time_total_veh) | `float` |  |
| [Travel_time_total_ped](#travel_time_total_ped) | `float` |  |
| [Travel_time_total_person](#travel_time_total_person) | `float` |  |
| [Travel_time_av_veh](#travel_time_av_veh) | `float` |  |
| [Travel_time_av_ped](#travel_time_av_ped) | `float` |  |
| [Travel_time_av_person](#travel_time_av_person) | `float` |  |
| [Travel_speed_ped](#travel_speed_ped) | `float` |  |
| [Travel_speed_person](#travel_speed_person) | `float` |  |
| [Operating_cost_total_veh](#operating_cost_total_veh) | `float` |  |
| [Operating_cost_total_ped](#operating_cost_total_ped) | `float` |  |
| [Arrival_flow_total](#arrival_flow_total) | `float` |  |
| [Arrival_flow_total_person](#arrival_flow_total_person) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Level_of_service](#level_of_service) | `int` |  |

</div>

## Properties

### X_value {#x_value}

```csharp
float X_value { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float x_value = outputGraphTuple.X_value;
        ```

    === "C++"

        ```cpp
        double x_value;
        outputGraphTuple->get_X_value(&x_value);
        ```

    === "Python"

        ```python
        x_value = outputGraphTuple.X_value
        ```

### Demand_flow_total {#demand_flow_total}

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputGraphTuple.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputGraphTuple->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputGraphTuple.Demand_flow_total
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputGraphTuple.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputGraphTuple->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputGraphTuple.Capacity_effective
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputGraphTuple.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputGraphTuple->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputGraphTuple.Deg_satn
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputGraphTuple.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputGraphTuple->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputGraphTuple.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputGraphTuple.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputGraphTuple->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputGraphTuple.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputGraphTuple.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputGraphTuple->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputGraphTuple.Delay_control_average_worstmov
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputGraphTuple.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputGraphTuple->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputGraphTuple.Stop_rate
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputGraphTuple.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputGraphTuple->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputGraphTuple.Queue_maxback_percentile
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputGraphTuple.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputGraphTuple->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputGraphTuple.Queue_dist_maxback_percentile
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputGraphTuple.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputGraphTuple->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputGraphTuple.Performance_index
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputGraphTuple.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputGraphTuple->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputGraphTuple.Travel_speed
        ```

### Cycle_time {#cycle_time}

```csharp
float Cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time = outputGraphTuple.Cycle_time;
        ```

    === "C++"

        ```cpp
        double cycle_time;
        outputGraphTuple->get_Cycle_time(&cycle_time);
        ```

    === "Python"

        ```python
        cycle_time = outputGraphTuple.Cycle_time
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputGraphTuple.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputGraphTuple->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputGraphTuple.Fuel_consumption_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputGraphTuple.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputGraphTuple->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputGraphTuple.Hydrocarbons_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputGraphTuple.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputGraphTuple->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputGraphTuple.Nox_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputGraphTuple.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputGraphTuple->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputGraphTuple.Carbon_monoxide_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputGraphTuple.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputGraphTuple->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputGraphTuple.Carbon_dioxide_total
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputGraphTuple.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputGraphTuple->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputGraphTuple.Operating_cost_total
        ```

### Unsettled {#unsettled}

```csharp
bool Unsettled { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool unsettled = outputGraphTuple.Unsettled;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL unsettled;
        outputGraphTuple->get_Unsettled(&unsettled);
        ```

    === "Python"

        ```python
        unsettled = outputGraphTuple.Unsettled
        ```

### Demand_flow_total_ped {#demand_flow_total_ped}

```csharp
float Demand_flow_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total_ped = outputGraphTuple.Demand_flow_total_ped;
        ```

    === "C++"

        ```cpp
        double demand_flow_total_ped;
        outputGraphTuple->get_Demand_flow_total_ped(&demand_flow_total_ped);
        ```

    === "Python"

        ```python
        demand_flow_total_ped = outputGraphTuple.Demand_flow_total_ped
        ```

### Demand_flow_total_person {#demand_flow_total_person}

```csharp
float Demand_flow_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total_person = outputGraphTuple.Demand_flow_total_person;
        ```

    === "C++"

        ```cpp
        double demand_flow_total_person;
        outputGraphTuple->get_Demand_flow_total_person(&demand_flow_total_person);
        ```

    === "Python"

        ```python
        demand_flow_total_person = outputGraphTuple.Demand_flow_total_person
        ```

### Perc_heavy_veh {#perc_heavy_veh}

```csharp
float Perc_heavy_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float perc_heavy_veh = outputGraphTuple.Perc_heavy_veh;
        ```

    === "C++"

        ```cpp
        double perc_heavy_veh;
        outputGraphTuple->get_Perc_heavy_veh(&perc_heavy_veh);
        ```

    === "Python"

        ```python
        perc_heavy_veh = outputGraphTuple.Perc_heavy_veh
        ```

### Deg_satn_ped {#deg_satn_ped}

```csharp
float Deg_satn_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn_ped = outputGraphTuple.Deg_satn_ped;
        ```

    === "C++"

        ```cpp
        double deg_satn_ped;
        outputGraphTuple->get_Deg_satn_ped(&deg_satn_ped);
        ```

    === "Python"

        ```python
        deg_satn_ped = outputGraphTuple.Deg_satn_ped
        ```

### Delay_control_total_veh {#delay_control_total_veh}

```csharp
float Delay_control_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_veh = outputGraphTuple.Delay_control_total_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_total_veh;
        outputGraphTuple->get_Delay_control_total_veh(&delay_control_total_veh);
        ```

    === "Python"

        ```python
        delay_control_total_veh = outputGraphTuple.Delay_control_total_veh
        ```

### Delay_control_total_ped {#delay_control_total_ped}

```csharp
float Delay_control_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_ped = outputGraphTuple.Delay_control_total_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_total_ped;
        outputGraphTuple->get_Delay_control_total_ped(&delay_control_total_ped);
        ```

    === "Python"

        ```python
        delay_control_total_ped = outputGraphTuple.Delay_control_total_ped
        ```

### Delay_control_total_person {#delay_control_total_person}

```csharp
float Delay_control_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_person = outputGraphTuple.Delay_control_total_person;
        ```

    === "C++"

        ```cpp
        double delay_control_total_person;
        outputGraphTuple->get_Delay_control_total_person(&delay_control_total_person);
        ```

    === "Python"

        ```python
        delay_control_total_person = outputGraphTuple.Delay_control_total_person
        ```

### Delay_control_average_veh {#delay_control_average_veh}

```csharp
float Delay_control_average_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_veh = outputGraphTuple.Delay_control_average_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_average_veh;
        outputGraphTuple->get_Delay_control_average_veh(&delay_control_average_veh);
        ```

    === "Python"

        ```python
        delay_control_average_veh = outputGraphTuple.Delay_control_average_veh
        ```

### Delay_control_average_ped {#delay_control_average_ped}

```csharp
float Delay_control_average_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_ped = outputGraphTuple.Delay_control_average_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_average_ped;
        outputGraphTuple->get_Delay_control_average_ped(&delay_control_average_ped);
        ```

    === "Python"

        ```python
        delay_control_average_ped = outputGraphTuple.Delay_control_average_ped
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputGraphTuple.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputGraphTuple->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputGraphTuple.Delay_control_average_worstlane
        ```

### Delay_control_average_worstmov_ped {#delay_control_average_worstmov_ped}

```csharp
float Delay_control_average_worstmov_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov_ped = outputGraphTuple.Delay_control_average_worstmov_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov_ped;
        outputGraphTuple->get_Delay_control_average_worstmov_ped(&delay_control_average_worstmov_ped);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov_ped = outputGraphTuple.Delay_control_average_worstmov_ped
        ```

### Delay_control_average_worstmov_person {#delay_control_average_worstmov_person}

```csharp
float Delay_control_average_worstmov_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov_person = outputGraphTuple.Delay_control_average_worstmov_person;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov_person;
        outputGraphTuple->get_Delay_control_average_worstmov_person(&delay_control_average_worstmov_person);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov_person = outputGraphTuple.Delay_control_average_worstmov_person
        ```

### Delay_geometric_average {#delay_geometric_average}

```csharp
float Delay_geometric_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric_average = outputGraphTuple.Delay_geometric_average;
        ```

    === "C++"

        ```cpp
        double delay_geometric_average;
        outputGraphTuple->get_Delay_geometric_average(&delay_geometric_average);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputGraphTuple.Delay_geometric_average
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputGraphTuple.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputGraphTuple->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputGraphTuple.Delay_stopline_average
        ```

### Level_of_service_veh {#level_of_service_veh}

```csharp
int Level_of_service_veh { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service_veh = outputGraphTuple.Level_of_service_veh;
        ```

    === "C++"

        ```cpp
        long level_of_service_veh;
        outputGraphTuple->get_Level_of_service_veh(&level_of_service_veh);
        ```

    === "Python"

        ```python
        level_of_service_veh = outputGraphTuple.Level_of_service_veh
        ```

### Level_of_service_ped {#level_of_service_ped}

```csharp
int Level_of_service_ped { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service_ped = outputGraphTuple.Level_of_service_ped;
        ```

    === "C++"

        ```cpp
        long level_of_service_ped;
        outputGraphTuple->get_Level_of_service_ped(&level_of_service_ped);
        ```

    === "Python"

        ```python
        level_of_service_ped = outputGraphTuple.Level_of_service_ped
        ```

### Total_stops_veh {#total_stops_veh}

```csharp
float Total_stops_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_veh = outputGraphTuple.Total_stops_veh;
        ```

    === "C++"

        ```cpp
        double total_stops_veh;
        outputGraphTuple->get_Total_stops_veh(&total_stops_veh);
        ```

    === "Python"

        ```python
        total_stops_veh = outputGraphTuple.Total_stops_veh
        ```

### Total_stops_ped {#total_stops_ped}

```csharp
float Total_stops_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_ped = outputGraphTuple.Total_stops_ped;
        ```

    === "C++"

        ```cpp
        double total_stops_ped;
        outputGraphTuple->get_Total_stops_ped(&total_stops_ped);
        ```

    === "Python"

        ```python
        total_stops_ped = outputGraphTuple.Total_stops_ped
        ```

### Total_stops_person {#total_stops_person}

```csharp
float Total_stops_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_person = outputGraphTuple.Total_stops_person;
        ```

    === "C++"

        ```cpp
        double total_stops_person;
        outputGraphTuple->get_Total_stops_person(&total_stops_person);
        ```

    === "Python"

        ```python
        total_stops_person = outputGraphTuple.Total_stops_person
        ```

### Stop_rate_veh {#stop_rate_veh}

```csharp
float Stop_rate_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate_veh = outputGraphTuple.Stop_rate_veh;
        ```

    === "C++"

        ```cpp
        double stop_rate_veh;
        outputGraphTuple->get_Stop_rate_veh(&stop_rate_veh);
        ```

    === "Python"

        ```python
        stop_rate_veh = outputGraphTuple.Stop_rate_veh
        ```

### Stop_rate_ped {#stop_rate_ped}

```csharp
float Stop_rate_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate_ped = outputGraphTuple.Stop_rate_ped;
        ```

    === "C++"

        ```cpp
        double stop_rate_ped;
        outputGraphTuple->get_Stop_rate_ped(&stop_rate_ped);
        ```

    === "Python"

        ```python
        stop_rate_ped = outputGraphTuple.Stop_rate_ped
        ```

### Prop_queued_veh {#prop_queued_veh}

```csharp
float Prop_queued_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_veh = outputGraphTuple.Prop_queued_veh;
        ```

    === "C++"

        ```cpp
        double prop_queued_veh;
        outputGraphTuple->get_Prop_queued_veh(&prop_queued_veh);
        ```

    === "Python"

        ```python
        prop_queued_veh = outputGraphTuple.Prop_queued_veh
        ```

### Prop_queued_ped {#prop_queued_ped}

```csharp
float Prop_queued_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_ped = outputGraphTuple.Prop_queued_ped;
        ```

    === "C++"

        ```cpp
        double prop_queued_ped;
        outputGraphTuple->get_Prop_queued_ped(&prop_queued_ped);
        ```

    === "Python"

        ```python
        prop_queued_ped = outputGraphTuple.Prop_queued_ped
        ```

### Prop_queued_person {#prop_queued_person}

```csharp
float Prop_queued_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_person = outputGraphTuple.Prop_queued_person;
        ```

    === "C++"

        ```cpp
        double prop_queued_person;
        outputGraphTuple->get_Prop_queued_person(&prop_queued_person);
        ```

    === "Python"

        ```python
        prop_queued_person = outputGraphTuple.Prop_queued_person
        ```

### Performance_index_veh {#performance_index_veh}

```csharp
float Performance_index_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index_veh = outputGraphTuple.Performance_index_veh;
        ```

    === "C++"

        ```cpp
        double performance_index_veh;
        outputGraphTuple->get_Performance_index_veh(&performance_index_veh);
        ```

    === "Python"

        ```python
        performance_index_veh = outputGraphTuple.Performance_index_veh
        ```

### Performance_index_ped {#performance_index_ped}

```csharp
float Performance_index_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index_ped = outputGraphTuple.Performance_index_ped;
        ```

    === "C++"

        ```cpp
        double performance_index_ped;
        outputGraphTuple->get_Performance_index_ped(&performance_index_ped);
        ```

    === "Python"

        ```python
        performance_index_ped = outputGraphTuple.Performance_index_ped
        ```

### Travel_dist_total_veh {#travel_dist_total_veh}

```csharp
float Travel_dist_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_veh = outputGraphTuple.Travel_dist_total_veh;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_veh;
        outputGraphTuple->get_Travel_dist_total_veh(&travel_dist_total_veh);
        ```

    === "Python"

        ```python
        travel_dist_total_veh = outputGraphTuple.Travel_dist_total_veh
        ```

### Travel_dist_total_ped {#travel_dist_total_ped}

```csharp
float Travel_dist_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_ped = outputGraphTuple.Travel_dist_total_ped;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_ped;
        outputGraphTuple->get_Travel_dist_total_ped(&travel_dist_total_ped);
        ```

    === "Python"

        ```python
        travel_dist_total_ped = outputGraphTuple.Travel_dist_total_ped
        ```

### Travel_dist_total_person {#travel_dist_total_person}

```csharp
float Travel_dist_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_person = outputGraphTuple.Travel_dist_total_person;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_person;
        outputGraphTuple->get_Travel_dist_total_person(&travel_dist_total_person);
        ```

    === "Python"

        ```python
        travel_dist_total_person = outputGraphTuple.Travel_dist_total_person
        ```

### Travel_dist_av_veh {#travel_dist_av_veh}

```csharp
float Travel_dist_av_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_veh = outputGraphTuple.Travel_dist_av_veh;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_veh;
        outputGraphTuple->get_Travel_dist_av_veh(&travel_dist_av_veh);
        ```

    === "Python"

        ```python
        travel_dist_av_veh = outputGraphTuple.Travel_dist_av_veh
        ```

### Travel_dist_av_ped {#travel_dist_av_ped}

```csharp
float Travel_dist_av_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_ped = outputGraphTuple.Travel_dist_av_ped;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_ped;
        outputGraphTuple->get_Travel_dist_av_ped(&travel_dist_av_ped);
        ```

    === "Python"

        ```python
        travel_dist_av_ped = outputGraphTuple.Travel_dist_av_ped
        ```

### Travel_dist_av_person {#travel_dist_av_person}

```csharp
float Travel_dist_av_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_person = outputGraphTuple.Travel_dist_av_person;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_person;
        outputGraphTuple->get_Travel_dist_av_person(&travel_dist_av_person);
        ```

    === "Python"

        ```python
        travel_dist_av_person = outputGraphTuple.Travel_dist_av_person
        ```

### Travel_time_total_veh {#travel_time_total_veh}

```csharp
float Travel_time_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_veh = outputGraphTuple.Travel_time_total_veh;
        ```

    === "C++"

        ```cpp
        double travel_time_total_veh;
        outputGraphTuple->get_Travel_time_total_veh(&travel_time_total_veh);
        ```

    === "Python"

        ```python
        travel_time_total_veh = outputGraphTuple.Travel_time_total_veh
        ```

### Travel_time_total_ped {#travel_time_total_ped}

```csharp
float Travel_time_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_ped = outputGraphTuple.Travel_time_total_ped;
        ```

    === "C++"

        ```cpp
        double travel_time_total_ped;
        outputGraphTuple->get_Travel_time_total_ped(&travel_time_total_ped);
        ```

    === "Python"

        ```python
        travel_time_total_ped = outputGraphTuple.Travel_time_total_ped
        ```

### Travel_time_total_person {#travel_time_total_person}

```csharp
float Travel_time_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_person = outputGraphTuple.Travel_time_total_person;
        ```

    === "C++"

        ```cpp
        double travel_time_total_person;
        outputGraphTuple->get_Travel_time_total_person(&travel_time_total_person);
        ```

    === "Python"

        ```python
        travel_time_total_person = outputGraphTuple.Travel_time_total_person
        ```

### Travel_time_av_veh {#travel_time_av_veh}

```csharp
float Travel_time_av_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_veh = outputGraphTuple.Travel_time_av_veh;
        ```

    === "C++"

        ```cpp
        double travel_time_av_veh;
        outputGraphTuple->get_Travel_time_av_veh(&travel_time_av_veh);
        ```

    === "Python"

        ```python
        travel_time_av_veh = outputGraphTuple.Travel_time_av_veh
        ```

### Travel_time_av_ped {#travel_time_av_ped}

```csharp
float Travel_time_av_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_ped = outputGraphTuple.Travel_time_av_ped;
        ```

    === "C++"

        ```cpp
        double travel_time_av_ped;
        outputGraphTuple->get_Travel_time_av_ped(&travel_time_av_ped);
        ```

    === "Python"

        ```python
        travel_time_av_ped = outputGraphTuple.Travel_time_av_ped
        ```

### Travel_time_av_person {#travel_time_av_person}

```csharp
float Travel_time_av_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_person = outputGraphTuple.Travel_time_av_person;
        ```

    === "C++"

        ```cpp
        double travel_time_av_person;
        outputGraphTuple->get_Travel_time_av_person(&travel_time_av_person);
        ```

    === "Python"

        ```python
        travel_time_av_person = outputGraphTuple.Travel_time_av_person
        ```

### Travel_speed_ped {#travel_speed_ped}

```csharp
float Travel_speed_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed_ped = outputGraphTuple.Travel_speed_ped;
        ```

    === "C++"

        ```cpp
        double travel_speed_ped;
        outputGraphTuple->get_Travel_speed_ped(&travel_speed_ped);
        ```

    === "Python"

        ```python
        travel_speed_ped = outputGraphTuple.Travel_speed_ped
        ```

### Travel_speed_person {#travel_speed_person}

```csharp
float Travel_speed_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed_person = outputGraphTuple.Travel_speed_person;
        ```

    === "C++"

        ```cpp
        double travel_speed_person;
        outputGraphTuple->get_Travel_speed_person(&travel_speed_person);
        ```

    === "Python"

        ```python
        travel_speed_person = outputGraphTuple.Travel_speed_person
        ```

### Operating_cost_total_veh {#operating_cost_total_veh}

```csharp
float Operating_cost_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total_veh = outputGraphTuple.Operating_cost_total_veh;
        ```

    === "C++"

        ```cpp
        double operating_cost_total_veh;
        outputGraphTuple->get_Operating_cost_total_veh(&operating_cost_total_veh);
        ```

    === "Python"

        ```python
        operating_cost_total_veh = outputGraphTuple.Operating_cost_total_veh
        ```

### Operating_cost_total_ped {#operating_cost_total_ped}

```csharp
float Operating_cost_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total_ped = outputGraphTuple.Operating_cost_total_ped;
        ```

    === "C++"

        ```cpp
        double operating_cost_total_ped;
        outputGraphTuple->get_Operating_cost_total_ped(&operating_cost_total_ped);
        ```

    === "Python"

        ```python
        operating_cost_total_ped = outputGraphTuple.Operating_cost_total_ped
        ```

### Arrival_flow_total {#arrival_flow_total}

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputGraphTuple.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputGraphTuple->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputGraphTuple.Arrival_flow_total
        ```

### Arrival_flow_total_person {#arrival_flow_total_person}

```csharp
float Arrival_flow_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total_person = outputGraphTuple.Arrival_flow_total_person;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total_person;
        outputGraphTuple->get_Arrival_flow_total_person(&arrival_flow_total_person);
        ```

    === "Python"

        ```python
        arrival_flow_total_person = outputGraphTuple.Arrival_flow_total_person
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputGraphTuple.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputGraphTuple->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputGraphTuple.SpeedEfficiency
        ```

### Level_of_service {#level_of_service}

```csharp
int Level_of_service { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service = outputGraphTuple.Level_of_service;
        ```

    === "C++"

        ```cpp
        long level_of_service;
        outputGraphTuple->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputGraphTuple.Level_of_service
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputgraphtuples.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputGraphTuples
title: OutputGraphTuples
name: ISIAPIOutputGraphTuples
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0D958FB6-F029-4960-863C-E82DA56C88B3
members:
  - ISIAPIOutputGraphTuple this[int index]
  - int Count
---

# OutputGraphTuples

Type `ISIAPIOutputGraphTuples` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0D958FB6-F029-4960-863C-E82DA56C88B3`

## Declaration

```csharp
[Guid("0D958FB6-F029-4960-863C-E82DA56C88B3")]
public interface ISIAPIOutputGraphTuples
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputGraphTuple`](sidrasolutions.si.api.isiapioutputgraphtuple.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputGraphTuples.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputGraphTuples->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputGraphTuples.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputGraphTuple this[] { get; }
```

**Type** [`ISIAPIOutputGraphTuple`](sidrasolutions.si.api.isiapioutputgraphtuple.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputGraphTuples.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputGraphTuple> this[];
        outputGraphTuples->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputGraphTuples.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlane.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLane
title: OutputLane
name: ISIAPIOutputLane
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 27D7E87B-7177-4082-B094-FE48D3E6A78F
summary: SIDRA INTERSECTION Output Lane wrapper interface
members:
  - int Orientation
  - int Laneno
  - float Capacity
  - float Capacity_end_deps
  - float Capacity_min
  - float Delay_ctrl
  - float Delay_geo
  - float Delay_idle
  - float Delay_model_1
  - float Delay_model_2
  - float Delay_n
  - float Delay_q
  - float Flow_total
  - float Flow_LV
  - float Flow_HV
  - float Flow_HV_pct
  - float Flow_total_capconstr
  - float Flow_LV_capconstr
  - float Flow_HV_capconstr
  - float Flow_HV_pct_capconstr
  - float Prop_queued
  - float Prob_blockage
  - float Queue_space
  - float Queue_cycav_1
  - float Queue_cycav_2
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_maxback_1
  - float Queue_maxback_2
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_overflow
  - float Satflow_basic
  - float Satflow_scats
  - float Satflow_scats_mf
  - bool Shortlane_flow_moved
  - float Stoprate_1
  - float Stoprate_2
  - float Stoprate_geo
  - float Stoprate_overall
  - float Stoprate_qmovup
  - bool T2_reduced
  - int Underutil_flag
  - float Util_factor
  - string Level_of_service
  - bool Capacity_shortlane_affected
  - int X1_flag
  - float Deg_satn
  - float Delay_acc_dec_dn
  - float Delay_queue_moveup
  - float Queue_storage_ratio_percentile
  - float Queue_storage_ratio_avg
  - float Total_stops
  - int Flag_na
  - float Satn_speed
  - float Satn_flow
  - float Satn_headway
  - float Satn_spacing
  - float Average_queue_space
  - float Driver_response_time
  - bool Is_dominant
  - float Capacity_adj
  - int Capacity_adj_flag
  - ISIAPIOutputLaneODs OutputLaneODs
  - ISIAPIOutputLaneGreenPeriods OutputLaneGreenPeriods
  - ISIAPIOutputLeg OutputLeg
  - ISIAPIOutputLaneMCs OutputLaneMCs
  - float Lane_block_adj
  - float Residual_demand_vol
  - float Initial_demand_vol_clear_time
  - float Residual_demand_vol_clear_time
  - float Oversatn_duration
  - float Stop_rate
  - float Perc_arriving_during_green
  - float Platoon_ratio
  - float Progression_factor_delay
  - float Progression_factor_queue
  - float Headway_scats_mf
  - float Occupancy_scats_mf
  - float Space_scats_mf
  - int Calc_mf_flag
  - int Queue_constraint_flag
  - int Green_periods
  - float Upstr_flow_after_exit_sl
  - float Lane_change_from_left
  - float Lane_change_to_left
  - float Lane_change_from_right
  - float Lane_change_to_right
  - bool Is_nw_connected
  - float Net_inflow
  - float Net_inflow_capconstr
  - int Arrival_flow_flag
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Initial_demand_vol
  - float Avg_num_of_cycles_to_depart
  - float Prob_shortlane_overflow
  - float Satflow_basic_adj
  - float Adjfactor_lanewidth
  - float Adjfactor_grade
  - float Adjfactor_parking
  - float Adjfactor_buses
  - float Adjfactor_flowscale
  - float Adjfactor_trafficflow
  - int Equivalent_AT
  - int Control_type
  - int Contlane_affect_by_adjshortlane
  - float Opposing_ped_factor
  - float Unblocked_time_ratio
  - float Gap_accept_cycle_time
  - float Gap_accept_blocked_time
  - float Gap_accept_unblocked_time
  - float Minimum_delay
  - float Queue_dist_overflow
  - float SpeedEfficiency
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - float Uninterrupted_speed
  - float Density
  - float Spacing
  - float Headway
  - float Occupancy_time
  - float Space_time
  - float Avg_veh_length
  - float Space_occupancy_ratio
  - float Time_occupancy_ratio
  - float Uninterrupted_travel_delay
  - float Queue_unrestr_mean
  - float Cum_storage_space
  - int Queue_maxback_mean_flag
  - int Queue_maxback_percentile_flag
  - int LOS_density
  - float Density_pcu
  - float Excess_queue_from_downstream_merge_mean
  - float Excess_queue_from_downstream_merge_percentile
  - float Excess_queue_dist_from_downstream_merge_mean
  - float Excess_queue_dist_from_downstream_merge_percentile
  - ISIAPIOutputLaneUnsignalPed OutputLaneUnsignalPed
---

# OutputLane

Type `ISIAPIOutputLane` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `27D7E87B-7177-4082-B094-FE48D3E6A78F`

SIDRA INTERSECTION Output Lane wrapper interface

## Declaration

```csharp
[Guid("27D7E87B-7177-4082-B094-FE48D3E6A78F")]
public interface ISIAPIOutputLane
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` |  |
| [Laneno](#laneno) | `int` | Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure. |
| [Capacity](#capacity) | `float` | Capacity (veh/h) total for both green periods. |
| [Capacity_end_deps](#capacity_end_deps) | `float` | Capacity (veh/h) due to "end departures" (Signals only). |
| [Capacity_min](#capacity_min) | `float` | Minimum Capacity (veh/h) (Roundabouts/Sign Control only). |
| [Delay_ctrl](#delay_ctrl) | `float` | Average control delay (sec/veh). |
| [Delay_geo](#delay_geo) | `float` | Geometric delay (sec/veh). |
| [Delay_idle](#delay_idle) | `float` | Idle delay (sec/veh). |
| [Delay_model_1](#delay_model_1) | `float` | Model delay (sec/veh) 1st term. |
| [Delay_model_2](#delay_model_2) | `float` | Model delay (sec/veh) 2nd term. |
| [Delay_n](#delay_n) | `float` | Accel/Decel delay (the difference between "stopped" delay and model delay). LV value only used. |
| [Delay_q](#delay_q) | `float` | "Queuing" ("stopped") delay. |
| [Flow_total](#flow_total) | `float` | Total Demand Flow Rate. |
| [Flow_LV](#flow_lv) | `float` | Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV](#flow_hv) | `float` | Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct](#flow_hv_pct) | `float` | Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` | Total Arrival Flow Rate. |
| [Flow_LV_capconstr](#flow_lv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV_capconstr](#flow_hv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct_capconstr](#flow_hv_pct_capconstr) | `float` | Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Prop_queued](#prop_queued) | `float` | Proportion queued. |
| [Prob_blockage](#prob_blockage) | `float` | Probability of blockage. |
| [Queue_space](#queue_space) | `float` | Queue space averaged over LV & HV in the lane. |
| [Queue_cycav_1](#queue_cycav_1) | `float` | Cycle-average queue (veh), 1st term. |
| [Queue_cycav_2](#queue_cycav_2) | `float` | Cycle-average queue (veh), 2nd term. |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` | Cycle-average queue (veh), mean. |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` | Cycle-average queue (veh), user-specified percentile. |
| [Queue_maxback_1](#queue_maxback_1) | `float` | Maximum back of queue (veh), 1st term. |
| [Queue_maxback_2](#queue_maxback_2) | `float` | Maximum back of queue (veh), 2nd term. |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` | Maximum back of queue (veh), mean. |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` | Maximum back of queue (veh), user-specified percentile. |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` | Maximum back of queue (distance), mean. |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` | Maximum back of queue (distance), user-specified percentile. |
| [Queue_overflow](#queue_overflow) | `float` | Overflow queue (veh). |
| [Satflow_basic](#satflow_basic) | `float` | "Adjusted Basic" saturation flow (tcu). |
| [Satflow_scats](#satflow_scats) | `float` | "SCATS" saturation flow. |
| [Satflow_scats_mf](#satflow_scats_mf) | `float` | "SCATS" MF. |
| [Shortlane_flow_moved](#shortlane_flow_moved) | `bool` | Flag indicating if flow moved out of this lane to adjacent lane due to short lane effects. |
| [Stoprate_1](#stoprate_1) | `float` | Stop rate 1st term. |
| [Stoprate_2](#stoprate_2) | `float` | Stop rate 2nd term. |
| [Stoprate_geo](#stoprate_geo) | `float` | "Geometric" stop rate. |
| [Stoprate_overall](#stoprate_overall) | `float` | Overall Stop Rate. |
| [Stoprate_qmovup](#stoprate_qmovup) | `float` | Queue move up rate (sum of both green periods). |
| [T2_reduced](#t2_reduced) | `bool` | Flag indicating if second terms reduced due to short lane effects. |
| [Underutil_flag](#underutil_flag) | `int` | Reason for lane underutilisation. |
| [Util_factor](#util_factor) | `float` | Utilisation factor determined by the program. |
| [Level_of_service](#level_of_service) | `string` | Lane LOS. |
| [Capacity_shortlane_affected](#capacity_shortlane_affected) | `bool` | Flag indicating if short lane affects capacity. |
| [X1_flag](#x1_flag) | `int` | Degree of saturation = 1 flag. |
| [Deg_satn](#deg_satn) | `float` |  |
| [Delay_acc_dec_dn](#delay_acc_dec_dn) | `float` |  |
| [Delay_queue_moveup](#delay_queue_moveup) | `float` |  |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` | Queue storage ratio based on maximum back of queue (distance), user-specified percentile |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` | Queue storage ratio based on maximum back of queue (distance), mean |
| [Total_stops](#total_stops) | `float` |  |
| [Flag_na](#flag_na) | `int` |  |
| [Satn_speed](#satn_speed) | `float` |  |
| [Satn_flow](#satn_flow) | `float` |  |
| [Satn_headway](#satn_headway) | `float` |  |
| [Satn_spacing](#satn_spacing) | `float` |  |
| [Average_queue_space](#average_queue_space) | `float` |  |
| [Driver_response_time](#driver_response_time) | `float` |  |
| [Is_dominant](#is_dominant) | `bool` |  |
| [Capacity_adj](#capacity_adj) | `float` |  |
| [Capacity_adj_flag](#capacity_adj_flag) | `int` |  |
| [OutputLaneODs](#outputlaneods) | [`ISIAPIOutputLaneODs`](sidrasolutions.si.api.isiapioutputlaneods.md) |  |
| [OutputLaneGreenPeriods](#outputlanegreenperiods) | [`ISIAPIOutputLaneGreenPeriods`](sidrasolutions.si.api.isiapioutputlanegreenperiods.md) |  |
| [OutputLeg](#outputleg) | [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md) |  |
| [OutputLaneMCs](#outputlanemcs) | [`ISIAPIOutputLaneMCs`](sidrasolutions.si.api.isiapioutputlanemcs.md) |  |
| [Lane_block_adj](#lane_block_adj) | `float` |  |
| [Residual_demand_vol](#residual_demand_vol) | `float` |  |
| [Initial_demand_vol_clear_time](#initial_demand_vol_clear_time) | `float` |  |
| [Residual_demand_vol_clear_time](#residual_demand_vol_clear_time) | `float` |  |
| [Oversatn_duration](#oversatn_duration) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Perc_arriving_during_green](#perc_arriving_during_green) | `float` |  |
| [Platoon_ratio](#platoon_ratio) | `float` |  |
| [Progression_factor_delay](#progression_factor_delay) | `float` |  |
| [Progression_factor_queue](#progression_factor_queue) | `float` |  |
| [Headway_scats_mf](#headway_scats_mf) | `float` |  |
| [Occupancy_scats_mf](#occupancy_scats_mf) | `float` |  |
| [Space_scats_mf](#space_scats_mf) | `float` |  |
| [Calc_mf_flag](#calc_mf_flag) | `int` |  |
| [Queue_constraint_flag](#queue_constraint_flag) | `int` |  |
| [Green_periods](#green_periods) | `int` |  |
| [Upstr_flow_after_exit_sl](#upstr_flow_after_exit_sl) | `float` |  |
| [Lane_change_from_left](#lane_change_from_left) | `float` |  |
| [Lane_change_to_left](#lane_change_to_left) | `float` |  |
| [Lane_change_from_right](#lane_change_from_right) | `float` |  |
| [Lane_change_to_right](#lane_change_to_right) | `float` |  |
| [Is_nw_connected](#is_nw_connected) | `bool` |  |
| [Net_inflow](#net_inflow) | `float` |  |
| [Net_inflow_capconstr](#net_inflow_capconstr) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` |  |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Initial_demand_vol](#initial_demand_vol) | `float` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Prob_shortlane_overflow](#prob_shortlane_overflow) | `float` |  |
| [Satflow_basic_adj](#satflow_basic_adj) | `float` |  |
| [Adjfactor_lanewidth](#adjfactor_lanewidth) | `float` |  |
| [Adjfactor_grade](#adjfactor_grade) | `float` |  |
| [Adjfactor_parking](#adjfactor_parking) | `float` |  |
| [Adjfactor_buses](#adjfactor_buses) | `float` |  |
| [Adjfactor_flowscale](#adjfactor_flowscale) | `float` |  |
| [Adjfactor_trafficflow](#adjfactor_trafficflow) | `float` |  |
| [Equivalent_AT](#equivalent_at) | `int` |  |
| [Control_type](#control_type) | `int` |  |
| [Contlane_affect_by_adjshortlane](#contlane_affect_by_adjshortlane) | `int` |  |
| [Opposing_ped_factor](#opposing_ped_factor) | `float` |  |
| [Unblocked_time_ratio](#unblocked_time_ratio) | `float` |  |
| [Gap_accept_cycle_time](#gap_accept_cycle_time) | `float` |  |
| [Gap_accept_blocked_time](#gap_accept_blocked_time) | `float` |  |
| [Gap_accept_unblocked_time](#gap_accept_unblocked_time) | `float` |  |
| [Minimum_delay](#minimum_delay) | `float` |  |
| [Queue_dist_overflow](#queue_dist_overflow) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [Uninterrupted_speed](#uninterrupted_speed) | `float` |  |
| [Density](#density) | `float` |  |
| [Spacing](#spacing) | `float` |  |
| [Headway](#headway) | `float` |  |
| [Occupancy_time](#occupancy_time) | `float` |  |
| [Space_time](#space_time) | `float` |  |
| [Avg_veh_length](#avg_veh_length) | `float` |  |
| [Space_occupancy_ratio](#space_occupancy_ratio) | `float` |  |
| [Time_occupancy_ratio](#time_occupancy_ratio) | `float` |  |
| [Uninterrupted_travel_delay](#uninterrupted_travel_delay) | `float` |  |
| [Queue_unrestr_mean](#queue_unrestr_mean) | `float` |  |
| [Cum_storage_space](#cum_storage_space) | `float` |  |
| [Queue_maxback_mean_flag](#queue_maxback_mean_flag) | `int` |  |
| [Queue_maxback_percentile_flag](#queue_maxback_percentile_flag) | `int` |  |
| [LOS_density](#los_density) | `int` |  |
| [Density_pcu](#density_pcu) | `float` |  |
| [Excess_queue_from_downstream_merge_mean](#excess_queue_from_downstream_merge_mean) | `float` |  |
| [Excess_queue_from_downstream_merge_percentile](#excess_queue_from_downstream_merge_percentile) | `float` |  |
| [Excess_queue_dist_from_downstream_merge_mean](#excess_queue_dist_from_downstream_merge_mean) | `float` |  |
| [Excess_queue_dist_from_downstream_merge_percentile](#excess_queue_dist_from_downstream_merge_percentile) | `float` |  |
| [OutputLaneUnsignalPed](#outputlaneunsignalped) | [`ISIAPIOutputLaneUnsignalPed`](sidrasolutions.si.api.isiapioutputlaneunsignalped.md) |  |

</div>

## Properties

### Orientation {#orientation}

```csharp
int Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = outputLane.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        outputLane->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = outputLane.Orientation
        ```

### Laneno {#laneno}

Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure.

```csharp
int Laneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int laneno = outputLane.Laneno;
        ```

    === "C++"

        ```cpp
        long laneno;
        outputLane->get_Laneno(&laneno);
        ```

    === "Python"

        ```python
        laneno = outputLane.Laneno
        ```

### Capacity {#capacity}

Capacity (veh/h) total for both green periods.

```csharp
float Capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity = outputLane.Capacity;
        ```

    === "C++"

        ```cpp
        double capacity;
        outputLane->get_Capacity(&capacity);
        ```

    === "Python"

        ```python
        capacity = outputLane.Capacity
        ```

### Capacity_end_deps {#capacity_end_deps}

Capacity (veh/h) due to "end departures" (Signals only).

```csharp
float Capacity_end_deps { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_end_deps = outputLane.Capacity_end_deps;
        ```

    === "C++"

        ```cpp
        double capacity_end_deps;
        outputLane->get_Capacity_end_deps(&capacity_end_deps);
        ```

    === "Python"

        ```python
        capacity_end_deps = outputLane.Capacity_end_deps
        ```

### Capacity_min {#capacity_min}

Minimum Capacity (veh/h) (Roundabouts/Sign Control only).

```csharp
float Capacity_min { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_min = outputLane.Capacity_min;
        ```

    === "C++"

        ```cpp
        double capacity_min;
        outputLane->get_Capacity_min(&capacity_min);
        ```

    === "Python"

        ```python
        capacity_min = outputLane.Capacity_min
        ```

### Delay_ctrl {#delay_ctrl}

Average control delay (sec/veh).

```csharp
float Delay_ctrl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_ctrl = outputLane.Delay_ctrl;
        ```

    === "C++"

        ```cpp
        double delay_ctrl;
        outputLane->get_Delay_ctrl(&delay_ctrl);
        ```

    === "Python"

        ```python
        delay_ctrl = outputLane.Delay_ctrl
        ```

### Delay_geo {#delay_geo}

Geometric delay (sec/veh).

```csharp
float Delay_geo { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geo = outputLane.Delay_geo;
        ```

    === "C++"

        ```cpp
        double delay_geo;
        outputLane->get_Delay_geo(&delay_geo);
        ```

    === "Python"

        ```python
        delay_geo = outputLane.Delay_geo
        ```

### Delay_idle {#delay_idle}

Idle delay (sec/veh).

```csharp
float Delay_idle { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_idle = outputLane.Delay_idle;
        ```

    === "C++"

        ```cpp
        double delay_idle;
        outputLane->get_Delay_idle(&delay_idle);
        ```

    === "Python"

        ```python
        delay_idle = outputLane.Delay_idle
        ```

### Delay_model_1 {#delay_model_1}

Model delay (sec/veh) 1st term.

```csharp
float Delay_model_1 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_model_1 = outputLane.Delay_model_1;
        ```

    === "C++"

        ```cpp
        double delay_model_1;
        outputLane->get_Delay_model_1(&delay_model_1);
        ```

    === "Python"

        ```python
        delay_model_1 = outputLane.Delay_model_1
        ```

### Delay_model_2 {#delay_model_2}

Model delay (sec/veh) 2nd term.

```csharp
float Delay_model_2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_model_2 = outputLane.Delay_model_2;
        ```

    === "C++"

        ```cpp
        double delay_model_2;
        outputLane->get_Delay_model_2(&delay_model_2);
        ```

    === "Python"

        ```python
        delay_model_2 = outputLane.Delay_model_2
        ```

### Delay_n {#delay_n}

Accel/Decel delay (the difference between "stopped" delay and model delay). LV
value only used.

```csharp
float Delay_n { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_n = outputLane.Delay_n;
        ```

    === "C++"

        ```cpp
        double delay_n;
        outputLane->get_Delay_n(&delay_n);
        ```

    === "Python"

        ```python
        delay_n = outputLane.Delay_n
        ```

### Delay_q {#delay_q}

"Queuing" ("stopped") delay.

```csharp
float Delay_q { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_q = outputLane.Delay_q;
        ```

    === "C++"

        ```cpp
        double delay_q;
        outputLane->get_Delay_q(&delay_q);
        ```

    === "Python"

        ```python
        delay_q = outputLane.Delay_q
        ```

### Flow_total {#flow_total}

Total Demand Flow Rate.

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputLane.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputLane->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputLane.Flow_total
        ```

### Flow_LV {#flow_lv}

Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV = outputLane.Flow_LV;
        ```

    === "C++"

        ```cpp
        double flow_LV;
        outputLane->get_Flow_LV(&flow_LV);
        ```

    === "Python"

        ```python
        flow_lv = outputLane.Flow_LV
        ```

### Flow_HV {#flow_hv}

Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV = outputLane.Flow_HV;
        ```

    === "C++"

        ```cpp
        double flow_HV;
        outputLane->get_Flow_HV(&flow_HV);
        ```

    === "Python"

        ```python
        flow_hv = outputLane.Flow_HV
        ```

### Flow_HV_pct {#flow_hv_pct}

Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct = outputLane.Flow_HV_pct;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct;
        outputLane->get_Flow_HV_pct(&flow_HV_pct);
        ```

    === "Python"

        ```python
        flow_hv_pct = outputLane.Flow_HV_pct
        ```

### Flow_total_capconstr {#flow_total_capconstr}

Total Arrival Flow Rate.

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputLane.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputLane->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputLane.Flow_total_capconstr
        ```

### Flow_LV_capconstr {#flow_lv_capconstr}

Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV_capconstr = outputLane.Flow_LV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_LV_capconstr;
        outputLane->get_Flow_LV_capconstr(&flow_LV_capconstr);
        ```

    === "Python"

        ```python
        flow_lv_capconstr = outputLane.Flow_LV_capconstr
        ```

### Flow_HV_capconstr {#flow_hv_capconstr}

Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_capconstr = outputLane.Flow_HV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_capconstr;
        outputLane->get_Flow_HV_capconstr(&flow_HV_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_capconstr = outputLane.Flow_HV_capconstr
        ```

### Flow_HV_pct_capconstr {#flow_hv_pct_capconstr}

Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct_capconstr = outputLane.Flow_HV_pct_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct_capconstr;
        outputLane->get_Flow_HV_pct_capconstr(&flow_HV_pct_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_pct_capconstr = outputLane.Flow_HV_pct_capconstr
        ```

### Prop_queued {#prop_queued}

Proportion queued.

```csharp
float Prop_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued = outputLane.Prop_queued;
        ```

    === "C++"

        ```cpp
        double prop_queued;
        outputLane->get_Prop_queued(&prop_queued);
        ```

    === "Python"

        ```python
        prop_queued = outputLane.Prop_queued
        ```

### Prob_blockage {#prob_blockage}

Probability of blockage.

```csharp
float Prob_blockage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_blockage = outputLane.Prob_blockage;
        ```

    === "C++"

        ```cpp
        double prob_blockage;
        outputLane->get_Prob_blockage(&prob_blockage);
        ```

    === "Python"

        ```python
        prob_blockage = outputLane.Prob_blockage
        ```

### Queue_space {#queue_space}

Queue space averaged over LV & HV in the lane.

```csharp
float Queue_space { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_space = outputLane.Queue_space;
        ```

    === "C++"

        ```cpp
        double queue_space;
        outputLane->get_Queue_space(&queue_space);
        ```

    === "Python"

        ```python
        queue_space = outputLane.Queue_space
        ```

### Queue_cycav_1 {#queue_cycav_1}

Cycle-average queue (veh), 1st term.

```csharp
float Queue_cycav_1 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_1 = outputLane.Queue_cycav_1;
        ```

    === "C++"

        ```cpp
        double queue_cycav_1;
        outputLane->get_Queue_cycav_1(&queue_cycav_1);
        ```

    === "Python"

        ```python
        queue_cycav_1 = outputLane.Queue_cycav_1
        ```

### Queue_cycav_2 {#queue_cycav_2}

Cycle-average queue (veh), 2nd term.

```csharp
float Queue_cycav_2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_2 = outputLane.Queue_cycav_2;
        ```

    === "C++"

        ```cpp
        double queue_cycav_2;
        outputLane->get_Queue_cycav_2(&queue_cycav_2);
        ```

    === "Python"

        ```python
        queue_cycav_2 = outputLane.Queue_cycav_2
        ```

### Queue_cycav_mean {#queue_cycav_mean}

Cycle-average queue (veh), mean.

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputLane.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputLane->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputLane.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

Cycle-average queue (veh), user-specified percentile.

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputLane.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputLane->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputLane.Queue_cycav_percentile
        ```

### Queue_maxback_1 {#queue_maxback_1}

Maximum back of queue (veh), 1st term.

```csharp
float Queue_maxback_1 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_1 = outputLane.Queue_maxback_1;
        ```

    === "C++"

        ```cpp
        double queue_maxback_1;
        outputLane->get_Queue_maxback_1(&queue_maxback_1);
        ```

    === "Python"

        ```python
        queue_maxback_1 = outputLane.Queue_maxback_1
        ```

### Queue_maxback_2 {#queue_maxback_2}

Maximum back of queue (veh), 2nd term.

```csharp
float Queue_maxback_2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_2 = outputLane.Queue_maxback_2;
        ```

    === "C++"

        ```cpp
        double queue_maxback_2;
        outputLane->get_Queue_maxback_2(&queue_maxback_2);
        ```

    === "Python"

        ```python
        queue_maxback_2 = outputLane.Queue_maxback_2
        ```

### Queue_maxback_mean {#queue_maxback_mean}

Maximum back of queue (veh), mean.

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputLane.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputLane->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputLane.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

Maximum back of queue (veh), user-specified percentile.

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputLane.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputLane->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputLane.Queue_maxback_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

Maximum back of queue (distance), mean.

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputLane.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputLane->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputLane.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

Maximum back of queue (distance), user-specified percentile.

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputLane.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputLane->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputLane.Queue_dist_maxback_percentile
        ```

### Queue_overflow {#queue_overflow}

Overflow queue (veh).

```csharp
float Queue_overflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_overflow = outputLane.Queue_overflow;
        ```

    === "C++"

        ```cpp
        double queue_overflow;
        outputLane->get_Queue_overflow(&queue_overflow);
        ```

    === "Python"

        ```python
        queue_overflow = outputLane.Queue_overflow
        ```

### Satflow_basic {#satflow_basic}

"Adjusted Basic" saturation flow (tcu).

```csharp
float Satflow_basic { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_basic = outputLane.Satflow_basic;
        ```

    === "C++"

        ```cpp
        double satflow_basic;
        outputLane->get_Satflow_basic(&satflow_basic);
        ```

    === "Python"

        ```python
        satflow_basic = outputLane.Satflow_basic
        ```

### Satflow_scats {#satflow_scats}

"SCATS" saturation flow.

```csharp
float Satflow_scats { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_scats = outputLane.Satflow_scats;
        ```

    === "C++"

        ```cpp
        double satflow_scats;
        outputLane->get_Satflow_scats(&satflow_scats);
        ```

    === "Python"

        ```python
        satflow_scats = outputLane.Satflow_scats
        ```

### Satflow_scats_mf {#satflow_scats_mf}

"SCATS" MF.

```csharp
float Satflow_scats_mf { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_scats_mf = outputLane.Satflow_scats_mf;
        ```

    === "C++"

        ```cpp
        double satflow_scats_mf;
        outputLane->get_Satflow_scats_mf(&satflow_scats_mf);
        ```

    === "Python"

        ```python
        satflow_scats_mf = outputLane.Satflow_scats_mf
        ```

### Shortlane_flow_moved {#shortlane_flow_moved}

Flag indicating if flow moved out of this lane to adjacent lane due to short lane
effects.

```csharp
bool Shortlane_flow_moved { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool shortlane_flow_moved = outputLane.Shortlane_flow_moved;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL shortlane_flow_moved;
        outputLane->get_Shortlane_flow_moved(&shortlane_flow_moved);
        ```

    === "Python"

        ```python
        shortlane_flow_moved = outputLane.Shortlane_flow_moved
        ```

### Stoprate_1 {#stoprate_1}

Stop rate 1st term.

```csharp
float Stoprate_1 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoprate_1 = outputLane.Stoprate_1;
        ```

    === "C++"

        ```cpp
        double stoprate_1;
        outputLane->get_Stoprate_1(&stoprate_1);
        ```

    === "Python"

        ```python
        stoprate_1 = outputLane.Stoprate_1
        ```

### Stoprate_2 {#stoprate_2}

Stop rate 2nd term.

```csharp
float Stoprate_2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoprate_2 = outputLane.Stoprate_2;
        ```

    === "C++"

        ```cpp
        double stoprate_2;
        outputLane->get_Stoprate_2(&stoprate_2);
        ```

    === "Python"

        ```python
        stoprate_2 = outputLane.Stoprate_2
        ```

### Stoprate_geo {#stoprate_geo}

"Geometric" stop rate.

```csharp
float Stoprate_geo { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoprate_geo = outputLane.Stoprate_geo;
        ```

    === "C++"

        ```cpp
        double stoprate_geo;
        outputLane->get_Stoprate_geo(&stoprate_geo);
        ```

    === "Python"

        ```python
        stoprate_geo = outputLane.Stoprate_geo
        ```

### Stoprate_overall {#stoprate_overall}

Overall Stop Rate.

```csharp
float Stoprate_overall { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoprate_overall = outputLane.Stoprate_overall;
        ```

    === "C++"

        ```cpp
        double stoprate_overall;
        outputLane->get_Stoprate_overall(&stoprate_overall);
        ```

    === "Python"

        ```python
        stoprate_overall = outputLane.Stoprate_overall
        ```

### Stoprate_qmovup {#stoprate_qmovup}

Queue move up rate (sum of both green periods).

```csharp
float Stoprate_qmovup { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stoprate_qmovup = outputLane.Stoprate_qmovup;
        ```

    === "C++"

        ```cpp
        double stoprate_qmovup;
        outputLane->get_Stoprate_qmovup(&stoprate_qmovup);
        ```

    === "Python"

        ```python
        stoprate_qmovup = outputLane.Stoprate_qmovup
        ```

### T2_reduced {#t2_reduced}

Flag indicating if second terms reduced due to short lane effects.

```csharp
bool T2_reduced { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool t2_reduced = outputLane.T2_reduced;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL t2_reduced;
        outputLane->get_T2_reduced(&t2_reduced);
        ```

    === "Python"

        ```python
        t2_reduced = outputLane.T2_reduced
        ```

### Underutil_flag {#underutil_flag}

Reason for lane underutilisation.

```csharp
int Underutil_flag { get; }
```

**Type** `int`

**Value**

One of:

- `0` - not underutilised
- `1` - program
- `2` - downstream
- `3` - user-specified

???- example "Code samples"

    === "C#"

        ```csharp
        int underutil_flag = outputLane.Underutil_flag;
        ```

    === "C++"

        ```cpp
        long underutil_flag;
        outputLane->get_Underutil_flag(&underutil_flag);
        ```

    === "Python"

        ```python
        underutil_flag = outputLane.Underutil_flag
        ```

### Util_factor {#util_factor}

Utilisation factor determined by the program.

```csharp
float Util_factor { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float util_factor = outputLane.Util_factor;
        ```

    === "C++"

        ```cpp
        double util_factor;
        outputLane->get_Util_factor(&util_factor);
        ```

    === "Python"

        ```python
        util_factor = outputLane.Util_factor
        ```

### Level_of_service {#level_of_service}

Lane LOS.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputLane.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputLane->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputLane.Level_of_service
        ```

### Capacity_shortlane_affected {#capacity_shortlane_affected}

Flag indicating if short lane affects capacity.

```csharp
bool Capacity_shortlane_affected { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool capacity_shortlane_affected = outputLane.Capacity_shortlane_affected;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL capacity_shortlane_affected;
        outputLane->get_Capacity_shortlane_affected(&capacity_shortlane_affected);
        ```

    === "Python"

        ```python
        capacity_shortlane_affected = outputLane.Capacity_shortlane_affected
        ```

### X1_flag {#x1_flag}

Degree of saturation = 1 flag.

```csharp
int X1_flag { get; }
```

**Type** `int`

**Value**

One of:

- `0` - x != 1
- `1` - x = 1 due to short lane
- `2` - x = 1 due to minimum capacity

???- example "Code samples"

    === "C#"

        ```csharp
        int x1_flag = outputLane.X1_flag;
        ```

    === "C++"

        ```cpp
        long x1_flag;
        outputLane->get_X1_flag(&x1_flag);
        ```

    === "Python"

        ```python
        x1_flag = outputLane.X1_flag
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputLane.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputLane->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputLane.Deg_satn
        ```

### Delay_acc_dec_dn {#delay_acc_dec_dn}

```csharp
float Delay_acc_dec_dn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_acc_dec_dn = outputLane.Delay_acc_dec_dn;
        ```

    === "C++"

        ```cpp
        double delay_acc_dec_dn;
        outputLane->get_Delay_acc_dec_dn(&delay_acc_dec_dn);
        ```

    === "Python"

        ```python
        delay_acc_dec_dn = outputLane.Delay_acc_dec_dn
        ```

### Delay_queue_moveup {#delay_queue_moveup}

```csharp
float Delay_queue_moveup { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_queue_moveup = outputLane.Delay_queue_moveup;
        ```

    === "C++"

        ```cpp
        double delay_queue_moveup;
        outputLane->get_Delay_queue_moveup(&delay_queue_moveup);
        ```

    === "Python"

        ```python
        delay_queue_moveup = outputLane.Delay_queue_moveup
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

Queue storage ratio based on maximum back of queue (distance), user-specified percentile

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputLane.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputLane->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputLane.Queue_storage_ratio_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

Queue storage ratio based on maximum back of queue (distance), mean

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputLane.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputLane->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputLane.Queue_storage_ratio_avg
        ```

### Total_stops {#total_stops}

```csharp
float Total_stops { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops = outputLane.Total_stops;
        ```

    === "C++"

        ```cpp
        double total_stops;
        outputLane->get_Total_stops(&total_stops);
        ```

    === "Python"

        ```python
        total_stops = outputLane.Total_stops
        ```

### Flag_na {#flag_na}

```csharp
int Flag_na { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int flag_na = outputLane.Flag_na;
        ```

    === "C++"

        ```cpp
        long flag_na;
        outputLane->get_Flag_na(&flag_na);
        ```

    === "Python"

        ```python
        flag_na = outputLane.Flag_na
        ```

### Satn_speed {#satn_speed}

```csharp
float Satn_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_speed = outputLane.Satn_speed;
        ```

    === "C++"

        ```cpp
        double satn_speed;
        outputLane->get_Satn_speed(&satn_speed);
        ```

    === "Python"

        ```python
        satn_speed = outputLane.Satn_speed
        ```

### Satn_flow {#satn_flow}

```csharp
float Satn_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_flow = outputLane.Satn_flow;
        ```

    === "C++"

        ```cpp
        double satn_flow;
        outputLane->get_Satn_flow(&satn_flow);
        ```

    === "Python"

        ```python
        satn_flow = outputLane.Satn_flow
        ```

### Satn_headway {#satn_headway}

```csharp
float Satn_headway { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_headway = outputLane.Satn_headway;
        ```

    === "C++"

        ```cpp
        double satn_headway;
        outputLane->get_Satn_headway(&satn_headway);
        ```

    === "Python"

        ```python
        satn_headway = outputLane.Satn_headway
        ```

### Satn_spacing {#satn_spacing}

```csharp
float Satn_spacing { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_spacing = outputLane.Satn_spacing;
        ```

    === "C++"

        ```cpp
        double satn_spacing;
        outputLane->get_Satn_spacing(&satn_spacing);
        ```

    === "Python"

        ```python
        satn_spacing = outputLane.Satn_spacing
        ```

### Average_queue_space {#average_queue_space}

```csharp
float Average_queue_space { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float average_queue_space = outputLane.Average_queue_space;
        ```

    === "C++"

        ```cpp
        double average_queue_space;
        outputLane->get_Average_queue_space(&average_queue_space);
        ```

    === "Python"

        ```python
        average_queue_space = outputLane.Average_queue_space
        ```

### Driver_response_time {#driver_response_time}

```csharp
float Driver_response_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float driver_response_time = outputLane.Driver_response_time;
        ```

    === "C++"

        ```cpp
        double driver_response_time;
        outputLane->get_Driver_response_time(&driver_response_time);
        ```

    === "Python"

        ```python
        driver_response_time = outputLane.Driver_response_time
        ```

### Is_dominant {#is_dominant}

```csharp
bool Is_dominant { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_dominant = outputLane.Is_dominant;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_dominant;
        outputLane->get_Is_dominant(&is_dominant);
        ```

    === "Python"

        ```python
        is_dominant = outputLane.Is_dominant
        ```

### Capacity_adj {#capacity_adj}

```csharp
float Capacity_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj = outputLane.Capacity_adj;
        ```

    === "C++"

        ```cpp
        double capacity_adj;
        outputLane->get_Capacity_adj(&capacity_adj);
        ```

    === "Python"

        ```python
        capacity_adj = outputLane.Capacity_adj
        ```

### Capacity_adj_flag {#capacity_adj_flag}

```csharp
int Capacity_adj_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag = outputLane.Capacity_adj_flag;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag;
        outputLane->get_Capacity_adj_flag(&capacity_adj_flag);
        ```

    === "Python"

        ```python
        capacity_adj_flag = outputLane.Capacity_adj_flag
        ```

### OutputLaneODs {#outputlaneods}

```csharp
ISIAPIOutputLaneODs OutputLaneODs { get; }
```

**Type** [`ISIAPIOutputLaneODs`](sidrasolutions.si.api.isiapioutputlaneods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneODs = outputLane.OutputLaneODs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneODs> outputLaneODs;
        outputLane->get_OutputLaneODs(&outputLaneODs);
        ```

    === "Python"

        ```python
        output_lane_o_ds = outputLane.OutputLaneODs
        ```

### OutputLaneGreenPeriods {#outputlanegreenperiods}

```csharp
ISIAPIOutputLaneGreenPeriods OutputLaneGreenPeriods { get; }
```

**Type** [`ISIAPIOutputLaneGreenPeriods`](sidrasolutions.si.api.isiapioutputlanegreenperiods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneGreenPeriods = outputLane.OutputLaneGreenPeriods;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneGreenPeriods> outputLaneGreenPeriods;
        outputLane->get_OutputLaneGreenPeriods(&outputLaneGreenPeriods);
        ```

    === "Python"

        ```python
        output_lane_green_periods = outputLane.OutputLaneGreenPeriods
        ```

### OutputLeg {#outputleg}

```csharp
ISIAPIOutputLeg OutputLeg { get; }
```

**Type** [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLeg = outputLane.OutputLeg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLeg> outputLeg;
        outputLane->get_OutputLeg(&outputLeg);
        ```

    === "Python"

        ```python
        output_leg = outputLane.OutputLeg
        ```

### OutputLaneMCs {#outputlanemcs}

```csharp
ISIAPIOutputLaneMCs OutputLaneMCs { get; }
```

**Type** [`ISIAPIOutputLaneMCs`](sidrasolutions.si.api.isiapioutputlanemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneMCs = outputLane.OutputLaneMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneMCs> outputLaneMCs;
        outputLane->get_OutputLaneMCs(&outputLaneMCs);
        ```

    === "Python"

        ```python
        output_lane_m_cs = outputLane.OutputLaneMCs
        ```

### Lane_block_adj {#lane_block_adj}

```csharp
float Lane_block_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_block_adj = outputLane.Lane_block_adj;
        ```

    === "C++"

        ```cpp
        double lane_block_adj;
        outputLane->get_Lane_block_adj(&lane_block_adj);
        ```

    === "Python"

        ```python
        lane_block_adj = outputLane.Lane_block_adj
        ```

### Residual_demand_vol {#residual_demand_vol}

```csharp
float Residual_demand_vol { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float residual_demand_vol = outputLane.Residual_demand_vol;
        ```

    === "C++"

        ```cpp
        double residual_demand_vol;
        outputLane->get_Residual_demand_vol(&residual_demand_vol);
        ```

    === "Python"

        ```python
        residual_demand_vol = outputLane.Residual_demand_vol
        ```

### Initial_demand_vol_clear_time {#initial_demand_vol_clear_time}

```csharp
float Initial_demand_vol_clear_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float initial_demand_vol_clear_time = outputLane.Initial_demand_vol_clear_time;
        ```

    === "C++"

        ```cpp
        double initial_demand_vol_clear_time;
        outputLane->get_Initial_demand_vol_clear_time(&initial_demand_vol_clear_time);
        ```

    === "Python"

        ```python
        initial_demand_vol_clear_time = outputLane.Initial_demand_vol_clear_time
        ```

### Residual_demand_vol_clear_time {#residual_demand_vol_clear_time}

```csharp
float Residual_demand_vol_clear_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float residual_demand_vol_clear_time = outputLane.Residual_demand_vol_clear_time;
        ```

    === "C++"

        ```cpp
        double residual_demand_vol_clear_time;
        outputLane->get_Residual_demand_vol_clear_time(&residual_demand_vol_clear_time);
        ```

    === "Python"

        ```python
        residual_demand_vol_clear_time = outputLane.Residual_demand_vol_clear_time
        ```

### Oversatn_duration {#oversatn_duration}

```csharp
float Oversatn_duration { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float oversatn_duration = outputLane.Oversatn_duration;
        ```

    === "C++"

        ```cpp
        double oversatn_duration;
        outputLane->get_Oversatn_duration(&oversatn_duration);
        ```

    === "Python"

        ```python
        oversatn_duration = outputLane.Oversatn_duration
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputLane.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputLane->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputLane.Stop_rate
        ```

### Perc_arriving_during_green {#perc_arriving_during_green}

```csharp
float Perc_arriving_during_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float perc_arriving_during_green = outputLane.Perc_arriving_during_green;
        ```

    === "C++"

        ```cpp
        double perc_arriving_during_green;
        outputLane->get_Perc_arriving_during_green(&perc_arriving_during_green);
        ```

    === "Python"

        ```python
        perc_arriving_during_green = outputLane.Perc_arriving_during_green
        ```

### Platoon_ratio {#platoon_ratio}

```csharp
float Platoon_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_ratio = outputLane.Platoon_ratio;
        ```

    === "C++"

        ```cpp
        double platoon_ratio;
        outputLane->get_Platoon_ratio(&platoon_ratio);
        ```

    === "Python"

        ```python
        platoon_ratio = outputLane.Platoon_ratio
        ```

### Progression_factor_delay {#progression_factor_delay}

```csharp
float Progression_factor_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float progression_factor_delay = outputLane.Progression_factor_delay;
        ```

    === "C++"

        ```cpp
        double progression_factor_delay;
        outputLane->get_Progression_factor_delay(&progression_factor_delay);
        ```

    === "Python"

        ```python
        progression_factor_delay = outputLane.Progression_factor_delay
        ```

### Progression_factor_queue {#progression_factor_queue}

```csharp
float Progression_factor_queue { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float progression_factor_queue = outputLane.Progression_factor_queue;
        ```

    === "C++"

        ```cpp
        double progression_factor_queue;
        outputLane->get_Progression_factor_queue(&progression_factor_queue);
        ```

    === "Python"

        ```python
        progression_factor_queue = outputLane.Progression_factor_queue
        ```

### Headway_scats_mf {#headway_scats_mf}

```csharp
float Headway_scats_mf { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float headway_scats_mf = outputLane.Headway_scats_mf;
        ```

    === "C++"

        ```cpp
        double headway_scats_mf;
        outputLane->get_Headway_scats_mf(&headway_scats_mf);
        ```

    === "Python"

        ```python
        headway_scats_mf = outputLane.Headway_scats_mf
        ```

### Occupancy_scats_mf {#occupancy_scats_mf}

```csharp
float Occupancy_scats_mf { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float occupancy_scats_mf = outputLane.Occupancy_scats_mf;
        ```

    === "C++"

        ```cpp
        double occupancy_scats_mf;
        outputLane->get_Occupancy_scats_mf(&occupancy_scats_mf);
        ```

    === "Python"

        ```python
        occupancy_scats_mf = outputLane.Occupancy_scats_mf
        ```

### Space_scats_mf {#space_scats_mf}

```csharp
float Space_scats_mf { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float space_scats_mf = outputLane.Space_scats_mf;
        ```

    === "C++"

        ```cpp
        double space_scats_mf;
        outputLane->get_Space_scats_mf(&space_scats_mf);
        ```

    === "Python"

        ```python
        space_scats_mf = outputLane.Space_scats_mf
        ```

### Calc_mf_flag {#calc_mf_flag}

```csharp
int Calc_mf_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int calc_mf_flag = outputLane.Calc_mf_flag;
        ```

    === "C++"

        ```cpp
        long calc_mf_flag;
        outputLane->get_Calc_mf_flag(&calc_mf_flag);
        ```

    === "Python"

        ```python
        calc_mf_flag = outputLane.Calc_mf_flag
        ```

### Queue_constraint_flag {#queue_constraint_flag}

```csharp
int Queue_constraint_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int queue_constraint_flag = outputLane.Queue_constraint_flag;
        ```

    === "C++"

        ```cpp
        long queue_constraint_flag;
        outputLane->get_Queue_constraint_flag(&queue_constraint_flag);
        ```

    === "Python"

        ```python
        queue_constraint_flag = outputLane.Queue_constraint_flag
        ```

### Green_periods {#green_periods}

```csharp
int Green_periods { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int green_periods = outputLane.Green_periods;
        ```

    === "C++"

        ```cpp
        long green_periods;
        outputLane->get_Green_periods(&green_periods);
        ```

    === "Python"

        ```python
        green_periods = outputLane.Green_periods
        ```

### Upstr_flow_after_exit_sl {#upstr_flow_after_exit_sl}

```csharp
float Upstr_flow_after_exit_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float upstr_flow_after_exit_sl = outputLane.Upstr_flow_after_exit_sl;
        ```

    === "C++"

        ```cpp
        double upstr_flow_after_exit_sl;
        outputLane->get_Upstr_flow_after_exit_sl(&upstr_flow_after_exit_sl);
        ```

    === "Python"

        ```python
        upstr_flow_after_exit_sl = outputLane.Upstr_flow_after_exit_sl
        ```

### Lane_change_from_left {#lane_change_from_left}

```csharp
float Lane_change_from_left { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_from_left = outputLane.Lane_change_from_left;
        ```

    === "C++"

        ```cpp
        double lane_change_from_left;
        outputLane->get_Lane_change_from_left(&lane_change_from_left);
        ```

    === "Python"

        ```python
        lane_change_from_left = outputLane.Lane_change_from_left
        ```

### Lane_change_to_left {#lane_change_to_left}

```csharp
float Lane_change_to_left { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_to_left = outputLane.Lane_change_to_left;
        ```

    === "C++"

        ```cpp
        double lane_change_to_left;
        outputLane->get_Lane_change_to_left(&lane_change_to_left);
        ```

    === "Python"

        ```python
        lane_change_to_left = outputLane.Lane_change_to_left
        ```

### Lane_change_from_right {#lane_change_from_right}

```csharp
float Lane_change_from_right { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_from_right = outputLane.Lane_change_from_right;
        ```

    === "C++"

        ```cpp
        double lane_change_from_right;
        outputLane->get_Lane_change_from_right(&lane_change_from_right);
        ```

    === "Python"

        ```python
        lane_change_from_right = outputLane.Lane_change_from_right
        ```

### Lane_change_to_right {#lane_change_to_right}

```csharp
float Lane_change_to_right { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_to_right = outputLane.Lane_change_to_right;
        ```

    === "C++"

        ```cpp
        double lane_change_to_right;
        outputLane->get_Lane_change_to_right(&lane_change_to_right);
        ```

    === "Python"

        ```python
        lane_change_to_right = outputLane.Lane_change_to_right
        ```

### Is_nw_connected {#is_nw_connected}

```csharp
bool Is_nw_connected { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_nw_connected = outputLane.Is_nw_connected;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_nw_connected;
        outputLane->get_Is_nw_connected(&is_nw_connected);
        ```

    === "Python"

        ```python
        is_nw_connected = outputLane.Is_nw_connected
        ```

### Net_inflow {#net_inflow}

```csharp
float Net_inflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow = outputLane.Net_inflow;
        ```

    === "C++"

        ```cpp
        double net_inflow;
        outputLane->get_Net_inflow(&net_inflow);
        ```

    === "Python"

        ```python
        net_inflow = outputLane.Net_inflow
        ```

### Net_inflow_capconstr {#net_inflow_capconstr}

```csharp
float Net_inflow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow_capconstr = outputLane.Net_inflow_capconstr;
        ```

    === "C++"

        ```cpp
        double net_inflow_capconstr;
        outputLane->get_Net_inflow_capconstr(&net_inflow_capconstr);
        ```

    === "Python"

        ```python
        net_inflow_capconstr = outputLane.Net_inflow_capconstr
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLane.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLane->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLane.Arrival_flow_flag
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputLane.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputLane->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputLane.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputLane.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputLane->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputLane.Queue_greenstart_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputLane.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputLane->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputLane.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputLane.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputLane->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputLane.Queue_dist_cycav_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputLane.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputLane->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputLane.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputLane.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputLane->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputLane.Queue_dist_greenstart_percentile
        ```

### Initial_demand_vol {#initial_demand_vol}

```csharp
float Initial_demand_vol { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float initial_demand_vol = outputLane.Initial_demand_vol;
        ```

    === "C++"

        ```cpp
        double initial_demand_vol;
        outputLane->get_Initial_demand_vol(&initial_demand_vol);
        ```

    === "Python"

        ```python
        initial_demand_vol = outputLane.Initial_demand_vol
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputLane.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputLane->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputLane.Avg_num_of_cycles_to_depart
        ```

### Prob_shortlane_overflow {#prob_shortlane_overflow}

```csharp
float Prob_shortlane_overflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_shortlane_overflow = outputLane.Prob_shortlane_overflow;
        ```

    === "C++"

        ```cpp
        double prob_shortlane_overflow;
        outputLane->get_Prob_shortlane_overflow(&prob_shortlane_overflow);
        ```

    === "Python"

        ```python
        prob_shortlane_overflow = outputLane.Prob_shortlane_overflow
        ```

### Satflow_basic_adj {#satflow_basic_adj}

```csharp
float Satflow_basic_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_basic_adj = outputLane.Satflow_basic_adj;
        ```

    === "C++"

        ```cpp
        double satflow_basic_adj;
        outputLane->get_Satflow_basic_adj(&satflow_basic_adj);
        ```

    === "Python"

        ```python
        satflow_basic_adj = outputLane.Satflow_basic_adj
        ```

### Adjfactor_lanewidth {#adjfactor_lanewidth}

```csharp
float Adjfactor_lanewidth { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_lanewidth = outputLane.Adjfactor_lanewidth;
        ```

    === "C++"

        ```cpp
        double adjfactor_lanewidth;
        outputLane->get_Adjfactor_lanewidth(&adjfactor_lanewidth);
        ```

    === "Python"

        ```python
        adjfactor_lanewidth = outputLane.Adjfactor_lanewidth
        ```

### Adjfactor_grade {#adjfactor_grade}

```csharp
float Adjfactor_grade { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_grade = outputLane.Adjfactor_grade;
        ```

    === "C++"

        ```cpp
        double adjfactor_grade;
        outputLane->get_Adjfactor_grade(&adjfactor_grade);
        ```

    === "Python"

        ```python
        adjfactor_grade = outputLane.Adjfactor_grade
        ```

### Adjfactor_parking {#adjfactor_parking}

```csharp
float Adjfactor_parking { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_parking = outputLane.Adjfactor_parking;
        ```

    === "C++"

        ```cpp
        double adjfactor_parking;
        outputLane->get_Adjfactor_parking(&adjfactor_parking);
        ```

    === "Python"

        ```python
        adjfactor_parking = outputLane.Adjfactor_parking
        ```

### Adjfactor_buses {#adjfactor_buses}

```csharp
float Adjfactor_buses { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_buses = outputLane.Adjfactor_buses;
        ```

    === "C++"

        ```cpp
        double adjfactor_buses;
        outputLane->get_Adjfactor_buses(&adjfactor_buses);
        ```

    === "Python"

        ```python
        adjfactor_buses = outputLane.Adjfactor_buses
        ```

### Adjfactor_flowscale {#adjfactor_flowscale}

```csharp
float Adjfactor_flowscale { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_flowscale = outputLane.Adjfactor_flowscale;
        ```

    === "C++"

        ```cpp
        double adjfactor_flowscale;
        outputLane->get_Adjfactor_flowscale(&adjfactor_flowscale);
        ```

    === "Python"

        ```python
        adjfactor_flowscale = outputLane.Adjfactor_flowscale
        ```

### Adjfactor_trafficflow {#adjfactor_trafficflow}

```csharp
float Adjfactor_trafficflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjfactor_trafficflow = outputLane.Adjfactor_trafficflow;
        ```

    === "C++"

        ```cpp
        double adjfactor_trafficflow;
        outputLane->get_Adjfactor_trafficflow(&adjfactor_trafficflow);
        ```

    === "Python"

        ```python
        adjfactor_trafficflow = outputLane.Adjfactor_trafficflow
        ```

### Equivalent_AT {#equivalent_at}

```csharp
int Equivalent_AT { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int equivalent_AT = outputLane.Equivalent_AT;
        ```

    === "C++"

        ```cpp
        long equivalent_AT;
        outputLane->get_Equivalent_AT(&equivalent_AT);
        ```

    === "Python"

        ```python
        equivalent_at = outputLane.Equivalent_AT
        ```

### Control_type {#control_type}

```csharp
int Control_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int control_type = outputLane.Control_type;
        ```

    === "C++"

        ```cpp
        long control_type;
        outputLane->get_Control_type(&control_type);
        ```

    === "Python"

        ```python
        control_type = outputLane.Control_type
        ```

### Contlane_affect_by_adjshortlane {#contlane_affect_by_adjshortlane}

```csharp
int Contlane_affect_by_adjshortlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int contlane_affect_by_adjshortlane = outputLane.Contlane_affect_by_adjshortlane;
        ```

    === "C++"

        ```cpp
        long contlane_affect_by_adjshortlane;
        outputLane->get_Contlane_affect_by_adjshortlane(&contlane_affect_by_adjshortlane);
        ```

    === "Python"

        ```python
        contlane_affect_by_adjshortlane = outputLane.Contlane_affect_by_adjshortlane
        ```

### Opposing_ped_factor {#opposing_ped_factor}

```csharp
float Opposing_ped_factor { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_ped_factor = outputLane.Opposing_ped_factor;
        ```

    === "C++"

        ```cpp
        double opposing_ped_factor;
        outputLane->get_Opposing_ped_factor(&opposing_ped_factor);
        ```

    === "Python"

        ```python
        opposing_ped_factor = outputLane.Opposing_ped_factor
        ```

### Unblocked_time_ratio {#unblocked_time_ratio}

```csharp
float Unblocked_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unblocked_time_ratio = outputLane.Unblocked_time_ratio;
        ```

    === "C++"

        ```cpp
        double unblocked_time_ratio;
        outputLane->get_Unblocked_time_ratio(&unblocked_time_ratio);
        ```

    === "Python"

        ```python
        unblocked_time_ratio = outputLane.Unblocked_time_ratio
        ```

### Gap_accept_cycle_time {#gap_accept_cycle_time}

```csharp
float Gap_accept_cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_cycle_time = outputLane.Gap_accept_cycle_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_cycle_time;
        outputLane->get_Gap_accept_cycle_time(&gap_accept_cycle_time);
        ```

    === "Python"

        ```python
        gap_accept_cycle_time = outputLane.Gap_accept_cycle_time
        ```

### Gap_accept_blocked_time {#gap_accept_blocked_time}

```csharp
float Gap_accept_blocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_blocked_time = outputLane.Gap_accept_blocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_blocked_time;
        outputLane->get_Gap_accept_blocked_time(&gap_accept_blocked_time);
        ```

    === "Python"

        ```python
        gap_accept_blocked_time = outputLane.Gap_accept_blocked_time
        ```

### Gap_accept_unblocked_time {#gap_accept_unblocked_time}

```csharp
float Gap_accept_unblocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_unblocked_time = outputLane.Gap_accept_unblocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_unblocked_time;
        outputLane->get_Gap_accept_unblocked_time(&gap_accept_unblocked_time);
        ```

    === "Python"

        ```python
        gap_accept_unblocked_time = outputLane.Gap_accept_unblocked_time
        ```

### Minimum_delay {#minimum_delay}

```csharp
float Minimum_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_delay = outputLane.Minimum_delay;
        ```

    === "C++"

        ```cpp
        double minimum_delay;
        outputLane->get_Minimum_delay(&minimum_delay);
        ```

    === "Python"

        ```python
        minimum_delay = outputLane.Minimum_delay
        ```

### Queue_dist_overflow {#queue_dist_overflow}

```csharp
float Queue_dist_overflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_overflow = outputLane.Queue_dist_overflow;
        ```

    === "C++"

        ```cpp
        double queue_dist_overflow;
        outputLane->get_Queue_dist_overflow(&queue_dist_overflow);
        ```

    === "Python"

        ```python
        queue_dist_overflow = outputLane.Queue_dist_overflow
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputLane.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputLane->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputLane.SpeedEfficiency
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputLane.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputLane->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputLane.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputLane.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputLane->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputLane.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputLane.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputLane->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputLane.TravelTimeIndex
        ```

### Uninterrupted_speed {#uninterrupted_speed}

```csharp
float Uninterrupted_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float uninterrupted_speed = outputLane.Uninterrupted_speed;
        ```

    === "C++"

        ```cpp
        double uninterrupted_speed;
        outputLane->get_Uninterrupted_speed(&uninterrupted_speed);
        ```

    === "Python"

        ```python
        uninterrupted_speed = outputLane.Uninterrupted_speed
        ```

### Density {#density}

```csharp
float Density { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float density = outputLane.Density;
        ```

    === "C++"

        ```cpp
        double density;
        outputLane->get_Density(&density);
        ```

    === "Python"

        ```python
        density = outputLane.Density
        ```

### Spacing {#spacing}

```csharp
float Spacing { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float spacing = outputLane.Spacing;
        ```

    === "C++"

        ```cpp
        double spacing;
        outputLane->get_Spacing(&spacing);
        ```

    === "Python"

        ```python
        spacing = outputLane.Spacing
        ```

### Headway {#headway}

```csharp
float Headway { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float headway = outputLane.Headway;
        ```

    === "C++"

        ```cpp
        double headway;
        outputLane->get_Headway(&headway);
        ```

    === "Python"

        ```python
        headway = outputLane.Headway
        ```

### Occupancy_time {#occupancy_time}

```csharp
float Occupancy_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float occupancy_time = outputLane.Occupancy_time;
        ```

    === "C++"

        ```cpp
        double occupancy_time;
        outputLane->get_Occupancy_time(&occupancy_time);
        ```

    === "Python"

        ```python
        occupancy_time = outputLane.Occupancy_time
        ```

### Space_time {#space_time}

```csharp
float Space_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float space_time = outputLane.Space_time;
        ```

    === "C++"

        ```cpp
        double space_time;
        outputLane->get_Space_time(&space_time);
        ```

    === "Python"

        ```python
        space_time = outputLane.Space_time
        ```

### Avg_veh_length {#avg_veh_length}

```csharp
float Avg_veh_length { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_veh_length = outputLane.Avg_veh_length;
        ```

    === "C++"

        ```cpp
        double avg_veh_length;
        outputLane->get_Avg_veh_length(&avg_veh_length);
        ```

    === "Python"

        ```python
        avg_veh_length = outputLane.Avg_veh_length
        ```

### Space_occupancy_ratio {#space_occupancy_ratio}

```csharp
float Space_occupancy_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float space_occupancy_ratio = outputLane.Space_occupancy_ratio;
        ```

    === "C++"

        ```cpp
        double space_occupancy_ratio;
        outputLane->get_Space_occupancy_ratio(&space_occupancy_ratio);
        ```

    === "Python"

        ```python
        space_occupancy_ratio = outputLane.Space_occupancy_ratio
        ```

### Time_occupancy_ratio {#time_occupancy_ratio}

```csharp
float Time_occupancy_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_occupancy_ratio = outputLane.Time_occupancy_ratio;
        ```

    === "C++"

        ```cpp
        double time_occupancy_ratio;
        outputLane->get_Time_occupancy_ratio(&time_occupancy_ratio);
        ```

    === "Python"

        ```python
        time_occupancy_ratio = outputLane.Time_occupancy_ratio
        ```

### Uninterrupted_travel_delay {#uninterrupted_travel_delay}

```csharp
float Uninterrupted_travel_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float uninterrupted_travel_delay = outputLane.Uninterrupted_travel_delay;
        ```

    === "C++"

        ```cpp
        double uninterrupted_travel_delay;
        outputLane->get_Uninterrupted_travel_delay(&uninterrupted_travel_delay);
        ```

    === "Python"

        ```python
        uninterrupted_travel_delay = outputLane.Uninterrupted_travel_delay
        ```

### Queue_unrestr_mean {#queue_unrestr_mean}

```csharp
float Queue_unrestr_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_unrestr_mean = outputLane.Queue_unrestr_mean;
        ```

    === "C++"

        ```cpp
        double queue_unrestr_mean;
        outputLane->get_Queue_unrestr_mean(&queue_unrestr_mean);
        ```

    === "Python"

        ```python
        queue_unrestr_mean = outputLane.Queue_unrestr_mean
        ```

### Cum_storage_space {#cum_storage_space}

```csharp
float Cum_storage_space { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cum_storage_space = outputLane.Cum_storage_space;
        ```

    === "C++"

        ```cpp
        double cum_storage_space;
        outputLane->get_Cum_storage_space(&cum_storage_space);
        ```

    === "Python"

        ```python
        cum_storage_space = outputLane.Cum_storage_space
        ```

### Queue_maxback_mean_flag {#queue_maxback_mean_flag}

```csharp
int Queue_maxback_mean_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int queue_maxback_mean_flag = outputLane.Queue_maxback_mean_flag;
        ```

    === "C++"

        ```cpp
        long queue_maxback_mean_flag;
        outputLane->get_Queue_maxback_mean_flag(&queue_maxback_mean_flag);
        ```

    === "Python"

        ```python
        queue_maxback_mean_flag = outputLane.Queue_maxback_mean_flag
        ```

### Queue_maxback_percentile_flag {#queue_maxback_percentile_flag}

```csharp
int Queue_maxback_percentile_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int queue_maxback_percentile_flag = outputLane.Queue_maxback_percentile_flag;
        ```

    === "C++"

        ```cpp
        long queue_maxback_percentile_flag;
        outputLane->get_Queue_maxback_percentile_flag(&queue_maxback_percentile_flag);
        ```

    === "Python"

        ```python
        queue_maxback_percentile_flag = outputLane.Queue_maxback_percentile_flag
        ```

### LOS_density {#los_density}

```csharp
int LOS_density { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int lOS_density = outputLane.LOS_density;
        ```

    === "C++"

        ```cpp
        long lOS_density;
        outputLane->get_LOS_density(&lOS_density);
        ```

    === "Python"

        ```python
        los_density = outputLane.LOS_density
        ```

### Density_pcu {#density_pcu}

```csharp
float Density_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float density_pcu = outputLane.Density_pcu;
        ```

    === "C++"

        ```cpp
        double density_pcu;
        outputLane->get_Density_pcu(&density_pcu);
        ```

    === "Python"

        ```python
        density_pcu = outputLane.Density_pcu
        ```

### Excess_queue_from_downstream_merge_mean {#excess_queue_from_downstream_merge_mean}

```csharp
float Excess_queue_from_downstream_merge_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float excess_queue_from_downstream_merge_mean = outputLane.Excess_queue_from_downstream_merge_mean;
        ```

    === "C++"

        ```cpp
        double excess_queue_from_downstream_merge_mean;
        outputLane->get_Excess_queue_from_downstream_merge_mean(&excess_queue_from_downstream_merge_mean);
        ```

    === "Python"

        ```python
        excess_queue_from_downstream_merge_mean = outputLane.Excess_queue_from_downstream_merge_mean
        ```

### Excess_queue_from_downstream_merge_percentile {#excess_queue_from_downstream_merge_percentile}

```csharp
float Excess_queue_from_downstream_merge_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float excess_queue_from_downstream_merge_percentile = outputLane.Excess_queue_from_downstream_merge_percentile;
        ```

    === "C++"

        ```cpp
        double excess_queue_from_downstream_merge_percentile;
        outputLane->get_Excess_queue_from_downstream_merge_percentile(&excess_queue_from_downstream_merge_percentile);
        ```

    === "Python"

        ```python
        excess_queue_from_downstream_merge_percentile = outputLane.Excess_queue_from_downstream_merge_percentile
        ```

### Excess_queue_dist_from_downstream_merge_mean {#excess_queue_dist_from_downstream_merge_mean}

```csharp
float Excess_queue_dist_from_downstream_merge_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float excess_queue_dist_from_downstream_merge_mean = outputLane.Excess_queue_dist_from_downstream_merge_mean;
        ```

    === "C++"

        ```cpp
        double excess_queue_dist_from_downstream_merge_mean;
        outputLane->get_Excess_queue_dist_from_downstream_merge_mean(&excess_queue_dist_from_downstream_merge_mean);
        ```

    === "Python"

        ```python
        excess_queue_dist_from_downstream_merge_mean = outputLane.Excess_queue_dist_from_downstream_merge_mean
        ```

### Excess_queue_dist_from_downstream_merge_percentile {#excess_queue_dist_from_downstream_merge_percentile}

```csharp
float Excess_queue_dist_from_downstream_merge_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float excess_queue_dist_from_downstream_merge_percentile = outputLane.Excess_queue_dist_from_downstream_merge_percentile;
        ```

    === "C++"

        ```cpp
        double excess_queue_dist_from_downstream_merge_percentile;
        outputLane->get_Excess_queue_dist_from_downstream_merge_percentile(&excess_queue_dist_from_downstream_merge_percentile);
        ```

    === "Python"

        ```python
        excess_queue_dist_from_downstream_merge_percentile = outputLane.Excess_queue_dist_from_downstream_merge_percentile
        ```

### OutputLaneUnsignalPed {#outputlaneunsignalped}

```csharp
ISIAPIOutputLaneUnsignalPed OutputLaneUnsignalPed { get; }
```

**Type** [`ISIAPIOutputLaneUnsignalPed`](sidrasolutions.si.api.isiapioutputlaneunsignalped.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneUnsignalPed = outputLane.OutputLaneUnsignalPed;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneUnsignalPed> outputLaneUnsignalPed;
        outputLane->get_OutputLaneUnsignalPed(&outputLaneUnsignalPed);
        ```

    === "Python"

        ```python
        output_lane_unsignal_ped = outputLane.OutputLaneUnsignalPed
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneexit.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneExit
title: OutputLaneExit
name: ISIAPIOutputLaneExit
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 706622FC-2968-476E-84C8-37264AB27B08
summary: SIDRA INTERSECTION Output Exit Lane wrapper interface
members:
  - int Orientation
  - int Laneno
  - float Flow
  - float Flow_capconstr
  - bool Merge_analysis_applied
  - float Opposing_flow_rate_veh_sl
  - float Opposing_flow_rate_pcu_sl
  - float Critical_gap_sl
  - float Followup_headway_sl
  - float Lane_flow_rate_sl
  - float Capacity_sl
  - float Deg_satn_sl
  - float Min_delay_sl
  - float Merge_delay_sl
  - float Opposing_flow_rate_veh_ml
  - float Opposing_flow_rate_pcu_ml
  - float Critical_gap_ml
  - float Followup_headway_ml
  - float Lane_flow_rate_ml
  - float Capacity_ml
  - float Deg_satn_ml
  - float Min_delay_ml
  - float Merge_delay_ml
  - ISIAPIOutputLeg OutputLeg
  - float Queue_cycav_mean_sl
  - float Queue_cycav_percentile_sl
  - float Queue_greenstart_mean_sl
  - float Queue_greenstart_percentile_sl
  - float Queue_maxback_mean_sl
  - float Queue_maxback_percentile_sl
  - float Queue_dist_cycav_mean_sl
  - float Queue_dist_cycav_percentile_sl
  - float Queue_dist_greenstart_mean_sl
  - float Queue_dist_greenstart_percentile_sl
  - float Queue_dist_maxback_mean_sl
  - float Queue_dist_maxback_percentile_sl
  - float Queue_cycav_mean_ml
  - float Queue_cycav_percentile_ml
  - float Queue_greenstart_mean_ml
  - float Queue_greenstart_percentile_ml
  - float Queue_maxback_mean_ml
  - float Queue_maxback_percentile_ml
  - float Queue_dist_cycav_mean_ml
  - float Queue_dist_cycav_percentile_ml
  - float Queue_dist_greenstart_mean_ml
  - float Queue_dist_greenstart_percentile_ml
  - float Queue_dist_maxback_mean_ml
  - float Queue_dist_maxback_percentile_ml
  - ISIAPIOutputLaneExitMCs OutputLaneExitMCs
---

# OutputLaneExit

Type `ISIAPIOutputLaneExit` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `706622FC-2968-476E-84C8-37264AB27B08`

SIDRA INTERSECTION Output Exit Lane wrapper interface

## Declaration

```csharp
[Guid("706622FC-2968-476E-84C8-37264AB27B08")]
public interface ISIAPIOutputLaneExit
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` |  |
| [Laneno](#laneno) | `int` | Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure. |
| [Flow](#flow) | `float` |  |
| [Flow_capconstr](#flow_capconstr) | `float` |  |
| [Merge_analysis_applied](#merge_analysis_applied) | `bool` |  |
| [Opposing_flow_rate_veh_sl](#opposing_flow_rate_veh_sl) | `float` |  |
| [Opposing_flow_rate_pcu_sl](#opposing_flow_rate_pcu_sl) | `float` |  |
| [Critical_gap_sl](#critical_gap_sl) | `float` |  |
| [Followup_headway_sl](#followup_headway_sl) | `float` |  |
| [Lane_flow_rate_sl](#lane_flow_rate_sl) | `float` |  |
| [Capacity_sl](#capacity_sl) | `float` |  |
| [Deg_satn_sl](#deg_satn_sl) | `float` |  |
| [Min_delay_sl](#min_delay_sl) | `float` |  |
| [Merge_delay_sl](#merge_delay_sl) | `float` |  |
| [Opposing_flow_rate_veh_ml](#opposing_flow_rate_veh_ml) | `float` |  |
| [Opposing_flow_rate_pcu_ml](#opposing_flow_rate_pcu_ml) | `float` |  |
| [Critical_gap_ml](#critical_gap_ml) | `float` |  |
| [Followup_headway_ml](#followup_headway_ml) | `float` |  |
| [Lane_flow_rate_ml](#lane_flow_rate_ml) | `float` |  |
| [Capacity_ml](#capacity_ml) | `float` |  |
| [Deg_satn_ml](#deg_satn_ml) | `float` |  |
| [Min_delay_ml](#min_delay_ml) | `float` |  |
| [Merge_delay_ml](#merge_delay_ml) | `float` |  |
| [OutputLeg](#outputleg) | [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md) |  |
| [Queue_cycav_mean_sl](#queue_cycav_mean_sl) | `float` |  |
| [Queue_cycav_percentile_sl](#queue_cycav_percentile_sl) | `float` |  |
| [Queue_greenstart_mean_sl](#queue_greenstart_mean_sl) | `float` |  |
| [Queue_greenstart_percentile_sl](#queue_greenstart_percentile_sl) | `float` |  |
| [Queue_maxback_mean_sl](#queue_maxback_mean_sl) | `float` |  |
| [Queue_maxback_percentile_sl](#queue_maxback_percentile_sl) | `float` |  |
| [Queue_dist_cycav_mean_sl](#queue_dist_cycav_mean_sl) | `float` |  |
| [Queue_dist_cycav_percentile_sl](#queue_dist_cycav_percentile_sl) | `float` |  |
| [Queue_dist_greenstart_mean_sl](#queue_dist_greenstart_mean_sl) | `float` |  |
| [Queue_dist_greenstart_percentile_sl](#queue_dist_greenstart_percentile_sl) | `float` |  |
| [Queue_dist_maxback_mean_sl](#queue_dist_maxback_mean_sl) | `float` |  |
| [Queue_dist_maxback_percentile_sl](#queue_dist_maxback_percentile_sl) | `float` |  |
| [Queue_cycav_mean_ml](#queue_cycav_mean_ml) | `float` |  |
| [Queue_cycav_percentile_ml](#queue_cycav_percentile_ml) | `float` |  |
| [Queue_greenstart_mean_ml](#queue_greenstart_mean_ml) | `float` |  |
| [Queue_greenstart_percentile_ml](#queue_greenstart_percentile_ml) | `float` |  |
| [Queue_maxback_mean_ml](#queue_maxback_mean_ml) | `float` |  |
| [Queue_maxback_percentile_ml](#queue_maxback_percentile_ml) | `float` |  |
| [Queue_dist_cycav_mean_ml](#queue_dist_cycav_mean_ml) | `float` |  |
| [Queue_dist_cycav_percentile_ml](#queue_dist_cycav_percentile_ml) | `float` |  |
| [Queue_dist_greenstart_mean_ml](#queue_dist_greenstart_mean_ml) | `float` |  |
| [Queue_dist_greenstart_percentile_ml](#queue_dist_greenstart_percentile_ml) | `float` |  |
| [Queue_dist_maxback_mean_ml](#queue_dist_maxback_mean_ml) | `float` |  |
| [Queue_dist_maxback_percentile_ml](#queue_dist_maxback_percentile_ml) | `float` |  |
| [OutputLaneExitMCs](#outputlaneexitmcs) | [`ISIAPIOutputLaneExitMCs`](sidrasolutions.si.api.isiapioutputlaneexitmcs.md) |  |

</div>

## Properties

### Orientation {#orientation}

```csharp
int Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = outputLaneExit.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        outputLaneExit->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = outputLaneExit.Orientation
        ```

### Laneno {#laneno}

Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure.

```csharp
int Laneno { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int laneno = outputLaneExit.Laneno;
        ```

    === "C++"

        ```cpp
        long laneno;
        outputLaneExit->get_Laneno(&laneno);
        ```

    === "Python"

        ```python
        laneno = outputLaneExit.Laneno
        ```

### Flow {#flow}

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputLaneExit.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputLaneExit->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputLaneExit.Flow
        ```

### Flow_capconstr {#flow_capconstr}

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputLaneExit.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputLaneExit->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputLaneExit.Flow_capconstr
        ```

### Merge_analysis_applied {#merge_analysis_applied}

```csharp
bool Merge_analysis_applied { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool merge_analysis_applied = outputLaneExit.Merge_analysis_applied;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL merge_analysis_applied;
        outputLaneExit->get_Merge_analysis_applied(&merge_analysis_applied);
        ```

    === "Python"

        ```python
        merge_analysis_applied = outputLaneExit.Merge_analysis_applied
        ```

### Opposing_flow_rate_veh_sl {#opposing_flow_rate_veh_sl}

```csharp
float Opposing_flow_rate_veh_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_rate_veh_sl = outputLaneExit.Opposing_flow_rate_veh_sl;
        ```

    === "C++"

        ```cpp
        double opposing_flow_rate_veh_sl;
        outputLaneExit->get_Opposing_flow_rate_veh_sl(&opposing_flow_rate_veh_sl);
        ```

    === "Python"

        ```python
        opposing_flow_rate_veh_sl = outputLaneExit.Opposing_flow_rate_veh_sl
        ```

### Opposing_flow_rate_pcu_sl {#opposing_flow_rate_pcu_sl}

```csharp
float Opposing_flow_rate_pcu_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_rate_pcu_sl = outputLaneExit.Opposing_flow_rate_pcu_sl;
        ```

    === "C++"

        ```cpp
        double opposing_flow_rate_pcu_sl;
        outputLaneExit->get_Opposing_flow_rate_pcu_sl(&opposing_flow_rate_pcu_sl);
        ```

    === "Python"

        ```python
        opposing_flow_rate_pcu_sl = outputLaneExit.Opposing_flow_rate_pcu_sl
        ```

### Critical_gap_sl {#critical_gap_sl}

```csharp
float Critical_gap_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap_sl = outputLaneExit.Critical_gap_sl;
        ```

    === "C++"

        ```cpp
        double critical_gap_sl;
        outputLaneExit->get_Critical_gap_sl(&critical_gap_sl);
        ```

    === "Python"

        ```python
        critical_gap_sl = outputLaneExit.Critical_gap_sl
        ```

### Followup_headway_sl {#followup_headway_sl}

```csharp
float Followup_headway_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway_sl = outputLaneExit.Followup_headway_sl;
        ```

    === "C++"

        ```cpp
        double followup_headway_sl;
        outputLaneExit->get_Followup_headway_sl(&followup_headway_sl);
        ```

    === "Python"

        ```python
        followup_headway_sl = outputLaneExit.Followup_headway_sl
        ```

### Lane_flow_rate_sl {#lane_flow_rate_sl}

```csharp
float Lane_flow_rate_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_flow_rate_sl = outputLaneExit.Lane_flow_rate_sl;
        ```

    === "C++"

        ```cpp
        double lane_flow_rate_sl;
        outputLaneExit->get_Lane_flow_rate_sl(&lane_flow_rate_sl);
        ```

    === "Python"

        ```python
        lane_flow_rate_sl = outputLaneExit.Lane_flow_rate_sl
        ```

### Capacity_sl {#capacity_sl}

```csharp
float Capacity_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_sl = outputLaneExit.Capacity_sl;
        ```

    === "C++"

        ```cpp
        double capacity_sl;
        outputLaneExit->get_Capacity_sl(&capacity_sl);
        ```

    === "Python"

        ```python
        capacity_sl = outputLaneExit.Capacity_sl
        ```

### Deg_satn_sl {#deg_satn_sl}

```csharp
float Deg_satn_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn_sl = outputLaneExit.Deg_satn_sl;
        ```

    === "C++"

        ```cpp
        double deg_satn_sl;
        outputLaneExit->get_Deg_satn_sl(&deg_satn_sl);
        ```

    === "Python"

        ```python
        deg_satn_sl = outputLaneExit.Deg_satn_sl
        ```

### Min_delay_sl {#min_delay_sl}

```csharp
float Min_delay_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_delay_sl = outputLaneExit.Min_delay_sl;
        ```

    === "C++"

        ```cpp
        double min_delay_sl;
        outputLaneExit->get_Min_delay_sl(&min_delay_sl);
        ```

    === "Python"

        ```python
        min_delay_sl = outputLaneExit.Min_delay_sl
        ```

### Merge_delay_sl {#merge_delay_sl}

```csharp
float Merge_delay_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float merge_delay_sl = outputLaneExit.Merge_delay_sl;
        ```

    === "C++"

        ```cpp
        double merge_delay_sl;
        outputLaneExit->get_Merge_delay_sl(&merge_delay_sl);
        ```

    === "Python"

        ```python
        merge_delay_sl = outputLaneExit.Merge_delay_sl
        ```

### Opposing_flow_rate_veh_ml {#opposing_flow_rate_veh_ml}

```csharp
float Opposing_flow_rate_veh_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_rate_veh_ml = outputLaneExit.Opposing_flow_rate_veh_ml;
        ```

    === "C++"

        ```cpp
        double opposing_flow_rate_veh_ml;
        outputLaneExit->get_Opposing_flow_rate_veh_ml(&opposing_flow_rate_veh_ml);
        ```

    === "Python"

        ```python
        opposing_flow_rate_veh_ml = outputLaneExit.Opposing_flow_rate_veh_ml
        ```

### Opposing_flow_rate_pcu_ml {#opposing_flow_rate_pcu_ml}

```csharp
float Opposing_flow_rate_pcu_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_rate_pcu_ml = outputLaneExit.Opposing_flow_rate_pcu_ml;
        ```

    === "C++"

        ```cpp
        double opposing_flow_rate_pcu_ml;
        outputLaneExit->get_Opposing_flow_rate_pcu_ml(&opposing_flow_rate_pcu_ml);
        ```

    === "Python"

        ```python
        opposing_flow_rate_pcu_ml = outputLaneExit.Opposing_flow_rate_pcu_ml
        ```

### Critical_gap_ml {#critical_gap_ml}

```csharp
float Critical_gap_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap_ml = outputLaneExit.Critical_gap_ml;
        ```

    === "C++"

        ```cpp
        double critical_gap_ml;
        outputLaneExit->get_Critical_gap_ml(&critical_gap_ml);
        ```

    === "Python"

        ```python
        critical_gap_ml = outputLaneExit.Critical_gap_ml
        ```

### Followup_headway_ml {#followup_headway_ml}

```csharp
float Followup_headway_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway_ml = outputLaneExit.Followup_headway_ml;
        ```

    === "C++"

        ```cpp
        double followup_headway_ml;
        outputLaneExit->get_Followup_headway_ml(&followup_headway_ml);
        ```

    === "Python"

        ```python
        followup_headway_ml = outputLaneExit.Followup_headway_ml
        ```

### Lane_flow_rate_ml {#lane_flow_rate_ml}

```csharp
float Lane_flow_rate_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_flow_rate_ml = outputLaneExit.Lane_flow_rate_ml;
        ```

    === "C++"

        ```cpp
        double lane_flow_rate_ml;
        outputLaneExit->get_Lane_flow_rate_ml(&lane_flow_rate_ml);
        ```

    === "Python"

        ```python
        lane_flow_rate_ml = outputLaneExit.Lane_flow_rate_ml
        ```

### Capacity_ml {#capacity_ml}

```csharp
float Capacity_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_ml = outputLaneExit.Capacity_ml;
        ```

    === "C++"

        ```cpp
        double capacity_ml;
        outputLaneExit->get_Capacity_ml(&capacity_ml);
        ```

    === "Python"

        ```python
        capacity_ml = outputLaneExit.Capacity_ml
        ```

### Deg_satn_ml {#deg_satn_ml}

```csharp
float Deg_satn_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn_ml = outputLaneExit.Deg_satn_ml;
        ```

    === "C++"

        ```cpp
        double deg_satn_ml;
        outputLaneExit->get_Deg_satn_ml(&deg_satn_ml);
        ```

    === "Python"

        ```python
        deg_satn_ml = outputLaneExit.Deg_satn_ml
        ```

### Min_delay_ml {#min_delay_ml}

```csharp
float Min_delay_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_delay_ml = outputLaneExit.Min_delay_ml;
        ```

    === "C++"

        ```cpp
        double min_delay_ml;
        outputLaneExit->get_Min_delay_ml(&min_delay_ml);
        ```

    === "Python"

        ```python
        min_delay_ml = outputLaneExit.Min_delay_ml
        ```

### Merge_delay_ml {#merge_delay_ml}

```csharp
float Merge_delay_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float merge_delay_ml = outputLaneExit.Merge_delay_ml;
        ```

    === "C++"

        ```cpp
        double merge_delay_ml;
        outputLaneExit->get_Merge_delay_ml(&merge_delay_ml);
        ```

    === "Python"

        ```python
        merge_delay_ml = outputLaneExit.Merge_delay_ml
        ```

### OutputLeg {#outputleg}

```csharp
ISIAPIOutputLeg OutputLeg { get; }
```

**Type** [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLeg = outputLaneExit.OutputLeg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLeg> outputLeg;
        outputLaneExit->get_OutputLeg(&outputLeg);
        ```

    === "Python"

        ```python
        output_leg = outputLaneExit.OutputLeg
        ```

### Queue_cycav_mean_sl {#queue_cycav_mean_sl}

```csharp
float Queue_cycav_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean_sl = outputLaneExit.Queue_cycav_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean_sl;
        outputLaneExit->get_Queue_cycav_mean_sl(&queue_cycav_mean_sl);
        ```

    === "Python"

        ```python
        queue_cycav_mean_sl = outputLaneExit.Queue_cycav_mean_sl
        ```

### Queue_cycav_percentile_sl {#queue_cycav_percentile_sl}

```csharp
float Queue_cycav_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile_sl = outputLaneExit.Queue_cycav_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile_sl;
        outputLaneExit->get_Queue_cycav_percentile_sl(&queue_cycav_percentile_sl);
        ```

    === "Python"

        ```python
        queue_cycav_percentile_sl = outputLaneExit.Queue_cycav_percentile_sl
        ```

### Queue_greenstart_mean_sl {#queue_greenstart_mean_sl}

```csharp
float Queue_greenstart_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean_sl = outputLaneExit.Queue_greenstart_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean_sl;
        outputLaneExit->get_Queue_greenstart_mean_sl(&queue_greenstart_mean_sl);
        ```

    === "Python"

        ```python
        queue_greenstart_mean_sl = outputLaneExit.Queue_greenstart_mean_sl
        ```

### Queue_greenstart_percentile_sl {#queue_greenstart_percentile_sl}

```csharp
float Queue_greenstart_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile_sl = outputLaneExit.Queue_greenstart_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile_sl;
        outputLaneExit->get_Queue_greenstart_percentile_sl(&queue_greenstart_percentile_sl);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile_sl = outputLaneExit.Queue_greenstart_percentile_sl
        ```

### Queue_maxback_mean_sl {#queue_maxback_mean_sl}

```csharp
float Queue_maxback_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean_sl = outputLaneExit.Queue_maxback_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean_sl;
        outputLaneExit->get_Queue_maxback_mean_sl(&queue_maxback_mean_sl);
        ```

    === "Python"

        ```python
        queue_maxback_mean_sl = outputLaneExit.Queue_maxback_mean_sl
        ```

### Queue_maxback_percentile_sl {#queue_maxback_percentile_sl}

```csharp
float Queue_maxback_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile_sl = outputLaneExit.Queue_maxback_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile_sl;
        outputLaneExit->get_Queue_maxback_percentile_sl(&queue_maxback_percentile_sl);
        ```

    === "Python"

        ```python
        queue_maxback_percentile_sl = outputLaneExit.Queue_maxback_percentile_sl
        ```

### Queue_dist_cycav_mean_sl {#queue_dist_cycav_mean_sl}

```csharp
float Queue_dist_cycav_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean_sl = outputLaneExit.Queue_dist_cycav_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean_sl;
        outputLaneExit->get_Queue_dist_cycav_mean_sl(&queue_dist_cycav_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean_sl = outputLaneExit.Queue_dist_cycav_mean_sl
        ```

### Queue_dist_cycav_percentile_sl {#queue_dist_cycav_percentile_sl}

```csharp
float Queue_dist_cycav_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile_sl = outputLaneExit.Queue_dist_cycav_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile_sl;
        outputLaneExit->get_Queue_dist_cycav_percentile_sl(&queue_dist_cycav_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile_sl = outputLaneExit.Queue_dist_cycav_percentile_sl
        ```

### Queue_dist_greenstart_mean_sl {#queue_dist_greenstart_mean_sl}

```csharp
float Queue_dist_greenstart_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean_sl = outputLaneExit.Queue_dist_greenstart_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean_sl;
        outputLaneExit->get_Queue_dist_greenstart_mean_sl(&queue_dist_greenstart_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean_sl = outputLaneExit.Queue_dist_greenstart_mean_sl
        ```

### Queue_dist_greenstart_percentile_sl {#queue_dist_greenstart_percentile_sl}

```csharp
float Queue_dist_greenstart_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile_sl = outputLaneExit.Queue_dist_greenstart_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile_sl;
        outputLaneExit->get_Queue_dist_greenstart_percentile_sl(&queue_dist_greenstart_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile_sl = outputLaneExit.Queue_dist_greenstart_percentile_sl
        ```

### Queue_dist_maxback_mean_sl {#queue_dist_maxback_mean_sl}

```csharp
float Queue_dist_maxback_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean_sl = outputLaneExit.Queue_dist_maxback_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean_sl;
        outputLaneExit->get_Queue_dist_maxback_mean_sl(&queue_dist_maxback_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean_sl = outputLaneExit.Queue_dist_maxback_mean_sl
        ```

### Queue_dist_maxback_percentile_sl {#queue_dist_maxback_percentile_sl}

```csharp
float Queue_dist_maxback_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile_sl = outputLaneExit.Queue_dist_maxback_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile_sl;
        outputLaneExit->get_Queue_dist_maxback_percentile_sl(&queue_dist_maxback_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile_sl = outputLaneExit.Queue_dist_maxback_percentile_sl
        ```

### Queue_cycav_mean_ml {#queue_cycav_mean_ml}

```csharp
float Queue_cycav_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean_ml = outputLaneExit.Queue_cycav_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean_ml;
        outputLaneExit->get_Queue_cycav_mean_ml(&queue_cycav_mean_ml);
        ```

    === "Python"

        ```python
        queue_cycav_mean_ml = outputLaneExit.Queue_cycav_mean_ml
        ```

### Queue_cycav_percentile_ml {#queue_cycav_percentile_ml}

```csharp
float Queue_cycav_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile_ml = outputLaneExit.Queue_cycav_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile_ml;
        outputLaneExit->get_Queue_cycav_percentile_ml(&queue_cycav_percentile_ml);
        ```

    === "Python"

        ```python
        queue_cycav_percentile_ml = outputLaneExit.Queue_cycav_percentile_ml
        ```

### Queue_greenstart_mean_ml {#queue_greenstart_mean_ml}

```csharp
float Queue_greenstart_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean_ml = outputLaneExit.Queue_greenstart_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean_ml;
        outputLaneExit->get_Queue_greenstart_mean_ml(&queue_greenstart_mean_ml);
        ```

    === "Python"

        ```python
        queue_greenstart_mean_ml = outputLaneExit.Queue_greenstart_mean_ml
        ```

### Queue_greenstart_percentile_ml {#queue_greenstart_percentile_ml}

```csharp
float Queue_greenstart_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile_ml = outputLaneExit.Queue_greenstart_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile_ml;
        outputLaneExit->get_Queue_greenstart_percentile_ml(&queue_greenstart_percentile_ml);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile_ml = outputLaneExit.Queue_greenstart_percentile_ml
        ```

### Queue_maxback_mean_ml {#queue_maxback_mean_ml}

```csharp
float Queue_maxback_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean_ml = outputLaneExit.Queue_maxback_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean_ml;
        outputLaneExit->get_Queue_maxback_mean_ml(&queue_maxback_mean_ml);
        ```

    === "Python"

        ```python
        queue_maxback_mean_ml = outputLaneExit.Queue_maxback_mean_ml
        ```

### Queue_maxback_percentile_ml {#queue_maxback_percentile_ml}

```csharp
float Queue_maxback_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile_ml = outputLaneExit.Queue_maxback_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile_ml;
        outputLaneExit->get_Queue_maxback_percentile_ml(&queue_maxback_percentile_ml);
        ```

    === "Python"

        ```python
        queue_maxback_percentile_ml = outputLaneExit.Queue_maxback_percentile_ml
        ```

### Queue_dist_cycav_mean_ml {#queue_dist_cycav_mean_ml}

```csharp
float Queue_dist_cycav_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean_ml = outputLaneExit.Queue_dist_cycav_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean_ml;
        outputLaneExit->get_Queue_dist_cycav_mean_ml(&queue_dist_cycav_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean_ml = outputLaneExit.Queue_dist_cycav_mean_ml
        ```

### Queue_dist_cycav_percentile_ml {#queue_dist_cycav_percentile_ml}

```csharp
float Queue_dist_cycav_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile_ml = outputLaneExit.Queue_dist_cycav_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile_ml;
        outputLaneExit->get_Queue_dist_cycav_percentile_ml(&queue_dist_cycav_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile_ml = outputLaneExit.Queue_dist_cycav_percentile_ml
        ```

### Queue_dist_greenstart_mean_ml {#queue_dist_greenstart_mean_ml}

```csharp
float Queue_dist_greenstart_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean_ml = outputLaneExit.Queue_dist_greenstart_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean_ml;
        outputLaneExit->get_Queue_dist_greenstart_mean_ml(&queue_dist_greenstart_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean_ml = outputLaneExit.Queue_dist_greenstart_mean_ml
        ```

### Queue_dist_greenstart_percentile_ml {#queue_dist_greenstart_percentile_ml}

```csharp
float Queue_dist_greenstart_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile_ml = outputLaneExit.Queue_dist_greenstart_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile_ml;
        outputLaneExit->get_Queue_dist_greenstart_percentile_ml(&queue_dist_greenstart_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile_ml = outputLaneExit.Queue_dist_greenstart_percentile_ml
        ```

### Queue_dist_maxback_mean_ml {#queue_dist_maxback_mean_ml}

```csharp
float Queue_dist_maxback_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean_ml = outputLaneExit.Queue_dist_maxback_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean_ml;
        outputLaneExit->get_Queue_dist_maxback_mean_ml(&queue_dist_maxback_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean_ml = outputLaneExit.Queue_dist_maxback_mean_ml
        ```

### Queue_dist_maxback_percentile_ml {#queue_dist_maxback_percentile_ml}

```csharp
float Queue_dist_maxback_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile_ml = outputLaneExit.Queue_dist_maxback_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile_ml;
        outputLaneExit->get_Queue_dist_maxback_percentile_ml(&queue_dist_maxback_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile_ml = outputLaneExit.Queue_dist_maxback_percentile_ml
        ```

### OutputLaneExitMCs {#outputlaneexitmcs}

```csharp
ISIAPIOutputLaneExitMCs OutputLaneExitMCs { get; }
```

**Type** [`ISIAPIOutputLaneExitMCs`](sidrasolutions.si.api.isiapioutputlaneexitmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneExitMCs = outputLaneExit.OutputLaneExitMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneExitMCs> outputLaneExitMCs;
        outputLaneExit->get_OutputLaneExitMCs(&outputLaneExitMCs);
        ```

    === "Python"

        ```python
        output_lane_exit_m_cs = outputLaneExit.OutputLaneExitMCs
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneexitmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneExitMC
title: OutputLaneExitMC
name: ISIAPIOutputLaneExitMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E015316B-6001-4406-B52F-778C45264B6D
members:
  - int MC_class
  - float Flow
  - float Flow_capconstr
  - float Queue_cycav_mean_sl
  - float Queue_cycav_percentile_sl
  - float Queue_greenstart_mean_sl
  - float Queue_greenstart_percentile_sl
  - float Queue_maxback_mean_sl
  - float Queue_maxback_percentile_sl
  - float Queue_dist_cycav_mean_sl
  - float Queue_dist_cycav_percentile_sl
  - float Queue_dist_greenstart_mean_sl
  - float Queue_dist_greenstart_percentile_sl
  - float Queue_dist_maxback_mean_sl
  - float Queue_dist_maxback_percentile_sl
  - float Queue_cycav_mean_ml
  - float Queue_cycav_percentile_ml
  - float Queue_greenstart_mean_ml
  - float Queue_greenstart_percentile_ml
  - float Queue_maxback_mean_ml
  - float Queue_maxback_percentile_ml
  - float Queue_dist_cycav_mean_ml
  - float Queue_dist_cycav_percentile_ml
  - float Queue_dist_greenstart_mean_ml
  - float Queue_dist_greenstart_percentile_ml
  - float Queue_dist_maxback_mean_ml
  - float Queue_dist_maxback_percentile_ml
  - ISIAPIOutputLaneExit OutputLaneExit
---

# OutputLaneExitMC

Type `ISIAPIOutputLaneExitMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E015316B-6001-4406-B52F-778C45264B6D`

## Declaration

```csharp
[Guid("E015316B-6001-4406-B52F-778C45264B6D")]
public interface ISIAPIOutputLaneExitMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Flow](#flow) | `float` |  |
| [Flow_capconstr](#flow_capconstr) | `float` |  |
| [Queue_cycav_mean_sl](#queue_cycav_mean_sl) | `float` |  |
| [Queue_cycav_percentile_sl](#queue_cycav_percentile_sl) | `float` |  |
| [Queue_greenstart_mean_sl](#queue_greenstart_mean_sl) | `float` |  |
| [Queue_greenstart_percentile_sl](#queue_greenstart_percentile_sl) | `float` |  |
| [Queue_maxback_mean_sl](#queue_maxback_mean_sl) | `float` |  |
| [Queue_maxback_percentile_sl](#queue_maxback_percentile_sl) | `float` |  |
| [Queue_dist_cycav_mean_sl](#queue_dist_cycav_mean_sl) | `float` |  |
| [Queue_dist_cycav_percentile_sl](#queue_dist_cycav_percentile_sl) | `float` |  |
| [Queue_dist_greenstart_mean_sl](#queue_dist_greenstart_mean_sl) | `float` |  |
| [Queue_dist_greenstart_percentile_sl](#queue_dist_greenstart_percentile_sl) | `float` |  |
| [Queue_dist_maxback_mean_sl](#queue_dist_maxback_mean_sl) | `float` |  |
| [Queue_dist_maxback_percentile_sl](#queue_dist_maxback_percentile_sl) | `float` |  |
| [Queue_cycav_mean_ml](#queue_cycav_mean_ml) | `float` |  |
| [Queue_cycav_percentile_ml](#queue_cycav_percentile_ml) | `float` |  |
| [Queue_greenstart_mean_ml](#queue_greenstart_mean_ml) | `float` |  |
| [Queue_greenstart_percentile_ml](#queue_greenstart_percentile_ml) | `float` |  |
| [Queue_maxback_mean_ml](#queue_maxback_mean_ml) | `float` |  |
| [Queue_maxback_percentile_ml](#queue_maxback_percentile_ml) | `float` |  |
| [Queue_dist_cycav_mean_ml](#queue_dist_cycav_mean_ml) | `float` |  |
| [Queue_dist_cycav_percentile_ml](#queue_dist_cycav_percentile_ml) | `float` |  |
| [Queue_dist_greenstart_mean_ml](#queue_dist_greenstart_mean_ml) | `float` |  |
| [Queue_dist_greenstart_percentile_ml](#queue_dist_greenstart_percentile_ml) | `float` |  |
| [Queue_dist_maxback_mean_ml](#queue_dist_maxback_mean_ml) | `float` |  |
| [Queue_dist_maxback_percentile_ml](#queue_dist_maxback_percentile_ml) | `float` |  |
| [OutputLaneExit](#outputlaneexit) | [`ISIAPIOutputLaneExit`](sidrasolutions.si.api.isiapioutputlaneexit.md) |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputLaneExitMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputLaneExitMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputLaneExitMC.MC_class
        ```

### Flow {#flow}

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputLaneExitMC.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputLaneExitMC->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputLaneExitMC.Flow
        ```

### Flow_capconstr {#flow_capconstr}

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputLaneExitMC.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputLaneExitMC->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputLaneExitMC.Flow_capconstr
        ```

### Queue_cycav_mean_sl {#queue_cycav_mean_sl}

```csharp
float Queue_cycav_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean_sl = outputLaneExitMC.Queue_cycav_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean_sl;
        outputLaneExitMC->get_Queue_cycav_mean_sl(&queue_cycav_mean_sl);
        ```

    === "Python"

        ```python
        queue_cycav_mean_sl = outputLaneExitMC.Queue_cycav_mean_sl
        ```

### Queue_cycav_percentile_sl {#queue_cycav_percentile_sl}

```csharp
float Queue_cycav_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile_sl = outputLaneExitMC.Queue_cycav_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile_sl;
        outputLaneExitMC->get_Queue_cycav_percentile_sl(&queue_cycav_percentile_sl);
        ```

    === "Python"

        ```python
        queue_cycav_percentile_sl = outputLaneExitMC.Queue_cycav_percentile_sl
        ```

### Queue_greenstart_mean_sl {#queue_greenstart_mean_sl}

```csharp
float Queue_greenstart_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean_sl = outputLaneExitMC.Queue_greenstart_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean_sl;
        outputLaneExitMC->get_Queue_greenstart_mean_sl(&queue_greenstart_mean_sl);
        ```

    === "Python"

        ```python
        queue_greenstart_mean_sl = outputLaneExitMC.Queue_greenstart_mean_sl
        ```

### Queue_greenstart_percentile_sl {#queue_greenstart_percentile_sl}

```csharp
float Queue_greenstart_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile_sl = outputLaneExitMC.Queue_greenstart_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile_sl;
        outputLaneExitMC->get_Queue_greenstart_percentile_sl(&queue_greenstart_percentile_sl);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile_sl = outputLaneExitMC.Queue_greenstart_percentile_sl
        ```

### Queue_maxback_mean_sl {#queue_maxback_mean_sl}

```csharp
float Queue_maxback_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean_sl = outputLaneExitMC.Queue_maxback_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean_sl;
        outputLaneExitMC->get_Queue_maxback_mean_sl(&queue_maxback_mean_sl);
        ```

    === "Python"

        ```python
        queue_maxback_mean_sl = outputLaneExitMC.Queue_maxback_mean_sl
        ```

### Queue_maxback_percentile_sl {#queue_maxback_percentile_sl}

```csharp
float Queue_maxback_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile_sl = outputLaneExitMC.Queue_maxback_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile_sl;
        outputLaneExitMC->get_Queue_maxback_percentile_sl(&queue_maxback_percentile_sl);
        ```

    === "Python"

        ```python
        queue_maxback_percentile_sl = outputLaneExitMC.Queue_maxback_percentile_sl
        ```

### Queue_dist_cycav_mean_sl {#queue_dist_cycav_mean_sl}

```csharp
float Queue_dist_cycav_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean_sl = outputLaneExitMC.Queue_dist_cycav_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean_sl;
        outputLaneExitMC->get_Queue_dist_cycav_mean_sl(&queue_dist_cycav_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean_sl = outputLaneExitMC.Queue_dist_cycav_mean_sl
        ```

### Queue_dist_cycav_percentile_sl {#queue_dist_cycav_percentile_sl}

```csharp
float Queue_dist_cycav_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile_sl = outputLaneExitMC.Queue_dist_cycav_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile_sl;
        outputLaneExitMC->get_Queue_dist_cycav_percentile_sl(&queue_dist_cycav_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile_sl = outputLaneExitMC.Queue_dist_cycav_percentile_sl
        ```

### Queue_dist_greenstart_mean_sl {#queue_dist_greenstart_mean_sl}

```csharp
float Queue_dist_greenstart_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean_sl = outputLaneExitMC.Queue_dist_greenstart_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean_sl;
        outputLaneExitMC->get_Queue_dist_greenstart_mean_sl(&queue_dist_greenstart_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean_sl = outputLaneExitMC.Queue_dist_greenstart_mean_sl
        ```

### Queue_dist_greenstart_percentile_sl {#queue_dist_greenstart_percentile_sl}

```csharp
float Queue_dist_greenstart_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile_sl = outputLaneExitMC.Queue_dist_greenstart_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile_sl;
        outputLaneExitMC->get_Queue_dist_greenstart_percentile_sl(&queue_dist_greenstart_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile_sl = outputLaneExitMC.Queue_dist_greenstart_percentile_sl
        ```

### Queue_dist_maxback_mean_sl {#queue_dist_maxback_mean_sl}

```csharp
float Queue_dist_maxback_mean_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean_sl = outputLaneExitMC.Queue_dist_maxback_mean_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean_sl;
        outputLaneExitMC->get_Queue_dist_maxback_mean_sl(&queue_dist_maxback_mean_sl);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean_sl = outputLaneExitMC.Queue_dist_maxback_mean_sl
        ```

### Queue_dist_maxback_percentile_sl {#queue_dist_maxback_percentile_sl}

```csharp
float Queue_dist_maxback_percentile_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile_sl = outputLaneExitMC.Queue_dist_maxback_percentile_sl;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile_sl;
        outputLaneExitMC->get_Queue_dist_maxback_percentile_sl(&queue_dist_maxback_percentile_sl);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile_sl = outputLaneExitMC.Queue_dist_maxback_percentile_sl
        ```

### Queue_cycav_mean_ml {#queue_cycav_mean_ml}

```csharp
float Queue_cycav_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean_ml = outputLaneExitMC.Queue_cycav_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean_ml;
        outputLaneExitMC->get_Queue_cycav_mean_ml(&queue_cycav_mean_ml);
        ```

    === "Python"

        ```python
        queue_cycav_mean_ml = outputLaneExitMC.Queue_cycav_mean_ml
        ```

### Queue_cycav_percentile_ml {#queue_cycav_percentile_ml}

```csharp
float Queue_cycav_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile_ml = outputLaneExitMC.Queue_cycav_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile_ml;
        outputLaneExitMC->get_Queue_cycav_percentile_ml(&queue_cycav_percentile_ml);
        ```

    === "Python"

        ```python
        queue_cycav_percentile_ml = outputLaneExitMC.Queue_cycav_percentile_ml
        ```

### Queue_greenstart_mean_ml {#queue_greenstart_mean_ml}

```csharp
float Queue_greenstart_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean_ml = outputLaneExitMC.Queue_greenstart_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean_ml;
        outputLaneExitMC->get_Queue_greenstart_mean_ml(&queue_greenstart_mean_ml);
        ```

    === "Python"

        ```python
        queue_greenstart_mean_ml = outputLaneExitMC.Queue_greenstart_mean_ml
        ```

### Queue_greenstart_percentile_ml {#queue_greenstart_percentile_ml}

```csharp
float Queue_greenstart_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile_ml = outputLaneExitMC.Queue_greenstart_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile_ml;
        outputLaneExitMC->get_Queue_greenstart_percentile_ml(&queue_greenstart_percentile_ml);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile_ml = outputLaneExitMC.Queue_greenstart_percentile_ml
        ```

### Queue_maxback_mean_ml {#queue_maxback_mean_ml}

```csharp
float Queue_maxback_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean_ml = outputLaneExitMC.Queue_maxback_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean_ml;
        outputLaneExitMC->get_Queue_maxback_mean_ml(&queue_maxback_mean_ml);
        ```

    === "Python"

        ```python
        queue_maxback_mean_ml = outputLaneExitMC.Queue_maxback_mean_ml
        ```

### Queue_maxback_percentile_ml {#queue_maxback_percentile_ml}

```csharp
float Queue_maxback_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile_ml = outputLaneExitMC.Queue_maxback_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile_ml;
        outputLaneExitMC->get_Queue_maxback_percentile_ml(&queue_maxback_percentile_ml);
        ```

    === "Python"

        ```python
        queue_maxback_percentile_ml = outputLaneExitMC.Queue_maxback_percentile_ml
        ```

### Queue_dist_cycav_mean_ml {#queue_dist_cycav_mean_ml}

```csharp
float Queue_dist_cycav_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean_ml = outputLaneExitMC.Queue_dist_cycav_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean_ml;
        outputLaneExitMC->get_Queue_dist_cycav_mean_ml(&queue_dist_cycav_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean_ml = outputLaneExitMC.Queue_dist_cycav_mean_ml
        ```

### Queue_dist_cycav_percentile_ml {#queue_dist_cycav_percentile_ml}

```csharp
float Queue_dist_cycav_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile_ml = outputLaneExitMC.Queue_dist_cycav_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile_ml;
        outputLaneExitMC->get_Queue_dist_cycav_percentile_ml(&queue_dist_cycav_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile_ml = outputLaneExitMC.Queue_dist_cycav_percentile_ml
        ```

### Queue_dist_greenstart_mean_ml {#queue_dist_greenstart_mean_ml}

```csharp
float Queue_dist_greenstart_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean_ml = outputLaneExitMC.Queue_dist_greenstart_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean_ml;
        outputLaneExitMC->get_Queue_dist_greenstart_mean_ml(&queue_dist_greenstart_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean_ml = outputLaneExitMC.Queue_dist_greenstart_mean_ml
        ```

### Queue_dist_greenstart_percentile_ml {#queue_dist_greenstart_percentile_ml}

```csharp
float Queue_dist_greenstart_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile_ml = outputLaneExitMC.Queue_dist_greenstart_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile_ml;
        outputLaneExitMC->get_Queue_dist_greenstart_percentile_ml(&queue_dist_greenstart_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile_ml = outputLaneExitMC.Queue_dist_greenstart_percentile_ml
        ```

### Queue_dist_maxback_mean_ml {#queue_dist_maxback_mean_ml}

```csharp
float Queue_dist_maxback_mean_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean_ml = outputLaneExitMC.Queue_dist_maxback_mean_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean_ml;
        outputLaneExitMC->get_Queue_dist_maxback_mean_ml(&queue_dist_maxback_mean_ml);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean_ml = outputLaneExitMC.Queue_dist_maxback_mean_ml
        ```

### Queue_dist_maxback_percentile_ml {#queue_dist_maxback_percentile_ml}

```csharp
float Queue_dist_maxback_percentile_ml { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile_ml = outputLaneExitMC.Queue_dist_maxback_percentile_ml;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile_ml;
        outputLaneExitMC->get_Queue_dist_maxback_percentile_ml(&queue_dist_maxback_percentile_ml);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile_ml = outputLaneExitMC.Queue_dist_maxback_percentile_ml
        ```

### OutputLaneExit {#outputlaneexit}

```csharp
ISIAPIOutputLaneExit OutputLaneExit { get; }
```

**Type** [`ISIAPIOutputLaneExit`](sidrasolutions.si.api.isiapioutputlaneexit.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneExit = outputLaneExitMC.OutputLaneExit;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneExit> outputLaneExit;
        outputLaneExitMC->get_OutputLaneExit(&outputLaneExit);
        ```

    === "Python"

        ```python
        output_lane_exit = outputLaneExitMC.OutputLaneExit
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneexitmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneExitMCs
title: OutputLaneExitMCs
name: ISIAPIOutputLaneExitMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1D185490-011A-46F0-8C78-3FCC3F5F10C4
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputLaneExitMC this[int mcClass]
  - int Count
---

# OutputLaneExitMCs

Type `ISIAPIOutputLaneExitMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1D185490-011A-46F0-8C78-3FCC3F5F10C4`

## Declaration

```csharp
[Guid("1D185490-011A-46F0-8C78-3FCC3F5F10C4")]
public interface ISIAPIOutputLaneExitMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneExitMC`](sidrasolutions.si.api.isiapioutputlaneexitmc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneExitMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneExitMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneExitMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLaneExitMC this[] { get; }
```

**Type** [`ISIAPIOutputLaneExitMC`](sidrasolutions.si.api.isiapioutputlaneexitmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneExitMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneExitMC> this[];
        outputLaneExitMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneExitMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneExitMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneExitMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneExitMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneexits.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneExits
title: OutputLaneExits
name: ISIAPIOutputLaneExits
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 3090F809-68DB-4B88-88A5-2159F20BC602
members:
  - bool LaneExists(int laneno)
  - ISIAPIOutputLaneExit this[int laneno]
  - int Count
---

# OutputLaneExits

Type `ISIAPIOutputLaneExits` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `3090F809-68DB-4B88-88A5-2159F20BC602`

## Declaration

```csharp
[Guid("3090F809-68DB-4B88-88A5-2159F20BC602")]
public interface ISIAPIOutputLaneExits
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneExit`](sidrasolutions.si.api.isiapioutputlaneexit.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneExists(int)](#laneexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneExits.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneExits->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneExits.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLaneExit this[] { get; }
```

**Type** [`ISIAPIOutputLaneExit`](sidrasolutions.si.api.isiapioutputlaneexit.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneExits.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneExit> this[];
        outputLaneExits->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneExits.this[]
        ```

## Methods

### LaneExists(int) {#laneexists-int}

```csharp
bool LaneExists(int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `laneno` | `int` | Exit Lane Number, a one-based integer, counts Exit Lanes only from left to right looking in the direction of departure. |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneExits.LaneExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneExits->LaneExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneExits.LaneExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlanegreenperiod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneGreenPeriod
title: OutputLaneGreenPeriod
name: ISIAPIOutputLaneGreenPeriod
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8C3CB55E-9E04-47B2-93D8-F72F530EF153
members:
  - int Greenperiod
  - float Capacity
  - float Green_start_time
  - float Green_end_time
  - float Satflow_full
  - float Satflow_reduced
  - float Satflow_laneblock_adj
  - float Satflow_queuecleartime_adj
  - bool Shortlane_effect
  - float Eff_green_start
  - float End_sat_green
  - float Eff_green_end
  - float Green_satn_time
  - float Queclearance_time
  - float Residual_queue
  - float Flow_ratio
  - float Green_ratio
  - float Queue_discharge_rate
  - int Depflow_gt_adjsatn
  - ISIAPIOutputLane OutputLane
---

# OutputLaneGreenPeriod

Type `ISIAPIOutputLaneGreenPeriod` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8C3CB55E-9E04-47B2-93D8-F72F530EF153`

## Declaration

```csharp
[Guid("8C3CB55E-9E04-47B2-93D8-F72F530EF153")]
public interface ISIAPIOutputLaneGreenPeriod
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Greenperiod](#greenperiod) | `int` | Green Period value is a one-based integer. |
| [Capacity](#capacity) | `float` |  |
| [Green_start_time](#green_start_time) | `float` |  |
| [Green_end_time](#green_end_time) | `float` |  |
| [Satflow_full](#satflow_full) | `float` |  |
| [Satflow_reduced](#satflow_reduced) | `float` |  |
| [Satflow_laneblock_adj](#satflow_laneblock_adj) | `float` |  |
| [Satflow_queuecleartime_adj](#satflow_queuecleartime_adj) | `float` |  |
| [Shortlane_effect](#shortlane_effect) | `bool` |  |
| [Eff_green_start](#eff_green_start) | `float` |  |
| [End_sat_green](#end_sat_green) | `float` |  |
| [Eff_green_end](#eff_green_end) | `float` |  |
| [Green_satn_time](#green_satn_time) | `float` |  |
| [Queclearance_time](#queclearance_time) | `float` |  |
| [Residual_queue](#residual_queue) | `float` |  |
| [Flow_ratio](#flow_ratio) | `float` |  |
| [Green_ratio](#green_ratio) | `float` |  |
| [Queue_discharge_rate](#queue_discharge_rate) | `float` |  |
| [Depflow_gt_adjsatn](#depflow_gt_adjsatn) | `int` |  |
| [OutputLane](#outputlane) | [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md) |  |

</div>

## Properties

### Greenperiod {#greenperiod}

Green Period value is a one-based integer.

```csharp
int Greenperiod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int greenperiod = outputLaneGreenPeriod.Greenperiod;
        ```

    === "C++"

        ```cpp
        long greenperiod;
        outputLaneGreenPeriod->get_Greenperiod(&greenperiod);
        ```

    === "Python"

        ```python
        greenperiod = outputLaneGreenPeriod.Greenperiod
        ```

### Capacity {#capacity}

```csharp
float Capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity = outputLaneGreenPeriod.Capacity;
        ```

    === "C++"

        ```cpp
        double capacity;
        outputLaneGreenPeriod->get_Capacity(&capacity);
        ```

    === "Python"

        ```python
        capacity = outputLaneGreenPeriod.Capacity
        ```

### Green_start_time {#green_start_time}

```csharp
float Green_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_start_time = outputLaneGreenPeriod.Green_start_time;
        ```

    === "C++"

        ```cpp
        double green_start_time;
        outputLaneGreenPeriod->get_Green_start_time(&green_start_time);
        ```

    === "Python"

        ```python
        green_start_time = outputLaneGreenPeriod.Green_start_time
        ```

### Green_end_time {#green_end_time}

```csharp
float Green_end_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_end_time = outputLaneGreenPeriod.Green_end_time;
        ```

    === "C++"

        ```cpp
        double green_end_time;
        outputLaneGreenPeriod->get_Green_end_time(&green_end_time);
        ```

    === "Python"

        ```python
        green_end_time = outputLaneGreenPeriod.Green_end_time
        ```

### Satflow_full {#satflow_full}

```csharp
float Satflow_full { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_full = outputLaneGreenPeriod.Satflow_full;
        ```

    === "C++"

        ```cpp
        double satflow_full;
        outputLaneGreenPeriod->get_Satflow_full(&satflow_full);
        ```

    === "Python"

        ```python
        satflow_full = outputLaneGreenPeriod.Satflow_full
        ```

### Satflow_reduced {#satflow_reduced}

```csharp
float Satflow_reduced { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_reduced = outputLaneGreenPeriod.Satflow_reduced;
        ```

    === "C++"

        ```cpp
        double satflow_reduced;
        outputLaneGreenPeriod->get_Satflow_reduced(&satflow_reduced);
        ```

    === "Python"

        ```python
        satflow_reduced = outputLaneGreenPeriod.Satflow_reduced
        ```

### Satflow_laneblock_adj {#satflow_laneblock_adj}

```csharp
float Satflow_laneblock_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_laneblock_adj = outputLaneGreenPeriod.Satflow_laneblock_adj;
        ```

    === "C++"

        ```cpp
        double satflow_laneblock_adj;
        outputLaneGreenPeriod->get_Satflow_laneblock_adj(&satflow_laneblock_adj);
        ```

    === "Python"

        ```python
        satflow_laneblock_adj = outputLaneGreenPeriod.Satflow_laneblock_adj
        ```

### Satflow_queuecleartime_adj {#satflow_queuecleartime_adj}

```csharp
float Satflow_queuecleartime_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satflow_queuecleartime_adj = outputLaneGreenPeriod.Satflow_queuecleartime_adj;
        ```

    === "C++"

        ```cpp
        double satflow_queuecleartime_adj;
        outputLaneGreenPeriod->get_Satflow_queuecleartime_adj(&satflow_queuecleartime_adj);
        ```

    === "Python"

        ```python
        satflow_queuecleartime_adj = outputLaneGreenPeriod.Satflow_queuecleartime_adj
        ```

### Shortlane_effect {#shortlane_effect}

```csharp
bool Shortlane_effect { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool shortlane_effect = outputLaneGreenPeriod.Shortlane_effect;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL shortlane_effect;
        outputLaneGreenPeriod->get_Shortlane_effect(&shortlane_effect);
        ```

    === "Python"

        ```python
        shortlane_effect = outputLaneGreenPeriod.Shortlane_effect
        ```

### Eff_green_start {#eff_green_start}

```csharp
float Eff_green_start { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_green_start = outputLaneGreenPeriod.Eff_green_start;
        ```

    === "C++"

        ```cpp
        double eff_green_start;
        outputLaneGreenPeriod->get_Eff_green_start(&eff_green_start);
        ```

    === "Python"

        ```python
        eff_green_start = outputLaneGreenPeriod.Eff_green_start
        ```

### End_sat_green {#end_sat_green}

```csharp
float End_sat_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_sat_green = outputLaneGreenPeriod.End_sat_green;
        ```

    === "C++"

        ```cpp
        double end_sat_green;
        outputLaneGreenPeriod->get_End_sat_green(&end_sat_green);
        ```

    === "Python"

        ```python
        end_sat_green = outputLaneGreenPeriod.End_sat_green
        ```

### Eff_green_end {#eff_green_end}

```csharp
float Eff_green_end { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_green_end = outputLaneGreenPeriod.Eff_green_end;
        ```

    === "C++"

        ```cpp
        double eff_green_end;
        outputLaneGreenPeriod->get_Eff_green_end(&eff_green_end);
        ```

    === "Python"

        ```python
        eff_green_end = outputLaneGreenPeriod.Eff_green_end
        ```

### Green_satn_time {#green_satn_time}

```csharp
float Green_satn_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_satn_time = outputLaneGreenPeriod.Green_satn_time;
        ```

    === "C++"

        ```cpp
        double green_satn_time;
        outputLaneGreenPeriod->get_Green_satn_time(&green_satn_time);
        ```

    === "Python"

        ```python
        green_satn_time = outputLaneGreenPeriod.Green_satn_time
        ```

### Queclearance_time {#queclearance_time}

```csharp
float Queclearance_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queclearance_time = outputLaneGreenPeriod.Queclearance_time;
        ```

    === "C++"

        ```cpp
        double queclearance_time;
        outputLaneGreenPeriod->get_Queclearance_time(&queclearance_time);
        ```

    === "Python"

        ```python
        queclearance_time = outputLaneGreenPeriod.Queclearance_time
        ```

### Residual_queue {#residual_queue}

```csharp
float Residual_queue { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float residual_queue = outputLaneGreenPeriod.Residual_queue;
        ```

    === "C++"

        ```cpp
        double residual_queue;
        outputLaneGreenPeriod->get_Residual_queue(&residual_queue);
        ```

    === "Python"

        ```python
        residual_queue = outputLaneGreenPeriod.Residual_queue
        ```

### Flow_ratio {#flow_ratio}

```csharp
float Flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_ratio = outputLaneGreenPeriod.Flow_ratio;
        ```

    === "C++"

        ```cpp
        double flow_ratio;
        outputLaneGreenPeriod->get_Flow_ratio(&flow_ratio);
        ```

    === "Python"

        ```python
        flow_ratio = outputLaneGreenPeriod.Flow_ratio
        ```

### Green_ratio {#green_ratio}

```csharp
float Green_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_ratio = outputLaneGreenPeriod.Green_ratio;
        ```

    === "C++"

        ```cpp
        double green_ratio;
        outputLaneGreenPeriod->get_Green_ratio(&green_ratio);
        ```

    === "Python"

        ```python
        green_ratio = outputLaneGreenPeriod.Green_ratio
        ```

### Queue_discharge_rate {#queue_discharge_rate}

```csharp
float Queue_discharge_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_discharge_rate = outputLaneGreenPeriod.Queue_discharge_rate;
        ```

    === "C++"

        ```cpp
        double queue_discharge_rate;
        outputLaneGreenPeriod->get_Queue_discharge_rate(&queue_discharge_rate);
        ```

    === "Python"

        ```python
        queue_discharge_rate = outputLaneGreenPeriod.Queue_discharge_rate
        ```

### Depflow_gt_adjsatn {#depflow_gt_adjsatn}

```csharp
int Depflow_gt_adjsatn { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int depflow_gt_adjsatn = outputLaneGreenPeriod.Depflow_gt_adjsatn;
        ```

    === "C++"

        ```cpp
        long depflow_gt_adjsatn;
        outputLaneGreenPeriod->get_Depflow_gt_adjsatn(&depflow_gt_adjsatn);
        ```

    === "Python"

        ```python
        depflow_gt_adjsatn = outputLaneGreenPeriod.Depflow_gt_adjsatn
        ```

### OutputLane {#outputlane}

```csharp
ISIAPIOutputLane OutputLane { get; }
```

**Type** [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLane = outputLaneGreenPeriod.OutputLane;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLane> outputLane;
        outputLaneGreenPeriod->get_OutputLane(&outputLane);
        ```

    === "Python"

        ```python
        output_lane = outputLaneGreenPeriod.OutputLane
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlanegreenperiods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneGreenPeriods
title: OutputLaneGreenPeriods
name: ISIAPIOutputLaneGreenPeriods
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BA8098E8-4B17-4B4B-81F5-D8F8F0E7F425
members:
  - bool GreenPeriodExists(int greenperiod)
  - ISIAPIOutputLaneGreenPeriod this[int greenperiod]
  - int Count
---

# OutputLaneGreenPeriods

Type `ISIAPIOutputLaneGreenPeriods` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BA8098E8-4B17-4B4B-81F5-D8F8F0E7F425`

## Declaration

```csharp
[Guid("BA8098E8-4B17-4B4B-81F5-D8F8F0E7F425")]
public interface ISIAPIOutputLaneGreenPeriods
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneGreenPeriod`](sidrasolutions.si.api.isiapioutputlanegreenperiod.md) | Get an Approach Lane Output Green Period. Return an Approach Lane Output Green Period if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [GreenPeriodExists(int)](#greenperiodexists-int) | `bool` | Get a value indicating whether an Approach Lane Output Green Period exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneGreenPeriods.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneGreenPeriods->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneGreenPeriods.Count
        ```

### this[] {#this}

Get an Approach Lane Output Green Period.  
Return an Approach Lane Output Green Period if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputLaneGreenPeriod this[] { get; }
```

**Type** [`ISIAPIOutputLaneGreenPeriod`](sidrasolutions.si.api.isiapioutputlanegreenperiod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneGreenPeriods.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneGreenPeriod> this[];
        outputLaneGreenPeriods->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneGreenPeriods.this[]
        ```

## Methods

### GreenPeriodExists(int) {#greenperiodexists-int}

Get a value indicating whether an Approach Lane Output Green Period exists in the data storage.

```csharp
bool GreenPeriodExists(int greenperiod)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `greenperiod` | `int` | A one-based integer. |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneGreenPeriods.GreenPeriodExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneGreenPeriods->GreenPeriodExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneGreenPeriods.GreenPeriodExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlanemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneMC
title: OutputLaneMC
name: ISIAPIOutputLaneMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 871F9363-DA34-46A1-8165-F8425303574A
members:
  - int MC_class
  - bool Calc_exists
  - float Flow_total
  - float Flow_total_capconstr
  - float Upstr_flow_after_exit_sl
  - float Lane_change_from_left
  - float Lane_change_to_left
  - float Lane_change_from_right
  - float Lane_change_to_right
  - bool Exist_in_nw_upstream_only
  - float Net_inflow
  - float Net_inflow_capconstr
  - ISIAPIOutputLane OutputLane
  - int Arrival_flow_flag
---

# OutputLaneMC

Type `ISIAPIOutputLaneMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `871F9363-DA34-46A1-8165-F8425303574A`

## Declaration

```csharp
[Guid("871F9363-DA34-46A1-8165-F8425303574A")]
public interface ISIAPIOutputLaneMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Flow_total](#flow_total) | `float` |  |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` |  |
| [Upstr_flow_after_exit_sl](#upstr_flow_after_exit_sl) | `float` |  |
| [Lane_change_from_left](#lane_change_from_left) | `float` |  |
| [Lane_change_to_left](#lane_change_to_left) | `float` |  |
| [Lane_change_from_right](#lane_change_from_right) | `float` |  |
| [Lane_change_to_right](#lane_change_to_right) | `float` |  |
| [Exist_in_nw_upstream_only](#exist_in_nw_upstream_only) | `bool` |  |
| [Net_inflow](#net_inflow) | `float` |  |
| [Net_inflow_capconstr](#net_inflow_capconstr) | `float` |  |
| [OutputLane](#outputlane) | [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md) |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputLaneMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputLaneMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputLaneMC.MC_class
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputLaneMC.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputLaneMC->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputLaneMC.Calc_exists
        ```

### Flow_total {#flow_total}

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputLaneMC.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputLaneMC->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputLaneMC.Flow_total
        ```

### Flow_total_capconstr {#flow_total_capconstr}

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputLaneMC.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputLaneMC->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputLaneMC.Flow_total_capconstr
        ```

### Upstr_flow_after_exit_sl {#upstr_flow_after_exit_sl}

```csharp
float Upstr_flow_after_exit_sl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float upstr_flow_after_exit_sl = outputLaneMC.Upstr_flow_after_exit_sl;
        ```

    === "C++"

        ```cpp
        double upstr_flow_after_exit_sl;
        outputLaneMC->get_Upstr_flow_after_exit_sl(&upstr_flow_after_exit_sl);
        ```

    === "Python"

        ```python
        upstr_flow_after_exit_sl = outputLaneMC.Upstr_flow_after_exit_sl
        ```

### Lane_change_from_left {#lane_change_from_left}

```csharp
float Lane_change_from_left { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_from_left = outputLaneMC.Lane_change_from_left;
        ```

    === "C++"

        ```cpp
        double lane_change_from_left;
        outputLaneMC->get_Lane_change_from_left(&lane_change_from_left);
        ```

    === "Python"

        ```python
        lane_change_from_left = outputLaneMC.Lane_change_from_left
        ```

### Lane_change_to_left {#lane_change_to_left}

```csharp
float Lane_change_to_left { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_to_left = outputLaneMC.Lane_change_to_left;
        ```

    === "C++"

        ```cpp
        double lane_change_to_left;
        outputLaneMC->get_Lane_change_to_left(&lane_change_to_left);
        ```

    === "Python"

        ```python
        lane_change_to_left = outputLaneMC.Lane_change_to_left
        ```

### Lane_change_from_right {#lane_change_from_right}

```csharp
float Lane_change_from_right { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_from_right = outputLaneMC.Lane_change_from_right;
        ```

    === "C++"

        ```cpp
        double lane_change_from_right;
        outputLaneMC->get_Lane_change_from_right(&lane_change_from_right);
        ```

    === "Python"

        ```python
        lane_change_from_right = outputLaneMC.Lane_change_from_right
        ```

### Lane_change_to_right {#lane_change_to_right}

```csharp
float Lane_change_to_right { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lane_change_to_right = outputLaneMC.Lane_change_to_right;
        ```

    === "C++"

        ```cpp
        double lane_change_to_right;
        outputLaneMC->get_Lane_change_to_right(&lane_change_to_right);
        ```

    === "Python"

        ```python
        lane_change_to_right = outputLaneMC.Lane_change_to_right
        ```

### Exist_in_nw_upstream_only {#exist_in_nw_upstream_only}

```csharp
bool Exist_in_nw_upstream_only { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exist_in_nw_upstream_only = outputLaneMC.Exist_in_nw_upstream_only;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exist_in_nw_upstream_only;
        outputLaneMC->get_Exist_in_nw_upstream_only(&exist_in_nw_upstream_only);
        ```

    === "Python"

        ```python
        exist_in_nw_upstream_only = outputLaneMC.Exist_in_nw_upstream_only
        ```

### Net_inflow {#net_inflow}

```csharp
float Net_inflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow = outputLaneMC.Net_inflow;
        ```

    === "C++"

        ```cpp
        double net_inflow;
        outputLaneMC->get_Net_inflow(&net_inflow);
        ```

    === "Python"

        ```python
        net_inflow = outputLaneMC.Net_inflow
        ```

### Net_inflow_capconstr {#net_inflow_capconstr}

```csharp
float Net_inflow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow_capconstr = outputLaneMC.Net_inflow_capconstr;
        ```

    === "C++"

        ```cpp
        double net_inflow_capconstr;
        outputLaneMC->get_Net_inflow_capconstr(&net_inflow_capconstr);
        ```

    === "Python"

        ```python
        net_inflow_capconstr = outputLaneMC.Net_inflow_capconstr
        ```

### OutputLane {#outputlane}

```csharp
ISIAPIOutputLane OutputLane { get; }
```

**Type** [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLane = outputLaneMC.OutputLane;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLane> outputLane;
        outputLaneMC->get_OutputLane(&outputLane);
        ```

    === "Python"

        ```python
        output_lane = outputLaneMC.OutputLane
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLaneMC.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLaneMC->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLaneMC.Arrival_flow_flag
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlanemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneMCs
title: OutputLaneMCs
name: ISIAPIOutputLaneMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 9461C66C-2AEE-4937-AE3F-B70B1A2C0AC4
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputLaneMC this[int mcClass]
  - int Count
---

# OutputLaneMCs

Type `ISIAPIOutputLaneMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `9461C66C-2AEE-4937-AE3F-B70B1A2C0AC4`

## Declaration

```csharp
[Guid("9461C66C-2AEE-4937-AE3F-B70B1A2C0AC4")]
public interface ISIAPIOutputLaneMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneMC`](sidrasolutions.si.api.isiapioutputlanemc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLaneMC this[] { get; }
```

**Type** [`ISIAPIOutputLaneMC`](sidrasolutions.si.api.isiapioutputlanemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneMC> this[];
        outputLaneMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneOD
title: OutputLaneOD
name: ISIAPIOutputLaneOD
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B0B8EDC4-C871-43B8-AEA8-012B6DE8A0F6
members:
  - int Destination
  - float Crit_gap
  - float Foll_up_hdwy
  - float Flow
  - float Flow_capconstr
  - bool Subdom_eq_dom
  - ISIAPIOutputLane OutputLane
  - ISIAPIOutputLaneODMCs OutputLaneODMCs
  - bool Calc_exists
  - float Critical_spacing
  - int Lane_output_type
  - float Opposing_flow
  - float HVE_pcu
  - float Opposing_flow_pcu
  - float Opposing_flow_ped
  - float Percent_nearest_lane_only
  - float Percent_exit_flow_incl
  - int Cap_constraint_effect
  - float OD_factor
  - float Average_speed
  - int Proportion_bunched_flag
  - float Proportion_bunched
  - float Intrabunch_headway
  - int Priority_sharing_flag
  - float HVE_for_entry
  - int OD_factor_flag
  - int Average_speed_flag
  - int Intrabunch_headway_flag
  - int Crit_gap_flag
  - int Foll_up_hdwy_flag
  - int Opposing_flow_flag
  - int Opposing_flow_ped_flag
  - int Arrival_flow_flag
  - float Unblocked_time_ratio
  - float Gap_accept_cycle_time
  - float Gap_accept_blocked_time
  - float Gap_accept_unblocked_time
  - float Minimum_delay
  - float Rou_ped_entry_adj_factor
---

# OutputLaneOD

Type `ISIAPIOutputLaneOD` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B0B8EDC4-C871-43B8-AEA8-012B6DE8A0F6`

## Declaration

```csharp
[Guid("B0B8EDC4-C871-43B8-AEA8-012B6DE8A0F6")]
public interface ISIAPIOutputLaneOD
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Destination](#destination) | `int` |  |
| [Crit_gap](#crit_gap) | `float` |  |
| [Foll_up_hdwy](#foll_up_hdwy) | `float` |  |
| [Flow](#flow) | `float` |  |
| [Flow_capconstr](#flow_capconstr) | `float` |  |
| [Subdom_eq_dom](#subdom_eq_dom) | `bool` |  |
| [OutputLane](#outputlane) | [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md) |  |
| [OutputLaneODMCs](#outputlaneodmcs) | [`ISIAPIOutputLaneODMCs`](sidrasolutions.si.api.isiapioutputlaneodmcs.md) |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Critical_spacing](#critical_spacing) | `float` |  |
| [Lane_output_type](#lane_output_type) | `int` |  |
| [Opposing_flow](#opposing_flow) | `float` |  |
| [HVE_pcu](#hve_pcu) | `float` |  |
| [Opposing_flow_pcu](#opposing_flow_pcu) | `float` |  |
| [Opposing_flow_ped](#opposing_flow_ped) | `float` |  |
| [Percent_nearest_lane_only](#percent_nearest_lane_only) | `float` |  |
| [Percent_exit_flow_incl](#percent_exit_flow_incl) | `float` |  |
| [Cap_constraint_effect](#cap_constraint_effect) | `int` |  |
| [OD_factor](#od_factor) | `float` |  |
| [Average_speed](#average_speed) | `float` |  |
| [Proportion_bunched_flag](#proportion_bunched_flag) | `int` |  |
| [Proportion_bunched](#proportion_bunched) | `float` |  |
| [Intrabunch_headway](#intrabunch_headway) | `float` |  |
| [Priority_sharing_flag](#priority_sharing_flag) | `int` |  |
| [HVE_for_entry](#hve_for_entry) | `float` |  |
| [OD_factor_flag](#od_factor_flag) | `int` |  |
| [Average_speed_flag](#average_speed_flag) | `int` |  |
| [Intrabunch_headway_flag](#intrabunch_headway_flag) | `int` |  |
| [Crit_gap_flag](#crit_gap_flag) | `int` |  |
| [Foll_up_hdwy_flag](#foll_up_hdwy_flag) | `int` |  |
| [Opposing_flow_flag](#opposing_flow_flag) | `int` |  |
| [Opposing_flow_ped_flag](#opposing_flow_ped_flag) | `int` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Unblocked_time_ratio](#unblocked_time_ratio) | `float` |  |
| [Gap_accept_cycle_time](#gap_accept_cycle_time) | `float` |  |
| [Gap_accept_blocked_time](#gap_accept_blocked_time) | `float` |  |
| [Gap_accept_unblocked_time](#gap_accept_unblocked_time) | `float` |  |
| [Minimum_delay](#minimum_delay) | `float` |  |
| [Rou_ped_entry_adj_factor](#rou_ped_entry_adj_factor) | `float` |  |

</div>

## Properties

### Destination {#destination}

```csharp
int Destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = outputLaneOD.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        outputLaneOD->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = outputLaneOD.Destination
        ```

### Crit_gap {#crit_gap}

```csharp
float Crit_gap { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float crit_gap = outputLaneOD.Crit_gap;
        ```

    === "C++"

        ```cpp
        double crit_gap;
        outputLaneOD->get_Crit_gap(&crit_gap);
        ```

    === "Python"

        ```python
        crit_gap = outputLaneOD.Crit_gap
        ```

### Foll_up_hdwy {#foll_up_hdwy}

```csharp
float Foll_up_hdwy { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float foll_up_hdwy = outputLaneOD.Foll_up_hdwy;
        ```

    === "C++"

        ```cpp
        double foll_up_hdwy;
        outputLaneOD->get_Foll_up_hdwy(&foll_up_hdwy);
        ```

    === "Python"

        ```python
        foll_up_hdwy = outputLaneOD.Foll_up_hdwy
        ```

### Flow {#flow}

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputLaneOD.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputLaneOD->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputLaneOD.Flow
        ```

### Flow_capconstr {#flow_capconstr}

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputLaneOD.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputLaneOD->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputLaneOD.Flow_capconstr
        ```

### Subdom_eq_dom {#subdom_eq_dom}

```csharp
bool Subdom_eq_dom { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool subdom_eq_dom = outputLaneOD.Subdom_eq_dom;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL subdom_eq_dom;
        outputLaneOD->get_Subdom_eq_dom(&subdom_eq_dom);
        ```

    === "Python"

        ```python
        subdom_eq_dom = outputLaneOD.Subdom_eq_dom
        ```

### OutputLane {#outputlane}

```csharp
ISIAPIOutputLane OutputLane { get; }
```

**Type** [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLane = outputLaneOD.OutputLane;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLane> outputLane;
        outputLaneOD->get_OutputLane(&outputLane);
        ```

    === "Python"

        ```python
        output_lane = outputLaneOD.OutputLane
        ```

### OutputLaneODMCs {#outputlaneodmcs}

```csharp
ISIAPIOutputLaneODMCs OutputLaneODMCs { get; }
```

**Type** [`ISIAPIOutputLaneODMCs`](sidrasolutions.si.api.isiapioutputlaneodmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneODMCs = outputLaneOD.OutputLaneODMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneODMCs> outputLaneODMCs;
        outputLaneOD->get_OutputLaneODMCs(&outputLaneODMCs);
        ```

    === "Python"

        ```python
        output_lane_odm_cs = outputLaneOD.OutputLaneODMCs
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputLaneOD.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputLaneOD->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputLaneOD.Calc_exists
        ```

### Critical_spacing {#critical_spacing}

```csharp
float Critical_spacing { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_spacing = outputLaneOD.Critical_spacing;
        ```

    === "C++"

        ```cpp
        double critical_spacing;
        outputLaneOD->get_Critical_spacing(&critical_spacing);
        ```

    === "Python"

        ```python
        critical_spacing = outputLaneOD.Critical_spacing
        ```

### Lane_output_type {#lane_output_type}

```csharp
int Lane_output_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int lane_output_type = outputLaneOD.Lane_output_type;
        ```

    === "C++"

        ```cpp
        long lane_output_type;
        outputLaneOD->get_Lane_output_type(&lane_output_type);
        ```

    === "Python"

        ```python
        lane_output_type = outputLaneOD.Lane_output_type
        ```

### Opposing_flow {#opposing_flow}

```csharp
float Opposing_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow = outputLaneOD.Opposing_flow;
        ```

    === "C++"

        ```cpp
        double opposing_flow;
        outputLaneOD->get_Opposing_flow(&opposing_flow);
        ```

    === "Python"

        ```python
        opposing_flow = outputLaneOD.Opposing_flow
        ```

### HVE_pcu {#hve_pcu}

```csharp
float HVE_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hVE_pcu = outputLaneOD.HVE_pcu;
        ```

    === "C++"

        ```cpp
        double hVE_pcu;
        outputLaneOD->get_HVE_pcu(&hVE_pcu);
        ```

    === "Python"

        ```python
        hve_pcu = outputLaneOD.HVE_pcu
        ```

### Opposing_flow_pcu {#opposing_flow_pcu}

```csharp
float Opposing_flow_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_pcu = outputLaneOD.Opposing_flow_pcu;
        ```

    === "C++"

        ```cpp
        double opposing_flow_pcu;
        outputLaneOD->get_Opposing_flow_pcu(&opposing_flow_pcu);
        ```

    === "Python"

        ```python
        opposing_flow_pcu = outputLaneOD.Opposing_flow_pcu
        ```

### Opposing_flow_ped {#opposing_flow_ped}

```csharp
float Opposing_flow_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opposing_flow_ped = outputLaneOD.Opposing_flow_ped;
        ```

    === "C++"

        ```cpp
        double opposing_flow_ped;
        outputLaneOD->get_Opposing_flow_ped(&opposing_flow_ped);
        ```

    === "Python"

        ```python
        opposing_flow_ped = outputLaneOD.Opposing_flow_ped
        ```

### Percent_nearest_lane_only {#percent_nearest_lane_only}

```csharp
float Percent_nearest_lane_only { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_nearest_lane_only = outputLaneOD.Percent_nearest_lane_only;
        ```

    === "C++"

        ```cpp
        double percent_nearest_lane_only;
        outputLaneOD->get_Percent_nearest_lane_only(&percent_nearest_lane_only);
        ```

    === "Python"

        ```python
        percent_nearest_lane_only = outputLaneOD.Percent_nearest_lane_only
        ```

### Percent_exit_flow_incl {#percent_exit_flow_incl}

```csharp
float Percent_exit_flow_incl { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float percent_exit_flow_incl = outputLaneOD.Percent_exit_flow_incl;
        ```

    === "C++"

        ```cpp
        double percent_exit_flow_incl;
        outputLaneOD->get_Percent_exit_flow_incl(&percent_exit_flow_incl);
        ```

    === "Python"

        ```python
        percent_exit_flow_incl = outputLaneOD.Percent_exit_flow_incl
        ```

### Cap_constraint_effect {#cap_constraint_effect}

```csharp
int Cap_constraint_effect { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cap_constraint_effect = outputLaneOD.Cap_constraint_effect;
        ```

    === "C++"

        ```cpp
        long cap_constraint_effect;
        outputLaneOD->get_Cap_constraint_effect(&cap_constraint_effect);
        ```

    === "Python"

        ```python
        cap_constraint_effect = outputLaneOD.Cap_constraint_effect
        ```

### OD_factor {#od_factor}

```csharp
float OD_factor { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float oD_factor = outputLaneOD.OD_factor;
        ```

    === "C++"

        ```cpp
        double oD_factor;
        outputLaneOD->get_OD_factor(&oD_factor);
        ```

    === "Python"

        ```python
        od_factor = outputLaneOD.OD_factor
        ```

### Average_speed {#average_speed}

```csharp
float Average_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float average_speed = outputLaneOD.Average_speed;
        ```

    === "C++"

        ```cpp
        double average_speed;
        outputLaneOD->get_Average_speed(&average_speed);
        ```

    === "Python"

        ```python
        average_speed = outputLaneOD.Average_speed
        ```

### Proportion_bunched_flag {#proportion_bunched_flag}

```csharp
int Proportion_bunched_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int proportion_bunched_flag = outputLaneOD.Proportion_bunched_flag;
        ```

    === "C++"

        ```cpp
        long proportion_bunched_flag;
        outputLaneOD->get_Proportion_bunched_flag(&proportion_bunched_flag);
        ```

    === "Python"

        ```python
        proportion_bunched_flag = outputLaneOD.Proportion_bunched_flag
        ```

### Proportion_bunched {#proportion_bunched}

```csharp
float Proportion_bunched { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_bunched = outputLaneOD.Proportion_bunched;
        ```

    === "C++"

        ```cpp
        double proportion_bunched;
        outputLaneOD->get_Proportion_bunched(&proportion_bunched);
        ```

    === "Python"

        ```python
        proportion_bunched = outputLaneOD.Proportion_bunched
        ```

### Intrabunch_headway {#intrabunch_headway}

```csharp
float Intrabunch_headway { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float intrabunch_headway = outputLaneOD.Intrabunch_headway;
        ```

    === "C++"

        ```cpp
        double intrabunch_headway;
        outputLaneOD->get_Intrabunch_headway(&intrabunch_headway);
        ```

    === "Python"

        ```python
        intrabunch_headway = outputLaneOD.Intrabunch_headway
        ```

### Priority_sharing_flag {#priority_sharing_flag}

```csharp
int Priority_sharing_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int priority_sharing_flag = outputLaneOD.Priority_sharing_flag;
        ```

    === "C++"

        ```cpp
        long priority_sharing_flag;
        outputLaneOD->get_Priority_sharing_flag(&priority_sharing_flag);
        ```

    === "Python"

        ```python
        priority_sharing_flag = outputLaneOD.Priority_sharing_flag
        ```

### HVE_for_entry {#hve_for_entry}

```csharp
float HVE_for_entry { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hVE_for_entry = outputLaneOD.HVE_for_entry;
        ```

    === "C++"

        ```cpp
        double hVE_for_entry;
        outputLaneOD->get_HVE_for_entry(&hVE_for_entry);
        ```

    === "Python"

        ```python
        hve_for_entry = outputLaneOD.HVE_for_entry
        ```

### OD_factor_flag {#od_factor_flag}

```csharp
int OD_factor_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int oD_factor_flag = outputLaneOD.OD_factor_flag;
        ```

    === "C++"

        ```cpp
        long oD_factor_flag;
        outputLaneOD->get_OD_factor_flag(&oD_factor_flag);
        ```

    === "Python"

        ```python
        od_factor_flag = outputLaneOD.OD_factor_flag
        ```

### Average_speed_flag {#average_speed_flag}

```csharp
int Average_speed_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int average_speed_flag = outputLaneOD.Average_speed_flag;
        ```

    === "C++"

        ```cpp
        long average_speed_flag;
        outputLaneOD->get_Average_speed_flag(&average_speed_flag);
        ```

    === "Python"

        ```python
        average_speed_flag = outputLaneOD.Average_speed_flag
        ```

### Intrabunch_headway_flag {#intrabunch_headway_flag}

```csharp
int Intrabunch_headway_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int intrabunch_headway_flag = outputLaneOD.Intrabunch_headway_flag;
        ```

    === "C++"

        ```cpp
        long intrabunch_headway_flag;
        outputLaneOD->get_Intrabunch_headway_flag(&intrabunch_headway_flag);
        ```

    === "Python"

        ```python
        intrabunch_headway_flag = outputLaneOD.Intrabunch_headway_flag
        ```

### Crit_gap_flag {#crit_gap_flag}

```csharp
int Crit_gap_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int crit_gap_flag = outputLaneOD.Crit_gap_flag;
        ```

    === "C++"

        ```cpp
        long crit_gap_flag;
        outputLaneOD->get_Crit_gap_flag(&crit_gap_flag);
        ```

    === "Python"

        ```python
        crit_gap_flag = outputLaneOD.Crit_gap_flag
        ```

### Foll_up_hdwy_flag {#foll_up_hdwy_flag}

```csharp
int Foll_up_hdwy_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int foll_up_hdwy_flag = outputLaneOD.Foll_up_hdwy_flag;
        ```

    === "C++"

        ```cpp
        long foll_up_hdwy_flag;
        outputLaneOD->get_Foll_up_hdwy_flag(&foll_up_hdwy_flag);
        ```

    === "Python"

        ```python
        foll_up_hdwy_flag = outputLaneOD.Foll_up_hdwy_flag
        ```

### Opposing_flow_flag {#opposing_flow_flag}

```csharp
int Opposing_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposing_flow_flag = outputLaneOD.Opposing_flow_flag;
        ```

    === "C++"

        ```cpp
        long opposing_flow_flag;
        outputLaneOD->get_Opposing_flow_flag(&opposing_flow_flag);
        ```

    === "Python"

        ```python
        opposing_flow_flag = outputLaneOD.Opposing_flow_flag
        ```

### Opposing_flow_ped_flag {#opposing_flow_ped_flag}

```csharp
int Opposing_flow_ped_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int opposing_flow_ped_flag = outputLaneOD.Opposing_flow_ped_flag;
        ```

    === "C++"

        ```cpp
        long opposing_flow_ped_flag;
        outputLaneOD->get_Opposing_flow_ped_flag(&opposing_flow_ped_flag);
        ```

    === "Python"

        ```python
        opposing_flow_ped_flag = outputLaneOD.Opposing_flow_ped_flag
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLaneOD.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLaneOD->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLaneOD.Arrival_flow_flag
        ```

### Unblocked_time_ratio {#unblocked_time_ratio}

```csharp
float Unblocked_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unblocked_time_ratio = outputLaneOD.Unblocked_time_ratio;
        ```

    === "C++"

        ```cpp
        double unblocked_time_ratio;
        outputLaneOD->get_Unblocked_time_ratio(&unblocked_time_ratio);
        ```

    === "Python"

        ```python
        unblocked_time_ratio = outputLaneOD.Unblocked_time_ratio
        ```

### Gap_accept_cycle_time {#gap_accept_cycle_time}

```csharp
float Gap_accept_cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_cycle_time = outputLaneOD.Gap_accept_cycle_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_cycle_time;
        outputLaneOD->get_Gap_accept_cycle_time(&gap_accept_cycle_time);
        ```

    === "Python"

        ```python
        gap_accept_cycle_time = outputLaneOD.Gap_accept_cycle_time
        ```

### Gap_accept_blocked_time {#gap_accept_blocked_time}

```csharp
float Gap_accept_blocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_blocked_time = outputLaneOD.Gap_accept_blocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_blocked_time;
        outputLaneOD->get_Gap_accept_blocked_time(&gap_accept_blocked_time);
        ```

    === "Python"

        ```python
        gap_accept_blocked_time = outputLaneOD.Gap_accept_blocked_time
        ```

### Gap_accept_unblocked_time {#gap_accept_unblocked_time}

```csharp
float Gap_accept_unblocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_unblocked_time = outputLaneOD.Gap_accept_unblocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_unblocked_time;
        outputLaneOD->get_Gap_accept_unblocked_time(&gap_accept_unblocked_time);
        ```

    === "Python"

        ```python
        gap_accept_unblocked_time = outputLaneOD.Gap_accept_unblocked_time
        ```

### Minimum_delay {#minimum_delay}

```csharp
float Minimum_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_delay = outputLaneOD.Minimum_delay;
        ```

    === "C++"

        ```cpp
        double minimum_delay;
        outputLaneOD->get_Minimum_delay(&minimum_delay);
        ```

    === "Python"

        ```python
        minimum_delay = outputLaneOD.Minimum_delay
        ```

### Rou_ped_entry_adj_factor {#rou_ped_entry_adj_factor}

```csharp
float Rou_ped_entry_adj_factor { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_ped_entry_adj_factor = outputLaneOD.Rou_ped_entry_adj_factor;
        ```

    === "C++"

        ```cpp
        double rou_ped_entry_adj_factor;
        outputLaneOD->get_Rou_ped_entry_adj_factor(&rou_ped_entry_adj_factor);
        ```

    === "Python"

        ```python
        rou_ped_entry_adj_factor = outputLaneOD.Rou_ped_entry_adj_factor
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneodmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneODMC
title: OutputLaneODMC
name: ISIAPIOutputLaneODMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5EBC14C8-5257-4414-A7D3-ECA260445AE2
members:
  - int MC_class
  - bool Calc_exists
  - float Flow
  - float Flow_capconstr
  - bool Shortlane_overflow
  - float Sl_overflow
  - ISIAPIOutputLaneOD OutputLaneOD
  - float Unblocked_time_ratio
  - float Gap_accept_cycle_time
  - float Gap_accept_blocked_time
  - float Gap_accept_unblocked_time
  - int Arrival_flow_flag
  - float Minimum_delay
---

# OutputLaneODMC

Type `ISIAPIOutputLaneODMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5EBC14C8-5257-4414-A7D3-ECA260445AE2`

## Declaration

```csharp
[Guid("5EBC14C8-5257-4414-A7D3-ECA260445AE2")]
public interface ISIAPIOutputLaneODMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Flow](#flow) | `float` |  |
| [Flow_capconstr](#flow_capconstr) | `float` |  |
| [Shortlane_overflow](#shortlane_overflow) | `bool` |  |
| [Sl_overflow](#sl_overflow) | `float` |  |
| [OutputLaneOD](#outputlaneod) | [`ISIAPIOutputLaneOD`](sidrasolutions.si.api.isiapioutputlaneod.md) |  |
| [Unblocked_time_ratio](#unblocked_time_ratio) | `float` |  |
| [Gap_accept_cycle_time](#gap_accept_cycle_time) | `float` |  |
| [Gap_accept_blocked_time](#gap_accept_blocked_time) | `float` |  |
| [Gap_accept_unblocked_time](#gap_accept_unblocked_time) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Minimum_delay](#minimum_delay) | `float` |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputLaneODMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputLaneODMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputLaneODMC.MC_class
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputLaneODMC.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputLaneODMC->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputLaneODMC.Calc_exists
        ```

### Flow {#flow}

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputLaneODMC.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputLaneODMC->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputLaneODMC.Flow
        ```

### Flow_capconstr {#flow_capconstr}

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputLaneODMC.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputLaneODMC->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputLaneODMC.Flow_capconstr
        ```

### Shortlane_overflow {#shortlane_overflow}

```csharp
bool Shortlane_overflow { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool shortlane_overflow = outputLaneODMC.Shortlane_overflow;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL shortlane_overflow;
        outputLaneODMC->get_Shortlane_overflow(&shortlane_overflow);
        ```

    === "Python"

        ```python
        shortlane_overflow = outputLaneODMC.Shortlane_overflow
        ```

### Sl_overflow {#sl_overflow}

```csharp
float Sl_overflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float sl_overflow = outputLaneODMC.Sl_overflow;
        ```

    === "C++"

        ```cpp
        double sl_overflow;
        outputLaneODMC->get_Sl_overflow(&sl_overflow);
        ```

    === "Python"

        ```python
        sl_overflow = outputLaneODMC.Sl_overflow
        ```

### OutputLaneOD {#outputlaneod}

```csharp
ISIAPIOutputLaneOD OutputLaneOD { get; }
```

**Type** [`ISIAPIOutputLaneOD`](sidrasolutions.si.api.isiapioutputlaneod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneOD = outputLaneODMC.OutputLaneOD;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneOD> outputLaneOD;
        outputLaneODMC->get_OutputLaneOD(&outputLaneOD);
        ```

    === "Python"

        ```python
        output_lane_od = outputLaneODMC.OutputLaneOD
        ```

### Unblocked_time_ratio {#unblocked_time_ratio}

```csharp
float Unblocked_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unblocked_time_ratio = outputLaneODMC.Unblocked_time_ratio;
        ```

    === "C++"

        ```cpp
        double unblocked_time_ratio;
        outputLaneODMC->get_Unblocked_time_ratio(&unblocked_time_ratio);
        ```

    === "Python"

        ```python
        unblocked_time_ratio = outputLaneODMC.Unblocked_time_ratio
        ```

### Gap_accept_cycle_time {#gap_accept_cycle_time}

```csharp
float Gap_accept_cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_cycle_time = outputLaneODMC.Gap_accept_cycle_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_cycle_time;
        outputLaneODMC->get_Gap_accept_cycle_time(&gap_accept_cycle_time);
        ```

    === "Python"

        ```python
        gap_accept_cycle_time = outputLaneODMC.Gap_accept_cycle_time
        ```

### Gap_accept_blocked_time {#gap_accept_blocked_time}

```csharp
float Gap_accept_blocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_blocked_time = outputLaneODMC.Gap_accept_blocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_blocked_time;
        outputLaneODMC->get_Gap_accept_blocked_time(&gap_accept_blocked_time);
        ```

    === "Python"

        ```python
        gap_accept_blocked_time = outputLaneODMC.Gap_accept_blocked_time
        ```

### Gap_accept_unblocked_time {#gap_accept_unblocked_time}

```csharp
float Gap_accept_unblocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_unblocked_time = outputLaneODMC.Gap_accept_unblocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_unblocked_time;
        outputLaneODMC->get_Gap_accept_unblocked_time(&gap_accept_unblocked_time);
        ```

    === "Python"

        ```python
        gap_accept_unblocked_time = outputLaneODMC.Gap_accept_unblocked_time
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLaneODMC.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLaneODMC->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLaneODMC.Arrival_flow_flag
        ```

### Minimum_delay {#minimum_delay}

```csharp
float Minimum_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_delay = outputLaneODMC.Minimum_delay;
        ```

    === "C++"

        ```cpp
        double minimum_delay;
        outputLaneODMC->get_Minimum_delay(&minimum_delay);
        ```

    === "Python"

        ```python
        minimum_delay = outputLaneODMC.Minimum_delay
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneodmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneODMCs
title: OutputLaneODMCs
name: ISIAPIOutputLaneODMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: F67F1946-961E-4B39-83AE-E73C40036855
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputLaneODMC this[int mcClass]
  - int Count
---

# OutputLaneODMCs

Type `ISIAPIOutputLaneODMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `F67F1946-961E-4B39-83AE-E73C40036855`

## Declaration

```csharp
[Guid("F67F1946-961E-4B39-83AE-E73C40036855")]
public interface ISIAPIOutputLaneODMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneODMC`](sidrasolutions.si.api.isiapioutputlaneodmc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneODMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneODMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneODMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLaneODMC this[] { get; }
```

**Type** [`ISIAPIOutputLaneODMC`](sidrasolutions.si.api.isiapioutputlaneodmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneODMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneODMC> this[];
        outputLaneODMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneODMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneODMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneODMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneODMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneODs
title: OutputLaneODs
name: ISIAPIOutputLaneODs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0B12CD6E-EBD8-46AB-B390-84BF1BD4215E
members:
  - bool LaneODExists(int destination)
  - ISIAPIOutputLaneOD this[int destination]
  - int Count
---

# OutputLaneODs

Type `ISIAPIOutputLaneODs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0B12CD6E-EBD8-46AB-B390-84BF1BD4215E`

## Declaration

```csharp
[Guid("0B12CD6E-EBD8-46AB-B390-84BF1BD4215E")]
public interface ISIAPIOutputLaneODs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLaneOD`](sidrasolutions.si.api.isiapioutputlaneod.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneODExists(int)](#laneodexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLaneODs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLaneODs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLaneODs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLaneOD this[] { get; }
```

**Type** [`ISIAPIOutputLaneOD`](sidrasolutions.si.api.isiapioutputlaneod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLaneODs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneOD> this[];
        outputLaneODs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLaneODs.this[]
        ```

## Methods

### LaneODExists(int) {#laneodexists-int}

```csharp
bool LaneODExists(int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `destination` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLaneODs.LaneODExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLaneODs->LaneODExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLaneODs.LaneODExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlanes.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLanes
title: OutputLanes
name: ISIAPIOutputLanes
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 388178C1-B04E-404E-90F6-4C5143B3F818
members:
  - bool LaneExists(int laneno)
  - ISIAPIOutputLane this[int laneno]
  - int Count
---

# OutputLanes

Type `ISIAPIOutputLanes` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `388178C1-B04E-404E-90F6-4C5143B3F818`

## Declaration

```csharp
[Guid("388178C1-B04E-404E-90F6-4C5143B3F818")]
public interface ISIAPIOutputLanes
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LaneExists(int)](#laneexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLanes.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLanes->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLanes.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLane this[] { get; }
```

**Type** [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLanes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLane> this[];
        outputLanes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLanes.this[]
        ```

## Methods

### LaneExists(int) {#laneexists-int}

```csharp
bool LaneExists(int laneno)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `laneno` | `int` | Approach Lane Number, a one-based integer, counts Approach Lanes only from left to right looking in the direction of departure. |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLanes.LaneExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLanes->LaneExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLanes.LaneExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlaneunsignalped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLaneUnsignalPed
title: OutputLaneUnsignalPed
name: ISIAPIOutputLaneUnsignalPed
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 48C6A7A6-2784-4191-AC16-867159050B1D
members:
  - float Opng_pedvol
  - float Conflict_zone_length
  - bool Conflict_zone_length_user
  - float Walking_speed
  - float Gap_acc_factor
  - float Critical_gap
  - bool Critical_gap_user
  - float Followup_headway
  - bool Followup_headway_user
  - float Capacity
  - float Delay
  - float Back_of_queue
  - float Back_of_queue_dist
  - float Cycle_av_queue
  - float Cycle_av_queue_dist
  - ISIAPIOutputLane OutputLane
---

# OutputLaneUnsignalPed

Type `ISIAPIOutputLaneUnsignalPed` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `48C6A7A6-2784-4191-AC16-867159050B1D`

## Declaration

```csharp
[Guid("48C6A7A6-2784-4191-AC16-867159050B1D")]
public interface ISIAPIOutputLaneUnsignalPed
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Opng_pedvol](#opng_pedvol) | `float` |  |
| [Conflict_zone_length](#conflict_zone_length) | `float` |  |
| [Conflict_zone_length_user](#conflict_zone_length_user) | `bool` |  |
| [Walking_speed](#walking_speed) | `float` |  |
| [Gap_acc_factor](#gap_acc_factor) | `float` |  |
| [Critical_gap](#critical_gap) | `float` |  |
| [Critical_gap_user](#critical_gap_user) | `bool` |  |
| [Followup_headway](#followup_headway) | `float` |  |
| [Followup_headway_user](#followup_headway_user) | `bool` |  |
| [Capacity](#capacity) | `float` |  |
| [Delay](#delay) | `float` |  |
| [Back_of_queue](#back_of_queue) | `float` |  |
| [Back_of_queue_dist](#back_of_queue_dist) | `float` |  |
| [Cycle_av_queue](#cycle_av_queue) | `float` |  |
| [Cycle_av_queue_dist](#cycle_av_queue_dist) | `float` |  |
| [OutputLane](#outputlane) | [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md) |  |

</div>

## Properties

### Opng_pedvol {#opng_pedvol}

```csharp
float Opng_pedvol { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float opng_pedvol = outputLaneUnsignalPed.Opng_pedvol;
        ```

    === "C++"

        ```cpp
        double opng_pedvol;
        outputLaneUnsignalPed->get_Opng_pedvol(&opng_pedvol);
        ```

    === "Python"

        ```python
        opng_pedvol = outputLaneUnsignalPed.Opng_pedvol
        ```

### Conflict_zone_length {#conflict_zone_length}

```csharp
float Conflict_zone_length { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float conflict_zone_length = outputLaneUnsignalPed.Conflict_zone_length;
        ```

    === "C++"

        ```cpp
        double conflict_zone_length;
        outputLaneUnsignalPed->get_Conflict_zone_length(&conflict_zone_length);
        ```

    === "Python"

        ```python
        conflict_zone_length = outputLaneUnsignalPed.Conflict_zone_length
        ```

### Conflict_zone_length_user {#conflict_zone_length_user}

```csharp
bool Conflict_zone_length_user { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool conflict_zone_length_user = outputLaneUnsignalPed.Conflict_zone_length_user;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL conflict_zone_length_user;
        outputLaneUnsignalPed->get_Conflict_zone_length_user(&conflict_zone_length_user);
        ```

    === "Python"

        ```python
        conflict_zone_length_user = outputLaneUnsignalPed.Conflict_zone_length_user
        ```

### Walking_speed {#walking_speed}

```csharp
float Walking_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float walking_speed = outputLaneUnsignalPed.Walking_speed;
        ```

    === "C++"

        ```cpp
        double walking_speed;
        outputLaneUnsignalPed->get_Walking_speed(&walking_speed);
        ```

    === "Python"

        ```python
        walking_speed = outputLaneUnsignalPed.Walking_speed
        ```

### Gap_acc_factor {#gap_acc_factor}

```csharp
float Gap_acc_factor { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_acc_factor = outputLaneUnsignalPed.Gap_acc_factor;
        ```

    === "C++"

        ```cpp
        double gap_acc_factor;
        outputLaneUnsignalPed->get_Gap_acc_factor(&gap_acc_factor);
        ```

    === "Python"

        ```python
        gap_acc_factor = outputLaneUnsignalPed.Gap_acc_factor
        ```

### Critical_gap {#critical_gap}

```csharp
float Critical_gap { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap = outputLaneUnsignalPed.Critical_gap;
        ```

    === "C++"

        ```cpp
        double critical_gap;
        outputLaneUnsignalPed->get_Critical_gap(&critical_gap);
        ```

    === "Python"

        ```python
        critical_gap = outputLaneUnsignalPed.Critical_gap
        ```

### Critical_gap_user {#critical_gap_user}

```csharp
bool Critical_gap_user { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool critical_gap_user = outputLaneUnsignalPed.Critical_gap_user;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL critical_gap_user;
        outputLaneUnsignalPed->get_Critical_gap_user(&critical_gap_user);
        ```

    === "Python"

        ```python
        critical_gap_user = outputLaneUnsignalPed.Critical_gap_user
        ```

### Followup_headway {#followup_headway}

```csharp
float Followup_headway { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway = outputLaneUnsignalPed.Followup_headway;
        ```

    === "C++"

        ```cpp
        double followup_headway;
        outputLaneUnsignalPed->get_Followup_headway(&followup_headway);
        ```

    === "Python"

        ```python
        followup_headway = outputLaneUnsignalPed.Followup_headway
        ```

### Followup_headway_user {#followup_headway_user}

```csharp
bool Followup_headway_user { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool followup_headway_user = outputLaneUnsignalPed.Followup_headway_user;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL followup_headway_user;
        outputLaneUnsignalPed->get_Followup_headway_user(&followup_headway_user);
        ```

    === "Python"

        ```python
        followup_headway_user = outputLaneUnsignalPed.Followup_headway_user
        ```

### Capacity {#capacity}

```csharp
float Capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity = outputLaneUnsignalPed.Capacity;
        ```

    === "C++"

        ```cpp
        double capacity;
        outputLaneUnsignalPed->get_Capacity(&capacity);
        ```

    === "Python"

        ```python
        capacity = outputLaneUnsignalPed.Capacity
        ```

### Delay {#delay}

```csharp
float Delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay = outputLaneUnsignalPed.Delay;
        ```

    === "C++"

        ```cpp
        double delay;
        outputLaneUnsignalPed->get_Delay(&delay);
        ```

    === "Python"

        ```python
        delay = outputLaneUnsignalPed.Delay
        ```

### Back_of_queue {#back_of_queue}

```csharp
float Back_of_queue { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float back_of_queue = outputLaneUnsignalPed.Back_of_queue;
        ```

    === "C++"

        ```cpp
        double back_of_queue;
        outputLaneUnsignalPed->get_Back_of_queue(&back_of_queue);
        ```

    === "Python"

        ```python
        back_of_queue = outputLaneUnsignalPed.Back_of_queue
        ```

### Back_of_queue_dist {#back_of_queue_dist}

```csharp
float Back_of_queue_dist { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float back_of_queue_dist = outputLaneUnsignalPed.Back_of_queue_dist;
        ```

    === "C++"

        ```cpp
        double back_of_queue_dist;
        outputLaneUnsignalPed->get_Back_of_queue_dist(&back_of_queue_dist);
        ```

    === "Python"

        ```python
        back_of_queue_dist = outputLaneUnsignalPed.Back_of_queue_dist
        ```

### Cycle_av_queue {#cycle_av_queue}

```csharp
float Cycle_av_queue { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_av_queue = outputLaneUnsignalPed.Cycle_av_queue;
        ```

    === "C++"

        ```cpp
        double cycle_av_queue;
        outputLaneUnsignalPed->get_Cycle_av_queue(&cycle_av_queue);
        ```

    === "Python"

        ```python
        cycle_av_queue = outputLaneUnsignalPed.Cycle_av_queue
        ```

### Cycle_av_queue_dist {#cycle_av_queue_dist}

```csharp
float Cycle_av_queue_dist { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_av_queue_dist = outputLaneUnsignalPed.Cycle_av_queue_dist;
        ```

    === "C++"

        ```cpp
        double cycle_av_queue_dist;
        outputLaneUnsignalPed->get_Cycle_av_queue_dist(&cycle_av_queue_dist);
        ```

    === "Python"

        ```python
        cycle_av_queue_dist = outputLaneUnsignalPed.Cycle_av_queue_dist
        ```

### OutputLane {#outputlane}

```csharp
ISIAPIOutputLane OutputLane { get; }
```

**Type** [`ISIAPIOutputLane`](sidrasolutions.si.api.isiapioutputlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLane = outputLaneUnsignalPed.OutputLane;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLane> outputLane;
        outputLaneUnsignalPed->get_OutputLane(&outputLane);
        ```

    === "Python"

        ```python
        output_lane = outputLaneUnsignalPed.OutputLane
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputleg.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLeg
title: OutputLeg
name: ISIAPIOutputLeg
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 13E6D6A5-09AB-4E97-8D6D-48625134A9CA
summary: SIDRA INTERSECTION Output Leg wrapper interface
members:
  - int Orientation
  - float Flow_total
  - float Flow_LV
  - float Flow_HV
  - float Flow_HV_pct
  - float Flow_total_capconstr
  - float Flow_LV_capconstr
  - float Flow_HV_capconstr
  - float Flow_HV_pct_capconstr
  - float Capacity_effective
  - float Capacity_lane_total
  - float Capacity_mov_total
  - float Deg_satn
  - float Delay_control_average
  - float Delay_control_total
  - string Level_of_service
  - string Level_of_service_worstmov
  - string Level_of_service_worstlane
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Operating_cost_rate
  - float Fuel_consumption_rate
  - float Carbon_dioxide_rate
  - float Hydrocarbons_rate
  - float Carbon_monoxide_rate
  - float Nox_rate
  - float Exiting_flow
  - float Circulating_flow
  - int X1_flag
  - ISIAPIOutputLegMCs OutputLegMCs
  - ISIAPIOutputLanes OutputLanes
  - ISIAPIOutputCirculatingLanes OutputCirculatingLanes
  - float Delay_control_average_worstlane
  - float Delay_control_average_worstmov
  - float Delay_geometric
  - float Delay_stopline_average
  - float Exiting_flow_capconstr
  - float Circulating_flow_pcu
  - float FHWA_capacity_zero_circ_flow
  - float Inscribed_diameter
  - int Num_entry_lanes
  - float Average_entry_lane_width
  - float Prop_queued_upstr_signal
  - int Prop_queued_upstr_signal_flag
  - float Extra_bunching
  - int Extra_bunching_flag
  - float Idling_time_average
  - float SpeedEfficiency
  - float Net_inflow
  - float Net_inflow_capconstr
  - int Arrival_flow_flag
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Capacity_adj_worstlane
  - int Capacity_adj_flag_worstlane
  - float Avg_num_of_cycles_to_depart
  - float Total_lane_changes
  - int Platoonmode_type
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - float Prob_blockage
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float DesiredSpeedProgram
  - float Uninterrupted_speed
  - float Density
  - float Density_pcu
  - float Spacing
  - float Headway
  - float Occupancy_time
  - float Space_time
  - float Avg_veh_length
  - float Space_occupancy_ratio
  - float Time_occupancy_ratio
  - float Uninterrupted_travel_delay
  - string LOS_density
  - ISIAPIOutputLaneExits OutputLaneExits
  - ISIAPIOutputset Outputset
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
  - float Rou_exit_peds_conflict_zone_len
  - float Rou_exit_peds_crit_gap
  - float Rou_exit_peds_followup_hdwy
  - float Rou_exit_peds_lane_capacity
---

# OutputLeg

Type `ISIAPIOutputLeg` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `13E6D6A5-09AB-4E97-8D6D-48625134A9CA`

SIDRA INTERSECTION Output Leg wrapper interface

## Declaration

```csharp
[Guid("13E6D6A5-09AB-4E97-8D6D-48625134A9CA")]
public interface ISIAPIOutputLeg
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` |  |
| [Flow_total](#flow_total) | `float` | Total Demand Flow Rate. |
| [Flow_LV](#flow_lv) | `float` | Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV](#flow_hv) | `float` | Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct](#flow_hv_pct) | `float` | Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` | Total Arrival Flow Rate. |
| [Flow_LV_capconstr](#flow_lv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV_capconstr](#flow_hv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct_capconstr](#flow_hv_pct_capconstr) | `float` | Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Capacity_effective](#capacity_effective) | `float` | Effective intersection capacity. |
| [Capacity_lane_total](#capacity_lane_total) | `float` | Sum of all lane capacities. |
| [Capacity_mov_total](#capacity_mov_total) | `float` | Sum of movement capacities (includes effect of lane underutilisation within movement). |
| [Deg_satn](#deg_satn) | `float` | Intersection degree of saturation. |
| [Delay_control_average](#delay_control_average) | `float` | Average control delay. |
| [Delay_control_total](#delay_control_total) | `float` | Total control delay. |
| [Level_of_service](#level_of_service) | `string` | Approach LOS. |
| [Level_of_service_worstmov](#level_of_service_worstmov) | `string` | Worst movement LOS on approach. |
| [Level_of_service_worstlane](#level_of_service_worstlane) | `string` | Worst lane LOS on approach. |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` | Longest cycle-average queue (veh), mean. |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` | Longest cycle-average queue (veh), user-specified percentile. |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` | Longest maximum back of queue (veh), mean. |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` | Longest maximum back of queue (veh), user-specified percentile. |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` | Longest cycle-average queue (distance), mean. |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` | Longest cycle-average queue (distance), user-specified percentile. |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` | Longest maximum back of queue (distance), mean. |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` | Longest maximum back of queue (distance), user-specified percentile. |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` | Queue storage ratio based on maximum back of queue (distance), mean |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` | Queue storage ratio based on maximum back of queue (distance), user-specified percentile |
| [Stop_rate](#stop_rate) | `float` | Effective stop rate. |
| [Stops_total](#stops_total) | `float` | Total effective stops. |
| [Proportion_queued](#proportion_queued) | `float` | Proportion queued. |
| [Performance_index](#performance_index) | `float` | Performance index. |
| [Travel_distance_total](#travel_distance_total) | `float` | Total travel distance. |
| [Travel_distance_average](#travel_distance_average) | `float` | Average travel distance. |
| [Travel_time_total](#travel_time_total) | `float` | Total travel time. |
| [Travel_time_average](#travel_time_average) | `float` | Average travel time. |
| [Travel_speed](#travel_speed) | `float` | Average travel speed. |
| [Operating_cost_total](#operating_cost_total) | `float` | Total operating cost (cost unit/h). |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` | Total fuel consumption. |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` | Total Carbon Dioxide emissions (kg/h). |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` | Total Hydrocarbon emissions (kg/h). |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` | Total Carbon Monoxide emissions (kg/h). |
| [Nox_total](#nox_total) | `float` | Total NOX emissions (kg/h). |
| [Operating_cost_rate](#operating_cost_rate) | `float` | Operating cost rate (cost unit/km). |
| [Fuel_consumption_rate](#fuel_consumption_rate) | `float` | Fuel consumption rate. |
| [Carbon_dioxide_rate](#carbon_dioxide_rate) | `float` | Carbon Dioxide emission rate (g/km). |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` | Hydrocarbon emission rate (g/km). |
| [Carbon_monoxide_rate](#carbon_monoxide_rate) | `float` | Carbon Monoxide emission rate (g/km). |
| [Nox_rate](#nox_rate) | `float` | NOX emission rate (g/km). |
| [Exiting_flow](#exiting_flow) | `float` | Flow exiting to leg (veh). |
| [Circulating_flow](#circulating_flow) | `float` | Flow circulating in front of leg (veh) (roundabouts). |
| [X1_flag](#x1_flag) | `int` | Degree of saturation = 1 flag. |
| [OutputLegMCs](#outputlegmcs) | [`ISIAPIOutputLegMCs`](sidrasolutions.si.api.isiapioutputlegmcs.md) |  |
| [OutputLanes](#outputlanes) | [`ISIAPIOutputLanes`](sidrasolutions.si.api.isiapioutputlanes.md) |  |
| [OutputCirculatingLanes](#outputcirculatinglanes) | [`ISIAPIOutputCirculatingLanes`](sidrasolutions.si.api.isiapioutputcirculatinglanes.md) |  |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Delay_geometric](#delay_geometric) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Exiting_flow_capconstr](#exiting_flow_capconstr) | `float` |  |
| [Circulating_flow_pcu](#circulating_flow_pcu) | `float` |  |
| [FHWA_capacity_zero_circ_flow](#fhwa_capacity_zero_circ_flow) | `float` |  |
| [Inscribed_diameter](#inscribed_diameter) | `float` |  |
| [Num_entry_lanes](#num_entry_lanes) | `int` |  |
| [Average_entry_lane_width](#average_entry_lane_width) | `float` |  |
| [Prop_queued_upstr_signal](#prop_queued_upstr_signal) | `float` |  |
| [Prop_queued_upstr_signal_flag](#prop_queued_upstr_signal_flag) | `int` |  |
| [Extra_bunching](#extra_bunching) | `float` |  |
| [Extra_bunching_flag](#extra_bunching_flag) | `int` |  |
| [Idling_time_average](#idling_time_average) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Net_inflow](#net_inflow) | `float` |  |
| [Net_inflow_capconstr](#net_inflow_capconstr) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Capacity_adj_worstlane](#capacity_adj_worstlane) | `float` |  |
| [Capacity_adj_flag_worstlane](#capacity_adj_flag_worstlane) | `int` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Total_lane_changes](#total_lane_changes) | `float` |  |
| [Platoonmode_type](#platoonmode_type) | `int` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [Prob_blockage](#prob_blockage) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [Uninterrupted_speed](#uninterrupted_speed) | `float` |  |
| [Density](#density) | `float` |  |
| [Density_pcu](#density_pcu) | `float` |  |
| [Spacing](#spacing) | `float` |  |
| [Headway](#headway) | `float` |  |
| [Occupancy_time](#occupancy_time) | `float` |  |
| [Space_time](#space_time) | `float` |  |
| [Avg_veh_length](#avg_veh_length) | `float` |  |
| [Space_occupancy_ratio](#space_occupancy_ratio) | `float` |  |
| [Time_occupancy_ratio](#time_occupancy_ratio) | `float` |  |
| [Uninterrupted_travel_delay](#uninterrupted_travel_delay) | `float` |  |
| [LOS_density](#los_density) | `string` |  |
| [OutputLaneExits](#outputlaneexits) | [`ISIAPIOutputLaneExits`](sidrasolutions.si.api.isiapioutputlaneexits.md) |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |
| [Rou_exit_peds_conflict_zone_len](#rou_exit_peds_conflict_zone_len) | `float` |  |
| [Rou_exit_peds_crit_gap](#rou_exit_peds_crit_gap) | `float` |  |
| [Rou_exit_peds_followup_hdwy](#rou_exit_peds_followup_hdwy) | `float` |  |
| [Rou_exit_peds_lane_capacity](#rou_exit_peds_lane_capacity) | `float` |  |

</div>

## Properties

### Orientation {#orientation}

```csharp
int Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = outputLeg.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        outputLeg->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = outputLeg.Orientation
        ```

### Flow_total {#flow_total}

Total Demand Flow Rate.

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputLeg.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputLeg->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputLeg.Flow_total
        ```

### Flow_LV {#flow_lv}

Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV = outputLeg.Flow_LV;
        ```

    === "C++"

        ```cpp
        double flow_LV;
        outputLeg->get_Flow_LV(&flow_LV);
        ```

    === "Python"

        ```python
        flow_lv = outputLeg.Flow_LV
        ```

### Flow_HV {#flow_hv}

Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV = outputLeg.Flow_HV;
        ```

    === "C++"

        ```cpp
        double flow_HV;
        outputLeg->get_Flow_HV(&flow_HV);
        ```

    === "Python"

        ```python
        flow_hv = outputLeg.Flow_HV
        ```

### Flow_HV_pct {#flow_hv_pct}

Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct = outputLeg.Flow_HV_pct;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct;
        outputLeg->get_Flow_HV_pct(&flow_HV_pct);
        ```

    === "Python"

        ```python
        flow_hv_pct = outputLeg.Flow_HV_pct
        ```

### Flow_total_capconstr {#flow_total_capconstr}

Total Arrival Flow Rate.

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputLeg.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputLeg->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputLeg.Flow_total_capconstr
        ```

### Flow_LV_capconstr {#flow_lv_capconstr}

Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV_capconstr = outputLeg.Flow_LV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_LV_capconstr;
        outputLeg->get_Flow_LV_capconstr(&flow_LV_capconstr);
        ```

    === "Python"

        ```python
        flow_lv_capconstr = outputLeg.Flow_LV_capconstr
        ```

### Flow_HV_capconstr {#flow_hv_capconstr}

Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_capconstr = outputLeg.Flow_HV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_capconstr;
        outputLeg->get_Flow_HV_capconstr(&flow_HV_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_capconstr = outputLeg.Flow_HV_capconstr
        ```

### Flow_HV_pct_capconstr {#flow_hv_pct_capconstr}

Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct_capconstr = outputLeg.Flow_HV_pct_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct_capconstr;
        outputLeg->get_Flow_HV_pct_capconstr(&flow_HV_pct_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_pct_capconstr = outputLeg.Flow_HV_pct_capconstr
        ```

### Capacity_effective {#capacity_effective}

Effective intersection capacity.

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputLeg.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputLeg->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputLeg.Capacity_effective
        ```

### Capacity_lane_total {#capacity_lane_total}

Sum of all lane capacities.

```csharp
float Capacity_lane_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_lane_total = outputLeg.Capacity_lane_total;
        ```

    === "C++"

        ```cpp
        double capacity_lane_total;
        outputLeg->get_Capacity_lane_total(&capacity_lane_total);
        ```

    === "Python"

        ```python
        capacity_lane_total = outputLeg.Capacity_lane_total
        ```

### Capacity_mov_total {#capacity_mov_total}

Sum of movement capacities (includes effect of lane underutilisation within
movement).

```csharp
float Capacity_mov_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov_total = outputLeg.Capacity_mov_total;
        ```

    === "C++"

        ```cpp
        double capacity_mov_total;
        outputLeg->get_Capacity_mov_total(&capacity_mov_total);
        ```

    === "Python"

        ```python
        capacity_mov_total = outputLeg.Capacity_mov_total
        ```

### Deg_satn {#deg_satn}

Intersection degree of saturation.

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputLeg.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputLeg->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputLeg.Deg_satn
        ```

### Delay_control_average {#delay_control_average}

Average control delay.

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputLeg.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputLeg->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputLeg.Delay_control_average
        ```

### Delay_control_total {#delay_control_total}

Total control delay.

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputLeg.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputLeg->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputLeg.Delay_control_total
        ```

### Level_of_service {#level_of_service}

Approach LOS.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputLeg.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputLeg->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputLeg.Level_of_service
        ```

### Level_of_service_worstmov {#level_of_service_worstmov}

Worst movement LOS on approach.

```csharp
string Level_of_service_worstmov { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstmov = outputLeg.Level_of_service_worstmov;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstmov;
        outputLeg->get_Level_of_service_worstmov(&level_of_service_worstmov);
        ```

    === "Python"

        ```python
        level_of_service_worstmov = outputLeg.Level_of_service_worstmov
        ```

### Level_of_service_worstlane {#level_of_service_worstlane}

Worst lane LOS on approach.

```csharp
string Level_of_service_worstlane { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstlane = outputLeg.Level_of_service_worstlane;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstlane;
        outputLeg->get_Level_of_service_worstlane(&level_of_service_worstlane);
        ```

    === "Python"

        ```python
        level_of_service_worstlane = outputLeg.Level_of_service_worstlane
        ```

### Queue_cycav_mean {#queue_cycav_mean}

Longest cycle-average queue (veh), mean.

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputLeg.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputLeg->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputLeg.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

Longest cycle-average queue (veh), user-specified percentile.

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputLeg.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputLeg->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputLeg.Queue_cycav_percentile
        ```

### Queue_maxback_mean {#queue_maxback_mean}

Longest maximum back of queue (veh), mean.

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputLeg.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputLeg->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputLeg.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

Longest maximum back of queue (veh), user-specified percentile.

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputLeg.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputLeg->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputLeg.Queue_maxback_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

Longest cycle-average queue (distance), mean.

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputLeg.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputLeg->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputLeg.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

Longest cycle-average queue (distance), user-specified percentile.

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputLeg.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputLeg->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputLeg.Queue_dist_cycav_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

Longest maximum back of queue (distance), mean.

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputLeg.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputLeg->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputLeg.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

Longest maximum back of queue (distance), user-specified percentile.

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputLeg.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputLeg->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputLeg.Queue_dist_maxback_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

Queue storage ratio based on maximum back of queue (distance), mean

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputLeg.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputLeg->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputLeg.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

Queue storage ratio based on maximum back of queue (distance), user-specified percentile

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputLeg.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputLeg->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputLeg.Queue_storage_ratio_percentile
        ```

### Stop_rate {#stop_rate}

Effective stop rate.

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputLeg.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputLeg->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputLeg.Stop_rate
        ```

### Stops_total {#stops_total}

Total effective stops.

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputLeg.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputLeg->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputLeg.Stops_total
        ```

### Proportion_queued {#proportion_queued}

Proportion queued.

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputLeg.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputLeg->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputLeg.Proportion_queued
        ```

### Performance_index {#performance_index}

Performance index.

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputLeg.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputLeg->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputLeg.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

Total travel distance.

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputLeg.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputLeg->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputLeg.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

Average travel distance.

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputLeg.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputLeg->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputLeg.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

Total travel time.

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputLeg.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputLeg->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputLeg.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

Average travel time.

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputLeg.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputLeg->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputLeg.Travel_time_average
        ```

### Travel_speed {#travel_speed}

Average travel speed.

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputLeg.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputLeg->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputLeg.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

Total operating cost (cost unit/h).

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputLeg.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputLeg->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputLeg.Operating_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

Total fuel consumption.

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputLeg.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputLeg->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputLeg.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

Total Carbon Dioxide emissions (kg/h).

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputLeg.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputLeg->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputLeg.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

Total Hydrocarbon emissions (kg/h).

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputLeg.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputLeg->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputLeg.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

Total Carbon Monoxide emissions (kg/h).

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputLeg.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputLeg->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputLeg.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

Total NOX emissions (kg/h).

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputLeg.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputLeg->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputLeg.Nox_total
        ```

### Operating_cost_rate {#operating_cost_rate}

Operating cost rate (cost unit/km).

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputLeg.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputLeg->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputLeg.Operating_cost_rate
        ```

### Fuel_consumption_rate {#fuel_consumption_rate}

Fuel consumption rate.

```csharp
float Fuel_consumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_rate = outputLeg.Fuel_consumption_rate;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_rate;
        outputLeg->get_Fuel_consumption_rate(&fuel_consumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputLeg.Fuel_consumption_rate
        ```

### Carbon_dioxide_rate {#carbon_dioxide_rate}

Carbon Dioxide emission rate (g/km).

```csharp
float Carbon_dioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_rate = outputLeg.Carbon_dioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_rate;
        outputLeg->get_Carbon_dioxide_rate(&carbon_dioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputLeg.Carbon_dioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

Hydrocarbon emission rate (g/km).

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputLeg.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputLeg->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputLeg.Hydrocarbons_rate
        ```

### Carbon_monoxide_rate {#carbon_monoxide_rate}

Carbon Monoxide emission rate (g/km).

```csharp
float Carbon_monoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_rate = outputLeg.Carbon_monoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_rate;
        outputLeg->get_Carbon_monoxide_rate(&carbon_monoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputLeg.Carbon_monoxide_rate
        ```

### Nox_rate {#nox_rate}

NOX emission rate (g/km).

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputLeg.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputLeg->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputLeg.Nox_rate
        ```

### Exiting_flow {#exiting_flow}

Flow exiting to leg (veh).

```csharp
float Exiting_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exiting_flow = outputLeg.Exiting_flow;
        ```

    === "C++"

        ```cpp
        double exiting_flow;
        outputLeg->get_Exiting_flow(&exiting_flow);
        ```

    === "Python"

        ```python
        exiting_flow = outputLeg.Exiting_flow
        ```

### Circulating_flow {#circulating_flow}

Flow circulating in front of leg (veh) (roundabouts).

```csharp
float Circulating_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float circulating_flow = outputLeg.Circulating_flow;
        ```

    === "C++"

        ```cpp
        double circulating_flow;
        outputLeg->get_Circulating_flow(&circulating_flow);
        ```

    === "Python"

        ```python
        circulating_flow = outputLeg.Circulating_flow
        ```

### X1_flag {#x1_flag}

Degree of saturation = 1 flag.

```csharp
int X1_flag { get; }
```

**Type** `int`

**Value**

One of:

- `0` - x != 1
- `1` - x = 1 due to short lane
- `2` - x = 1 due to minimum capacity

???- example "Code samples"

    === "C#"

        ```csharp
        int x1_flag = outputLeg.X1_flag;
        ```

    === "C++"

        ```cpp
        long x1_flag;
        outputLeg->get_X1_flag(&x1_flag);
        ```

    === "Python"

        ```python
        x1_flag = outputLeg.X1_flag
        ```

### OutputLegMCs {#outputlegmcs}

```csharp
ISIAPIOutputLegMCs OutputLegMCs { get; }
```

**Type** [`ISIAPIOutputLegMCs`](sidrasolutions.si.api.isiapioutputlegmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLegMCs = outputLeg.OutputLegMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLegMCs> outputLegMCs;
        outputLeg->get_OutputLegMCs(&outputLegMCs);
        ```

    === "Python"

        ```python
        output_leg_m_cs = outputLeg.OutputLegMCs
        ```

### OutputLanes {#outputlanes}

```csharp
ISIAPIOutputLanes OutputLanes { get; }
```

**Type** [`ISIAPIOutputLanes`](sidrasolutions.si.api.isiapioutputlanes.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLanes = outputLeg.OutputLanes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLanes> outputLanes;
        outputLeg->get_OutputLanes(&outputLanes);
        ```

    === "Python"

        ```python
        output_lanes = outputLeg.OutputLanes
        ```

### OutputCirculatingLanes {#outputcirculatinglanes}

```csharp
ISIAPIOutputCirculatingLanes OutputCirculatingLanes { get; }
```

**Type** [`ISIAPIOutputCirculatingLanes`](sidrasolutions.si.api.isiapioutputcirculatinglanes.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputCirculatingLanes = outputLeg.OutputCirculatingLanes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputCirculatingLanes> outputCirculatingLanes;
        outputLeg->get_OutputCirculatingLanes(&outputCirculatingLanes);
        ```

    === "Python"

        ```python
        output_circulating_lanes = outputLeg.OutputCirculatingLanes
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputLeg.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputLeg->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputLeg.Delay_control_average_worstlane
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputLeg.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputLeg->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputLeg.Delay_control_average_worstmov
        ```

### Delay_geometric {#delay_geometric}

```csharp
float Delay_geometric { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric = outputLeg.Delay_geometric;
        ```

    === "C++"

        ```cpp
        double delay_geometric;
        outputLeg->get_Delay_geometric(&delay_geometric);
        ```

    === "Python"

        ```python
        delay_geometric = outputLeg.Delay_geometric
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputLeg.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputLeg->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputLeg.Delay_stopline_average
        ```

### Exiting_flow_capconstr {#exiting_flow_capconstr}

```csharp
float Exiting_flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exiting_flow_capconstr = outputLeg.Exiting_flow_capconstr;
        ```

    === "C++"

        ```cpp
        double exiting_flow_capconstr;
        outputLeg->get_Exiting_flow_capconstr(&exiting_flow_capconstr);
        ```

    === "Python"

        ```python
        exiting_flow_capconstr = outputLeg.Exiting_flow_capconstr
        ```

### Circulating_flow_pcu {#circulating_flow_pcu}

```csharp
float Circulating_flow_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float circulating_flow_pcu = outputLeg.Circulating_flow_pcu;
        ```

    === "C++"

        ```cpp
        double circulating_flow_pcu;
        outputLeg->get_Circulating_flow_pcu(&circulating_flow_pcu);
        ```

    === "Python"

        ```python
        circulating_flow_pcu = outputLeg.Circulating_flow_pcu
        ```

### FHWA_capacity_zero_circ_flow {#fhwa_capacity_zero_circ_flow}

```csharp
float FHWA_capacity_zero_circ_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fHWA_capacity_zero_circ_flow = outputLeg.FHWA_capacity_zero_circ_flow;
        ```

    === "C++"

        ```cpp
        double fHWA_capacity_zero_circ_flow;
        outputLeg->get_FHWA_capacity_zero_circ_flow(&fHWA_capacity_zero_circ_flow);
        ```

    === "Python"

        ```python
        fhwa_capacity_zero_circ_flow = outputLeg.FHWA_capacity_zero_circ_flow
        ```

### Inscribed_diameter {#inscribed_diameter}

```csharp
float Inscribed_diameter { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float inscribed_diameter = outputLeg.Inscribed_diameter;
        ```

    === "C++"

        ```cpp
        double inscribed_diameter;
        outputLeg->get_Inscribed_diameter(&inscribed_diameter);
        ```

    === "Python"

        ```python
        inscribed_diameter = outputLeg.Inscribed_diameter
        ```

### Num_entry_lanes {#num_entry_lanes}

```csharp
int Num_entry_lanes { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int num_entry_lanes = outputLeg.Num_entry_lanes;
        ```

    === "C++"

        ```cpp
        long num_entry_lanes;
        outputLeg->get_Num_entry_lanes(&num_entry_lanes);
        ```

    === "Python"

        ```python
        num_entry_lanes = outputLeg.Num_entry_lanes
        ```

### Average_entry_lane_width {#average_entry_lane_width}

```csharp
float Average_entry_lane_width { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float average_entry_lane_width = outputLeg.Average_entry_lane_width;
        ```

    === "C++"

        ```cpp
        double average_entry_lane_width;
        outputLeg->get_Average_entry_lane_width(&average_entry_lane_width);
        ```

    === "Python"

        ```python
        average_entry_lane_width = outputLeg.Average_entry_lane_width
        ```

### Prop_queued_upstr_signal {#prop_queued_upstr_signal}

```csharp
float Prop_queued_upstr_signal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_upstr_signal = outputLeg.Prop_queued_upstr_signal;
        ```

    === "C++"

        ```cpp
        double prop_queued_upstr_signal;
        outputLeg->get_Prop_queued_upstr_signal(&prop_queued_upstr_signal);
        ```

    === "Python"

        ```python
        prop_queued_upstr_signal = outputLeg.Prop_queued_upstr_signal
        ```

### Prop_queued_upstr_signal_flag {#prop_queued_upstr_signal_flag}

```csharp
int Prop_queued_upstr_signal_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int prop_queued_upstr_signal_flag = outputLeg.Prop_queued_upstr_signal_flag;
        ```

    === "C++"

        ```cpp
        long prop_queued_upstr_signal_flag;
        outputLeg->get_Prop_queued_upstr_signal_flag(&prop_queued_upstr_signal_flag);
        ```

    === "Python"

        ```python
        prop_queued_upstr_signal_flag = outputLeg.Prop_queued_upstr_signal_flag
        ```

### Extra_bunching {#extra_bunching}

```csharp
float Extra_bunching { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float extra_bunching = outputLeg.Extra_bunching;
        ```

    === "C++"

        ```cpp
        double extra_bunching;
        outputLeg->get_Extra_bunching(&extra_bunching);
        ```

    === "Python"

        ```python
        extra_bunching = outputLeg.Extra_bunching
        ```

### Extra_bunching_flag {#extra_bunching_flag}

```csharp
int Extra_bunching_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int extra_bunching_flag = outputLeg.Extra_bunching_flag;
        ```

    === "C++"

        ```cpp
        long extra_bunching_flag;
        outputLeg->get_Extra_bunching_flag(&extra_bunching_flag);
        ```

    === "Python"

        ```python
        extra_bunching_flag = outputLeg.Extra_bunching_flag
        ```

### Idling_time_average {#idling_time_average}

```csharp
float Idling_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idling_time_average = outputLeg.Idling_time_average;
        ```

    === "C++"

        ```cpp
        double idling_time_average;
        outputLeg->get_Idling_time_average(&idling_time_average);
        ```

    === "Python"

        ```python
        idling_time_average = outputLeg.Idling_time_average
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputLeg.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputLeg->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputLeg.SpeedEfficiency
        ```

### Net_inflow {#net_inflow}

```csharp
float Net_inflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow = outputLeg.Net_inflow;
        ```

    === "C++"

        ```cpp
        double net_inflow;
        outputLeg->get_Net_inflow(&net_inflow);
        ```

    === "Python"

        ```python
        net_inflow = outputLeg.Net_inflow
        ```

### Net_inflow_capconstr {#net_inflow_capconstr}

```csharp
float Net_inflow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow_capconstr = outputLeg.Net_inflow_capconstr;
        ```

    === "C++"

        ```cpp
        double net_inflow_capconstr;
        outputLeg->get_Net_inflow_capconstr(&net_inflow_capconstr);
        ```

    === "Python"

        ```python
        net_inflow_capconstr = outputLeg.Net_inflow_capconstr
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLeg.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLeg->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLeg.Arrival_flow_flag
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputLeg.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputLeg->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputLeg.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputLeg.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputLeg->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputLeg.Queue_greenstart_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputLeg.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputLeg->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputLeg.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputLeg.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputLeg->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputLeg.Queue_dist_greenstart_percentile
        ```

### Capacity_adj_worstlane {#capacity_adj_worstlane}

```csharp
float Capacity_adj_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj_worstlane = outputLeg.Capacity_adj_worstlane;
        ```

    === "C++"

        ```cpp
        double capacity_adj_worstlane;
        outputLeg->get_Capacity_adj_worstlane(&capacity_adj_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_worstlane = outputLeg.Capacity_adj_worstlane
        ```

### Capacity_adj_flag_worstlane {#capacity_adj_flag_worstlane}

```csharp
int Capacity_adj_flag_worstlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag_worstlane = outputLeg.Capacity_adj_flag_worstlane;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag_worstlane;
        outputLeg->get_Capacity_adj_flag_worstlane(&capacity_adj_flag_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_flag_worstlane = outputLeg.Capacity_adj_flag_worstlane
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputLeg.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputLeg->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputLeg.Avg_num_of_cycles_to_depart
        ```

### Total_lane_changes {#total_lane_changes}

```csharp
float Total_lane_changes { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_lane_changes = outputLeg.Total_lane_changes;
        ```

    === "C++"

        ```cpp
        double total_lane_changes;
        outputLeg->get_Total_lane_changes(&total_lane_changes);
        ```

    === "Python"

        ```python
        total_lane_changes = outputLeg.Total_lane_changes
        ```

### Platoonmode_type {#platoonmode_type}

```csharp
int Platoonmode_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int platoonmode_type = outputLeg.Platoonmode_type;
        ```

    === "C++"

        ```cpp
        long platoonmode_type;
        outputLeg->get_Platoonmode_type(&platoonmode_type);
        ```

    === "Python"

        ```python
        platoonmode_type = outputLeg.Platoonmode_type
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputLeg.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputLeg->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputLeg.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputLeg.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputLeg->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputLeg.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputLeg.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputLeg->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputLeg.TravelTimeIndex
        ```

### Prob_blockage {#prob_blockage}

```csharp
float Prob_blockage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_blockage = outputLeg.Prob_blockage;
        ```

    === "C++"

        ```cpp
        double prob_blockage;
        outputLeg->get_Prob_blockage(&prob_blockage);
        ```

    === "Python"

        ```python
        prob_blockage = outputLeg.Prob_blockage
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputLeg.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputLeg->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputLeg.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputLeg.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputLeg->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputLeg.DesiredSpeed
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputLeg.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputLeg->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputLeg.DesiredSpeedProgram
        ```

### Uninterrupted_speed {#uninterrupted_speed}

```csharp
float Uninterrupted_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float uninterrupted_speed = outputLeg.Uninterrupted_speed;
        ```

    === "C++"

        ```cpp
        double uninterrupted_speed;
        outputLeg->get_Uninterrupted_speed(&uninterrupted_speed);
        ```

    === "Python"

        ```python
        uninterrupted_speed = outputLeg.Uninterrupted_speed
        ```

### Density {#density}

```csharp
float Density { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float density = outputLeg.Density;
        ```

    === "C++"

        ```cpp
        double density;
        outputLeg->get_Density(&density);
        ```

    === "Python"

        ```python
        density = outputLeg.Density
        ```

### Density_pcu {#density_pcu}

```csharp
float Density_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float density_pcu = outputLeg.Density_pcu;
        ```

    === "C++"

        ```cpp
        double density_pcu;
        outputLeg->get_Density_pcu(&density_pcu);
        ```

    === "Python"

        ```python
        density_pcu = outputLeg.Density_pcu
        ```

### Spacing {#spacing}

```csharp
float Spacing { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float spacing = outputLeg.Spacing;
        ```

    === "C++"

        ```cpp
        double spacing;
        outputLeg->get_Spacing(&spacing);
        ```

    === "Python"

        ```python
        spacing = outputLeg.Spacing
        ```

### Headway {#headway}

```csharp
float Headway { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float headway = outputLeg.Headway;
        ```

    === "C++"

        ```cpp
        double headway;
        outputLeg->get_Headway(&headway);
        ```

    === "Python"

        ```python
        headway = outputLeg.Headway
        ```

### Occupancy_time {#occupancy_time}

```csharp
float Occupancy_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float occupancy_time = outputLeg.Occupancy_time;
        ```

    === "C++"

        ```cpp
        double occupancy_time;
        outputLeg->get_Occupancy_time(&occupancy_time);
        ```

    === "Python"

        ```python
        occupancy_time = outputLeg.Occupancy_time
        ```

### Space_time {#space_time}

```csharp
float Space_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float space_time = outputLeg.Space_time;
        ```

    === "C++"

        ```cpp
        double space_time;
        outputLeg->get_Space_time(&space_time);
        ```

    === "Python"

        ```python
        space_time = outputLeg.Space_time
        ```

### Avg_veh_length {#avg_veh_length}

```csharp
float Avg_veh_length { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_veh_length = outputLeg.Avg_veh_length;
        ```

    === "C++"

        ```cpp
        double avg_veh_length;
        outputLeg->get_Avg_veh_length(&avg_veh_length);
        ```

    === "Python"

        ```python
        avg_veh_length = outputLeg.Avg_veh_length
        ```

### Space_occupancy_ratio {#space_occupancy_ratio}

```csharp
float Space_occupancy_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float space_occupancy_ratio = outputLeg.Space_occupancy_ratio;
        ```

    === "C++"

        ```cpp
        double space_occupancy_ratio;
        outputLeg->get_Space_occupancy_ratio(&space_occupancy_ratio);
        ```

    === "Python"

        ```python
        space_occupancy_ratio = outputLeg.Space_occupancy_ratio
        ```

### Time_occupancy_ratio {#time_occupancy_ratio}

```csharp
float Time_occupancy_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_occupancy_ratio = outputLeg.Time_occupancy_ratio;
        ```

    === "C++"

        ```cpp
        double time_occupancy_ratio;
        outputLeg->get_Time_occupancy_ratio(&time_occupancy_ratio);
        ```

    === "Python"

        ```python
        time_occupancy_ratio = outputLeg.Time_occupancy_ratio
        ```

### Uninterrupted_travel_delay {#uninterrupted_travel_delay}

```csharp
float Uninterrupted_travel_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float uninterrupted_travel_delay = outputLeg.Uninterrupted_travel_delay;
        ```

    === "C++"

        ```cpp
        double uninterrupted_travel_delay;
        outputLeg->get_Uninterrupted_travel_delay(&uninterrupted_travel_delay);
        ```

    === "Python"

        ```python
        uninterrupted_travel_delay = outputLeg.Uninterrupted_travel_delay
        ```

### LOS_density {#los_density}

```csharp
string LOS_density { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lOS_density = outputLeg.LOS_density;
        ```

    === "C++"

        ```cpp
        CComBSTR lOS_density;
        outputLeg->get_LOS_density(&lOS_density);
        ```

    === "Python"

        ```python
        los_density = outputLeg.LOS_density
        ```

### OutputLaneExits {#outputlaneexits}

```csharp
ISIAPIOutputLaneExits OutputLaneExits { get; }
```

**Type** [`ISIAPIOutputLaneExits`](sidrasolutions.si.api.isiapioutputlaneexits.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLaneExits = outputLeg.OutputLaneExits;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLaneExits> outputLaneExits;
        outputLeg->get_OutputLaneExits(&outputLaneExits);
        ```

    === "Python"

        ```python
        output_lane_exits = outputLeg.OutputLaneExits
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputLeg.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputLeg->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputLeg.Outputset
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputLeg.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputLeg->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputLeg.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputLeg.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputLeg->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputLeg.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputLeg.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputLeg->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputLeg.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputLeg.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputLeg->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputLeg.Time_cost_rate
        ```

### Rou_exit_peds_conflict_zone_len {#rou_exit_peds_conflict_zone_len}

```csharp
float Rou_exit_peds_conflict_zone_len { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_exit_peds_conflict_zone_len = outputLeg.Rou_exit_peds_conflict_zone_len;
        ```

    === "C++"

        ```cpp
        double rou_exit_peds_conflict_zone_len;
        outputLeg->get_Rou_exit_peds_conflict_zone_len(&rou_exit_peds_conflict_zone_len);
        ```

    === "Python"

        ```python
        rou_exit_peds_conflict_zone_len = outputLeg.Rou_exit_peds_conflict_zone_len
        ```

### Rou_exit_peds_crit_gap {#rou_exit_peds_crit_gap}

```csharp
float Rou_exit_peds_crit_gap { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_exit_peds_crit_gap = outputLeg.Rou_exit_peds_crit_gap;
        ```

    === "C++"

        ```cpp
        double rou_exit_peds_crit_gap;
        outputLeg->get_Rou_exit_peds_crit_gap(&rou_exit_peds_crit_gap);
        ```

    === "Python"

        ```python
        rou_exit_peds_crit_gap = outputLeg.Rou_exit_peds_crit_gap
        ```

### Rou_exit_peds_followup_hdwy {#rou_exit_peds_followup_hdwy}

```csharp
float Rou_exit_peds_followup_hdwy { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_exit_peds_followup_hdwy = outputLeg.Rou_exit_peds_followup_hdwy;
        ```

    === "C++"

        ```cpp
        double rou_exit_peds_followup_hdwy;
        outputLeg->get_Rou_exit_peds_followup_hdwy(&rou_exit_peds_followup_hdwy);
        ```

    === "Python"

        ```python
        rou_exit_peds_followup_hdwy = outputLeg.Rou_exit_peds_followup_hdwy
        ```

### Rou_exit_peds_lane_capacity {#rou_exit_peds_lane_capacity}

```csharp
float Rou_exit_peds_lane_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_exit_peds_lane_capacity = outputLeg.Rou_exit_peds_lane_capacity;
        ```

    === "C++"

        ```cpp
        double rou_exit_peds_lane_capacity;
        outputLeg->get_Rou_exit_peds_lane_capacity(&rou_exit_peds_lane_capacity);
        ```

    === "Python"

        ```python
        rou_exit_peds_lane_capacity = outputLeg.Rou_exit_peds_lane_capacity
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlegmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLegMC
title: OutputLegMC
name: ISIAPIOutputLegMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0C46789E-53A9-4A4C-A1D5-5E1838DC0605
members:
  - int MC_class
  - float Flow
  - float Flow_capconstr
  - ISIAPIOutputLeg OutputLeg
  - float Exiting_flow
  - float Exiting_flow_capconstr
  - float Circulating_flow
  - float Circulating_flow_pcu
  - bool Exist_in_nw_upstream_only
  - float Net_inflow
  - float Net_inflow_capconstr
  - int Arrival_flow_flag
  - float Total_lane_changes
  - bool Calc_exists
  - float Deg_satn
  - float Delay_control_average
  - string Level_of_service
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Proportion_queued
  - float Stop_rate
  - float Avg_num_of_cycles_to_depart
  - float Travel_speed
  - float SpeedEfficiency
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - float Prob_blockage
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Capacity_adj_worstlane
  - int Capacity_adj_flag_worstlane
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float DesiredSpeedProgram
  - float Operating_cost_total
  - float Operating_cost_rate
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputLegMC

Type `ISIAPIOutputLegMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0C46789E-53A9-4A4C-A1D5-5E1838DC0605`

## Declaration

```csharp
[Guid("0C46789E-53A9-4A4C-A1D5-5E1838DC0605")]
public interface ISIAPIOutputLegMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Flow](#flow) | `float` | Demand Flow Rate. |
| [Flow_capconstr](#flow_capconstr) | `float` | Arrival Flow Rate. |
| [OutputLeg](#outputleg) | [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md) |  |
| [Exiting_flow](#exiting_flow) | `float` |  |
| [Exiting_flow_capconstr](#exiting_flow_capconstr) | `float` |  |
| [Circulating_flow](#circulating_flow) | `float` |  |
| [Circulating_flow_pcu](#circulating_flow_pcu) | `float` |  |
| [Exist_in_nw_upstream_only](#exist_in_nw_upstream_only) | `bool` |  |
| [Net_inflow](#net_inflow) | `float` |  |
| [Net_inflow_capconstr](#net_inflow_capconstr) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Total_lane_changes](#total_lane_changes) | `float` |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Level_of_service](#level_of_service) | `string` |  |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [Prob_blockage](#prob_blockage) | `float` |  |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` |  |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` |  |
| [Capacity_adj_worstlane](#capacity_adj_worstlane) | `float` |  |
| [Capacity_adj_flag_worstlane](#capacity_adj_flag_worstlane) | `int` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputLegMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputLegMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputLegMC.MC_class
        ```

### Flow {#flow}

Demand Flow Rate.

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputLegMC.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputLegMC->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputLegMC.Flow
        ```

### Flow_capconstr {#flow_capconstr}

Arrival Flow Rate.

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputLegMC.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputLegMC->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputLegMC.Flow_capconstr
        ```

### OutputLeg {#outputleg}

```csharp
ISIAPIOutputLeg OutputLeg { get; }
```

**Type** [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLeg = outputLegMC.OutputLeg;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLeg> outputLeg;
        outputLegMC->get_OutputLeg(&outputLeg);
        ```

    === "Python"

        ```python
        output_leg = outputLegMC.OutputLeg
        ```

### Exiting_flow {#exiting_flow}

```csharp
float Exiting_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exiting_flow = outputLegMC.Exiting_flow;
        ```

    === "C++"

        ```cpp
        double exiting_flow;
        outputLegMC->get_Exiting_flow(&exiting_flow);
        ```

    === "Python"

        ```python
        exiting_flow = outputLegMC.Exiting_flow
        ```

### Exiting_flow_capconstr {#exiting_flow_capconstr}

```csharp
float Exiting_flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exiting_flow_capconstr = outputLegMC.Exiting_flow_capconstr;
        ```

    === "C++"

        ```cpp
        double exiting_flow_capconstr;
        outputLegMC->get_Exiting_flow_capconstr(&exiting_flow_capconstr);
        ```

    === "Python"

        ```python
        exiting_flow_capconstr = outputLegMC.Exiting_flow_capconstr
        ```

### Circulating_flow {#circulating_flow}

```csharp
float Circulating_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float circulating_flow = outputLegMC.Circulating_flow;
        ```

    === "C++"

        ```cpp
        double circulating_flow;
        outputLegMC->get_Circulating_flow(&circulating_flow);
        ```

    === "Python"

        ```python
        circulating_flow = outputLegMC.Circulating_flow
        ```

### Circulating_flow_pcu {#circulating_flow_pcu}

```csharp
float Circulating_flow_pcu { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float circulating_flow_pcu = outputLegMC.Circulating_flow_pcu;
        ```

    === "C++"

        ```cpp
        double circulating_flow_pcu;
        outputLegMC->get_Circulating_flow_pcu(&circulating_flow_pcu);
        ```

    === "Python"

        ```python
        circulating_flow_pcu = outputLegMC.Circulating_flow_pcu
        ```

### Exist_in_nw_upstream_only {#exist_in_nw_upstream_only}

```csharp
bool Exist_in_nw_upstream_only { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exist_in_nw_upstream_only = outputLegMC.Exist_in_nw_upstream_only;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exist_in_nw_upstream_only;
        outputLegMC->get_Exist_in_nw_upstream_only(&exist_in_nw_upstream_only);
        ```

    === "Python"

        ```python
        exist_in_nw_upstream_only = outputLegMC.Exist_in_nw_upstream_only
        ```

### Net_inflow {#net_inflow}

```csharp
float Net_inflow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow = outputLegMC.Net_inflow;
        ```

    === "C++"

        ```cpp
        double net_inflow;
        outputLegMC->get_Net_inflow(&net_inflow);
        ```

    === "Python"

        ```python
        net_inflow = outputLegMC.Net_inflow
        ```

### Net_inflow_capconstr {#net_inflow_capconstr}

```csharp
float Net_inflow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float net_inflow_capconstr = outputLegMC.Net_inflow_capconstr;
        ```

    === "C++"

        ```cpp
        double net_inflow_capconstr;
        outputLegMC->get_Net_inflow_capconstr(&net_inflow_capconstr);
        ```

    === "Python"

        ```python
        net_inflow_capconstr = outputLegMC.Net_inflow_capconstr
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputLegMC.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputLegMC->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputLegMC.Arrival_flow_flag
        ```

### Total_lane_changes {#total_lane_changes}

```csharp
float Total_lane_changes { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_lane_changes = outputLegMC.Total_lane_changes;
        ```

    === "C++"

        ```cpp
        double total_lane_changes;
        outputLegMC->get_Total_lane_changes(&total_lane_changes);
        ```

    === "Python"

        ```python
        total_lane_changes = outputLegMC.Total_lane_changes
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputLegMC.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputLegMC->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputLegMC.Calc_exists
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputLegMC.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputLegMC->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputLegMC.Deg_satn
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputLegMC.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputLegMC->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputLegMC.Delay_control_average
        ```

### Level_of_service {#level_of_service}

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputLegMC.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputLegMC->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputLegMC.Level_of_service
        ```

### Queue_maxback_mean {#queue_maxback_mean}

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputLegMC.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputLegMC->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputLegMC.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputLegMC.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputLegMC->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputLegMC.Queue_maxback_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputLegMC.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputLegMC->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputLegMC.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputLegMC.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputLegMC->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputLegMC.Queue_dist_maxback_percentile
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputLegMC.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputLegMC->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputLegMC.Proportion_queued
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputLegMC.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputLegMC->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputLegMC.Stop_rate
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputLegMC.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputLegMC->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputLegMC.Avg_num_of_cycles_to_depart
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputLegMC.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputLegMC->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputLegMC.Travel_speed
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputLegMC.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputLegMC->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputLegMC.SpeedEfficiency
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputLegMC.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputLegMC->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputLegMC.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputLegMC.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputLegMC->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputLegMC.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputLegMC.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputLegMC->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputLegMC.TravelTimeIndex
        ```

### Prob_blockage {#prob_blockage}

```csharp
float Prob_blockage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_blockage = outputLegMC.Prob_blockage;
        ```

    === "C++"

        ```cpp
        double prob_blockage;
        outputLegMC->get_Prob_blockage(&prob_blockage);
        ```

    === "Python"

        ```python
        prob_blockage = outputLegMC.Prob_blockage
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputLegMC.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputLegMC->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputLegMC.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputLegMC.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputLegMC->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputLegMC.Queue_storage_ratio_percentile
        ```

### Capacity_adj_worstlane {#capacity_adj_worstlane}

```csharp
float Capacity_adj_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj_worstlane = outputLegMC.Capacity_adj_worstlane;
        ```

    === "C++"

        ```cpp
        double capacity_adj_worstlane;
        outputLegMC->get_Capacity_adj_worstlane(&capacity_adj_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_worstlane = outputLegMC.Capacity_adj_worstlane
        ```

### Capacity_adj_flag_worstlane {#capacity_adj_flag_worstlane}

```csharp
int Capacity_adj_flag_worstlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag_worstlane = outputLegMC.Capacity_adj_flag_worstlane;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag_worstlane;
        outputLegMC->get_Capacity_adj_flag_worstlane(&capacity_adj_flag_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_flag_worstlane = outputLegMC.Capacity_adj_flag_worstlane
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputLegMC.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputLegMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputLegMC.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputLegMC.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputLegMC->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputLegMC.DesiredSpeed
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputLegMC.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputLegMC->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputLegMC.DesiredSpeedProgram
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputLegMC.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputLegMC->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputLegMC.Operating_cost_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputLegMC.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputLegMC->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputLegMC.Operating_cost_rate
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputLegMC.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputLegMC->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputLegMC.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputLegMC.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputLegMC->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputLegMC.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputLegMC.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputLegMC->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputLegMC.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputLegMC.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputLegMC->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputLegMC.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlegmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLegMCs
title: OutputLegMCs
name: ISIAPIOutputLegMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1CFD8D95-DE13-4B42-9505-BABD3657FF7D
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputLegMC this[int mcClass]
  - int Count
---

# OutputLegMCs

Type `ISIAPIOutputLegMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1CFD8D95-DE13-4B42-9505-BABD3657FF7D`

## Declaration

```csharp
[Guid("1CFD8D95-DE13-4B42-9505-BABD3657FF7D")]
public interface ISIAPIOutputLegMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLegMC`](sidrasolutions.si.api.isiapioutputlegmc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLegMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLegMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLegMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLegMC this[] { get; }
```

**Type** [`ISIAPIOutputLegMC`](sidrasolutions.si.api.isiapioutputlegmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLegMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLegMC> this[];
        outputLegMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLegMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLegMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLegMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLegMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlegperson.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLegPerson
title: OutputLegPerson
name: ISIAPIOutputLegPerson
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 651A23B0-DD52-4506-A4C4-7D8A61A590EB
members:
  - int Orientation
  - float Demand_flow_total
  - float Arrival_flow_total
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_total
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Performance_index
  - ISIAPIOutputset Outputset
  - float Operating_cost_rate
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputLegPerson

Type `ISIAPIOutputLegPerson` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `651A23B0-DD52-4506-A4C4-7D8A61A590EB`

## Declaration

```csharp
[Guid("651A23B0-DD52-4506-A4C4-7D8A61A590EB")]
public interface ISIAPIOutputLegPerson
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` |  |
| [Demand_flow_total](#demand_flow_total) | `float` |  |
| [Arrival_flow_total](#arrival_flow_total) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Delay_control_total](#delay_control_total) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### Orientation {#orientation}

```csharp
int Orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = outputLegPerson.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        outputLegPerson->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = outputLegPerson.Orientation
        ```

### Demand_flow_total {#demand_flow_total}

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputLegPerson.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputLegPerson->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputLegPerson.Demand_flow_total
        ```

### Arrival_flow_total {#arrival_flow_total}

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputLegPerson.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputLegPerson->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputLegPerson.Arrival_flow_total
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputLegPerson.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputLegPerson->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputLegPerson.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputLegPerson.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputLegPerson->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputLegPerson.Delay_control_average_worstmov
        ```

### Delay_control_total {#delay_control_total}

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputLegPerson.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputLegPerson->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputLegPerson.Delay_control_total
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputLegPerson.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputLegPerson->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputLegPerson.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputLegPerson.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputLegPerson->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputLegPerson.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputLegPerson.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputLegPerson->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputLegPerson.Proportion_queued
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputLegPerson.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputLegPerson->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputLegPerson.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputLegPerson.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputLegPerson->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputLegPerson.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputLegPerson.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputLegPerson->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputLegPerson.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputLegPerson.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputLegPerson->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputLegPerson.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputLegPerson.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputLegPerson->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputLegPerson.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputLegPerson.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputLegPerson->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputLegPerson.Operating_cost_total
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputLegPerson.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputLegPerson->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputLegPerson.Performance_index
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputLegPerson.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputLegPerson->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputLegPerson.Outputset
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputLegPerson.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputLegPerson->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputLegPerson.Operating_cost_rate
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputLegPerson.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputLegPerson->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputLegPerson.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputLegPerson.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputLegPerson->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputLegPerson.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputLegPerson.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputLegPerson->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputLegPerson.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputLegPerson.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputLegPerson->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputLegPerson.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlegpersons.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLegPersons
title: OutputLegPersons
name: ISIAPIOutputLegPersons
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D8B3A441-FD8F-4673-9193-9383735E7B75
members:
  - bool LegPersonExists(int orientation)
  - ISIAPIOutputLegPerson this[int orientation]
  - int Count
---

# OutputLegPersons

Type `ISIAPIOutputLegPersons` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D8B3A441-FD8F-4673-9193-9383735E7B75`

## Declaration

```csharp
[Guid("D8B3A441-FD8F-4673-9193-9383735E7B75")]
public interface ISIAPIOutputLegPersons
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLegPerson`](sidrasolutions.si.api.isiapioutputlegperson.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LegPersonExists(int)](#legpersonexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLegPersons.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLegPersons->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLegPersons.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLegPerson this[] { get; }
```

**Type** [`ISIAPIOutputLegPerson`](sidrasolutions.si.api.isiapioutputlegperson.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLegPersons.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLegPerson> this[];
        outputLegPersons->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLegPersons.this[]
        ```

## Methods

### LegPersonExists(int) {#legpersonexists-int}

```csharp
bool LegPersonExists(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLegPersons.LegPersonExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLegPersons->LegPersonExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLegPersons.LegPersonExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputlegs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputLegs
title: OutputLegs
name: ISIAPIOutputLegs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 139787D8-0DEB-4F4B-83A2-211673BC7273
members:
  - bool LegExists(int orientation)
  - ISIAPIOutputLeg this[int orientation]
  - int Count
---

# OutputLegs

Type `ISIAPIOutputLegs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `139787D8-0DEB-4F4B-83A2-211673BC7273`

## Declaration

```csharp
[Guid("139787D8-0DEB-4F4B-83A2-211673BC7273")]
public interface ISIAPIOutputLegs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LegExists(int)](#legexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputLegs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputLegs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputLegs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputLeg this[] { get; }
```

**Type** [`ISIAPIOutputLeg`](sidrasolutions.si.api.isiapioutputleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputLegs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLeg> this[];
        outputLegs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputLegs.this[]
        ```

## Methods

### LegExists(int) {#legexists-int}

```csharp
bool LegExists(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputLegs.LegExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputLegs->LegExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputLegs.LegExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmeteredroundabout.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMeteredRoundabout
title: OutputMeteredRoundabout
name: ISIAPIOutputMeteredRoundabout
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 18E46BF1-EC65-4016-B6FD-77B57927EF46
members:
  - float Metered_displayed_red
  - float Metered_displayed_blank
  - float Metered_effective_red
  - float Metered_effective_blank
  - float Blank_time_ratio
  - float Controlling_queue_detection_probability
---

# OutputMeteredRoundabout

Type `ISIAPIOutputMeteredRoundabout` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `18E46BF1-EC65-4016-B6FD-77B57927EF46`

## Declaration

```csharp
[Guid("18E46BF1-EC65-4016-B6FD-77B57927EF46")]
public interface ISIAPIOutputMeteredRoundabout
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Metered_displayed_red](#metered_displayed_red) | `float` |  |
| [Metered_displayed_blank](#metered_displayed_blank) | `float` |  |
| [Metered_effective_red](#metered_effective_red) | `float` |  |
| [Metered_effective_blank](#metered_effective_blank) | `float` |  |
| [Blank_time_ratio](#blank_time_ratio) | `float` |  |
| [Controlling_queue_detection_probability](#controlling_queue_detection_probability) | `float` |  |

</div>

## Properties

### Metered_displayed_red {#metered_displayed_red}

```csharp
float Metered_displayed_red { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float metered_displayed_red = outputMeteredRoundabout.Metered_displayed_red;
        ```

    === "C++"

        ```cpp
        double metered_displayed_red;
        outputMeteredRoundabout->get_Metered_displayed_red(&metered_displayed_red);
        ```

    === "Python"

        ```python
        metered_displayed_red = outputMeteredRoundabout.Metered_displayed_red
        ```

### Metered_displayed_blank {#metered_displayed_blank}

```csharp
float Metered_displayed_blank { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float metered_displayed_blank = outputMeteredRoundabout.Metered_displayed_blank;
        ```

    === "C++"

        ```cpp
        double metered_displayed_blank;
        outputMeteredRoundabout->get_Metered_displayed_blank(&metered_displayed_blank);
        ```

    === "Python"

        ```python
        metered_displayed_blank = outputMeteredRoundabout.Metered_displayed_blank
        ```

### Metered_effective_red {#metered_effective_red}

```csharp
float Metered_effective_red { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float metered_effective_red = outputMeteredRoundabout.Metered_effective_red;
        ```

    === "C++"

        ```cpp
        double metered_effective_red;
        outputMeteredRoundabout->get_Metered_effective_red(&metered_effective_red);
        ```

    === "Python"

        ```python
        metered_effective_red = outputMeteredRoundabout.Metered_effective_red
        ```

### Metered_effective_blank {#metered_effective_blank}

```csharp
float Metered_effective_blank { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float metered_effective_blank = outputMeteredRoundabout.Metered_effective_blank;
        ```

    === "C++"

        ```cpp
        double metered_effective_blank;
        outputMeteredRoundabout->get_Metered_effective_blank(&metered_effective_blank);
        ```

    === "Python"

        ```python
        metered_effective_blank = outputMeteredRoundabout.Metered_effective_blank
        ```

### Blank_time_ratio {#blank_time_ratio}

```csharp
float Blank_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float blank_time_ratio = outputMeteredRoundabout.Blank_time_ratio;
        ```

    === "C++"

        ```cpp
        double blank_time_ratio;
        outputMeteredRoundabout->get_Blank_time_ratio(&blank_time_ratio);
        ```

    === "Python"

        ```python
        blank_time_ratio = outputMeteredRoundabout.Blank_time_ratio
        ```

### Controlling_queue_detection_probability {#controlling_queue_detection_probability}

```csharp
float Controlling_queue_detection_probability { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float controlling_queue_detection_probability = outputMeteredRoundabout.Controlling_queue_detection_probability;
        ```

    === "C++"

        ```cpp
        double controlling_queue_detection_probability;
        outputMeteredRoundabout->get_Controlling_queue_detection_probability(&controlling_queue_detection_probability);
        ```

    === "Python"

        ```python
        controlling_queue_detection_probability = outputMeteredRoundabout.Controlling_queue_detection_probability
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPed
title: OutputMovementPed
name: ISIAPIOutputMovementPed
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 178DC795-6F05-413B-BE13-5876A75AF6F6
summary: SIDRA INTERSECTION Pedestrian movement output wrapper interface.
members:
  - int Type
  - int Origin
  - int Stage
  - float Demand_flow_total
  - float Capacity_mov
  - float Deg_satn
  - float Delay_control_average
  - float Delay_control_total
  - string Level_of_service
  - float Queue_maxback_mean
  - float Queue_dist_maxback_mean
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - int Green_periods
  - ISIAPIOutputMovementPed_GreenPeriods OutputMovementPed_GreenPeriods
  - float Practical_degree_of_saturation
  - float Operating_cost_rate
  - bool Practical_degree_of_saturation_user_spec
  - float Crossing_dist
  - bool Crossing_dist_user_spec
  - ISIAPIOutputset Outputset
  - float Demand_flow_total_adj
  - float Time_cost_total
  - float Time_cost_rate
---

# OutputMovementPed

Type `ISIAPIOutputMovementPed` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `178DC795-6F05-413B-BE13-5876A75AF6F6`

SIDRA INTERSECTION Pedestrian movement output wrapper interface.

## Declaration

```csharp
[Guid("178DC795-6F05-413B-BE13-5876A75AF6F6")]
public interface ISIAPIOutputMovementPed
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Type](#type) | `int` | The type of a Pedestrian Movement One of: - `1` - Full Crossing - `2` - Slip Lane - `3` - Staged - `4` - Diagonal |
| [Origin](#origin) | `int` | Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs |
| [Stage](#stage) | `int` | Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian Movements on each Leg allowing modelling of "staged" pedestrian crossings. |
| [Demand_flow_total](#demand_flow_total) | `float` | Movement total demand flow. |
| [Capacity_mov](#capacity_mov) | `float` | Movement capacity (includes effect of lane underutilisation within movement). |
| [Deg_satn](#deg_satn) | `float` | Movement degree of saturation. |
| [Delay_control_average](#delay_control_average) | `float` | Average control delay. |
| [Delay_control_total](#delay_control_total) | `float` | Total control delay (veh-h/h). |
| [Level_of_service](#level_of_service) | `string` | Level of service. |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` | Longest maximum back of queue (veh), mean. |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` | Longest maximum back of queue (distance), mean. |
| [Stop_rate](#stop_rate) | `float` | Effective stop rate. |
| [Stops_total](#stops_total) | `float` | Total effective stops. |
| [Proportion_queued](#proportion_queued) | `float` | Proportion queued. |
| [Performance_index](#performance_index) | `float` | Performance index. |
| [Travel_distance_total](#travel_distance_total) | `float` | Total travel distance. |
| [Travel_distance_average](#travel_distance_average) | `float` | Average travel distance. |
| [Travel_time_total](#travel_time_total) | `float` | Total travel time (veh-h/h). |
| [Travel_time_average](#travel_time_average) | `float` | Average travel time (secs). |
| [Travel_speed](#travel_speed) | `float` | Average travel time (secs). |
| [Operating_cost_total](#operating_cost_total) | `float` | Total operating cost (cost unit/h). |
| [Green_periods](#green_periods) | `int` | Number of green periods for movement. |
| [OutputMovementPed_GreenPeriods](#outputmovementped_greenperiods) | [`ISIAPIOutputMovementPed_GreenPeriods`](sidrasolutions.si.api.isiapioutputmovementped_greenperiods.md) |  |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Practical_degree_of_saturation_user_spec](#practical_degree_of_saturation_user_spec) | `bool` |  |
| [Crossing_dist](#crossing_dist) | `float` |  |
| [Crossing_dist_user_spec](#crossing_dist_user_spec) | `bool` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [Demand_flow_total_adj](#demand_flow_total_adj) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### Type {#type}

The type of a Pedestrian Movement

One of:

- `1` - Full Crossing
- `2` - Slip Lane
- `3` - Staged
- `4` - Diagonal

```csharp
int Type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int type = outputMovementPed.Type;
        ```

    === "C++"

        ```cpp
        long type;
        outputMovementPed->get_Type(&type);
        ```

    === "Python"

        ```python
        type = outputMovementPed.Type
        ```

### Origin {#origin}

Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = outputMovementPed.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        outputMovementPed->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = outputMovementPed.Origin
        ```

### Stage {#stage}

Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian
Movements on each Leg allowing modelling of "staged" pedestrian crossings.

```csharp
int Stage { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Stage 1 (Approach-side crossing)
- `2` - Stage 2 (Exit-side crossing)

???- example "Code samples"

    === "C#"

        ```csharp
        int stage = outputMovementPed.Stage;
        ```

    === "C++"

        ```cpp
        long stage;
        outputMovementPed->get_Stage(&stage);
        ```

    === "Python"

        ```python
        stage = outputMovementPed.Stage
        ```

### Demand_flow_total {#demand_flow_total}

Movement total demand flow.

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputMovementPed.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputMovementPed->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputMovementPed.Demand_flow_total
        ```

### Capacity_mov {#capacity_mov}

Movement capacity (includes effect of lane underutilisation within
movement).

```csharp
float Capacity_mov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov = outputMovementPed.Capacity_mov;
        ```

    === "C++"

        ```cpp
        double capacity_mov;
        outputMovementPed->get_Capacity_mov(&capacity_mov);
        ```

    === "Python"

        ```python
        capacity_mov = outputMovementPed.Capacity_mov
        ```

### Deg_satn {#deg_satn}

Movement degree of saturation.

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputMovementPed.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputMovementPed->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputMovementPed.Deg_satn
        ```

### Delay_control_average {#delay_control_average}

Average control delay.

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMovementPed.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMovementPed->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMovementPed.Delay_control_average
        ```

### Delay_control_total {#delay_control_total}

Total control delay (veh-h/h).

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputMovementPed.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputMovementPed->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputMovementPed.Delay_control_total
        ```

### Level_of_service {#level_of_service}

Level of service.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputMovementPed.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputMovementPed->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputMovementPed.Level_of_service
        ```

### Queue_maxback_mean {#queue_maxback_mean}

Longest maximum back of queue (veh), mean.

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputMovementPed.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputMovementPed->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputMovementPed.Queue_maxback_mean
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

Longest maximum back of queue (distance), mean.

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputMovementPed.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputMovementPed->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputMovementPed.Queue_dist_maxback_mean
        ```

### Stop_rate {#stop_rate}

Effective stop rate.

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMovementPed.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMovementPed->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMovementPed.Stop_rate
        ```

### Stops_total {#stops_total}

Total effective stops.

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputMovementPed.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputMovementPed->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputMovementPed.Stops_total
        ```

### Proportion_queued {#proportion_queued}

Proportion queued.

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputMovementPed.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputMovementPed->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputMovementPed.Proportion_queued
        ```

### Performance_index {#performance_index}

Performance index.

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMovementPed.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMovementPed->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMovementPed.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

Total travel distance.

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputMovementPed.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputMovementPed->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputMovementPed.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

Average travel distance.

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputMovementPed.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputMovementPed->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputMovementPed.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

Total travel time (veh-h/h).

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputMovementPed.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputMovementPed->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputMovementPed.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

Average travel time (secs).

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputMovementPed.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputMovementPed->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputMovementPed.Travel_time_average
        ```

### Travel_speed {#travel_speed}

Average travel time (secs).

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMovementPed.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMovementPed->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMovementPed.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

Total operating cost (cost unit/h).

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMovementPed.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMovementPed->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMovementPed.Operating_cost_total
        ```

### Green_periods {#green_periods}

Number of green periods for movement.

```csharp
int Green_periods { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int green_periods = outputMovementPed.Green_periods;
        ```

    === "C++"

        ```cpp
        long green_periods;
        outputMovementPed->get_Green_periods(&green_periods);
        ```

    === "Python"

        ```python
        green_periods = outputMovementPed.Green_periods
        ```

### OutputMovementPed_GreenPeriods {#outputmovementped_greenperiods}

```csharp
ISIAPIOutputMovementPed_GreenPeriods OutputMovementPed_GreenPeriods { get; }
```

**Type** [`ISIAPIOutputMovementPed_GreenPeriods`](sidrasolutions.si.api.isiapioutputmovementped_greenperiods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementPed_GreenPeriods = outputMovementPed.OutputMovementPed_GreenPeriods;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPed_GreenPeriods> outputMovementPed_GreenPeriods;
        outputMovementPed->get_OutputMovementPed_GreenPeriods(&outputMovementPed_GreenPeriods);
        ```

    === "Python"

        ```python
        output_movement_ped__green_periods = outputMovementPed.OutputMovementPed_GreenPeriods
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

```csharp
float Practical_degree_of_saturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = outputMovementPed.Practical_degree_of_saturation;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        outputMovementPed->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = outputMovementPed.Practical_degree_of_saturation
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputMovementPed.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputMovementPed->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputMovementPed.Operating_cost_rate
        ```

### Practical_degree_of_saturation_user_spec {#practical_degree_of_saturation_user_spec}

```csharp
bool Practical_degree_of_saturation_user_spec { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_degree_of_saturation_user_spec = outputMovementPed.Practical_degree_of_saturation_user_spec;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_degree_of_saturation_user_spec;
        outputMovementPed->get_Practical_degree_of_saturation_user_spec(&practical_degree_of_saturation_user_spec);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation_user_spec = outputMovementPed.Practical_degree_of_saturation_user_spec
        ```

### Crossing_dist {#crossing_dist}

```csharp
float Crossing_dist { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float crossing_dist = outputMovementPed.Crossing_dist;
        ```

    === "C++"

        ```cpp
        double crossing_dist;
        outputMovementPed->get_Crossing_dist(&crossing_dist);
        ```

    === "Python"

        ```python
        crossing_dist = outputMovementPed.Crossing_dist
        ```

### Crossing_dist_user_spec {#crossing_dist_user_spec}

```csharp
bool Crossing_dist_user_spec { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool crossing_dist_user_spec = outputMovementPed.Crossing_dist_user_spec;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL crossing_dist_user_spec;
        outputMovementPed->get_Crossing_dist_user_spec(&crossing_dist_user_spec);
        ```

    === "Python"

        ```python
        crossing_dist_user_spec = outputMovementPed.Crossing_dist_user_spec
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputMovementPed.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputMovementPed->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputMovementPed.Outputset
        ```

### Demand_flow_total_adj {#demand_flow_total_adj}

```csharp
float Demand_flow_total_adj { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total_adj = outputMovementPed.Demand_flow_total_adj;
        ```

    === "C++"

        ```cpp
        double demand_flow_total_adj;
        outputMovementPed->get_Demand_flow_total_adj(&demand_flow_total_adj);
        ```

    === "Python"

        ```python
        demand_flow_total_adj = outputMovementPed.Demand_flow_total_adj
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputMovementPed.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputMovementPed->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputMovementPed.Time_cost_total
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputMovementPed.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputMovementPed->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputMovementPed.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementped_greenperiod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPed_GreenPeriod
title: OutputMovementPed_GreenPeriod
name: ISIAPIOutputMovementPed_GreenPeriod
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 30CC4A3A-48C4-444D-91ED-94F062A7D6E8
members:
  - int Start_phase
  - int End_phase
  - bool Priority
  - int Greenperiod
  - float Start_loss
  - float End_gain
  - float End_loss
  - float Eff_start_time
  - float Eff_end_time
  - float Lost_time
  - float Reqd_time
  - float Eff_green
  - float Adjusted_lost_time
  - float Adjusted_flow_ratio
  - float Reqd_green_time_ratio
  - float Satn_flow
  - float Flow_ratio
  - bool Critical_mov
  - float Tmin
  - float Tmax
  - float Displayed_start_time
  - float Displayed_end_time
  - int Min_max_flag
  - bool No_arrival
  - float Min_walk_time
  - float Clearance1_time
  - float Clearance2_time
  - float Adjusted_lost_time_noact
  - float Tmin_noact
  - int Clearance1_time_option
  - int Clearance2_time_option
  - float Clearance_time_total
  - float Ped_minimum_time
  - bool Ped_minimum_time_user_spec
  - float Ped_maximum_time
  - float Ped_negative_end_gain
  - float Start_intergrn_noact
  - float Start_intergrn
  - float Eff_min_walk_time_noact
  - float Eff_min_walk_time
  - float Walk_extension_time
  - float Total_walk_time
  - float Prob_ped_arrival
  - int Prob_ped_arrival_option
  - int Ped_maximum_time_option
  - float Unadj_reqd_time
  - float Practical_degree_of_saturation
---

# OutputMovementPed_GreenPeriod

Type `ISIAPIOutputMovementPed_GreenPeriod` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `30CC4A3A-48C4-444D-91ED-94F062A7D6E8`

## Declaration

```csharp
[Guid("30CC4A3A-48C4-444D-91ED-94F062A7D6E8")]
public interface ISIAPIOutputMovementPed_GreenPeriod
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Start_phase](#start_phase) | `int` |  |
| [End_phase](#end_phase) | `int` |  |
| [Priority](#priority) | `bool` |  |
| [Greenperiod](#greenperiod) | `int` | Green Period value is a one-based integer. |
| [Start_loss](#start_loss) | `float` |  |
| [End_gain](#end_gain) | `float` |  |
| [End_loss](#end_loss) | `float` |  |
| [Eff_start_time](#eff_start_time) | `float` |  |
| [Eff_end_time](#eff_end_time) | `float` |  |
| [Lost_time](#lost_time) | `float` |  |
| [Reqd_time](#reqd_time) | `float` |  |
| [Eff_green](#eff_green) | `float` |  |
| [Adjusted_lost_time](#adjusted_lost_time) | `float` |  |
| [Adjusted_flow_ratio](#adjusted_flow_ratio) | `float` |  |
| [Reqd_green_time_ratio](#reqd_green_time_ratio) | `float` |  |
| [Satn_flow](#satn_flow) | `float` |  |
| [Flow_ratio](#flow_ratio) | `float` |  |
| [Critical_mov](#critical_mov) | `bool` |  |
| [Tmin](#tmin) | `float` |  |
| [Tmax](#tmax) | `float` |  |
| [Displayed_start_time](#displayed_start_time) | `float` |  |
| [Displayed_end_time](#displayed_end_time) | `float` |  |
| [Min_max_flag](#min_max_flag) | `int` |  |
| [No_arrival](#no_arrival) | `bool` |  |
| [Min_walk_time](#min_walk_time) | `float` |  |
| [Clearance1_time](#clearance1_time) | `float` |  |
| [Clearance2_time](#clearance2_time) | `float` |  |
| [Adjusted_lost_time_noact](#adjusted_lost_time_noact) | `float` |  |
| [Tmin_noact](#tmin_noact) | `float` |  |
| [Clearance1_time_option](#clearance1_time_option) | `int` |  |
| [Clearance2_time_option](#clearance2_time_option) | `int` |  |
| [Clearance_time_total](#clearance_time_total) | `float` |  |
| [Ped_minimum_time](#ped_minimum_time) | `float` |  |
| [Ped_minimum_time_user_spec](#ped_minimum_time_user_spec) | `bool` |  |
| [Ped_maximum_time](#ped_maximum_time) | `float` |  |
| [Ped_negative_end_gain](#ped_negative_end_gain) | `float` |  |
| [Start_intergrn_noact](#start_intergrn_noact) | `float` |  |
| [Start_intergrn](#start_intergrn) | `float` |  |
| [Eff_min_walk_time_noact](#eff_min_walk_time_noact) | `float` |  |
| [Eff_min_walk_time](#eff_min_walk_time) | `float` |  |
| [Walk_extension_time](#walk_extension_time) | `float` |  |
| [Total_walk_time](#total_walk_time) | `float` |  |
| [Prob_ped_arrival](#prob_ped_arrival) | `float` |  |
| [Prob_ped_arrival_option](#prob_ped_arrival_option) | `int` |  |
| [Ped_maximum_time_option](#ped_maximum_time_option) | `int` |  |
| [Unadj_reqd_time](#unadj_reqd_time) | `float` |  |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` |  |

</div>

## Properties

### Start_phase {#start_phase}

```csharp
int Start_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int start_phase = outputMovementPed_GreenPeriod.Start_phase;
        ```

    === "C++"

        ```cpp
        long start_phase;
        outputMovementPed_GreenPeriod->get_Start_phase(&start_phase);
        ```

    === "Python"

        ```python
        start_phase = outputMovementPed_GreenPeriod.Start_phase
        ```

### End_phase {#end_phase}

```csharp
int End_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int end_phase = outputMovementPed_GreenPeriod.End_phase;
        ```

    === "C++"

        ```cpp
        long end_phase;
        outputMovementPed_GreenPeriod->get_End_phase(&end_phase);
        ```

    === "Python"

        ```python
        end_phase = outputMovementPed_GreenPeriod.End_phase
        ```

### Priority {#priority}

```csharp
bool Priority { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool priority = outputMovementPed_GreenPeriod.Priority;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL priority;
        outputMovementPed_GreenPeriod->get_Priority(&priority);
        ```

    === "Python"

        ```python
        priority = outputMovementPed_GreenPeriod.Priority
        ```

### Greenperiod {#greenperiod}

Green Period value is a one-based integer.

```csharp
int Greenperiod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int greenperiod = outputMovementPed_GreenPeriod.Greenperiod;
        ```

    === "C++"

        ```cpp
        long greenperiod;
        outputMovementPed_GreenPeriod->get_Greenperiod(&greenperiod);
        ```

    === "Python"

        ```python
        greenperiod = outputMovementPed_GreenPeriod.Greenperiod
        ```

### Start_loss {#start_loss}

```csharp
float Start_loss { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_loss = outputMovementPed_GreenPeriod.Start_loss;
        ```

    === "C++"

        ```cpp
        double start_loss;
        outputMovementPed_GreenPeriod->get_Start_loss(&start_loss);
        ```

    === "Python"

        ```python
        start_loss = outputMovementPed_GreenPeriod.Start_loss
        ```

### End_gain {#end_gain}

```csharp
float End_gain { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_gain = outputMovementPed_GreenPeriod.End_gain;
        ```

    === "C++"

        ```cpp
        double end_gain;
        outputMovementPed_GreenPeriod->get_End_gain(&end_gain);
        ```

    === "Python"

        ```python
        end_gain = outputMovementPed_GreenPeriod.End_gain
        ```

### End_loss {#end_loss}

```csharp
float End_loss { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_loss = outputMovementPed_GreenPeriod.End_loss;
        ```

    === "C++"

        ```cpp
        double end_loss;
        outputMovementPed_GreenPeriod->get_End_loss(&end_loss);
        ```

    === "Python"

        ```python
        end_loss = outputMovementPed_GreenPeriod.End_loss
        ```

### Eff_start_time {#eff_start_time}

```csharp
float Eff_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_start_time = outputMovementPed_GreenPeriod.Eff_start_time;
        ```

    === "C++"

        ```cpp
        double eff_start_time;
        outputMovementPed_GreenPeriod->get_Eff_start_time(&eff_start_time);
        ```

    === "Python"

        ```python
        eff_start_time = outputMovementPed_GreenPeriod.Eff_start_time
        ```

### Eff_end_time {#eff_end_time}

```csharp
float Eff_end_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_end_time = outputMovementPed_GreenPeriod.Eff_end_time;
        ```

    === "C++"

        ```cpp
        double eff_end_time;
        outputMovementPed_GreenPeriod->get_Eff_end_time(&eff_end_time);
        ```

    === "Python"

        ```python
        eff_end_time = outputMovementPed_GreenPeriod.Eff_end_time
        ```

### Lost_time {#lost_time}

```csharp
float Lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lost_time = outputMovementPed_GreenPeriod.Lost_time;
        ```

    === "C++"

        ```cpp
        double lost_time;
        outputMovementPed_GreenPeriod->get_Lost_time(&lost_time);
        ```

    === "Python"

        ```python
        lost_time = outputMovementPed_GreenPeriod.Lost_time
        ```

### Reqd_time {#reqd_time}

```csharp
float Reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_time = outputMovementPed_GreenPeriod.Reqd_time;
        ```

    === "C++"

        ```cpp
        double reqd_time;
        outputMovementPed_GreenPeriod->get_Reqd_time(&reqd_time);
        ```

    === "Python"

        ```python
        reqd_time = outputMovementPed_GreenPeriod.Reqd_time
        ```

### Eff_green {#eff_green}

```csharp
float Eff_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_green = outputMovementPed_GreenPeriod.Eff_green;
        ```

    === "C++"

        ```cpp
        double eff_green;
        outputMovementPed_GreenPeriod->get_Eff_green(&eff_green);
        ```

    === "Python"

        ```python
        eff_green = outputMovementPed_GreenPeriod.Eff_green
        ```

### Adjusted_lost_time {#adjusted_lost_time}

```csharp
float Adjusted_lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_lost_time = outputMovementPed_GreenPeriod.Adjusted_lost_time;
        ```

    === "C++"

        ```cpp
        double adjusted_lost_time;
        outputMovementPed_GreenPeriod->get_Adjusted_lost_time(&adjusted_lost_time);
        ```

    === "Python"

        ```python
        adjusted_lost_time = outputMovementPed_GreenPeriod.Adjusted_lost_time
        ```

### Adjusted_flow_ratio {#adjusted_flow_ratio}

```csharp
float Adjusted_flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_flow_ratio = outputMovementPed_GreenPeriod.Adjusted_flow_ratio;
        ```

    === "C++"

        ```cpp
        double adjusted_flow_ratio;
        outputMovementPed_GreenPeriod->get_Adjusted_flow_ratio(&adjusted_flow_ratio);
        ```

    === "Python"

        ```python
        adjusted_flow_ratio = outputMovementPed_GreenPeriod.Adjusted_flow_ratio
        ```

### Reqd_green_time_ratio {#reqd_green_time_ratio}

```csharp
float Reqd_green_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_green_time_ratio = outputMovementPed_GreenPeriod.Reqd_green_time_ratio;
        ```

    === "C++"

        ```cpp
        double reqd_green_time_ratio;
        outputMovementPed_GreenPeriod->get_Reqd_green_time_ratio(&reqd_green_time_ratio);
        ```

    === "Python"

        ```python
        reqd_green_time_ratio = outputMovementPed_GreenPeriod.Reqd_green_time_ratio
        ```

### Satn_flow {#satn_flow}

```csharp
float Satn_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_flow = outputMovementPed_GreenPeriod.Satn_flow;
        ```

    === "C++"

        ```cpp
        double satn_flow;
        outputMovementPed_GreenPeriod->get_Satn_flow(&satn_flow);
        ```

    === "Python"

        ```python
        satn_flow = outputMovementPed_GreenPeriod.Satn_flow
        ```

### Flow_ratio {#flow_ratio}

```csharp
float Flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_ratio = outputMovementPed_GreenPeriod.Flow_ratio;
        ```

    === "C++"

        ```cpp
        double flow_ratio;
        outputMovementPed_GreenPeriod->get_Flow_ratio(&flow_ratio);
        ```

    === "Python"

        ```python
        flow_ratio = outputMovementPed_GreenPeriod.Flow_ratio
        ```

### Critical_mov {#critical_mov}

```csharp
bool Critical_mov { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool critical_mov = outputMovementPed_GreenPeriod.Critical_mov;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL critical_mov;
        outputMovementPed_GreenPeriod->get_Critical_mov(&critical_mov);
        ```

    === "Python"

        ```python
        critical_mov = outputMovementPed_GreenPeriod.Critical_mov
        ```

### Tmin {#tmin}

```csharp
float Tmin { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmin = outputMovementPed_GreenPeriod.Tmin;
        ```

    === "C++"

        ```cpp
        double tmin;
        outputMovementPed_GreenPeriod->get_Tmin(&tmin);
        ```

    === "Python"

        ```python
        tmin = outputMovementPed_GreenPeriod.Tmin
        ```

### Tmax {#tmax}

```csharp
float Tmax { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmax = outputMovementPed_GreenPeriod.Tmax;
        ```

    === "C++"

        ```cpp
        double tmax;
        outputMovementPed_GreenPeriod->get_Tmax(&tmax);
        ```

    === "Python"

        ```python
        tmax = outputMovementPed_GreenPeriod.Tmax
        ```

### Displayed_start_time {#displayed_start_time}

```csharp
float Displayed_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_start_time = outputMovementPed_GreenPeriod.Displayed_start_time;
        ```

    === "C++"

        ```cpp
        double displayed_start_time;
        outputMovementPed_GreenPeriod->get_Displayed_start_time(&displayed_start_time);
        ```

    === "Python"

        ```python
        displayed_start_time = outputMovementPed_GreenPeriod.Displayed_start_time
        ```

### Displayed_end_time {#displayed_end_time}

```csharp
float Displayed_end_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_end_time = outputMovementPed_GreenPeriod.Displayed_end_time;
        ```

    === "C++"

        ```cpp
        double displayed_end_time;
        outputMovementPed_GreenPeriod->get_Displayed_end_time(&displayed_end_time);
        ```

    === "Python"

        ```python
        displayed_end_time = outputMovementPed_GreenPeriod.Displayed_end_time
        ```

### Min_max_flag {#min_max_flag}

```csharp
int Min_max_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int min_max_flag = outputMovementPed_GreenPeriod.Min_max_flag;
        ```

    === "C++"

        ```cpp
        long min_max_flag;
        outputMovementPed_GreenPeriod->get_Min_max_flag(&min_max_flag);
        ```

    === "Python"

        ```python
        min_max_flag = outputMovementPed_GreenPeriod.Min_max_flag
        ```

### No_arrival {#no_arrival}

```csharp
bool No_arrival { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool no_arrival = outputMovementPed_GreenPeriod.No_arrival;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL no_arrival;
        outputMovementPed_GreenPeriod->get_No_arrival(&no_arrival);
        ```

    === "Python"

        ```python
        no_arrival = outputMovementPed_GreenPeriod.No_arrival
        ```

### Min_walk_time {#min_walk_time}

```csharp
float Min_walk_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_walk_time = outputMovementPed_GreenPeriod.Min_walk_time;
        ```

    === "C++"

        ```cpp
        double min_walk_time;
        outputMovementPed_GreenPeriod->get_Min_walk_time(&min_walk_time);
        ```

    === "Python"

        ```python
        min_walk_time = outputMovementPed_GreenPeriod.Min_walk_time
        ```

### Clearance1_time {#clearance1_time}

```csharp
float Clearance1_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float clearance1_time = outputMovementPed_GreenPeriod.Clearance1_time;
        ```

    === "C++"

        ```cpp
        double clearance1_time;
        outputMovementPed_GreenPeriod->get_Clearance1_time(&clearance1_time);
        ```

    === "Python"

        ```python
        clearance1_time = outputMovementPed_GreenPeriod.Clearance1_time
        ```

### Clearance2_time {#clearance2_time}

```csharp
float Clearance2_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float clearance2_time = outputMovementPed_GreenPeriod.Clearance2_time;
        ```

    === "C++"

        ```cpp
        double clearance2_time;
        outputMovementPed_GreenPeriod->get_Clearance2_time(&clearance2_time);
        ```

    === "Python"

        ```python
        clearance2_time = outputMovementPed_GreenPeriod.Clearance2_time
        ```

### Adjusted_lost_time_noact {#adjusted_lost_time_noact}

```csharp
float Adjusted_lost_time_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_lost_time_noact = outputMovementPed_GreenPeriod.Adjusted_lost_time_noact;
        ```

    === "C++"

        ```cpp
        double adjusted_lost_time_noact;
        outputMovementPed_GreenPeriod->get_Adjusted_lost_time_noact(&adjusted_lost_time_noact);
        ```

    === "Python"

        ```python
        adjusted_lost_time_noact = outputMovementPed_GreenPeriod.Adjusted_lost_time_noact
        ```

### Tmin_noact {#tmin_noact}

```csharp
float Tmin_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmin_noact = outputMovementPed_GreenPeriod.Tmin_noact;
        ```

    === "C++"

        ```cpp
        double tmin_noact;
        outputMovementPed_GreenPeriod->get_Tmin_noact(&tmin_noact);
        ```

    === "Python"

        ```python
        tmin_noact = outputMovementPed_GreenPeriod.Tmin_noact
        ```

### Clearance1_time_option {#clearance1_time_option}

```csharp
int Clearance1_time_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int clearance1_time_option = outputMovementPed_GreenPeriod.Clearance1_time_option;
        ```

    === "C++"

        ```cpp
        long clearance1_time_option;
        outputMovementPed_GreenPeriod->get_Clearance1_time_option(&clearance1_time_option);
        ```

    === "Python"

        ```python
        clearance1_time_option = outputMovementPed_GreenPeriod.Clearance1_time_option
        ```

### Clearance2_time_option {#clearance2_time_option}

```csharp
int Clearance2_time_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int clearance2_time_option = outputMovementPed_GreenPeriod.Clearance2_time_option;
        ```

    === "C++"

        ```cpp
        long clearance2_time_option;
        outputMovementPed_GreenPeriod->get_Clearance2_time_option(&clearance2_time_option);
        ```

    === "Python"

        ```python
        clearance2_time_option = outputMovementPed_GreenPeriod.Clearance2_time_option
        ```

### Clearance_time_total {#clearance_time_total}

```csharp
float Clearance_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float clearance_time_total = outputMovementPed_GreenPeriod.Clearance_time_total;
        ```

    === "C++"

        ```cpp
        double clearance_time_total;
        outputMovementPed_GreenPeriod->get_Clearance_time_total(&clearance_time_total);
        ```

    === "Python"

        ```python
        clearance_time_total = outputMovementPed_GreenPeriod.Clearance_time_total
        ```

### Ped_minimum_time {#ped_minimum_time}

```csharp
float Ped_minimum_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float ped_minimum_time = outputMovementPed_GreenPeriod.Ped_minimum_time;
        ```

    === "C++"

        ```cpp
        double ped_minimum_time;
        outputMovementPed_GreenPeriod->get_Ped_minimum_time(&ped_minimum_time);
        ```

    === "Python"

        ```python
        ped_minimum_time = outputMovementPed_GreenPeriod.Ped_minimum_time
        ```

### Ped_minimum_time_user_spec {#ped_minimum_time_user_spec}

```csharp
bool Ped_minimum_time_user_spec { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool ped_minimum_time_user_spec = outputMovementPed_GreenPeriod.Ped_minimum_time_user_spec;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL ped_minimum_time_user_spec;
        outputMovementPed_GreenPeriod->get_Ped_minimum_time_user_spec(&ped_minimum_time_user_spec);
        ```

    === "Python"

        ```python
        ped_minimum_time_user_spec = outputMovementPed_GreenPeriod.Ped_minimum_time_user_spec
        ```

### Ped_maximum_time {#ped_maximum_time}

```csharp
float Ped_maximum_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float ped_maximum_time = outputMovementPed_GreenPeriod.Ped_maximum_time;
        ```

    === "C++"

        ```cpp
        double ped_maximum_time;
        outputMovementPed_GreenPeriod->get_Ped_maximum_time(&ped_maximum_time);
        ```

    === "Python"

        ```python
        ped_maximum_time = outputMovementPed_GreenPeriod.Ped_maximum_time
        ```

### Ped_negative_end_gain {#ped_negative_end_gain}

```csharp
float Ped_negative_end_gain { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float ped_negative_end_gain = outputMovementPed_GreenPeriod.Ped_negative_end_gain;
        ```

    === "C++"

        ```cpp
        double ped_negative_end_gain;
        outputMovementPed_GreenPeriod->get_Ped_negative_end_gain(&ped_negative_end_gain);
        ```

    === "Python"

        ```python
        ped_negative_end_gain = outputMovementPed_GreenPeriod.Ped_negative_end_gain
        ```

### Start_intergrn_noact {#start_intergrn_noact}

```csharp
float Start_intergrn_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_intergrn_noact = outputMovementPed_GreenPeriod.Start_intergrn_noact;
        ```

    === "C++"

        ```cpp
        double start_intergrn_noact;
        outputMovementPed_GreenPeriod->get_Start_intergrn_noact(&start_intergrn_noact);
        ```

    === "Python"

        ```python
        start_intergrn_noact = outputMovementPed_GreenPeriod.Start_intergrn_noact
        ```

### Start_intergrn {#start_intergrn}

```csharp
float Start_intergrn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_intergrn = outputMovementPed_GreenPeriod.Start_intergrn;
        ```

    === "C++"

        ```cpp
        double start_intergrn;
        outputMovementPed_GreenPeriod->get_Start_intergrn(&start_intergrn);
        ```

    === "Python"

        ```python
        start_intergrn = outputMovementPed_GreenPeriod.Start_intergrn
        ```

### Eff_min_walk_time_noact {#eff_min_walk_time_noact}

```csharp
float Eff_min_walk_time_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_min_walk_time_noact = outputMovementPed_GreenPeriod.Eff_min_walk_time_noact;
        ```

    === "C++"

        ```cpp
        double eff_min_walk_time_noact;
        outputMovementPed_GreenPeriod->get_Eff_min_walk_time_noact(&eff_min_walk_time_noact);
        ```

    === "Python"

        ```python
        eff_min_walk_time_noact = outputMovementPed_GreenPeriod.Eff_min_walk_time_noact
        ```

### Eff_min_walk_time {#eff_min_walk_time}

```csharp
float Eff_min_walk_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_min_walk_time = outputMovementPed_GreenPeriod.Eff_min_walk_time;
        ```

    === "C++"

        ```cpp
        double eff_min_walk_time;
        outputMovementPed_GreenPeriod->get_Eff_min_walk_time(&eff_min_walk_time);
        ```

    === "Python"

        ```python
        eff_min_walk_time = outputMovementPed_GreenPeriod.Eff_min_walk_time
        ```

### Walk_extension_time {#walk_extension_time}

```csharp
float Walk_extension_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float walk_extension_time = outputMovementPed_GreenPeriod.Walk_extension_time;
        ```

    === "C++"

        ```cpp
        double walk_extension_time;
        outputMovementPed_GreenPeriod->get_Walk_extension_time(&walk_extension_time);
        ```

    === "Python"

        ```python
        walk_extension_time = outputMovementPed_GreenPeriod.Walk_extension_time
        ```

### Total_walk_time {#total_walk_time}

```csharp
float Total_walk_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_walk_time = outputMovementPed_GreenPeriod.Total_walk_time;
        ```

    === "C++"

        ```cpp
        double total_walk_time;
        outputMovementPed_GreenPeriod->get_Total_walk_time(&total_walk_time);
        ```

    === "Python"

        ```python
        total_walk_time = outputMovementPed_GreenPeriod.Total_walk_time
        ```

### Prob_ped_arrival {#prob_ped_arrival}

```csharp
float Prob_ped_arrival { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_ped_arrival = outputMovementPed_GreenPeriod.Prob_ped_arrival;
        ```

    === "C++"

        ```cpp
        double prob_ped_arrival;
        outputMovementPed_GreenPeriod->get_Prob_ped_arrival(&prob_ped_arrival);
        ```

    === "Python"

        ```python
        prob_ped_arrival = outputMovementPed_GreenPeriod.Prob_ped_arrival
        ```

### Prob_ped_arrival_option {#prob_ped_arrival_option}

```csharp
int Prob_ped_arrival_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int prob_ped_arrival_option = outputMovementPed_GreenPeriod.Prob_ped_arrival_option;
        ```

    === "C++"

        ```cpp
        long prob_ped_arrival_option;
        outputMovementPed_GreenPeriod->get_Prob_ped_arrival_option(&prob_ped_arrival_option);
        ```

    === "Python"

        ```python
        prob_ped_arrival_option = outputMovementPed_GreenPeriod.Prob_ped_arrival_option
        ```

### Ped_maximum_time_option {#ped_maximum_time_option}

```csharp
int Ped_maximum_time_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int ped_maximum_time_option = outputMovementPed_GreenPeriod.Ped_maximum_time_option;
        ```

    === "C++"

        ```cpp
        long ped_maximum_time_option;
        outputMovementPed_GreenPeriod->get_Ped_maximum_time_option(&ped_maximum_time_option);
        ```

    === "Python"

        ```python
        ped_maximum_time_option = outputMovementPed_GreenPeriod.Ped_maximum_time_option
        ```

### Unadj_reqd_time {#unadj_reqd_time}

```csharp
float Unadj_reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unadj_reqd_time = outputMovementPed_GreenPeriod.Unadj_reqd_time;
        ```

    === "C++"

        ```cpp
        double unadj_reqd_time;
        outputMovementPed_GreenPeriod->get_Unadj_reqd_time(&unadj_reqd_time);
        ```

    === "Python"

        ```python
        unadj_reqd_time = outputMovementPed_GreenPeriod.Unadj_reqd_time
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

```csharp
float Practical_degree_of_saturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = outputMovementPed_GreenPeriod.Practical_degree_of_saturation;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        outputMovementPed_GreenPeriod->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = outputMovementPed_GreenPeriod.Practical_degree_of_saturation
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementped_greenperiods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPed_GreenPeriods
title: OutputMovementPed_GreenPeriods
name: ISIAPIOutputMovementPed_GreenPeriods
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: EDFEE1C1-0FFF-4F18-B226-1B441787E042
members:
  - bool GreenPeriodExists(int greenperiod)
  - ISIAPIOutputMovementPed_GreenPeriod this[int greenperiod]
  - int Count
---

# OutputMovementPed_GreenPeriods

Type `ISIAPIOutputMovementPed_GreenPeriods` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `EDFEE1C1-0FFF-4F18-B226-1B441787E042`

## Declaration

```csharp
[Guid("EDFEE1C1-0FFF-4F18-B226-1B441787E042")]
public interface ISIAPIOutputMovementPed_GreenPeriods
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementPed_GreenPeriod`](sidrasolutions.si.api.isiapioutputmovementped_greenperiod.md) | Get a Pedestrian Movement Output Green Period. Return a Pedestrian Movement Output Green Period if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [GreenPeriodExists(int)](#greenperiodexists-int) | `bool` | Get a value indicating whether a Pedestrian Movement Output Green Period exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementPed_GreenPeriods.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementPed_GreenPeriods->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementPed_GreenPeriods.Count
        ```

### this[] {#this}

Get a Pedestrian Movement Output Green Period.  
Return a Pedestrian Movement Output Green Period if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputMovementPed_GreenPeriod this[] { get; }
```

**Type** [`ISIAPIOutputMovementPed_GreenPeriod`](sidrasolutions.si.api.isiapioutputmovementped_greenperiod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementPed_GreenPeriods.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPed_GreenPeriod> this[];
        outputMovementPed_GreenPeriods->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementPed_GreenPeriods.this[]
        ```

## Methods

### GreenPeriodExists(int) {#greenperiodexists-int}

Get a value indicating whether a Pedestrian Movement Output Green Period exists in the data storage.

```csharp
bool GreenPeriodExists(int greenperiod)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `greenperiod` | `int` | A one-based integer. |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementPed_GreenPeriods.GreenPeriodExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementPed_GreenPeriods->GreenPeriodExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementPed_GreenPeriods.GreenPeriodExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementpeds.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPeds
title: OutputMovementPeds
name: ISIAPIOutputMovementPeds
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: CF0394B0-4C77-480C-86EF-510921AE1905
members:
  - bool MovementExists(int type, int origin, int stage)
  - ISIAPIOutputMovementPed this[int type, int origin, int stage]
  - int Count
---

# OutputMovementPeds

Type `ISIAPIOutputMovementPeds` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `CF0394B0-4C77-480C-86EF-510921AE1905`

## Declaration

```csharp
[Guid("CF0394B0-4C77-480C-86EF-510921AE1905")]
public interface ISIAPIOutputMovementPeds
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementPed`](sidrasolutions.si.api.isiapioutputmovementped.md) | Get a Pedestrian Movement Output Data Object. Return a Pedestrian Movement Output Data Object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int, int)](#movementexists-int--int--int) | `bool` | Get a value indicating whether a Pedestrian Movement Output Data Object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementPeds.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementPeds->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementPeds.Count
        ```

### this[] {#this}

Get a Pedestrian Movement Output Data Object.  
Return a Pedestrian Movement Output Data Object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputMovementPed this[] { get; }
```

**Type** [`ISIAPIOutputMovementPed`](sidrasolutions.si.api.isiapioutputmovementped.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementPeds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPed> this[];
        outputMovementPeds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementPeds.this[]
        ```

## Methods

### MovementExists(int, int, int) {#movementexists-int--int--int}

Get a value indicating whether a Pedestrian Movement Output Data Object exists in the data storage.

```csharp
bool MovementExists(int type, int origin, int stage)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `type` | `int` | One of: - `1` - Full Crossing - `2` - Slip Lane - `3` - Staged - `4` - Diagonal |
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `stage` | `int` | One of: - `1` - Stage 1 (Approach-side crossing) - `2` - Stage 2 (Exit-side crossing) |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementPeds.MovementExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementPeds->MovementExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementPeds.MovementExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementpersonod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPersonOD
title: OutputMovementPersonOD
name: ISIAPIOutputMovementPersonOD
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 7E06C45A-BABA-49B4-AE49-947232DC291B
members:
  - int Origin
  - int Destination
  - float Demand_flow_total
  - float Arrival_flow_total
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_total
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Performance_index
  - ISIAPIOutputMovementPersonODMCs OutputMovementPersonODMCs
  - ISIAPIOutputset Outputset
  - float Operating_cost_rate
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputMovementPersonOD

Type `ISIAPIOutputMovementPersonOD` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `7E06C45A-BABA-49B4-AE49-947232DC291B`

## Declaration

```csharp
[Guid("7E06C45A-BABA-49B4-AE49-947232DC291B")]
public interface ISIAPIOutputMovementPersonOD
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` | Movement Origin Leg |
| [Destination](#destination) | `int` | Movement Destination Leg |
| [Demand_flow_total](#demand_flow_total) | `float` |  |
| [Arrival_flow_total](#arrival_flow_total) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Delay_control_total](#delay_control_total) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [OutputMovementPersonODMCs](#outputmovementpersonodmcs) | [`ISIAPIOutputMovementPersonODMCs`](sidrasolutions.si.api.isiapioutputmovementpersonodmcs.md) |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### Origin {#origin}

Movement Origin Leg

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = outputMovementPersonOD.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        outputMovementPersonOD->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = outputMovementPersonOD.Origin
        ```

### Destination {#destination}

Movement Destination Leg

```csharp
int Destination { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = outputMovementPersonOD.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        outputMovementPersonOD->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = outputMovementPersonOD.Destination
        ```

### Demand_flow_total {#demand_flow_total}

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputMovementPersonOD.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputMovementPersonOD->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputMovementPersonOD.Demand_flow_total
        ```

### Arrival_flow_total {#arrival_flow_total}

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputMovementPersonOD.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputMovementPersonOD->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputMovementPersonOD.Arrival_flow_total
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMovementPersonOD.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMovementPersonOD->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMovementPersonOD.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputMovementPersonOD.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputMovementPersonOD->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputMovementPersonOD.Delay_control_average_worstmov
        ```

### Delay_control_total {#delay_control_total}

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputMovementPersonOD.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputMovementPersonOD->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputMovementPersonOD.Delay_control_total
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMovementPersonOD.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMovementPersonOD->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMovementPersonOD.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputMovementPersonOD.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputMovementPersonOD->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputMovementPersonOD.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputMovementPersonOD.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputMovementPersonOD->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputMovementPersonOD.Proportion_queued
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputMovementPersonOD.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputMovementPersonOD->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputMovementPersonOD.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputMovementPersonOD.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputMovementPersonOD->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputMovementPersonOD.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputMovementPersonOD.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputMovementPersonOD->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputMovementPersonOD.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputMovementPersonOD.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputMovementPersonOD->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputMovementPersonOD.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMovementPersonOD.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMovementPersonOD->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMovementPersonOD.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMovementPersonOD.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMovementPersonOD->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMovementPersonOD.Operating_cost_total
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMovementPersonOD.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMovementPersonOD->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMovementPersonOD.Performance_index
        ```

### OutputMovementPersonODMCs {#outputmovementpersonodmcs}

```csharp
ISIAPIOutputMovementPersonODMCs OutputMovementPersonODMCs { get; }
```

**Type** [`ISIAPIOutputMovementPersonODMCs`](sidrasolutions.si.api.isiapioutputmovementpersonodmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementPersonODMCs = outputMovementPersonOD.OutputMovementPersonODMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPersonODMCs> outputMovementPersonODMCs;
        outputMovementPersonOD->get_OutputMovementPersonODMCs(&outputMovementPersonODMCs);
        ```

    === "Python"

        ```python
        output_movement_person_odm_cs = outputMovementPersonOD.OutputMovementPersonODMCs
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputMovementPersonOD.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputMovementPersonOD->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputMovementPersonOD.Outputset
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputMovementPersonOD.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputMovementPersonOD->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputMovementPersonOD.Operating_cost_rate
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputMovementPersonOD.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputMovementPersonOD->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputMovementPersonOD.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputMovementPersonOD.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputMovementPersonOD->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputMovementPersonOD.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputMovementPersonOD.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputMovementPersonOD->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputMovementPersonOD.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputMovementPersonOD.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputMovementPersonOD->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputMovementPersonOD.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementpersonodmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPersonODMC
title: OutputMovementPersonODMC
name: ISIAPIOutputMovementPersonODMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 31415A8A-7D61-42E1-B622-261ED2B04FC8
members:
  - int MC_class
  - bool Calc_exists
  - float Demand_flow_total
  - float Arrival_flow_total
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_total
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Performance_index
  - ISIAPIOutputMovementPersonOD OutputMovementPersonOD
  - float Operating_cost_rate
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputMovementPersonODMC

Type `ISIAPIOutputMovementPersonODMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `31415A8A-7D61-42E1-B622-261ED2B04FC8`

## Declaration

```csharp
[Guid("31415A8A-7D61-42E1-B622-261ED2B04FC8")]
public interface ISIAPIOutputMovementPersonODMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Demand_flow_total](#demand_flow_total) | `float` |  |
| [Arrival_flow_total](#arrival_flow_total) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Delay_control_total](#delay_control_total) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [OutputMovementPersonOD](#outputmovementpersonod) | [`ISIAPIOutputMovementPersonOD`](sidrasolutions.si.api.isiapioutputmovementpersonod.md) |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputMovementPersonODMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputMovementPersonODMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputMovementPersonODMC.MC_class
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputMovementPersonODMC.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputMovementPersonODMC->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputMovementPersonODMC.Calc_exists
        ```

### Demand_flow_total {#demand_flow_total}

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputMovementPersonODMC.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputMovementPersonODMC->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputMovementPersonODMC.Demand_flow_total
        ```

### Arrival_flow_total {#arrival_flow_total}

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputMovementPersonODMC.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputMovementPersonODMC->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputMovementPersonODMC.Arrival_flow_total
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMovementPersonODMC.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMovementPersonODMC->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMovementPersonODMC.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputMovementPersonODMC.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputMovementPersonODMC->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputMovementPersonODMC.Delay_control_average_worstmov
        ```

### Delay_control_total {#delay_control_total}

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputMovementPersonODMC.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputMovementPersonODMC->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputMovementPersonODMC.Delay_control_total
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMovementPersonODMC.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMovementPersonODMC->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMovementPersonODMC.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputMovementPersonODMC.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputMovementPersonODMC->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputMovementPersonODMC.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputMovementPersonODMC.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputMovementPersonODMC->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputMovementPersonODMC.Proportion_queued
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputMovementPersonODMC.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputMovementPersonODMC->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputMovementPersonODMC.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputMovementPersonODMC.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputMovementPersonODMC->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputMovementPersonODMC.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputMovementPersonODMC.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputMovementPersonODMC->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputMovementPersonODMC.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputMovementPersonODMC.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputMovementPersonODMC->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputMovementPersonODMC.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMovementPersonODMC.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMovementPersonODMC->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMovementPersonODMC.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMovementPersonODMC.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMovementPersonODMC->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMovementPersonODMC.Operating_cost_total
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMovementPersonODMC.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMovementPersonODMC->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMovementPersonODMC.Performance_index
        ```

### OutputMovementPersonOD {#outputmovementpersonod}

```csharp
ISIAPIOutputMovementPersonOD OutputMovementPersonOD { get; }
```

**Type** [`ISIAPIOutputMovementPersonOD`](sidrasolutions.si.api.isiapioutputmovementpersonod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementPersonOD = outputMovementPersonODMC.OutputMovementPersonOD;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPersonOD> outputMovementPersonOD;
        outputMovementPersonODMC->get_OutputMovementPersonOD(&outputMovementPersonOD);
        ```

    === "Python"

        ```python
        output_movement_person_od = outputMovementPersonODMC.OutputMovementPersonOD
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputMovementPersonODMC.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputMovementPersonODMC->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputMovementPersonODMC.Operating_cost_rate
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputMovementPersonODMC.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputMovementPersonODMC->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputMovementPersonODMC.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputMovementPersonODMC.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputMovementPersonODMC->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputMovementPersonODMC.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputMovementPersonODMC.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputMovementPersonODMC->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputMovementPersonODMC.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputMovementPersonODMC.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputMovementPersonODMC->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputMovementPersonODMC.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementpersonodmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPersonODMCs
title: OutputMovementPersonODMCs
name: ISIAPIOutputMovementPersonODMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FDB5EC6B-6CD7-4627-B092-0D1AA64B3A0F
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputMovementPersonODMC this[int mcClass]
  - int Count
---

# OutputMovementPersonODMCs

Type `ISIAPIOutputMovementPersonODMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FDB5EC6B-6CD7-4627-B092-0D1AA64B3A0F`

## Declaration

```csharp
[Guid("FDB5EC6B-6CD7-4627-B092-0D1AA64B3A0F")]
public interface ISIAPIOutputMovementPersonODMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementPersonODMC`](sidrasolutions.si.api.isiapioutputmovementpersonodmc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementPersonODMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementPersonODMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementPersonODMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputMovementPersonODMC this[] { get; }
```

**Type** [`ISIAPIOutputMovementPersonODMC`](sidrasolutions.si.api.isiapioutputmovementpersonodmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementPersonODMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPersonODMC> this[];
        outputMovementPersonODMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementPersonODMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementPersonODMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementPersonODMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementPersonODMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementpersonods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementPersonODs
title: OutputMovementPersonODs
name: ISIAPIOutputMovementPersonODs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E2E5DA80-A3FB-48E7-9C63-EE2FEB4A5158
members:
  - bool MovementExists(int origin, int destination)
  - ISIAPIOutputMovementPersonOD this[int origin, int destination]
  - int Count
---

# OutputMovementPersonODs

Type `ISIAPIOutputMovementPersonODs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E2E5DA80-A3FB-48E7-9C63-EE2FEB4A5158`

## Declaration

```csharp
[Guid("E2E5DA80-A3FB-48E7-9C63-EE2FEB4A5158")]
public interface ISIAPIOutputMovementPersonODs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementPersonOD`](sidrasolutions.si.api.isiapioutputmovementpersonod.md) | Get a Movement Output Person Data Object. Return a Movement Output Person Data Object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int)](#movementexists-int--int) | `bool` | Get a value indicating whether a Movement Output Person Data Object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementPersonODs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementPersonODs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementPersonODs.Count
        ```

### this[] {#this}

Get a Movement Output Person Data Object.  
Return a Movement Output Person Data Object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputMovementPersonOD this[] { get; }
```

**Type** [`ISIAPIOutputMovementPersonOD`](sidrasolutions.si.api.isiapioutputmovementpersonod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementPersonODs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPersonOD> this[];
        outputMovementPersonODs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementPersonODs.this[]
        ```

## Methods

### MovementExists(int, int) {#movementexists-int--int}

Get a value indicating whether a Movement Output Person Data Object exists in the data storage.

```csharp
bool MovementExists(int origin, int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `destination` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementPersonODs.MovementExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementPersonODs->MovementExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementPersonODs.MovementExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleOD
title: OutputMovementVehicleOD
name: ISIAPIOutputMovementVehicleOD
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 6791D889-100D-409D-A180-BB65CC799EFC
members:
  - int Origin
  - int Destination
  - float Flow_total
  - float Flow_LV
  - float Flow_HV
  - float Flow_HV_pct
  - float Flow_total_capconstr
  - float Flow_LV_capconstr
  - float Flow_HV_capconstr
  - float Flow_HV_pct_capconstr
  - float Capacity_mov
  - float Deg_satn
  - int X1_flag
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_total_veh
  - float Delay_control_total_persons
  - float Delay_stopline_average
  - float Delay_geometric
  - string Level_of_service
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Running_speed
  - float Cruise_speed
  - float Operating_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Operating_cost_rate
  - float Fuel_consumption_rate
  - float Carbon_dioxide_rate
  - float Hydrocarbons_rate
  - float Carbon_monoxide_rate
  - float Nox_rate
  - int Green_periods
  - float Approach_negotiation_speed
  - float Exit_negotiation_speed
  - float Exit_cruise_speed
  - bool Has_highangle_slip
  - bool Has_lowangle_slip
  - bool Has_signals_control
  - bool Has_stop_control
  - bool Has_giveway_control
  - bool Has_continuous_control
  - int Effective_control
  - ISIAPIOutputMovementVehicleODMCs OutputMovementVehicleODMCs
  - float Delay_control_average_worstlane
  - float Delay_control_average_worstmov
  - float Travel_distance_stopline_total
  - float Travel_distance_stopline_average
  - float Travel_time_stopline_total
  - float Travel_time_stopline_average
  - float Idling_time_average
  - float SpeedEfficiency
  - int Arrival_flow_flag
  - int Capacity_data_type
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Capacity_adj_worstlane
  - int Capacity_adj_flag_worstlane
  - float Perc_arriving_during_green
  - float Platoon_ratio
  - int Equivalent_AT
  - float Avg_num_of_cycles_to_depart
  - float Unblocked_time_ratio
  - float Gap_accept_cycle_time
  - float Gap_accept_blocked_time
  - float Gap_accept_unblocked_time
  - float Minimum_delay
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float DesiredSpeedProgram
  - ISIAPIOutputset Outputset
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputMovementVehicleOD

Type `ISIAPIOutputMovementVehicleOD` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `6791D889-100D-409D-A180-BB65CC799EFC`

## Declaration

```csharp
[Guid("6791D889-100D-409D-A180-BB65CC799EFC")]
public interface ISIAPIOutputMovementVehicleOD
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` | Movement Origin Leg |
| [Destination](#destination) | `int` | Movement Destination Leg |
| [Flow_total](#flow_total) | `float` | Total Demand Flow Rate. |
| [Flow_LV](#flow_lv) | `float` | Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV](#flow_hv) | `float` | Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct](#flow_hv_pct) | `float` | Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` | Total Arrival Flow Rate. |
| [Flow_LV_capconstr](#flow_lv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV_capconstr](#flow_hv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct_capconstr](#flow_hv_pct_capconstr) | `float` | Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Capacity_mov](#capacity_mov) | `float` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [X1_flag](#x1_flag) | `int` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_total_veh](#delay_control_total_veh) | `float` |  |
| [Delay_control_total_persons](#delay_control_total_persons) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Delay_geometric](#delay_geometric) | `float` |  |
| [Level_of_service](#level_of_service) | `string` |  |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` |  |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` |  |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` |  |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` |  |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` |  |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Running_speed](#running_speed) | `float` |  |
| [Cruise_speed](#cruise_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Fuel_consumption_rate](#fuel_consumption_rate) | `float` |  |
| [Carbon_dioxide_rate](#carbon_dioxide_rate) | `float` |  |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` |  |
| [Carbon_monoxide_rate](#carbon_monoxide_rate) | `float` |  |
| [Nox_rate](#nox_rate) | `float` |  |
| [Green_periods](#green_periods) | `int` |  |
| [Approach_negotiation_speed](#approach_negotiation_speed) | `float` |  |
| [Exit_negotiation_speed](#exit_negotiation_speed) | `float` |  |
| [Exit_cruise_speed](#exit_cruise_speed) | `float` |  |
| [Has_highangle_slip](#has_highangle_slip) | `bool` |  |
| [Has_lowangle_slip](#has_lowangle_slip) | `bool` |  |
| [Has_signals_control](#has_signals_control) | `bool` |  |
| [Has_stop_control](#has_stop_control) | `bool` |  |
| [Has_giveway_control](#has_giveway_control) | `bool` |  |
| [Has_continuous_control](#has_continuous_control) | `bool` |  |
| [Effective_control](#effective_control) | `int` |  |
| [OutputMovementVehicleODMCs](#outputmovementvehicleodmcs) | [`ISIAPIOutputMovementVehicleODMCs`](sidrasolutions.si.api.isiapioutputmovementvehicleodmcs.md) |  |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Travel_distance_stopline_total](#travel_distance_stopline_total) | `float` |  |
| [Travel_distance_stopline_average](#travel_distance_stopline_average) | `float` |  |
| [Travel_time_stopline_total](#travel_time_stopline_total) | `float` |  |
| [Travel_time_stopline_average](#travel_time_stopline_average) | `float` |  |
| [Idling_time_average](#idling_time_average) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Capacity_data_type](#capacity_data_type) | `int` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Capacity_adj_worstlane](#capacity_adj_worstlane) | `float` |  |
| [Capacity_adj_flag_worstlane](#capacity_adj_flag_worstlane) | `int` |  |
| [Perc_arriving_during_green](#perc_arriving_during_green) | `float` |  |
| [Platoon_ratio](#platoon_ratio) | `float` |  |
| [Equivalent_AT](#equivalent_at) | `int` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Unblocked_time_ratio](#unblocked_time_ratio) | `float` |  |
| [Gap_accept_cycle_time](#gap_accept_cycle_time) | `float` |  |
| [Gap_accept_blocked_time](#gap_accept_blocked_time) | `float` |  |
| [Gap_accept_unblocked_time](#gap_accept_unblocked_time) | `float` |  |
| [Minimum_delay](#minimum_delay) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### Origin {#origin}

Movement Origin Leg

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = outputMovementVehicleOD.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        outputMovementVehicleOD->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = outputMovementVehicleOD.Origin
        ```

### Destination {#destination}

Movement Destination Leg

```csharp
int Destination { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = outputMovementVehicleOD.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        outputMovementVehicleOD->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = outputMovementVehicleOD.Destination
        ```

### Flow_total {#flow_total}

Total Demand Flow Rate.

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputMovementVehicleOD.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputMovementVehicleOD->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputMovementVehicleOD.Flow_total
        ```

### Flow_LV {#flow_lv}

Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV = outputMovementVehicleOD.Flow_LV;
        ```

    === "C++"

        ```cpp
        double flow_LV;
        outputMovementVehicleOD->get_Flow_LV(&flow_LV);
        ```

    === "Python"

        ```python
        flow_lv = outputMovementVehicleOD.Flow_LV
        ```

### Flow_HV {#flow_hv}

Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV = outputMovementVehicleOD.Flow_HV;
        ```

    === "C++"

        ```cpp
        double flow_HV;
        outputMovementVehicleOD->get_Flow_HV(&flow_HV);
        ```

    === "Python"

        ```python
        flow_hv = outputMovementVehicleOD.Flow_HV
        ```

### Flow_HV_pct {#flow_hv_pct}

Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct = outputMovementVehicleOD.Flow_HV_pct;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct;
        outputMovementVehicleOD->get_Flow_HV_pct(&flow_HV_pct);
        ```

    === "Python"

        ```python
        flow_hv_pct = outputMovementVehicleOD.Flow_HV_pct
        ```

### Flow_total_capconstr {#flow_total_capconstr}

Total Arrival Flow Rate.

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputMovementVehicleOD.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputMovementVehicleOD->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputMovementVehicleOD.Flow_total_capconstr
        ```

### Flow_LV_capconstr {#flow_lv_capconstr}

Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV_capconstr = outputMovementVehicleOD.Flow_LV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_LV_capconstr;
        outputMovementVehicleOD->get_Flow_LV_capconstr(&flow_LV_capconstr);
        ```

    === "Python"

        ```python
        flow_lv_capconstr = outputMovementVehicleOD.Flow_LV_capconstr
        ```

### Flow_HV_capconstr {#flow_hv_capconstr}

Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_capconstr = outputMovementVehicleOD.Flow_HV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_capconstr;
        outputMovementVehicleOD->get_Flow_HV_capconstr(&flow_HV_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_capconstr = outputMovementVehicleOD.Flow_HV_capconstr
        ```

### Flow_HV_pct_capconstr {#flow_hv_pct_capconstr}

Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct_capconstr = outputMovementVehicleOD.Flow_HV_pct_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct_capconstr;
        outputMovementVehicleOD->get_Flow_HV_pct_capconstr(&flow_HV_pct_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_pct_capconstr = outputMovementVehicleOD.Flow_HV_pct_capconstr
        ```

### Capacity_mov {#capacity_mov}

```csharp
float Capacity_mov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov = outputMovementVehicleOD.Capacity_mov;
        ```

    === "C++"

        ```cpp
        double capacity_mov;
        outputMovementVehicleOD->get_Capacity_mov(&capacity_mov);
        ```

    === "Python"

        ```python
        capacity_mov = outputMovementVehicleOD.Capacity_mov
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputMovementVehicleOD.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputMovementVehicleOD->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputMovementVehicleOD.Deg_satn
        ```

### X1_flag {#x1_flag}

```csharp
int X1_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int x1_flag = outputMovementVehicleOD.X1_flag;
        ```

    === "C++"

        ```cpp
        long x1_flag;
        outputMovementVehicleOD->get_X1_flag(&x1_flag);
        ```

    === "Python"

        ```python
        x1_flag = outputMovementVehicleOD.X1_flag
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputMovementVehicleOD.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputMovementVehicleOD->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputMovementVehicleOD.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMovementVehicleOD.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMovementVehicleOD->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMovementVehicleOD.Delay_control_average
        ```

### Delay_control_total_veh {#delay_control_total_veh}

```csharp
float Delay_control_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_veh = outputMovementVehicleOD.Delay_control_total_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_total_veh;
        outputMovementVehicleOD->get_Delay_control_total_veh(&delay_control_total_veh);
        ```

    === "Python"

        ```python
        delay_control_total_veh = outputMovementVehicleOD.Delay_control_total_veh
        ```

### Delay_control_total_persons {#delay_control_total_persons}

```csharp
float Delay_control_total_persons { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_persons = outputMovementVehicleOD.Delay_control_total_persons;
        ```

    === "C++"

        ```cpp
        double delay_control_total_persons;
        outputMovementVehicleOD->get_Delay_control_total_persons(&delay_control_total_persons);
        ```

    === "Python"

        ```python
        delay_control_total_persons = outputMovementVehicleOD.Delay_control_total_persons
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputMovementVehicleOD.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputMovementVehicleOD->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputMovementVehicleOD.Delay_stopline_average
        ```

### Delay_geometric {#delay_geometric}

```csharp
float Delay_geometric { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric = outputMovementVehicleOD.Delay_geometric;
        ```

    === "C++"

        ```cpp
        double delay_geometric;
        outputMovementVehicleOD->get_Delay_geometric(&delay_geometric);
        ```

    === "Python"

        ```python
        delay_geometric = outputMovementVehicleOD.Delay_geometric
        ```

### Level_of_service {#level_of_service}

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputMovementVehicleOD.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputMovementVehicleOD->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputMovementVehicleOD.Level_of_service
        ```

### Queue_cycav_mean {#queue_cycav_mean}

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputMovementVehicleOD.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputMovementVehicleOD->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputMovementVehicleOD.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputMovementVehicleOD.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputMovementVehicleOD->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputMovementVehicleOD.Queue_cycav_percentile
        ```

### Queue_maxback_mean {#queue_maxback_mean}

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputMovementVehicleOD.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputMovementVehicleOD->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputMovementVehicleOD.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputMovementVehicleOD.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputMovementVehicleOD->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputMovementVehicleOD.Queue_maxback_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputMovementVehicleOD.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputMovementVehicleOD->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputMovementVehicleOD.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputMovementVehicleOD.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputMovementVehicleOD->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputMovementVehicleOD.Queue_dist_cycav_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputMovementVehicleOD.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputMovementVehicleOD->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputMovementVehicleOD.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputMovementVehicleOD.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputMovementVehicleOD->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputMovementVehicleOD.Queue_dist_maxback_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputMovementVehicleOD.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputMovementVehicleOD->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputMovementVehicleOD.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputMovementVehicleOD.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputMovementVehicleOD->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputMovementVehicleOD.Queue_storage_ratio_percentile
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMovementVehicleOD.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMovementVehicleOD->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMovementVehicleOD.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputMovementVehicleOD.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputMovementVehicleOD->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputMovementVehicleOD.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputMovementVehicleOD.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputMovementVehicleOD->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputMovementVehicleOD.Proportion_queued
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMovementVehicleOD.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMovementVehicleOD->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMovementVehicleOD.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputMovementVehicleOD.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputMovementVehicleOD->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputMovementVehicleOD.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputMovementVehicleOD.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputMovementVehicleOD->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputMovementVehicleOD.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputMovementVehicleOD.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputMovementVehicleOD->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputMovementVehicleOD.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputMovementVehicleOD.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputMovementVehicleOD->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputMovementVehicleOD.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMovementVehicleOD.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMovementVehicleOD->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMovementVehicleOD.Travel_speed
        ```

### Running_speed {#running_speed}

```csharp
float Running_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float running_speed = outputMovementVehicleOD.Running_speed;
        ```

    === "C++"

        ```cpp
        double running_speed;
        outputMovementVehicleOD->get_Running_speed(&running_speed);
        ```

    === "Python"

        ```python
        running_speed = outputMovementVehicleOD.Running_speed
        ```

### Cruise_speed {#cruise_speed}

```csharp
float Cruise_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cruise_speed = outputMovementVehicleOD.Cruise_speed;
        ```

    === "C++"

        ```cpp
        double cruise_speed;
        outputMovementVehicleOD->get_Cruise_speed(&cruise_speed);
        ```

    === "Python"

        ```python
        cruise_speed = outputMovementVehicleOD.Cruise_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMovementVehicleOD.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMovementVehicleOD->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMovementVehicleOD.Operating_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputMovementVehicleOD.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputMovementVehicleOD->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputMovementVehicleOD.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputMovementVehicleOD.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputMovementVehicleOD->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputMovementVehicleOD.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputMovementVehicleOD.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputMovementVehicleOD->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputMovementVehicleOD.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputMovementVehicleOD.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputMovementVehicleOD->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputMovementVehicleOD.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputMovementVehicleOD.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputMovementVehicleOD->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputMovementVehicleOD.Nox_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputMovementVehicleOD.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputMovementVehicleOD->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputMovementVehicleOD.Operating_cost_rate
        ```

### Fuel_consumption_rate {#fuel_consumption_rate}

```csharp
float Fuel_consumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_rate = outputMovementVehicleOD.Fuel_consumption_rate;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_rate;
        outputMovementVehicleOD->get_Fuel_consumption_rate(&fuel_consumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputMovementVehicleOD.Fuel_consumption_rate
        ```

### Carbon_dioxide_rate {#carbon_dioxide_rate}

```csharp
float Carbon_dioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_rate = outputMovementVehicleOD.Carbon_dioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_rate;
        outputMovementVehicleOD->get_Carbon_dioxide_rate(&carbon_dioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputMovementVehicleOD.Carbon_dioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputMovementVehicleOD.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputMovementVehicleOD->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputMovementVehicleOD.Hydrocarbons_rate
        ```

### Carbon_monoxide_rate {#carbon_monoxide_rate}

```csharp
float Carbon_monoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_rate = outputMovementVehicleOD.Carbon_monoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_rate;
        outputMovementVehicleOD->get_Carbon_monoxide_rate(&carbon_monoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputMovementVehicleOD.Carbon_monoxide_rate
        ```

### Nox_rate {#nox_rate}

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputMovementVehicleOD.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputMovementVehicleOD->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputMovementVehicleOD.Nox_rate
        ```

### Green_periods {#green_periods}

```csharp
int Green_periods { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int green_periods = outputMovementVehicleOD.Green_periods;
        ```

    === "C++"

        ```cpp
        long green_periods;
        outputMovementVehicleOD->get_Green_periods(&green_periods);
        ```

    === "Python"

        ```python
        green_periods = outputMovementVehicleOD.Green_periods
        ```

### Approach_negotiation_speed {#approach_negotiation_speed}

```csharp
float Approach_negotiation_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float approach_negotiation_speed = outputMovementVehicleOD.Approach_negotiation_speed;
        ```

    === "C++"

        ```cpp
        double approach_negotiation_speed;
        outputMovementVehicleOD->get_Approach_negotiation_speed(&approach_negotiation_speed);
        ```

    === "Python"

        ```python
        approach_negotiation_speed = outputMovementVehicleOD.Approach_negotiation_speed
        ```

### Exit_negotiation_speed {#exit_negotiation_speed}

```csharp
float Exit_negotiation_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_negotiation_speed = outputMovementVehicleOD.Exit_negotiation_speed;
        ```

    === "C++"

        ```cpp
        double exit_negotiation_speed;
        outputMovementVehicleOD->get_Exit_negotiation_speed(&exit_negotiation_speed);
        ```

    === "Python"

        ```python
        exit_negotiation_speed = outputMovementVehicleOD.Exit_negotiation_speed
        ```

### Exit_cruise_speed {#exit_cruise_speed}

```csharp
float Exit_cruise_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_cruise_speed = outputMovementVehicleOD.Exit_cruise_speed;
        ```

    === "C++"

        ```cpp
        double exit_cruise_speed;
        outputMovementVehicleOD->get_Exit_cruise_speed(&exit_cruise_speed);
        ```

    === "Python"

        ```python
        exit_cruise_speed = outputMovementVehicleOD.Exit_cruise_speed
        ```

### Has_highangle_slip {#has_highangle_slip}

```csharp
bool Has_highangle_slip { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_highangle_slip = outputMovementVehicleOD.Has_highangle_slip;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_highangle_slip;
        outputMovementVehicleOD->get_Has_highangle_slip(&has_highangle_slip);
        ```

    === "Python"

        ```python
        has_highangle_slip = outputMovementVehicleOD.Has_highangle_slip
        ```

### Has_lowangle_slip {#has_lowangle_slip}

```csharp
bool Has_lowangle_slip { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_lowangle_slip = outputMovementVehicleOD.Has_lowangle_slip;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_lowangle_slip;
        outputMovementVehicleOD->get_Has_lowangle_slip(&has_lowangle_slip);
        ```

    === "Python"

        ```python
        has_lowangle_slip = outputMovementVehicleOD.Has_lowangle_slip
        ```

### Has_signals_control {#has_signals_control}

```csharp
bool Has_signals_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_signals_control = outputMovementVehicleOD.Has_signals_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_signals_control;
        outputMovementVehicleOD->get_Has_signals_control(&has_signals_control);
        ```

    === "Python"

        ```python
        has_signals_control = outputMovementVehicleOD.Has_signals_control
        ```

### Has_stop_control {#has_stop_control}

```csharp
bool Has_stop_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_stop_control = outputMovementVehicleOD.Has_stop_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_stop_control;
        outputMovementVehicleOD->get_Has_stop_control(&has_stop_control);
        ```

    === "Python"

        ```python
        has_stop_control = outputMovementVehicleOD.Has_stop_control
        ```

### Has_giveway_control {#has_giveway_control}

```csharp
bool Has_giveway_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_giveway_control = outputMovementVehicleOD.Has_giveway_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_giveway_control;
        outputMovementVehicleOD->get_Has_giveway_control(&has_giveway_control);
        ```

    === "Python"

        ```python
        has_giveway_control = outputMovementVehicleOD.Has_giveway_control
        ```

### Has_continuous_control {#has_continuous_control}

```csharp
bool Has_continuous_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_continuous_control = outputMovementVehicleOD.Has_continuous_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_continuous_control;
        outputMovementVehicleOD->get_Has_continuous_control(&has_continuous_control);
        ```

    === "Python"

        ```python
        has_continuous_control = outputMovementVehicleOD.Has_continuous_control
        ```

### Effective_control {#effective_control}

```csharp
int Effective_control { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int effective_control = outputMovementVehicleOD.Effective_control;
        ```

    === "C++"

        ```cpp
        long effective_control;
        outputMovementVehicleOD->get_Effective_control(&effective_control);
        ```

    === "Python"

        ```python
        effective_control = outputMovementVehicleOD.Effective_control
        ```

### OutputMovementVehicleODMCs {#outputmovementvehicleodmcs}

```csharp
ISIAPIOutputMovementVehicleODMCs OutputMovementVehicleODMCs { get; }
```

**Type** [`ISIAPIOutputMovementVehicleODMCs`](sidrasolutions.si.api.isiapioutputmovementvehicleodmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementVehicleODMCs = outputMovementVehicleOD.OutputMovementVehicleODMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleODMCs> outputMovementVehicleODMCs;
        outputMovementVehicleOD->get_OutputMovementVehicleODMCs(&outputMovementVehicleODMCs);
        ```

    === "Python"

        ```python
        output_movement_vehicle_odm_cs = outputMovementVehicleOD.OutputMovementVehicleODMCs
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputMovementVehicleOD.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputMovementVehicleOD->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputMovementVehicleOD.Delay_control_average_worstlane
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputMovementVehicleOD.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputMovementVehicleOD->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputMovementVehicleOD.Delay_control_average_worstmov
        ```

### Travel_distance_stopline_total {#travel_distance_stopline_total}

```csharp
float Travel_distance_stopline_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_stopline_total = outputMovementVehicleOD.Travel_distance_stopline_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_stopline_total;
        outputMovementVehicleOD->get_Travel_distance_stopline_total(&travel_distance_stopline_total);
        ```

    === "Python"

        ```python
        travel_distance_stopline_total = outputMovementVehicleOD.Travel_distance_stopline_total
        ```

### Travel_distance_stopline_average {#travel_distance_stopline_average}

```csharp
float Travel_distance_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_stopline_average = outputMovementVehicleOD.Travel_distance_stopline_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_stopline_average;
        outputMovementVehicleOD->get_Travel_distance_stopline_average(&travel_distance_stopline_average);
        ```

    === "Python"

        ```python
        travel_distance_stopline_average = outputMovementVehicleOD.Travel_distance_stopline_average
        ```

### Travel_time_stopline_total {#travel_time_stopline_total}

```csharp
float Travel_time_stopline_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_stopline_total = outputMovementVehicleOD.Travel_time_stopline_total;
        ```

    === "C++"

        ```cpp
        double travel_time_stopline_total;
        outputMovementVehicleOD->get_Travel_time_stopline_total(&travel_time_stopline_total);
        ```

    === "Python"

        ```python
        travel_time_stopline_total = outputMovementVehicleOD.Travel_time_stopline_total
        ```

### Travel_time_stopline_average {#travel_time_stopline_average}

```csharp
float Travel_time_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_stopline_average = outputMovementVehicleOD.Travel_time_stopline_average;
        ```

    === "C++"

        ```cpp
        double travel_time_stopline_average;
        outputMovementVehicleOD->get_Travel_time_stopline_average(&travel_time_stopline_average);
        ```

    === "Python"

        ```python
        travel_time_stopline_average = outputMovementVehicleOD.Travel_time_stopline_average
        ```

### Idling_time_average {#idling_time_average}

```csharp
float Idling_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idling_time_average = outputMovementVehicleOD.Idling_time_average;
        ```

    === "C++"

        ```cpp
        double idling_time_average;
        outputMovementVehicleOD->get_Idling_time_average(&idling_time_average);
        ```

    === "Python"

        ```python
        idling_time_average = outputMovementVehicleOD.Idling_time_average
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputMovementVehicleOD.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputMovementVehicleOD->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputMovementVehicleOD.SpeedEfficiency
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputMovementVehicleOD.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputMovementVehicleOD->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputMovementVehicleOD.Arrival_flow_flag
        ```

### Capacity_data_type {#capacity_data_type}

```csharp
int Capacity_data_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_data_type = outputMovementVehicleOD.Capacity_data_type;
        ```

    === "C++"

        ```cpp
        long capacity_data_type;
        outputMovementVehicleOD->get_Capacity_data_type(&capacity_data_type);
        ```

    === "Python"

        ```python
        capacity_data_type = outputMovementVehicleOD.Capacity_data_type
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputMovementVehicleOD.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputMovementVehicleOD->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputMovementVehicleOD.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputMovementVehicleOD.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputMovementVehicleOD->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputMovementVehicleOD.Queue_greenstart_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputMovementVehicleOD.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputMovementVehicleOD->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputMovementVehicleOD.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputMovementVehicleOD.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputMovementVehicleOD->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputMovementVehicleOD.Queue_dist_greenstart_percentile
        ```

### Capacity_adj_worstlane {#capacity_adj_worstlane}

```csharp
float Capacity_adj_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj_worstlane = outputMovementVehicleOD.Capacity_adj_worstlane;
        ```

    === "C++"

        ```cpp
        double capacity_adj_worstlane;
        outputMovementVehicleOD->get_Capacity_adj_worstlane(&capacity_adj_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_worstlane = outputMovementVehicleOD.Capacity_adj_worstlane
        ```

### Capacity_adj_flag_worstlane {#capacity_adj_flag_worstlane}

```csharp
int Capacity_adj_flag_worstlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag_worstlane = outputMovementVehicleOD.Capacity_adj_flag_worstlane;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag_worstlane;
        outputMovementVehicleOD->get_Capacity_adj_flag_worstlane(&capacity_adj_flag_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_flag_worstlane = outputMovementVehicleOD.Capacity_adj_flag_worstlane
        ```

### Perc_arriving_during_green {#perc_arriving_during_green}

```csharp
float Perc_arriving_during_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float perc_arriving_during_green = outputMovementVehicleOD.Perc_arriving_during_green;
        ```

    === "C++"

        ```cpp
        double perc_arriving_during_green;
        outputMovementVehicleOD->get_Perc_arriving_during_green(&perc_arriving_during_green);
        ```

    === "Python"

        ```python
        perc_arriving_during_green = outputMovementVehicleOD.Perc_arriving_during_green
        ```

### Platoon_ratio {#platoon_ratio}

```csharp
float Platoon_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_ratio = outputMovementVehicleOD.Platoon_ratio;
        ```

    === "C++"

        ```cpp
        double platoon_ratio;
        outputMovementVehicleOD->get_Platoon_ratio(&platoon_ratio);
        ```

    === "Python"

        ```python
        platoon_ratio = outputMovementVehicleOD.Platoon_ratio
        ```

### Equivalent_AT {#equivalent_at}

```csharp
int Equivalent_AT { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int equivalent_AT = outputMovementVehicleOD.Equivalent_AT;
        ```

    === "C++"

        ```cpp
        long equivalent_AT;
        outputMovementVehicleOD->get_Equivalent_AT(&equivalent_AT);
        ```

    === "Python"

        ```python
        equivalent_at = outputMovementVehicleOD.Equivalent_AT
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputMovementVehicleOD.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputMovementVehicleOD->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputMovementVehicleOD.Avg_num_of_cycles_to_depart
        ```

### Unblocked_time_ratio {#unblocked_time_ratio}

```csharp
float Unblocked_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unblocked_time_ratio = outputMovementVehicleOD.Unblocked_time_ratio;
        ```

    === "C++"

        ```cpp
        double unblocked_time_ratio;
        outputMovementVehicleOD->get_Unblocked_time_ratio(&unblocked_time_ratio);
        ```

    === "Python"

        ```python
        unblocked_time_ratio = outputMovementVehicleOD.Unblocked_time_ratio
        ```

### Gap_accept_cycle_time {#gap_accept_cycle_time}

```csharp
float Gap_accept_cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_cycle_time = outputMovementVehicleOD.Gap_accept_cycle_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_cycle_time;
        outputMovementVehicleOD->get_Gap_accept_cycle_time(&gap_accept_cycle_time);
        ```

    === "Python"

        ```python
        gap_accept_cycle_time = outputMovementVehicleOD.Gap_accept_cycle_time
        ```

### Gap_accept_blocked_time {#gap_accept_blocked_time}

```csharp
float Gap_accept_blocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_blocked_time = outputMovementVehicleOD.Gap_accept_blocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_blocked_time;
        outputMovementVehicleOD->get_Gap_accept_blocked_time(&gap_accept_blocked_time);
        ```

    === "Python"

        ```python
        gap_accept_blocked_time = outputMovementVehicleOD.Gap_accept_blocked_time
        ```

### Gap_accept_unblocked_time {#gap_accept_unblocked_time}

```csharp
float Gap_accept_unblocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_unblocked_time = outputMovementVehicleOD.Gap_accept_unblocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_unblocked_time;
        outputMovementVehicleOD->get_Gap_accept_unblocked_time(&gap_accept_unblocked_time);
        ```

    === "Python"

        ```python
        gap_accept_unblocked_time = outputMovementVehicleOD.Gap_accept_unblocked_time
        ```

### Minimum_delay {#minimum_delay}

```csharp
float Minimum_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_delay = outputMovementVehicleOD.Minimum_delay;
        ```

    === "C++"

        ```cpp
        double minimum_delay;
        outputMovementVehicleOD->get_Minimum_delay(&minimum_delay);
        ```

    === "Python"

        ```python
        minimum_delay = outputMovementVehicleOD.Minimum_delay
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputMovementVehicleOD.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputMovementVehicleOD->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputMovementVehicleOD.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputMovementVehicleOD.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputMovementVehicleOD->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputMovementVehicleOD.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputMovementVehicleOD.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputMovementVehicleOD->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputMovementVehicleOD.TravelTimeIndex
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputMovementVehicleOD.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputMovementVehicleOD->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputMovementVehicleOD.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputMovementVehicleOD.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputMovementVehicleOD->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputMovementVehicleOD.DesiredSpeed
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputMovementVehicleOD.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputMovementVehicleOD->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputMovementVehicleOD.DesiredSpeedProgram
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputMovementVehicleOD.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputMovementVehicleOD->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputMovementVehicleOD.Outputset
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputMovementVehicleOD.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputMovementVehicleOD->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputMovementVehicleOD.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputMovementVehicleOD.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputMovementVehicleOD->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputMovementVehicleOD.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputMovementVehicleOD.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputMovementVehicleOD->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputMovementVehicleOD.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputMovementVehicleOD.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputMovementVehicleOD->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputMovementVehicleOD.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleodmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleODMC
title: OutputMovementVehicleODMC
name: ISIAPIOutputMovementVehicleODMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 9E8001D0-ACD2-4DAE-BBCF-79DAE876BBD5
members:
  - int Origin
  - int Destination
  - int MC_class
  - float Flow
  - float Flow_capconstr
  - float Capacity_mov
  - float Deg_satn
  - int X1_flag
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_total_veh
  - float Delay_control_total_persons
  - float Delay_stopline_average
  - float Delay_geometric
  - string Level_of_service
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Running_speed
  - float Cruise_speed
  - float Operating_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Operating_cost_rate
  - float Fuel_consumption_rate
  - float Carbon_dioxide_rate
  - float Hydrocarbons_rate
  - float Carbon_monoxide_rate
  - float Nox_rate
  - int Green_periods
  - float Approach_negotiation_speed
  - float Exit_negotiation_speed
  - float Exit_cruise_speed
  - bool Has_highangle_slip
  - bool Has_lowangle_slip
  - bool Has_signals_control
  - bool Has_stop_control
  - bool Has_giveway_control
  - bool Has_continuous_control
  - int Effective_control
  - ISIAPIOutputMovementVehicleODMC_GreenPeriods OutputMovementVehicleODMC_GreenPeriods
  - ISIAPIOutputMovementVehicleOD OutputMovementVehicleOD
  - bool Calc_exists
  - float Travel_distance_stopline_total
  - float Travel_distance_stopline_average
  - float Travel_time_stopline_total
  - float Travel_time_stopline_average
  - float Negotiation_distance
  - float Perc_arriving_during_green
  - float Green_time_ratio
  - float Platoon_ratio
  - int Equivalent_AT
  - int Signal_coordination
  - bool Non_actuated
  - float SpeedEfficiency
  - int Arrival_flow_flag
  - float Practical_degree_of_saturation
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Avg_num_of_cycles_to_depart
  - float Initial_demand_vol
  - float Residual_demand_vol
  - float Residual_demand_vol_clear_time
  - float Oversatn_duration
  - float Unblocked_time_ratio
  - float Gap_accept_cycle_time
  - float Gap_accept_blocked_time
  - float Gap_accept_unblocked_time
  - float Minimum_delay
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float DesiredSpeedProgram
  - float Flow_capconstr_no_initial
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
---

# OutputMovementVehicleODMC

Type `ISIAPIOutputMovementVehicleODMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `9E8001D0-ACD2-4DAE-BBCF-79DAE876BBD5`

## Declaration

```csharp
[Guid("9E8001D0-ACD2-4DAE-BBCF-79DAE876BBD5")]
public interface ISIAPIOutputMovementVehicleODMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` |  |
| [Destination](#destination) | `int` |  |
| [MC_class](#mc_class) | `int` |  |
| [Flow](#flow) | `float` |  |
| [Flow_capconstr](#flow_capconstr) | `float` |  |
| [Capacity_mov](#capacity_mov) | `float` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [X1_flag](#x1_flag) | `int` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_total_veh](#delay_control_total_veh) | `float` |  |
| [Delay_control_total_persons](#delay_control_total_persons) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Delay_geometric](#delay_geometric) | `float` |  |
| [Level_of_service](#level_of_service) | `string` |  |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` |  |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` |  |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` |  |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` |  |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` |  |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Running_speed](#running_speed) | `float` |  |
| [Cruise_speed](#cruise_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Fuel_consumption_rate](#fuel_consumption_rate) | `float` |  |
| [Carbon_dioxide_rate](#carbon_dioxide_rate) | `float` |  |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` |  |
| [Carbon_monoxide_rate](#carbon_monoxide_rate) | `float` |  |
| [Nox_rate](#nox_rate) | `float` |  |
| [Green_periods](#green_periods) | `int` |  |
| [Approach_negotiation_speed](#approach_negotiation_speed) | `float` |  |
| [Exit_negotiation_speed](#exit_negotiation_speed) | `float` |  |
| [Exit_cruise_speed](#exit_cruise_speed) | `float` |  |
| [Has_highangle_slip](#has_highangle_slip) | `bool` |  |
| [Has_lowangle_slip](#has_lowangle_slip) | `bool` |  |
| [Has_signals_control](#has_signals_control) | `bool` |  |
| [Has_stop_control](#has_stop_control) | `bool` |  |
| [Has_giveway_control](#has_giveway_control) | `bool` |  |
| [Has_continuous_control](#has_continuous_control) | `bool` |  |
| [Effective_control](#effective_control) | `int` |  |
| [OutputMovementVehicleODMC_GreenPeriods](#outputmovementvehicleodmc_greenperiods) | [`ISIAPIOutputMovementVehicleODMC_GreenPeriods`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiods.md) |  |
| [OutputMovementVehicleOD](#outputmovementvehicleod) | [`ISIAPIOutputMovementVehicleOD`](sidrasolutions.si.api.isiapioutputmovementvehicleod.md) |  |
| [Calc_exists](#calc_exists) | `bool` |  |
| [Travel_distance_stopline_total](#travel_distance_stopline_total) | `float` |  |
| [Travel_distance_stopline_average](#travel_distance_stopline_average) | `float` |  |
| [Travel_time_stopline_total](#travel_time_stopline_total) | `float` |  |
| [Travel_time_stopline_average](#travel_time_stopline_average) | `float` |  |
| [Negotiation_distance](#negotiation_distance) | `float` |  |
| [Perc_arriving_during_green](#perc_arriving_during_green) | `float` |  |
| [Green_time_ratio](#green_time_ratio) | `float` |  |
| [Platoon_ratio](#platoon_ratio) | `float` |  |
| [Equivalent_AT](#equivalent_at) | `int` |  |
| [Signal_coordination](#signal_coordination) | `int` |  |
| [Non_actuated](#non_actuated) | `bool` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Arrival_flow_flag](#arrival_flow_flag) | `int` |  |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Initial_demand_vol](#initial_demand_vol) | `float` |  |
| [Residual_demand_vol](#residual_demand_vol) | `float` |  |
| [Residual_demand_vol_clear_time](#residual_demand_vol_clear_time) | `float` |  |
| [Oversatn_duration](#oversatn_duration) | `float` |  |
| [Unblocked_time_ratio](#unblocked_time_ratio) | `float` |  |
| [Gap_accept_cycle_time](#gap_accept_cycle_time) | `float` |  |
| [Gap_accept_blocked_time](#gap_accept_blocked_time) | `float` |  |
| [Gap_accept_unblocked_time](#gap_accept_unblocked_time) | `float` |  |
| [Minimum_delay](#minimum_delay) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [Flow_capconstr_no_initial](#flow_capconstr_no_initial) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |

</div>

## Properties

### Origin {#origin}

```csharp
int Origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = outputMovementVehicleODMC.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        outputMovementVehicleODMC->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = outputMovementVehicleODMC.Origin
        ```

### Destination {#destination}

```csharp
int Destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = outputMovementVehicleODMC.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        outputMovementVehicleODMC->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = outputMovementVehicleODMC.Destination
        ```

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputMovementVehicleODMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputMovementVehicleODMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputMovementVehicleODMC.MC_class
        ```

### Flow {#flow}

```csharp
float Flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow = outputMovementVehicleODMC.Flow;
        ```

    === "C++"

        ```cpp
        double flow;
        outputMovementVehicleODMC->get_Flow(&flow);
        ```

    === "Python"

        ```python
        flow = outputMovementVehicleODMC.Flow
        ```

### Flow_capconstr {#flow_capconstr}

```csharp
float Flow_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr = outputMovementVehicleODMC.Flow_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_capconstr;
        outputMovementVehicleODMC->get_Flow_capconstr(&flow_capconstr);
        ```

    === "Python"

        ```python
        flow_capconstr = outputMovementVehicleODMC.Flow_capconstr
        ```

### Capacity_mov {#capacity_mov}

```csharp
float Capacity_mov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov = outputMovementVehicleODMC.Capacity_mov;
        ```

    === "C++"

        ```cpp
        double capacity_mov;
        outputMovementVehicleODMC->get_Capacity_mov(&capacity_mov);
        ```

    === "Python"

        ```python
        capacity_mov = outputMovementVehicleODMC.Capacity_mov
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputMovementVehicleODMC.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputMovementVehicleODMC->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputMovementVehicleODMC.Deg_satn
        ```

### X1_flag {#x1_flag}

```csharp
int X1_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int x1_flag = outputMovementVehicleODMC.X1_flag;
        ```

    === "C++"

        ```cpp
        long x1_flag;
        outputMovementVehicleODMC->get_X1_flag(&x1_flag);
        ```

    === "Python"

        ```python
        x1_flag = outputMovementVehicleODMC.X1_flag
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputMovementVehicleODMC.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputMovementVehicleODMC->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputMovementVehicleODMC.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMovementVehicleODMC.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMovementVehicleODMC->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMovementVehicleODMC.Delay_control_average
        ```

### Delay_control_total_veh {#delay_control_total_veh}

```csharp
float Delay_control_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_veh = outputMovementVehicleODMC.Delay_control_total_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_total_veh;
        outputMovementVehicleODMC->get_Delay_control_total_veh(&delay_control_total_veh);
        ```

    === "Python"

        ```python
        delay_control_total_veh = outputMovementVehicleODMC.Delay_control_total_veh
        ```

### Delay_control_total_persons {#delay_control_total_persons}

```csharp
float Delay_control_total_persons { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_persons = outputMovementVehicleODMC.Delay_control_total_persons;
        ```

    === "C++"

        ```cpp
        double delay_control_total_persons;
        outputMovementVehicleODMC->get_Delay_control_total_persons(&delay_control_total_persons);
        ```

    === "Python"

        ```python
        delay_control_total_persons = outputMovementVehicleODMC.Delay_control_total_persons
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputMovementVehicleODMC.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputMovementVehicleODMC->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputMovementVehicleODMC.Delay_stopline_average
        ```

### Delay_geometric {#delay_geometric}

```csharp
float Delay_geometric { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric = outputMovementVehicleODMC.Delay_geometric;
        ```

    === "C++"

        ```cpp
        double delay_geometric;
        outputMovementVehicleODMC->get_Delay_geometric(&delay_geometric);
        ```

    === "Python"

        ```python
        delay_geometric = outputMovementVehicleODMC.Delay_geometric
        ```

### Level_of_service {#level_of_service}

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputMovementVehicleODMC.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputMovementVehicleODMC->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputMovementVehicleODMC.Level_of_service
        ```

### Queue_cycav_mean {#queue_cycav_mean}

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputMovementVehicleODMC.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputMovementVehicleODMC->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputMovementVehicleODMC.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputMovementVehicleODMC.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputMovementVehicleODMC->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputMovementVehicleODMC.Queue_cycav_percentile
        ```

### Queue_maxback_mean {#queue_maxback_mean}

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputMovementVehicleODMC.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputMovementVehicleODMC->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputMovementVehicleODMC.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputMovementVehicleODMC.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputMovementVehicleODMC->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputMovementVehicleODMC.Queue_maxback_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputMovementVehicleODMC.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputMovementVehicleODMC->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputMovementVehicleODMC.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputMovementVehicleODMC.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputMovementVehicleODMC->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputMovementVehicleODMC.Queue_dist_cycav_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputMovementVehicleODMC.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputMovementVehicleODMC->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputMovementVehicleODMC.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputMovementVehicleODMC.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputMovementVehicleODMC->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputMovementVehicleODMC.Queue_dist_maxback_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputMovementVehicleODMC.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputMovementVehicleODMC->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputMovementVehicleODMC.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputMovementVehicleODMC.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputMovementVehicleODMC->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputMovementVehicleODMC.Queue_storage_ratio_percentile
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMovementVehicleODMC.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMovementVehicleODMC->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMovementVehicleODMC.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputMovementVehicleODMC.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputMovementVehicleODMC->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputMovementVehicleODMC.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputMovementVehicleODMC.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputMovementVehicleODMC->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputMovementVehicleODMC.Proportion_queued
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMovementVehicleODMC.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMovementVehicleODMC->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMovementVehicleODMC.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputMovementVehicleODMC.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputMovementVehicleODMC->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputMovementVehicleODMC.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputMovementVehicleODMC.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputMovementVehicleODMC->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputMovementVehicleODMC.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputMovementVehicleODMC.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputMovementVehicleODMC->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputMovementVehicleODMC.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputMovementVehicleODMC.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputMovementVehicleODMC->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputMovementVehicleODMC.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMovementVehicleODMC.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMovementVehicleODMC->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMovementVehicleODMC.Travel_speed
        ```

### Running_speed {#running_speed}

```csharp
float Running_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float running_speed = outputMovementVehicleODMC.Running_speed;
        ```

    === "C++"

        ```cpp
        double running_speed;
        outputMovementVehicleODMC->get_Running_speed(&running_speed);
        ```

    === "Python"

        ```python
        running_speed = outputMovementVehicleODMC.Running_speed
        ```

### Cruise_speed {#cruise_speed}

```csharp
float Cruise_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cruise_speed = outputMovementVehicleODMC.Cruise_speed;
        ```

    === "C++"

        ```cpp
        double cruise_speed;
        outputMovementVehicleODMC->get_Cruise_speed(&cruise_speed);
        ```

    === "Python"

        ```python
        cruise_speed = outputMovementVehicleODMC.Cruise_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMovementVehicleODMC.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMovementVehicleODMC->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMovementVehicleODMC.Operating_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputMovementVehicleODMC.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputMovementVehicleODMC->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputMovementVehicleODMC.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputMovementVehicleODMC.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputMovementVehicleODMC->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputMovementVehicleODMC.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputMovementVehicleODMC.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputMovementVehicleODMC->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputMovementVehicleODMC.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputMovementVehicleODMC.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputMovementVehicleODMC->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputMovementVehicleODMC.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputMovementVehicleODMC.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputMovementVehicleODMC->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputMovementVehicleODMC.Nox_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputMovementVehicleODMC.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputMovementVehicleODMC->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputMovementVehicleODMC.Operating_cost_rate
        ```

### Fuel_consumption_rate {#fuel_consumption_rate}

```csharp
float Fuel_consumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_rate = outputMovementVehicleODMC.Fuel_consumption_rate;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_rate;
        outputMovementVehicleODMC->get_Fuel_consumption_rate(&fuel_consumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputMovementVehicleODMC.Fuel_consumption_rate
        ```

### Carbon_dioxide_rate {#carbon_dioxide_rate}

```csharp
float Carbon_dioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_rate = outputMovementVehicleODMC.Carbon_dioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_rate;
        outputMovementVehicleODMC->get_Carbon_dioxide_rate(&carbon_dioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputMovementVehicleODMC.Carbon_dioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputMovementVehicleODMC.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputMovementVehicleODMC->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputMovementVehicleODMC.Hydrocarbons_rate
        ```

### Carbon_monoxide_rate {#carbon_monoxide_rate}

```csharp
float Carbon_monoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_rate = outputMovementVehicleODMC.Carbon_monoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_rate;
        outputMovementVehicleODMC->get_Carbon_monoxide_rate(&carbon_monoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputMovementVehicleODMC.Carbon_monoxide_rate
        ```

### Nox_rate {#nox_rate}

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputMovementVehicleODMC.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputMovementVehicleODMC->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputMovementVehicleODMC.Nox_rate
        ```

### Green_periods {#green_periods}

```csharp
int Green_periods { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int green_periods = outputMovementVehicleODMC.Green_periods;
        ```

    === "C++"

        ```cpp
        long green_periods;
        outputMovementVehicleODMC->get_Green_periods(&green_periods);
        ```

    === "Python"

        ```python
        green_periods = outputMovementVehicleODMC.Green_periods
        ```

### Approach_negotiation_speed {#approach_negotiation_speed}

```csharp
float Approach_negotiation_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float approach_negotiation_speed = outputMovementVehicleODMC.Approach_negotiation_speed;
        ```

    === "C++"

        ```cpp
        double approach_negotiation_speed;
        outputMovementVehicleODMC->get_Approach_negotiation_speed(&approach_negotiation_speed);
        ```

    === "Python"

        ```python
        approach_negotiation_speed = outputMovementVehicleODMC.Approach_negotiation_speed
        ```

### Exit_negotiation_speed {#exit_negotiation_speed}

```csharp
float Exit_negotiation_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_negotiation_speed = outputMovementVehicleODMC.Exit_negotiation_speed;
        ```

    === "C++"

        ```cpp
        double exit_negotiation_speed;
        outputMovementVehicleODMC->get_Exit_negotiation_speed(&exit_negotiation_speed);
        ```

    === "Python"

        ```python
        exit_negotiation_speed = outputMovementVehicleODMC.Exit_negotiation_speed
        ```

### Exit_cruise_speed {#exit_cruise_speed}

```csharp
float Exit_cruise_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float exit_cruise_speed = outputMovementVehicleODMC.Exit_cruise_speed;
        ```

    === "C++"

        ```cpp
        double exit_cruise_speed;
        outputMovementVehicleODMC->get_Exit_cruise_speed(&exit_cruise_speed);
        ```

    === "Python"

        ```python
        exit_cruise_speed = outputMovementVehicleODMC.Exit_cruise_speed
        ```

### Has_highangle_slip {#has_highangle_slip}

```csharp
bool Has_highangle_slip { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_highangle_slip = outputMovementVehicleODMC.Has_highangle_slip;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_highangle_slip;
        outputMovementVehicleODMC->get_Has_highangle_slip(&has_highangle_slip);
        ```

    === "Python"

        ```python
        has_highangle_slip = outputMovementVehicleODMC.Has_highangle_slip
        ```

### Has_lowangle_slip {#has_lowangle_slip}

```csharp
bool Has_lowangle_slip { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_lowangle_slip = outputMovementVehicleODMC.Has_lowangle_slip;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_lowangle_slip;
        outputMovementVehicleODMC->get_Has_lowangle_slip(&has_lowangle_slip);
        ```

    === "Python"

        ```python
        has_lowangle_slip = outputMovementVehicleODMC.Has_lowangle_slip
        ```

### Has_signals_control {#has_signals_control}

```csharp
bool Has_signals_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_signals_control = outputMovementVehicleODMC.Has_signals_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_signals_control;
        outputMovementVehicleODMC->get_Has_signals_control(&has_signals_control);
        ```

    === "Python"

        ```python
        has_signals_control = outputMovementVehicleODMC.Has_signals_control
        ```

### Has_stop_control {#has_stop_control}

```csharp
bool Has_stop_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_stop_control = outputMovementVehicleODMC.Has_stop_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_stop_control;
        outputMovementVehicleODMC->get_Has_stop_control(&has_stop_control);
        ```

    === "Python"

        ```python
        has_stop_control = outputMovementVehicleODMC.Has_stop_control
        ```

### Has_giveway_control {#has_giveway_control}

```csharp
bool Has_giveway_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_giveway_control = outputMovementVehicleODMC.Has_giveway_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_giveway_control;
        outputMovementVehicleODMC->get_Has_giveway_control(&has_giveway_control);
        ```

    === "Python"

        ```python
        has_giveway_control = outputMovementVehicleODMC.Has_giveway_control
        ```

### Has_continuous_control {#has_continuous_control}

```csharp
bool Has_continuous_control { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_continuous_control = outputMovementVehicleODMC.Has_continuous_control;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_continuous_control;
        outputMovementVehicleODMC->get_Has_continuous_control(&has_continuous_control);
        ```

    === "Python"

        ```python
        has_continuous_control = outputMovementVehicleODMC.Has_continuous_control
        ```

### Effective_control {#effective_control}

```csharp
int Effective_control { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int effective_control = outputMovementVehicleODMC.Effective_control;
        ```

    === "C++"

        ```cpp
        long effective_control;
        outputMovementVehicleODMC->get_Effective_control(&effective_control);
        ```

    === "Python"

        ```python
        effective_control = outputMovementVehicleODMC.Effective_control
        ```

### OutputMovementVehicleODMC_GreenPeriods {#outputmovementvehicleodmc_greenperiods}

```csharp
ISIAPIOutputMovementVehicleODMC_GreenPeriods OutputMovementVehicleODMC_GreenPeriods { get; }
```

**Type** [`ISIAPIOutputMovementVehicleODMC_GreenPeriods`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementVehicleODMC_GreenPeriods = outputMovementVehicleODMC.OutputMovementVehicleODMC_GreenPeriods;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleODMC_GreenPeriods> outputMovementVehicleODMC_GreenPeriods;
        outputMovementVehicleODMC->get_OutputMovementVehicleODMC_GreenPeriods(&outputMovementVehicleODMC_GreenPeriods);
        ```

    === "Python"

        ```python
        output_movement_vehicle_odmc__green_periods = outputMovementVehicleODMC.OutputMovementVehicleODMC_GreenPeriods
        ```

### OutputMovementVehicleOD {#outputmovementvehicleod}

```csharp
ISIAPIOutputMovementVehicleOD OutputMovementVehicleOD { get; }
```

**Type** [`ISIAPIOutputMovementVehicleOD`](sidrasolutions.si.api.isiapioutputmovementvehicleod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementVehicleOD = outputMovementVehicleODMC.OutputMovementVehicleOD;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleOD> outputMovementVehicleOD;
        outputMovementVehicleODMC->get_OutputMovementVehicleOD(&outputMovementVehicleOD);
        ```

    === "Python"

        ```python
        output_movement_vehicle_od = outputMovementVehicleODMC.OutputMovementVehicleOD
        ```

### Calc_exists {#calc_exists}

```csharp
bool Calc_exists { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool calc_exists = outputMovementVehicleODMC.Calc_exists;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL calc_exists;
        outputMovementVehicleODMC->get_Calc_exists(&calc_exists);
        ```

    === "Python"

        ```python
        calc_exists = outputMovementVehicleODMC.Calc_exists
        ```

### Travel_distance_stopline_total {#travel_distance_stopline_total}

```csharp
float Travel_distance_stopline_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_stopline_total = outputMovementVehicleODMC.Travel_distance_stopline_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_stopline_total;
        outputMovementVehicleODMC->get_Travel_distance_stopline_total(&travel_distance_stopline_total);
        ```

    === "Python"

        ```python
        travel_distance_stopline_total = outputMovementVehicleODMC.Travel_distance_stopline_total
        ```

### Travel_distance_stopline_average {#travel_distance_stopline_average}

```csharp
float Travel_distance_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_stopline_average = outputMovementVehicleODMC.Travel_distance_stopline_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_stopline_average;
        outputMovementVehicleODMC->get_Travel_distance_stopline_average(&travel_distance_stopline_average);
        ```

    === "Python"

        ```python
        travel_distance_stopline_average = outputMovementVehicleODMC.Travel_distance_stopline_average
        ```

### Travel_time_stopline_total {#travel_time_stopline_total}

```csharp
float Travel_time_stopline_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_stopline_total = outputMovementVehicleODMC.Travel_time_stopline_total;
        ```

    === "C++"

        ```cpp
        double travel_time_stopline_total;
        outputMovementVehicleODMC->get_Travel_time_stopline_total(&travel_time_stopline_total);
        ```

    === "Python"

        ```python
        travel_time_stopline_total = outputMovementVehicleODMC.Travel_time_stopline_total
        ```

### Travel_time_stopline_average {#travel_time_stopline_average}

```csharp
float Travel_time_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_stopline_average = outputMovementVehicleODMC.Travel_time_stopline_average;
        ```

    === "C++"

        ```cpp
        double travel_time_stopline_average;
        outputMovementVehicleODMC->get_Travel_time_stopline_average(&travel_time_stopline_average);
        ```

    === "Python"

        ```python
        travel_time_stopline_average = outputMovementVehicleODMC.Travel_time_stopline_average
        ```

### Negotiation_distance {#negotiation_distance}

```csharp
float Negotiation_distance { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float negotiation_distance = outputMovementVehicleODMC.Negotiation_distance;
        ```

    === "C++"

        ```cpp
        double negotiation_distance;
        outputMovementVehicleODMC->get_Negotiation_distance(&negotiation_distance);
        ```

    === "Python"

        ```python
        negotiation_distance = outputMovementVehicleODMC.Negotiation_distance
        ```

### Perc_arriving_during_green {#perc_arriving_during_green}

```csharp
float Perc_arriving_during_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float perc_arriving_during_green = outputMovementVehicleODMC.Perc_arriving_during_green;
        ```

    === "C++"

        ```cpp
        double perc_arriving_during_green;
        outputMovementVehicleODMC->get_Perc_arriving_during_green(&perc_arriving_during_green);
        ```

    === "Python"

        ```python
        perc_arriving_during_green = outputMovementVehicleODMC.Perc_arriving_during_green
        ```

### Green_time_ratio {#green_time_ratio}

```csharp
float Green_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_time_ratio = outputMovementVehicleODMC.Green_time_ratio;
        ```

    === "C++"

        ```cpp
        double green_time_ratio;
        outputMovementVehicleODMC->get_Green_time_ratio(&green_time_ratio);
        ```

    === "Python"

        ```python
        green_time_ratio = outputMovementVehicleODMC.Green_time_ratio
        ```

### Platoon_ratio {#platoon_ratio}

```csharp
float Platoon_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float platoon_ratio = outputMovementVehicleODMC.Platoon_ratio;
        ```

    === "C++"

        ```cpp
        double platoon_ratio;
        outputMovementVehicleODMC->get_Platoon_ratio(&platoon_ratio);
        ```

    === "Python"

        ```python
        platoon_ratio = outputMovementVehicleODMC.Platoon_ratio
        ```

### Equivalent_AT {#equivalent_at}

```csharp
int Equivalent_AT { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int equivalent_AT = outputMovementVehicleODMC.Equivalent_AT;
        ```

    === "C++"

        ```cpp
        long equivalent_AT;
        outputMovementVehicleODMC->get_Equivalent_AT(&equivalent_AT);
        ```

    === "Python"

        ```python
        equivalent_at = outputMovementVehicleODMC.Equivalent_AT
        ```

### Signal_coordination {#signal_coordination}

```csharp
int Signal_coordination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int signal_coordination = outputMovementVehicleODMC.Signal_coordination;
        ```

    === "C++"

        ```cpp
        long signal_coordination;
        outputMovementVehicleODMC->get_Signal_coordination(&signal_coordination);
        ```

    === "Python"

        ```python
        signal_coordination = outputMovementVehicleODMC.Signal_coordination
        ```

### Non_actuated {#non_actuated}

```csharp
bool Non_actuated { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool non_actuated = outputMovementVehicleODMC.Non_actuated;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL non_actuated;
        outputMovementVehicleODMC->get_Non_actuated(&non_actuated);
        ```

    === "Python"

        ```python
        non_actuated = outputMovementVehicleODMC.Non_actuated
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputMovementVehicleODMC.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputMovementVehicleODMC->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputMovementVehicleODMC.SpeedEfficiency
        ```

### Arrival_flow_flag {#arrival_flow_flag}

```csharp
int Arrival_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int arrival_flow_flag = outputMovementVehicleODMC.Arrival_flow_flag;
        ```

    === "C++"

        ```cpp
        long arrival_flow_flag;
        outputMovementVehicleODMC->get_Arrival_flow_flag(&arrival_flow_flag);
        ```

    === "Python"

        ```python
        arrival_flow_flag = outputMovementVehicleODMC.Arrival_flow_flag
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

```csharp
float Practical_degree_of_saturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = outputMovementVehicleODMC.Practical_degree_of_saturation;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        outputMovementVehicleODMC->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = outputMovementVehicleODMC.Practical_degree_of_saturation
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputMovementVehicleODMC.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputMovementVehicleODMC->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputMovementVehicleODMC.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputMovementVehicleODMC.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputMovementVehicleODMC->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputMovementVehicleODMC.Queue_greenstart_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputMovementVehicleODMC.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputMovementVehicleODMC->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputMovementVehicleODMC.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputMovementVehicleODMC.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputMovementVehicleODMC->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputMovementVehicleODMC.Queue_dist_greenstart_percentile
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputMovementVehicleODMC.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputMovementVehicleODMC->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputMovementVehicleODMC.Avg_num_of_cycles_to_depart
        ```

### Initial_demand_vol {#initial_demand_vol}

```csharp
float Initial_demand_vol { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float initial_demand_vol = outputMovementVehicleODMC.Initial_demand_vol;
        ```

    === "C++"

        ```cpp
        double initial_demand_vol;
        outputMovementVehicleODMC->get_Initial_demand_vol(&initial_demand_vol);
        ```

    === "Python"

        ```python
        initial_demand_vol = outputMovementVehicleODMC.Initial_demand_vol
        ```

### Residual_demand_vol {#residual_demand_vol}

```csharp
float Residual_demand_vol { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float residual_demand_vol = outputMovementVehicleODMC.Residual_demand_vol;
        ```

    === "C++"

        ```cpp
        double residual_demand_vol;
        outputMovementVehicleODMC->get_Residual_demand_vol(&residual_demand_vol);
        ```

    === "Python"

        ```python
        residual_demand_vol = outputMovementVehicleODMC.Residual_demand_vol
        ```

### Residual_demand_vol_clear_time {#residual_demand_vol_clear_time}

```csharp
float Residual_demand_vol_clear_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float residual_demand_vol_clear_time = outputMovementVehicleODMC.Residual_demand_vol_clear_time;
        ```

    === "C++"

        ```cpp
        double residual_demand_vol_clear_time;
        outputMovementVehicleODMC->get_Residual_demand_vol_clear_time(&residual_demand_vol_clear_time);
        ```

    === "Python"

        ```python
        residual_demand_vol_clear_time = outputMovementVehicleODMC.Residual_demand_vol_clear_time
        ```

### Oversatn_duration {#oversatn_duration}

```csharp
float Oversatn_duration { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float oversatn_duration = outputMovementVehicleODMC.Oversatn_duration;
        ```

    === "C++"

        ```cpp
        double oversatn_duration;
        outputMovementVehicleODMC->get_Oversatn_duration(&oversatn_duration);
        ```

    === "Python"

        ```python
        oversatn_duration = outputMovementVehicleODMC.Oversatn_duration
        ```

### Unblocked_time_ratio {#unblocked_time_ratio}

```csharp
float Unblocked_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unblocked_time_ratio = outputMovementVehicleODMC.Unblocked_time_ratio;
        ```

    === "C++"

        ```cpp
        double unblocked_time_ratio;
        outputMovementVehicleODMC->get_Unblocked_time_ratio(&unblocked_time_ratio);
        ```

    === "Python"

        ```python
        unblocked_time_ratio = outputMovementVehicleODMC.Unblocked_time_ratio
        ```

### Gap_accept_cycle_time {#gap_accept_cycle_time}

```csharp
float Gap_accept_cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_cycle_time = outputMovementVehicleODMC.Gap_accept_cycle_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_cycle_time;
        outputMovementVehicleODMC->get_Gap_accept_cycle_time(&gap_accept_cycle_time);
        ```

    === "Python"

        ```python
        gap_accept_cycle_time = outputMovementVehicleODMC.Gap_accept_cycle_time
        ```

### Gap_accept_blocked_time {#gap_accept_blocked_time}

```csharp
float Gap_accept_blocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_blocked_time = outputMovementVehicleODMC.Gap_accept_blocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_blocked_time;
        outputMovementVehicleODMC->get_Gap_accept_blocked_time(&gap_accept_blocked_time);
        ```

    === "Python"

        ```python
        gap_accept_blocked_time = outputMovementVehicleODMC.Gap_accept_blocked_time
        ```

### Gap_accept_unblocked_time {#gap_accept_unblocked_time}

```csharp
float Gap_accept_unblocked_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float gap_accept_unblocked_time = outputMovementVehicleODMC.Gap_accept_unblocked_time;
        ```

    === "C++"

        ```cpp
        double gap_accept_unblocked_time;
        outputMovementVehicleODMC->get_Gap_accept_unblocked_time(&gap_accept_unblocked_time);
        ```

    === "Python"

        ```python
        gap_accept_unblocked_time = outputMovementVehicleODMC.Gap_accept_unblocked_time
        ```

### Minimum_delay {#minimum_delay}

```csharp
float Minimum_delay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_delay = outputMovementVehicleODMC.Minimum_delay;
        ```

    === "C++"

        ```cpp
        double minimum_delay;
        outputMovementVehicleODMC->get_Minimum_delay(&minimum_delay);
        ```

    === "Python"

        ```python
        minimum_delay = outputMovementVehicleODMC.Minimum_delay
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputMovementVehicleODMC.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputMovementVehicleODMC->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputMovementVehicleODMC.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputMovementVehicleODMC.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputMovementVehicleODMC->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputMovementVehicleODMC.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputMovementVehicleODMC.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputMovementVehicleODMC->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputMovementVehicleODMC.TravelTimeIndex
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputMovementVehicleODMC.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputMovementVehicleODMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputMovementVehicleODMC.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputMovementVehicleODMC.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputMovementVehicleODMC->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputMovementVehicleODMC.DesiredSpeed
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputMovementVehicleODMC.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputMovementVehicleODMC->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputMovementVehicleODMC.DesiredSpeedProgram
        ```

### Flow_capconstr_no_initial {#flow_capconstr_no_initial}

```csharp
float Flow_capconstr_no_initial { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_capconstr_no_initial = outputMovementVehicleODMC.Flow_capconstr_no_initial;
        ```

    === "C++"

        ```cpp
        double flow_capconstr_no_initial;
        outputMovementVehicleODMC->get_Flow_capconstr_no_initial(&flow_capconstr_no_initial);
        ```

    === "Python"

        ```python
        flow_capconstr_no_initial = outputMovementVehicleODMC.Flow_capconstr_no_initial
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputMovementVehicleODMC.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputMovementVehicleODMC->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputMovementVehicleODMC.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputMovementVehicleODMC.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputMovementVehicleODMC->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputMovementVehicleODMC.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputMovementVehicleODMC.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputMovementVehicleODMC->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputMovementVehicleODMC.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputMovementVehicleODMC.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputMovementVehicleODMC->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputMovementVehicleODMC.Time_cost_rate
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleODMC_GreenPeriod
title: OutputMovementVehicleODMC_GreenPeriod
name: ISIAPIOutputMovementVehicleODMC_GreenPeriod
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 9EB8C8F7-7D9C-44A1-939A-4B2CA246B82A
members:
  - int Greenperiod
  - int Start_phase
  - int End_phase
  - bool Opposed
  - bool Priority
  - bool Undetected
  - float Start_loss
  - float End_gain
  - float End_loss
  - float Eff_start_time
  - float Eff_end_time
  - float Lost_time
  - float Reqd_time
  - float Eff_green
  - float Adjusted_lost_time
  - float Adjusted_flow_ratio
  - float Reqd_green_time_ratio
  - float Satn_flow
  - float Flow_ratio
  - bool Critical_mov
  - float Queue_move_up_speed
  - int Timing_data_type
  - float Tmin
  - float Tmax
  - float Displayed_start_time
  - float Displayed_end_time
  - int Min_max_flag
  - bool No_arrival
  - bool Coord_mov_runs
  - float Displayed_green_time
  - int Satn_flow_flag
  - float Unadj_reqd_time
  - float Adjusted_lost_time_noact
  - float Min_green_noact
  - float Start_intergrn_noact
  - float Start_intergrn
  - float Prob_veh_arrival
  - int Prob_veh_arrival_flag
  - float Tmin_noact
  - bool Red_arrow_drop_off_applied
  - float Red_arrow_drop_off
  - float Practical_degree_of_saturation
  - bool Early_cutoff_applied
  - float Early_cutoff
  - bool Late_start_applied
  - float Late_start
  - bool Turn_on_red
---

# OutputMovementVehicleODMC_GreenPeriod

Type `ISIAPIOutputMovementVehicleODMC_GreenPeriod` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `9EB8C8F7-7D9C-44A1-939A-4B2CA246B82A`

## Declaration

```csharp
[Guid("9EB8C8F7-7D9C-44A1-939A-4B2CA246B82A")]
public interface ISIAPIOutputMovementVehicleODMC_GreenPeriod
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Greenperiod](#greenperiod) | `int` | Green Period value is a one-based integer. |
| [Start_phase](#start_phase) | `int` |  |
| [End_phase](#end_phase) | `int` |  |
| [Opposed](#opposed) | `bool` |  |
| [Priority](#priority) | `bool` |  |
| [Undetected](#undetected) | `bool` |  |
| [Start_loss](#start_loss) | `float` |  |
| [End_gain](#end_gain) | `float` |  |
| [End_loss](#end_loss) | `float` |  |
| [Eff_start_time](#eff_start_time) | `float` |  |
| [Eff_end_time](#eff_end_time) | `float` |  |
| [Lost_time](#lost_time) | `float` |  |
| [Reqd_time](#reqd_time) | `float` |  |
| [Eff_green](#eff_green) | `float` |  |
| [Adjusted_lost_time](#adjusted_lost_time) | `float` |  |
| [Adjusted_flow_ratio](#adjusted_flow_ratio) | `float` |  |
| [Reqd_green_time_ratio](#reqd_green_time_ratio) | `float` |  |
| [Satn_flow](#satn_flow) | `float` |  |
| [Flow_ratio](#flow_ratio) | `float` |  |
| [Critical_mov](#critical_mov) | `bool` |  |
| [Queue_move_up_speed](#queue_move_up_speed) | `float` |  |
| [Timing_data_type](#timing_data_type) | `int` |  |
| [Tmin](#tmin) | `float` |  |
| [Tmax](#tmax) | `float` |  |
| [Displayed_start_time](#displayed_start_time) | `float` |  |
| [Displayed_end_time](#displayed_end_time) | `float` |  |
| [Min_max_flag](#min_max_flag) | `int` |  |
| [No_arrival](#no_arrival) | `bool` |  |
| [Coord_mov_runs](#coord_mov_runs) | `bool` |  |
| [Displayed_green_time](#displayed_green_time) | `float` |  |
| [Satn_flow_flag](#satn_flow_flag) | `int` |  |
| [Unadj_reqd_time](#unadj_reqd_time) | `float` |  |
| [Adjusted_lost_time_noact](#adjusted_lost_time_noact) | `float` |  |
| [Min_green_noact](#min_green_noact) | `float` |  |
| [Start_intergrn_noact](#start_intergrn_noact) | `float` |  |
| [Start_intergrn](#start_intergrn) | `float` |  |
| [Prob_veh_arrival](#prob_veh_arrival) | `float` |  |
| [Prob_veh_arrival_flag](#prob_veh_arrival_flag) | `int` |  |
| [Tmin_noact](#tmin_noact) | `float` |  |
| [Red_arrow_drop_off_applied](#red_arrow_drop_off_applied) | `bool` |  |
| [Red_arrow_drop_off](#red_arrow_drop_off) | `float` |  |
| [Practical_degree_of_saturation](#practical_degree_of_saturation) | `float` |  |
| [Early_cutoff_applied](#early_cutoff_applied) | `bool` |  |
| [Early_cutoff](#early_cutoff) | `float` |  |
| [Late_start_applied](#late_start_applied) | `bool` |  |
| [Late_start](#late_start) | `float` |  |
| [Turn_on_red](#turn_on_red) | `bool` |  |

</div>

## Properties

### Greenperiod {#greenperiod}

Green Period value is a one-based integer.

```csharp
int Greenperiod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int greenperiod = outputMovementVehicleODMC_GreenPeriod.Greenperiod;
        ```

    === "C++"

        ```cpp
        long greenperiod;
        outputMovementVehicleODMC_GreenPeriod->get_Greenperiod(&greenperiod);
        ```

    === "Python"

        ```python
        greenperiod = outputMovementVehicleODMC_GreenPeriod.Greenperiod
        ```

### Start_phase {#start_phase}

```csharp
int Start_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int start_phase = outputMovementVehicleODMC_GreenPeriod.Start_phase;
        ```

    === "C++"

        ```cpp
        long start_phase;
        outputMovementVehicleODMC_GreenPeriod->get_Start_phase(&start_phase);
        ```

    === "Python"

        ```python
        start_phase = outputMovementVehicleODMC_GreenPeriod.Start_phase
        ```

### End_phase {#end_phase}

```csharp
int End_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int end_phase = outputMovementVehicleODMC_GreenPeriod.End_phase;
        ```

    === "C++"

        ```cpp
        long end_phase;
        outputMovementVehicleODMC_GreenPeriod->get_End_phase(&end_phase);
        ```

    === "Python"

        ```python
        end_phase = outputMovementVehicleODMC_GreenPeriod.End_phase
        ```

### Opposed {#opposed}

```csharp
bool Opposed { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool opposed = outputMovementVehicleODMC_GreenPeriod.Opposed;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL opposed;
        outputMovementVehicleODMC_GreenPeriod->get_Opposed(&opposed);
        ```

    === "Python"

        ```python
        opposed = outputMovementVehicleODMC_GreenPeriod.Opposed
        ```

### Priority {#priority}

```csharp
bool Priority { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool priority = outputMovementVehicleODMC_GreenPeriod.Priority;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL priority;
        outputMovementVehicleODMC_GreenPeriod->get_Priority(&priority);
        ```

    === "Python"

        ```python
        priority = outputMovementVehicleODMC_GreenPeriod.Priority
        ```

### Undetected {#undetected}

```csharp
bool Undetected { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool undetected = outputMovementVehicleODMC_GreenPeriod.Undetected;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL undetected;
        outputMovementVehicleODMC_GreenPeriod->get_Undetected(&undetected);
        ```

    === "Python"

        ```python
        undetected = outputMovementVehicleODMC_GreenPeriod.Undetected
        ```

### Start_loss {#start_loss}

```csharp
float Start_loss { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_loss = outputMovementVehicleODMC_GreenPeriod.Start_loss;
        ```

    === "C++"

        ```cpp
        double start_loss;
        outputMovementVehicleODMC_GreenPeriod->get_Start_loss(&start_loss);
        ```

    === "Python"

        ```python
        start_loss = outputMovementVehicleODMC_GreenPeriod.Start_loss
        ```

### End_gain {#end_gain}

```csharp
float End_gain { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_gain = outputMovementVehicleODMC_GreenPeriod.End_gain;
        ```

    === "C++"

        ```cpp
        double end_gain;
        outputMovementVehicleODMC_GreenPeriod->get_End_gain(&end_gain);
        ```

    === "Python"

        ```python
        end_gain = outputMovementVehicleODMC_GreenPeriod.End_gain
        ```

### End_loss {#end_loss}

```csharp
float End_loss { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float end_loss = outputMovementVehicleODMC_GreenPeriod.End_loss;
        ```

    === "C++"

        ```cpp
        double end_loss;
        outputMovementVehicleODMC_GreenPeriod->get_End_loss(&end_loss);
        ```

    === "Python"

        ```python
        end_loss = outputMovementVehicleODMC_GreenPeriod.End_loss
        ```

### Eff_start_time {#eff_start_time}

```csharp
float Eff_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_start_time = outputMovementVehicleODMC_GreenPeriod.Eff_start_time;
        ```

    === "C++"

        ```cpp
        double eff_start_time;
        outputMovementVehicleODMC_GreenPeriod->get_Eff_start_time(&eff_start_time);
        ```

    === "Python"

        ```python
        eff_start_time = outputMovementVehicleODMC_GreenPeriod.Eff_start_time
        ```

### Eff_end_time {#eff_end_time}

```csharp
float Eff_end_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_end_time = outputMovementVehicleODMC_GreenPeriod.Eff_end_time;
        ```

    === "C++"

        ```cpp
        double eff_end_time;
        outputMovementVehicleODMC_GreenPeriod->get_Eff_end_time(&eff_end_time);
        ```

    === "Python"

        ```python
        eff_end_time = outputMovementVehicleODMC_GreenPeriod.Eff_end_time
        ```

### Lost_time {#lost_time}

```csharp
float Lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lost_time = outputMovementVehicleODMC_GreenPeriod.Lost_time;
        ```

    === "C++"

        ```cpp
        double lost_time;
        outputMovementVehicleODMC_GreenPeriod->get_Lost_time(&lost_time);
        ```

    === "Python"

        ```python
        lost_time = outputMovementVehicleODMC_GreenPeriod.Lost_time
        ```

### Reqd_time {#reqd_time}

```csharp
float Reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_time = outputMovementVehicleODMC_GreenPeriod.Reqd_time;
        ```

    === "C++"

        ```cpp
        double reqd_time;
        outputMovementVehicleODMC_GreenPeriod->get_Reqd_time(&reqd_time);
        ```

    === "Python"

        ```python
        reqd_time = outputMovementVehicleODMC_GreenPeriod.Reqd_time
        ```

### Eff_green {#eff_green}

```csharp
float Eff_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_green = outputMovementVehicleODMC_GreenPeriod.Eff_green;
        ```

    === "C++"

        ```cpp
        double eff_green;
        outputMovementVehicleODMC_GreenPeriod->get_Eff_green(&eff_green);
        ```

    === "Python"

        ```python
        eff_green = outputMovementVehicleODMC_GreenPeriod.Eff_green
        ```

### Adjusted_lost_time {#adjusted_lost_time}

```csharp
float Adjusted_lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_lost_time = outputMovementVehicleODMC_GreenPeriod.Adjusted_lost_time;
        ```

    === "C++"

        ```cpp
        double adjusted_lost_time;
        outputMovementVehicleODMC_GreenPeriod->get_Adjusted_lost_time(&adjusted_lost_time);
        ```

    === "Python"

        ```python
        adjusted_lost_time = outputMovementVehicleODMC_GreenPeriod.Adjusted_lost_time
        ```

### Adjusted_flow_ratio {#adjusted_flow_ratio}

```csharp
float Adjusted_flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_flow_ratio = outputMovementVehicleODMC_GreenPeriod.Adjusted_flow_ratio;
        ```

    === "C++"

        ```cpp
        double adjusted_flow_ratio;
        outputMovementVehicleODMC_GreenPeriod->get_Adjusted_flow_ratio(&adjusted_flow_ratio);
        ```

    === "Python"

        ```python
        adjusted_flow_ratio = outputMovementVehicleODMC_GreenPeriod.Adjusted_flow_ratio
        ```

### Reqd_green_time_ratio {#reqd_green_time_ratio}

```csharp
float Reqd_green_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_green_time_ratio = outputMovementVehicleODMC_GreenPeriod.Reqd_green_time_ratio;
        ```

    === "C++"

        ```cpp
        double reqd_green_time_ratio;
        outputMovementVehicleODMC_GreenPeriod->get_Reqd_green_time_ratio(&reqd_green_time_ratio);
        ```

    === "Python"

        ```python
        reqd_green_time_ratio = outputMovementVehicleODMC_GreenPeriod.Reqd_green_time_ratio
        ```

### Satn_flow {#satn_flow}

```csharp
float Satn_flow { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float satn_flow = outputMovementVehicleODMC_GreenPeriod.Satn_flow;
        ```

    === "C++"

        ```cpp
        double satn_flow;
        outputMovementVehicleODMC_GreenPeriod->get_Satn_flow(&satn_flow);
        ```

    === "Python"

        ```python
        satn_flow = outputMovementVehicleODMC_GreenPeriod.Satn_flow
        ```

### Flow_ratio {#flow_ratio}

```csharp
float Flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_ratio = outputMovementVehicleODMC_GreenPeriod.Flow_ratio;
        ```

    === "C++"

        ```cpp
        double flow_ratio;
        outputMovementVehicleODMC_GreenPeriod->get_Flow_ratio(&flow_ratio);
        ```

    === "Python"

        ```python
        flow_ratio = outputMovementVehicleODMC_GreenPeriod.Flow_ratio
        ```

### Critical_mov {#critical_mov}

```csharp
bool Critical_mov { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool critical_mov = outputMovementVehicleODMC_GreenPeriod.Critical_mov;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL critical_mov;
        outputMovementVehicleODMC_GreenPeriod->get_Critical_mov(&critical_mov);
        ```

    === "Python"

        ```python
        critical_mov = outputMovementVehicleODMC_GreenPeriod.Critical_mov
        ```

### Queue_move_up_speed {#queue_move_up_speed}

```csharp
float Queue_move_up_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_move_up_speed = outputMovementVehicleODMC_GreenPeriod.Queue_move_up_speed;
        ```

    === "C++"

        ```cpp
        double queue_move_up_speed;
        outputMovementVehicleODMC_GreenPeriod->get_Queue_move_up_speed(&queue_move_up_speed);
        ```

    === "Python"

        ```python
        queue_move_up_speed = outputMovementVehicleODMC_GreenPeriod.Queue_move_up_speed
        ```

### Timing_data_type {#timing_data_type}

```csharp
int Timing_data_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int timing_data_type = outputMovementVehicleODMC_GreenPeriod.Timing_data_type;
        ```

    === "C++"

        ```cpp
        long timing_data_type;
        outputMovementVehicleODMC_GreenPeriod->get_Timing_data_type(&timing_data_type);
        ```

    === "Python"

        ```python
        timing_data_type = outputMovementVehicleODMC_GreenPeriod.Timing_data_type
        ```

### Tmin {#tmin}

```csharp
float Tmin { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmin = outputMovementVehicleODMC_GreenPeriod.Tmin;
        ```

    === "C++"

        ```cpp
        double tmin;
        outputMovementVehicleODMC_GreenPeriod->get_Tmin(&tmin);
        ```

    === "Python"

        ```python
        tmin = outputMovementVehicleODMC_GreenPeriod.Tmin
        ```

### Tmax {#tmax}

```csharp
float Tmax { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmax = outputMovementVehicleODMC_GreenPeriod.Tmax;
        ```

    === "C++"

        ```cpp
        double tmax;
        outputMovementVehicleODMC_GreenPeriod->get_Tmax(&tmax);
        ```

    === "Python"

        ```python
        tmax = outputMovementVehicleODMC_GreenPeriod.Tmax
        ```

### Displayed_start_time {#displayed_start_time}

```csharp
float Displayed_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_start_time = outputMovementVehicleODMC_GreenPeriod.Displayed_start_time;
        ```

    === "C++"

        ```cpp
        double displayed_start_time;
        outputMovementVehicleODMC_GreenPeriod->get_Displayed_start_time(&displayed_start_time);
        ```

    === "Python"

        ```python
        displayed_start_time = outputMovementVehicleODMC_GreenPeriod.Displayed_start_time
        ```

### Displayed_end_time {#displayed_end_time}

```csharp
float Displayed_end_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_end_time = outputMovementVehicleODMC_GreenPeriod.Displayed_end_time;
        ```

    === "C++"

        ```cpp
        double displayed_end_time;
        outputMovementVehicleODMC_GreenPeriod->get_Displayed_end_time(&displayed_end_time);
        ```

    === "Python"

        ```python
        displayed_end_time = outputMovementVehicleODMC_GreenPeriod.Displayed_end_time
        ```

### Min_max_flag {#min_max_flag}

```csharp
int Min_max_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int min_max_flag = outputMovementVehicleODMC_GreenPeriod.Min_max_flag;
        ```

    === "C++"

        ```cpp
        long min_max_flag;
        outputMovementVehicleODMC_GreenPeriod->get_Min_max_flag(&min_max_flag);
        ```

    === "Python"

        ```python
        min_max_flag = outputMovementVehicleODMC_GreenPeriod.Min_max_flag
        ```

### No_arrival {#no_arrival}

```csharp
bool No_arrival { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool no_arrival = outputMovementVehicleODMC_GreenPeriod.No_arrival;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL no_arrival;
        outputMovementVehicleODMC_GreenPeriod->get_No_arrival(&no_arrival);
        ```

    === "Python"

        ```python
        no_arrival = outputMovementVehicleODMC_GreenPeriod.No_arrival
        ```

### Coord_mov_runs {#coord_mov_runs}

```csharp
bool Coord_mov_runs { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool coord_mov_runs = outputMovementVehicleODMC_GreenPeriod.Coord_mov_runs;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL coord_mov_runs;
        outputMovementVehicleODMC_GreenPeriod->get_Coord_mov_runs(&coord_mov_runs);
        ```

    === "Python"

        ```python
        coord_mov_runs = outputMovementVehicleODMC_GreenPeriod.Coord_mov_runs
        ```

### Displayed_green_time {#displayed_green_time}

```csharp
float Displayed_green_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_green_time = outputMovementVehicleODMC_GreenPeriod.Displayed_green_time;
        ```

    === "C++"

        ```cpp
        double displayed_green_time;
        outputMovementVehicleODMC_GreenPeriod->get_Displayed_green_time(&displayed_green_time);
        ```

    === "Python"

        ```python
        displayed_green_time = outputMovementVehicleODMC_GreenPeriod.Displayed_green_time
        ```

### Satn_flow_flag {#satn_flow_flag}

```csharp
int Satn_flow_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int satn_flow_flag = outputMovementVehicleODMC_GreenPeriod.Satn_flow_flag;
        ```

    === "C++"

        ```cpp
        long satn_flow_flag;
        outputMovementVehicleODMC_GreenPeriod->get_Satn_flow_flag(&satn_flow_flag);
        ```

    === "Python"

        ```python
        satn_flow_flag = outputMovementVehicleODMC_GreenPeriod.Satn_flow_flag
        ```

### Unadj_reqd_time {#unadj_reqd_time}

```csharp
float Unadj_reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float unadj_reqd_time = outputMovementVehicleODMC_GreenPeriod.Unadj_reqd_time;
        ```

    === "C++"

        ```cpp
        double unadj_reqd_time;
        outputMovementVehicleODMC_GreenPeriod->get_Unadj_reqd_time(&unadj_reqd_time);
        ```

    === "Python"

        ```python
        unadj_reqd_time = outputMovementVehicleODMC_GreenPeriod.Unadj_reqd_time
        ```

### Adjusted_lost_time_noact {#adjusted_lost_time_noact}

```csharp
float Adjusted_lost_time_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_lost_time_noact = outputMovementVehicleODMC_GreenPeriod.Adjusted_lost_time_noact;
        ```

    === "C++"

        ```cpp
        double adjusted_lost_time_noact;
        outputMovementVehicleODMC_GreenPeriod->get_Adjusted_lost_time_noact(&adjusted_lost_time_noact);
        ```

    === "Python"

        ```python
        adjusted_lost_time_noact = outputMovementVehicleODMC_GreenPeriod.Adjusted_lost_time_noact
        ```

### Min_green_noact {#min_green_noact}

```csharp
float Min_green_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_green_noact = outputMovementVehicleODMC_GreenPeriod.Min_green_noact;
        ```

    === "C++"

        ```cpp
        double min_green_noact;
        outputMovementVehicleODMC_GreenPeriod->get_Min_green_noact(&min_green_noact);
        ```

    === "Python"

        ```python
        min_green_noact = outputMovementVehicleODMC_GreenPeriod.Min_green_noact
        ```

### Start_intergrn_noact {#start_intergrn_noact}

```csharp
float Start_intergrn_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_intergrn_noact = outputMovementVehicleODMC_GreenPeriod.Start_intergrn_noact;
        ```

    === "C++"

        ```cpp
        double start_intergrn_noact;
        outputMovementVehicleODMC_GreenPeriod->get_Start_intergrn_noact(&start_intergrn_noact);
        ```

    === "Python"

        ```python
        start_intergrn_noact = outputMovementVehicleODMC_GreenPeriod.Start_intergrn_noact
        ```

### Start_intergrn {#start_intergrn}

```csharp
float Start_intergrn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_intergrn = outputMovementVehicleODMC_GreenPeriod.Start_intergrn;
        ```

    === "C++"

        ```cpp
        double start_intergrn;
        outputMovementVehicleODMC_GreenPeriod->get_Start_intergrn(&start_intergrn);
        ```

    === "Python"

        ```python
        start_intergrn = outputMovementVehicleODMC_GreenPeriod.Start_intergrn
        ```

### Prob_veh_arrival {#prob_veh_arrival}

```csharp
float Prob_veh_arrival { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prob_veh_arrival = outputMovementVehicleODMC_GreenPeriod.Prob_veh_arrival;
        ```

    === "C++"

        ```cpp
        double prob_veh_arrival;
        outputMovementVehicleODMC_GreenPeriod->get_Prob_veh_arrival(&prob_veh_arrival);
        ```

    === "Python"

        ```python
        prob_veh_arrival = outputMovementVehicleODMC_GreenPeriod.Prob_veh_arrival
        ```

### Prob_veh_arrival_flag {#prob_veh_arrival_flag}

```csharp
int Prob_veh_arrival_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int prob_veh_arrival_flag = outputMovementVehicleODMC_GreenPeriod.Prob_veh_arrival_flag;
        ```

    === "C++"

        ```cpp
        long prob_veh_arrival_flag;
        outputMovementVehicleODMC_GreenPeriod->get_Prob_veh_arrival_flag(&prob_veh_arrival_flag);
        ```

    === "Python"

        ```python
        prob_veh_arrival_flag = outputMovementVehicleODMC_GreenPeriod.Prob_veh_arrival_flag
        ```

### Tmin_noact {#tmin_noact}

```csharp
float Tmin_noact { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float tmin_noact = outputMovementVehicleODMC_GreenPeriod.Tmin_noact;
        ```

    === "C++"

        ```cpp
        double tmin_noact;
        outputMovementVehicleODMC_GreenPeriod->get_Tmin_noact(&tmin_noact);
        ```

    === "Python"

        ```python
        tmin_noact = outputMovementVehicleODMC_GreenPeriod.Tmin_noact
        ```

### Red_arrow_drop_off_applied {#red_arrow_drop_off_applied}

```csharp
bool Red_arrow_drop_off_applied { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool red_arrow_drop_off_applied = outputMovementVehicleODMC_GreenPeriod.Red_arrow_drop_off_applied;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL red_arrow_drop_off_applied;
        outputMovementVehicleODMC_GreenPeriod->get_Red_arrow_drop_off_applied(&red_arrow_drop_off_applied);
        ```

    === "Python"

        ```python
        red_arrow_drop_off_applied = outputMovementVehicleODMC_GreenPeriod.Red_arrow_drop_off_applied
        ```

### Red_arrow_drop_off {#red_arrow_drop_off}

```csharp
float Red_arrow_drop_off { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float red_arrow_drop_off = outputMovementVehicleODMC_GreenPeriod.Red_arrow_drop_off;
        ```

    === "C++"

        ```cpp
        double red_arrow_drop_off;
        outputMovementVehicleODMC_GreenPeriod->get_Red_arrow_drop_off(&red_arrow_drop_off);
        ```

    === "Python"

        ```python
        red_arrow_drop_off = outputMovementVehicleODMC_GreenPeriod.Red_arrow_drop_off
        ```

### Practical_degree_of_saturation {#practical_degree_of_saturation}

```csharp
float Practical_degree_of_saturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_degree_of_saturation = outputMovementVehicleODMC_GreenPeriod.Practical_degree_of_saturation;
        ```

    === "C++"

        ```cpp
        double practical_degree_of_saturation;
        outputMovementVehicleODMC_GreenPeriod->get_Practical_degree_of_saturation(&practical_degree_of_saturation);
        ```

    === "Python"

        ```python
        practical_degree_of_saturation = outputMovementVehicleODMC_GreenPeriod.Practical_degree_of_saturation
        ```

### Early_cutoff_applied {#early_cutoff_applied}

```csharp
bool Early_cutoff_applied { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool early_cutoff_applied = outputMovementVehicleODMC_GreenPeriod.Early_cutoff_applied;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL early_cutoff_applied;
        outputMovementVehicleODMC_GreenPeriod->get_Early_cutoff_applied(&early_cutoff_applied);
        ```

    === "Python"

        ```python
        early_cutoff_applied = outputMovementVehicleODMC_GreenPeriod.Early_cutoff_applied
        ```

### Early_cutoff {#early_cutoff}

```csharp
float Early_cutoff { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float early_cutoff = outputMovementVehicleODMC_GreenPeriod.Early_cutoff;
        ```

    === "C++"

        ```cpp
        double early_cutoff;
        outputMovementVehicleODMC_GreenPeriod->get_Early_cutoff(&early_cutoff);
        ```

    === "Python"

        ```python
        early_cutoff = outputMovementVehicleODMC_GreenPeriod.Early_cutoff
        ```

### Late_start_applied {#late_start_applied}

```csharp
bool Late_start_applied { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool late_start_applied = outputMovementVehicleODMC_GreenPeriod.Late_start_applied;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL late_start_applied;
        outputMovementVehicleODMC_GreenPeriod->get_Late_start_applied(&late_start_applied);
        ```

    === "Python"

        ```python
        late_start_applied = outputMovementVehicleODMC_GreenPeriod.Late_start_applied
        ```

### Late_start {#late_start}

```csharp
float Late_start { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float late_start = outputMovementVehicleODMC_GreenPeriod.Late_start;
        ```

    === "C++"

        ```cpp
        double late_start;
        outputMovementVehicleODMC_GreenPeriod->get_Late_start(&late_start);
        ```

    === "Python"

        ```python
        late_start = outputMovementVehicleODMC_GreenPeriod.Late_start
        ```

### Turn_on_red {#turn_on_red}

```csharp
bool Turn_on_red { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool turn_on_red = outputMovementVehicleODMC_GreenPeriod.Turn_on_red;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL turn_on_red;
        outputMovementVehicleODMC_GreenPeriod->get_Turn_on_red(&turn_on_red);
        ```

    === "Python"

        ```python
        turn_on_red = outputMovementVehicleODMC_GreenPeriod.Turn_on_red
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleODMC_GreenPeriods
title: OutputMovementVehicleODMC_GreenPeriods
name: ISIAPIOutputMovementVehicleODMC_GreenPeriods
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: C1798ED6-DD63-490E-8989-CF99E112BF9E
members:
  - bool GreenPeriodExists(int greenperiod)
  - ISIAPIOutputMovementVehicleODMC_GreenPeriod this[int greenperiod]
  - int Count
---

# OutputMovementVehicleODMC_GreenPeriods

Type `ISIAPIOutputMovementVehicleODMC_GreenPeriods` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `C1798ED6-DD63-490E-8989-CF99E112BF9E`

## Declaration

```csharp
[Guid("C1798ED6-DD63-490E-8989-CF99E112BF9E")]
public interface ISIAPIOutputMovementVehicleODMC_GreenPeriods
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementVehicleODMC_GreenPeriod`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiod.md) | Get a Vehicle Movement Output Green Period Data Object. Return a Vehicle Movement Output Green Period Data Object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [GreenPeriodExists(int)](#greenperiodexists-int) | `bool` | Get a value indicating whether a Vehicle Movement Output Green Period Data Object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementVehicleODMC_GreenPeriods.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementVehicleODMC_GreenPeriods->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementVehicleODMC_GreenPeriods.Count
        ```

### this[] {#this}

Get a Vehicle Movement Output Green Period Data Object.  
Return a Vehicle Movement Output Green Period Data Object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputMovementVehicleODMC_GreenPeriod this[] { get; }
```

**Type** [`ISIAPIOutputMovementVehicleODMC_GreenPeriod`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc_greenperiod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementVehicleODMC_GreenPeriods.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleODMC_GreenPeriod> this[];
        outputMovementVehicleODMC_GreenPeriods->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementVehicleODMC_GreenPeriods.this[]
        ```

## Methods

### GreenPeriodExists(int) {#greenperiodexists-int}

Get a value indicating whether a Vehicle Movement Output Green Period Data Object exists in the data storage.

```csharp
bool GreenPeriodExists(int greenperiod)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `greenperiod` | `int` | A one-based integer. |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementVehicleODMC_GreenPeriods.GreenPeriodExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementVehicleODMC_GreenPeriods->GreenPeriodExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementVehicleODMC_GreenPeriods.GreenPeriodExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleodmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleODMCs
title: OutputMovementVehicleODMCs
name: ISIAPIOutputMovementVehicleODMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 7F4A871D-285F-4729-A290-2ED5992F3167
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputMovementVehicleODMC this[int mcClass]
  - int Count
---

# OutputMovementVehicleODMCs

Type `ISIAPIOutputMovementVehicleODMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `7F4A871D-285F-4729-A290-2ED5992F3167`

## Declaration

```csharp
[Guid("7F4A871D-285F-4729-A290-2ED5992F3167")]
public interface ISIAPIOutputMovementVehicleODMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementVehicleODMC`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementVehicleODMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementVehicleODMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementVehicleODMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputMovementVehicleODMC this[] { get; }
```

**Type** [`ISIAPIOutputMovementVehicleODMC`](sidrasolutions.si.api.isiapioutputmovementvehicleodmc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementVehicleODMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleODMC> this[];
        outputMovementVehicleODMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementVehicleODMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementVehicleODMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementVehicleODMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementVehicleODMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmovementvehicleods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMovementVehicleODs
title: OutputMovementVehicleODs
name: ISIAPIOutputMovementVehicleODs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 05D1C1BE-A4EF-4BBD-BC20-530374B6A6F2
members:
  - bool MovementExists(int origin, int destination)
  - ISIAPIOutputMovementVehicleOD this[int origin, int destination]
  - int Count
---

# OutputMovementVehicleODs

Type `ISIAPIOutputMovementVehicleODs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `05D1C1BE-A4EF-4BBD-BC20-530374B6A6F2`

## Declaration

```csharp
[Guid("05D1C1BE-A4EF-4BBD-BC20-530374B6A6F2")]
public interface ISIAPIOutputMovementVehicleODs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMovementVehicleOD`](sidrasolutions.si.api.isiapioutputmovementvehicleod.md) | Get a Vehicle Movement Output Data Object. Return a Vehicle Movement Output Data Object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int)](#movementexists-int--int) | `bool` | Get a value indicating whether a Vehicle Movement Output Data Object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMovementVehicleODs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMovementVehicleODs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMovementVehicleODs.Count
        ```

### this[] {#this}

Get a Vehicle Movement Output Data Object.  
Return a Vehicle Movement Output Data Object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPIOutputMovementVehicleOD this[] { get; }
```

**Type** [`ISIAPIOutputMovementVehicleOD`](sidrasolutions.si.api.isiapioutputmovementvehicleod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMovementVehicleODs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleOD> this[];
        outputMovementVehicleODs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMovementVehicleODs.this[]
        ```

## Methods

### MovementExists(int, int) {#movementexists-int--int}

Get a value indicating whether a Vehicle Movement Output Data Object exists in the data storage.

```csharp
bool MovementExists(int origin, int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `destination` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputMovementVehicleODs.MovementExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputMovementVehicleODs->MovementExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = outputMovementVehicleODs.MovementExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmultisequenceanalyses.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMultiSequenceAnalyses
title: OutputMultiSequenceAnalyses
name: ISIAPIOutputMultiSequenceAnalyses
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2C745E45-78C8-4384-83FB-FBF0EA5F392D
members:
  - ISIAPIOutputMultiSequenceAnalysis this[int index]
  - int Count
---

# OutputMultiSequenceAnalyses

Type `ISIAPIOutputMultiSequenceAnalyses` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2C745E45-78C8-4384-83FB-FBF0EA5F392D`

## Declaration

```csharp
[Guid("2C745E45-78C8-4384-83FB-FBF0EA5F392D")]
public interface ISIAPIOutputMultiSequenceAnalyses
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputMultiSequenceAnalysis`](sidrasolutions.si.api.isiapioutputmultisequenceanalysis.md) | Get an item at the specified index. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputMultiSequenceAnalyses.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputMultiSequenceAnalyses->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputMultiSequenceAnalyses.Count
        ```

### this[] {#this}

Get an item at the specified index.

```csharp
ISIAPIOutputMultiSequenceAnalysis this[] { get; }
```

**Type** [`ISIAPIOutputMultiSequenceAnalysis`](sidrasolutions.si.api.isiapioutputmultisequenceanalysis.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputMultiSequenceAnalyses.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMultiSequenceAnalysis> this[];
        outputMultiSequenceAnalyses->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputMultiSequenceAnalyses.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputmultisequenceanalysis.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputMultiSequenceAnalysis
title: OutputMultiSequenceAnalysis
name: ISIAPIOutputMultiSequenceAnalysis
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 71EA2CF5-7F13-42E3-BB75-FE7BF8B75D10
members:
  - int Seq_position
  - float Cycle_time
  - float Deg_satn
  - float Capacity_effective
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Stop_rate
  - float Queue_maxback_percentile
  - float Queue_dist_maxback_percentile
  - float Performance_index
  - float Operating_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Carbon_monoxide_total
  - float Hydrocarbons_total
  - float Nox_total
  - float SpeedEfficiency
  - float Travel_speed
  - ISIAPIOutputset Outputset
---

# OutputMultiSequenceAnalysis

Type `ISIAPIOutputMultiSequenceAnalysis` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `71EA2CF5-7F13-42E3-BB75-FE7BF8B75D10`

## Declaration

```csharp
[Guid("71EA2CF5-7F13-42E3-BB75-FE7BF8B75D10")]
public interface ISIAPIOutputMultiSequenceAnalysis
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Seq_position](#seq_position) | `int` | The corresponding Sequence Input data position in the collection, i.e. ISIAPISequence.Position or ISIAPINetworkCCGSequence.Position |
| [Cycle_time](#cycle_time) | `float` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |

</div>

## Properties

### Seq_position {#seq_position}

The corresponding Sequence Input data position in the collection, i.e. ISIAPISequence.Position or ISIAPINetworkCCGSequence.Position

```csharp
int Seq_position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int seq_position = outputMultiSequenceAnalysis.Seq_position;
        ```

    === "C++"

        ```cpp
        long seq_position;
        outputMultiSequenceAnalysis->get_Seq_position(&seq_position);
        ```

    === "Python"

        ```python
        seq_position = outputMultiSequenceAnalysis.Seq_position
        ```

### Cycle_time {#cycle_time}

```csharp
float Cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time = outputMultiSequenceAnalysis.Cycle_time;
        ```

    === "C++"

        ```cpp
        double cycle_time;
        outputMultiSequenceAnalysis->get_Cycle_time(&cycle_time);
        ```

    === "Python"

        ```python
        cycle_time = outputMultiSequenceAnalysis.Cycle_time
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputMultiSequenceAnalysis.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputMultiSequenceAnalysis->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputMultiSequenceAnalysis.Deg_satn
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputMultiSequenceAnalysis.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputMultiSequenceAnalysis->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputMultiSequenceAnalysis.Capacity_effective
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputMultiSequenceAnalysis.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputMultiSequenceAnalysis->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputMultiSequenceAnalysis.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputMultiSequenceAnalysis.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputMultiSequenceAnalysis->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputMultiSequenceAnalysis.Delay_control_average
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputMultiSequenceAnalysis.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputMultiSequenceAnalysis->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputMultiSequenceAnalysis.Stop_rate
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputMultiSequenceAnalysis.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputMultiSequenceAnalysis->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputMultiSequenceAnalysis.Queue_maxback_percentile
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputMultiSequenceAnalysis.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputMultiSequenceAnalysis->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputMultiSequenceAnalysis.Queue_dist_maxback_percentile
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputMultiSequenceAnalysis.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputMultiSequenceAnalysis->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputMultiSequenceAnalysis.Performance_index
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputMultiSequenceAnalysis.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputMultiSequenceAnalysis->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputMultiSequenceAnalysis.Operating_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputMultiSequenceAnalysis.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputMultiSequenceAnalysis->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputMultiSequenceAnalysis.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputMultiSequenceAnalysis.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputMultiSequenceAnalysis->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputMultiSequenceAnalysis.Carbon_dioxide_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputMultiSequenceAnalysis.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputMultiSequenceAnalysis->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputMultiSequenceAnalysis.Carbon_monoxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputMultiSequenceAnalysis.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputMultiSequenceAnalysis->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputMultiSequenceAnalysis.Hydrocarbons_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputMultiSequenceAnalysis.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputMultiSequenceAnalysis->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputMultiSequenceAnalysis.Nox_total
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputMultiSequenceAnalysis.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputMultiSequenceAnalysis->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputMultiSequenceAnalysis.SpeedEfficiency
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputMultiSequenceAnalysis.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputMultiSequenceAnalysis->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputMultiSequenceAnalysis.Travel_speed
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputMultiSequenceAnalysis.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputMultiSequenceAnalysis->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputMultiSequenceAnalysis.Outputset
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetwork.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetwork
title: OutputNetwork
name: ISIAPIOutputNetwork
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: ADA253F7-3B57-4801-AB60-D8B4474D7662
members:
  - ISIAPINetwork Network
  - DateTime GeneratedTime
  - int IterationsCount
  - ISIAPIOutputNetworkVehicle OutputNetworkVehicle
  - ISIAPIOutputNetworkPedestrian OutputNetworkPedestrian
  - ISIAPIOutputNetworkPerson OutputNetworkPerson
  - string GeneratedByVersion
  - float NetworkCycleTime
  - int NetworkSummaryType
  - ISIAPIRoute Route
  - int Analysis_method_flag
  - int Analysis_method
  - int Analysis_status
  - int Selected_future_year
  - float Largest_movement_flow_scale
  - float Selected_parameter_scale
  - int Single_ccg
  - int Cycle_time_option
  - ISIAPIOutputNetworkGraphTuples OutputNetworkGraphTuples
  - ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle
  - ISIAPIOutputRouteMovementBasedPerson OutputRouteMovementBasedPerson
  - int TwoLoops_TotalInnerIterations
  - bool Is_settled
  - bool Is_minPSC_regenerated
  - float MinPSC
  - int MinPSC_iteration
---

# OutputNetwork

Type `ISIAPIOutputNetwork` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `ADA253F7-3B57-4801-AB60-D8B4474D7662`

## Declaration

```csharp
[Guid("ADA253F7-3B57-4801-AB60-D8B4474D7662")]
public interface ISIAPIOutputNetwork
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [GeneratedTime](#generatedtime) | `DateTime` |  |
| [IterationsCount](#iterationscount) | `int` | The number of iterations that have been run to get this network output result |
| [OutputNetworkVehicle](#outputnetworkvehicle) | [`ISIAPIOutputNetworkVehicle`](sidrasolutions.si.api.isiapioutputnetworkvehicle.md) |  |
| [OutputNetworkPedestrian](#outputnetworkpedestrian) | [`ISIAPIOutputNetworkPedestrian`](sidrasolutions.si.api.isiapioutputnetworkpedestrian.md) |  |
| [OutputNetworkPerson](#outputnetworkperson) | [`ISIAPIOutputNetworkPerson`](sidrasolutions.si.api.isiapioutputnetworkperson.md) |  |
| [GeneratedByVersion](#generatedbyversion) | `string` |  |
| [NetworkCycleTime](#networkcycletime) | `float` |  |
| [NetworkSummaryType](#networksummarytype) | `int` | Network Summary Type, the summary type of this SIAPIOutputNetwork. |
| [Route](#route) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) |  |
| [Analysis_method_flag](#analysis_method_flag) | `int` |  |
| [Analysis_method](#analysis_method) | `int` |  |
| [Analysis_status](#analysis_status) | `int` |  |
| [Selected_future_year](#selected_future_year) | `int` |  |
| [Largest_movement_flow_scale](#largest_movement_flow_scale) | `float` |  |
| [Selected_parameter_scale](#selected_parameter_scale) | `float` |  |
| [Single_ccg](#single_ccg) | `int` |  |
| [Cycle_time_option](#cycle_time_option) | `int` |  |
| [OutputNetworkGraphTuples](#outputnetworkgraphtuples) | [`ISIAPIOutputNetworkGraphTuples`](sidrasolutions.si.api.isiapioutputnetworkgraphtuples.md) |  |
| [OutputRouteMovementBasedVehicle](#outputroutemovementbasedvehicle) | [`ISIAPIOutputRouteMovementBasedVehicle`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md) |  |
| [OutputRouteMovementBasedPerson](#outputroutemovementbasedperson) | [`ISIAPIOutputRouteMovementBasedPerson`](sidrasolutions.si.api.isiapioutputroutemovementbasedperson.md) |  |
| [TwoLoops_TotalInnerIterations](#twoloops_totalinneriterations) | `int` | The total number of Inner Loop Iterations that have been performed when the Network is processed using the Two-Loop Convergence Method. |
| [Is_settled](#is_settled) | `bool` | Flag indicating if the Iterations settle. |
| [Is_minPSC_regenerated](#is_minpsc_regenerated) | `bool` | Flag indicating if the result of the Outer Loop Iteration with the Minimum Percentage Stopping Condition is regenerated when the Two-Loop Convergence Method is applied. |
| [MinPSC](#minpsc) | `float` | Minimum Percentage Stopping Condition found in the Two-Loop Convergence Method when the iterations do not settle. When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0. |
| [MinPSC_iteration](#minpsc_iteration) | `int` | The Iteration Number of the Outer Loop Iteration with the Minimum Percentage Stopping Condition when the Two-Loop Convergence Method iterations settle. When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0. |

</div>

## Properties

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = outputNetwork.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        outputNetwork->get_Network(&network);
        ```

    === "Python"

        ```python
        network = outputNetwork.Network
        ```

### GeneratedTime {#generatedtime}

```csharp
DateTime GeneratedTime { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var generatedTime = outputNetwork.GeneratedTime;
        ```

    === "C++"

        ```cpp
        VARIANT generatedTime;
        outputNetwork->get_GeneratedTime(&generatedTime);
        ```

    === "Python"

        ```python
        generated_time = outputNetwork.GeneratedTime
        ```

### IterationsCount {#iterationscount}

The number of iterations that have been run to get this network output result

```csharp
int IterationsCount { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int iterationsCount = outputNetwork.IterationsCount;
        ```

    === "C++"

        ```cpp
        long iterationsCount;
        outputNetwork->get_IterationsCount(&iterationsCount);
        ```

    === "Python"

        ```python
        iterations_count = outputNetwork.IterationsCount
        ```

### OutputNetworkVehicle {#outputnetworkvehicle}

```csharp
ISIAPIOutputNetworkVehicle OutputNetworkVehicle { get; }
```

**Type** [`ISIAPIOutputNetworkVehicle`](sidrasolutions.si.api.isiapioutputnetworkvehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkVehicle = outputNetwork.OutputNetworkVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkVehicle> outputNetworkVehicle;
        outputNetwork->get_OutputNetworkVehicle(&outputNetworkVehicle);
        ```

    === "Python"

        ```python
        output_network_vehicle = outputNetwork.OutputNetworkVehicle
        ```

### OutputNetworkPedestrian {#outputnetworkpedestrian}

```csharp
ISIAPIOutputNetworkPedestrian OutputNetworkPedestrian { get; }
```

**Type** [`ISIAPIOutputNetworkPedestrian`](sidrasolutions.si.api.isiapioutputnetworkpedestrian.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkPedestrian = outputNetwork.OutputNetworkPedestrian;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkPedestrian> outputNetworkPedestrian;
        outputNetwork->get_OutputNetworkPedestrian(&outputNetworkPedestrian);
        ```

    === "Python"

        ```python
        output_network_pedestrian = outputNetwork.OutputNetworkPedestrian
        ```

### OutputNetworkPerson {#outputnetworkperson}

```csharp
ISIAPIOutputNetworkPerson OutputNetworkPerson { get; }
```

**Type** [`ISIAPIOutputNetworkPerson`](sidrasolutions.si.api.isiapioutputnetworkperson.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkPerson = outputNetwork.OutputNetworkPerson;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkPerson> outputNetworkPerson;
        outputNetwork->get_OutputNetworkPerson(&outputNetworkPerson);
        ```

    === "Python"

        ```python
        output_network_person = outputNetwork.OutputNetworkPerson
        ```

### GeneratedByVersion {#generatedbyversion}

```csharp
string GeneratedByVersion { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string generatedByVersion = outputNetwork.GeneratedByVersion;
        ```

    === "C++"

        ```cpp
        CComBSTR generatedByVersion;
        outputNetwork->get_GeneratedByVersion(&generatedByVersion);
        ```

    === "Python"

        ```python
        generated_by_version = outputNetwork.GeneratedByVersion
        ```

### NetworkCycleTime {#networkcycletime}

```csharp
float NetworkCycleTime { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float networkCycleTime = outputNetwork.NetworkCycleTime;
        ```

    === "C++"

        ```cpp
        double networkCycleTime;
        outputNetwork->get_NetworkCycleTime(&networkCycleTime);
        ```

    === "Python"

        ```python
        network_cycle_time = outputNetwork.NetworkCycleTime
        ```

### NetworkSummaryType {#networksummarytype}

Network Summary Type, the summary type of this SIAPIOutputNetwork.

```csharp
int NetworkSummaryType { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Whole Network
- `2` - Summary for selected Routes
- `3` - Summary for a particular Route

???- example "Code samples"

    === "C#"

        ```csharp
        int networkSummaryType = outputNetwork.NetworkSummaryType;
        ```

    === "C++"

        ```cpp
        long networkSummaryType;
        outputNetwork->get_NetworkSummaryType(&networkSummaryType);
        ```

    === "Python"

        ```python
        network_summary_type = outputNetwork.NetworkSummaryType
        ```

### Route {#route}

```csharp
ISIAPIRoute Route { get; }
```

**Type** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var route = outputNetwork.Route;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> route;
        outputNetwork->get_Route(&route);
        ```

    === "Python"

        ```python
        route = outputNetwork.Route
        ```

### Analysis_method_flag {#analysis_method_flag}

```csharp
int Analysis_method_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_method_flag = outputNetwork.Analysis_method_flag;
        ```

    === "C++"

        ```cpp
        long analysis_method_flag;
        outputNetwork->get_Analysis_method_flag(&analysis_method_flag);
        ```

    === "Python"

        ```python
        analysis_method_flag = outputNetwork.Analysis_method_flag
        ```

### Analysis_method {#analysis_method}

```csharp
int Analysis_method { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_method = outputNetwork.Analysis_method;
        ```

    === "C++"

        ```cpp
        long analysis_method;
        outputNetwork->get_Analysis_method(&analysis_method);
        ```

    === "Python"

        ```python
        analysis_method = outputNetwork.Analysis_method
        ```

### Analysis_status {#analysis_status}

```csharp
int Analysis_status { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_status = outputNetwork.Analysis_status;
        ```

    === "C++"

        ```cpp
        long analysis_status;
        outputNetwork->get_Analysis_status(&analysis_status);
        ```

    === "Python"

        ```python
        analysis_status = outputNetwork.Analysis_status
        ```

### Selected_future_year {#selected_future_year}

```csharp
int Selected_future_year { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int selected_future_year = outputNetwork.Selected_future_year;
        ```

    === "C++"

        ```cpp
        long selected_future_year;
        outputNetwork->get_Selected_future_year(&selected_future_year);
        ```

    === "Python"

        ```python
        selected_future_year = outputNetwork.Selected_future_year
        ```

### Largest_movement_flow_scale {#largest_movement_flow_scale}

```csharp
float Largest_movement_flow_scale { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float largest_movement_flow_scale = outputNetwork.Largest_movement_flow_scale;
        ```

    === "C++"

        ```cpp
        double largest_movement_flow_scale;
        outputNetwork->get_Largest_movement_flow_scale(&largest_movement_flow_scale);
        ```

    === "Python"

        ```python
        largest_movement_flow_scale = outputNetwork.Largest_movement_flow_scale
        ```

### Selected_parameter_scale {#selected_parameter_scale}

```csharp
float Selected_parameter_scale { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float selected_parameter_scale = outputNetwork.Selected_parameter_scale;
        ```

    === "C++"

        ```cpp
        double selected_parameter_scale;
        outputNetwork->get_Selected_parameter_scale(&selected_parameter_scale);
        ```

    === "Python"

        ```python
        selected_parameter_scale = outputNetwork.Selected_parameter_scale
        ```

### Single_ccg {#single_ccg}

```csharp
int Single_ccg { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int single_ccg = outputNetwork.Single_ccg;
        ```

    === "C++"

        ```cpp
        long single_ccg;
        outputNetwork->get_Single_ccg(&single_ccg);
        ```

    === "Python"

        ```python
        single_ccg = outputNetwork.Single_ccg
        ```

### Cycle_time_option {#cycle_time_option}

```csharp
int Cycle_time_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option = outputNetwork.Cycle_time_option;
        ```

    === "C++"

        ```cpp
        long cycle_time_option;
        outputNetwork->get_Cycle_time_option(&cycle_time_option);
        ```

    === "Python"

        ```python
        cycle_time_option = outputNetwork.Cycle_time_option
        ```

### OutputNetworkGraphTuples {#outputnetworkgraphtuples}

```csharp
ISIAPIOutputNetworkGraphTuples OutputNetworkGraphTuples { get; }
```

**Type** [`ISIAPIOutputNetworkGraphTuples`](sidrasolutions.si.api.isiapioutputnetworkgraphtuples.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkGraphTuples = outputNetwork.OutputNetworkGraphTuples;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkGraphTuples> outputNetworkGraphTuples;
        outputNetwork->get_OutputNetworkGraphTuples(&outputNetworkGraphTuples);
        ```

    === "Python"

        ```python
        output_network_graph_tuples = outputNetwork.OutputNetworkGraphTuples
        ```

### OutputRouteMovementBasedVehicle {#outputroutemovementbasedvehicle}

```csharp
ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle { get; }
```

**Type** [`ISIAPIOutputRouteMovementBasedVehicle`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputRouteMovementBasedVehicle = outputNetwork.OutputRouteMovementBasedVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputRouteMovementBasedVehicle> outputRouteMovementBasedVehicle;
        outputNetwork->get_OutputRouteMovementBasedVehicle(&outputRouteMovementBasedVehicle);
        ```

    === "Python"

        ```python
        output_route_movement_based_vehicle = outputNetwork.OutputRouteMovementBasedVehicle
        ```

### OutputRouteMovementBasedPerson {#outputroutemovementbasedperson}

```csharp
ISIAPIOutputRouteMovementBasedPerson OutputRouteMovementBasedPerson { get; }
```

**Type** [`ISIAPIOutputRouteMovementBasedPerson`](sidrasolutions.si.api.isiapioutputroutemovementbasedperson.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputRouteMovementBasedPerson = outputNetwork.OutputRouteMovementBasedPerson;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputRouteMovementBasedPerson> outputRouteMovementBasedPerson;
        outputNetwork->get_OutputRouteMovementBasedPerson(&outputRouteMovementBasedPerson);
        ```

    === "Python"

        ```python
        output_route_movement_based_person = outputNetwork.OutputRouteMovementBasedPerson
        ```

### TwoLoops_TotalInnerIterations {#twoloops_totalinneriterations}

The total number of Inner Loop Iterations that have been performed when the Network is processed using the Two-Loop Convergence Method.

```csharp
int TwoLoops_TotalInnerIterations { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int twoLoops_TotalInnerIterations = outputNetwork.TwoLoops_TotalInnerIterations;
        ```

    === "C++"

        ```cpp
        long twoLoops_TotalInnerIterations;
        outputNetwork->get_TwoLoops_TotalInnerIterations(&twoLoops_TotalInnerIterations);
        ```

    === "Python"

        ```python
        two_loops__total_inner_iterations = outputNetwork.TwoLoops_TotalInnerIterations
        ```

### Is_settled {#is_settled}

Flag indicating if the Iterations settle.

```csharp
bool Is_settled { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_settled = outputNetwork.Is_settled;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_settled;
        outputNetwork->get_Is_settled(&is_settled);
        ```

    === "Python"

        ```python
        is_settled = outputNetwork.Is_settled
        ```

### Is_minPSC_regenerated {#is_minpsc_regenerated}

Flag indicating if the result of the Outer Loop Iteration with the Minimum Percentage Stopping Condition is regenerated when the Two-Loop Convergence Method is applied.

```csharp
bool Is_minPSC_regenerated { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_minPSC_regenerated = outputNetwork.Is_minPSC_regenerated;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_minPSC_regenerated;
        outputNetwork->get_Is_minPSC_regenerated(&is_minPSC_regenerated);
        ```

    === "Python"

        ```python
        is_min_psc_regenerated = outputNetwork.Is_minPSC_regenerated
        ```

### MinPSC {#minpsc}

Minimum Percentage Stopping Condition found in the Two-Loop Convergence Method when the iterations do not settle. 

When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.

```csharp
float MinPSC { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minPSC = outputNetwork.MinPSC;
        ```

    === "C++"

        ```cpp
        double minPSC;
        outputNetwork->get_MinPSC(&minPSC);
        ```

    === "Python"

        ```python
        min_psc = outputNetwork.MinPSC
        ```

### MinPSC_iteration {#minpsc_iteration}

The Iteration Number of the Outer Loop Iteration with the Minimum Percentage Stopping Condition when the Two-Loop Convergence Method iterations settle. 

When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.

```csharp
int MinPSC_iteration { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int minPSC_iteration = outputNetwork.MinPSC_iteration;
        ```

    === "C++"

        ```cpp
        long minPSC_iteration;
        outputNetwork->get_MinPSC_iteration(&minPSC_iteration);
        ```

    === "Python"

        ```python
        min_psc_iteration = outputNetwork.MinPSC_iteration
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkgraphtuple.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkGraphTuple
title: OutputNetworkGraphTuple
name: ISIAPIOutputNetworkGraphTuple
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 16EB4227-E929-4471-B3C2-83F89F9EE5E8
members:
  - float X_value
  - float Arrival_flow_total
  - float Arrival_flow_total_person
  - float SpeedEfficiency
  - float Demand_flow_total
  - float Capacity_effective
  - float Deg_satn
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - int Level_of_service
  - float Stop_rate
  - float Queue_maxback_percentile
  - float Queue_dist_maxback_percentile
  - float Performance_index
  - float Travel_speed
  - float Cycle_time
  - float Fuel_consumption_total
  - float Hydrocarbons_total
  - float Nox_total
  - float Carbon_monoxide_total
  - float Carbon_dioxide_total
  - float Operating_cost_total
  - bool Unsettled
  - float Demand_flow_total_ped
  - float Demand_flow_total_person
  - float Perc_heavy_veh
  - float Deg_satn_ped
  - float Delay_control_total_veh
  - float Delay_control_total_ped
  - float Delay_control_total_person
  - float Delay_control_average_veh
  - float Delay_control_average_ped
  - float Delay_control_average_worstlane
  - float Delay_control_average_worstmov_ped
  - float Delay_control_average_worstmov_person
  - float Delay_geometric_average
  - float Delay_stopline_average
  - int Level_of_service_veh
  - int Level_of_service_ped
  - float Total_stops_veh
  - float Total_stops_ped
  - float Total_stops_person
  - float Stop_rate_veh
  - float Stop_rate_ped
  - float Prop_queued_veh
  - float Prop_queued_ped
  - float Prop_queued_person
  - float Performance_index_veh
  - float Performance_index_ped
  - float Travel_dist_total_veh
  - float Travel_dist_total_ped
  - float Travel_dist_total_person
  - float Travel_dist_av_veh
  - float Travel_dist_av_ped
  - float Travel_dist_av_person
  - float Travel_time_total_veh
  - float Travel_time_total_ped
  - float Travel_time_total_person
  - float Travel_time_av_veh
  - float Travel_time_av_ped
  - float Travel_time_av_person
  - float Travel_speed_ped
  - float Travel_speed_person
  - float Operating_cost_total_veh
  - float Operating_cost_total_ped
---

# OutputNetworkGraphTuple

Type `ISIAPIOutputNetworkGraphTuple` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `16EB4227-E929-4471-B3C2-83F89F9EE5E8`

## Declaration

```csharp
[Guid("16EB4227-E929-4471-B3C2-83F89F9EE5E8")]
public interface ISIAPIOutputNetworkGraphTuple
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [X_value](#x_value) | `float` |  |
| [Arrival_flow_total](#arrival_flow_total) | `float` |  |
| [Arrival_flow_total_person](#arrival_flow_total_person) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Demand_flow_total](#demand_flow_total) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Level_of_service](#level_of_service) | `int` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Cycle_time](#cycle_time) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Unsettled](#unsettled) | `bool` |  |
| [Demand_flow_total_ped](#demand_flow_total_ped) | `float` |  |
| [Demand_flow_total_person](#demand_flow_total_person) | `float` |  |
| [Perc_heavy_veh](#perc_heavy_veh) | `float` |  |
| [Deg_satn_ped](#deg_satn_ped) | `float` |  |
| [Delay_control_total_veh](#delay_control_total_veh) | `float` |  |
| [Delay_control_total_ped](#delay_control_total_ped) | `float` |  |
| [Delay_control_total_person](#delay_control_total_person) | `float` |  |
| [Delay_control_average_veh](#delay_control_average_veh) | `float` |  |
| [Delay_control_average_ped](#delay_control_average_ped) | `float` |  |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` |  |
| [Delay_control_average_worstmov_ped](#delay_control_average_worstmov_ped) | `float` |  |
| [Delay_control_average_worstmov_person](#delay_control_average_worstmov_person) | `float` |  |
| [Delay_geometric_average](#delay_geometric_average) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Level_of_service_veh](#level_of_service_veh) | `int` |  |
| [Level_of_service_ped](#level_of_service_ped) | `int` |  |
| [Total_stops_veh](#total_stops_veh) | `float` |  |
| [Total_stops_ped](#total_stops_ped) | `float` |  |
| [Total_stops_person](#total_stops_person) | `float` |  |
| [Stop_rate_veh](#stop_rate_veh) | `float` |  |
| [Stop_rate_ped](#stop_rate_ped) | `float` |  |
| [Prop_queued_veh](#prop_queued_veh) | `float` |  |
| [Prop_queued_ped](#prop_queued_ped) | `float` |  |
| [Prop_queued_person](#prop_queued_person) | `float` |  |
| [Performance_index_veh](#performance_index_veh) | `float` |  |
| [Performance_index_ped](#performance_index_ped) | `float` |  |
| [Travel_dist_total_veh](#travel_dist_total_veh) | `float` |  |
| [Travel_dist_total_ped](#travel_dist_total_ped) | `float` |  |
| [Travel_dist_total_person](#travel_dist_total_person) | `float` |  |
| [Travel_dist_av_veh](#travel_dist_av_veh) | `float` |  |
| [Travel_dist_av_ped](#travel_dist_av_ped) | `float` |  |
| [Travel_dist_av_person](#travel_dist_av_person) | `float` |  |
| [Travel_time_total_veh](#travel_time_total_veh) | `float` |  |
| [Travel_time_total_ped](#travel_time_total_ped) | `float` |  |
| [Travel_time_total_person](#travel_time_total_person) | `float` |  |
| [Travel_time_av_veh](#travel_time_av_veh) | `float` |  |
| [Travel_time_av_ped](#travel_time_av_ped) | `float` |  |
| [Travel_time_av_person](#travel_time_av_person) | `float` |  |
| [Travel_speed_ped](#travel_speed_ped) | `float` |  |
| [Travel_speed_person](#travel_speed_person) | `float` |  |
| [Operating_cost_total_veh](#operating_cost_total_veh) | `float` |  |
| [Operating_cost_total_ped](#operating_cost_total_ped) | `float` |  |

</div>

## Properties

### X_value {#x_value}

```csharp
float X_value { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float x_value = outputNetworkGraphTuple.X_value;
        ```

    === "C++"

        ```cpp
        double x_value;
        outputNetworkGraphTuple->get_X_value(&x_value);
        ```

    === "Python"

        ```python
        x_value = outputNetworkGraphTuple.X_value
        ```

### Arrival_flow_total {#arrival_flow_total}

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputNetworkGraphTuple.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputNetworkGraphTuple->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputNetworkGraphTuple.Arrival_flow_total
        ```

### Arrival_flow_total_person {#arrival_flow_total_person}

```csharp
float Arrival_flow_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total_person = outputNetworkGraphTuple.Arrival_flow_total_person;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total_person;
        outputNetworkGraphTuple->get_Arrival_flow_total_person(&arrival_flow_total_person);
        ```

    === "Python"

        ```python
        arrival_flow_total_person = outputNetworkGraphTuple.Arrival_flow_total_person
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputNetworkGraphTuple.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputNetworkGraphTuple->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputNetworkGraphTuple.SpeedEfficiency
        ```

### Demand_flow_total {#demand_flow_total}

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputNetworkGraphTuple.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputNetworkGraphTuple->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputNetworkGraphTuple.Demand_flow_total
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputNetworkGraphTuple.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputNetworkGraphTuple->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputNetworkGraphTuple.Capacity_effective
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputNetworkGraphTuple.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputNetworkGraphTuple->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputNetworkGraphTuple.Deg_satn
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputNetworkGraphTuple.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputNetworkGraphTuple->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputNetworkGraphTuple.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputNetworkGraphTuple.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputNetworkGraphTuple->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputNetworkGraphTuple.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputNetworkGraphTuple.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputNetworkGraphTuple->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputNetworkGraphTuple.Delay_control_average_worstmov
        ```

### Level_of_service {#level_of_service}

```csharp
int Level_of_service { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service = outputNetworkGraphTuple.Level_of_service;
        ```

    === "C++"

        ```cpp
        long level_of_service;
        outputNetworkGraphTuple->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputNetworkGraphTuple.Level_of_service
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputNetworkGraphTuple.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputNetworkGraphTuple->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputNetworkGraphTuple.Stop_rate
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputNetworkGraphTuple.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputNetworkGraphTuple->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputNetworkGraphTuple.Queue_maxback_percentile
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputNetworkGraphTuple.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputNetworkGraphTuple->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputNetworkGraphTuple.Queue_dist_maxback_percentile
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputNetworkGraphTuple.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputNetworkGraphTuple->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputNetworkGraphTuple.Performance_index
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputNetworkGraphTuple.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputNetworkGraphTuple->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputNetworkGraphTuple.Travel_speed
        ```

### Cycle_time {#cycle_time}

```csharp
float Cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time = outputNetworkGraphTuple.Cycle_time;
        ```

    === "C++"

        ```cpp
        double cycle_time;
        outputNetworkGraphTuple->get_Cycle_time(&cycle_time);
        ```

    === "Python"

        ```python
        cycle_time = outputNetworkGraphTuple.Cycle_time
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputNetworkGraphTuple.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputNetworkGraphTuple->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputNetworkGraphTuple.Fuel_consumption_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputNetworkGraphTuple.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputNetworkGraphTuple->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputNetworkGraphTuple.Hydrocarbons_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputNetworkGraphTuple.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputNetworkGraphTuple->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputNetworkGraphTuple.Nox_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputNetworkGraphTuple.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputNetworkGraphTuple->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputNetworkGraphTuple.Carbon_monoxide_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputNetworkGraphTuple.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputNetworkGraphTuple->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputNetworkGraphTuple.Carbon_dioxide_total
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputNetworkGraphTuple.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputNetworkGraphTuple->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputNetworkGraphTuple.Operating_cost_total
        ```

### Unsettled {#unsettled}

```csharp
bool Unsettled { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool unsettled = outputNetworkGraphTuple.Unsettled;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL unsettled;
        outputNetworkGraphTuple->get_Unsettled(&unsettled);
        ```

    === "Python"

        ```python
        unsettled = outputNetworkGraphTuple.Unsettled
        ```

### Demand_flow_total_ped {#demand_flow_total_ped}

```csharp
float Demand_flow_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total_ped = outputNetworkGraphTuple.Demand_flow_total_ped;
        ```

    === "C++"

        ```cpp
        double demand_flow_total_ped;
        outputNetworkGraphTuple->get_Demand_flow_total_ped(&demand_flow_total_ped);
        ```

    === "Python"

        ```python
        demand_flow_total_ped = outputNetworkGraphTuple.Demand_flow_total_ped
        ```

### Demand_flow_total_person {#demand_flow_total_person}

```csharp
float Demand_flow_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total_person = outputNetworkGraphTuple.Demand_flow_total_person;
        ```

    === "C++"

        ```cpp
        double demand_flow_total_person;
        outputNetworkGraphTuple->get_Demand_flow_total_person(&demand_flow_total_person);
        ```

    === "Python"

        ```python
        demand_flow_total_person = outputNetworkGraphTuple.Demand_flow_total_person
        ```

### Perc_heavy_veh {#perc_heavy_veh}

```csharp
float Perc_heavy_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float perc_heavy_veh = outputNetworkGraphTuple.Perc_heavy_veh;
        ```

    === "C++"

        ```cpp
        double perc_heavy_veh;
        outputNetworkGraphTuple->get_Perc_heavy_veh(&perc_heavy_veh);
        ```

    === "Python"

        ```python
        perc_heavy_veh = outputNetworkGraphTuple.Perc_heavy_veh
        ```

### Deg_satn_ped {#deg_satn_ped}

```csharp
float Deg_satn_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn_ped = outputNetworkGraphTuple.Deg_satn_ped;
        ```

    === "C++"

        ```cpp
        double deg_satn_ped;
        outputNetworkGraphTuple->get_Deg_satn_ped(&deg_satn_ped);
        ```

    === "Python"

        ```python
        deg_satn_ped = outputNetworkGraphTuple.Deg_satn_ped
        ```

### Delay_control_total_veh {#delay_control_total_veh}

```csharp
float Delay_control_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_veh = outputNetworkGraphTuple.Delay_control_total_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_total_veh;
        outputNetworkGraphTuple->get_Delay_control_total_veh(&delay_control_total_veh);
        ```

    === "Python"

        ```python
        delay_control_total_veh = outputNetworkGraphTuple.Delay_control_total_veh
        ```

### Delay_control_total_ped {#delay_control_total_ped}

```csharp
float Delay_control_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_ped = outputNetworkGraphTuple.Delay_control_total_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_total_ped;
        outputNetworkGraphTuple->get_Delay_control_total_ped(&delay_control_total_ped);
        ```

    === "Python"

        ```python
        delay_control_total_ped = outputNetworkGraphTuple.Delay_control_total_ped
        ```

### Delay_control_total_person {#delay_control_total_person}

```csharp
float Delay_control_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total_person = outputNetworkGraphTuple.Delay_control_total_person;
        ```

    === "C++"

        ```cpp
        double delay_control_total_person;
        outputNetworkGraphTuple->get_Delay_control_total_person(&delay_control_total_person);
        ```

    === "Python"

        ```python
        delay_control_total_person = outputNetworkGraphTuple.Delay_control_total_person
        ```

### Delay_control_average_veh {#delay_control_average_veh}

```csharp
float Delay_control_average_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_veh = outputNetworkGraphTuple.Delay_control_average_veh;
        ```

    === "C++"

        ```cpp
        double delay_control_average_veh;
        outputNetworkGraphTuple->get_Delay_control_average_veh(&delay_control_average_veh);
        ```

    === "Python"

        ```python
        delay_control_average_veh = outputNetworkGraphTuple.Delay_control_average_veh
        ```

### Delay_control_average_ped {#delay_control_average_ped}

```csharp
float Delay_control_average_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_ped = outputNetworkGraphTuple.Delay_control_average_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_average_ped;
        outputNetworkGraphTuple->get_Delay_control_average_ped(&delay_control_average_ped);
        ```

    === "Python"

        ```python
        delay_control_average_ped = outputNetworkGraphTuple.Delay_control_average_ped
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputNetworkGraphTuple.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputNetworkGraphTuple->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputNetworkGraphTuple.Delay_control_average_worstlane
        ```

### Delay_control_average_worstmov_ped {#delay_control_average_worstmov_ped}

```csharp
float Delay_control_average_worstmov_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov_ped = outputNetworkGraphTuple.Delay_control_average_worstmov_ped;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov_ped;
        outputNetworkGraphTuple->get_Delay_control_average_worstmov_ped(&delay_control_average_worstmov_ped);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov_ped = outputNetworkGraphTuple.Delay_control_average_worstmov_ped
        ```

### Delay_control_average_worstmov_person {#delay_control_average_worstmov_person}

```csharp
float Delay_control_average_worstmov_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov_person = outputNetworkGraphTuple.Delay_control_average_worstmov_person;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov_person;
        outputNetworkGraphTuple->get_Delay_control_average_worstmov_person(&delay_control_average_worstmov_person);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov_person = outputNetworkGraphTuple.Delay_control_average_worstmov_person
        ```

### Delay_geometric_average {#delay_geometric_average}

```csharp
float Delay_geometric_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric_average = outputNetworkGraphTuple.Delay_geometric_average;
        ```

    === "C++"

        ```cpp
        double delay_geometric_average;
        outputNetworkGraphTuple->get_Delay_geometric_average(&delay_geometric_average);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputNetworkGraphTuple.Delay_geometric_average
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputNetworkGraphTuple.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputNetworkGraphTuple->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputNetworkGraphTuple.Delay_stopline_average
        ```

### Level_of_service_veh {#level_of_service_veh}

```csharp
int Level_of_service_veh { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service_veh = outputNetworkGraphTuple.Level_of_service_veh;
        ```

    === "C++"

        ```cpp
        long level_of_service_veh;
        outputNetworkGraphTuple->get_Level_of_service_veh(&level_of_service_veh);
        ```

    === "Python"

        ```python
        level_of_service_veh = outputNetworkGraphTuple.Level_of_service_veh
        ```

### Level_of_service_ped {#level_of_service_ped}

```csharp
int Level_of_service_ped { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int level_of_service_ped = outputNetworkGraphTuple.Level_of_service_ped;
        ```

    === "C++"

        ```cpp
        long level_of_service_ped;
        outputNetworkGraphTuple->get_Level_of_service_ped(&level_of_service_ped);
        ```

    === "Python"

        ```python
        level_of_service_ped = outputNetworkGraphTuple.Level_of_service_ped
        ```

### Total_stops_veh {#total_stops_veh}

```csharp
float Total_stops_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_veh = outputNetworkGraphTuple.Total_stops_veh;
        ```

    === "C++"

        ```cpp
        double total_stops_veh;
        outputNetworkGraphTuple->get_Total_stops_veh(&total_stops_veh);
        ```

    === "Python"

        ```python
        total_stops_veh = outputNetworkGraphTuple.Total_stops_veh
        ```

### Total_stops_ped {#total_stops_ped}

```csharp
float Total_stops_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_ped = outputNetworkGraphTuple.Total_stops_ped;
        ```

    === "C++"

        ```cpp
        double total_stops_ped;
        outputNetworkGraphTuple->get_Total_stops_ped(&total_stops_ped);
        ```

    === "Python"

        ```python
        total_stops_ped = outputNetworkGraphTuple.Total_stops_ped
        ```

### Total_stops_person {#total_stops_person}

```csharp
float Total_stops_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_stops_person = outputNetworkGraphTuple.Total_stops_person;
        ```

    === "C++"

        ```cpp
        double total_stops_person;
        outputNetworkGraphTuple->get_Total_stops_person(&total_stops_person);
        ```

    === "Python"

        ```python
        total_stops_person = outputNetworkGraphTuple.Total_stops_person
        ```

### Stop_rate_veh {#stop_rate_veh}

```csharp
float Stop_rate_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate_veh = outputNetworkGraphTuple.Stop_rate_veh;
        ```

    === "C++"

        ```cpp
        double stop_rate_veh;
        outputNetworkGraphTuple->get_Stop_rate_veh(&stop_rate_veh);
        ```

    === "Python"

        ```python
        stop_rate_veh = outputNetworkGraphTuple.Stop_rate_veh
        ```

### Stop_rate_ped {#stop_rate_ped}

```csharp
float Stop_rate_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate_ped = outputNetworkGraphTuple.Stop_rate_ped;
        ```

    === "C++"

        ```cpp
        double stop_rate_ped;
        outputNetworkGraphTuple->get_Stop_rate_ped(&stop_rate_ped);
        ```

    === "Python"

        ```python
        stop_rate_ped = outputNetworkGraphTuple.Stop_rate_ped
        ```

### Prop_queued_veh {#prop_queued_veh}

```csharp
float Prop_queued_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_veh = outputNetworkGraphTuple.Prop_queued_veh;
        ```

    === "C++"

        ```cpp
        double prop_queued_veh;
        outputNetworkGraphTuple->get_Prop_queued_veh(&prop_queued_veh);
        ```

    === "Python"

        ```python
        prop_queued_veh = outputNetworkGraphTuple.Prop_queued_veh
        ```

### Prop_queued_ped {#prop_queued_ped}

```csharp
float Prop_queued_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_ped = outputNetworkGraphTuple.Prop_queued_ped;
        ```

    === "C++"

        ```cpp
        double prop_queued_ped;
        outputNetworkGraphTuple->get_Prop_queued_ped(&prop_queued_ped);
        ```

    === "Python"

        ```python
        prop_queued_ped = outputNetworkGraphTuple.Prop_queued_ped
        ```

### Prop_queued_person {#prop_queued_person}

```csharp
float Prop_queued_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float prop_queued_person = outputNetworkGraphTuple.Prop_queued_person;
        ```

    === "C++"

        ```cpp
        double prop_queued_person;
        outputNetworkGraphTuple->get_Prop_queued_person(&prop_queued_person);
        ```

    === "Python"

        ```python
        prop_queued_person = outputNetworkGraphTuple.Prop_queued_person
        ```

### Performance_index_veh {#performance_index_veh}

```csharp
float Performance_index_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index_veh = outputNetworkGraphTuple.Performance_index_veh;
        ```

    === "C++"

        ```cpp
        double performance_index_veh;
        outputNetworkGraphTuple->get_Performance_index_veh(&performance_index_veh);
        ```

    === "Python"

        ```python
        performance_index_veh = outputNetworkGraphTuple.Performance_index_veh
        ```

### Performance_index_ped {#performance_index_ped}

```csharp
float Performance_index_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index_ped = outputNetworkGraphTuple.Performance_index_ped;
        ```

    === "C++"

        ```cpp
        double performance_index_ped;
        outputNetworkGraphTuple->get_Performance_index_ped(&performance_index_ped);
        ```

    === "Python"

        ```python
        performance_index_ped = outputNetworkGraphTuple.Performance_index_ped
        ```

### Travel_dist_total_veh {#travel_dist_total_veh}

```csharp
float Travel_dist_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_veh = outputNetworkGraphTuple.Travel_dist_total_veh;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_veh;
        outputNetworkGraphTuple->get_Travel_dist_total_veh(&travel_dist_total_veh);
        ```

    === "Python"

        ```python
        travel_dist_total_veh = outputNetworkGraphTuple.Travel_dist_total_veh
        ```

### Travel_dist_total_ped {#travel_dist_total_ped}

```csharp
float Travel_dist_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_ped = outputNetworkGraphTuple.Travel_dist_total_ped;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_ped;
        outputNetworkGraphTuple->get_Travel_dist_total_ped(&travel_dist_total_ped);
        ```

    === "Python"

        ```python
        travel_dist_total_ped = outputNetworkGraphTuple.Travel_dist_total_ped
        ```

### Travel_dist_total_person {#travel_dist_total_person}

```csharp
float Travel_dist_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_total_person = outputNetworkGraphTuple.Travel_dist_total_person;
        ```

    === "C++"

        ```cpp
        double travel_dist_total_person;
        outputNetworkGraphTuple->get_Travel_dist_total_person(&travel_dist_total_person);
        ```

    === "Python"

        ```python
        travel_dist_total_person = outputNetworkGraphTuple.Travel_dist_total_person
        ```

### Travel_dist_av_veh {#travel_dist_av_veh}

```csharp
float Travel_dist_av_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_veh = outputNetworkGraphTuple.Travel_dist_av_veh;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_veh;
        outputNetworkGraphTuple->get_Travel_dist_av_veh(&travel_dist_av_veh);
        ```

    === "Python"

        ```python
        travel_dist_av_veh = outputNetworkGraphTuple.Travel_dist_av_veh
        ```

### Travel_dist_av_ped {#travel_dist_av_ped}

```csharp
float Travel_dist_av_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_ped = outputNetworkGraphTuple.Travel_dist_av_ped;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_ped;
        outputNetworkGraphTuple->get_Travel_dist_av_ped(&travel_dist_av_ped);
        ```

    === "Python"

        ```python
        travel_dist_av_ped = outputNetworkGraphTuple.Travel_dist_av_ped
        ```

### Travel_dist_av_person {#travel_dist_av_person}

```csharp
float Travel_dist_av_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_dist_av_person = outputNetworkGraphTuple.Travel_dist_av_person;
        ```

    === "C++"

        ```cpp
        double travel_dist_av_person;
        outputNetworkGraphTuple->get_Travel_dist_av_person(&travel_dist_av_person);
        ```

    === "Python"

        ```python
        travel_dist_av_person = outputNetworkGraphTuple.Travel_dist_av_person
        ```

### Travel_time_total_veh {#travel_time_total_veh}

```csharp
float Travel_time_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_veh = outputNetworkGraphTuple.Travel_time_total_veh;
        ```

    === "C++"

        ```cpp
        double travel_time_total_veh;
        outputNetworkGraphTuple->get_Travel_time_total_veh(&travel_time_total_veh);
        ```

    === "Python"

        ```python
        travel_time_total_veh = outputNetworkGraphTuple.Travel_time_total_veh
        ```

### Travel_time_total_ped {#travel_time_total_ped}

```csharp
float Travel_time_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_ped = outputNetworkGraphTuple.Travel_time_total_ped;
        ```

    === "C++"

        ```cpp
        double travel_time_total_ped;
        outputNetworkGraphTuple->get_Travel_time_total_ped(&travel_time_total_ped);
        ```

    === "Python"

        ```python
        travel_time_total_ped = outputNetworkGraphTuple.Travel_time_total_ped
        ```

### Travel_time_total_person {#travel_time_total_person}

```csharp
float Travel_time_total_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_person = outputNetworkGraphTuple.Travel_time_total_person;
        ```

    === "C++"

        ```cpp
        double travel_time_total_person;
        outputNetworkGraphTuple->get_Travel_time_total_person(&travel_time_total_person);
        ```

    === "Python"

        ```python
        travel_time_total_person = outputNetworkGraphTuple.Travel_time_total_person
        ```

### Travel_time_av_veh {#travel_time_av_veh}

```csharp
float Travel_time_av_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_veh = outputNetworkGraphTuple.Travel_time_av_veh;
        ```

    === "C++"

        ```cpp
        double travel_time_av_veh;
        outputNetworkGraphTuple->get_Travel_time_av_veh(&travel_time_av_veh);
        ```

    === "Python"

        ```python
        travel_time_av_veh = outputNetworkGraphTuple.Travel_time_av_veh
        ```

### Travel_time_av_ped {#travel_time_av_ped}

```csharp
float Travel_time_av_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_ped = outputNetworkGraphTuple.Travel_time_av_ped;
        ```

    === "C++"

        ```cpp
        double travel_time_av_ped;
        outputNetworkGraphTuple->get_Travel_time_av_ped(&travel_time_av_ped);
        ```

    === "Python"

        ```python
        travel_time_av_ped = outputNetworkGraphTuple.Travel_time_av_ped
        ```

### Travel_time_av_person {#travel_time_av_person}

```csharp
float Travel_time_av_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_av_person = outputNetworkGraphTuple.Travel_time_av_person;
        ```

    === "C++"

        ```cpp
        double travel_time_av_person;
        outputNetworkGraphTuple->get_Travel_time_av_person(&travel_time_av_person);
        ```

    === "Python"

        ```python
        travel_time_av_person = outputNetworkGraphTuple.Travel_time_av_person
        ```

### Travel_speed_ped {#travel_speed_ped}

```csharp
float Travel_speed_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed_ped = outputNetworkGraphTuple.Travel_speed_ped;
        ```

    === "C++"

        ```cpp
        double travel_speed_ped;
        outputNetworkGraphTuple->get_Travel_speed_ped(&travel_speed_ped);
        ```

    === "Python"

        ```python
        travel_speed_ped = outputNetworkGraphTuple.Travel_speed_ped
        ```

### Travel_speed_person {#travel_speed_person}

```csharp
float Travel_speed_person { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed_person = outputNetworkGraphTuple.Travel_speed_person;
        ```

    === "C++"

        ```cpp
        double travel_speed_person;
        outputNetworkGraphTuple->get_Travel_speed_person(&travel_speed_person);
        ```

    === "Python"

        ```python
        travel_speed_person = outputNetworkGraphTuple.Travel_speed_person
        ```

### Operating_cost_total_veh {#operating_cost_total_veh}

```csharp
float Operating_cost_total_veh { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total_veh = outputNetworkGraphTuple.Operating_cost_total_veh;
        ```

    === "C++"

        ```cpp
        double operating_cost_total_veh;
        outputNetworkGraphTuple->get_Operating_cost_total_veh(&operating_cost_total_veh);
        ```

    === "Python"

        ```python
        operating_cost_total_veh = outputNetworkGraphTuple.Operating_cost_total_veh
        ```

### Operating_cost_total_ped {#operating_cost_total_ped}

```csharp
float Operating_cost_total_ped { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total_ped = outputNetworkGraphTuple.Operating_cost_total_ped;
        ```

    === "C++"

        ```cpp
        double operating_cost_total_ped;
        outputNetworkGraphTuple->get_Operating_cost_total_ped(&operating_cost_total_ped);
        ```

    === "Python"

        ```python
        operating_cost_total_ped = outputNetworkGraphTuple.Operating_cost_total_ped
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkgraphtuples.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkGraphTuples
title: OutputNetworkGraphTuples
name: ISIAPIOutputNetworkGraphTuples
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FD291FB7-64B6-4F12-9314-529C6B79B38A
members:
  - ISIAPIOutputNetworkGraphTuple this[int index]
  - int Count
---

# OutputNetworkGraphTuples

Type `ISIAPIOutputNetworkGraphTuples` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FD291FB7-64B6-4F12-9314-529C6B79B38A`

## Declaration

```csharp
[Guid("FD291FB7-64B6-4F12-9314-529C6B79B38A")]
public interface ISIAPIOutputNetworkGraphTuples
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputNetworkGraphTuple`](sidrasolutions.si.api.isiapioutputnetworkgraphtuple.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputNetworkGraphTuples.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputNetworkGraphTuples->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputNetworkGraphTuples.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputNetworkGraphTuple this[] { get; }
```

**Type** [`ISIAPIOutputNetworkGraphTuple`](sidrasolutions.si.api.isiapioutputnetworkgraphtuple.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputNetworkGraphTuples.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkGraphTuple> this[];
        outputNetworkGraphTuples->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputNetworkGraphTuples.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkpedestrian.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkPedestrian
title: OutputNetworkPedestrian
name: ISIAPIOutputNetworkPedestrian
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8C26CC5A-A489-4C59-A159-414A4BE7E09D
members:
  - float ArrivalFlowTotal
  - float DemandFlowTotal
  - float DelayControlTotal
  - float DelayControlAverage
  - float DelayControlAverageWorstMovement
  - float StopsTotal
  - float StopRate
  - float ProportionQueued
  - float PerformanceIndex
  - float TravelDistanceTotal
  - float TravelDistanceAverage
  - float TravelTimeTotal
  - float TravelTimeAverage
  - float TravelSpeed
  - float OperatingCostTotal
  - ISIAPIOutputNetwork OutputNetwork
---

# OutputNetworkPedestrian

Type `ISIAPIOutputNetworkPedestrian` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8C26CC5A-A489-4C59-A159-414A4BE7E09D`

## Declaration

```csharp
[Guid("8C26CC5A-A489-4C59-A159-414A4BE7E09D")]
public interface ISIAPIOutputNetworkPedestrian
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [ArrivalFlowTotal](#arrivalflowtotal) | `float` |  |
| [DemandFlowTotal](#demandflowtotal) | `float` |  |
| [DelayControlTotal](#delaycontroltotal) | `float` |  |
| [DelayControlAverage](#delaycontrolaverage) | `float` |  |
| [DelayControlAverageWorstMovement](#delaycontrolaverageworstmovement) | `float` |  |
| [StopsTotal](#stopstotal) | `float` |  |
| [StopRate](#stoprate) | `float` |  |
| [ProportionQueued](#proportionqueued) | `float` |  |
| [PerformanceIndex](#performanceindex) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelSpeed](#travelspeed) | `float` |  |
| [OperatingCostTotal](#operatingcosttotal) | `float` |  |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) |  |

</div>

## Properties

### ArrivalFlowTotal {#arrivalflowtotal}

```csharp
float ArrivalFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrivalFlowTotal = outputNetworkPedestrian.ArrivalFlowTotal;
        ```

    === "C++"

        ```cpp
        double arrivalFlowTotal;
        outputNetworkPedestrian->get_ArrivalFlowTotal(&arrivalFlowTotal);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputNetworkPedestrian.ArrivalFlowTotal
        ```

### DemandFlowTotal {#demandflowtotal}

```csharp
float DemandFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demandFlowTotal = outputNetworkPedestrian.DemandFlowTotal;
        ```

    === "C++"

        ```cpp
        double demandFlowTotal;
        outputNetworkPedestrian->get_DemandFlowTotal(&demandFlowTotal);
        ```

    === "Python"

        ```python
        demand_flow_total = outputNetworkPedestrian.DemandFlowTotal
        ```

### DelayControlTotal {#delaycontroltotal}

```csharp
float DelayControlTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlTotal = outputNetworkPedestrian.DelayControlTotal;
        ```

    === "C++"

        ```cpp
        double delayControlTotal;
        outputNetworkPedestrian->get_DelayControlTotal(&delayControlTotal);
        ```

    === "Python"

        ```python
        delay_control_total = outputNetworkPedestrian.DelayControlTotal
        ```

### DelayControlAverage {#delaycontrolaverage}

```csharp
float DelayControlAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverage = outputNetworkPedestrian.DelayControlAverage;
        ```

    === "C++"

        ```cpp
        double delayControlAverage;
        outputNetworkPedestrian->get_DelayControlAverage(&delayControlAverage);
        ```

    === "Python"

        ```python
        delay_control_average = outputNetworkPedestrian.DelayControlAverage
        ```

### DelayControlAverageWorstMovement {#delaycontrolaverageworstmovement}

```csharp
float DelayControlAverageWorstMovement { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstMovement = outputNetworkPedestrian.DelayControlAverageWorstMovement;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstMovement;
        outputNetworkPedestrian->get_DelayControlAverageWorstMovement(&delayControlAverageWorstMovement);
        ```

    === "Python"

        ```python
        delay_control_average_worst_movement = outputNetworkPedestrian.DelayControlAverageWorstMovement
        ```

### StopsTotal {#stopstotal}

```csharp
float StopsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopsTotal = outputNetworkPedestrian.StopsTotal;
        ```

    === "C++"

        ```cpp
        double stopsTotal;
        outputNetworkPedestrian->get_StopsTotal(&stopsTotal);
        ```

    === "Python"

        ```python
        stops_total = outputNetworkPedestrian.StopsTotal
        ```

### StopRate {#stoprate}

```csharp
float StopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate = outputNetworkPedestrian.StopRate;
        ```

    === "C++"

        ```cpp
        double stopRate;
        outputNetworkPedestrian->get_StopRate(&stopRate);
        ```

    === "Python"

        ```python
        stop_rate = outputNetworkPedestrian.StopRate
        ```

### ProportionQueued {#proportionqueued}

```csharp
float ProportionQueued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportionQueued = outputNetworkPedestrian.ProportionQueued;
        ```

    === "C++"

        ```cpp
        double proportionQueued;
        outputNetworkPedestrian->get_ProportionQueued(&proportionQueued);
        ```

    === "Python"

        ```python
        proportion_queued = outputNetworkPedestrian.ProportionQueued
        ```

### PerformanceIndex {#performanceindex}

```csharp
float PerformanceIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performanceIndex = outputNetworkPedestrian.PerformanceIndex;
        ```

    === "C++"

        ```cpp
        double performanceIndex;
        outputNetworkPedestrian->get_PerformanceIndex(&performanceIndex);
        ```

    === "Python"

        ```python
        performance_index = outputNetworkPedestrian.PerformanceIndex
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputNetworkPedestrian.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputNetworkPedestrian->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputNetworkPedestrian.TravelDistanceTotal
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputNetworkPedestrian.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputNetworkPedestrian->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputNetworkPedestrian.TravelDistanceAverage
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputNetworkPedestrian.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputNetworkPedestrian->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputNetworkPedestrian.TravelTimeTotal
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputNetworkPedestrian.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputNetworkPedestrian->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputNetworkPedestrian.TravelTimeAverage
        ```

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputNetworkPedestrian.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputNetworkPedestrian->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputNetworkPedestrian.TravelSpeed
        ```

### OperatingCostTotal {#operatingcosttotal}

```csharp
float OperatingCostTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCostTotal = outputNetworkPedestrian.OperatingCostTotal;
        ```

    === "C++"

        ```cpp
        double operatingCostTotal;
        outputNetworkPedestrian->get_OperatingCostTotal(&operatingCostTotal);
        ```

    === "Python"

        ```python
        operating_cost_total = outputNetworkPedestrian.OperatingCostTotal
        ```

### OutputNetwork {#outputnetwork}

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = outputNetworkPedestrian.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        outputNetworkPedestrian->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = outputNetworkPedestrian.OutputNetwork
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkperson.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkPerson
title: OutputNetworkPerson
name: ISIAPIOutputNetworkPerson
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 99B973C9-1BC6-4212-BE59-584618761BAA
members:
  - float ArrivalFlowTotal
  - float DemandFlowTotal
  - float DelayControlTotal
  - float DelayControlAverage
  - float DelayControlAverageWorstMovement
  - float StopsTotal
  - float StopRate
  - float ProportionQueued
  - float PerformanceIndex
  - float TravelDistanceTotal
  - float TravelDistanceAverage
  - float TravelTimeTotal
  - float TravelTimeAverage
  - float TravelSpeed
  - float OperatingCostTotal
  - float TravelDelay
  - float TravelDelayAverage
  - ISIAPIOutputNetwork OutputNetwork
---

# OutputNetworkPerson

Type `ISIAPIOutputNetworkPerson` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `99B973C9-1BC6-4212-BE59-584618761BAA`

## Declaration

```csharp
[Guid("99B973C9-1BC6-4212-BE59-584618761BAA")]
public interface ISIAPIOutputNetworkPerson
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [ArrivalFlowTotal](#arrivalflowtotal) | `float` |  |
| [DemandFlowTotal](#demandflowtotal) | `float` |  |
| [DelayControlTotal](#delaycontroltotal) | `float` |  |
| [DelayControlAverage](#delaycontrolaverage) | `float` |  |
| [DelayControlAverageWorstMovement](#delaycontrolaverageworstmovement) | `float` |  |
| [StopsTotal](#stopstotal) | `float` |  |
| [StopRate](#stoprate) | `float` |  |
| [ProportionQueued](#proportionqueued) | `float` |  |
| [PerformanceIndex](#performanceindex) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelSpeed](#travelspeed) | `float` |  |
| [OperatingCostTotal](#operatingcosttotal) | `float` |  |
| [TravelDelay](#traveldelay) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) |  |

</div>

## Properties

### ArrivalFlowTotal {#arrivalflowtotal}

```csharp
float ArrivalFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrivalFlowTotal = outputNetworkPerson.ArrivalFlowTotal;
        ```

    === "C++"

        ```cpp
        double arrivalFlowTotal;
        outputNetworkPerson->get_ArrivalFlowTotal(&arrivalFlowTotal);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputNetworkPerson.ArrivalFlowTotal
        ```

### DemandFlowTotal {#demandflowtotal}

```csharp
float DemandFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demandFlowTotal = outputNetworkPerson.DemandFlowTotal;
        ```

    === "C++"

        ```cpp
        double demandFlowTotal;
        outputNetworkPerson->get_DemandFlowTotal(&demandFlowTotal);
        ```

    === "Python"

        ```python
        demand_flow_total = outputNetworkPerson.DemandFlowTotal
        ```

### DelayControlTotal {#delaycontroltotal}

```csharp
float DelayControlTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlTotal = outputNetworkPerson.DelayControlTotal;
        ```

    === "C++"

        ```cpp
        double delayControlTotal;
        outputNetworkPerson->get_DelayControlTotal(&delayControlTotal);
        ```

    === "Python"

        ```python
        delay_control_total = outputNetworkPerson.DelayControlTotal
        ```

### DelayControlAverage {#delaycontrolaverage}

```csharp
float DelayControlAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverage = outputNetworkPerson.DelayControlAverage;
        ```

    === "C++"

        ```cpp
        double delayControlAverage;
        outputNetworkPerson->get_DelayControlAverage(&delayControlAverage);
        ```

    === "Python"

        ```python
        delay_control_average = outputNetworkPerson.DelayControlAverage
        ```

### DelayControlAverageWorstMovement {#delaycontrolaverageworstmovement}

```csharp
float DelayControlAverageWorstMovement { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstMovement = outputNetworkPerson.DelayControlAverageWorstMovement;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstMovement;
        outputNetworkPerson->get_DelayControlAverageWorstMovement(&delayControlAverageWorstMovement);
        ```

    === "Python"

        ```python
        delay_control_average_worst_movement = outputNetworkPerson.DelayControlAverageWorstMovement
        ```

### StopsTotal {#stopstotal}

```csharp
float StopsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopsTotal = outputNetworkPerson.StopsTotal;
        ```

    === "C++"

        ```cpp
        double stopsTotal;
        outputNetworkPerson->get_StopsTotal(&stopsTotal);
        ```

    === "Python"

        ```python
        stops_total = outputNetworkPerson.StopsTotal
        ```

### StopRate {#stoprate}

```csharp
float StopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate = outputNetworkPerson.StopRate;
        ```

    === "C++"

        ```cpp
        double stopRate;
        outputNetworkPerson->get_StopRate(&stopRate);
        ```

    === "Python"

        ```python
        stop_rate = outputNetworkPerson.StopRate
        ```

### ProportionQueued {#proportionqueued}

```csharp
float ProportionQueued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportionQueued = outputNetworkPerson.ProportionQueued;
        ```

    === "C++"

        ```cpp
        double proportionQueued;
        outputNetworkPerson->get_ProportionQueued(&proportionQueued);
        ```

    === "Python"

        ```python
        proportion_queued = outputNetworkPerson.ProportionQueued
        ```

### PerformanceIndex {#performanceindex}

```csharp
float PerformanceIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performanceIndex = outputNetworkPerson.PerformanceIndex;
        ```

    === "C++"

        ```cpp
        double performanceIndex;
        outputNetworkPerson->get_PerformanceIndex(&performanceIndex);
        ```

    === "Python"

        ```python
        performance_index = outputNetworkPerson.PerformanceIndex
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputNetworkPerson.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputNetworkPerson->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputNetworkPerson.TravelDistanceTotal
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputNetworkPerson.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputNetworkPerson->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputNetworkPerson.TravelDistanceAverage
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputNetworkPerson.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputNetworkPerson->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputNetworkPerson.TravelTimeTotal
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputNetworkPerson.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputNetworkPerson->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputNetworkPerson.TravelTimeAverage
        ```

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputNetworkPerson.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputNetworkPerson->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputNetworkPerson.TravelSpeed
        ```

### OperatingCostTotal {#operatingcosttotal}

```csharp
float OperatingCostTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCostTotal = outputNetworkPerson.OperatingCostTotal;
        ```

    === "C++"

        ```cpp
        double operatingCostTotal;
        outputNetworkPerson->get_OperatingCostTotal(&operatingCostTotal);
        ```

    === "Python"

        ```python
        operating_cost_total = outputNetworkPerson.OperatingCostTotal
        ```

### TravelDelay {#traveldelay}

```csharp
float TravelDelay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay = outputNetworkPerson.TravelDelay;
        ```

    === "C++"

        ```cpp
        double travelDelay;
        outputNetworkPerson->get_TravelDelay(&travelDelay);
        ```

    === "Python"

        ```python
        travel_delay = outputNetworkPerson.TravelDelay
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputNetworkPerson.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputNetworkPerson->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputNetworkPerson.TravelDelayAverage
        ```

### OutputNetwork {#outputnetwork}

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = outputNetworkPerson.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        outputNetworkPerson->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = outputNetworkPerson.OutputNetwork
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkvehicle.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkVehicle
title: OutputNetworkVehicle
name: ISIAPIOutputNetworkVehicle
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 27B24392-4491-4109-A190-C0E554698AC1
members:
  - float ArrivalFlowTotal
  - float ArrivalFlow_HV_pct
  - float DemandFlowTotal
  - float DemandFlow_HV_pct
  - float DegreeSaturation
  - float DelayControlTotal
  - float DelayControlAverage
  - float DelayControlAverageWorstLane
  - float DelayControlAverageWorstMovement
  - float DelayGeometricAverage
  - float DelayStoplineAverage
  - float StopsTotal
  - float StopRate
  - float ProportionQueued
  - float PerformanceIndex
  - float TravelDistanceTotal
  - float TravelTimeTotal
  - float OperatingCostTotal
  - float FuelConsumptionTotal
  - float CarbonDioxideTotal
  - float HydrocarbonsTotal
  - float CarbonMonoxideTotal
  - float NoxTotal
  - float SpeedEfficiency
  - float CongestionCoefficient
  - float TravelDistanceAverage
  - float TravelTimeAverage
  - float TravelSpeed
  - float DesiredTripTime
  - float TravelDelay
  - float IdlingTimeAvg
  - float RunningTimeAvg
  - float TravelTimeIndex
  - float QueueStorageRatioMaximum
  - float QueueStorageRatioAverage
  - string LevelOfService
  - float OperatingCost_rate
  - float TravelTimeAverage_rate
  - float IdlingTimeAvgerage_rate
  - float IdlingTimeAvgerage_pct
  - float RunningTimeAvgerage_rate
  - float RunningTimeAvgerage_pct
  - float DesiredTripTime_rate
  - float TravelDelay_rate
  - float TravelDelay_pct
  - float StopRate_rate
  - float FuelConsumption_rate
  - float CarbonDioxide_rate
  - float Hydrocarbons_rate
  - float CarbonMonoxide_rate
  - float Nox_rate
  - float FuelEconomy
  - float Min_dx_percent
  - float Max_dx_percent
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float TravelDelayAverage
  - float TravelDelayAverage_rate
  - float Max_dx_percent_prev
  - float Max_dx_percent_prev2
  - float Capacity_effective
  - float Practical_spare_capacity
  - float NwModel_vari_index
  - int SpeedEfficiencyFlag
  - ISIAPIOutputNetwork OutputNetwork
  - ISIAPIOutputNetworkVehicleMCs OutputNetworkVehicleMCs
  - float DiffDelayControlAveragePct
  - float DiffDelayControlAveragePctPrev
  - float DiffDelayControlAveragePctPrev2
  - float DiffSpeedEfficiencyPct
  - float DiffSpeedEfficiencyPctPrev
  - float DiffSpeedEfficiencyPctPrev2
---

# OutputNetworkVehicle

Type `ISIAPIOutputNetworkVehicle` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `27B24392-4491-4109-A190-C0E554698AC1`

## Declaration

```csharp
[Guid("27B24392-4491-4109-A190-C0E554698AC1")]
public interface ISIAPIOutputNetworkVehicle
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [ArrivalFlowTotal](#arrivalflowtotal) | `float` |  |
| [ArrivalFlow_HV_pct](#arrivalflow_hv_pct) | `float` |  |
| [DemandFlowTotal](#demandflowtotal) | `float` |  |
| [DemandFlow_HV_pct](#demandflow_hv_pct) | `float` |  |
| [DegreeSaturation](#degreesaturation) | `float` |  |
| [DelayControlTotal](#delaycontroltotal) | `float` |  |
| [DelayControlAverage](#delaycontrolaverage) | `float` |  |
| [DelayControlAverageWorstLane](#delaycontrolaverageworstlane) | `float` |  |
| [DelayControlAverageWorstMovement](#delaycontrolaverageworstmovement) | `float` |  |
| [DelayGeometricAverage](#delaygeometricaverage) | `float` |  |
| [DelayStoplineAverage](#delaystoplineaverage) | `float` |  |
| [StopsTotal](#stopstotal) | `float` |  |
| [StopRate](#stoprate) | `float` |  |
| [ProportionQueued](#proportionqueued) | `float` |  |
| [PerformanceIndex](#performanceindex) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [OperatingCostTotal](#operatingcosttotal) | `float` |  |
| [FuelConsumptionTotal](#fuelconsumptiontotal) | `float` |  |
| [CarbonDioxideTotal](#carbondioxidetotal) | `float` |  |
| [HydrocarbonsTotal](#hydrocarbonstotal) | `float` |  |
| [CarbonMonoxideTotal](#carbonmonoxidetotal) | `float` |  |
| [NoxTotal](#noxtotal) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelSpeed](#travelspeed) | `float` |  |
| [DesiredTripTime](#desiredtriptime) | `float` |  |
| [TravelDelay](#traveldelay) | `float` |  |
| [IdlingTimeAvg](#idlingtimeavg) | `float` |  |
| [RunningTimeAvg](#runningtimeavg) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [QueueStorageRatioMaximum](#queuestorageratiomaximum) | `float` |  |
| [QueueStorageRatioAverage](#queuestorageratioaverage) | `float` |  |
| [LevelOfService](#levelofservice) | `string` |  |
| [OperatingCost_rate](#operatingcost_rate) | `float` |  |
| [TravelTimeAverage_rate](#traveltimeaverage_rate) | `float` |  |
| [IdlingTimeAvgerage_rate](#idlingtimeavgerage_rate) | `float` |  |
| [IdlingTimeAvgerage_pct](#idlingtimeavgerage_pct) | `float` |  |
| [RunningTimeAvgerage_rate](#runningtimeavgerage_rate) | `float` |  |
| [RunningTimeAvgerage_pct](#runningtimeavgerage_pct) | `float` |  |
| [DesiredTripTime_rate](#desiredtriptime_rate) | `float` |  |
| [TravelDelay_rate](#traveldelay_rate) | `float` |  |
| [TravelDelay_pct](#traveldelay_pct) | `float` |  |
| [StopRate_rate](#stoprate_rate) | `float` |  |
| [FuelConsumption_rate](#fuelconsumption_rate) | `float` |  |
| [CarbonDioxide_rate](#carbondioxide_rate) | `float` |  |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` |  |
| [CarbonMonoxide_rate](#carbonmonoxide_rate) | `float` |  |
| [Nox_rate](#nox_rate) | `float` |  |
| [FuelEconomy](#fueleconomy) | `float` |  |
| [Min_dx_percent](#min_dx_percent) | `float` |  |
| [Max_dx_percent](#max_dx_percent) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [TravelDelayAverage_rate](#traveldelayaverage_rate) | `float` |  |
| [Max_dx_percent_prev](#max_dx_percent_prev) | `float` |  |
| [Max_dx_percent_prev2](#max_dx_percent_prev2) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [NwModel_vari_index](#nwmodel_vari_index) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) |  |
| [OutputNetworkVehicleMCs](#outputnetworkvehiclemcs) | [`ISIAPIOutputNetworkVehicleMCs`](sidrasolutions.si.api.isiapioutputnetworkvehiclemcs.md) |  |
| [DiffDelayControlAveragePct](#diffdelaycontrolaveragepct) | `float` |  |
| [DiffDelayControlAveragePctPrev](#diffdelaycontrolaveragepctprev) | `float` |  |
| [DiffDelayControlAveragePctPrev2](#diffdelaycontrolaveragepctprev2) | `float` |  |
| [DiffSpeedEfficiencyPct](#diffspeedefficiencypct) | `float` |  |
| [DiffSpeedEfficiencyPctPrev](#diffspeedefficiencypctprev) | `float` |  |
| [DiffSpeedEfficiencyPctPrev2](#diffspeedefficiencypctprev2) | `float` |  |

</div>

## Properties

### ArrivalFlowTotal {#arrivalflowtotal}

```csharp
float ArrivalFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrivalFlowTotal = outputNetworkVehicle.ArrivalFlowTotal;
        ```

    === "C++"

        ```cpp
        double arrivalFlowTotal;
        outputNetworkVehicle->get_ArrivalFlowTotal(&arrivalFlowTotal);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputNetworkVehicle.ArrivalFlowTotal
        ```

### ArrivalFlow_HV_pct {#arrivalflow_hv_pct}

```csharp
float ArrivalFlow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrivalFlow_HV_pct = outputNetworkVehicle.ArrivalFlow_HV_pct;
        ```

    === "C++"

        ```cpp
        double arrivalFlow_HV_pct;
        outputNetworkVehicle->get_ArrivalFlow_HV_pct(&arrivalFlow_HV_pct);
        ```

    === "Python"

        ```python
        arrival_flow_hv_pct = outputNetworkVehicle.ArrivalFlow_HV_pct
        ```

### DemandFlowTotal {#demandflowtotal}

```csharp
float DemandFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demandFlowTotal = outputNetworkVehicle.DemandFlowTotal;
        ```

    === "C++"

        ```cpp
        double demandFlowTotal;
        outputNetworkVehicle->get_DemandFlowTotal(&demandFlowTotal);
        ```

    === "Python"

        ```python
        demand_flow_total = outputNetworkVehicle.DemandFlowTotal
        ```

### DemandFlow_HV_pct {#demandflow_hv_pct}

```csharp
float DemandFlow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demandFlow_HV_pct = outputNetworkVehicle.DemandFlow_HV_pct;
        ```

    === "C++"

        ```cpp
        double demandFlow_HV_pct;
        outputNetworkVehicle->get_DemandFlow_HV_pct(&demandFlow_HV_pct);
        ```

    === "Python"

        ```python
        demand_flow_hv_pct = outputNetworkVehicle.DemandFlow_HV_pct
        ```

### DegreeSaturation {#degreesaturation}

```csharp
float DegreeSaturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float degreeSaturation = outputNetworkVehicle.DegreeSaturation;
        ```

    === "C++"

        ```cpp
        double degreeSaturation;
        outputNetworkVehicle->get_DegreeSaturation(&degreeSaturation);
        ```

    === "Python"

        ```python
        degree_saturation = outputNetworkVehicle.DegreeSaturation
        ```

### DelayControlTotal {#delaycontroltotal}

```csharp
float DelayControlTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlTotal = outputNetworkVehicle.DelayControlTotal;
        ```

    === "C++"

        ```cpp
        double delayControlTotal;
        outputNetworkVehicle->get_DelayControlTotal(&delayControlTotal);
        ```

    === "Python"

        ```python
        delay_control_total = outputNetworkVehicle.DelayControlTotal
        ```

### DelayControlAverage {#delaycontrolaverage}

```csharp
float DelayControlAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverage = outputNetworkVehicle.DelayControlAverage;
        ```

    === "C++"

        ```cpp
        double delayControlAverage;
        outputNetworkVehicle->get_DelayControlAverage(&delayControlAverage);
        ```

    === "Python"

        ```python
        delay_control_average = outputNetworkVehicle.DelayControlAverage
        ```

### DelayControlAverageWorstLane {#delaycontrolaverageworstlane}

```csharp
float DelayControlAverageWorstLane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstLane = outputNetworkVehicle.DelayControlAverageWorstLane;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstLane;
        outputNetworkVehicle->get_DelayControlAverageWorstLane(&delayControlAverageWorstLane);
        ```

    === "Python"

        ```python
        delay_control_average_worst_lane = outputNetworkVehicle.DelayControlAverageWorstLane
        ```

### DelayControlAverageWorstMovement {#delaycontrolaverageworstmovement}

```csharp
float DelayControlAverageWorstMovement { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstMovement = outputNetworkVehicle.DelayControlAverageWorstMovement;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstMovement;
        outputNetworkVehicle->get_DelayControlAverageWorstMovement(&delayControlAverageWorstMovement);
        ```

    === "Python"

        ```python
        delay_control_average_worst_movement = outputNetworkVehicle.DelayControlAverageWorstMovement
        ```

### DelayGeometricAverage {#delaygeometricaverage}

```csharp
float DelayGeometricAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayGeometricAverage = outputNetworkVehicle.DelayGeometricAverage;
        ```

    === "C++"

        ```cpp
        double delayGeometricAverage;
        outputNetworkVehicle->get_DelayGeometricAverage(&delayGeometricAverage);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputNetworkVehicle.DelayGeometricAverage
        ```

### DelayStoplineAverage {#delaystoplineaverage}

```csharp
float DelayStoplineAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayStoplineAverage = outputNetworkVehicle.DelayStoplineAverage;
        ```

    === "C++"

        ```cpp
        double delayStoplineAverage;
        outputNetworkVehicle->get_DelayStoplineAverage(&delayStoplineAverage);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputNetworkVehicle.DelayStoplineAverage
        ```

### StopsTotal {#stopstotal}

```csharp
float StopsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopsTotal = outputNetworkVehicle.StopsTotal;
        ```

    === "C++"

        ```cpp
        double stopsTotal;
        outputNetworkVehicle->get_StopsTotal(&stopsTotal);
        ```

    === "Python"

        ```python
        stops_total = outputNetworkVehicle.StopsTotal
        ```

### StopRate {#stoprate}

```csharp
float StopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate = outputNetworkVehicle.StopRate;
        ```

    === "C++"

        ```cpp
        double stopRate;
        outputNetworkVehicle->get_StopRate(&stopRate);
        ```

    === "Python"

        ```python
        stop_rate = outputNetworkVehicle.StopRate
        ```

### ProportionQueued {#proportionqueued}

```csharp
float ProportionQueued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportionQueued = outputNetworkVehicle.ProportionQueued;
        ```

    === "C++"

        ```cpp
        double proportionQueued;
        outputNetworkVehicle->get_ProportionQueued(&proportionQueued);
        ```

    === "Python"

        ```python
        proportion_queued = outputNetworkVehicle.ProportionQueued
        ```

### PerformanceIndex {#performanceindex}

```csharp
float PerformanceIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performanceIndex = outputNetworkVehicle.PerformanceIndex;
        ```

    === "C++"

        ```cpp
        double performanceIndex;
        outputNetworkVehicle->get_PerformanceIndex(&performanceIndex);
        ```

    === "Python"

        ```python
        performance_index = outputNetworkVehicle.PerformanceIndex
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputNetworkVehicle.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputNetworkVehicle->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputNetworkVehicle.TravelDistanceTotal
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputNetworkVehicle.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputNetworkVehicle->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputNetworkVehicle.TravelTimeTotal
        ```

### OperatingCostTotal {#operatingcosttotal}

```csharp
float OperatingCostTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCostTotal = outputNetworkVehicle.OperatingCostTotal;
        ```

    === "C++"

        ```cpp
        double operatingCostTotal;
        outputNetworkVehicle->get_OperatingCostTotal(&operatingCostTotal);
        ```

    === "Python"

        ```python
        operating_cost_total = outputNetworkVehicle.OperatingCostTotal
        ```

### FuelConsumptionTotal {#fuelconsumptiontotal}

```csharp
float FuelConsumptionTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelConsumptionTotal = outputNetworkVehicle.FuelConsumptionTotal;
        ```

    === "C++"

        ```cpp
        double fuelConsumptionTotal;
        outputNetworkVehicle->get_FuelConsumptionTotal(&fuelConsumptionTotal);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputNetworkVehicle.FuelConsumptionTotal
        ```

### CarbonDioxideTotal {#carbondioxidetotal}

```csharp
float CarbonDioxideTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonDioxideTotal = outputNetworkVehicle.CarbonDioxideTotal;
        ```

    === "C++"

        ```cpp
        double carbonDioxideTotal;
        outputNetworkVehicle->get_CarbonDioxideTotal(&carbonDioxideTotal);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputNetworkVehicle.CarbonDioxideTotal
        ```

### HydrocarbonsTotal {#hydrocarbonstotal}

```csharp
float HydrocarbonsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbonsTotal = outputNetworkVehicle.HydrocarbonsTotal;
        ```

    === "C++"

        ```cpp
        double hydrocarbonsTotal;
        outputNetworkVehicle->get_HydrocarbonsTotal(&hydrocarbonsTotal);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputNetworkVehicle.HydrocarbonsTotal
        ```

### CarbonMonoxideTotal {#carbonmonoxidetotal}

```csharp
float CarbonMonoxideTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonMonoxideTotal = outputNetworkVehicle.CarbonMonoxideTotal;
        ```

    === "C++"

        ```cpp
        double carbonMonoxideTotal;
        outputNetworkVehicle->get_CarbonMonoxideTotal(&carbonMonoxideTotal);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputNetworkVehicle.CarbonMonoxideTotal
        ```

### NoxTotal {#noxtotal}

```csharp
float NoxTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float noxTotal = outputNetworkVehicle.NoxTotal;
        ```

    === "C++"

        ```cpp
        double noxTotal;
        outputNetworkVehicle->get_NoxTotal(&noxTotal);
        ```

    === "Python"

        ```python
        nox_total = outputNetworkVehicle.NoxTotal
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputNetworkVehicle.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputNetworkVehicle->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputNetworkVehicle.SpeedEfficiency
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputNetworkVehicle.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputNetworkVehicle->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputNetworkVehicle.CongestionCoefficient
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputNetworkVehicle.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputNetworkVehicle->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputNetworkVehicle.TravelDistanceAverage
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputNetworkVehicle.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputNetworkVehicle->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputNetworkVehicle.TravelTimeAverage
        ```

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputNetworkVehicle.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputNetworkVehicle->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputNetworkVehicle.TravelSpeed
        ```

### DesiredTripTime {#desiredtriptime}

```csharp
float DesiredTripTime { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredTripTime = outputNetworkVehicle.DesiredTripTime;
        ```

    === "C++"

        ```cpp
        double desiredTripTime;
        outputNetworkVehicle->get_DesiredTripTime(&desiredTripTime);
        ```

    === "Python"

        ```python
        desired_trip_time = outputNetworkVehicle.DesiredTripTime
        ```

### TravelDelay {#traveldelay}

```csharp
float TravelDelay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay = outputNetworkVehicle.TravelDelay;
        ```

    === "C++"

        ```cpp
        double travelDelay;
        outputNetworkVehicle->get_TravelDelay(&travelDelay);
        ```

    === "Python"

        ```python
        travel_delay = outputNetworkVehicle.TravelDelay
        ```

### IdlingTimeAvg {#idlingtimeavg}

```csharp
float IdlingTimeAvg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvg = outputNetworkVehicle.IdlingTimeAvg;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvg;
        outputNetworkVehicle->get_IdlingTimeAvg(&idlingTimeAvg);
        ```

    === "Python"

        ```python
        idling_time_avg = outputNetworkVehicle.IdlingTimeAvg
        ```

### RunningTimeAvg {#runningtimeavg}

```csharp
float RunningTimeAvg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvg = outputNetworkVehicle.RunningTimeAvg;
        ```

    === "C++"

        ```cpp
        double runningTimeAvg;
        outputNetworkVehicle->get_RunningTimeAvg(&runningTimeAvg);
        ```

    === "Python"

        ```python
        running_time_avg = outputNetworkVehicle.RunningTimeAvg
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputNetworkVehicle.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputNetworkVehicle->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputNetworkVehicle.TravelTimeIndex
        ```

### QueueStorageRatioMaximum {#queuestorageratiomaximum}

```csharp
float QueueStorageRatioMaximum { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queueStorageRatioMaximum = outputNetworkVehicle.QueueStorageRatioMaximum;
        ```

    === "C++"

        ```cpp
        double queueStorageRatioMaximum;
        outputNetworkVehicle->get_QueueStorageRatioMaximum(&queueStorageRatioMaximum);
        ```

    === "Python"

        ```python
        queue_storage_ratio_maximum = outputNetworkVehicle.QueueStorageRatioMaximum
        ```

### QueueStorageRatioAverage {#queuestorageratioaverage}

```csharp
float QueueStorageRatioAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queueStorageRatioAverage = outputNetworkVehicle.QueueStorageRatioAverage;
        ```

    === "C++"

        ```cpp
        double queueStorageRatioAverage;
        outputNetworkVehicle->get_QueueStorageRatioAverage(&queueStorageRatioAverage);
        ```

    === "Python"

        ```python
        queue_storage_ratio_average = outputNetworkVehicle.QueueStorageRatioAverage
        ```

### LevelOfService {#levelofservice}

```csharp
string LevelOfService { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string levelOfService = outputNetworkVehicle.LevelOfService;
        ```

    === "C++"

        ```cpp
        CComBSTR levelOfService;
        outputNetworkVehicle->get_LevelOfService(&levelOfService);
        ```

    === "Python"

        ```python
        level_of_service = outputNetworkVehicle.LevelOfService
        ```

### OperatingCost_rate {#operatingcost_rate}

```csharp
float OperatingCost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCost_rate = outputNetworkVehicle.OperatingCost_rate;
        ```

    === "C++"

        ```cpp
        double operatingCost_rate;
        outputNetworkVehicle->get_OperatingCost_rate(&operatingCost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputNetworkVehicle.OperatingCost_rate
        ```

### TravelTimeAverage_rate {#traveltimeaverage_rate}

```csharp
float TravelTimeAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage_rate = outputNetworkVehicle.TravelTimeAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage_rate;
        outputNetworkVehicle->get_TravelTimeAverage_rate(&travelTimeAverage_rate);
        ```

    === "Python"

        ```python
        travel_time_average_rate = outputNetworkVehicle.TravelTimeAverage_rate
        ```

### IdlingTimeAvgerage_rate {#idlingtimeavgerage_rate}

```csharp
float IdlingTimeAvgerage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvgerage_rate = outputNetworkVehicle.IdlingTimeAvgerage_rate;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvgerage_rate;
        outputNetworkVehicle->get_IdlingTimeAvgerage_rate(&idlingTimeAvgerage_rate);
        ```

    === "Python"

        ```python
        idling_time_avgerage_rate = outputNetworkVehicle.IdlingTimeAvgerage_rate
        ```

### IdlingTimeAvgerage_pct {#idlingtimeavgerage_pct}

```csharp
float IdlingTimeAvgerage_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvgerage_pct = outputNetworkVehicle.IdlingTimeAvgerage_pct;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvgerage_pct;
        outputNetworkVehicle->get_IdlingTimeAvgerage_pct(&idlingTimeAvgerage_pct);
        ```

    === "Python"

        ```python
        idling_time_avgerage_pct = outputNetworkVehicle.IdlingTimeAvgerage_pct
        ```

### RunningTimeAvgerage_rate {#runningtimeavgerage_rate}

```csharp
float RunningTimeAvgerage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvgerage_rate = outputNetworkVehicle.RunningTimeAvgerage_rate;
        ```

    === "C++"

        ```cpp
        double runningTimeAvgerage_rate;
        outputNetworkVehicle->get_RunningTimeAvgerage_rate(&runningTimeAvgerage_rate);
        ```

    === "Python"

        ```python
        running_time_avgerage_rate = outputNetworkVehicle.RunningTimeAvgerage_rate
        ```

### RunningTimeAvgerage_pct {#runningtimeavgerage_pct}

```csharp
float RunningTimeAvgerage_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvgerage_pct = outputNetworkVehicle.RunningTimeAvgerage_pct;
        ```

    === "C++"

        ```cpp
        double runningTimeAvgerage_pct;
        outputNetworkVehicle->get_RunningTimeAvgerage_pct(&runningTimeAvgerage_pct);
        ```

    === "Python"

        ```python
        running_time_avgerage_pct = outputNetworkVehicle.RunningTimeAvgerage_pct
        ```

### DesiredTripTime_rate {#desiredtriptime_rate}

```csharp
float DesiredTripTime_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredTripTime_rate = outputNetworkVehicle.DesiredTripTime_rate;
        ```

    === "C++"

        ```cpp
        double desiredTripTime_rate;
        outputNetworkVehicle->get_DesiredTripTime_rate(&desiredTripTime_rate);
        ```

    === "Python"

        ```python
        desired_trip_time_rate = outputNetworkVehicle.DesiredTripTime_rate
        ```

### TravelDelay_rate {#traveldelay_rate}

```csharp
float TravelDelay_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay_rate = outputNetworkVehicle.TravelDelay_rate;
        ```

    === "C++"

        ```cpp
        double travelDelay_rate;
        outputNetworkVehicle->get_TravelDelay_rate(&travelDelay_rate);
        ```

    === "Python"

        ```python
        travel_delay_rate = outputNetworkVehicle.TravelDelay_rate
        ```

### TravelDelay_pct {#traveldelay_pct}

```csharp
float TravelDelay_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay_pct = outputNetworkVehicle.TravelDelay_pct;
        ```

    === "C++"

        ```cpp
        double travelDelay_pct;
        outputNetworkVehicle->get_TravelDelay_pct(&travelDelay_pct);
        ```

    === "Python"

        ```python
        travel_delay_pct = outputNetworkVehicle.TravelDelay_pct
        ```

### StopRate_rate {#stoprate_rate}

```csharp
float StopRate_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate_rate = outputNetworkVehicle.StopRate_rate;
        ```

    === "C++"

        ```cpp
        double stopRate_rate;
        outputNetworkVehicle->get_StopRate_rate(&stopRate_rate);
        ```

    === "Python"

        ```python
        stop_rate_rate = outputNetworkVehicle.StopRate_rate
        ```

### FuelConsumption_rate {#fuelconsumption_rate}

```csharp
float FuelConsumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelConsumption_rate = outputNetworkVehicle.FuelConsumption_rate;
        ```

    === "C++"

        ```cpp
        double fuelConsumption_rate;
        outputNetworkVehicle->get_FuelConsumption_rate(&fuelConsumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputNetworkVehicle.FuelConsumption_rate
        ```

### CarbonDioxide_rate {#carbondioxide_rate}

```csharp
float CarbonDioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonDioxide_rate = outputNetworkVehicle.CarbonDioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbonDioxide_rate;
        outputNetworkVehicle->get_CarbonDioxide_rate(&carbonDioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputNetworkVehicle.CarbonDioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputNetworkVehicle.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputNetworkVehicle->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputNetworkVehicle.Hydrocarbons_rate
        ```

### CarbonMonoxide_rate {#carbonmonoxide_rate}

```csharp
float CarbonMonoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonMonoxide_rate = outputNetworkVehicle.CarbonMonoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbonMonoxide_rate;
        outputNetworkVehicle->get_CarbonMonoxide_rate(&carbonMonoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputNetworkVehicle.CarbonMonoxide_rate
        ```

### Nox_rate {#nox_rate}

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputNetworkVehicle.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputNetworkVehicle->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputNetworkVehicle.Nox_rate
        ```

### FuelEconomy {#fueleconomy}

```csharp
float FuelEconomy { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelEconomy = outputNetworkVehicle.FuelEconomy;
        ```

    === "C++"

        ```cpp
        double fuelEconomy;
        outputNetworkVehicle->get_FuelEconomy(&fuelEconomy);
        ```

    === "Python"

        ```python
        fuel_economy = outputNetworkVehicle.FuelEconomy
        ```

### Min_dx_percent {#min_dx_percent}

```csharp
float Min_dx_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float min_dx_percent = outputNetworkVehicle.Min_dx_percent;
        ```

    === "C++"

        ```cpp
        double min_dx_percent;
        outputNetworkVehicle->get_Min_dx_percent(&min_dx_percent);
        ```

    === "Python"

        ```python
        min_dx_percent = outputNetworkVehicle.Min_dx_percent
        ```

### Max_dx_percent {#max_dx_percent}

```csharp
float Max_dx_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_dx_percent = outputNetworkVehicle.Max_dx_percent;
        ```

    === "C++"

        ```cpp
        double max_dx_percent;
        outputNetworkVehicle->get_Max_dx_percent(&max_dx_percent);
        ```

    === "Python"

        ```python
        max_dx_percent = outputNetworkVehicle.Max_dx_percent
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputNetworkVehicle.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputNetworkVehicle->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputNetworkVehicle.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputNetworkVehicle.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputNetworkVehicle->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputNetworkVehicle.DesiredSpeed
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputNetworkVehicle.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputNetworkVehicle->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputNetworkVehicle.TravelDelayAverage
        ```

### TravelDelayAverage_rate {#traveldelayaverage_rate}

```csharp
float TravelDelayAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage_rate = outputNetworkVehicle.TravelDelayAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage_rate;
        outputNetworkVehicle->get_TravelDelayAverage_rate(&travelDelayAverage_rate);
        ```

    === "Python"

        ```python
        travel_delay_average_rate = outputNetworkVehicle.TravelDelayAverage_rate
        ```

### Max_dx_percent_prev {#max_dx_percent_prev}

```csharp
float Max_dx_percent_prev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_dx_percent_prev = outputNetworkVehicle.Max_dx_percent_prev;
        ```

    === "C++"

        ```cpp
        double max_dx_percent_prev;
        outputNetworkVehicle->get_Max_dx_percent_prev(&max_dx_percent_prev);
        ```

    === "Python"

        ```python
        max_dx_percent_prev = outputNetworkVehicle.Max_dx_percent_prev
        ```

### Max_dx_percent_prev2 {#max_dx_percent_prev2}

```csharp
float Max_dx_percent_prev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_dx_percent_prev2 = outputNetworkVehicle.Max_dx_percent_prev2;
        ```

    === "C++"

        ```cpp
        double max_dx_percent_prev2;
        outputNetworkVehicle->get_Max_dx_percent_prev2(&max_dx_percent_prev2);
        ```

    === "Python"

        ```python
        max_dx_percent_prev2 = outputNetworkVehicle.Max_dx_percent_prev2
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputNetworkVehicle.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputNetworkVehicle->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputNetworkVehicle.Capacity_effective
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputNetworkVehicle.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputNetworkVehicle->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputNetworkVehicle.Practical_spare_capacity
        ```

### NwModel_vari_index {#nwmodel_vari_index}

```csharp
float NwModel_vari_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nwModel_vari_index = outputNetworkVehicle.NwModel_vari_index;
        ```

    === "C++"

        ```cpp
        double nwModel_vari_index;
        outputNetworkVehicle->get_NwModel_vari_index(&nwModel_vari_index);
        ```

    === "Python"

        ```python
        nw_model_vari_index = outputNetworkVehicle.NwModel_vari_index
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputNetworkVehicle.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputNetworkVehicle->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputNetworkVehicle.SpeedEfficiencyFlag
        ```

### OutputNetwork {#outputnetwork}

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = outputNetworkVehicle.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        outputNetworkVehicle->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = outputNetworkVehicle.OutputNetwork
        ```

### OutputNetworkVehicleMCs {#outputnetworkvehiclemcs}

```csharp
ISIAPIOutputNetworkVehicleMCs OutputNetworkVehicleMCs { get; }
```

**Type** [`ISIAPIOutputNetworkVehicleMCs`](sidrasolutions.si.api.isiapioutputnetworkvehiclemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkVehicleMCs = outputNetworkVehicle.OutputNetworkVehicleMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkVehicleMCs> outputNetworkVehicleMCs;
        outputNetworkVehicle->get_OutputNetworkVehicleMCs(&outputNetworkVehicleMCs);
        ```

    === "Python"

        ```python
        output_network_vehicle_m_cs = outputNetworkVehicle.OutputNetworkVehicleMCs
        ```

### DiffDelayControlAveragePct {#diffdelaycontrolaveragepct}

```csharp
float DiffDelayControlAveragePct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePct = outputNetworkVehicle.DiffDelayControlAveragePct;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePct;
        outputNetworkVehicle->get_DiffDelayControlAveragePct(&diffDelayControlAveragePct);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct = outputNetworkVehicle.DiffDelayControlAveragePct
        ```

### DiffDelayControlAveragePctPrev {#diffdelaycontrolaveragepctprev}

```csharp
float DiffDelayControlAveragePctPrev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePctPrev = outputNetworkVehicle.DiffDelayControlAveragePctPrev;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePctPrev;
        outputNetworkVehicle->get_DiffDelayControlAveragePctPrev(&diffDelayControlAveragePctPrev);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct_prev = outputNetworkVehicle.DiffDelayControlAveragePctPrev
        ```

### DiffDelayControlAveragePctPrev2 {#diffdelaycontrolaveragepctprev2}

```csharp
float DiffDelayControlAveragePctPrev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePctPrev2 = outputNetworkVehicle.DiffDelayControlAveragePctPrev2;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePctPrev2;
        outputNetworkVehicle->get_DiffDelayControlAveragePctPrev2(&diffDelayControlAveragePctPrev2);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct_prev2 = outputNetworkVehicle.DiffDelayControlAveragePctPrev2
        ```

### DiffSpeedEfficiencyPct {#diffspeedefficiencypct}

```csharp
float DiffSpeedEfficiencyPct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPct = outputNetworkVehicle.DiffSpeedEfficiencyPct;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPct;
        outputNetworkVehicle->get_DiffSpeedEfficiencyPct(&diffSpeedEfficiencyPct);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct = outputNetworkVehicle.DiffSpeedEfficiencyPct
        ```

### DiffSpeedEfficiencyPctPrev {#diffspeedefficiencypctprev}

```csharp
float DiffSpeedEfficiencyPctPrev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPctPrev = outputNetworkVehicle.DiffSpeedEfficiencyPctPrev;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPctPrev;
        outputNetworkVehicle->get_DiffSpeedEfficiencyPctPrev(&diffSpeedEfficiencyPctPrev);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct_prev = outputNetworkVehicle.DiffSpeedEfficiencyPctPrev
        ```

### DiffSpeedEfficiencyPctPrev2 {#diffspeedefficiencypctprev2}

```csharp
float DiffSpeedEfficiencyPctPrev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPctPrev2 = outputNetworkVehicle.DiffSpeedEfficiencyPctPrev2;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPctPrev2;
        outputNetworkVehicle->get_DiffSpeedEfficiencyPctPrev2(&diffSpeedEfficiencyPctPrev2);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct_prev2 = outputNetworkVehicle.DiffSpeedEfficiencyPctPrev2
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkvehiclemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkVehicleMC
title: OutputNetworkVehicleMC
name: ISIAPIOutputNetworkVehicleMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E6A493E3-8076-475C-8958-1C21EF27185E
members:
  - int MC_class
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float ArrivalFlowTotal
  - float DemandFlowTotal
  - float DegreeSaturation
  - float DelayControlTotal
  - float DelayControlAverage
  - float DelayControlAverageWorstLane
  - float DelayControlAverageWorstMovement
  - float DelayGeometricAverage
  - float DelayStoplineAverage
  - float StopsTotal
  - float StopRate
  - float ProportionQueued
  - float PerformanceIndex
  - float TravelDistanceTotal
  - float TravelTimeTotal
  - float OperatingCostTotal
  - float FuelConsumptionTotal
  - float CarbonDioxideTotal
  - float HydrocarbonsTotal
  - float CarbonMonoxideTotal
  - float NoxTotal
  - float SpeedEfficiency
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelDistanceAverage
  - float TravelTimeAverage
  - float TravelSpeed
  - float DesiredTripTime
  - float TravelDelay
  - float TravelDelayAverage
  - float IdlingTimeAvg
  - float RunningTimeAvg
  - float TravelTimeIndex
  - float QueueStorageRatioMaximum
  - float QueueStorageRatioAverage
  - string LevelOfService
  - float OperatingCost_rate
  - float TravelTimeAverage_rate
  - float IdlingTimeAvgerage_rate
  - float IdlingTimeAvgerage_pct
  - float RunningTimeAvgerage_rate
  - float RunningTimeAvgerage_pct
  - float DesiredTripTime_rate
  - float TravelDelay_rate
  - float TravelDelay_pct
  - float TravelDelayAverage_rate
  - float StopRate_rate
  - float FuelConsumption_rate
  - float CarbonDioxide_rate
  - float Hydrocarbons_rate
  - float CarbonMonoxide_rate
  - float Nox_rate
  - float FuelEconomy
  - float Capacity_effective
  - float Practical_spare_capacity
  - ISIAPIOutputNetworkVehicle OutputNetworkVehicle
---

# OutputNetworkVehicleMC

Type `ISIAPIOutputNetworkVehicleMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E6A493E3-8076-475C-8958-1C21EF27185E`

## Declaration

```csharp
[Guid("E6A493E3-8076-475C-8958-1C21EF27185E")]
public interface ISIAPIOutputNetworkVehicleMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [ArrivalFlowTotal](#arrivalflowtotal) | `float` |  |
| [DemandFlowTotal](#demandflowtotal) | `float` |  |
| [DegreeSaturation](#degreesaturation) | `float` |  |
| [DelayControlTotal](#delaycontroltotal) | `float` |  |
| [DelayControlAverage](#delaycontrolaverage) | `float` |  |
| [DelayControlAverageWorstLane](#delaycontrolaverageworstlane) | `float` |  |
| [DelayControlAverageWorstMovement](#delaycontrolaverageworstmovement) | `float` |  |
| [DelayGeometricAverage](#delaygeometricaverage) | `float` |  |
| [DelayStoplineAverage](#delaystoplineaverage) | `float` |  |
| [StopsTotal](#stopstotal) | `float` |  |
| [StopRate](#stoprate) | `float` |  |
| [ProportionQueued](#proportionqueued) | `float` |  |
| [PerformanceIndex](#performanceindex) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [OperatingCostTotal](#operatingcosttotal) | `float` |  |
| [FuelConsumptionTotal](#fuelconsumptiontotal) | `float` |  |
| [CarbonDioxideTotal](#carbondioxidetotal) | `float` |  |
| [HydrocarbonsTotal](#hydrocarbonstotal) | `float` |  |
| [CarbonMonoxideTotal](#carbonmonoxidetotal) | `float` |  |
| [NoxTotal](#noxtotal) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelSpeed](#travelspeed) | `float` |  |
| [DesiredTripTime](#desiredtriptime) | `float` |  |
| [TravelDelay](#traveldelay) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [IdlingTimeAvg](#idlingtimeavg) | `float` |  |
| [RunningTimeAvg](#runningtimeavg) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [QueueStorageRatioMaximum](#queuestorageratiomaximum) | `float` |  |
| [QueueStorageRatioAverage](#queuestorageratioaverage) | `float` |  |
| [LevelOfService](#levelofservice) | `string` |  |
| [OperatingCost_rate](#operatingcost_rate) | `float` |  |
| [TravelTimeAverage_rate](#traveltimeaverage_rate) | `float` |  |
| [IdlingTimeAvgerage_rate](#idlingtimeavgerage_rate) | `float` |  |
| [IdlingTimeAvgerage_pct](#idlingtimeavgerage_pct) | `float` |  |
| [RunningTimeAvgerage_rate](#runningtimeavgerage_rate) | `float` |  |
| [RunningTimeAvgerage_pct](#runningtimeavgerage_pct) | `float` |  |
| [DesiredTripTime_rate](#desiredtriptime_rate) | `float` |  |
| [TravelDelay_rate](#traveldelay_rate) | `float` |  |
| [TravelDelay_pct](#traveldelay_pct) | `float` |  |
| [TravelDelayAverage_rate](#traveldelayaverage_rate) | `float` |  |
| [StopRate_rate](#stoprate_rate) | `float` |  |
| [FuelConsumption_rate](#fuelconsumption_rate) | `float` |  |
| [CarbonDioxide_rate](#carbondioxide_rate) | `float` |  |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` |  |
| [CarbonMonoxide_rate](#carbonmonoxide_rate) | `float` |  |
| [Nox_rate](#nox_rate) | `float` |  |
| [FuelEconomy](#fueleconomy) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [OutputNetworkVehicle](#outputnetworkvehicle) | [`ISIAPIOutputNetworkVehicle`](sidrasolutions.si.api.isiapioutputnetworkvehicle.md) |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputNetworkVehicleMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputNetworkVehicleMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputNetworkVehicleMC.MC_class
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputNetworkVehicleMC.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputNetworkVehicleMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputNetworkVehicleMC.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputNetworkVehicleMC.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputNetworkVehicleMC->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputNetworkVehicleMC.DesiredSpeed
        ```

### ArrivalFlowTotal {#arrivalflowtotal}

```csharp
float ArrivalFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrivalFlowTotal = outputNetworkVehicleMC.ArrivalFlowTotal;
        ```

    === "C++"

        ```cpp
        double arrivalFlowTotal;
        outputNetworkVehicleMC->get_ArrivalFlowTotal(&arrivalFlowTotal);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputNetworkVehicleMC.ArrivalFlowTotal
        ```

### DemandFlowTotal {#demandflowtotal}

```csharp
float DemandFlowTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demandFlowTotal = outputNetworkVehicleMC.DemandFlowTotal;
        ```

    === "C++"

        ```cpp
        double demandFlowTotal;
        outputNetworkVehicleMC->get_DemandFlowTotal(&demandFlowTotal);
        ```

    === "Python"

        ```python
        demand_flow_total = outputNetworkVehicleMC.DemandFlowTotal
        ```

### DegreeSaturation {#degreesaturation}

```csharp
float DegreeSaturation { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float degreeSaturation = outputNetworkVehicleMC.DegreeSaturation;
        ```

    === "C++"

        ```cpp
        double degreeSaturation;
        outputNetworkVehicleMC->get_DegreeSaturation(&degreeSaturation);
        ```

    === "Python"

        ```python
        degree_saturation = outputNetworkVehicleMC.DegreeSaturation
        ```

### DelayControlTotal {#delaycontroltotal}

```csharp
float DelayControlTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlTotal = outputNetworkVehicleMC.DelayControlTotal;
        ```

    === "C++"

        ```cpp
        double delayControlTotal;
        outputNetworkVehicleMC->get_DelayControlTotal(&delayControlTotal);
        ```

    === "Python"

        ```python
        delay_control_total = outputNetworkVehicleMC.DelayControlTotal
        ```

### DelayControlAverage {#delaycontrolaverage}

```csharp
float DelayControlAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverage = outputNetworkVehicleMC.DelayControlAverage;
        ```

    === "C++"

        ```cpp
        double delayControlAverage;
        outputNetworkVehicleMC->get_DelayControlAverage(&delayControlAverage);
        ```

    === "Python"

        ```python
        delay_control_average = outputNetworkVehicleMC.DelayControlAverage
        ```

### DelayControlAverageWorstLane {#delaycontrolaverageworstlane}

```csharp
float DelayControlAverageWorstLane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstLane = outputNetworkVehicleMC.DelayControlAverageWorstLane;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstLane;
        outputNetworkVehicleMC->get_DelayControlAverageWorstLane(&delayControlAverageWorstLane);
        ```

    === "Python"

        ```python
        delay_control_average_worst_lane = outputNetworkVehicleMC.DelayControlAverageWorstLane
        ```

### DelayControlAverageWorstMovement {#delaycontrolaverageworstmovement}

```csharp
float DelayControlAverageWorstMovement { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayControlAverageWorstMovement = outputNetworkVehicleMC.DelayControlAverageWorstMovement;
        ```

    === "C++"

        ```cpp
        double delayControlAverageWorstMovement;
        outputNetworkVehicleMC->get_DelayControlAverageWorstMovement(&delayControlAverageWorstMovement);
        ```

    === "Python"

        ```python
        delay_control_average_worst_movement = outputNetworkVehicleMC.DelayControlAverageWorstMovement
        ```

### DelayGeometricAverage {#delaygeometricaverage}

```csharp
float DelayGeometricAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayGeometricAverage = outputNetworkVehicleMC.DelayGeometricAverage;
        ```

    === "C++"

        ```cpp
        double delayGeometricAverage;
        outputNetworkVehicleMC->get_DelayGeometricAverage(&delayGeometricAverage);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputNetworkVehicleMC.DelayGeometricAverage
        ```

### DelayStoplineAverage {#delaystoplineaverage}

```csharp
float DelayStoplineAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delayStoplineAverage = outputNetworkVehicleMC.DelayStoplineAverage;
        ```

    === "C++"

        ```cpp
        double delayStoplineAverage;
        outputNetworkVehicleMC->get_DelayStoplineAverage(&delayStoplineAverage);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputNetworkVehicleMC.DelayStoplineAverage
        ```

### StopsTotal {#stopstotal}

```csharp
float StopsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopsTotal = outputNetworkVehicleMC.StopsTotal;
        ```

    === "C++"

        ```cpp
        double stopsTotal;
        outputNetworkVehicleMC->get_StopsTotal(&stopsTotal);
        ```

    === "Python"

        ```python
        stops_total = outputNetworkVehicleMC.StopsTotal
        ```

### StopRate {#stoprate}

```csharp
float StopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate = outputNetworkVehicleMC.StopRate;
        ```

    === "C++"

        ```cpp
        double stopRate;
        outputNetworkVehicleMC->get_StopRate(&stopRate);
        ```

    === "Python"

        ```python
        stop_rate = outputNetworkVehicleMC.StopRate
        ```

### ProportionQueued {#proportionqueued}

```csharp
float ProportionQueued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportionQueued = outputNetworkVehicleMC.ProportionQueued;
        ```

    === "C++"

        ```cpp
        double proportionQueued;
        outputNetworkVehicleMC->get_ProportionQueued(&proportionQueued);
        ```

    === "Python"

        ```python
        proportion_queued = outputNetworkVehicleMC.ProportionQueued
        ```

### PerformanceIndex {#performanceindex}

```csharp
float PerformanceIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performanceIndex = outputNetworkVehicleMC.PerformanceIndex;
        ```

    === "C++"

        ```cpp
        double performanceIndex;
        outputNetworkVehicleMC->get_PerformanceIndex(&performanceIndex);
        ```

    === "Python"

        ```python
        performance_index = outputNetworkVehicleMC.PerformanceIndex
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputNetworkVehicleMC.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputNetworkVehicleMC->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputNetworkVehicleMC.TravelDistanceTotal
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputNetworkVehicleMC.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputNetworkVehicleMC->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputNetworkVehicleMC.TravelTimeTotal
        ```

### OperatingCostTotal {#operatingcosttotal}

```csharp
float OperatingCostTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCostTotal = outputNetworkVehicleMC.OperatingCostTotal;
        ```

    === "C++"

        ```cpp
        double operatingCostTotal;
        outputNetworkVehicleMC->get_OperatingCostTotal(&operatingCostTotal);
        ```

    === "Python"

        ```python
        operating_cost_total = outputNetworkVehicleMC.OperatingCostTotal
        ```

### FuelConsumptionTotal {#fuelconsumptiontotal}

```csharp
float FuelConsumptionTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelConsumptionTotal = outputNetworkVehicleMC.FuelConsumptionTotal;
        ```

    === "C++"

        ```cpp
        double fuelConsumptionTotal;
        outputNetworkVehicleMC->get_FuelConsumptionTotal(&fuelConsumptionTotal);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputNetworkVehicleMC.FuelConsumptionTotal
        ```

### CarbonDioxideTotal {#carbondioxidetotal}

```csharp
float CarbonDioxideTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonDioxideTotal = outputNetworkVehicleMC.CarbonDioxideTotal;
        ```

    === "C++"

        ```cpp
        double carbonDioxideTotal;
        outputNetworkVehicleMC->get_CarbonDioxideTotal(&carbonDioxideTotal);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputNetworkVehicleMC.CarbonDioxideTotal
        ```

### HydrocarbonsTotal {#hydrocarbonstotal}

```csharp
float HydrocarbonsTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbonsTotal = outputNetworkVehicleMC.HydrocarbonsTotal;
        ```

    === "C++"

        ```cpp
        double hydrocarbonsTotal;
        outputNetworkVehicleMC->get_HydrocarbonsTotal(&hydrocarbonsTotal);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputNetworkVehicleMC.HydrocarbonsTotal
        ```

### CarbonMonoxideTotal {#carbonmonoxidetotal}

```csharp
float CarbonMonoxideTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonMonoxideTotal = outputNetworkVehicleMC.CarbonMonoxideTotal;
        ```

    === "C++"

        ```cpp
        double carbonMonoxideTotal;
        outputNetworkVehicleMC->get_CarbonMonoxideTotal(&carbonMonoxideTotal);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputNetworkVehicleMC.CarbonMonoxideTotal
        ```

### NoxTotal {#noxtotal}

```csharp
float NoxTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float noxTotal = outputNetworkVehicleMC.NoxTotal;
        ```

    === "C++"

        ```cpp
        double noxTotal;
        outputNetworkVehicleMC->get_NoxTotal(&noxTotal);
        ```

    === "Python"

        ```python
        nox_total = outputNetworkVehicleMC.NoxTotal
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputNetworkVehicleMC.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputNetworkVehicleMC->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputNetworkVehicleMC.SpeedEfficiency
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputNetworkVehicleMC.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputNetworkVehicleMC->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputNetworkVehicleMC.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputNetworkVehicleMC.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputNetworkVehicleMC->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputNetworkVehicleMC.CongestionCoefficient
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputNetworkVehicleMC.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputNetworkVehicleMC->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputNetworkVehicleMC.TravelDistanceAverage
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputNetworkVehicleMC.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputNetworkVehicleMC->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputNetworkVehicleMC.TravelTimeAverage
        ```

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputNetworkVehicleMC.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputNetworkVehicleMC->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputNetworkVehicleMC.TravelSpeed
        ```

### DesiredTripTime {#desiredtriptime}

```csharp
float DesiredTripTime { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredTripTime = outputNetworkVehicleMC.DesiredTripTime;
        ```

    === "C++"

        ```cpp
        double desiredTripTime;
        outputNetworkVehicleMC->get_DesiredTripTime(&desiredTripTime);
        ```

    === "Python"

        ```python
        desired_trip_time = outputNetworkVehicleMC.DesiredTripTime
        ```

### TravelDelay {#traveldelay}

```csharp
float TravelDelay { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay = outputNetworkVehicleMC.TravelDelay;
        ```

    === "C++"

        ```cpp
        double travelDelay;
        outputNetworkVehicleMC->get_TravelDelay(&travelDelay);
        ```

    === "Python"

        ```python
        travel_delay = outputNetworkVehicleMC.TravelDelay
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputNetworkVehicleMC.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputNetworkVehicleMC->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputNetworkVehicleMC.TravelDelayAverage
        ```

### IdlingTimeAvg {#idlingtimeavg}

```csharp
float IdlingTimeAvg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvg = outputNetworkVehicleMC.IdlingTimeAvg;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvg;
        outputNetworkVehicleMC->get_IdlingTimeAvg(&idlingTimeAvg);
        ```

    === "Python"

        ```python
        idling_time_avg = outputNetworkVehicleMC.IdlingTimeAvg
        ```

### RunningTimeAvg {#runningtimeavg}

```csharp
float RunningTimeAvg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvg = outputNetworkVehicleMC.RunningTimeAvg;
        ```

    === "C++"

        ```cpp
        double runningTimeAvg;
        outputNetworkVehicleMC->get_RunningTimeAvg(&runningTimeAvg);
        ```

    === "Python"

        ```python
        running_time_avg = outputNetworkVehicleMC.RunningTimeAvg
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputNetworkVehicleMC.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputNetworkVehicleMC->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputNetworkVehicleMC.TravelTimeIndex
        ```

### QueueStorageRatioMaximum {#queuestorageratiomaximum}

```csharp
float QueueStorageRatioMaximum { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queueStorageRatioMaximum = outputNetworkVehicleMC.QueueStorageRatioMaximum;
        ```

    === "C++"

        ```cpp
        double queueStorageRatioMaximum;
        outputNetworkVehicleMC->get_QueueStorageRatioMaximum(&queueStorageRatioMaximum);
        ```

    === "Python"

        ```python
        queue_storage_ratio_maximum = outputNetworkVehicleMC.QueueStorageRatioMaximum
        ```

### QueueStorageRatioAverage {#queuestorageratioaverage}

```csharp
float QueueStorageRatioAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queueStorageRatioAverage = outputNetworkVehicleMC.QueueStorageRatioAverage;
        ```

    === "C++"

        ```cpp
        double queueStorageRatioAverage;
        outputNetworkVehicleMC->get_QueueStorageRatioAverage(&queueStorageRatioAverage);
        ```

    === "Python"

        ```python
        queue_storage_ratio_average = outputNetworkVehicleMC.QueueStorageRatioAverage
        ```

### LevelOfService {#levelofservice}

```csharp
string LevelOfService { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string levelOfService = outputNetworkVehicleMC.LevelOfService;
        ```

    === "C++"

        ```cpp
        CComBSTR levelOfService;
        outputNetworkVehicleMC->get_LevelOfService(&levelOfService);
        ```

    === "Python"

        ```python
        level_of_service = outputNetworkVehicleMC.LevelOfService
        ```

### OperatingCost_rate {#operatingcost_rate}

```csharp
float OperatingCost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operatingCost_rate = outputNetworkVehicleMC.OperatingCost_rate;
        ```

    === "C++"

        ```cpp
        double operatingCost_rate;
        outputNetworkVehicleMC->get_OperatingCost_rate(&operatingCost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputNetworkVehicleMC.OperatingCost_rate
        ```

### TravelTimeAverage_rate {#traveltimeaverage_rate}

```csharp
float TravelTimeAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage_rate = outputNetworkVehicleMC.TravelTimeAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage_rate;
        outputNetworkVehicleMC->get_TravelTimeAverage_rate(&travelTimeAverage_rate);
        ```

    === "Python"

        ```python
        travel_time_average_rate = outputNetworkVehicleMC.TravelTimeAverage_rate
        ```

### IdlingTimeAvgerage_rate {#idlingtimeavgerage_rate}

```csharp
float IdlingTimeAvgerage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvgerage_rate = outputNetworkVehicleMC.IdlingTimeAvgerage_rate;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvgerage_rate;
        outputNetworkVehicleMC->get_IdlingTimeAvgerage_rate(&idlingTimeAvgerage_rate);
        ```

    === "Python"

        ```python
        idling_time_avgerage_rate = outputNetworkVehicleMC.IdlingTimeAvgerage_rate
        ```

### IdlingTimeAvgerage_pct {#idlingtimeavgerage_pct}

```csharp
float IdlingTimeAvgerage_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idlingTimeAvgerage_pct = outputNetworkVehicleMC.IdlingTimeAvgerage_pct;
        ```

    === "C++"

        ```cpp
        double idlingTimeAvgerage_pct;
        outputNetworkVehicleMC->get_IdlingTimeAvgerage_pct(&idlingTimeAvgerage_pct);
        ```

    === "Python"

        ```python
        idling_time_avgerage_pct = outputNetworkVehicleMC.IdlingTimeAvgerage_pct
        ```

### RunningTimeAvgerage_rate {#runningtimeavgerage_rate}

```csharp
float RunningTimeAvgerage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvgerage_rate = outputNetworkVehicleMC.RunningTimeAvgerage_rate;
        ```

    === "C++"

        ```cpp
        double runningTimeAvgerage_rate;
        outputNetworkVehicleMC->get_RunningTimeAvgerage_rate(&runningTimeAvgerage_rate);
        ```

    === "Python"

        ```python
        running_time_avgerage_rate = outputNetworkVehicleMC.RunningTimeAvgerage_rate
        ```

### RunningTimeAvgerage_pct {#runningtimeavgerage_pct}

```csharp
float RunningTimeAvgerage_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float runningTimeAvgerage_pct = outputNetworkVehicleMC.RunningTimeAvgerage_pct;
        ```

    === "C++"

        ```cpp
        double runningTimeAvgerage_pct;
        outputNetworkVehicleMC->get_RunningTimeAvgerage_pct(&runningTimeAvgerage_pct);
        ```

    === "Python"

        ```python
        running_time_avgerage_pct = outputNetworkVehicleMC.RunningTimeAvgerage_pct
        ```

### DesiredTripTime_rate {#desiredtriptime_rate}

```csharp
float DesiredTripTime_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredTripTime_rate = outputNetworkVehicleMC.DesiredTripTime_rate;
        ```

    === "C++"

        ```cpp
        double desiredTripTime_rate;
        outputNetworkVehicleMC->get_DesiredTripTime_rate(&desiredTripTime_rate);
        ```

    === "Python"

        ```python
        desired_trip_time_rate = outputNetworkVehicleMC.DesiredTripTime_rate
        ```

### TravelDelay_rate {#traveldelay_rate}

```csharp
float TravelDelay_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay_rate = outputNetworkVehicleMC.TravelDelay_rate;
        ```

    === "C++"

        ```cpp
        double travelDelay_rate;
        outputNetworkVehicleMC->get_TravelDelay_rate(&travelDelay_rate);
        ```

    === "Python"

        ```python
        travel_delay_rate = outputNetworkVehicleMC.TravelDelay_rate
        ```

### TravelDelay_pct {#traveldelay_pct}

```csharp
float TravelDelay_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelay_pct = outputNetworkVehicleMC.TravelDelay_pct;
        ```

    === "C++"

        ```cpp
        double travelDelay_pct;
        outputNetworkVehicleMC->get_TravelDelay_pct(&travelDelay_pct);
        ```

    === "Python"

        ```python
        travel_delay_pct = outputNetworkVehicleMC.TravelDelay_pct
        ```

### TravelDelayAverage_rate {#traveldelayaverage_rate}

```csharp
float TravelDelayAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage_rate = outputNetworkVehicleMC.TravelDelayAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage_rate;
        outputNetworkVehicleMC->get_TravelDelayAverage_rate(&travelDelayAverage_rate);
        ```

    === "Python"

        ```python
        travel_delay_average_rate = outputNetworkVehicleMC.TravelDelayAverage_rate
        ```

### StopRate_rate {#stoprate_rate}

```csharp
float StopRate_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stopRate_rate = outputNetworkVehicleMC.StopRate_rate;
        ```

    === "C++"

        ```cpp
        double stopRate_rate;
        outputNetworkVehicleMC->get_StopRate_rate(&stopRate_rate);
        ```

    === "Python"

        ```python
        stop_rate_rate = outputNetworkVehicleMC.StopRate_rate
        ```

### FuelConsumption_rate {#fuelconsumption_rate}

```csharp
float FuelConsumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelConsumption_rate = outputNetworkVehicleMC.FuelConsumption_rate;
        ```

    === "C++"

        ```cpp
        double fuelConsumption_rate;
        outputNetworkVehicleMC->get_FuelConsumption_rate(&fuelConsumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputNetworkVehicleMC.FuelConsumption_rate
        ```

### CarbonDioxide_rate {#carbondioxide_rate}

```csharp
float CarbonDioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonDioxide_rate = outputNetworkVehicleMC.CarbonDioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbonDioxide_rate;
        outputNetworkVehicleMC->get_CarbonDioxide_rate(&carbonDioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputNetworkVehicleMC.CarbonDioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputNetworkVehicleMC.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputNetworkVehicleMC->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputNetworkVehicleMC.Hydrocarbons_rate
        ```

### CarbonMonoxide_rate {#carbonmonoxide_rate}

```csharp
float CarbonMonoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbonMonoxide_rate = outputNetworkVehicleMC.CarbonMonoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbonMonoxide_rate;
        outputNetworkVehicleMC->get_CarbonMonoxide_rate(&carbonMonoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputNetworkVehicleMC.CarbonMonoxide_rate
        ```

### Nox_rate {#nox_rate}

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputNetworkVehicleMC.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputNetworkVehicleMC->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputNetworkVehicleMC.Nox_rate
        ```

### FuelEconomy {#fueleconomy}

```csharp
float FuelEconomy { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuelEconomy = outputNetworkVehicleMC.FuelEconomy;
        ```

    === "C++"

        ```cpp
        double fuelEconomy;
        outputNetworkVehicleMC->get_FuelEconomy(&fuelEconomy);
        ```

    === "Python"

        ```python
        fuel_economy = outputNetworkVehicleMC.FuelEconomy
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputNetworkVehicleMC.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputNetworkVehicleMC->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputNetworkVehicleMC.Capacity_effective
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputNetworkVehicleMC.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputNetworkVehicleMC->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputNetworkVehicleMC.Practical_spare_capacity
        ```

### OutputNetworkVehicle {#outputnetworkvehicle}

```csharp
ISIAPIOutputNetworkVehicle OutputNetworkVehicle { get; }
```

**Type** [`ISIAPIOutputNetworkVehicle`](sidrasolutions.si.api.isiapioutputnetworkvehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetworkVehicle = outputNetworkVehicleMC.OutputNetworkVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkVehicle> outputNetworkVehicle;
        outputNetworkVehicleMC->get_OutputNetworkVehicle(&outputNetworkVehicle);
        ```

    === "Python"

        ```python
        output_network_vehicle = outputNetworkVehicleMC.OutputNetworkVehicle
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputnetworkvehiclemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputNetworkVehicleMCs
title: OutputNetworkVehicleMCs
name: ISIAPIOutputNetworkVehicleMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1B71EC61-529F-4485-95B8-3CC409BAD0FF
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputNetworkVehicleMC this[int mcClass]
  - int Count
---

# OutputNetworkVehicleMCs

Type `ISIAPIOutputNetworkVehicleMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1B71EC61-529F-4485-95B8-3CC409BAD0FF`

## Declaration

```csharp
[Guid("1B71EC61-529F-4485-95B8-3CC409BAD0FF")]
public interface ISIAPIOutputNetworkVehicleMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputNetworkVehicleMC`](sidrasolutions.si.api.isiapioutputnetworkvehiclemc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputNetworkVehicleMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputNetworkVehicleMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputNetworkVehicleMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputNetworkVehicleMC this[] { get; }
```

**Type** [`ISIAPIOutputNetworkVehicleMC`](sidrasolutions.si.api.isiapioutputnetworkvehiclemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputNetworkVehicleMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetworkVehicleMC> this[];
        outputNetworkVehicleMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputNetworkVehicleMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputNetworkVehicleMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputNetworkVehicleMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputNetworkVehicleMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphase.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhase
title: OutputPhase
name: ISIAPIOutputPhase
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 7CB21F0B-ACFD-4F83-B570-91B450AADF8D
members:
  - int Position
  - float Phase_time
  - float Displayed_green_time
  - float Change_time
  - float Green_start
  - float Green_end
  - float Start_intergreen
  - float Terminating_intergreen
  - float Phase_split_percent
  - bool Has_dummy
  - float Dummy_lost_time
  - float Dummy_reqd_time
  - float Dummy_eff_green
  - int Critical_dummy_mov_flag
  - bool IsReferencePhase
  - float Offset_change_time
  - float Dummy_adj_lost_time
  - float Dummy_adj_flow_ratio
  - float Dummy_reqd_green_time_ratio
  - float Dummy_tmin
  - float Dummy_tmax
  - int Dummy_min_max_flag
  - float Yellow_time
  - float All_red_time
  - float Phase_frequency
  - int Phase_frequency_option
---

# OutputPhase

Type `ISIAPIOutputPhase` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `7CB21F0B-ACFD-4F83-B570-91B450AADF8D`

## Declaration

```csharp
[Guid("7CB21F0B-ACFD-4F83-B570-91B450AADF8D")]
public interface ISIAPIOutputPhase
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Position](#position) | `int` | The corresponding Phase Input data position in the collection, i.e. ISIAPIPhase.Position or ISIAPINetworkCCGPhase.Position |
| [Phase_time](#phase_time) | `float` |  |
| [Displayed_green_time](#displayed_green_time) | `float` |  |
| [Change_time](#change_time) | `float` |  |
| [Green_start](#green_start) | `float` |  |
| [Green_end](#green_end) | `float` |  |
| [Start_intergreen](#start_intergreen) | `float` |  |
| [Terminating_intergreen](#terminating_intergreen) | `float` |  |
| [Phase_split_percent](#phase_split_percent) | `float` |  |
| [Has_dummy](#has_dummy) | `bool` |  |
| [Dummy_lost_time](#dummy_lost_time) | `float` |  |
| [Dummy_reqd_time](#dummy_reqd_time) | `float` |  |
| [Dummy_eff_green](#dummy_eff_green) | `float` |  |
| [Critical_dummy_mov_flag](#critical_dummy_mov_flag) | `int` |  |
| [IsReferencePhase](#isreferencephase) | `bool` |  |
| [Offset_change_time](#offset_change_time) | `float` |  |
| [Dummy_adj_lost_time](#dummy_adj_lost_time) | `float` |  |
| [Dummy_adj_flow_ratio](#dummy_adj_flow_ratio) | `float` |  |
| [Dummy_reqd_green_time_ratio](#dummy_reqd_green_time_ratio) | `float` |  |
| [Dummy_tmin](#dummy_tmin) | `float` |  |
| [Dummy_tmax](#dummy_tmax) | `float` |  |
| [Dummy_min_max_flag](#dummy_min_max_flag) | `int` |  |
| [Yellow_time](#yellow_time) | `float` |  |
| [All_red_time](#all_red_time) | `float` |  |
| [Phase_frequency](#phase_frequency) | `float` |  |
| [Phase_frequency_option](#phase_frequency_option) | `int` | Phase Frequency Option |

</div>

## Properties

### Position {#position}

The corresponding Phase Input data position in the collection, i.e. ISIAPIPhase.Position or ISIAPINetworkCCGPhase.Position

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = outputPhase.Position;
        ```

    === "C++"

        ```cpp
        long position;
        outputPhase->get_Position(&position);
        ```

    === "Python"

        ```python
        position = outputPhase.Position
        ```

### Phase_time {#phase_time}

```csharp
float Phase_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_time = outputPhase.Phase_time;
        ```

    === "C++"

        ```cpp
        double phase_time;
        outputPhase->get_Phase_time(&phase_time);
        ```

    === "Python"

        ```python
        phase_time = outputPhase.Phase_time
        ```

### Displayed_green_time {#displayed_green_time}

```csharp
float Displayed_green_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float displayed_green_time = outputPhase.Displayed_green_time;
        ```

    === "C++"

        ```cpp
        double displayed_green_time;
        outputPhase->get_Displayed_green_time(&displayed_green_time);
        ```

    === "Python"

        ```python
        displayed_green_time = outputPhase.Displayed_green_time
        ```

### Change_time {#change_time}

```csharp
float Change_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float change_time = outputPhase.Change_time;
        ```

    === "C++"

        ```cpp
        double change_time;
        outputPhase->get_Change_time(&change_time);
        ```

    === "Python"

        ```python
        change_time = outputPhase.Change_time
        ```

### Green_start {#green_start}

```csharp
float Green_start { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_start = outputPhase.Green_start;
        ```

    === "C++"

        ```cpp
        double green_start;
        outputPhase->get_Green_start(&green_start);
        ```

    === "Python"

        ```python
        green_start = outputPhase.Green_start
        ```

### Green_end {#green_end}

```csharp
float Green_end { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_end = outputPhase.Green_end;
        ```

    === "C++"

        ```cpp
        double green_end;
        outputPhase->get_Green_end(&green_end);
        ```

    === "Python"

        ```python
        green_end = outputPhase.Green_end
        ```

### Start_intergreen {#start_intergreen}

```csharp
float Start_intergreen { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float start_intergreen = outputPhase.Start_intergreen;
        ```

    === "C++"

        ```cpp
        double start_intergreen;
        outputPhase->get_Start_intergreen(&start_intergreen);
        ```

    === "Python"

        ```python
        start_intergreen = outputPhase.Start_intergreen
        ```

### Terminating_intergreen {#terminating_intergreen}

```csharp
float Terminating_intergreen { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float terminating_intergreen = outputPhase.Terminating_intergreen;
        ```

    === "C++"

        ```cpp
        double terminating_intergreen;
        outputPhase->get_Terminating_intergreen(&terminating_intergreen);
        ```

    === "Python"

        ```python
        terminating_intergreen = outputPhase.Terminating_intergreen
        ```

### Phase_split_percent {#phase_split_percent}

```csharp
float Phase_split_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_split_percent = outputPhase.Phase_split_percent;
        ```

    === "C++"

        ```cpp
        double phase_split_percent;
        outputPhase->get_Phase_split_percent(&phase_split_percent);
        ```

    === "Python"

        ```python
        phase_split_percent = outputPhase.Phase_split_percent
        ```

### Has_dummy {#has_dummy}

```csharp
bool Has_dummy { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_dummy = outputPhase.Has_dummy;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_dummy;
        outputPhase->get_Has_dummy(&has_dummy);
        ```

    === "Python"

        ```python
        has_dummy = outputPhase.Has_dummy
        ```

### Dummy_lost_time {#dummy_lost_time}

```csharp
float Dummy_lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_lost_time = outputPhase.Dummy_lost_time;
        ```

    === "C++"

        ```cpp
        double dummy_lost_time;
        outputPhase->get_Dummy_lost_time(&dummy_lost_time);
        ```

    === "Python"

        ```python
        dummy_lost_time = outputPhase.Dummy_lost_time
        ```

### Dummy_reqd_time {#dummy_reqd_time}

```csharp
float Dummy_reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_reqd_time = outputPhase.Dummy_reqd_time;
        ```

    === "C++"

        ```cpp
        double dummy_reqd_time;
        outputPhase->get_Dummy_reqd_time(&dummy_reqd_time);
        ```

    === "Python"

        ```python
        dummy_reqd_time = outputPhase.Dummy_reqd_time
        ```

### Dummy_eff_green {#dummy_eff_green}

```csharp
float Dummy_eff_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_eff_green = outputPhase.Dummy_eff_green;
        ```

    === "C++"

        ```cpp
        double dummy_eff_green;
        outputPhase->get_Dummy_eff_green(&dummy_eff_green);
        ```

    === "Python"

        ```python
        dummy_eff_green = outputPhase.Dummy_eff_green
        ```

### Critical_dummy_mov_flag {#critical_dummy_mov_flag}

```csharp
int Critical_dummy_mov_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int critical_dummy_mov_flag = outputPhase.Critical_dummy_mov_flag;
        ```

    === "C++"

        ```cpp
        long critical_dummy_mov_flag;
        outputPhase->get_Critical_dummy_mov_flag(&critical_dummy_mov_flag);
        ```

    === "Python"

        ```python
        critical_dummy_mov_flag = outputPhase.Critical_dummy_mov_flag
        ```

### IsReferencePhase {#isreferencephase}

```csharp
bool IsReferencePhase { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isReferencePhase = outputPhase.IsReferencePhase;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isReferencePhase;
        outputPhase->get_IsReferencePhase(&isReferencePhase);
        ```

    === "Python"

        ```python
        is_reference_phase = outputPhase.IsReferencePhase
        ```

### Offset_change_time {#offset_change_time}

```csharp
float Offset_change_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float offset_change_time = outputPhase.Offset_change_time;
        ```

    === "C++"

        ```cpp
        double offset_change_time;
        outputPhase->get_Offset_change_time(&offset_change_time);
        ```

    === "Python"

        ```python
        offset_change_time = outputPhase.Offset_change_time
        ```

### Dummy_adj_lost_time {#dummy_adj_lost_time}

```csharp
float Dummy_adj_lost_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_adj_lost_time = outputPhase.Dummy_adj_lost_time;
        ```

    === "C++"

        ```cpp
        double dummy_adj_lost_time;
        outputPhase->get_Dummy_adj_lost_time(&dummy_adj_lost_time);
        ```

    === "Python"

        ```python
        dummy_adj_lost_time = outputPhase.Dummy_adj_lost_time
        ```

### Dummy_adj_flow_ratio {#dummy_adj_flow_ratio}

```csharp
float Dummy_adj_flow_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_adj_flow_ratio = outputPhase.Dummy_adj_flow_ratio;
        ```

    === "C++"

        ```cpp
        double dummy_adj_flow_ratio;
        outputPhase->get_Dummy_adj_flow_ratio(&dummy_adj_flow_ratio);
        ```

    === "Python"

        ```python
        dummy_adj_flow_ratio = outputPhase.Dummy_adj_flow_ratio
        ```

### Dummy_reqd_green_time_ratio {#dummy_reqd_green_time_ratio}

```csharp
float Dummy_reqd_green_time_ratio { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_reqd_green_time_ratio = outputPhase.Dummy_reqd_green_time_ratio;
        ```

    === "C++"

        ```cpp
        double dummy_reqd_green_time_ratio;
        outputPhase->get_Dummy_reqd_green_time_ratio(&dummy_reqd_green_time_ratio);
        ```

    === "Python"

        ```python
        dummy_reqd_green_time_ratio = outputPhase.Dummy_reqd_green_time_ratio
        ```

### Dummy_tmin {#dummy_tmin}

```csharp
float Dummy_tmin { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_tmin = outputPhase.Dummy_tmin;
        ```

    === "C++"

        ```cpp
        double dummy_tmin;
        outputPhase->get_Dummy_tmin(&dummy_tmin);
        ```

    === "Python"

        ```python
        dummy_tmin = outputPhase.Dummy_tmin
        ```

### Dummy_tmax {#dummy_tmax}

```csharp
float Dummy_tmax { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_tmax = outputPhase.Dummy_tmax;
        ```

    === "C++"

        ```cpp
        double dummy_tmax;
        outputPhase->get_Dummy_tmax(&dummy_tmax);
        ```

    === "Python"

        ```python
        dummy_tmax = outputPhase.Dummy_tmax
        ```

### Dummy_min_max_flag {#dummy_min_max_flag}

```csharp
int Dummy_min_max_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int dummy_min_max_flag = outputPhase.Dummy_min_max_flag;
        ```

    === "C++"

        ```cpp
        long dummy_min_max_flag;
        outputPhase->get_Dummy_min_max_flag(&dummy_min_max_flag);
        ```

    === "Python"

        ```python
        dummy_min_max_flag = outputPhase.Dummy_min_max_flag
        ```

### Yellow_time {#yellow_time}

```csharp
float Yellow_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float yellow_time = outputPhase.Yellow_time;
        ```

    === "C++"

        ```cpp
        double yellow_time;
        outputPhase->get_Yellow_time(&yellow_time);
        ```

    === "Python"

        ```python
        yellow_time = outputPhase.Yellow_time
        ```

### All_red_time {#all_red_time}

```csharp
float All_red_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float all_red_time = outputPhase.All_red_time;
        ```

    === "C++"

        ```cpp
        double all_red_time;
        outputPhase->get_All_red_time(&all_red_time);
        ```

    === "Python"

        ```python
        all_red_time = outputPhase.All_red_time
        ```

### Phase_frequency {#phase_frequency}

```csharp
float Phase_frequency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_frequency = outputPhase.Phase_frequency;
        ```

    === "C++"

        ```cpp
        double phase_frequency;
        outputPhase->get_Phase_frequency(&phase_frequency);
        ```

    === "Python"

        ```python
        phase_frequency = outputPhase.Phase_frequency
        ```

### Phase_frequency_option {#phase_frequency_option}

Phase Frequency Option

```csharp
int Phase_frequency_option { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Not applicable
- `1` - User-given
- `2` - Implied
- `3` - No Phase Frequency

???- example "Code samples"

    === "C#"

        ```csharp
        int phase_frequency_option = outputPhase.Phase_frequency_option;
        ```

    === "C++"

        ```cpp
        long phase_frequency_option;
        outputPhase->get_Phase_frequency_option(&phase_frequency_option);
        ```

    === "Python"

        ```python
        phase_frequency_option = outputPhase.Phase_frequency_option
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphasemovtimingpath.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhaseMovTimingPath
title: OutputPhaseMovTimingPath
name: ISIAPIOutputPhaseMovTimingPath
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 06ECA85A-D43C-41EA-968F-E7B38821D371
members:
  - int Position
  - ISIAPIOutputset Outputset
  - ISIAPIOutputPhaseMovTimingPathMovements OutputPhaseMovTimingPathMovements
---

# OutputPhaseMovTimingPath

Type `ISIAPIOutputPhaseMovTimingPath` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `06ECA85A-D43C-41EA-968F-E7B38821D371`

## Declaration

```csharp
[Guid("06ECA85A-D43C-41EA-968F-E7B38821D371")]
public interface ISIAPIOutputPhaseMovTimingPath
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Position](#position) | `int` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [OutputPhaseMovTimingPathMovements](#outputphasemovtimingpathmovements) | [`ISIAPIOutputPhaseMovTimingPathMovements`](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovements.md) |  |

</div>

## Properties

### Position {#position}

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = outputPhaseMovTimingPath.Position;
        ```

    === "C++"

        ```cpp
        long position;
        outputPhaseMovTimingPath->get_Position(&position);
        ```

    === "Python"

        ```python
        position = outputPhaseMovTimingPath.Position
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputPhaseMovTimingPath.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputPhaseMovTimingPath->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputPhaseMovTimingPath.Outputset
        ```

### OutputPhaseMovTimingPathMovements {#outputphasemovtimingpathmovements}

```csharp
ISIAPIOutputPhaseMovTimingPathMovements OutputPhaseMovTimingPathMovements { get; }
```

**Type** [`ISIAPIOutputPhaseMovTimingPathMovements`](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovements.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputPhaseMovTimingPathMovements = outputPhaseMovTimingPath.OutputPhaseMovTimingPathMovements;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhaseMovTimingPathMovements> outputPhaseMovTimingPathMovements;
        outputPhaseMovTimingPath->get_OutputPhaseMovTimingPathMovements(&outputPhaseMovTimingPathMovements);
        ```

    === "Python"

        ```python
        output_phase_mov_timing_path_movements = outputPhaseMovTimingPath.OutputPhaseMovTimingPathMovements
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphasemovtimingpathmovement.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhaseMovTimingPathMovement
title: OutputPhaseMovTimingPathMovement
name: ISIAPIOutputPhaseMovTimingPathMovement
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0BC237A4-F607-49C5-B95E-14DF0D5B33EE
members:
  - int Position
  - int Mov_type
  - int Origin
  - int Destination
  - int MC_class
  - int Ped_type
  - int Ped_stage
  - int Greenperiod
  - int Dummy_phase_original_position
  - float Green_time
  - int Start_phase
  - int End_phase
  - string MovementDisplayID
  - string SiteDisplayID
  - bool Critical_mov
  - float Eff_green
  - float Reqd_time
  - int MaxGreenPeriod
  - ISIAPIOutputPhaseMovTimingPath OutputPhaseMovTimingPath
---

# OutputPhaseMovTimingPathMovement

Type `ISIAPIOutputPhaseMovTimingPathMovement` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0BC237A4-F607-49C5-B95E-14DF0D5B33EE`

## Declaration

```csharp
[Guid("0BC237A4-F607-49C5-B95E-14DF0D5B33EE")]
public interface ISIAPIOutputPhaseMovTimingPathMovement
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Position](#position) | `int` | The index of this Movement in the Timing Path. It is a zero-base integer. |
| [Mov_type](#mov_type) | `int` | Movement Type |
| [Origin](#origin) | `int` |  |
| [Destination](#destination) | `int` |  |
| [MC_class](#mc_class) | `int` |  |
| [Ped_type](#ped_type) | `int` |  |
| [Ped_stage](#ped_stage) | `int` |  |
| [Greenperiod](#greenperiod) | `int` |  |
| [Dummy_phase_original_position](#dummy_phase_original_position) | `int` |  |
| [Green_time](#green_time) | `float` |  |
| [Start_phase](#start_phase) | `int` | The position / index of the Phase that this Movement starts from |
| [End_phase](#end_phase) | `int` | The position / index of the Phase that this Movement finishes at. |
| [MovementDisplayID](#movementdisplayid) | `string` |  |
| [SiteDisplayID](#sitedisplayid) | `string` |  |
| [Critical_mov](#critical_mov) | `bool` | Flag indicating this Movement is a critical movement or not. |
| [Eff_green](#eff_green) | `float` |  |
| [Reqd_time](#reqd_time) | `float` |  |
| [MaxGreenPeriod](#maxgreenperiod) | `int` |  |
| [OutputPhaseMovTimingPath](#outputphasemovtimingpath) | [`ISIAPIOutputPhaseMovTimingPath`](sidrasolutions.si.api.isiapioutputphasemovtimingpath.md) |  |

</div>

## Properties

### Position {#position}

The index of this Movement in the Timing Path. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = outputPhaseMovTimingPathMovement.Position;
        ```

    === "C++"

        ```cpp
        long position;
        outputPhaseMovTimingPathMovement->get_Position(&position);
        ```

    === "Python"

        ```python
        position = outputPhaseMovTimingPathMovement.Position
        ```

### Mov_type {#mov_type}

Movement Type

```csharp
int Mov_type { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Vehicle Approach Movement
- `2` - Pedestrian Movement
- `3` - Dummy Movement in a Phase

???- example "Code samples"

    === "C#"

        ```csharp
        int mov_type = outputPhaseMovTimingPathMovement.Mov_type;
        ```

    === "C++"

        ```cpp
        long mov_type;
        outputPhaseMovTimingPathMovement->get_Mov_type(&mov_type);
        ```

    === "Python"

        ```python
        mov_type = outputPhaseMovTimingPathMovement.Mov_type
        ```

### Origin {#origin}

```csharp
int Origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = outputPhaseMovTimingPathMovement.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        outputPhaseMovTimingPathMovement->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = outputPhaseMovTimingPathMovement.Origin
        ```

### Destination {#destination}

```csharp
int Destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = outputPhaseMovTimingPathMovement.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        outputPhaseMovTimingPathMovement->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = outputPhaseMovTimingPathMovement.Destination
        ```

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputPhaseMovTimingPathMovement.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputPhaseMovTimingPathMovement->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputPhaseMovTimingPathMovement.MC_class
        ```

### Ped_type {#ped_type}

```csharp
int Ped_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int ped_type = outputPhaseMovTimingPathMovement.Ped_type;
        ```

    === "C++"

        ```cpp
        long ped_type;
        outputPhaseMovTimingPathMovement->get_Ped_type(&ped_type);
        ```

    === "Python"

        ```python
        ped_type = outputPhaseMovTimingPathMovement.Ped_type
        ```

### Ped_stage {#ped_stage}

```csharp
int Ped_stage { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int ped_stage = outputPhaseMovTimingPathMovement.Ped_stage;
        ```

    === "C++"

        ```cpp
        long ped_stage;
        outputPhaseMovTimingPathMovement->get_Ped_stage(&ped_stage);
        ```

    === "Python"

        ```python
        ped_stage = outputPhaseMovTimingPathMovement.Ped_stage
        ```

### Greenperiod {#greenperiod}

```csharp
int Greenperiod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int greenperiod = outputPhaseMovTimingPathMovement.Greenperiod;
        ```

    === "C++"

        ```cpp
        long greenperiod;
        outputPhaseMovTimingPathMovement->get_Greenperiod(&greenperiod);
        ```

    === "Python"

        ```python
        greenperiod = outputPhaseMovTimingPathMovement.Greenperiod
        ```

### Dummy_phase_original_position {#dummy_phase_original_position}

```csharp
int Dummy_phase_original_position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int dummy_phase_original_position = outputPhaseMovTimingPathMovement.Dummy_phase_original_position;
        ```

    === "C++"

        ```cpp
        long dummy_phase_original_position;
        outputPhaseMovTimingPathMovement->get_Dummy_phase_original_position(&dummy_phase_original_position);
        ```

    === "Python"

        ```python
        dummy_phase_original_position = outputPhaseMovTimingPathMovement.Dummy_phase_original_position
        ```

### Green_time {#green_time}

```csharp
float Green_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float green_time = outputPhaseMovTimingPathMovement.Green_time;
        ```

    === "C++"

        ```cpp
        double green_time;
        outputPhaseMovTimingPathMovement->get_Green_time(&green_time);
        ```

    === "Python"

        ```python
        green_time = outputPhaseMovTimingPathMovement.Green_time
        ```

### Start_phase {#start_phase}

The position / index of the Phase that this Movement starts from

```csharp
int Start_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int start_phase = outputPhaseMovTimingPathMovement.Start_phase;
        ```

    === "C++"

        ```cpp
        long start_phase;
        outputPhaseMovTimingPathMovement->get_Start_phase(&start_phase);
        ```

    === "Python"

        ```python
        start_phase = outputPhaseMovTimingPathMovement.Start_phase
        ```

### End_phase {#end_phase}

The position / index of the Phase that this Movement finishes at.

```csharp
int End_phase { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int end_phase = outputPhaseMovTimingPathMovement.End_phase;
        ```

    === "C++"

        ```cpp
        long end_phase;
        outputPhaseMovTimingPathMovement->get_End_phase(&end_phase);
        ```

    === "Python"

        ```python
        end_phase = outputPhaseMovTimingPathMovement.End_phase
        ```

### MovementDisplayID {#movementdisplayid}

```csharp
string MovementDisplayID { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string movementDisplayID = outputPhaseMovTimingPathMovement.MovementDisplayID;
        ```

    === "C++"

        ```cpp
        CComBSTR movementDisplayID;
        outputPhaseMovTimingPathMovement->get_MovementDisplayID(&movementDisplayID);
        ```

    === "Python"

        ```python
        movement_display_id = outputPhaseMovTimingPathMovement.MovementDisplayID
        ```

### SiteDisplayID {#sitedisplayid}

```csharp
string SiteDisplayID { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string siteDisplayID = outputPhaseMovTimingPathMovement.SiteDisplayID;
        ```

    === "C++"

        ```cpp
        CComBSTR siteDisplayID;
        outputPhaseMovTimingPathMovement->get_SiteDisplayID(&siteDisplayID);
        ```

    === "Python"

        ```python
        site_display_id = outputPhaseMovTimingPathMovement.SiteDisplayID
        ```

### Critical_mov {#critical_mov}

Flag indicating this Movement is a critical movement or not.

```csharp
bool Critical_mov { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool critical_mov = outputPhaseMovTimingPathMovement.Critical_mov;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL critical_mov;
        outputPhaseMovTimingPathMovement->get_Critical_mov(&critical_mov);
        ```

    === "Python"

        ```python
        critical_mov = outputPhaseMovTimingPathMovement.Critical_mov
        ```

### Eff_green {#eff_green}

```csharp
float Eff_green { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_green = outputPhaseMovTimingPathMovement.Eff_green;
        ```

    === "C++"

        ```cpp
        double eff_green;
        outputPhaseMovTimingPathMovement->get_Eff_green(&eff_green);
        ```

    === "Python"

        ```python
        eff_green = outputPhaseMovTimingPathMovement.Eff_green
        ```

### Reqd_time {#reqd_time}

```csharp
float Reqd_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_time = outputPhaseMovTimingPathMovement.Reqd_time;
        ```

    === "C++"

        ```cpp
        double reqd_time;
        outputPhaseMovTimingPathMovement->get_Reqd_time(&reqd_time);
        ```

    === "Python"

        ```python
        reqd_time = outputPhaseMovTimingPathMovement.Reqd_time
        ```

### MaxGreenPeriod {#maxgreenperiod}

```csharp
int MaxGreenPeriod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int maxGreenPeriod = outputPhaseMovTimingPathMovement.MaxGreenPeriod;
        ```

    === "C++"

        ```cpp
        long maxGreenPeriod;
        outputPhaseMovTimingPathMovement->get_MaxGreenPeriod(&maxGreenPeriod);
        ```

    === "Python"

        ```python
        max_green_period = outputPhaseMovTimingPathMovement.MaxGreenPeriod
        ```

### OutputPhaseMovTimingPath {#outputphasemovtimingpath}

```csharp
ISIAPIOutputPhaseMovTimingPath OutputPhaseMovTimingPath { get; }
```

**Type** [`ISIAPIOutputPhaseMovTimingPath`](sidrasolutions.si.api.isiapioutputphasemovtimingpath.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputPhaseMovTimingPath = outputPhaseMovTimingPathMovement.OutputPhaseMovTimingPath;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhaseMovTimingPath> outputPhaseMovTimingPath;
        outputPhaseMovTimingPathMovement->get_OutputPhaseMovTimingPath(&outputPhaseMovTimingPath);
        ```

    === "Python"

        ```python
        output_phase_mov_timing_path = outputPhaseMovTimingPathMovement.OutputPhaseMovTimingPath
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphasemovtimingpathmovements.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhaseMovTimingPathMovements
title: OutputPhaseMovTimingPathMovements
name: ISIAPIOutputPhaseMovTimingPathMovements
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: C20BEAF4-3F7A-4ABC-BA9D-4EF00B5DAD61
members:
  - ISIAPIOutputPhaseMovTimingPathMovement this[int index]
  - int Count
---

# OutputPhaseMovTimingPathMovements

Type `ISIAPIOutputPhaseMovTimingPathMovements` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `C20BEAF4-3F7A-4ABC-BA9D-4EF00B5DAD61`

## Declaration

```csharp
[Guid("C20BEAF4-3F7A-4ABC-BA9D-4EF00B5DAD61")]
public interface ISIAPIOutputPhaseMovTimingPathMovements
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputPhaseMovTimingPathMovement`](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovement.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputPhaseMovTimingPathMovements.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputPhaseMovTimingPathMovements->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputPhaseMovTimingPathMovements.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputPhaseMovTimingPathMovement this[] { get; }
```

**Type** [`ISIAPIOutputPhaseMovTimingPathMovement`](sidrasolutions.si.api.isiapioutputphasemovtimingpathmovement.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputPhaseMovTimingPathMovements.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhaseMovTimingPathMovement> this[];
        outputPhaseMovTimingPathMovements->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputPhaseMovTimingPathMovements.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphasemovtimingpaths.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhaseMovTimingPaths
title: OutputPhaseMovTimingPaths
name: ISIAPIOutputPhaseMovTimingPaths
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B2116A07-78CC-454E-9A19-75148C7ECD91
members:
  - ISIAPIOutputPhaseMovTimingPath this[int index]
  - int Count
---

# OutputPhaseMovTimingPaths

Type `ISIAPIOutputPhaseMovTimingPaths` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B2116A07-78CC-454E-9A19-75148C7ECD91`

## Declaration

```csharp
[Guid("B2116A07-78CC-454E-9A19-75148C7ECD91")]
public interface ISIAPIOutputPhaseMovTimingPaths
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputPhaseMovTimingPath`](sidrasolutions.si.api.isiapioutputphasemovtimingpath.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputPhaseMovTimingPaths.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputPhaseMovTimingPaths->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputPhaseMovTimingPaths.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputPhaseMovTimingPath this[] { get; }
```

**Type** [`ISIAPIOutputPhaseMovTimingPath`](sidrasolutions.si.api.isiapioutputphasemovtimingpath.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputPhaseMovTimingPaths.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhaseMovTimingPath> this[];
        outputPhaseMovTimingPaths->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputPhaseMovTimingPaths.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputphases.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputPhases
title: OutputPhases
name: ISIAPIOutputPhases
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1A268BF1-6A1A-4DD9-9F6B-0435C9171411
members:
  - ISIAPIOutputPhase this[int index]
  - int Count
---

# OutputPhases

Type `ISIAPIOutputPhases` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1A268BF1-6A1A-4DD9-9F6B-0435C9171411`

## Declaration

```csharp
[Guid("1A268BF1-6A1A-4DD9-9F6B-0435C9171411")]
public interface ISIAPIOutputPhases
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputPhase`](sidrasolutions.si.api.isiapioutputphase.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputPhases.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputPhases->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputPhases.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputPhase this[] { get; }
```

**Type** [`ISIAPIOutputPhase`](sidrasolutions.si.api.isiapioutputphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputPhases.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhase> this[];
        outputPhases->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputPhases.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputroutemovementbasedperson.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputRouteMovementBasedPerson
title: OutputRouteMovementBasedPerson
name: ISIAPIOutputRouteMovementBasedPerson
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: DE19588E-31AC-477A-B647-0796A7CD9781
members:
  - float TravelSpeed
  - float TravelDistanceAverage
  - float TravelTimeAverage
  - float TravelDistanceTotal
  - float TravelTimeTotal
  - float TravelDelayAverage
  - float RouteStopRate
  - float RouteStopRate_rate
  - ISIAPIOutputNetwork OutputNetwork
---

# OutputRouteMovementBasedPerson

Type `ISIAPIOutputRouteMovementBasedPerson` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `DE19588E-31AC-477A-B647-0796A7CD9781`

## Declaration

```csharp
[Guid("DE19588E-31AC-477A-B647-0796A7CD9781")]
public interface ISIAPIOutputRouteMovementBasedPerson
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [TravelSpeed](#travelspeed) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [RouteStopRate](#routestoprate) | `float` |  |
| [RouteStopRate_rate](#routestoprate_rate) | `float` |  |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) |  |

</div>

## Properties

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputRouteMovementBasedPerson.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputRouteMovementBasedPerson->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputRouteMovementBasedPerson.TravelSpeed
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputRouteMovementBasedPerson.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputRouteMovementBasedPerson->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputRouteMovementBasedPerson.TravelDistanceAverage
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputRouteMovementBasedPerson.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputRouteMovementBasedPerson->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputRouteMovementBasedPerson.TravelTimeAverage
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputRouteMovementBasedPerson.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputRouteMovementBasedPerson->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputRouteMovementBasedPerson.TravelDistanceTotal
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputRouteMovementBasedPerson.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputRouteMovementBasedPerson->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputRouteMovementBasedPerson.TravelTimeTotal
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputRouteMovementBasedPerson.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputRouteMovementBasedPerson->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputRouteMovementBasedPerson.TravelDelayAverage
        ```

### RouteStopRate {#routestoprate}

```csharp
float RouteStopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate = outputRouteMovementBasedPerson.RouteStopRate;
        ```

    === "C++"

        ```cpp
        double routeStopRate;
        outputRouteMovementBasedPerson->get_RouteStopRate(&routeStopRate);
        ```

    === "Python"

        ```python
        route_stop_rate = outputRouteMovementBasedPerson.RouteStopRate
        ```

### RouteStopRate_rate {#routestoprate_rate}

```csharp
float RouteStopRate_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate_rate = outputRouteMovementBasedPerson.RouteStopRate_rate;
        ```

    === "C++"

        ```cpp
        double routeStopRate_rate;
        outputRouteMovementBasedPerson->get_RouteStopRate_rate(&routeStopRate_rate);
        ```

    === "Python"

        ```python
        route_stop_rate_rate = outputRouteMovementBasedPerson.RouteStopRate_rate
        ```

### OutputNetwork {#outputnetwork}

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = outputRouteMovementBasedPerson.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        outputRouteMovementBasedPerson->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = outputRouteMovementBasedPerson.OutputNetwork
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputRouteMovementBasedVehicle
title: OutputRouteMovementBasedVehicle
name: ISIAPIOutputRouteMovementBasedVehicle
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4396CAEE-E69B-47A7-9872-4144B0F47EEC
members:
  - float TravelSpeed
  - float TravelDistanceAverage
  - float TravelTimeAverage
  - float TravelTimeAverage_rate
  - float TravelDistanceTotal
  - float TravelTimeTotal
  - float TravelDelayAverage
  - float TravelDelayAverage_rate
  - float RouteStopRate
  - float RouteStopRate_rate
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - string LevelOfService
  - float TravelTimeIndex
  - float SpeedEfficiency
  - float CongestionCoefficient
  - int SpeedEfficiencyFlag
  - ISIAPIOutputNetwork OutputNetwork
  - ISIAPIOutputRouteMovementBasedVehicleMCs OutputRouteMovementBasedVehicleMCs
---

# OutputRouteMovementBasedVehicle

Type `ISIAPIOutputRouteMovementBasedVehicle` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4396CAEE-E69B-47A7-9872-4144B0F47EEC`

## Declaration

```csharp
[Guid("4396CAEE-E69B-47A7-9872-4144B0F47EEC")]
public interface ISIAPIOutputRouteMovementBasedVehicle
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [TravelSpeed](#travelspeed) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelTimeAverage_rate](#traveltimeaverage_rate) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [TravelDelayAverage_rate](#traveldelayaverage_rate) | `float` |  |
| [RouteStopRate](#routestoprate) | `float` |  |
| [RouteStopRate_rate](#routestoprate_rate) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [LevelOfService](#levelofservice) | `string` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [OutputNetwork](#outputnetwork) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) |  |
| [OutputRouteMovementBasedVehicleMCs](#outputroutemovementbasedvehiclemcs) | [`ISIAPIOutputRouteMovementBasedVehicleMCs`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemcs.md) |  |

</div>

## Properties

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputRouteMovementBasedVehicle.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputRouteMovementBasedVehicle->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputRouteMovementBasedVehicle.TravelSpeed
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputRouteMovementBasedVehicle.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputRouteMovementBasedVehicle->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputRouteMovementBasedVehicle.TravelDistanceAverage
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputRouteMovementBasedVehicle.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputRouteMovementBasedVehicle->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputRouteMovementBasedVehicle.TravelTimeAverage
        ```

### TravelTimeAverage_rate {#traveltimeaverage_rate}

```csharp
float TravelTimeAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage_rate = outputRouteMovementBasedVehicle.TravelTimeAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage_rate;
        outputRouteMovementBasedVehicle->get_TravelTimeAverage_rate(&travelTimeAverage_rate);
        ```

    === "Python"

        ```python
        travel_time_average_rate = outputRouteMovementBasedVehicle.TravelTimeAverage_rate
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputRouteMovementBasedVehicle.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputRouteMovementBasedVehicle->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputRouteMovementBasedVehicle.TravelDistanceTotal
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputRouteMovementBasedVehicle.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputRouteMovementBasedVehicle->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputRouteMovementBasedVehicle.TravelTimeTotal
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputRouteMovementBasedVehicle.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputRouteMovementBasedVehicle->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputRouteMovementBasedVehicle.TravelDelayAverage
        ```

### TravelDelayAverage_rate {#traveldelayaverage_rate}

```csharp
float TravelDelayAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage_rate = outputRouteMovementBasedVehicle.TravelDelayAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage_rate;
        outputRouteMovementBasedVehicle->get_TravelDelayAverage_rate(&travelDelayAverage_rate);
        ```

    === "Python"

        ```python
        travel_delay_average_rate = outputRouteMovementBasedVehicle.TravelDelayAverage_rate
        ```

### RouteStopRate {#routestoprate}

```csharp
float RouteStopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate = outputRouteMovementBasedVehicle.RouteStopRate;
        ```

    === "C++"

        ```cpp
        double routeStopRate;
        outputRouteMovementBasedVehicle->get_RouteStopRate(&routeStopRate);
        ```

    === "Python"

        ```python
        route_stop_rate = outputRouteMovementBasedVehicle.RouteStopRate
        ```

### RouteStopRate_rate {#routestoprate_rate}

```csharp
float RouteStopRate_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate_rate = outputRouteMovementBasedVehicle.RouteStopRate_rate;
        ```

    === "C++"

        ```cpp
        double routeStopRate_rate;
        outputRouteMovementBasedVehicle->get_RouteStopRate_rate(&routeStopRate_rate);
        ```

    === "Python"

        ```python
        route_stop_rate_rate = outputRouteMovementBasedVehicle.RouteStopRate_rate
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputRouteMovementBasedVehicle.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputRouteMovementBasedVehicle->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputRouteMovementBasedVehicle.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputRouteMovementBasedVehicle.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputRouteMovementBasedVehicle->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputRouteMovementBasedVehicle.DesiredSpeed
        ```

### LevelOfService {#levelofservice}

```csharp
string LevelOfService { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string levelOfService = outputRouteMovementBasedVehicle.LevelOfService;
        ```

    === "C++"

        ```cpp
        CComBSTR levelOfService;
        outputRouteMovementBasedVehicle->get_LevelOfService(&levelOfService);
        ```

    === "Python"

        ```python
        level_of_service = outputRouteMovementBasedVehicle.LevelOfService
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputRouteMovementBasedVehicle.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputRouteMovementBasedVehicle->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputRouteMovementBasedVehicle.TravelTimeIndex
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputRouteMovementBasedVehicle.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputRouteMovementBasedVehicle->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputRouteMovementBasedVehicle.SpeedEfficiency
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputRouteMovementBasedVehicle.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputRouteMovementBasedVehicle->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputRouteMovementBasedVehicle.CongestionCoefficient
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputRouteMovementBasedVehicle.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputRouteMovementBasedVehicle->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputRouteMovementBasedVehicle.SpeedEfficiencyFlag
        ```

### OutputNetwork {#outputnetwork}

```csharp
ISIAPIOutputNetwork OutputNetwork { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputNetwork = outputRouteMovementBasedVehicle.OutputNetwork;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputNetwork;
        outputRouteMovementBasedVehicle->get_OutputNetwork(&outputNetwork);
        ```

    === "Python"

        ```python
        output_network = outputRouteMovementBasedVehicle.OutputNetwork
        ```

### OutputRouteMovementBasedVehicleMCs {#outputroutemovementbasedvehiclemcs}

```csharp
ISIAPIOutputRouteMovementBasedVehicleMCs OutputRouteMovementBasedVehicleMCs { get; }
```

**Type** [`ISIAPIOutputRouteMovementBasedVehicleMCs`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputRouteMovementBasedVehicleMCs = outputRouteMovementBasedVehicle.OutputRouteMovementBasedVehicleMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputRouteMovementBasedVehicleMCs> outputRouteMovementBasedVehicleMCs;
        outputRouteMovementBasedVehicle->get_OutputRouteMovementBasedVehicleMCs(&outputRouteMovementBasedVehicleMCs);
        ```

    === "Python"

        ```python
        output_route_movement_based_vehicle_m_cs = outputRouteMovementBasedVehicle.OutputRouteMovementBasedVehicleMCs
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputRouteMovementBasedVehicleMC
title: OutputRouteMovementBasedVehicleMC
name: ISIAPIOutputRouteMovementBasedVehicleMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8A140F89-28EE-4EA2-AA06-DABBE9BB4CDD
members:
  - int MC_class
  - float TravelSpeed
  - float TravelDistanceAverage
  - float TravelTimeAverage
  - float TravelTimeAverage_rate
  - float TravelDistanceTotal
  - float TravelTimeTotal
  - float TravelDelayAverage
  - float TravelDelayAverage_rate
  - float RouteStopRate
  - float RouteStopRate_rate
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - string LevelOfService
  - float TravelTimeIndex
  - float SpeedEfficiency
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle
---

# OutputRouteMovementBasedVehicleMC

Type `ISIAPIOutputRouteMovementBasedVehicleMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8A140F89-28EE-4EA2-AA06-DABBE9BB4CDD`

## Declaration

```csharp
[Guid("8A140F89-28EE-4EA2-AA06-DABBE9BB4CDD")]
public interface ISIAPIOutputRouteMovementBasedVehicleMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [TravelSpeed](#travelspeed) | `float` |  |
| [TravelDistanceAverage](#traveldistanceaverage) | `float` |  |
| [TravelTimeAverage](#traveltimeaverage) | `float` |  |
| [TravelTimeAverage_rate](#traveltimeaverage_rate) | `float` |  |
| [TravelDistanceTotal](#traveldistancetotal) | `float` |  |
| [TravelTimeTotal](#traveltimetotal) | `float` |  |
| [TravelDelayAverage](#traveldelayaverage) | `float` |  |
| [TravelDelayAverage_rate](#traveldelayaverage_rate) | `float` |  |
| [RouteStopRate](#routestoprate) | `float` |  |
| [RouteStopRate_rate](#routestoprate_rate) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [LevelOfService](#levelofservice) | `string` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [OutputRouteMovementBasedVehicle](#outputroutemovementbasedvehicle) | [`ISIAPIOutputRouteMovementBasedVehicle`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md) |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputRouteMovementBasedVehicleMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputRouteMovementBasedVehicleMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputRouteMovementBasedVehicleMC.MC_class
        ```

### TravelSpeed {#travelspeed}

```csharp
float TravelSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelSpeed = outputRouteMovementBasedVehicleMC.TravelSpeed;
        ```

    === "C++"

        ```cpp
        double travelSpeed;
        outputRouteMovementBasedVehicleMC->get_TravelSpeed(&travelSpeed);
        ```

    === "Python"

        ```python
        travel_speed = outputRouteMovementBasedVehicleMC.TravelSpeed
        ```

### TravelDistanceAverage {#traveldistanceaverage}

```csharp
float TravelDistanceAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceAverage = outputRouteMovementBasedVehicleMC.TravelDistanceAverage;
        ```

    === "C++"

        ```cpp
        double travelDistanceAverage;
        outputRouteMovementBasedVehicleMC->get_TravelDistanceAverage(&travelDistanceAverage);
        ```

    === "Python"

        ```python
        travel_distance_average = outputRouteMovementBasedVehicleMC.TravelDistanceAverage
        ```

### TravelTimeAverage {#traveltimeaverage}

```csharp
float TravelTimeAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage = outputRouteMovementBasedVehicleMC.TravelTimeAverage;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage;
        outputRouteMovementBasedVehicleMC->get_TravelTimeAverage(&travelTimeAverage);
        ```

    === "Python"

        ```python
        travel_time_average = outputRouteMovementBasedVehicleMC.TravelTimeAverage
        ```

### TravelTimeAverage_rate {#traveltimeaverage_rate}

```csharp
float TravelTimeAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeAverage_rate = outputRouteMovementBasedVehicleMC.TravelTimeAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelTimeAverage_rate;
        outputRouteMovementBasedVehicleMC->get_TravelTimeAverage_rate(&travelTimeAverage_rate);
        ```

    === "Python"

        ```python
        travel_time_average_rate = outputRouteMovementBasedVehicleMC.TravelTimeAverage_rate
        ```

### TravelDistanceTotal {#traveldistancetotal}

```csharp
float TravelDistanceTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDistanceTotal = outputRouteMovementBasedVehicleMC.TravelDistanceTotal;
        ```

    === "C++"

        ```cpp
        double travelDistanceTotal;
        outputRouteMovementBasedVehicleMC->get_TravelDistanceTotal(&travelDistanceTotal);
        ```

    === "Python"

        ```python
        travel_distance_total = outputRouteMovementBasedVehicleMC.TravelDistanceTotal
        ```

### TravelTimeTotal {#traveltimetotal}

```csharp
float TravelTimeTotal { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeTotal = outputRouteMovementBasedVehicleMC.TravelTimeTotal;
        ```

    === "C++"

        ```cpp
        double travelTimeTotal;
        outputRouteMovementBasedVehicleMC->get_TravelTimeTotal(&travelTimeTotal);
        ```

    === "Python"

        ```python
        travel_time_total = outputRouteMovementBasedVehicleMC.TravelTimeTotal
        ```

### TravelDelayAverage {#traveldelayaverage}

```csharp
float TravelDelayAverage { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage = outputRouteMovementBasedVehicleMC.TravelDelayAverage;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage;
        outputRouteMovementBasedVehicleMC->get_TravelDelayAverage(&travelDelayAverage);
        ```

    === "Python"

        ```python
        travel_delay_average = outputRouteMovementBasedVehicleMC.TravelDelayAverage
        ```

### TravelDelayAverage_rate {#traveldelayaverage_rate}

```csharp
float TravelDelayAverage_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelDelayAverage_rate = outputRouteMovementBasedVehicleMC.TravelDelayAverage_rate;
        ```

    === "C++"

        ```cpp
        double travelDelayAverage_rate;
        outputRouteMovementBasedVehicleMC->get_TravelDelayAverage_rate(&travelDelayAverage_rate);
        ```

    === "Python"

        ```python
        travel_delay_average_rate = outputRouteMovementBasedVehicleMC.TravelDelayAverage_rate
        ```

### RouteStopRate {#routestoprate}

```csharp
float RouteStopRate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate = outputRouteMovementBasedVehicleMC.RouteStopRate;
        ```

    === "C++"

        ```cpp
        double routeStopRate;
        outputRouteMovementBasedVehicleMC->get_RouteStopRate(&routeStopRate);
        ```

    === "Python"

        ```python
        route_stop_rate = outputRouteMovementBasedVehicleMC.RouteStopRate
        ```

### RouteStopRate_rate {#routestoprate_rate}

```csharp
float RouteStopRate_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float routeStopRate_rate = outputRouteMovementBasedVehicleMC.RouteStopRate_rate;
        ```

    === "C++"

        ```cpp
        double routeStopRate_rate;
        outputRouteMovementBasedVehicleMC->get_RouteStopRate_rate(&routeStopRate_rate);
        ```

    === "Python"

        ```python
        route_stop_rate_rate = outputRouteMovementBasedVehicleMC.RouteStopRate_rate
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputRouteMovementBasedVehicleMC.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputRouteMovementBasedVehicleMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputRouteMovementBasedVehicleMC.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputRouteMovementBasedVehicleMC.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputRouteMovementBasedVehicleMC->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputRouteMovementBasedVehicleMC.DesiredSpeed
        ```

### LevelOfService {#levelofservice}

```csharp
string LevelOfService { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string levelOfService = outputRouteMovementBasedVehicleMC.LevelOfService;
        ```

    === "C++"

        ```cpp
        CComBSTR levelOfService;
        outputRouteMovementBasedVehicleMC->get_LevelOfService(&levelOfService);
        ```

    === "Python"

        ```python
        level_of_service = outputRouteMovementBasedVehicleMC.LevelOfService
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputRouteMovementBasedVehicleMC.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputRouteMovementBasedVehicleMC->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputRouteMovementBasedVehicleMC.TravelTimeIndex
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputRouteMovementBasedVehicleMC.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputRouteMovementBasedVehicleMC->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputRouteMovementBasedVehicleMC.SpeedEfficiency
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputRouteMovementBasedVehicleMC.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputRouteMovementBasedVehicleMC->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputRouteMovementBasedVehicleMC.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputRouteMovementBasedVehicleMC.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputRouteMovementBasedVehicleMC->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputRouteMovementBasedVehicleMC.CongestionCoefficient
        ```

### OutputRouteMovementBasedVehicle {#outputroutemovementbasedvehicle}

```csharp
ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle { get; }
```

**Type** [`ISIAPIOutputRouteMovementBasedVehicle`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputRouteMovementBasedVehicle = outputRouteMovementBasedVehicleMC.OutputRouteMovementBasedVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputRouteMovementBasedVehicle> outputRouteMovementBasedVehicle;
        outputRouteMovementBasedVehicleMC->get_OutputRouteMovementBasedVehicle(&outputRouteMovementBasedVehicle);
        ```

    === "Python"

        ```python
        output_route_movement_based_vehicle = outputRouteMovementBasedVehicleMC.OutputRouteMovementBasedVehicle
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputRouteMovementBasedVehicleMCs
title: OutputRouteMovementBasedVehicleMCs
name: ISIAPIOutputRouteMovementBasedVehicleMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FE29E9C8-8D2B-4691-BBA2-0A0F15FFC4AA
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputRouteMovementBasedVehicleMC this[int mcClass]
  - int Count
---

# OutputRouteMovementBasedVehicleMCs

Type `ISIAPIOutputRouteMovementBasedVehicleMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FE29E9C8-8D2B-4691-BBA2-0A0F15FFC4AA`

## Declaration

```csharp
[Guid("FE29E9C8-8D2B-4691-BBA2-0A0F15FFC4AA")]
public interface ISIAPIOutputRouteMovementBasedVehicleMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputRouteMovementBasedVehicleMC`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputRouteMovementBasedVehicleMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputRouteMovementBasedVehicleMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputRouteMovementBasedVehicleMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputRouteMovementBasedVehicleMC this[] { get; }
```

**Type** [`ISIAPIOutputRouteMovementBasedVehicleMC`](sidrasolutions.si.api.isiapioutputroutemovementbasedvehiclemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputRouteMovementBasedVehicleMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputRouteMovementBasedVehicleMC> this[];
        outputRouteMovementBasedVehicleMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputRouteMovementBasedVehicleMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputRouteMovementBasedVehicleMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputRouteMovementBasedVehicleMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputRouteMovementBasedVehicleMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsequence.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSequence
title: OutputSequence
name: ISIAPIOutputSequence
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: ED85B5E2-3AA3-4489-8064-4D51C1C137D7
members:
  - int Cycle_time_option
  - float Cycle_time
  - float Cycle_time_minimum
  - int Cycle_time_minimum_flag
  - float Cycle_time_practical
  - float Max_green_percent
  - float Adjusted_lost_time_total
  - float Adjusted_flow_ratio_total
  - float Reqd_green_time_ratio_total
  - float Reqd_movement_time_total
  - ISIAPIOutputPhases Phases
  - float Cycle_time_maximum
  - int Cycle_time_maximum_flag
  - int Warning_flag
  - int Cmaxsl_flag
  - int Largeyu_flag
  - int Critical_in_network
  - int Cycle_time_option_flag
  - int Seq_position
---

# OutputSequence

Type `ISIAPIOutputSequence` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `ED85B5E2-3AA3-4489-8064-4D51C1C137D7`

## Declaration

```csharp
[Guid("ED85B5E2-3AA3-4489-8064-4D51C1C137D7")]
public interface ISIAPIOutputSequence
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Cycle_time_option](#cycle_time_option) | `int` |  |
| [Cycle_time](#cycle_time) | `float` |  |
| [Cycle_time_minimum](#cycle_time_minimum) | `float` |  |
| [Cycle_time_minimum_flag](#cycle_time_minimum_flag) | `int` |  |
| [Cycle_time_practical](#cycle_time_practical) | `float` |  |
| [Max_green_percent](#max_green_percent) | `float` |  |
| [Adjusted_lost_time_total](#adjusted_lost_time_total) | `float` |  |
| [Adjusted_flow_ratio_total](#adjusted_flow_ratio_total) | `float` |  |
| [Reqd_green_time_ratio_total](#reqd_green_time_ratio_total) | `float` |  |
| [Reqd_movement_time_total](#reqd_movement_time_total) | `float` |  |
| [Phases](#phases) | [`ISIAPIOutputPhases`](sidrasolutions.si.api.isiapioutputphases.md) |  |
| [Cycle_time_maximum](#cycle_time_maximum) | `float` |  |
| [Cycle_time_maximum_flag](#cycle_time_maximum_flag) | `int` |  |
| [Warning_flag](#warning_flag) | `int` |  |
| [Cmaxsl_flag](#cmaxsl_flag) | `int` |  |
| [Largeyu_flag](#largeyu_flag) | `int` |  |
| [Critical_in_network](#critical_in_network) | `int` |  |
| [Cycle_time_option_flag](#cycle_time_option_flag) | `int` |  |
| [Seq_position](#seq_position) | `int` | The corresponding Sequence Input data position in the collection, i.e. ISIAPISequence.Position or ISIAPINetworkCCGSequence.Position |

</div>

## Properties

### Cycle_time_option {#cycle_time_option}

```csharp
int Cycle_time_option { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option = outputSequence.Cycle_time_option;
        ```

    === "C++"

        ```cpp
        long cycle_time_option;
        outputSequence->get_Cycle_time_option(&cycle_time_option);
        ```

    === "Python"

        ```python
        cycle_time_option = outputSequence.Cycle_time_option
        ```

### Cycle_time {#cycle_time}

```csharp
float Cycle_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time = outputSequence.Cycle_time;
        ```

    === "C++"

        ```cpp
        double cycle_time;
        outputSequence->get_Cycle_time(&cycle_time);
        ```

    === "Python"

        ```python
        cycle_time = outputSequence.Cycle_time
        ```

### Cycle_time_minimum {#cycle_time_minimum}

```csharp
float Cycle_time_minimum { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time_minimum = outputSequence.Cycle_time_minimum;
        ```

    === "C++"

        ```cpp
        double cycle_time_minimum;
        outputSequence->get_Cycle_time_minimum(&cycle_time_minimum);
        ```

    === "Python"

        ```python
        cycle_time_minimum = outputSequence.Cycle_time_minimum
        ```

### Cycle_time_minimum_flag {#cycle_time_minimum_flag}

```csharp
int Cycle_time_minimum_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_minimum_flag = outputSequence.Cycle_time_minimum_flag;
        ```

    === "C++"

        ```cpp
        long cycle_time_minimum_flag;
        outputSequence->get_Cycle_time_minimum_flag(&cycle_time_minimum_flag);
        ```

    === "Python"

        ```python
        cycle_time_minimum_flag = outputSequence.Cycle_time_minimum_flag
        ```

### Cycle_time_practical {#cycle_time_practical}

```csharp
float Cycle_time_practical { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time_practical = outputSequence.Cycle_time_practical;
        ```

    === "C++"

        ```cpp
        double cycle_time_practical;
        outputSequence->get_Cycle_time_practical(&cycle_time_practical);
        ```

    === "Python"

        ```python
        cycle_time_practical = outputSequence.Cycle_time_practical
        ```

### Max_green_percent {#max_green_percent}

```csharp
float Max_green_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_green_percent = outputSequence.Max_green_percent;
        ```

    === "C++"

        ```cpp
        double max_green_percent;
        outputSequence->get_Max_green_percent(&max_green_percent);
        ```

    === "Python"

        ```python
        max_green_percent = outputSequence.Max_green_percent
        ```

### Adjusted_lost_time_total {#adjusted_lost_time_total}

```csharp
float Adjusted_lost_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_lost_time_total = outputSequence.Adjusted_lost_time_total;
        ```

    === "C++"

        ```cpp
        double adjusted_lost_time_total;
        outputSequence->get_Adjusted_lost_time_total(&adjusted_lost_time_total);
        ```

    === "Python"

        ```python
        adjusted_lost_time_total = outputSequence.Adjusted_lost_time_total
        ```

### Adjusted_flow_ratio_total {#adjusted_flow_ratio_total}

```csharp
float Adjusted_flow_ratio_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float adjusted_flow_ratio_total = outputSequence.Adjusted_flow_ratio_total;
        ```

    === "C++"

        ```cpp
        double adjusted_flow_ratio_total;
        outputSequence->get_Adjusted_flow_ratio_total(&adjusted_flow_ratio_total);
        ```

    === "Python"

        ```python
        adjusted_flow_ratio_total = outputSequence.Adjusted_flow_ratio_total
        ```

### Reqd_green_time_ratio_total {#reqd_green_time_ratio_total}

```csharp
float Reqd_green_time_ratio_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_green_time_ratio_total = outputSequence.Reqd_green_time_ratio_total;
        ```

    === "C++"

        ```cpp
        double reqd_green_time_ratio_total;
        outputSequence->get_Reqd_green_time_ratio_total(&reqd_green_time_ratio_total);
        ```

    === "Python"

        ```python
        reqd_green_time_ratio_total = outputSequence.Reqd_green_time_ratio_total
        ```

### Reqd_movement_time_total {#reqd_movement_time_total}

```csharp
float Reqd_movement_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float reqd_movement_time_total = outputSequence.Reqd_movement_time_total;
        ```

    === "C++"

        ```cpp
        double reqd_movement_time_total;
        outputSequence->get_Reqd_movement_time_total(&reqd_movement_time_total);
        ```

    === "Python"

        ```python
        reqd_movement_time_total = outputSequence.Reqd_movement_time_total
        ```

### Phases {#phases}

```csharp
ISIAPIOutputPhases Phases { get; }
```

**Type** [`ISIAPIOutputPhases`](sidrasolutions.si.api.isiapioutputphases.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phases = outputSequence.Phases;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhases> phases;
        outputSequence->get_Phases(&phases);
        ```

    === "Python"

        ```python
        phases = outputSequence.Phases
        ```

### Cycle_time_maximum {#cycle_time_maximum}

```csharp
float Cycle_time_maximum { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float cycle_time_maximum = outputSequence.Cycle_time_maximum;
        ```

    === "C++"

        ```cpp
        double cycle_time_maximum;
        outputSequence->get_Cycle_time_maximum(&cycle_time_maximum);
        ```

    === "Python"

        ```python
        cycle_time_maximum = outputSequence.Cycle_time_maximum
        ```

### Cycle_time_maximum_flag {#cycle_time_maximum_flag}

```csharp
int Cycle_time_maximum_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_maximum_flag = outputSequence.Cycle_time_maximum_flag;
        ```

    === "C++"

        ```cpp
        long cycle_time_maximum_flag;
        outputSequence->get_Cycle_time_maximum_flag(&cycle_time_maximum_flag);
        ```

    === "Python"

        ```python
        cycle_time_maximum_flag = outputSequence.Cycle_time_maximum_flag
        ```

### Warning_flag {#warning_flag}

```csharp
int Warning_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int warning_flag = outputSequence.Warning_flag;
        ```

    === "C++"

        ```cpp
        long warning_flag;
        outputSequence->get_Warning_flag(&warning_flag);
        ```

    === "Python"

        ```python
        warning_flag = outputSequence.Warning_flag
        ```

### Cmaxsl_flag {#cmaxsl_flag}

```csharp
int Cmaxsl_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cmaxsl_flag = outputSequence.Cmaxsl_flag;
        ```

    === "C++"

        ```cpp
        long cmaxsl_flag;
        outputSequence->get_Cmaxsl_flag(&cmaxsl_flag);
        ```

    === "Python"

        ```python
        cmaxsl_flag = outputSequence.Cmaxsl_flag
        ```

### Largeyu_flag {#largeyu_flag}

```csharp
int Largeyu_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int largeyu_flag = outputSequence.Largeyu_flag;
        ```

    === "C++"

        ```cpp
        long largeyu_flag;
        outputSequence->get_Largeyu_flag(&largeyu_flag);
        ```

    === "Python"

        ```python
        largeyu_flag = outputSequence.Largeyu_flag
        ```

### Critical_in_network {#critical_in_network}

```csharp
int Critical_in_network { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int critical_in_network = outputSequence.Critical_in_network;
        ```

    === "C++"

        ```cpp
        long critical_in_network;
        outputSequence->get_Critical_in_network(&critical_in_network);
        ```

    === "Python"

        ```python
        critical_in_network = outputSequence.Critical_in_network
        ```

### Cycle_time_option_flag {#cycle_time_option_flag}

```csharp
int Cycle_time_option_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option_flag = outputSequence.Cycle_time_option_flag;
        ```

    === "C++"

        ```cpp
        long cycle_time_option_flag;
        outputSequence->get_Cycle_time_option_flag(&cycle_time_option_flag);
        ```

    === "Python"

        ```python
        cycle_time_option_flag = outputSequence.Cycle_time_option_flag
        ```

### Seq_position {#seq_position}

The corresponding Sequence Input data position in the collection, i.e. ISIAPISequence.Position or ISIAPINetworkCCGSequence.Position

```csharp
int Seq_position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int seq_position = outputSequence.Seq_position;
        ```

    === "C++"

        ```cpp
        long seq_position;
        outputSequence->get_Seq_position(&seq_position);
        ```

    === "Python"

        ```python
        seq_position = outputSequence.Seq_position
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputset.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputset
title: Outputset
name: ISIAPIOutputset
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: DF145A48-BCCC-4A7C-A96D-763D665B94A9
summary: SIDRA INTERSECTION Outputset wrapper interface
members:
  - DateTime Generated
  - ISIAPIOutputSiteVehicle OutputSiteVehicle
  - ISIAPIOutputSitePedestrian OutputSitePedestrian
  - ISIAPIOutputSitePerson OutputSitePerson
  - ISIAPIOutputLegs OutputLegs
  - ISIAPIOutputMovementVehicleODs OutputMovementVehicleODs
  - ISIAPIOutputMovementPeds OutputMovementPeds
  - ISIAPIOutputMeteredRoundabout OutputMeteredRoundabout
  - ISIAPIOutputSequence OutputSequence
  - ISIAPIOutputAnalysis OutputAnalysis
  - ISIAPIOutputGraphTuples OutputGraphTuples
  - ISIAPISite Site
  - ISIAPINetworkSite NetworkSite
  - string GeneratedByVersion
  - int Analysis_method
  - int TWSC_calib_adjusted
  - int NwSiteOffset
  - int NwSite_SignalPlatoonMode
  - ISIAPIOutputLegPersons OutputLegPersons
  - ISIAPIOutputMovementPersonODs OutputMovementPersonODs
  - ISIAPIOutputSiteRoutes OutputSiteRoutes
  - int Analysis_method_flag
  - ISIAPIOutputPhaseMovTimingPaths OutputPhaseMovTimingPaths
  - bool HasSIDRUNUnsettledMsg
  - bool HasSIDRUNAWSCMsg
  - ISIAPIOutputMultiSequenceAnalyses OutputMultiSequenceAnalyses
---

# Outputset

Type `ISIAPIOutputset` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `DF145A48-BCCC-4A7C-A96D-763D665B94A9`

SIDRA INTERSECTION Outputset wrapper interface

## Declaration

```csharp
[Guid("DF145A48-BCCC-4A7C-A96D-763D665B94A9")]
public interface ISIAPIOutputset
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Generated](#generated) | `DateTime` | Date and Time site output was created (Processed). |
| [OutputSiteVehicle](#outputsitevehicle) | [`ISIAPIOutputSiteVehicle`](sidrasolutions.si.api.isiapioutputsitevehicle.md) | Vehicle specific site output. |
| [OutputSitePedestrian](#outputsitepedestrian) | [`ISIAPIOutputSitePedestrian`](sidrasolutions.si.api.isiapioutputsitepedestrian.md) | Pedestrian specific site output. |
| [OutputSitePerson](#outputsiteperson) | [`ISIAPIOutputSitePerson`](sidrasolutions.si.api.isiapioutputsiteperson.md) | Person specific site output. |
| [OutputLegs](#outputlegs) | [`ISIAPIOutputLegs`](sidrasolutions.si.api.isiapioutputlegs.md) |  |
| [OutputMovementVehicleODs](#outputmovementvehicleods) | [`ISIAPIOutputMovementVehicleODs`](sidrasolutions.si.api.isiapioutputmovementvehicleods.md) |  |
| [OutputMovementPeds](#outputmovementpeds) | [`ISIAPIOutputMovementPeds`](sidrasolutions.si.api.isiapioutputmovementpeds.md) |  |
| [OutputMeteredRoundabout](#outputmeteredroundabout) | [`ISIAPIOutputMeteredRoundabout`](sidrasolutions.si.api.isiapioutputmeteredroundabout.md) |  |
| [OutputSequence](#outputsequence) | [`ISIAPIOutputSequence`](sidrasolutions.si.api.isiapioutputsequence.md) |  |
| [OutputAnalysis](#outputanalysis) | [`ISIAPIOutputAnalysis`](sidrasolutions.si.api.isiapioutputanalysis.md) |  |
| [OutputGraphTuples](#outputgraphtuples) | [`ISIAPIOutputGraphTuples`](sidrasolutions.si.api.isiapioutputgraphtuples.md) |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [NetworkSite](#networksite) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |
| [GeneratedByVersion](#generatedbyversion) | `string` |  |
| [Analysis_method](#analysis_method) | `int` |  |
| [TWSC_calib_adjusted](#twsc_calib_adjusted) | `int` |  |
| [NwSiteOffset](#nwsiteoffset) | `int` |  |
| [NwSite_SignalPlatoonMode](#nwsite_signalplatoonmode) | `int` |  |
| [OutputLegPersons](#outputlegpersons) | [`ISIAPIOutputLegPersons`](sidrasolutions.si.api.isiapioutputlegpersons.md) |  |
| [OutputMovementPersonODs](#outputmovementpersonods) | [`ISIAPIOutputMovementPersonODs`](sidrasolutions.si.api.isiapioutputmovementpersonods.md) |  |
| [OutputSiteRoutes](#outputsiteroutes) | [`ISIAPIOutputSiteRoutes`](sidrasolutions.si.api.isiapioutputsiteroutes.md) |  |
| [Analysis_method_flag](#analysis_method_flag) | `int` |  |
| [OutputPhaseMovTimingPaths](#outputphasemovtimingpaths) | [`ISIAPIOutputPhaseMovTimingPaths`](sidrasolutions.si.api.isiapioutputphasemovtimingpaths.md) |  |
| [HasSIDRUNUnsettledMsg](#hassidrununsettledmsg) | `bool` |  |
| [HasSIDRUNAWSCMsg](#hassidrunawscmsg) | `bool` |  |
| [OutputMultiSequenceAnalyses](#outputmultisequenceanalyses) | [`ISIAPIOutputMultiSequenceAnalyses`](sidrasolutions.si.api.isiapioutputmultisequenceanalyses.md) |  |

</div>

## Properties

### Generated {#generated}

Date and Time site output was created (Processed).

```csharp
DateTime Generated { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var generated = outputset.Generated;
        ```

    === "C++"

        ```cpp
        VARIANT generated;
        outputset->get_Generated(&generated);
        ```

    === "Python"

        ```python
        generated = outputset.Generated
        ```

### OutputSiteVehicle {#outputsitevehicle}

Vehicle specific site output.

```csharp
ISIAPIOutputSiteVehicle OutputSiteVehicle { get; }
```

**Type** [`ISIAPIOutputSiteVehicle`](sidrasolutions.si.api.isiapioutputsitevehicle.md)

**Value**

Type:

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSiteVehicle = outputset.OutputSiteVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteVehicle> outputSiteVehicle;
        outputset->get_OutputSiteVehicle(&outputSiteVehicle);
        ```

    === "Python"

        ```python
        output_site_vehicle = outputset.OutputSiteVehicle
        ```

### OutputSitePedestrian {#outputsitepedestrian}

Pedestrian specific site output.

```csharp
ISIAPIOutputSitePedestrian OutputSitePedestrian { get; }
```

**Type** [`ISIAPIOutputSitePedestrian`](sidrasolutions.si.api.isiapioutputsitepedestrian.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSitePedestrian = outputset.OutputSitePedestrian;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSitePedestrian> outputSitePedestrian;
        outputset->get_OutputSitePedestrian(&outputSitePedestrian);
        ```

    === "Python"

        ```python
        output_site_pedestrian = outputset.OutputSitePedestrian
        ```

### OutputSitePerson {#outputsiteperson}

Person specific site output.

```csharp
ISIAPIOutputSitePerson OutputSitePerson { get; }
```

**Type** [`ISIAPIOutputSitePerson`](sidrasolutions.si.api.isiapioutputsiteperson.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSitePerson = outputset.OutputSitePerson;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSitePerson> outputSitePerson;
        outputset->get_OutputSitePerson(&outputSitePerson);
        ```

    === "Python"

        ```python
        output_site_person = outputset.OutputSitePerson
        ```

### OutputLegs {#outputlegs}

```csharp
ISIAPIOutputLegs OutputLegs { get; }
```

**Type** [`ISIAPIOutputLegs`](sidrasolutions.si.api.isiapioutputlegs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLegs = outputset.OutputLegs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLegs> outputLegs;
        outputset->get_OutputLegs(&outputLegs);
        ```

    === "Python"

        ```python
        output_legs = outputset.OutputLegs
        ```

### OutputMovementVehicleODs {#outputmovementvehicleods}

```csharp
ISIAPIOutputMovementVehicleODs OutputMovementVehicleODs { get; }
```

**Type** [`ISIAPIOutputMovementVehicleODs`](sidrasolutions.si.api.isiapioutputmovementvehicleods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementVehicleODs = outputset.OutputMovementVehicleODs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementVehicleODs> outputMovementVehicleODs;
        outputset->get_OutputMovementVehicleODs(&outputMovementVehicleODs);
        ```

    === "Python"

        ```python
        output_movement_vehicle_o_ds = outputset.OutputMovementVehicleODs
        ```

### OutputMovementPeds {#outputmovementpeds}

```csharp
ISIAPIOutputMovementPeds OutputMovementPeds { get; }
```

**Type** [`ISIAPIOutputMovementPeds`](sidrasolutions.si.api.isiapioutputmovementpeds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementPeds = outputset.OutputMovementPeds;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPeds> outputMovementPeds;
        outputset->get_OutputMovementPeds(&outputMovementPeds);
        ```

    === "Python"

        ```python
        output_movement_peds = outputset.OutputMovementPeds
        ```

### OutputMeteredRoundabout {#outputmeteredroundabout}

```csharp
ISIAPIOutputMeteredRoundabout OutputMeteredRoundabout { get; }
```

**Type** [`ISIAPIOutputMeteredRoundabout`](sidrasolutions.si.api.isiapioutputmeteredroundabout.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMeteredRoundabout = outputset.OutputMeteredRoundabout;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMeteredRoundabout> outputMeteredRoundabout;
        outputset->get_OutputMeteredRoundabout(&outputMeteredRoundabout);
        ```

    === "Python"

        ```python
        output_metered_roundabout = outputset.OutputMeteredRoundabout
        ```

### OutputSequence {#outputsequence}

```csharp
ISIAPIOutputSequence OutputSequence { get; }
```

**Type** [`ISIAPIOutputSequence`](sidrasolutions.si.api.isiapioutputsequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSequence = outputset.OutputSequence;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSequence> outputSequence;
        outputset->get_OutputSequence(&outputSequence);
        ```

    === "Python"

        ```python
        output_sequence = outputset.OutputSequence
        ```

### OutputAnalysis {#outputanalysis}

```csharp
ISIAPIOutputAnalysis OutputAnalysis { get; }
```

**Type** [`ISIAPIOutputAnalysis`](sidrasolutions.si.api.isiapioutputanalysis.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputAnalysis = outputset.OutputAnalysis;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputAnalysis> outputAnalysis;
        outputset->get_OutputAnalysis(&outputAnalysis);
        ```

    === "Python"

        ```python
        output_analysis = outputset.OutputAnalysis
        ```

### OutputGraphTuples {#outputgraphtuples}

```csharp
ISIAPIOutputGraphTuples OutputGraphTuples { get; }
```

**Type** [`ISIAPIOutputGraphTuples`](sidrasolutions.si.api.isiapioutputgraphtuples.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputGraphTuples = outputset.OutputGraphTuples;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputGraphTuples> outputGraphTuples;
        outputset->get_OutputGraphTuples(&outputGraphTuples);
        ```

    === "Python"

        ```python
        output_graph_tuples = outputset.OutputGraphTuples
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = outputset.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        outputset->get_Site(&site);
        ```

    === "Python"

        ```python
        site = outputset.Site
        ```

### NetworkSite {#networksite}

```csharp
ISIAPINetworkSite NetworkSite { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSite = outputset.NetworkSite;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> networkSite;
        outputset->get_NetworkSite(&networkSite);
        ```

    === "Python"

        ```python
        network_site = outputset.NetworkSite
        ```

### GeneratedByVersion {#generatedbyversion}

```csharp
string GeneratedByVersion { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string generatedByVersion = outputset.GeneratedByVersion;
        ```

    === "C++"

        ```cpp
        CComBSTR generatedByVersion;
        outputset->get_GeneratedByVersion(&generatedByVersion);
        ```

    === "Python"

        ```python
        generated_by_version = outputset.GeneratedByVersion
        ```

### Analysis_method {#analysis_method}

```csharp
int Analysis_method { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_method = outputset.Analysis_method;
        ```

    === "C++"

        ```cpp
        long analysis_method;
        outputset->get_Analysis_method(&analysis_method);
        ```

    === "Python"

        ```python
        analysis_method = outputset.Analysis_method
        ```

### TWSC_calib_adjusted {#twsc_calib_adjusted}

```csharp
int TWSC_calib_adjusted { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int tWSC_calib_adjusted = outputset.TWSC_calib_adjusted;
        ```

    === "C++"

        ```cpp
        long tWSC_calib_adjusted;
        outputset->get_TWSC_calib_adjusted(&tWSC_calib_adjusted);
        ```

    === "Python"

        ```python
        twsc_calib_adjusted = outputset.TWSC_calib_adjusted
        ```

### NwSiteOffset {#nwsiteoffset}

```csharp
int NwSiteOffset { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int nwSiteOffset = outputset.NwSiteOffset;
        ```

    === "C++"

        ```cpp
        long nwSiteOffset;
        outputset->get_NwSiteOffset(&nwSiteOffset);
        ```

    === "Python"

        ```python
        nw_site_offset = outputset.NwSiteOffset
        ```

### NwSite_SignalPlatoonMode {#nwsite_signalplatoonmode}

```csharp
int NwSite_SignalPlatoonMode { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int nwSite_SignalPlatoonMode = outputset.NwSite_SignalPlatoonMode;
        ```

    === "C++"

        ```cpp
        long nwSite_SignalPlatoonMode;
        outputset->get_NwSite_SignalPlatoonMode(&nwSite_SignalPlatoonMode);
        ```

    === "Python"

        ```python
        nw_site__signal_platoon_mode = outputset.NwSite_SignalPlatoonMode
        ```

### OutputLegPersons {#outputlegpersons}

```csharp
ISIAPIOutputLegPersons OutputLegPersons { get; }
```

**Type** [`ISIAPIOutputLegPersons`](sidrasolutions.si.api.isiapioutputlegpersons.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputLegPersons = outputset.OutputLegPersons;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputLegPersons> outputLegPersons;
        outputset->get_OutputLegPersons(&outputLegPersons);
        ```

    === "Python"

        ```python
        output_leg_persons = outputset.OutputLegPersons
        ```

### OutputMovementPersonODs {#outputmovementpersonods}

```csharp
ISIAPIOutputMovementPersonODs OutputMovementPersonODs { get; }
```

**Type** [`ISIAPIOutputMovementPersonODs`](sidrasolutions.si.api.isiapioutputmovementpersonods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMovementPersonODs = outputset.OutputMovementPersonODs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMovementPersonODs> outputMovementPersonODs;
        outputset->get_OutputMovementPersonODs(&outputMovementPersonODs);
        ```

    === "Python"

        ```python
        output_movement_person_o_ds = outputset.OutputMovementPersonODs
        ```

### OutputSiteRoutes {#outputsiteroutes}

```csharp
ISIAPIOutputSiteRoutes OutputSiteRoutes { get; }
```

**Type** [`ISIAPIOutputSiteRoutes`](sidrasolutions.si.api.isiapioutputsiteroutes.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSiteRoutes = outputset.OutputSiteRoutes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteRoutes> outputSiteRoutes;
        outputset->get_OutputSiteRoutes(&outputSiteRoutes);
        ```

    === "Python"

        ```python
        output_site_routes = outputset.OutputSiteRoutes
        ```

### Analysis_method_flag {#analysis_method_flag}

```csharp
int Analysis_method_flag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_method_flag = outputset.Analysis_method_flag;
        ```

    === "C++"

        ```cpp
        long analysis_method_flag;
        outputset->get_Analysis_method_flag(&analysis_method_flag);
        ```

    === "Python"

        ```python
        analysis_method_flag = outputset.Analysis_method_flag
        ```

### OutputPhaseMovTimingPaths {#outputphasemovtimingpaths}

```csharp
ISIAPIOutputPhaseMovTimingPaths OutputPhaseMovTimingPaths { get; }
```

**Type** [`ISIAPIOutputPhaseMovTimingPaths`](sidrasolutions.si.api.isiapioutputphasemovtimingpaths.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputPhaseMovTimingPaths = outputset.OutputPhaseMovTimingPaths;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputPhaseMovTimingPaths> outputPhaseMovTimingPaths;
        outputset->get_OutputPhaseMovTimingPaths(&outputPhaseMovTimingPaths);
        ```

    === "Python"

        ```python
        output_phase_mov_timing_paths = outputset.OutputPhaseMovTimingPaths
        ```

### HasSIDRUNUnsettledMsg {#hassidrununsettledmsg}

```csharp
bool HasSIDRUNUnsettledMsg { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool hasSIDRUNUnsettledMsg = outputset.HasSIDRUNUnsettledMsg;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL hasSIDRUNUnsettledMsg;
        outputset->get_HasSIDRUNUnsettledMsg(&hasSIDRUNUnsettledMsg);
        ```

    === "Python"

        ```python
        has_sidrun_unsettled_msg = outputset.HasSIDRUNUnsettledMsg
        ```

### HasSIDRUNAWSCMsg {#hassidrunawscmsg}

```csharp
bool HasSIDRUNAWSCMsg { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool hasSIDRUNAWSCMsg = outputset.HasSIDRUNAWSCMsg;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL hasSIDRUNAWSCMsg;
        outputset->get_HasSIDRUNAWSCMsg(&hasSIDRUNAWSCMsg);
        ```

    === "Python"

        ```python
        has_sidrunawsc_msg = outputset.HasSIDRUNAWSCMsg
        ```

### OutputMultiSequenceAnalyses {#outputmultisequenceanalyses}

```csharp
ISIAPIOutputMultiSequenceAnalyses OutputMultiSequenceAnalyses { get; }
```

**Type** [`ISIAPIOutputMultiSequenceAnalyses`](sidrasolutions.si.api.isiapioutputmultisequenceanalyses.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputMultiSequenceAnalyses = outputset.OutputMultiSequenceAnalyses;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputMultiSequenceAnalyses> outputMultiSequenceAnalyses;
        outputset->get_OutputMultiSequenceAnalyses(&outputMultiSequenceAnalyses);
        ```

    === "Python"

        ```python
        output_multi_sequence_analyses = outputset.OutputMultiSequenceAnalyses
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsitepedestrian.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSitePedestrian
title: OutputSitePedestrian
name: ISIAPIOutputSitePedestrian
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 76FE6B33-E1F4-4676-B01A-97082F08FCCE
summary: SIDRA INTERSECTION Pedestrian specific site output wrapper interface.
members:
  - float Demand_flow_total
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_total
  - string Level_of_service
  - string Level_of_service_worstmov
  - float Queue_maxback_mean
  - float Queue_dist_maxback_mean
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Deg_satn
  - float Operating_cost_total
  - float Operating_cost_rate
  - float Time_cost_total
  - float Time_cost_rate
  - ISIAPIOutputset Outputset
---

# OutputSitePedestrian

Type `ISIAPIOutputSitePedestrian` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `76FE6B33-E1F4-4676-B01A-97082F08FCCE`

SIDRA INTERSECTION Pedestrian specific site output wrapper interface.

## Declaration

```csharp
[Guid("76FE6B33-E1F4-4676-B01A-97082F08FCCE")]
public interface ISIAPIOutputSitePedestrian
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Demand_flow_total](#demand_flow_total) | `float` | Total pedestrian demand flow. |
| [Delay_control_average](#delay_control_average) | `float` | Average control delay. |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` | Average control delay for worst pedestrian movement. |
| [Delay_control_total](#delay_control_total) | `float` | Total control delay. |
| [Level_of_service](#level_of_service) | `string` | Intersection pedestrian LOS. |
| [Level_of_service_worstmov](#level_of_service_worstmov) | `string` | Worst pedestrian movement LOS. |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` | Pedestrian queue (peds), mean. |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` | Longest pedestrian queue (distance), mean. |
| [Stop_rate](#stop_rate) | `float` | Effective stop rate. |
| [Stops_total](#stops_total) | `float` | Total effective stops. |
| [Proportion_queued](#proportion_queued) | `float` | Proportion queued. |
| [Performance_index](#performance_index) | `float` | Performance index. |
| [Travel_distance_total](#travel_distance_total) | `float` | Total travel distance. |
| [Travel_distance_average](#travel_distance_average) | `float` | Average travel distance. |
| [Travel_time_total](#travel_time_total) | `float` | Total travel time (veh-h/h). |
| [Travel_time_average](#travel_time_average) | `float` | Average travel time (secs). |
| [Travel_speed](#travel_speed) | `float` | Average travel speed. |
| [Deg_satn](#deg_satn) | `float` | Intersection degree of saturation. |
| [Operating_cost_total](#operating_cost_total) | `float` | Total operating cost (cost unit/h). |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |

</div>

## Properties

### Demand_flow_total {#demand_flow_total}

Total pedestrian demand flow.

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputSitePedestrian.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputSitePedestrian->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputSitePedestrian.Demand_flow_total
        ```

### Delay_control_average {#delay_control_average}

Average control delay.

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputSitePedestrian.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputSitePedestrian->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputSitePedestrian.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

Average control delay for worst pedestrian movement.

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputSitePedestrian.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputSitePedestrian->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputSitePedestrian.Delay_control_average_worstmov
        ```

### Delay_control_total {#delay_control_total}

Total control delay.

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputSitePedestrian.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputSitePedestrian->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputSitePedestrian.Delay_control_total
        ```

### Level_of_service {#level_of_service}

Intersection pedestrian LOS.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputSitePedestrian.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputSitePedestrian->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputSitePedestrian.Level_of_service
        ```

### Level_of_service_worstmov {#level_of_service_worstmov}

Worst pedestrian movement LOS.

```csharp
string Level_of_service_worstmov { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstmov = outputSitePedestrian.Level_of_service_worstmov;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstmov;
        outputSitePedestrian->get_Level_of_service_worstmov(&level_of_service_worstmov);
        ```

    === "Python"

        ```python
        level_of_service_worstmov = outputSitePedestrian.Level_of_service_worstmov
        ```

### Queue_maxback_mean {#queue_maxback_mean}

Pedestrian queue (peds), mean.

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputSitePedestrian.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputSitePedestrian->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputSitePedestrian.Queue_maxback_mean
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

Longest pedestrian queue (distance), mean.

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputSitePedestrian.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputSitePedestrian->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputSitePedestrian.Queue_dist_maxback_mean
        ```

### Stop_rate {#stop_rate}

Effective stop rate.

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputSitePedestrian.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputSitePedestrian->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputSitePedestrian.Stop_rate
        ```

### Stops_total {#stops_total}

Total effective stops.

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputSitePedestrian.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputSitePedestrian->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputSitePedestrian.Stops_total
        ```

### Proportion_queued {#proportion_queued}

Proportion queued.

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputSitePedestrian.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputSitePedestrian->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputSitePedestrian.Proportion_queued
        ```

### Performance_index {#performance_index}

Performance index.

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputSitePedestrian.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputSitePedestrian->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputSitePedestrian.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

Total travel distance.

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputSitePedestrian.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputSitePedestrian->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputSitePedestrian.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

Average travel distance.

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputSitePedestrian.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputSitePedestrian->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputSitePedestrian.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

Total travel time (veh-h/h).

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputSitePedestrian.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputSitePedestrian->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputSitePedestrian.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

Average travel time (secs).

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputSitePedestrian.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputSitePedestrian->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputSitePedestrian.Travel_time_average
        ```

### Travel_speed {#travel_speed}

Average travel speed.

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputSitePedestrian.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputSitePedestrian->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputSitePedestrian.Travel_speed
        ```

### Deg_satn {#deg_satn}

Intersection degree of saturation.

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputSitePedestrian.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputSitePedestrian->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputSitePedestrian.Deg_satn
        ```

### Operating_cost_total {#operating_cost_total}

Total operating cost (cost unit/h).

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputSitePedestrian.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputSitePedestrian->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputSitePedestrian.Operating_cost_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputSitePedestrian.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputSitePedestrian->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputSitePedestrian.Operating_cost_rate
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputSitePedestrian.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputSitePedestrian->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputSitePedestrian.Time_cost_total
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputSitePedestrian.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputSitePedestrian->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputSitePedestrian.Time_cost_rate
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputSitePedestrian.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputSitePedestrian->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputSitePedestrian.Outputset
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsiteperson.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSitePerson
title: OutputSitePerson
name: ISIAPIOutputSitePerson
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5C61E636-2D60-4A76-8B60-1DAEA0CE3872
summary: SIDRA INTERSECTION Person specific site output wrapper interface.
members:
  - float Demand_flow_total
  - float Arrival_flow_total
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_total
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Operating_cost_rate
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
  - ISIAPIOutputset Outputset
---

# OutputSitePerson

Type `ISIAPIOutputSitePerson` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5C61E636-2D60-4A76-8B60-1DAEA0CE3872`

SIDRA INTERSECTION Person specific site output wrapper interface.

## Declaration

```csharp
[Guid("5C61E636-2D60-4A76-8B60-1DAEA0CE3872")]
public interface ISIAPIOutputSitePerson
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Demand_flow_total](#demand_flow_total) | `float` | Total person Demand Flow. |
| [Arrival_flow_total](#arrival_flow_total) | `float` | Total person Arrival Flow. |
| [Delay_control_average](#delay_control_average) | `float` | Average control delay. |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` | Average control delay for worst pedestrian movement. |
| [Delay_control_total](#delay_control_total) | `float` | Total control delay. |
| [Stop_rate](#stop_rate) | `float` | Effective stop rate. |
| [Stops_total](#stops_total) | `float` | Total effective stops. |
| [Proportion_queued](#proportion_queued) | `float` | Proportion queued. |
| [Performance_index](#performance_index) | `float` | Performance index. |
| [Travel_distance_total](#travel_distance_total) | `float` | Total travel distance. |
| [Travel_distance_average](#travel_distance_average) | `float` | Average travel distance. |
| [Travel_time_total](#travel_time_total) | `float` | Total travel time (veh-h/h). |
| [Travel_time_average](#travel_time_average) | `float` | Average travel time (secs). |
| [Travel_speed](#travel_speed) | `float` | Average travel speed. |
| [Operating_cost_total](#operating_cost_total) | `float` | Total operating cost (cost unit/h). |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |

</div>

## Properties

### Demand_flow_total {#demand_flow_total}

Total person Demand Flow.

```csharp
float Demand_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float demand_flow_total = outputSitePerson.Demand_flow_total;
        ```

    === "C++"

        ```cpp
        double demand_flow_total;
        outputSitePerson->get_Demand_flow_total(&demand_flow_total);
        ```

    === "Python"

        ```python
        demand_flow_total = outputSitePerson.Demand_flow_total
        ```

### Arrival_flow_total {#arrival_flow_total}

Total person Arrival Flow.

```csharp
float Arrival_flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float arrival_flow_total = outputSitePerson.Arrival_flow_total;
        ```

    === "C++"

        ```cpp
        double arrival_flow_total;
        outputSitePerson->get_Arrival_flow_total(&arrival_flow_total);
        ```

    === "Python"

        ```python
        arrival_flow_total = outputSitePerson.Arrival_flow_total
        ```

### Delay_control_average {#delay_control_average}

Average control delay.

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputSitePerson.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputSitePerson->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputSitePerson.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

Average control delay for worst pedestrian movement.

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputSitePerson.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputSitePerson->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputSitePerson.Delay_control_average_worstmov
        ```

### Delay_control_total {#delay_control_total}

Total control delay.

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputSitePerson.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputSitePerson->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputSitePerson.Delay_control_total
        ```

### Stop_rate {#stop_rate}

Effective stop rate.

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputSitePerson.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputSitePerson->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputSitePerson.Stop_rate
        ```

### Stops_total {#stops_total}

Total effective stops.

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputSitePerson.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputSitePerson->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputSitePerson.Stops_total
        ```

### Proportion_queued {#proportion_queued}

Proportion queued.

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputSitePerson.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputSitePerson->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputSitePerson.Proportion_queued
        ```

### Performance_index {#performance_index}

Performance index.

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputSitePerson.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputSitePerson->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputSitePerson.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

Total travel distance.

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputSitePerson.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputSitePerson->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputSitePerson.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

Average travel distance.

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputSitePerson.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputSitePerson->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputSitePerson.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

Total travel time (veh-h/h).

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputSitePerson.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputSitePerson->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputSitePerson.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

Average travel time (secs).

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputSitePerson.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputSitePerson->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputSitePerson.Travel_time_average
        ```

### Travel_speed {#travel_speed}

Average travel speed.

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputSitePerson.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputSitePerson->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputSitePerson.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

Total operating cost (cost unit/h).

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputSitePerson.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputSitePerson->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputSitePerson.Operating_cost_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputSitePerson.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputSitePerson->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputSitePerson.Operating_cost_rate
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputSitePerson.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputSitePerson->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputSitePerson.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputSitePerson.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputSitePerson->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputSitePerson.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputSitePerson.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputSitePerson->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputSitePerson.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputSitePerson.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputSitePerson->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputSitePerson.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputSitePerson.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputSitePerson->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputSitePerson.Nox_total
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputSitePerson.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputSitePerson->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputSitePerson.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputSitePerson.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputSitePerson->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputSitePerson.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputSitePerson.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputSitePerson->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputSitePerson.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputSitePerson.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputSitePerson->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputSitePerson.Time_cost_rate
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputSitePerson.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputSitePerson->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputSitePerson.Outputset
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsiteroute.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSiteRoute
title: OutputSiteRoute
name: ISIAPIOutputSiteRoute
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BA4F40C8-7DC3-4FBE-894D-1D469D0BD760
members:
  - string RouteName
  - int RouteSignalOffsetPriority
  - string Route_id
  - float Coord_mov_phasetime
  - float Coord_mov_effgreen
  - float Coord_mov_eff_start_time
  - float Coord_mov_displayed_start_time
  - float Coord_mov_displayed_green_time
  - ISIAPIOutputset Outputset
---

# OutputSiteRoute

Type `ISIAPIOutputSiteRoute` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BA4F40C8-7DC3-4FBE-894D-1D469D0BD760`

## Declaration

```csharp
[Guid("BA4F40C8-7DC3-4FBE-894D-1D469D0BD760")]
public interface ISIAPIOutputSiteRoute
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [RouteName](#routename) | `string` |  |
| [RouteSignalOffsetPriority](#routesignaloffsetpriority) | `int` |  |
| [Route_id](#route_id) | `string` |  |
| [Coord_mov_phasetime](#coord_mov_phasetime) | `float` |  |
| [Coord_mov_effgreen](#coord_mov_effgreen) | `float` |  |
| [Coord_mov_eff_start_time](#coord_mov_eff_start_time) | `float` |  |
| [Coord_mov_displayed_start_time](#coord_mov_displayed_start_time) | `float` |  |
| [Coord_mov_displayed_green_time](#coord_mov_displayed_green_time) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |

</div>

## Properties

### RouteName {#routename}

```csharp
string RouteName { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string routeName = outputSiteRoute.RouteName;
        ```

    === "C++"

        ```cpp
        CComBSTR routeName;
        outputSiteRoute->get_RouteName(&routeName);
        ```

    === "Python"

        ```python
        route_name = outputSiteRoute.RouteName
        ```

### RouteSignalOffsetPriority {#routesignaloffsetpriority}

```csharp
int RouteSignalOffsetPriority { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int routeSignalOffsetPriority = outputSiteRoute.RouteSignalOffsetPriority;
        ```

    === "C++"

        ```cpp
        long routeSignalOffsetPriority;
        outputSiteRoute->get_RouteSignalOffsetPriority(&routeSignalOffsetPriority);
        ```

    === "Python"

        ```python
        route_signal_offset_priority = outputSiteRoute.RouteSignalOffsetPriority
        ```

### Route_id {#route_id}

```csharp
string Route_id { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string route_id = outputSiteRoute.Route_id;
        ```

    === "C++"

        ```cpp
        CComBSTR route_id;
        outputSiteRoute->get_Route_id(&route_id);
        ```

    === "Python"

        ```python
        route_id = outputSiteRoute.Route_id
        ```

### Coord_mov_phasetime {#coord_mov_phasetime}

```csharp
float Coord_mov_phasetime { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float coord_mov_phasetime = outputSiteRoute.Coord_mov_phasetime;
        ```

    === "C++"

        ```cpp
        double coord_mov_phasetime;
        outputSiteRoute->get_Coord_mov_phasetime(&coord_mov_phasetime);
        ```

    === "Python"

        ```python
        coord_mov_phasetime = outputSiteRoute.Coord_mov_phasetime
        ```

### Coord_mov_effgreen {#coord_mov_effgreen}

```csharp
float Coord_mov_effgreen { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float coord_mov_effgreen = outputSiteRoute.Coord_mov_effgreen;
        ```

    === "C++"

        ```cpp
        double coord_mov_effgreen;
        outputSiteRoute->get_Coord_mov_effgreen(&coord_mov_effgreen);
        ```

    === "Python"

        ```python
        coord_mov_effgreen = outputSiteRoute.Coord_mov_effgreen
        ```

### Coord_mov_eff_start_time {#coord_mov_eff_start_time}

```csharp
float Coord_mov_eff_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float coord_mov_eff_start_time = outputSiteRoute.Coord_mov_eff_start_time;
        ```

    === "C++"

        ```cpp
        double coord_mov_eff_start_time;
        outputSiteRoute->get_Coord_mov_eff_start_time(&coord_mov_eff_start_time);
        ```

    === "Python"

        ```python
        coord_mov_eff_start_time = outputSiteRoute.Coord_mov_eff_start_time
        ```

### Coord_mov_displayed_start_time {#coord_mov_displayed_start_time}

```csharp
float Coord_mov_displayed_start_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float coord_mov_displayed_start_time = outputSiteRoute.Coord_mov_displayed_start_time;
        ```

    === "C++"

        ```cpp
        double coord_mov_displayed_start_time;
        outputSiteRoute->get_Coord_mov_displayed_start_time(&coord_mov_displayed_start_time);
        ```

    === "Python"

        ```python
        coord_mov_displayed_start_time = outputSiteRoute.Coord_mov_displayed_start_time
        ```

### Coord_mov_displayed_green_time {#coord_mov_displayed_green_time}

```csharp
float Coord_mov_displayed_green_time { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float coord_mov_displayed_green_time = outputSiteRoute.Coord_mov_displayed_green_time;
        ```

    === "C++"

        ```cpp
        double coord_mov_displayed_green_time;
        outputSiteRoute->get_Coord_mov_displayed_green_time(&coord_mov_displayed_green_time);
        ```

    === "Python"

        ```python
        coord_mov_displayed_green_time = outputSiteRoute.Coord_mov_displayed_green_time
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputSiteRoute.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputSiteRoute->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputSiteRoute.Outputset
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsiteroutes.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSiteRoutes
title: OutputSiteRoutes
name: ISIAPIOutputSiteRoutes
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D82C5B78-EF2A-4A30-8E3A-74E391559E70
members:
  - bool Exists(string routeName)
  - ISIAPIOutputSiteRoute this[string routeName]
  - ISIAPIOutputSiteRoute this[int index]
  - int Count
---

# OutputSiteRoutes

Type `ISIAPIOutputSiteRoutes` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D82C5B78-EF2A-4A30-8E3A-74E391559E70`

## Declaration

```csharp
[Guid("D82C5B78-EF2A-4A30-8E3A-74E391559E70")]
public interface ISIAPIOutputSiteRoutes
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputSiteRoute`](sidrasolutions.si.api.isiapioutputsiteroute.md) |  |
| [this[]](#this) | [`ISIAPIOutputSiteRoute`](sidrasolutions.si.api.isiapioutputsiteroute.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Exists(string)](#exists-string) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputSiteRoutes.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputSiteRoutes->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputSiteRoutes.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputSiteRoute this[] { get; }
```

**Type** [`ISIAPIOutputSiteRoute`](sidrasolutions.si.api.isiapioutputsiteroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputSiteRoutes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteRoute> this[];
        outputSiteRoutes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputSiteRoutes.this[]
        ```

### this[] {#this}

```csharp
ISIAPIOutputSiteRoute this[] { get; }
```

**Type** [`ISIAPIOutputSiteRoute`](sidrasolutions.si.api.isiapioutputsiteroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputSiteRoutes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteRoute> this[];
        outputSiteRoutes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputSiteRoutes.this[]
        ```

## Methods

### Exists(string) {#exists-string}

```csharp
bool Exists(string routeName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `routeName` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputSiteRoutes.Exists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputSiteRoutes->Exists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = outputSiteRoutes.Exists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsitevehicle.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSiteVehicle
title: OutputSiteVehicle
name: ISIAPIOutputSiteVehicle
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: BEF9733F-A4F1-4206-9BAB-084ED8F8A305
summary: SIDRA INTERSECTION Vehicle specific site output wrapper class.
members:
  - float Flow_total
  - float Flow_LV
  - float Flow_HV
  - float Flow_HV_pct
  - float Flow_total_capconstr
  - float Flow_LV_capconstr
  - float Flow_HV_capconstr
  - float Flow_HV_pct_capconstr
  - float Capacity_effective
  - float Capacity_lane_total
  - float Capacity_mov_total
  - float Deg_satn
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_average_worstlane
  - float Delay_control_total
  - float Delay_stopline_average
  - float Delay_geometric_average
  - string Level_of_service
  - string Level_of_service_av_int_delay
  - string Level_of_service_worstmov
  - string Level_of_service_worstlane
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Operating_cost_rate
  - float Fuel_consumption_rate
  - float Carbon_dioxide_rate
  - float Hydrocarbons_rate
  - float Carbon_monoxide_rate
  - float Nox_rate
  - float Idling_time_average
  - int Analysis_method
  - float SpeedEfficiency
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Capacity_adj_worstlane
  - int Capacity_adj_flag_worstlane
  - float Avg_num_of_cycles_to_depart
  - float Model_timing_vari_index
  - float Max_timit_dx_percent
  - float Max_timit_dx_percent_prev
  - float Max_timit_dx_percent_prev2
  - int TimIterationsCount
  - int Max_TimIterations
  - float Model_flowcap_vari_index
  - float Max_subit_dx_percent
  - float Max_subit_dx_percent_prev
  - float Max_subit_dx_percent_prev2
  - int SubIterationsCount
  - int Max_SubIterations
  - float Max_subit_capacity_diff
  - float Max_subit_capacity_percent
  - float DesiredSpeed
  - int DesiredSpeedMethod
  - float DesiredSpeedProgram
  - float TravelTimeIndex
  - float CongestionCoefficient
  - int SpeedEfficiencyFlag
  - float Travel_time_total_at_desired_speed
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Veh_operating_cost_rate
  - float Time_cost_rate
  - ISIAPIOutputset Outputset
  - ISIAPIOutputSiteVehicleMCs OutputSiteVehicleMCs
  - float MaxDxPct
  - float MaxDxPctPrev
  - float MaxDxPctPrev2
  - float DiffDelayControlAveragePct
  - float DiffDelayControlAveragePctPrev
  - float DiffDelayControlAveragePctPrev2
  - float DiffSpeedEfficiencyPct
  - float DiffSpeedEfficiencyPctPrev
  - float DiffSpeedEfficiencyPctPrev2
---

# OutputSiteVehicle

Type `ISIAPIOutputSiteVehicle` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `BEF9733F-A4F1-4206-9BAB-084ED8F8A305`

SIDRA INTERSECTION Vehicle specific site output wrapper class.

## Declaration

```csharp
[Guid("BEF9733F-A4F1-4206-9BAB-084ED8F8A305")]
public interface ISIAPIOutputSiteVehicle
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Flow_total](#flow_total) | `float` | Total Demand Flow Rate. |
| [Flow_LV](#flow_lv) | `float` | Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV](#flow_hv) | `float` | Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct](#flow_hv_pct) | `float` | Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` | Total Arrival Flow Rate. |
| [Flow_LV_capconstr](#flow_lv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation. |
| [Flow_HV_capconstr](#flow_hv_capconstr) | `float` | Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation. |
| [Flow_HV_pct_capconstr](#flow_hv_pct_capconstr) | `float` | Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation. |
| [Capacity_effective](#capacity_effective) | `float` | Effective intersection capacity. |
| [Capacity_lane_total](#capacity_lane_total) | `float` | Sum of all lane capacities. |
| [Capacity_mov_total](#capacity_mov_total) | `float` | Sum of movement capacities (includes effect of lane underutilisation within movement). |
| [Deg_satn](#deg_satn) | `float` | Intersection degree of saturation. |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` | Lowest practical degree of saturation. |
| [Delay_control_average](#delay_control_average) | `float` | Average control delay. |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` | Average control delay for worst movement. |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` | Average control delay for worst lane. |
| [Delay_control_total](#delay_control_total) | `float` | Total control delay. |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Delay_geometric_average](#delay_geometric_average) | `float` |  |
| [Level_of_service](#level_of_service) | `string` | Intersection LOS. |
| [Level_of_service_av_int_delay](#level_of_service_av_int_delay) | `string` | Average intersection delay LOS. |
| [Level_of_service_worstmov](#level_of_service_worstmov) | `string` | Worst movement LOS. |
| [Level_of_service_worstlane](#level_of_service_worstlane) | `string` | Worst lane LOS. |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` | Longest cycle-average queue (veh), mean. |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` | Longest cycle-average queue (veh), user-specified percentile. |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` | Longest maximum back of queue (veh), mean. |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` | Longest maximum back of queue (veh), user-specified percentile. |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` | Longest cycle-average queue (distance), mean. |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` | Longest cycle-average queue (distance), user-specified percentile. |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` | Longest maximum back of queue (distance), mean. |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` | Longest maximum back of queue (distance), user-specified percentile. |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` | Queue storage ratio based on maximum back of queue (distance), mean |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` | Queue storage ratio based on maximum back of queue (distance), user-specified percentile |
| [Stop_rate](#stop_rate) | `float` | Effective stop rate. |
| [Stops_total](#stops_total) | `float` | Total effective stops. |
| [Proportion_queued](#proportion_queued) | `float` | Proportion queued. |
| [Performance_index](#performance_index) | `float` | Performance index. |
| [Travel_distance_total](#travel_distance_total) | `float` | Total travel distance. |
| [Travel_distance_average](#travel_distance_average) | `float` | Average travel distance. |
| [Travel_time_total](#travel_time_total) | `float` | Total travel time. |
| [Travel_time_average](#travel_time_average) | `float` | Average travel time. |
| [Travel_speed](#travel_speed) | `float` | Average travel speed. |
| [Operating_cost_total](#operating_cost_total) | `float` | Total operating cost (cost unit/h) |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` | Total fuel consumption. |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` | Total Carbon Dioxide emissions (kg/h). |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` | Total Hydrocarbon emissions (kg/h). |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` | Total Carbon Monoxide emissions (kg/h). |
| [Nox_total](#nox_total) | `float` | Total NOX emissions (kg/h). |
| [Operating_cost_rate](#operating_cost_rate) | `float` | Operating cost rate (cost unit/km). |
| [Fuel_consumption_rate](#fuel_consumption_rate) | `float` | Fuel consumption rate. |
| [Carbon_dioxide_rate](#carbon_dioxide_rate) | `float` | Carbon Dioxide emission rate (g/km). |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` | Hydrocarbon emission rate (g/km). |
| [Carbon_monoxide_rate](#carbon_monoxide_rate) | `float` | Carbon Monoxide emission rate (g/km). |
| [Nox_rate](#nox_rate) | `float` | NOX emission rate (g/km). |
| [Idling_time_average](#idling_time_average) | `float` |  |
| [Analysis_method](#analysis_method) | `int` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Capacity_adj_worstlane](#capacity_adj_worstlane) | `float` |  |
| [Capacity_adj_flag_worstlane](#capacity_adj_flag_worstlane) | `int` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [Model_timing_vari_index](#model_timing_vari_index) | `float` |  |
| [Max_timit_dx_percent](#max_timit_dx_percent) | `float` |  |
| [Max_timit_dx_percent_prev](#max_timit_dx_percent_prev) | `float` |  |
| [Max_timit_dx_percent_prev2](#max_timit_dx_percent_prev2) | `float` |  |
| [TimIterationsCount](#timiterationscount) | `int` |  |
| [Max_TimIterations](#max_timiterations) | `int` |  |
| [Model_flowcap_vari_index](#model_flowcap_vari_index) | `float` |  |
| [Max_subit_dx_percent](#max_subit_dx_percent) | `float` |  |
| [Max_subit_dx_percent_prev](#max_subit_dx_percent_prev) | `float` |  |
| [Max_subit_dx_percent_prev2](#max_subit_dx_percent_prev2) | `float` |  |
| [SubIterationsCount](#subiterationscount) | `int` |  |
| [Max_SubIterations](#max_subiterations) | `int` |  |
| [Max_subit_capacity_diff](#max_subit_capacity_diff) | `float` |  |
| [Max_subit_capacity_percent](#max_subit_capacity_percent) | `float` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` | Speed Efficiency Flag |
| [Travel_time_total_at_desired_speed](#travel_time_total_at_desired_speed) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) |  |
| [OutputSiteVehicleMCs](#outputsitevehiclemcs) | [`ISIAPIOutputSiteVehicleMCs`](sidrasolutions.si.api.isiapioutputsitevehiclemcs.md) |  |
| [MaxDxPct](#maxdxpct) | `float` |  |
| [MaxDxPctPrev](#maxdxpctprev) | `float` |  |
| [MaxDxPctPrev2](#maxdxpctprev2) | `float` |  |
| [DiffDelayControlAveragePct](#diffdelaycontrolaveragepct) | `float` |  |
| [DiffDelayControlAveragePctPrev](#diffdelaycontrolaveragepctprev) | `float` |  |
| [DiffDelayControlAveragePctPrev2](#diffdelaycontrolaveragepctprev2) | `float` |  |
| [DiffSpeedEfficiencyPct](#diffspeedefficiencypct) | `float` |  |
| [DiffSpeedEfficiencyPctPrev](#diffspeedefficiencypctprev) | `float` |  |
| [DiffSpeedEfficiencyPctPrev2](#diffspeedefficiencypctprev2) | `float` |  |

</div>

## Properties

### Flow_total {#flow_total}

Total Demand Flow Rate.

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputSiteVehicle.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputSiteVehicle->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputSiteVehicle.Flow_total
        ```

### Flow_LV {#flow_lv}

Demand Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV = outputSiteVehicle.Flow_LV;
        ```

    === "C++"

        ```cpp
        double flow_LV;
        outputSiteVehicle->get_Flow_LV(&flow_LV);
        ```

    === "Python"

        ```python
        flow_lv = outputSiteVehicle.Flow_LV
        ```

### Flow_HV {#flow_hv}

Demand Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV = outputSiteVehicle.Flow_HV;
        ```

    === "C++"

        ```cpp
        double flow_HV;
        outputSiteVehicle->get_Flow_HV(&flow_HV);
        ```

    === "Python"

        ```python
        flow_hv = outputSiteVehicle.Flow_HV
        ```

### Flow_HV_pct {#flow_hv_pct}

Demand Flow Rate Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct = outputSiteVehicle.Flow_HV_pct;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct;
        outputSiteVehicle->get_Flow_HV_pct(&flow_HV_pct);
        ```

    === "Python"

        ```python
        flow_hv_pct = outputSiteVehicle.Flow_HV_pct
        ```

### Flow_total_capconstr {#flow_total_capconstr}

Total Arrival Flow Rate.

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputSiteVehicle.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputSiteVehicle->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputSiteVehicle.Flow_total_capconstr
        ```

### Flow_LV_capconstr {#flow_lv_capconstr}

Arrival Flow Rate of all Movement Classes with Light Vehicle Model Designation.

```csharp
float Flow_LV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_LV_capconstr = outputSiteVehicle.Flow_LV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_LV_capconstr;
        outputSiteVehicle->get_Flow_LV_capconstr(&flow_LV_capconstr);
        ```

    === "Python"

        ```python
        flow_lv_capconstr = outputSiteVehicle.Flow_LV_capconstr
        ```

### Flow_HV_capconstr {#flow_hv_capconstr}

Arrival Flow Rate of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_capconstr = outputSiteVehicle.Flow_HV_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_capconstr;
        outputSiteVehicle->get_Flow_HV_capconstr(&flow_HV_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_capconstr = outputSiteVehicle.Flow_HV_capconstr
        ```

### Flow_HV_pct_capconstr {#flow_hv_pct_capconstr}

Arrival Flow Percentage (%) of all Movement Classes with Heavy Vehicle Model Designation.

```csharp
float Flow_HV_pct_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_HV_pct_capconstr = outputSiteVehicle.Flow_HV_pct_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_HV_pct_capconstr;
        outputSiteVehicle->get_Flow_HV_pct_capconstr(&flow_HV_pct_capconstr);
        ```

    === "Python"

        ```python
        flow_hv_pct_capconstr = outputSiteVehicle.Flow_HV_pct_capconstr
        ```

### Capacity_effective {#capacity_effective}

Effective intersection capacity.

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputSiteVehicle.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputSiteVehicle->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputSiteVehicle.Capacity_effective
        ```

### Capacity_lane_total {#capacity_lane_total}

Sum of all lane capacities.

```csharp
float Capacity_lane_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_lane_total = outputSiteVehicle.Capacity_lane_total;
        ```

    === "C++"

        ```cpp
        double capacity_lane_total;
        outputSiteVehicle->get_Capacity_lane_total(&capacity_lane_total);
        ```

    === "Python"

        ```python
        capacity_lane_total = outputSiteVehicle.Capacity_lane_total
        ```

### Capacity_mov_total {#capacity_mov_total}

Sum of movement capacities (includes effect of lane underutilisation within
movement).

```csharp
float Capacity_mov_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov_total = outputSiteVehicle.Capacity_mov_total;
        ```

    === "C++"

        ```cpp
        double capacity_mov_total;
        outputSiteVehicle->get_Capacity_mov_total(&capacity_mov_total);
        ```

    === "Python"

        ```python
        capacity_mov_total = outputSiteVehicle.Capacity_mov_total
        ```

### Deg_satn {#deg_satn}

Intersection degree of saturation.

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputSiteVehicle.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputSiteVehicle->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputSiteVehicle.Deg_satn
        ```

### Practical_spare_capacity {#practical_spare_capacity}

Lowest practical degree of saturation.

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputSiteVehicle.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputSiteVehicle->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputSiteVehicle.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

Average control delay.

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputSiteVehicle.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputSiteVehicle->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputSiteVehicle.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

Average control delay for worst movement.

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputSiteVehicle.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputSiteVehicle->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputSiteVehicle.Delay_control_average_worstmov
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

Average control delay for worst lane.

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputSiteVehicle.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputSiteVehicle->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputSiteVehicle.Delay_control_average_worstlane
        ```

### Delay_control_total {#delay_control_total}

Total control delay.

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputSiteVehicle.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputSiteVehicle->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputSiteVehicle.Delay_control_total
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputSiteVehicle.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputSiteVehicle->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputSiteVehicle.Delay_stopline_average
        ```

### Delay_geometric_average {#delay_geometric_average}

```csharp
float Delay_geometric_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric_average = outputSiteVehicle.Delay_geometric_average;
        ```

    === "C++"

        ```cpp
        double delay_geometric_average;
        outputSiteVehicle->get_Delay_geometric_average(&delay_geometric_average);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputSiteVehicle.Delay_geometric_average
        ```

### Level_of_service {#level_of_service}

Intersection LOS.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputSiteVehicle.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputSiteVehicle->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputSiteVehicle.Level_of_service
        ```

### Level_of_service_av_int_delay {#level_of_service_av_int_delay}

Average intersection delay LOS.

```csharp
string Level_of_service_av_int_delay { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_av_int_delay = outputSiteVehicle.Level_of_service_av_int_delay;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_av_int_delay;
        outputSiteVehicle->get_Level_of_service_av_int_delay(&level_of_service_av_int_delay);
        ```

    === "Python"

        ```python
        level_of_service_av_int_delay = outputSiteVehicle.Level_of_service_av_int_delay
        ```

### Level_of_service_worstmov {#level_of_service_worstmov}

Worst movement LOS.

```csharp
string Level_of_service_worstmov { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstmov = outputSiteVehicle.Level_of_service_worstmov;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstmov;
        outputSiteVehicle->get_Level_of_service_worstmov(&level_of_service_worstmov);
        ```

    === "Python"

        ```python
        level_of_service_worstmov = outputSiteVehicle.Level_of_service_worstmov
        ```

### Level_of_service_worstlane {#level_of_service_worstlane}

Worst lane LOS.

```csharp
string Level_of_service_worstlane { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstlane = outputSiteVehicle.Level_of_service_worstlane;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstlane;
        outputSiteVehicle->get_Level_of_service_worstlane(&level_of_service_worstlane);
        ```

    === "Python"

        ```python
        level_of_service_worstlane = outputSiteVehicle.Level_of_service_worstlane
        ```

### Queue_cycav_mean {#queue_cycav_mean}

Longest cycle-average queue (veh), mean.

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputSiteVehicle.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputSiteVehicle->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputSiteVehicle.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

Longest cycle-average queue (veh), user-specified percentile.

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputSiteVehicle.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputSiteVehicle->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputSiteVehicle.Queue_cycav_percentile
        ```

### Queue_maxback_mean {#queue_maxback_mean}

Longest maximum back of queue (veh), mean.

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputSiteVehicle.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputSiteVehicle->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputSiteVehicle.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

Longest maximum back of queue (veh), user-specified percentile.

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputSiteVehicle.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputSiteVehicle->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputSiteVehicle.Queue_maxback_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

Longest cycle-average queue (distance), mean.

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputSiteVehicle.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputSiteVehicle->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputSiteVehicle.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

Longest cycle-average queue (distance), user-specified percentile.

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputSiteVehicle.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputSiteVehicle->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputSiteVehicle.Queue_dist_cycav_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

Longest maximum back of queue (distance), mean.

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputSiteVehicle.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputSiteVehicle->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputSiteVehicle.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

Longest maximum back of queue (distance), user-specified percentile.

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputSiteVehicle.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputSiteVehicle->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputSiteVehicle.Queue_dist_maxback_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

Queue storage ratio based on maximum back of queue (distance), mean

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputSiteVehicle.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputSiteVehicle->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputSiteVehicle.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

Queue storage ratio based on maximum back of queue (distance), user-specified percentile

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputSiteVehicle.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputSiteVehicle->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputSiteVehicle.Queue_storage_ratio_percentile
        ```

### Stop_rate {#stop_rate}

Effective stop rate.

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputSiteVehicle.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputSiteVehicle->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputSiteVehicle.Stop_rate
        ```

### Stops_total {#stops_total}

Total effective stops.

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputSiteVehicle.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputSiteVehicle->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputSiteVehicle.Stops_total
        ```

### Proportion_queued {#proportion_queued}

Proportion queued.

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputSiteVehicle.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputSiteVehicle->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputSiteVehicle.Proportion_queued
        ```

### Performance_index {#performance_index}

Performance index.

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputSiteVehicle.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputSiteVehicle->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputSiteVehicle.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

Total travel distance.

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputSiteVehicle.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputSiteVehicle->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputSiteVehicle.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

Average travel distance.

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputSiteVehicle.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputSiteVehicle->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputSiteVehicle.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

Total travel time.

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputSiteVehicle.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputSiteVehicle->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputSiteVehicle.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

Average travel time.

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputSiteVehicle.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputSiteVehicle->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputSiteVehicle.Travel_time_average
        ```

### Travel_speed {#travel_speed}

Average travel speed.

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputSiteVehicle.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputSiteVehicle->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputSiteVehicle.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

Total operating cost (cost unit/h)

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputSiteVehicle.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputSiteVehicle->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputSiteVehicle.Operating_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

Total fuel consumption.

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputSiteVehicle.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputSiteVehicle->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputSiteVehicle.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

Total Carbon Dioxide emissions (kg/h).

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputSiteVehicle.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputSiteVehicle->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputSiteVehicle.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

Total Hydrocarbon emissions (kg/h).

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputSiteVehicle.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputSiteVehicle->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputSiteVehicle.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

Total Carbon Monoxide emissions (kg/h).

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputSiteVehicle.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputSiteVehicle->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputSiteVehicle.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

Total NOX emissions (kg/h).

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputSiteVehicle.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputSiteVehicle->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputSiteVehicle.Nox_total
        ```

### Operating_cost_rate {#operating_cost_rate}

Operating cost rate (cost unit/km).

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputSiteVehicle.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputSiteVehicle->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputSiteVehicle.Operating_cost_rate
        ```

### Fuel_consumption_rate {#fuel_consumption_rate}

Fuel consumption rate.

```csharp
float Fuel_consumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_rate = outputSiteVehicle.Fuel_consumption_rate;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_rate;
        outputSiteVehicle->get_Fuel_consumption_rate(&fuel_consumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputSiteVehicle.Fuel_consumption_rate
        ```

### Carbon_dioxide_rate {#carbon_dioxide_rate}

Carbon Dioxide emission rate (g/km).

```csharp
float Carbon_dioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_rate = outputSiteVehicle.Carbon_dioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_rate;
        outputSiteVehicle->get_Carbon_dioxide_rate(&carbon_dioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputSiteVehicle.Carbon_dioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

Hydrocarbon emission rate (g/km).

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputSiteVehicle.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputSiteVehicle->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputSiteVehicle.Hydrocarbons_rate
        ```

### Carbon_monoxide_rate {#carbon_monoxide_rate}

Carbon Monoxide emission rate (g/km).

```csharp
float Carbon_monoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_rate = outputSiteVehicle.Carbon_monoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_rate;
        outputSiteVehicle->get_Carbon_monoxide_rate(&carbon_monoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputSiteVehicle.Carbon_monoxide_rate
        ```

### Nox_rate {#nox_rate}

NOX emission rate (g/km).

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputSiteVehicle.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputSiteVehicle->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputSiteVehicle.Nox_rate
        ```

### Idling_time_average {#idling_time_average}

```csharp
float Idling_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idling_time_average = outputSiteVehicle.Idling_time_average;
        ```

    === "C++"

        ```cpp
        double idling_time_average;
        outputSiteVehicle->get_Idling_time_average(&idling_time_average);
        ```

    === "Python"

        ```python
        idling_time_average = outputSiteVehicle.Idling_time_average
        ```

### Analysis_method {#analysis_method}

```csharp
int Analysis_method { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int analysis_method = outputSiteVehicle.Analysis_method;
        ```

    === "C++"

        ```cpp
        long analysis_method;
        outputSiteVehicle->get_Analysis_method(&analysis_method);
        ```

    === "Python"

        ```python
        analysis_method = outputSiteVehicle.Analysis_method
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputSiteVehicle.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputSiteVehicle->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputSiteVehicle.SpeedEfficiency
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputSiteVehicle.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputSiteVehicle->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputSiteVehicle.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputSiteVehicle.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputSiteVehicle->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputSiteVehicle.Queue_greenstart_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputSiteVehicle.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputSiteVehicle->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputSiteVehicle.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputSiteVehicle.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputSiteVehicle->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputSiteVehicle.Queue_dist_greenstart_percentile
        ```

### Capacity_adj_worstlane {#capacity_adj_worstlane}

```csharp
float Capacity_adj_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj_worstlane = outputSiteVehicle.Capacity_adj_worstlane;
        ```

    === "C++"

        ```cpp
        double capacity_adj_worstlane;
        outputSiteVehicle->get_Capacity_adj_worstlane(&capacity_adj_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_worstlane = outputSiteVehicle.Capacity_adj_worstlane
        ```

### Capacity_adj_flag_worstlane {#capacity_adj_flag_worstlane}

```csharp
int Capacity_adj_flag_worstlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag_worstlane = outputSiteVehicle.Capacity_adj_flag_worstlane;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag_worstlane;
        outputSiteVehicle->get_Capacity_adj_flag_worstlane(&capacity_adj_flag_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_flag_worstlane = outputSiteVehicle.Capacity_adj_flag_worstlane
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputSiteVehicle.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputSiteVehicle->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputSiteVehicle.Avg_num_of_cycles_to_depart
        ```

### Model_timing_vari_index {#model_timing_vari_index}

```csharp
float Model_timing_vari_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float model_timing_vari_index = outputSiteVehicle.Model_timing_vari_index;
        ```

    === "C++"

        ```cpp
        double model_timing_vari_index;
        outputSiteVehicle->get_Model_timing_vari_index(&model_timing_vari_index);
        ```

    === "Python"

        ```python
        model_timing_vari_index = outputSiteVehicle.Model_timing_vari_index
        ```

### Max_timit_dx_percent {#max_timit_dx_percent}

```csharp
float Max_timit_dx_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_timit_dx_percent = outputSiteVehicle.Max_timit_dx_percent;
        ```

    === "C++"

        ```cpp
        double max_timit_dx_percent;
        outputSiteVehicle->get_Max_timit_dx_percent(&max_timit_dx_percent);
        ```

    === "Python"

        ```python
        max_timit_dx_percent = outputSiteVehicle.Max_timit_dx_percent
        ```

### Max_timit_dx_percent_prev {#max_timit_dx_percent_prev}

```csharp
float Max_timit_dx_percent_prev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_timit_dx_percent_prev = outputSiteVehicle.Max_timit_dx_percent_prev;
        ```

    === "C++"

        ```cpp
        double max_timit_dx_percent_prev;
        outputSiteVehicle->get_Max_timit_dx_percent_prev(&max_timit_dx_percent_prev);
        ```

    === "Python"

        ```python
        max_timit_dx_percent_prev = outputSiteVehicle.Max_timit_dx_percent_prev
        ```

### Max_timit_dx_percent_prev2 {#max_timit_dx_percent_prev2}

```csharp
float Max_timit_dx_percent_prev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_timit_dx_percent_prev2 = outputSiteVehicle.Max_timit_dx_percent_prev2;
        ```

    === "C++"

        ```cpp
        double max_timit_dx_percent_prev2;
        outputSiteVehicle->get_Max_timit_dx_percent_prev2(&max_timit_dx_percent_prev2);
        ```

    === "Python"

        ```python
        max_timit_dx_percent_prev2 = outputSiteVehicle.Max_timit_dx_percent_prev2
        ```

### TimIterationsCount {#timiterationscount}

```csharp
int TimIterationsCount { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int timIterationsCount = outputSiteVehicle.TimIterationsCount;
        ```

    === "C++"

        ```cpp
        long timIterationsCount;
        outputSiteVehicle->get_TimIterationsCount(&timIterationsCount);
        ```

    === "Python"

        ```python
        tim_iterations_count = outputSiteVehicle.TimIterationsCount
        ```

### Max_TimIterations {#max_timiterations}

```csharp
int Max_TimIterations { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int max_TimIterations = outputSiteVehicle.Max_TimIterations;
        ```

    === "C++"

        ```cpp
        long max_TimIterations;
        outputSiteVehicle->get_Max_TimIterations(&max_TimIterations);
        ```

    === "Python"

        ```python
        max__tim_iterations = outputSiteVehicle.Max_TimIterations
        ```

### Model_flowcap_vari_index {#model_flowcap_vari_index}

```csharp
float Model_flowcap_vari_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float model_flowcap_vari_index = outputSiteVehicle.Model_flowcap_vari_index;
        ```

    === "C++"

        ```cpp
        double model_flowcap_vari_index;
        outputSiteVehicle->get_Model_flowcap_vari_index(&model_flowcap_vari_index);
        ```

    === "Python"

        ```python
        model_flowcap_vari_index = outputSiteVehicle.Model_flowcap_vari_index
        ```

### Max_subit_dx_percent {#max_subit_dx_percent}

```csharp
float Max_subit_dx_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_subit_dx_percent = outputSiteVehicle.Max_subit_dx_percent;
        ```

    === "C++"

        ```cpp
        double max_subit_dx_percent;
        outputSiteVehicle->get_Max_subit_dx_percent(&max_subit_dx_percent);
        ```

    === "Python"

        ```python
        max_subit_dx_percent = outputSiteVehicle.Max_subit_dx_percent
        ```

### Max_subit_dx_percent_prev {#max_subit_dx_percent_prev}

```csharp
float Max_subit_dx_percent_prev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_subit_dx_percent_prev = outputSiteVehicle.Max_subit_dx_percent_prev;
        ```

    === "C++"

        ```cpp
        double max_subit_dx_percent_prev;
        outputSiteVehicle->get_Max_subit_dx_percent_prev(&max_subit_dx_percent_prev);
        ```

    === "Python"

        ```python
        max_subit_dx_percent_prev = outputSiteVehicle.Max_subit_dx_percent_prev
        ```

### Max_subit_dx_percent_prev2 {#max_subit_dx_percent_prev2}

```csharp
float Max_subit_dx_percent_prev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_subit_dx_percent_prev2 = outputSiteVehicle.Max_subit_dx_percent_prev2;
        ```

    === "C++"

        ```cpp
        double max_subit_dx_percent_prev2;
        outputSiteVehicle->get_Max_subit_dx_percent_prev2(&max_subit_dx_percent_prev2);
        ```

    === "Python"

        ```python
        max_subit_dx_percent_prev2 = outputSiteVehicle.Max_subit_dx_percent_prev2
        ```

### SubIterationsCount {#subiterationscount}

```csharp
int SubIterationsCount { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int subIterationsCount = outputSiteVehicle.SubIterationsCount;
        ```

    === "C++"

        ```cpp
        long subIterationsCount;
        outputSiteVehicle->get_SubIterationsCount(&subIterationsCount);
        ```

    === "Python"

        ```python
        sub_iterations_count = outputSiteVehicle.SubIterationsCount
        ```

### Max_SubIterations {#max_subiterations}

```csharp
int Max_SubIterations { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int max_SubIterations = outputSiteVehicle.Max_SubIterations;
        ```

    === "C++"

        ```cpp
        long max_SubIterations;
        outputSiteVehicle->get_Max_SubIterations(&max_SubIterations);
        ```

    === "Python"

        ```python
        max__sub_iterations = outputSiteVehicle.Max_SubIterations
        ```

### Max_subit_capacity_diff {#max_subit_capacity_diff}

```csharp
float Max_subit_capacity_diff { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_subit_capacity_diff = outputSiteVehicle.Max_subit_capacity_diff;
        ```

    === "C++"

        ```cpp
        double max_subit_capacity_diff;
        outputSiteVehicle->get_Max_subit_capacity_diff(&max_subit_capacity_diff);
        ```

    === "Python"

        ```python
        max_subit_capacity_diff = outputSiteVehicle.Max_subit_capacity_diff
        ```

### Max_subit_capacity_percent {#max_subit_capacity_percent}

```csharp
float Max_subit_capacity_percent { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float max_subit_capacity_percent = outputSiteVehicle.Max_subit_capacity_percent;
        ```

    === "C++"

        ```cpp
        double max_subit_capacity_percent;
        outputSiteVehicle->get_Max_subit_capacity_percent(&max_subit_capacity_percent);
        ```

    === "Python"

        ```python
        max_subit_capacity_percent = outputSiteVehicle.Max_subit_capacity_percent
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputSiteVehicle.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputSiteVehicle->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputSiteVehicle.DesiredSpeed
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputSiteVehicle.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputSiteVehicle->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputSiteVehicle.DesiredSpeedMethod
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputSiteVehicle.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputSiteVehicle->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputSiteVehicle.DesiredSpeedProgram
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputSiteVehicle.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputSiteVehicle->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputSiteVehicle.TravelTimeIndex
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputSiteVehicle.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputSiteVehicle->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputSiteVehicle.CongestionCoefficient
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

Speed Efficiency Flag

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

**Value**

1 = Calculated Average Travel Speed exceeds the specified Desired Speed

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputSiteVehicle.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputSiteVehicle->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputSiteVehicle.SpeedEfficiencyFlag
        ```

### Travel_time_total_at_desired_speed {#travel_time_total_at_desired_speed}

```csharp
float Travel_time_total_at_desired_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_at_desired_speed = outputSiteVehicle.Travel_time_total_at_desired_speed;
        ```

    === "C++"

        ```cpp
        double travel_time_total_at_desired_speed;
        outputSiteVehicle->get_Travel_time_total_at_desired_speed(&travel_time_total_at_desired_speed);
        ```

    === "Python"

        ```python
        travel_time_total_at_desired_speed = outputSiteVehicle.Travel_time_total_at_desired_speed
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputSiteVehicle.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputSiteVehicle->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputSiteVehicle.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputSiteVehicle.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputSiteVehicle->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputSiteVehicle.Time_cost_total
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputSiteVehicle.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputSiteVehicle->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputSiteVehicle.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputSiteVehicle.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputSiteVehicle->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputSiteVehicle.Time_cost_rate
        ```

### Outputset {#outputset}

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = outputSiteVehicle.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        outputSiteVehicle->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = outputSiteVehicle.Outputset
        ```

### OutputSiteVehicleMCs {#outputsitevehiclemcs}

```csharp
ISIAPIOutputSiteVehicleMCs OutputSiteVehicleMCs { get; }
```

**Type** [`ISIAPIOutputSiteVehicleMCs`](sidrasolutions.si.api.isiapioutputsitevehiclemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSiteVehicleMCs = outputSiteVehicle.OutputSiteVehicleMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteVehicleMCs> outputSiteVehicleMCs;
        outputSiteVehicle->get_OutputSiteVehicleMCs(&outputSiteVehicleMCs);
        ```

    === "Python"

        ```python
        output_site_vehicle_m_cs = outputSiteVehicle.OutputSiteVehicleMCs
        ```

### MaxDxPct {#maxdxpct}

```csharp
float MaxDxPct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float maxDxPct = outputSiteVehicle.MaxDxPct;
        ```

    === "C++"

        ```cpp
        double maxDxPct;
        outputSiteVehicle->get_MaxDxPct(&maxDxPct);
        ```

    === "Python"

        ```python
        max_dx_pct = outputSiteVehicle.MaxDxPct
        ```

### MaxDxPctPrev {#maxdxpctprev}

```csharp
float MaxDxPctPrev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float maxDxPctPrev = outputSiteVehicle.MaxDxPctPrev;
        ```

    === "C++"

        ```cpp
        double maxDxPctPrev;
        outputSiteVehicle->get_MaxDxPctPrev(&maxDxPctPrev);
        ```

    === "Python"

        ```python
        max_dx_pct_prev = outputSiteVehicle.MaxDxPctPrev
        ```

### MaxDxPctPrev2 {#maxdxpctprev2}

```csharp
float MaxDxPctPrev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float maxDxPctPrev2 = outputSiteVehicle.MaxDxPctPrev2;
        ```

    === "C++"

        ```cpp
        double maxDxPctPrev2;
        outputSiteVehicle->get_MaxDxPctPrev2(&maxDxPctPrev2);
        ```

    === "Python"

        ```python
        max_dx_pct_prev2 = outputSiteVehicle.MaxDxPctPrev2
        ```

### DiffDelayControlAveragePct {#diffdelaycontrolaveragepct}

```csharp
float DiffDelayControlAveragePct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePct = outputSiteVehicle.DiffDelayControlAveragePct;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePct;
        outputSiteVehicle->get_DiffDelayControlAveragePct(&diffDelayControlAveragePct);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct = outputSiteVehicle.DiffDelayControlAveragePct
        ```

### DiffDelayControlAveragePctPrev {#diffdelaycontrolaveragepctprev}

```csharp
float DiffDelayControlAveragePctPrev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePctPrev = outputSiteVehicle.DiffDelayControlAveragePctPrev;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePctPrev;
        outputSiteVehicle->get_DiffDelayControlAveragePctPrev(&diffDelayControlAveragePctPrev);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct_prev = outputSiteVehicle.DiffDelayControlAveragePctPrev
        ```

### DiffDelayControlAveragePctPrev2 {#diffdelaycontrolaveragepctprev2}

```csharp
float DiffDelayControlAveragePctPrev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffDelayControlAveragePctPrev2 = outputSiteVehicle.DiffDelayControlAveragePctPrev2;
        ```

    === "C++"

        ```cpp
        double diffDelayControlAveragePctPrev2;
        outputSiteVehicle->get_DiffDelayControlAveragePctPrev2(&diffDelayControlAveragePctPrev2);
        ```

    === "Python"

        ```python
        diff_delay_control_average_pct_prev2 = outputSiteVehicle.DiffDelayControlAveragePctPrev2
        ```

### DiffSpeedEfficiencyPct {#diffspeedefficiencypct}

```csharp
float DiffSpeedEfficiencyPct { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPct = outputSiteVehicle.DiffSpeedEfficiencyPct;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPct;
        outputSiteVehicle->get_DiffSpeedEfficiencyPct(&diffSpeedEfficiencyPct);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct = outputSiteVehicle.DiffSpeedEfficiencyPct
        ```

### DiffSpeedEfficiencyPctPrev {#diffspeedefficiencypctprev}

```csharp
float DiffSpeedEfficiencyPctPrev { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPctPrev = outputSiteVehicle.DiffSpeedEfficiencyPctPrev;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPctPrev;
        outputSiteVehicle->get_DiffSpeedEfficiencyPctPrev(&diffSpeedEfficiencyPctPrev);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct_prev = outputSiteVehicle.DiffSpeedEfficiencyPctPrev
        ```

### DiffSpeedEfficiencyPctPrev2 {#diffspeedefficiencypctprev2}

```csharp
float DiffSpeedEfficiencyPctPrev2 { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float diffSpeedEfficiencyPctPrev2 = outputSiteVehicle.DiffSpeedEfficiencyPctPrev2;
        ```

    === "C++"

        ```cpp
        double diffSpeedEfficiencyPctPrev2;
        outputSiteVehicle->get_DiffSpeedEfficiencyPctPrev2(&diffSpeedEfficiencyPctPrev2);
        ```

    === "Python"

        ```python
        diff_speed_efficiency_pct_prev2 = outputSiteVehicle.DiffSpeedEfficiencyPctPrev2
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsitevehiclemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSiteVehicleMC
title: OutputSiteVehicleMC
name: ISIAPIOutputSiteVehicleMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 71E678E0-4F12-428F-AD50-D2036D53658E
members:
  - int MC_class
  - float Flow_total
  - float Flow_total_capconstr
  - float Capacity_effective
  - float Capacity_lane_total
  - float Capacity_mov_total
  - float Capacity_adj_worstlane
  - int Capacity_adj_flag_worstlane
  - float Deg_satn
  - float Practical_spare_capacity
  - float Delay_control_average
  - float Delay_control_average_worstmov
  - float Delay_control_average_worstlane
  - float Delay_control_total
  - float Delay_stopline_average
  - float Delay_geometric_average
  - string Level_of_service
  - string Level_of_service_av_int_delay
  - string Level_of_service_worstmov
  - string Level_of_service_worstlane
  - float Queue_cycav_mean
  - float Queue_cycav_percentile
  - float Queue_greenstart_mean
  - float Queue_greenstart_percentile
  - float Queue_maxback_mean
  - float Queue_maxback_percentile
  - float Queue_dist_cycav_mean
  - float Queue_dist_cycav_percentile
  - float Queue_dist_greenstart_mean
  - float Queue_dist_greenstart_percentile
  - float Queue_dist_maxback_mean
  - float Queue_dist_maxback_percentile
  - float Queue_storage_ratio_avg
  - float Queue_storage_ratio_percentile
  - float Stop_rate
  - float Stops_total
  - float Proportion_queued
  - float Performance_index
  - float Travel_distance_total
  - float Travel_distance_average
  - float Travel_time_total
  - float Travel_time_average
  - float Travel_speed
  - float Operating_cost_total
  - float Veh_operating_cost_total
  - float Time_cost_total
  - float Fuel_consumption_total
  - float Carbon_dioxide_total
  - float Hydrocarbons_total
  - float Carbon_monoxide_total
  - float Nox_total
  - float Operating_cost_rate
  - float Veh_operating_cost_rate
  - float Time_cost_rate
  - float Fuel_consumption_rate
  - float Carbon_dioxide_rate
  - float Hydrocarbons_rate
  - float Carbon_monoxide_rate
  - float Nox_rate
  - float Idling_time_average
  - float SpeedEfficiency
  - int SpeedEfficiencyFlag
  - float CongestionCoefficient
  - float TravelTimeIndex
  - float Avg_num_of_cycles_to_depart
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float DesiredSpeedProgram
  - float Travel_time_total_at_desired_speed
  - ISIAPIOutputSiteVehicle OutputSiteVehicle
---

# OutputSiteVehicleMC

Type `ISIAPIOutputSiteVehicleMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `71E678E0-4F12-428F-AD50-D2036D53658E`

## Declaration

```csharp
[Guid("71E678E0-4F12-428F-AD50-D2036D53658E")]
public interface ISIAPIOutputSiteVehicleMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` |  |
| [Flow_total](#flow_total) | `float` |  |
| [Flow_total_capconstr](#flow_total_capconstr) | `float` |  |
| [Capacity_effective](#capacity_effective) | `float` |  |
| [Capacity_lane_total](#capacity_lane_total) | `float` |  |
| [Capacity_mov_total](#capacity_mov_total) | `float` |  |
| [Capacity_adj_worstlane](#capacity_adj_worstlane) | `float` |  |
| [Capacity_adj_flag_worstlane](#capacity_adj_flag_worstlane) | `int` |  |
| [Deg_satn](#deg_satn) | `float` |  |
| [Practical_spare_capacity](#practical_spare_capacity) | `float` |  |
| [Delay_control_average](#delay_control_average) | `float` |  |
| [Delay_control_average_worstmov](#delay_control_average_worstmov) | `float` |  |
| [Delay_control_average_worstlane](#delay_control_average_worstlane) | `float` |  |
| [Delay_control_total](#delay_control_total) | `float` |  |
| [Delay_stopline_average](#delay_stopline_average) | `float` |  |
| [Delay_geometric_average](#delay_geometric_average) | `float` |  |
| [Level_of_service](#level_of_service) | `string` | Intersection LOS by Movement Class. |
| [Level_of_service_av_int_delay](#level_of_service_av_int_delay) | `string` | Average intersection delay LOS by Movement Class. |
| [Level_of_service_worstmov](#level_of_service_worstmov) | `string` | Worst movement LOS by Movement Class. |
| [Level_of_service_worstlane](#level_of_service_worstlane) | `string` | Worst lane LOS by Movement Class. |
| [Queue_cycav_mean](#queue_cycav_mean) | `float` |  |
| [Queue_cycav_percentile](#queue_cycav_percentile) | `float` |  |
| [Queue_greenstart_mean](#queue_greenstart_mean) | `float` |  |
| [Queue_greenstart_percentile](#queue_greenstart_percentile) | `float` |  |
| [Queue_maxback_mean](#queue_maxback_mean) | `float` |  |
| [Queue_maxback_percentile](#queue_maxback_percentile) | `float` |  |
| [Queue_dist_cycav_mean](#queue_dist_cycav_mean) | `float` |  |
| [Queue_dist_cycav_percentile](#queue_dist_cycav_percentile) | `float` |  |
| [Queue_dist_greenstart_mean](#queue_dist_greenstart_mean) | `float` |  |
| [Queue_dist_greenstart_percentile](#queue_dist_greenstart_percentile) | `float` |  |
| [Queue_dist_maxback_mean](#queue_dist_maxback_mean) | `float` |  |
| [Queue_dist_maxback_percentile](#queue_dist_maxback_percentile) | `float` |  |
| [Queue_storage_ratio_avg](#queue_storage_ratio_avg) | `float` |  |
| [Queue_storage_ratio_percentile](#queue_storage_ratio_percentile) | `float` |  |
| [Stop_rate](#stop_rate) | `float` |  |
| [Stops_total](#stops_total) | `float` |  |
| [Proportion_queued](#proportion_queued) | `float` |  |
| [Performance_index](#performance_index) | `float` |  |
| [Travel_distance_total](#travel_distance_total) | `float` |  |
| [Travel_distance_average](#travel_distance_average) | `float` |  |
| [Travel_time_total](#travel_time_total) | `float` |  |
| [Travel_time_average](#travel_time_average) | `float` |  |
| [Travel_speed](#travel_speed) | `float` |  |
| [Operating_cost_total](#operating_cost_total) | `float` |  |
| [Veh_operating_cost_total](#veh_operating_cost_total) | `float` |  |
| [Time_cost_total](#time_cost_total) | `float` |  |
| [Fuel_consumption_total](#fuel_consumption_total) | `float` |  |
| [Carbon_dioxide_total](#carbon_dioxide_total) | `float` |  |
| [Hydrocarbons_total](#hydrocarbons_total) | `float` |  |
| [Carbon_monoxide_total](#carbon_monoxide_total) | `float` |  |
| [Nox_total](#nox_total) | `float` |  |
| [Operating_cost_rate](#operating_cost_rate) | `float` |  |
| [Veh_operating_cost_rate](#veh_operating_cost_rate) | `float` |  |
| [Time_cost_rate](#time_cost_rate) | `float` |  |
| [Fuel_consumption_rate](#fuel_consumption_rate) | `float` |  |
| [Carbon_dioxide_rate](#carbon_dioxide_rate) | `float` |  |
| [Hydrocarbons_rate](#hydrocarbons_rate) | `float` |  |
| [Carbon_monoxide_rate](#carbon_monoxide_rate) | `float` |  |
| [Nox_rate](#nox_rate) | `float` |  |
| [Idling_time_average](#idling_time_average) | `float` |  |
| [SpeedEfficiency](#speedefficiency) | `float` |  |
| [SpeedEfficiencyFlag](#speedefficiencyflag) | `int` |  |
| [CongestionCoefficient](#congestioncoefficient) | `float` |  |
| [TravelTimeIndex](#traveltimeindex) | `float` |  |
| [Avg_num_of_cycles_to_depart](#avg_num_of_cycles_to_depart) | `float` |  |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` |  |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [DesiredSpeedProgram](#desiredspeedprogram) | `float` |  |
| [Travel_time_total_at_desired_speed](#travel_time_total_at_desired_speed) | `float` |  |
| [OutputSiteVehicle](#outputsitevehicle) | [`ISIAPIOutputSiteVehicle`](sidrasolutions.si.api.isiapioutputsitevehicle.md) |  |

</div>

## Properties

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = outputSiteVehicleMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        outputSiteVehicleMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = outputSiteVehicleMC.MC_class
        ```

### Flow_total {#flow_total}

```csharp
float Flow_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total = outputSiteVehicleMC.Flow_total;
        ```

    === "C++"

        ```cpp
        double flow_total;
        outputSiteVehicleMC->get_Flow_total(&flow_total);
        ```

    === "Python"

        ```python
        flow_total = outputSiteVehicleMC.Flow_total
        ```

### Flow_total_capconstr {#flow_total_capconstr}

```csharp
float Flow_total_capconstr { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flow_total_capconstr = outputSiteVehicleMC.Flow_total_capconstr;
        ```

    === "C++"

        ```cpp
        double flow_total_capconstr;
        outputSiteVehicleMC->get_Flow_total_capconstr(&flow_total_capconstr);
        ```

    === "Python"

        ```python
        flow_total_capconstr = outputSiteVehicleMC.Flow_total_capconstr
        ```

### Capacity_effective {#capacity_effective}

```csharp
float Capacity_effective { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_effective = outputSiteVehicleMC.Capacity_effective;
        ```

    === "C++"

        ```cpp
        double capacity_effective;
        outputSiteVehicleMC->get_Capacity_effective(&capacity_effective);
        ```

    === "Python"

        ```python
        capacity_effective = outputSiteVehicleMC.Capacity_effective
        ```

### Capacity_lane_total {#capacity_lane_total}

```csharp
float Capacity_lane_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_lane_total = outputSiteVehicleMC.Capacity_lane_total;
        ```

    === "C++"

        ```cpp
        double capacity_lane_total;
        outputSiteVehicleMC->get_Capacity_lane_total(&capacity_lane_total);
        ```

    === "Python"

        ```python
        capacity_lane_total = outputSiteVehicleMC.Capacity_lane_total
        ```

### Capacity_mov_total {#capacity_mov_total}

```csharp
float Capacity_mov_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_mov_total = outputSiteVehicleMC.Capacity_mov_total;
        ```

    === "C++"

        ```cpp
        double capacity_mov_total;
        outputSiteVehicleMC->get_Capacity_mov_total(&capacity_mov_total);
        ```

    === "Python"

        ```python
        capacity_mov_total = outputSiteVehicleMC.Capacity_mov_total
        ```

### Capacity_adj_worstlane {#capacity_adj_worstlane}

```csharp
float Capacity_adj_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float capacity_adj_worstlane = outputSiteVehicleMC.Capacity_adj_worstlane;
        ```

    === "C++"

        ```cpp
        double capacity_adj_worstlane;
        outputSiteVehicleMC->get_Capacity_adj_worstlane(&capacity_adj_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_worstlane = outputSiteVehicleMC.Capacity_adj_worstlane
        ```

### Capacity_adj_flag_worstlane {#capacity_adj_flag_worstlane}

```csharp
int Capacity_adj_flag_worstlane { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int capacity_adj_flag_worstlane = outputSiteVehicleMC.Capacity_adj_flag_worstlane;
        ```

    === "C++"

        ```cpp
        long capacity_adj_flag_worstlane;
        outputSiteVehicleMC->get_Capacity_adj_flag_worstlane(&capacity_adj_flag_worstlane);
        ```

    === "Python"

        ```python
        capacity_adj_flag_worstlane = outputSiteVehicleMC.Capacity_adj_flag_worstlane
        ```

### Deg_satn {#deg_satn}

```csharp
float Deg_satn { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float deg_satn = outputSiteVehicleMC.Deg_satn;
        ```

    === "C++"

        ```cpp
        double deg_satn;
        outputSiteVehicleMC->get_Deg_satn(&deg_satn);
        ```

    === "Python"

        ```python
        deg_satn = outputSiteVehicleMC.Deg_satn
        ```

### Practical_spare_capacity {#practical_spare_capacity}

```csharp
float Practical_spare_capacity { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_spare_capacity = outputSiteVehicleMC.Practical_spare_capacity;
        ```

    === "C++"

        ```cpp
        double practical_spare_capacity;
        outputSiteVehicleMC->get_Practical_spare_capacity(&practical_spare_capacity);
        ```

    === "Python"

        ```python
        practical_spare_capacity = outputSiteVehicleMC.Practical_spare_capacity
        ```

### Delay_control_average {#delay_control_average}

```csharp
float Delay_control_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average = outputSiteVehicleMC.Delay_control_average;
        ```

    === "C++"

        ```cpp
        double delay_control_average;
        outputSiteVehicleMC->get_Delay_control_average(&delay_control_average);
        ```

    === "Python"

        ```python
        delay_control_average = outputSiteVehicleMC.Delay_control_average
        ```

### Delay_control_average_worstmov {#delay_control_average_worstmov}

```csharp
float Delay_control_average_worstmov { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstmov = outputSiteVehicleMC.Delay_control_average_worstmov;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstmov;
        outputSiteVehicleMC->get_Delay_control_average_worstmov(&delay_control_average_worstmov);
        ```

    === "Python"

        ```python
        delay_control_average_worstmov = outputSiteVehicleMC.Delay_control_average_worstmov
        ```

### Delay_control_average_worstlane {#delay_control_average_worstlane}

```csharp
float Delay_control_average_worstlane { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_average_worstlane = outputSiteVehicleMC.Delay_control_average_worstlane;
        ```

    === "C++"

        ```cpp
        double delay_control_average_worstlane;
        outputSiteVehicleMC->get_Delay_control_average_worstlane(&delay_control_average_worstlane);
        ```

    === "Python"

        ```python
        delay_control_average_worstlane = outputSiteVehicleMC.Delay_control_average_worstlane
        ```

### Delay_control_total {#delay_control_total}

```csharp
float Delay_control_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_control_total = outputSiteVehicleMC.Delay_control_total;
        ```

    === "C++"

        ```cpp
        double delay_control_total;
        outputSiteVehicleMC->get_Delay_control_total(&delay_control_total);
        ```

    === "Python"

        ```python
        delay_control_total = outputSiteVehicleMC.Delay_control_total
        ```

### Delay_stopline_average {#delay_stopline_average}

```csharp
float Delay_stopline_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_stopline_average = outputSiteVehicleMC.Delay_stopline_average;
        ```

    === "C++"

        ```cpp
        double delay_stopline_average;
        outputSiteVehicleMC->get_Delay_stopline_average(&delay_stopline_average);
        ```

    === "Python"

        ```python
        delay_stopline_average = outputSiteVehicleMC.Delay_stopline_average
        ```

### Delay_geometric_average {#delay_geometric_average}

```csharp
float Delay_geometric_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float delay_geometric_average = outputSiteVehicleMC.Delay_geometric_average;
        ```

    === "C++"

        ```cpp
        double delay_geometric_average;
        outputSiteVehicleMC->get_Delay_geometric_average(&delay_geometric_average);
        ```

    === "Python"

        ```python
        delay_geometric_average = outputSiteVehicleMC.Delay_geometric_average
        ```

### Level_of_service {#level_of_service}

Intersection LOS by Movement Class.

```csharp
string Level_of_service { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service = outputSiteVehicleMC.Level_of_service;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service;
        outputSiteVehicleMC->get_Level_of_service(&level_of_service);
        ```

    === "Python"

        ```python
        level_of_service = outputSiteVehicleMC.Level_of_service
        ```

### Level_of_service_av_int_delay {#level_of_service_av_int_delay}

Average intersection delay LOS by Movement Class.

```csharp
string Level_of_service_av_int_delay { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_av_int_delay = outputSiteVehicleMC.Level_of_service_av_int_delay;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_av_int_delay;
        outputSiteVehicleMC->get_Level_of_service_av_int_delay(&level_of_service_av_int_delay);
        ```

    === "Python"

        ```python
        level_of_service_av_int_delay = outputSiteVehicleMC.Level_of_service_av_int_delay
        ```

### Level_of_service_worstmov {#level_of_service_worstmov}

Worst movement LOS by Movement Class.

```csharp
string Level_of_service_worstmov { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstmov = outputSiteVehicleMC.Level_of_service_worstmov;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstmov;
        outputSiteVehicleMC->get_Level_of_service_worstmov(&level_of_service_worstmov);
        ```

    === "Python"

        ```python
        level_of_service_worstmov = outputSiteVehicleMC.Level_of_service_worstmov
        ```

### Level_of_service_worstlane {#level_of_service_worstlane}

Worst lane LOS by Movement Class.

```csharp
string Level_of_service_worstlane { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string level_of_service_worstlane = outputSiteVehicleMC.Level_of_service_worstlane;
        ```

    === "C++"

        ```cpp
        CComBSTR level_of_service_worstlane;
        outputSiteVehicleMC->get_Level_of_service_worstlane(&level_of_service_worstlane);
        ```

    === "Python"

        ```python
        level_of_service_worstlane = outputSiteVehicleMC.Level_of_service_worstlane
        ```

### Queue_cycav_mean {#queue_cycav_mean}

```csharp
float Queue_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_mean = outputSiteVehicleMC.Queue_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_cycav_mean;
        outputSiteVehicleMC->get_Queue_cycav_mean(&queue_cycav_mean);
        ```

    === "Python"

        ```python
        queue_cycav_mean = outputSiteVehicleMC.Queue_cycav_mean
        ```

### Queue_cycav_percentile {#queue_cycav_percentile}

```csharp
float Queue_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_cycav_percentile = outputSiteVehicleMC.Queue_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_cycav_percentile;
        outputSiteVehicleMC->get_Queue_cycav_percentile(&queue_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_cycav_percentile = outputSiteVehicleMC.Queue_cycav_percentile
        ```

### Queue_greenstart_mean {#queue_greenstart_mean}

```csharp
float Queue_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_mean = outputSiteVehicleMC.Queue_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_mean;
        outputSiteVehicleMC->get_Queue_greenstart_mean(&queue_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_greenstart_mean = outputSiteVehicleMC.Queue_greenstart_mean
        ```

### Queue_greenstart_percentile {#queue_greenstart_percentile}

```csharp
float Queue_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_greenstart_percentile = outputSiteVehicleMC.Queue_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_greenstart_percentile;
        outputSiteVehicleMC->get_Queue_greenstart_percentile(&queue_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_greenstart_percentile = outputSiteVehicleMC.Queue_greenstart_percentile
        ```

### Queue_maxback_mean {#queue_maxback_mean}

```csharp
float Queue_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_mean = outputSiteVehicleMC.Queue_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_maxback_mean;
        outputSiteVehicleMC->get_Queue_maxback_mean(&queue_maxback_mean);
        ```

    === "Python"

        ```python
        queue_maxback_mean = outputSiteVehicleMC.Queue_maxback_mean
        ```

### Queue_maxback_percentile {#queue_maxback_percentile}

```csharp
float Queue_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_maxback_percentile = outputSiteVehicleMC.Queue_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_maxback_percentile;
        outputSiteVehicleMC->get_Queue_maxback_percentile(&queue_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_maxback_percentile = outputSiteVehicleMC.Queue_maxback_percentile
        ```

### Queue_dist_cycav_mean {#queue_dist_cycav_mean}

```csharp
float Queue_dist_cycav_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_mean = outputSiteVehicleMC.Queue_dist_cycav_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_mean;
        outputSiteVehicleMC->get_Queue_dist_cycav_mean(&queue_dist_cycav_mean);
        ```

    === "Python"

        ```python
        queue_dist_cycav_mean = outputSiteVehicleMC.Queue_dist_cycav_mean
        ```

### Queue_dist_cycav_percentile {#queue_dist_cycav_percentile}

```csharp
float Queue_dist_cycav_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_cycav_percentile = outputSiteVehicleMC.Queue_dist_cycav_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_cycav_percentile;
        outputSiteVehicleMC->get_Queue_dist_cycav_percentile(&queue_dist_cycav_percentile);
        ```

    === "Python"

        ```python
        queue_dist_cycav_percentile = outputSiteVehicleMC.Queue_dist_cycav_percentile
        ```

### Queue_dist_greenstart_mean {#queue_dist_greenstart_mean}

```csharp
float Queue_dist_greenstart_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_mean = outputSiteVehicleMC.Queue_dist_greenstart_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_mean;
        outputSiteVehicleMC->get_Queue_dist_greenstart_mean(&queue_dist_greenstart_mean);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_mean = outputSiteVehicleMC.Queue_dist_greenstart_mean
        ```

### Queue_dist_greenstart_percentile {#queue_dist_greenstart_percentile}

```csharp
float Queue_dist_greenstart_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_greenstart_percentile = outputSiteVehicleMC.Queue_dist_greenstart_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_greenstart_percentile;
        outputSiteVehicleMC->get_Queue_dist_greenstart_percentile(&queue_dist_greenstart_percentile);
        ```

    === "Python"

        ```python
        queue_dist_greenstart_percentile = outputSiteVehicleMC.Queue_dist_greenstart_percentile
        ```

### Queue_dist_maxback_mean {#queue_dist_maxback_mean}

```csharp
float Queue_dist_maxback_mean { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_mean = outputSiteVehicleMC.Queue_dist_maxback_mean;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_mean;
        outputSiteVehicleMC->get_Queue_dist_maxback_mean(&queue_dist_maxback_mean);
        ```

    === "Python"

        ```python
        queue_dist_maxback_mean = outputSiteVehicleMC.Queue_dist_maxback_mean
        ```

### Queue_dist_maxback_percentile {#queue_dist_maxback_percentile}

```csharp
float Queue_dist_maxback_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_dist_maxback_percentile = outputSiteVehicleMC.Queue_dist_maxback_percentile;
        ```

    === "C++"

        ```cpp
        double queue_dist_maxback_percentile;
        outputSiteVehicleMC->get_Queue_dist_maxback_percentile(&queue_dist_maxback_percentile);
        ```

    === "Python"

        ```python
        queue_dist_maxback_percentile = outputSiteVehicleMC.Queue_dist_maxback_percentile
        ```

### Queue_storage_ratio_avg {#queue_storage_ratio_avg}

```csharp
float Queue_storage_ratio_avg { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_avg = outputSiteVehicleMC.Queue_storage_ratio_avg;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_avg;
        outputSiteVehicleMC->get_Queue_storage_ratio_avg(&queue_storage_ratio_avg);
        ```

    === "Python"

        ```python
        queue_storage_ratio_avg = outputSiteVehicleMC.Queue_storage_ratio_avg
        ```

### Queue_storage_ratio_percentile {#queue_storage_ratio_percentile}

```csharp
float Queue_storage_ratio_percentile { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float queue_storage_ratio_percentile = outputSiteVehicleMC.Queue_storage_ratio_percentile;
        ```

    === "C++"

        ```cpp
        double queue_storage_ratio_percentile;
        outputSiteVehicleMC->get_Queue_storage_ratio_percentile(&queue_storage_ratio_percentile);
        ```

    === "Python"

        ```python
        queue_storage_ratio_percentile = outputSiteVehicleMC.Queue_storage_ratio_percentile
        ```

### Stop_rate {#stop_rate}

```csharp
float Stop_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stop_rate = outputSiteVehicleMC.Stop_rate;
        ```

    === "C++"

        ```cpp
        double stop_rate;
        outputSiteVehicleMC->get_Stop_rate(&stop_rate);
        ```

    === "Python"

        ```python
        stop_rate = outputSiteVehicleMC.Stop_rate
        ```

### Stops_total {#stops_total}

```csharp
float Stops_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float stops_total = outputSiteVehicleMC.Stops_total;
        ```

    === "C++"

        ```cpp
        double stops_total;
        outputSiteVehicleMC->get_Stops_total(&stops_total);
        ```

    === "Python"

        ```python
        stops_total = outputSiteVehicleMC.Stops_total
        ```

### Proportion_queued {#proportion_queued}

```csharp
float Proportion_queued { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float proportion_queued = outputSiteVehicleMC.Proportion_queued;
        ```

    === "C++"

        ```cpp
        double proportion_queued;
        outputSiteVehicleMC->get_Proportion_queued(&proportion_queued);
        ```

    === "Python"

        ```python
        proportion_queued = outputSiteVehicleMC.Proportion_queued
        ```

### Performance_index {#performance_index}

```csharp
float Performance_index { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float performance_index = outputSiteVehicleMC.Performance_index;
        ```

    === "C++"

        ```cpp
        double performance_index;
        outputSiteVehicleMC->get_Performance_index(&performance_index);
        ```

    === "Python"

        ```python
        performance_index = outputSiteVehicleMC.Performance_index
        ```

### Travel_distance_total {#travel_distance_total}

```csharp
float Travel_distance_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_total = outputSiteVehicleMC.Travel_distance_total;
        ```

    === "C++"

        ```cpp
        double travel_distance_total;
        outputSiteVehicleMC->get_Travel_distance_total(&travel_distance_total);
        ```

    === "Python"

        ```python
        travel_distance_total = outputSiteVehicleMC.Travel_distance_total
        ```

### Travel_distance_average {#travel_distance_average}

```csharp
float Travel_distance_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_distance_average = outputSiteVehicleMC.Travel_distance_average;
        ```

    === "C++"

        ```cpp
        double travel_distance_average;
        outputSiteVehicleMC->get_Travel_distance_average(&travel_distance_average);
        ```

    === "Python"

        ```python
        travel_distance_average = outputSiteVehicleMC.Travel_distance_average
        ```

### Travel_time_total {#travel_time_total}

```csharp
float Travel_time_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total = outputSiteVehicleMC.Travel_time_total;
        ```

    === "C++"

        ```cpp
        double travel_time_total;
        outputSiteVehicleMC->get_Travel_time_total(&travel_time_total);
        ```

    === "Python"

        ```python
        travel_time_total = outputSiteVehicleMC.Travel_time_total
        ```

### Travel_time_average {#travel_time_average}

```csharp
float Travel_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_average = outputSiteVehicleMC.Travel_time_average;
        ```

    === "C++"

        ```cpp
        double travel_time_average;
        outputSiteVehicleMC->get_Travel_time_average(&travel_time_average);
        ```

    === "Python"

        ```python
        travel_time_average = outputSiteVehicleMC.Travel_time_average
        ```

### Travel_speed {#travel_speed}

```csharp
float Travel_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_speed = outputSiteVehicleMC.Travel_speed;
        ```

    === "C++"

        ```cpp
        double travel_speed;
        outputSiteVehicleMC->get_Travel_speed(&travel_speed);
        ```

    === "Python"

        ```python
        travel_speed = outputSiteVehicleMC.Travel_speed
        ```

### Operating_cost_total {#operating_cost_total}

```csharp
float Operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_total = outputSiteVehicleMC.Operating_cost_total;
        ```

    === "C++"

        ```cpp
        double operating_cost_total;
        outputSiteVehicleMC->get_Operating_cost_total(&operating_cost_total);
        ```

    === "Python"

        ```python
        operating_cost_total = outputSiteVehicleMC.Operating_cost_total
        ```

### Veh_operating_cost_total {#veh_operating_cost_total}

```csharp
float Veh_operating_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_total = outputSiteVehicleMC.Veh_operating_cost_total;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_total;
        outputSiteVehicleMC->get_Veh_operating_cost_total(&veh_operating_cost_total);
        ```

    === "Python"

        ```python
        veh_operating_cost_total = outputSiteVehicleMC.Veh_operating_cost_total
        ```

### Time_cost_total {#time_cost_total}

```csharp
float Time_cost_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_total = outputSiteVehicleMC.Time_cost_total;
        ```

    === "C++"

        ```cpp
        double time_cost_total;
        outputSiteVehicleMC->get_Time_cost_total(&time_cost_total);
        ```

    === "Python"

        ```python
        time_cost_total = outputSiteVehicleMC.Time_cost_total
        ```

### Fuel_consumption_total {#fuel_consumption_total}

```csharp
float Fuel_consumption_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_total = outputSiteVehicleMC.Fuel_consumption_total;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_total;
        outputSiteVehicleMC->get_Fuel_consumption_total(&fuel_consumption_total);
        ```

    === "Python"

        ```python
        fuel_consumption_total = outputSiteVehicleMC.Fuel_consumption_total
        ```

### Carbon_dioxide_total {#carbon_dioxide_total}

```csharp
float Carbon_dioxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_total = outputSiteVehicleMC.Carbon_dioxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_total;
        outputSiteVehicleMC->get_Carbon_dioxide_total(&carbon_dioxide_total);
        ```

    === "Python"

        ```python
        carbon_dioxide_total = outputSiteVehicleMC.Carbon_dioxide_total
        ```

### Hydrocarbons_total {#hydrocarbons_total}

```csharp
float Hydrocarbons_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_total = outputSiteVehicleMC.Hydrocarbons_total;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_total;
        outputSiteVehicleMC->get_Hydrocarbons_total(&hydrocarbons_total);
        ```

    === "Python"

        ```python
        hydrocarbons_total = outputSiteVehicleMC.Hydrocarbons_total
        ```

### Carbon_monoxide_total {#carbon_monoxide_total}

```csharp
float Carbon_monoxide_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_total = outputSiteVehicleMC.Carbon_monoxide_total;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_total;
        outputSiteVehicleMC->get_Carbon_monoxide_total(&carbon_monoxide_total);
        ```

    === "Python"

        ```python
        carbon_monoxide_total = outputSiteVehicleMC.Carbon_monoxide_total
        ```

### Nox_total {#nox_total}

```csharp
float Nox_total { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_total = outputSiteVehicleMC.Nox_total;
        ```

    === "C++"

        ```cpp
        double nox_total;
        outputSiteVehicleMC->get_Nox_total(&nox_total);
        ```

    === "Python"

        ```python
        nox_total = outputSiteVehicleMC.Nox_total
        ```

### Operating_cost_rate {#operating_cost_rate}

```csharp
float Operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float operating_cost_rate = outputSiteVehicleMC.Operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double operating_cost_rate;
        outputSiteVehicleMC->get_Operating_cost_rate(&operating_cost_rate);
        ```

    === "Python"

        ```python
        operating_cost_rate = outputSiteVehicleMC.Operating_cost_rate
        ```

### Veh_operating_cost_rate {#veh_operating_cost_rate}

```csharp
float Veh_operating_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float veh_operating_cost_rate = outputSiteVehicleMC.Veh_operating_cost_rate;
        ```

    === "C++"

        ```cpp
        double veh_operating_cost_rate;
        outputSiteVehicleMC->get_Veh_operating_cost_rate(&veh_operating_cost_rate);
        ```

    === "Python"

        ```python
        veh_operating_cost_rate = outputSiteVehicleMC.Veh_operating_cost_rate
        ```

### Time_cost_rate {#time_cost_rate}

```csharp
float Time_cost_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float time_cost_rate = outputSiteVehicleMC.Time_cost_rate;
        ```

    === "C++"

        ```cpp
        double time_cost_rate;
        outputSiteVehicleMC->get_Time_cost_rate(&time_cost_rate);
        ```

    === "Python"

        ```python
        time_cost_rate = outputSiteVehicleMC.Time_cost_rate
        ```

### Fuel_consumption_rate {#fuel_consumption_rate}

```csharp
float Fuel_consumption_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float fuel_consumption_rate = outputSiteVehicleMC.Fuel_consumption_rate;
        ```

    === "C++"

        ```cpp
        double fuel_consumption_rate;
        outputSiteVehicleMC->get_Fuel_consumption_rate(&fuel_consumption_rate);
        ```

    === "Python"

        ```python
        fuel_consumption_rate = outputSiteVehicleMC.Fuel_consumption_rate
        ```

### Carbon_dioxide_rate {#carbon_dioxide_rate}

```csharp
float Carbon_dioxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_dioxide_rate = outputSiteVehicleMC.Carbon_dioxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_dioxide_rate;
        outputSiteVehicleMC->get_Carbon_dioxide_rate(&carbon_dioxide_rate);
        ```

    === "Python"

        ```python
        carbon_dioxide_rate = outputSiteVehicleMC.Carbon_dioxide_rate
        ```

### Hydrocarbons_rate {#hydrocarbons_rate}

```csharp
float Hydrocarbons_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float hydrocarbons_rate = outputSiteVehicleMC.Hydrocarbons_rate;
        ```

    === "C++"

        ```cpp
        double hydrocarbons_rate;
        outputSiteVehicleMC->get_Hydrocarbons_rate(&hydrocarbons_rate);
        ```

    === "Python"

        ```python
        hydrocarbons_rate = outputSiteVehicleMC.Hydrocarbons_rate
        ```

### Carbon_monoxide_rate {#carbon_monoxide_rate}

```csharp
float Carbon_monoxide_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float carbon_monoxide_rate = outputSiteVehicleMC.Carbon_monoxide_rate;
        ```

    === "C++"

        ```cpp
        double carbon_monoxide_rate;
        outputSiteVehicleMC->get_Carbon_monoxide_rate(&carbon_monoxide_rate);
        ```

    === "Python"

        ```python
        carbon_monoxide_rate = outputSiteVehicleMC.Carbon_monoxide_rate
        ```

### Nox_rate {#nox_rate}

```csharp
float Nox_rate { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float nox_rate = outputSiteVehicleMC.Nox_rate;
        ```

    === "C++"

        ```cpp
        double nox_rate;
        outputSiteVehicleMC->get_Nox_rate(&nox_rate);
        ```

    === "Python"

        ```python
        nox_rate = outputSiteVehicleMC.Nox_rate
        ```

### Idling_time_average {#idling_time_average}

```csharp
float Idling_time_average { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float idling_time_average = outputSiteVehicleMC.Idling_time_average;
        ```

    === "C++"

        ```cpp
        double idling_time_average;
        outputSiteVehicleMC->get_Idling_time_average(&idling_time_average);
        ```

    === "Python"

        ```python
        idling_time_average = outputSiteVehicleMC.Idling_time_average
        ```

### SpeedEfficiency {#speedefficiency}

```csharp
float SpeedEfficiency { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float speedEfficiency = outputSiteVehicleMC.SpeedEfficiency;
        ```

    === "C++"

        ```cpp
        double speedEfficiency;
        outputSiteVehicleMC->get_SpeedEfficiency(&speedEfficiency);
        ```

    === "Python"

        ```python
        speed_efficiency = outputSiteVehicleMC.SpeedEfficiency
        ```

### SpeedEfficiencyFlag {#speedefficiencyflag}

```csharp
int SpeedEfficiencyFlag { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int speedEfficiencyFlag = outputSiteVehicleMC.SpeedEfficiencyFlag;
        ```

    === "C++"

        ```cpp
        long speedEfficiencyFlag;
        outputSiteVehicleMC->get_SpeedEfficiencyFlag(&speedEfficiencyFlag);
        ```

    === "Python"

        ```python
        speed_efficiency_flag = outputSiteVehicleMC.SpeedEfficiencyFlag
        ```

### CongestionCoefficient {#congestioncoefficient}

```csharp
float CongestionCoefficient { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float congestionCoefficient = outputSiteVehicleMC.CongestionCoefficient;
        ```

    === "C++"

        ```cpp
        double congestionCoefficient;
        outputSiteVehicleMC->get_CongestionCoefficient(&congestionCoefficient);
        ```

    === "Python"

        ```python
        congestion_coefficient = outputSiteVehicleMC.CongestionCoefficient
        ```

### TravelTimeIndex {#traveltimeindex}

```csharp
float TravelTimeIndex { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travelTimeIndex = outputSiteVehicleMC.TravelTimeIndex;
        ```

    === "C++"

        ```cpp
        double travelTimeIndex;
        outputSiteVehicleMC->get_TravelTimeIndex(&travelTimeIndex);
        ```

    === "Python"

        ```python
        travel_time_index = outputSiteVehicleMC.TravelTimeIndex
        ```

### Avg_num_of_cycles_to_depart {#avg_num_of_cycles_to_depart}

```csharp
float Avg_num_of_cycles_to_depart { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float avg_num_of_cycles_to_depart = outputSiteVehicleMC.Avg_num_of_cycles_to_depart;
        ```

    === "C++"

        ```cpp
        double avg_num_of_cycles_to_depart;
        outputSiteVehicleMC->get_Avg_num_of_cycles_to_depart(&avg_num_of_cycles_to_depart);
        ```

    === "Python"

        ```python
        avg_num_of_cycles_to_depart = outputSiteVehicleMC.Avg_num_of_cycles_to_depart
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

```csharp
int DesiredSpeedMethod { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = outputSiteVehicleMC.DesiredSpeedMethod;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        outputSiteVehicleMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        ```

    === "Python"

        ```python
        desired_speed_method = outputSiteVehicleMC.DesiredSpeedMethod
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = outputSiteVehicleMC.DesiredSpeed;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        outputSiteVehicleMC->get_DesiredSpeed(&desiredSpeed);
        ```

    === "Python"

        ```python
        desired_speed = outputSiteVehicleMC.DesiredSpeed
        ```

### DesiredSpeedProgram {#desiredspeedprogram}

```csharp
float DesiredSpeedProgram { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeedProgram = outputSiteVehicleMC.DesiredSpeedProgram;
        ```

    === "C++"

        ```cpp
        double desiredSpeedProgram;
        outputSiteVehicleMC->get_DesiredSpeedProgram(&desiredSpeedProgram);
        ```

    === "Python"

        ```python
        desired_speed_program = outputSiteVehicleMC.DesiredSpeedProgram
        ```

### Travel_time_total_at_desired_speed {#travel_time_total_at_desired_speed}

```csharp
float Travel_time_total_at_desired_speed { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float travel_time_total_at_desired_speed = outputSiteVehicleMC.Travel_time_total_at_desired_speed;
        ```

    === "C++"

        ```cpp
        double travel_time_total_at_desired_speed;
        outputSiteVehicleMC->get_Travel_time_total_at_desired_speed(&travel_time_total_at_desired_speed);
        ```

    === "Python"

        ```python
        travel_time_total_at_desired_speed = outputSiteVehicleMC.Travel_time_total_at_desired_speed
        ```

### OutputSiteVehicle {#outputsitevehicle}

```csharp
ISIAPIOutputSiteVehicle OutputSiteVehicle { get; }
```

**Type** [`ISIAPIOutputSiteVehicle`](sidrasolutions.si.api.isiapioutputsitevehicle.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputSiteVehicle = outputSiteVehicleMC.OutputSiteVehicle;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteVehicle> outputSiteVehicle;
        outputSiteVehicleMC->get_OutputSiteVehicle(&outputSiteVehicle);
        ```

    === "Python"

        ```python
        output_site_vehicle = outputSiteVehicleMC.OutputSiteVehicle
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapioutputsitevehiclemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIOutputSiteVehicleMCs
title: OutputSiteVehicleMCs
name: ISIAPIOutputSiteVehicleMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2B5E8D3F-0F5E-4B29-90D0-3021B0AAC0CC
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPIOutputSiteVehicleMC this[int mcClass]
  - int Count
---

# OutputSiteVehicleMCs

Type `ISIAPIOutputSiteVehicleMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2B5E8D3F-0F5E-4B29-90D0-3021B0AAC0CC`

## Declaration

```csharp
[Guid("2B5E8D3F-0F5E-4B29-90D0-3021B0AAC0CC")]
public interface ISIAPIOutputSiteVehicleMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIOutputSiteVehicleMC`](sidrasolutions.si.api.isiapioutputsitevehiclemc.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = outputSiteVehicleMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        outputSiteVehicleMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = outputSiteVehicleMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIOutputSiteVehicleMC this[] { get; }
```

**Type** [`ISIAPIOutputSiteVehicleMC`](sidrasolutions.si.api.isiapioutputsitevehiclemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = outputSiteVehicleMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputSiteVehicleMC> this[];
        outputSiteVehicleMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = outputSiteVehicleMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = outputSiteVehicleMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        outputSiteVehicleMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = outputSiteVehicleMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphase.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhase
title: Phase
name: ISIAPIPhase
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4562846F-02E3-4C12-B075-FCE3FD2E0D98
members:
  - string Name
  - int Position
  - bool Is_variable
  - bool IsReferencePhase
  - float Phase_time
  - float Yellow_time
  - float All_red_time
  - bool Has_dummy
  - bool Dummy_minimum_green_time_user
  - float Dummy_minimum_green_time
  - bool Dummy_maximum_green_time_user
  - float Dummy_maximum_green_time
  - float Minimum_time
  - ISIAPIPhasemovement_vehicles Phasemovement_vehicles
  - ISIAPIPhasemovement_peds Phasemovement_peds
  - ISIAPISequence Sequence
  - bool Phase_frequency_user
  - float Phase_frequency
---

# Phase

Type `ISIAPIPhase` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4562846F-02E3-4C12-B075-FCE3FD2E0D98`

## Declaration

```csharp
[Guid("4562846F-02E3-4C12-B075-FCE3FD2E0D98")]
public interface ISIAPIPhase
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [Position](#position) | `int` | The Phase Position in the Sequence's Phases collection. It is a zero-base integer. |
| [Is_variable](#is_variable) | `bool` |  |
| [IsReferencePhase](#isreferencephase) | `bool` |  |
| [Phase_time](#phase_time) | `float` |  |
| [Yellow_time](#yellow_time) | `float` |  |
| [All_red_time](#all_red_time) | `float` |  |
| [Has_dummy](#has_dummy) | `bool` |  |
| [Dummy_minimum_green_time_user](#dummy_minimum_green_time_user) | `bool` |  |
| [Dummy_minimum_green_time](#dummy_minimum_green_time) | `float` |  |
| [Dummy_maximum_green_time_user](#dummy_maximum_green_time_user) | `bool` |  |
| [Dummy_maximum_green_time](#dummy_maximum_green_time) | `float` |  |
| [Minimum_time](#minimum_time) | `float` |  |
| [Phasemovement_vehicles](#phasemovement_vehicles) | [`ISIAPIPhasemovement_vehicles`](sidrasolutions.si.api.isiapiphasemovement_vehicles.md) |  |
| [Phasemovement_peds](#phasemovement_peds) | [`ISIAPIPhasemovement_peds`](sidrasolutions.si.api.isiapiphasemovement_peds.md) |  |
| [Sequence](#sequence) | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) |  |
| [Phase_frequency_user](#phase_frequency_user) | `bool` |  |
| [Phase_frequency](#phase_frequency) | `float` |  |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = phase.Name;
        phase.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        phase->get_Name(&name);
        phase->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = phase.Name
        phase.Name = r"Example"
        ```

### Position {#position}

The Phase Position in the Sequence's Phases collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = phase.Position;
        ```

    === "C++"

        ```cpp
        long position;
        phase->get_Position(&position);
        ```

    === "Python"

        ```python
        position = phase.Position
        ```

### Is_variable {#is_variable}

```csharp
bool Is_variable { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_variable = phase.Is_variable;
        phase.Is_variable = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_variable;
        phase->get_Is_variable(&is_variable);
        phase->put_Is_variable(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_variable = phase.Is_variable
        phase.Is_variable = True
        ```

### IsReferencePhase {#isreferencephase}

```csharp
bool IsReferencePhase { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isReferencePhase = phase.IsReferencePhase;
        phase.IsReferencePhase = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isReferencePhase;
        phase->get_IsReferencePhase(&isReferencePhase);
        phase->put_IsReferencePhase(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_reference_phase = phase.IsReferencePhase
        phase.IsReferencePhase = True
        ```

### Phase_time {#phase_time}

```csharp
float Phase_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_time = phase.Phase_time;
        phase.Phase_time = 0.0;
        ```

    === "C++"

        ```cpp
        double phase_time;
        phase->get_Phase_time(&phase_time);
        phase->put_Phase_time(0.0);
        ```

    === "Python"

        ```python
        phase_time = phase.Phase_time
        phase.Phase_time = 0.0
        ```

### Yellow_time {#yellow_time}

```csharp
float Yellow_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float yellow_time = phase.Yellow_time;
        phase.Yellow_time = 0.0;
        ```

    === "C++"

        ```cpp
        double yellow_time;
        phase->get_Yellow_time(&yellow_time);
        phase->put_Yellow_time(0.0);
        ```

    === "Python"

        ```python
        yellow_time = phase.Yellow_time
        phase.Yellow_time = 0.0
        ```

### All_red_time {#all_red_time}

```csharp
float All_red_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float all_red_time = phase.All_red_time;
        phase.All_red_time = 0.0;
        ```

    === "C++"

        ```cpp
        double all_red_time;
        phase->get_All_red_time(&all_red_time);
        phase->put_All_red_time(0.0);
        ```

    === "Python"

        ```python
        all_red_time = phase.All_red_time
        phase.All_red_time = 0.0
        ```

### Has_dummy {#has_dummy}

```csharp
bool Has_dummy { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool has_dummy = phase.Has_dummy;
        phase.Has_dummy = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL has_dummy;
        phase->get_Has_dummy(&has_dummy);
        phase->put_Has_dummy(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        has_dummy = phase.Has_dummy
        phase.Has_dummy = True
        ```

### Dummy_minimum_green_time_user {#dummy_minimum_green_time_user}

```csharp
bool Dummy_minimum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool dummy_minimum_green_time_user = phase.Dummy_minimum_green_time_user;
        phase.Dummy_minimum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL dummy_minimum_green_time_user;
        phase->get_Dummy_minimum_green_time_user(&dummy_minimum_green_time_user);
        phase->put_Dummy_minimum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        dummy_minimum_green_time_user = phase.Dummy_minimum_green_time_user
        phase.Dummy_minimum_green_time_user = True
        ```

### Dummy_minimum_green_time {#dummy_minimum_green_time}

```csharp
float Dummy_minimum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_minimum_green_time = phase.Dummy_minimum_green_time;
        phase.Dummy_minimum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double dummy_minimum_green_time;
        phase->get_Dummy_minimum_green_time(&dummy_minimum_green_time);
        phase->put_Dummy_minimum_green_time(0.0);
        ```

    === "Python"

        ```python
        dummy_minimum_green_time = phase.Dummy_minimum_green_time
        phase.Dummy_minimum_green_time = 0.0
        ```

### Dummy_maximum_green_time_user {#dummy_maximum_green_time_user}

```csharp
bool Dummy_maximum_green_time_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool dummy_maximum_green_time_user = phase.Dummy_maximum_green_time_user;
        phase.Dummy_maximum_green_time_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL dummy_maximum_green_time_user;
        phase->get_Dummy_maximum_green_time_user(&dummy_maximum_green_time_user);
        phase->put_Dummy_maximum_green_time_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        dummy_maximum_green_time_user = phase.Dummy_maximum_green_time_user
        phase.Dummy_maximum_green_time_user = True
        ```

### Dummy_maximum_green_time {#dummy_maximum_green_time}

```csharp
float Dummy_maximum_green_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float dummy_maximum_green_time = phase.Dummy_maximum_green_time;
        phase.Dummy_maximum_green_time = 0.0;
        ```

    === "C++"

        ```cpp
        double dummy_maximum_green_time;
        phase->get_Dummy_maximum_green_time(&dummy_maximum_green_time);
        phase->put_Dummy_maximum_green_time(0.0);
        ```

    === "Python"

        ```python
        dummy_maximum_green_time = phase.Dummy_maximum_green_time
        phase.Dummy_maximum_green_time = 0.0
        ```

### Minimum_time {#minimum_time}

```csharp
float Minimum_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float minimum_time = phase.Minimum_time;
        phase.Minimum_time = 0.0;
        ```

    === "C++"

        ```cpp
        double minimum_time;
        phase->get_Minimum_time(&minimum_time);
        phase->put_Minimum_time(0.0);
        ```

    === "Python"

        ```python
        minimum_time = phase.Minimum_time
        phase.Minimum_time = 0.0
        ```

### Phasemovement_vehicles {#phasemovement_vehicles}

```csharp
ISIAPIPhasemovement_vehicles Phasemovement_vehicles { get; }
```

**Type** [`ISIAPIPhasemovement_vehicles`](sidrasolutions.si.api.isiapiphasemovement_vehicles.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phasemovement_vehicles = phase.Phasemovement_vehicles;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_vehicles> phasemovement_vehicles;
        phase->get_Phasemovement_vehicles(&phasemovement_vehicles);
        ```

    === "Python"

        ```python
        phasemovement_vehicles = phase.Phasemovement_vehicles
        ```

### Phasemovement_peds {#phasemovement_peds}

```csharp
ISIAPIPhasemovement_peds Phasemovement_peds { get; }
```

**Type** [`ISIAPIPhasemovement_peds`](sidrasolutions.si.api.isiapiphasemovement_peds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phasemovement_peds = phase.Phasemovement_peds;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_peds> phasemovement_peds;
        phase->get_Phasemovement_peds(&phasemovement_peds);
        ```

    === "Python"

        ```python
        phasemovement_peds = phase.Phasemovement_peds
        ```

### Sequence {#sequence}

```csharp
ISIAPISequence Sequence { get; }
```

**Type** [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var sequence = phase.Sequence;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequence> sequence;
        phase->get_Sequence(&sequence);
        ```

    === "Python"

        ```python
        sequence = phase.Sequence
        ```

### Phase_frequency_user {#phase_frequency_user}

```csharp
bool Phase_frequency_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool phase_frequency_user = phase.Phase_frequency_user;
        phase.Phase_frequency_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL phase_frequency_user;
        phase->get_Phase_frequency_user(&phase_frequency_user);
        phase->put_Phase_frequency_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        phase_frequency_user = phase.Phase_frequency_user
        phase.Phase_frequency_user = True
        ```

### Phase_frequency {#phase_frequency}

```csharp
float Phase_frequency { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float phase_frequency = phase.Phase_frequency;
        phase.Phase_frequency = 0.0;
        ```

    === "C++"

        ```cpp
        double phase_frequency;
        phase->get_Phase_frequency(&phase_frequency);
        phase->put_Phase_frequency(0.0);
        ```

    === "Python"

        ```python
        phase_frequency = phase.Phase_frequency
        phase.Phase_frequency = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphasemovement_ped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhasemovement_ped
title: Phasemovement_ped
name: ISIAPIPhasemovement_ped
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 68BEA53D-4F9E-443E-9E57-1AB56AE4E0DA
members:
  - int Movement_ped_origin
  - int Movement_ped_type
  - int Movement_ped_stage
  - bool Running
  - bool Terminates
  - bool Undetected
  - ISIAPIPhase Phase
---

# Phasemovement_ped

Type `ISIAPIPhasemovement_ped` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `68BEA53D-4F9E-443E-9E57-1AB56AE4E0DA`

## Declaration

```csharp
[Guid("68BEA53D-4F9E-443E-9E57-1AB56AE4E0DA")]
public interface ISIAPIPhasemovement_ped
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Movement_ped_origin](#movement_ped_origin) | `int` |  |
| [Movement_ped_type](#movement_ped_type) | `int` |  |
| [Movement_ped_stage](#movement_ped_stage) | `int` |  |
| [Running](#running) | `bool` |  |
| [Terminates](#terminates) | `bool` |  |
| [Undetected](#undetected) | `bool` |  |
| [Phase](#phase) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) |  |

</div>

## Properties

### Movement_ped_origin {#movement_ped_origin}

```csharp
int Movement_ped_origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_ped_origin = phasemovement_ped.Movement_ped_origin;
        ```

    === "C++"

        ```cpp
        long movement_ped_origin;
        phasemovement_ped->get_Movement_ped_origin(&movement_ped_origin);
        ```

    === "Python"

        ```python
        movement_ped_origin = phasemovement_ped.Movement_ped_origin
        ```

### Movement_ped_type {#movement_ped_type}

```csharp
int Movement_ped_type { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_ped_type = phasemovement_ped.Movement_ped_type;
        ```

    === "C++"

        ```cpp
        long movement_ped_type;
        phasemovement_ped->get_Movement_ped_type(&movement_ped_type);
        ```

    === "Python"

        ```python
        movement_ped_type = phasemovement_ped.Movement_ped_type
        ```

### Movement_ped_stage {#movement_ped_stage}

```csharp
int Movement_ped_stage { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_ped_stage = phasemovement_ped.Movement_ped_stage;
        ```

    === "C++"

        ```cpp
        long movement_ped_stage;
        phasemovement_ped->get_Movement_ped_stage(&movement_ped_stage);
        ```

    === "Python"

        ```python
        movement_ped_stage = phasemovement_ped.Movement_ped_stage
        ```

### Running {#running}

```csharp
bool Running { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool running = phasemovement_ped.Running;
        phasemovement_ped.Running = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL running;
        phasemovement_ped->get_Running(&running);
        phasemovement_ped->put_Running(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        running = phasemovement_ped.Running
        phasemovement_ped.Running = True
        ```

### Terminates {#terminates}

```csharp
bool Terminates { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool terminates = phasemovement_ped.Terminates;
        phasemovement_ped.Terminates = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL terminates;
        phasemovement_ped->get_Terminates(&terminates);
        phasemovement_ped->put_Terminates(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        terminates = phasemovement_ped.Terminates
        phasemovement_ped.Terminates = True
        ```

### Undetected {#undetected}

```csharp
bool Undetected { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool undetected = phasemovement_ped.Undetected;
        phasemovement_ped.Undetected = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL undetected;
        phasemovement_ped->get_Undetected(&undetected);
        phasemovement_ped->put_Undetected(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        undetected = phasemovement_ped.Undetected
        phasemovement_ped.Undetected = True
        ```

### Phase {#phase}

```csharp
ISIAPIPhase Phase { get; }
```

**Type** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phase = phasemovement_ped.Phase;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> phase;
        phasemovement_ped->get_Phase(&phase);
        ```

    === "Python"

        ```python
        phase = phasemovement_ped.Phase
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphasemovement_peds.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhasemovement_peds
title: Phasemovement_peds
name: ISIAPIPhasemovement_peds
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 29FCFFCB-198A-48E0-A45E-D3C24650D76A
members:
  - bool PhasemovementPedExists(int type, int origin, int stage)
  - ISIAPIPhasemovement_ped this[int type, int origin, int stage]
  - int Count
---

# Phasemovement_peds

Type `ISIAPIPhasemovement_peds` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `29FCFFCB-198A-48E0-A45E-D3C24650D76A`

## Declaration

```csharp
[Guid("29FCFFCB-198A-48E0-A45E-D3C24650D76A")]
public interface ISIAPIPhasemovement_peds
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIPhasemovement_ped`](sidrasolutions.si.api.isiapiphasemovement_ped.md) | Get a Phase's Pedestrian Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [PhasemovementPedExists(int, int, int)](#phasemovementpedexists-int--int--int) | `bool` | Get a value indicating whether a Phase's Pedestrian Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = phasemovement_peds.Count;
        ```

    === "C++"

        ```cpp
        long count;
        phasemovement_peds->get_Count(&count);
        ```

    === "Python"

        ```python
        count = phasemovement_peds.Count
        ```

### this[] {#this}

Get a Phase's Pedestrian Movement.

```csharp
ISIAPIPhasemovement_ped this[] { get; }
```

**Type** [`ISIAPIPhasemovement_ped`](sidrasolutions.si.api.isiapiphasemovement_ped.md) - Return a Phase's Pedestrian Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = phasemovement_peds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_ped> this[];
        phasemovement_peds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = phasemovement_peds.this[]
        ```

## Methods

### PhasemovementPedExists(int, int, int) {#phasemovementpedexists-int--int--int}

Get a value indicating whether a Phase's Pedestrian Movement exists in the data storage.

```csharp
bool PhasemovementPedExists(int type, int origin, int stage)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `type` | `int` | One of: - `1` - Full Crossing - `2` - Slip Lane - `3` - Staged - `4` - Diagonal |
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `stage` | `int` | One of: - `1` - Stage 1 (Approach-side crossing) - `2` - Stage 2 (Exit-side crossing) |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = phasemovement_peds.PhasemovementPedExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        phasemovement_peds->PhasemovementPedExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = phasemovement_peds.PhasemovementPedExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphasemovement_vehicle.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhasemovement_vehicle
title: Phasemovement_vehicle
name: ISIAPIPhasemovement_vehicle
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 05490B51-B40F-4FF8-8CEC-F0EE4D836503
members:
  - int Movement_vehicle_origin
  - int Movement_vehicle_destination
  - int MC_class
  - bool Running
  - bool Terminates
  - bool Undetected
  - ISIAPIPhase Phase
  - bool Is_red_arrow_drop_off_enabled
  - float Red_arrow_drop_off
  - bool Is_early_cutoff
  - float Early_cutoff
  - bool Is_late_start
  - float Late_start
---

# Phasemovement_vehicle

Type `ISIAPIPhasemovement_vehicle` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `05490B51-B40F-4FF8-8CEC-F0EE4D836503`

## Declaration

```csharp
[Guid("05490B51-B40F-4FF8-8CEC-F0EE4D836503")]
public interface ISIAPIPhasemovement_vehicle
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Movement_vehicle_origin](#movement_vehicle_origin) | `int` |  |
| [Movement_vehicle_destination](#movement_vehicle_destination) | `int` |  |
| [MC_class](#mc_class) | `int` |  |
| [Running](#running) | `bool` |  |
| [Terminates](#terminates) | `bool` |  |
| [Undetected](#undetected) | `bool` |  |
| [Phase](#phase) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) |  |
| [Is_red_arrow_drop_off_enabled](#is_red_arrow_drop_off_enabled) | `bool` |  |
| [Red_arrow_drop_off](#red_arrow_drop_off) | `float` |  |
| [Is_early_cutoff](#is_early_cutoff) | `bool` |  |
| [Early_cutoff](#early_cutoff) | `float` |  |
| [Is_late_start](#is_late_start) | `bool` |  |
| [Late_start](#late_start) | `float` |  |

</div>

## Properties

### Movement_vehicle_origin {#movement_vehicle_origin}

```csharp
int Movement_vehicle_origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_vehicle_origin = phasemovement_vehicle.Movement_vehicle_origin;
        ```

    === "C++"

        ```cpp
        long movement_vehicle_origin;
        phasemovement_vehicle->get_Movement_vehicle_origin(&movement_vehicle_origin);
        ```

    === "Python"

        ```python
        movement_vehicle_origin = phasemovement_vehicle.Movement_vehicle_origin
        ```

### Movement_vehicle_destination {#movement_vehicle_destination}

```csharp
int Movement_vehicle_destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_vehicle_destination = phasemovement_vehicle.Movement_vehicle_destination;
        ```

    === "C++"

        ```cpp
        long movement_vehicle_destination;
        phasemovement_vehicle->get_Movement_vehicle_destination(&movement_vehicle_destination);
        ```

    === "Python"

        ```python
        movement_vehicle_destination = phasemovement_vehicle.Movement_vehicle_destination
        ```

### MC_class {#mc_class}

```csharp
int MC_class { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = phasemovement_vehicle.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        phasemovement_vehicle->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = phasemovement_vehicle.MC_class
        ```

### Running {#running}

```csharp
bool Running { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool running = phasemovement_vehicle.Running;
        phasemovement_vehicle.Running = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL running;
        phasemovement_vehicle->get_Running(&running);
        phasemovement_vehicle->put_Running(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        running = phasemovement_vehicle.Running
        phasemovement_vehicle.Running = True
        ```

### Terminates {#terminates}

```csharp
bool Terminates { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool terminates = phasemovement_vehicle.Terminates;
        phasemovement_vehicle.Terminates = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL terminates;
        phasemovement_vehicle->get_Terminates(&terminates);
        phasemovement_vehicle->put_Terminates(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        terminates = phasemovement_vehicle.Terminates
        phasemovement_vehicle.Terminates = True
        ```

### Undetected {#undetected}

```csharp
bool Undetected { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool undetected = phasemovement_vehicle.Undetected;
        phasemovement_vehicle.Undetected = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL undetected;
        phasemovement_vehicle->get_Undetected(&undetected);
        phasemovement_vehicle->put_Undetected(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        undetected = phasemovement_vehicle.Undetected
        phasemovement_vehicle.Undetected = True
        ```

### Phase {#phase}

```csharp
ISIAPIPhase Phase { get; }
```

**Type** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phase = phasemovement_vehicle.Phase;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> phase;
        phasemovement_vehicle->get_Phase(&phase);
        ```

    === "Python"

        ```python
        phase = phasemovement_vehicle.Phase
        ```

### Is_red_arrow_drop_off_enabled {#is_red_arrow_drop_off_enabled}

```csharp
bool Is_red_arrow_drop_off_enabled { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_red_arrow_drop_off_enabled = phasemovement_vehicle.Is_red_arrow_drop_off_enabled;
        phasemovement_vehicle.Is_red_arrow_drop_off_enabled = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_red_arrow_drop_off_enabled;
        phasemovement_vehicle->get_Is_red_arrow_drop_off_enabled(&is_red_arrow_drop_off_enabled);
        phasemovement_vehicle->put_Is_red_arrow_drop_off_enabled(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_red_arrow_drop_off_enabled = phasemovement_vehicle.Is_red_arrow_drop_off_enabled
        phasemovement_vehicle.Is_red_arrow_drop_off_enabled = True
        ```

### Red_arrow_drop_off {#red_arrow_drop_off}

```csharp
float Red_arrow_drop_off { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float red_arrow_drop_off = phasemovement_vehicle.Red_arrow_drop_off;
        phasemovement_vehicle.Red_arrow_drop_off = 0.0;
        ```

    === "C++"

        ```cpp
        double red_arrow_drop_off;
        phasemovement_vehicle->get_Red_arrow_drop_off(&red_arrow_drop_off);
        phasemovement_vehicle->put_Red_arrow_drop_off(0.0);
        ```

    === "Python"

        ```python
        red_arrow_drop_off = phasemovement_vehicle.Red_arrow_drop_off
        phasemovement_vehicle.Red_arrow_drop_off = 0.0
        ```

### Is_early_cutoff {#is_early_cutoff}

```csharp
bool Is_early_cutoff { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_early_cutoff = phasemovement_vehicle.Is_early_cutoff;
        phasemovement_vehicle.Is_early_cutoff = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_early_cutoff;
        phasemovement_vehicle->get_Is_early_cutoff(&is_early_cutoff);
        phasemovement_vehicle->put_Is_early_cutoff(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_early_cutoff = phasemovement_vehicle.Is_early_cutoff
        phasemovement_vehicle.Is_early_cutoff = True
        ```

### Early_cutoff {#early_cutoff}

```csharp
float Early_cutoff { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float early_cutoff = phasemovement_vehicle.Early_cutoff;
        phasemovement_vehicle.Early_cutoff = 0.0;
        ```

    === "C++"

        ```cpp
        double early_cutoff;
        phasemovement_vehicle->get_Early_cutoff(&early_cutoff);
        phasemovement_vehicle->put_Early_cutoff(0.0);
        ```

    === "Python"

        ```python
        early_cutoff = phasemovement_vehicle.Early_cutoff
        phasemovement_vehicle.Early_cutoff = 0.0
        ```

### Is_late_start {#is_late_start}

```csharp
bool Is_late_start { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_late_start = phasemovement_vehicle.Is_late_start;
        phasemovement_vehicle.Is_late_start = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_late_start;
        phasemovement_vehicle->get_Is_late_start(&is_late_start);
        phasemovement_vehicle->put_Is_late_start(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_late_start = phasemovement_vehicle.Is_late_start
        phasemovement_vehicle.Is_late_start = True
        ```

### Late_start {#late_start}

```csharp
float Late_start { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float late_start = phasemovement_vehicle.Late_start;
        phasemovement_vehicle.Late_start = 0.0;
        ```

    === "C++"

        ```cpp
        double late_start;
        phasemovement_vehicle->get_Late_start(&late_start);
        phasemovement_vehicle->put_Late_start(0.0);
        ```

    === "Python"

        ```python
        late_start = phasemovement_vehicle.Late_start
        phasemovement_vehicle.Late_start = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphasemovement_vehicles.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhasemovement_vehicles
title: Phasemovement_vehicles
name: ISIAPIPhasemovement_vehicles
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 6C0D331C-1B1B-4C15-9D8D-43B7310274CC
members:
  - bool PhasemovementVehicleExists(int origin, int destination, int mcClass)
  - ISIAPIPhasemovement_vehicle this[int origin, int destination, int mcClass]
  - int Count
---

# Phasemovement_vehicles

Type `ISIAPIPhasemovement_vehicles` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `6C0D331C-1B1B-4C15-9D8D-43B7310274CC`

## Declaration

```csharp
[Guid("6C0D331C-1B1B-4C15-9D8D-43B7310274CC")]
public interface ISIAPIPhasemovement_vehicles
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIPhasemovement_vehicle`](sidrasolutions.si.api.isiapiphasemovement_vehicle.md) | Get a Phase's Vehicle Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [PhasemovementVehicleExists(int, int, int)](#phasemovementvehicleexists-int--int--int) | `bool` | Get a value indicating whether a Phase's Vehicle Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = phasemovement_vehicles.Count;
        ```

    === "C++"

        ```cpp
        long count;
        phasemovement_vehicles->get_Count(&count);
        ```

    === "Python"

        ```python
        count = phasemovement_vehicles.Count
        ```

### this[] {#this}

Get a Phase's Vehicle Movement.

```csharp
ISIAPIPhasemovement_vehicle this[] { get; }
```

**Type** [`ISIAPIPhasemovement_vehicle`](sidrasolutions.si.api.isiapiphasemovement_vehicle.md) - Return a Phase's Vehicle Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = phasemovement_vehicles.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhasemovement_vehicle> this[];
        phasemovement_vehicles->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = phasemovement_vehicles.this[]
        ```

## Methods

### PhasemovementVehicleExists(int, int, int) {#phasemovementvehicleexists-int--int--int}

Get a value indicating whether a Phase's Vehicle Movement exists in the data storage.

```csharp
bool PhasemovementVehicleExists(int origin, int destination, int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `destination` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `mcClass` | `int` | One of: - `1` - Light Vehicles - `2` - Heavy Vehicles - `3` - Buses - `4` - Bicycles - `5` - Large Trucks - `6` - Trams - `7` - User Class 1 - `8` - User Class 2 |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = phasemovement_vehicles.PhasemovementVehicleExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        phasemovement_vehicles->PhasemovementVehicleExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = phasemovement_vehicles.PhasemovementVehicleExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiphases.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIPhases
title: Phases
name: ISIAPIPhases
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: C5D06130-63EE-413E-B452-5A0D13701E6D
members:
  - bool PhaseExists(string phasename)
  - ISIAPIPhase this[string phasename]
  - ISIAPIPhase this[int index]
  - int Count
---

# Phases

Type `ISIAPIPhases` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `C5D06130-63EE-413E-B452-5A0D13701E6D`

## Declaration

```csharp
[Guid("C5D06130-63EE-413E-B452-5A0D13701E6D")]
public interface ISIAPIPhases
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) |  |
| [this[]](#this) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [PhaseExists(string)](#phaseexists-string) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = phases.Count;
        ```

    === "C++"

        ```cpp
        long count;
        phases->get_Count(&count);
        ```

    === "Python"

        ```python
        count = phases.Count
        ```

### this[] {#this}

```csharp
ISIAPIPhase this[] { get; }
```

**Type** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = phases.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> this[];
        phases->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = phases.this[]
        ```

### this[] {#this}

```csharp
ISIAPIPhase this[] { get; }
```

**Type** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = phases.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> this[];
        phases->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = phases.this[]
        ```

## Methods

### PhaseExists(string) {#phaseexists-string}

```csharp
bool PhaseExists(string phasename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `phasename` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = phases.PhaseExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        phases->PhaseExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = phases.PhaseExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiproject.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIProject
title: Project
name: ISIAPIProject
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 92FE4623-165F-4767-B5DD-0C803422C9DD
summary: SIDRA INTERSECTION Project wrapper interface
members:
  - bool UpdateModifiedInfo()
  - int ImportSitesFromProject(string projectFilePath, string siteNames)
  - int ImportNetworksFromProject(string projectFilePath, string networkNames)
  - ISIAPISiteFolder AddSiteFolder(string name)
  - bool RemoveSiteFolder(ISIAPISiteFolder siteFolder)
  - bool MoveSiteFolderTo(ISIAPISiteFolder siteFolder, int newPosition)
  - ISIAPINetworkFolder AddNetworkFolder(string name)
  - bool RemoveNetworkFolder(ISIAPINetworkFolder networkFolder)
  - bool MoveNetworkFolderTo(ISIAPINetworkFolder networkFolder, int newPosition)
  - ISIAPISiteVolumeBinFolder AddSiteVolumeBinFolder(string name)
  - bool RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder siteVolumeBinFolder)
  - bool MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder siteVolumeBinFolder, int newPosition)
  - string Name
  - string LastErrorMessage
  - ISIAPISiteFolders SiteFolders
  - ISIAPINetworkFolders NetworkFolders
  - string Description
  - string MinViableVersion
  - DateTime Created_date
  - string Created_by
  - string Created_by_company
  - string Created_version
  - DateTime Modified_date
  - string Modified_by
  - string Modified_by_company
  - string Modified_version
  - string EarliestModifiedVersion
  - string LatestModifiedVersion
  - ISIAPISiteVolumeBinFolders SiteVolumeBinFolders
---

# Project

Type `ISIAPIProject` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `92FE4623-165F-4767-B5DD-0C803422C9DD`

SIDRA INTERSECTION Project wrapper interface

## Declaration

```csharp
[Guid("92FE4623-165F-4767-B5DD-0C803422C9DD")]
public interface ISIAPIProject
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | Project name |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [SiteFolders](#sitefolders) | [`ISIAPISiteFolders`](sidrasolutions.si.api.isiapisitefolders.md) | Collection of SiteFolders in the current Project |
| [NetworkFolders](#networkfolders) | [`ISIAPINetworkFolders`](sidrasolutions.si.api.isiapinetworkfolders.md) | Collection of NetworkFolders in the current Project |
| [Description](#description) | `string` |  |
| [MinViableVersion](#minviableversion) | `string` |  |
| [Created_date](#created_date) | `DateTime` |  |
| [Created_by](#created_by) | `string` |  |
| [Created_by_company](#created_by_company) | `string` |  |
| [Created_version](#created_version) | `string` |  |
| [Modified_date](#modified_date) | `DateTime` |  |
| [Modified_by](#modified_by) | `string` |  |
| [Modified_by_company](#modified_by_company) | `string` |  |
| [Modified_version](#modified_version) | `string` |  |
| [EarliestModifiedVersion](#earliestmodifiedversion) | `string` |  |
| [LatestModifiedVersion](#latestmodifiedversion) | `string` |  |
| [SiteVolumeBinFolders](#sitevolumebinfolders) | [`ISIAPISiteVolumeBinFolders`](sidrasolutions.si.api.isiapisitevolumebinfolders.md) | Collection of SiteVolumeBinFolders in the current Project |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [UpdateModifiedInfo()](#updatemodifiedinfo) | `bool` | Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number |
| [ImportSitesFromProject(string, string)](#importsitesfromproject-string--string) | `int` | Import Site(s) from another Project file into this Project file. |
| [ImportNetworksFromProject(string, string)](#importnetworksfromproject-string--string) | `int` | Import Network(s) from another Project file into this Project file. This function will import the Sites in the Network(s) too. |
| [AddSiteFolder(string)](#addsitefolder-string) | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | Add a new SiteFolder into the Project. |
| [RemoveSiteFolder(ISIAPISiteFolder)](#removesitefolder-isiapisitefolder) | `bool` | Remove a SiteFolder from the Project. All Sites in the SiteFolder will be removed. This method fails if any Site in the SiteFolder is used in a Network. |
| [MoveSiteFolderTo(ISIAPISiteFolder, int)](#movesitefolderto-isiapisitefolder--int) | `bool` | Move a SiteFolder to a new position. |
| [AddNetworkFolder(string)](#addnetworkfolder-string) | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | Add a new NetworkFolder into the Project. |
| [RemoveNetworkFolder(ISIAPINetworkFolder)](#removenetworkfolder-isiapinetworkfolder) | `bool` | Remove a NetworkFolder from the Project. All Networks in the NetworkFolder will be removed. |
| [MoveNetworkFolderTo(ISIAPINetworkFolder, int)](#movenetworkfolderto-isiapinetworkfolder--int) | `bool` | Move a NetworkFolder to a new position. |
| [AddSiteVolumeBinFolder(string)](#addsitevolumebinfolder-string) | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | Add a new SiteVolumeBinFolder into the Project. |
| [RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder)](#removesitevolumebinfolder-isiapisitevolumebinfolder) | `bool` | Remove a SiteVolumeBinFolder from the Project. All SiteVolumeBins in the SiteVolumeBinFolder will be removed. This method fails if any SiteVolumeBin in the Folder is used by Site. |
| [MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder, int)](#movesitevolumebinfolderto-isiapisitevolumebinfolder--int) | `bool` | Move a SiteVolumeBinFolder to a new position. |

</div>

## Properties

### Name {#name}

Project name

```csharp
string Name { get; }
```

**Type** `string`

**Value**

Project name

???- example "Code samples"

    === "C#"

        ```csharp
        string name = project.Name;
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        project->get_Name(&name);
        ```

    === "Python"

        ```python
        name = project.Name
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = project.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        project->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = project.LastErrorMessage
        ```

### SiteFolders {#sitefolders}

Collection of SiteFolders in the current Project

```csharp
ISIAPISiteFolders SiteFolders { get; }
```

**Type** [`ISIAPISiteFolders`](sidrasolutions.si.api.isiapisitefolders.md)

**Value**

SiteFolders collection

???- example "Code samples"

    === "C#"

        ```csharp
        var siteFolders = project.SiteFolders;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteFolders> siteFolders;
        project->get_SiteFolders(&siteFolders);
        ```

    === "Python"

        ```python
        site_folders = project.SiteFolders
        ```

### NetworkFolders {#networkfolders}

Collection of NetworkFolders in the current Project

```csharp
ISIAPINetworkFolders NetworkFolders { get; }
```

**Type** [`ISIAPINetworkFolders`](sidrasolutions.si.api.isiapinetworkfolders.md)

**Value**

NetworkFolders collection

???- example "Code samples"

    === "C#"

        ```csharp
        var networkFolders = project.NetworkFolders;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkFolders> networkFolders;
        project->get_NetworkFolders(&networkFolders);
        ```

    === "Python"

        ```python
        network_folders = project.NetworkFolders
        ```

### Description {#description}

```csharp
string Description { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string description = project.Description;
        project.Description = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR description;
        project->get_Description(&description);
        project->put_Description(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        description = project.Description
        project.Description = r"value"
        ```

### MinViableVersion {#minviableversion}

```csharp
string MinViableVersion { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersion = project.MinViableVersion;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersion;
        project->get_MinViableVersion(&minViableVersion);
        ```

    === "Python"

        ```python
        min_viable_version = project.MinViableVersion
        ```

### Created_date {#created_date}

```csharp
DateTime Created_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var created_date = project.Created_date;
        ```

    === "C++"

        ```cpp
        VARIANT created_date;
        project->get_Created_date(&created_date);
        ```

    === "Python"

        ```python
        created_date = project.Created_date
        ```

### Created_by {#created_by}

```csharp
string Created_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by = project.Created_by;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by;
        project->get_Created_by(&created_by);
        ```

    === "Python"

        ```python
        created_by = project.Created_by
        ```

### Created_by_company {#created_by_company}

```csharp
string Created_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by_company = project.Created_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by_company;
        project->get_Created_by_company(&created_by_company);
        ```

    === "Python"

        ```python
        created_by_company = project.Created_by_company
        ```

### Created_version {#created_version}

```csharp
string Created_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_version = project.Created_version;
        ```

    === "C++"

        ```cpp
        CComBSTR created_version;
        project->get_Created_version(&created_version);
        ```

    === "Python"

        ```python
        created_version = project.Created_version
        ```

### Modified_date {#modified_date}

```csharp
DateTime Modified_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var modified_date = project.Modified_date;
        ```

    === "C++"

        ```cpp
        VARIANT modified_date;
        project->get_Modified_date(&modified_date);
        ```

    === "Python"

        ```python
        modified_date = project.Modified_date
        ```

### Modified_by {#modified_by}

```csharp
string Modified_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by = project.Modified_by;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by;
        project->get_Modified_by(&modified_by);
        ```

    === "Python"

        ```python
        modified_by = project.Modified_by
        ```

### Modified_by_company {#modified_by_company}

```csharp
string Modified_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by_company = project.Modified_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by_company;
        project->get_Modified_by_company(&modified_by_company);
        ```

    === "Python"

        ```python
        modified_by_company = project.Modified_by_company
        ```

### Modified_version {#modified_version}

```csharp
string Modified_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_version = project.Modified_version;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_version;
        project->get_Modified_version(&modified_version);
        ```

    === "Python"

        ```python
        modified_version = project.Modified_version
        ```

### EarliestModifiedVersion {#earliestmodifiedversion}

```csharp
string EarliestModifiedVersion { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string earliestModifiedVersion = project.EarliestModifiedVersion;
        ```

    === "C++"

        ```cpp
        CComBSTR earliestModifiedVersion;
        project->get_EarliestModifiedVersion(&earliestModifiedVersion);
        ```

    === "Python"

        ```python
        earliest_modified_version = project.EarliestModifiedVersion
        ```

### LatestModifiedVersion {#latestmodifiedversion}

```csharp
string LatestModifiedVersion { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string latestModifiedVersion = project.LatestModifiedVersion;
        ```

    === "C++"

        ```cpp
        CComBSTR latestModifiedVersion;
        project->get_LatestModifiedVersion(&latestModifiedVersion);
        ```

    === "Python"

        ```python
        latest_modified_version = project.LatestModifiedVersion
        ```

### SiteVolumeBinFolders {#sitevolumebinfolders}

Collection of SiteVolumeBinFolders in the current Project

```csharp
ISIAPISiteVolumeBinFolders SiteVolumeBinFolders { get; }
```

**Type** [`ISIAPISiteVolumeBinFolders`](sidrasolutions.si.api.isiapisitevolumebinfolders.md)

**Value**

SiteVolumeBinFolders collection

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBinFolders = project.SiteVolumeBinFolders;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBinFolders> siteVolumeBinFolders;
        project->get_SiteVolumeBinFolders(&siteVolumeBinFolders);
        ```

    === "Python"

        ```python
        site_volume_bin_folders = project.SiteVolumeBinFolders
        ```

## Methods

### UpdateModifiedInfo() {#updatemodifiedinfo}

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

```csharp
bool UpdateModifiedInfo()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.UpdateModifiedInfo();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->UpdateModifiedInfo(&result);
        ```

    === "Python"

        ```python
        result = project.UpdateModifiedInfo()
        ```

### ImportSitesFromProject(string, string) {#importsitesfromproject-string--string}

Import Site(s) from another Project file into this Project file.

```csharp
int ImportSitesFromProject(string projectFilePath, string siteNames)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `projectFilePath` | `string` | The file path of the other Project file. |
| `siteNames` | `string` | The name(s) of the Site(s) to import. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples: |

**Returns** `int` - The number of successfully imported Sites

???- example "Code samples"

    === "C#"

        ```csharp
        int result = project.ImportSitesFromProject(@"C:\path\to\project.sipx", @"Main Intersection");
        ```

    === "C++"

        ```cpp
        long result;
        project->ImportSitesFromProject(CComBSTR(L"C:\\path\\to\\project.sipx"), CComBSTR(L"Main Intersection"), &result);
        ```

    === "Python"

        ```python
        result = project.ImportSitesFromProject(r"C:\path\to\project.sipx", r"Main Intersection")
        ```

### ImportNetworksFromProject(string, string) {#importnetworksfromproject-string--string}

Import Network(s) from another Project file into this Project file. This function will import the Sites in the Network(s) too.

```csharp
int ImportNetworksFromProject(string projectFilePath, string networkNames)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `projectFilePath` | `string` | The file path of the other Project file. |
| `networkNames` | `string` | The name(s) of the Network(s) to import. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples: |

**Returns** `int` - The number of successfully imported Networks

???- example "Code samples"

    === "C#"

        ```csharp
        int result = project.ImportNetworksFromProject(@"C:\path\to\project.sipx", @"City Network");
        ```

    === "C++"

        ```cpp
        long result;
        project->ImportNetworksFromProject(CComBSTR(L"C:\\path\\to\\project.sipx"), CComBSTR(L"City Network"), &result);
        ```

    === "Python"

        ```python
        result = project.ImportNetworksFromProject(r"C:\path\to\project.sipx", r"City Network")
        ```

### AddSiteFolder(string) {#addsitefolder-string}

Add a new SiteFolder into the Project.

```csharp
ISIAPISiteFolder AddSiteFolder(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` |  |

**Returns** [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = project.AddSiteFolder(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteFolder> result;
        project->AddSiteFolder(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = project.AddSiteFolder(r"Example")
        ```

### RemoveSiteFolder(ISIAPISiteFolder) {#removesitefolder-isiapisitefolder}

Remove a SiteFolder from the Project. All Sites in the SiteFolder will be removed. This method fails if any Site in the SiteFolder is used in a Network.

```csharp
bool RemoveSiteFolder(ISIAPISiteFolder siteFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteFolder` | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | The SiteFolder to remove. |

**Returns** `bool` - true if the SiteFolder is successfully removed; otherwise, false. This method also returns false if the SiteFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.RemoveSiteFolder(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->RemoveSiteFolder(NULL, &result);
        ```

    === "Python"

        ```python
        result = project.RemoveSiteFolder(None)
        ```

### MoveSiteFolderTo(ISIAPISiteFolder, int) {#movesitefolderto-isiapisitefolder--int}

Move a SiteFolder to a new position.

```csharp
bool MoveSiteFolderTo(ISIAPISiteFolder siteFolder, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteFolder` | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | The SiteFolder to move. |
| `newPosition` | `int` | The zero-based position that the SiteFolder should be moved to. |

**Returns** `bool` - true if the SiteFolder is successfully moved; otherwise, false. This method also returns false if the SiteFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.MoveSiteFolderTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->MoveSiteFolderTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = project.MoveSiteFolderTo(None, 0)
        ```

### AddNetworkFolder(string) {#addnetworkfolder-string}

Add a new NetworkFolder into the Project.

```csharp
ISIAPINetworkFolder AddNetworkFolder(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` |  |

**Returns** [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = project.AddNetworkFolder(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkFolder> result;
        project->AddNetworkFolder(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = project.AddNetworkFolder(r"Example")
        ```

### RemoveNetworkFolder(ISIAPINetworkFolder) {#removenetworkfolder-isiapinetworkfolder}

Remove a NetworkFolder from the Project. All Networks in the NetworkFolder will be removed.

```csharp
bool RemoveNetworkFolder(ISIAPINetworkFolder networkFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkFolder` | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | The NetworkFolder to remove. |

**Returns** `bool` - true if the NetworkFolder is successfully removed; otherwise, false. This method also returns false if the NetworkFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.RemoveNetworkFolder(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->RemoveNetworkFolder(NULL, &result);
        ```

    === "Python"

        ```python
        result = project.RemoveNetworkFolder(None)
        ```

### MoveNetworkFolderTo(ISIAPINetworkFolder, int) {#movenetworkfolderto-isiapinetworkfolder--int}

Move a NetworkFolder to a new position.

```csharp
bool MoveNetworkFolderTo(ISIAPINetworkFolder networkFolder, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkFolder` | [`ISIAPINetworkFolder`](sidrasolutions.si.api.isiapinetworkfolder.md) | The NetworkFolder to move. |
| `newPosition` | `int` | The zero-based position that the NetworkFolder should be moved to. |

**Returns** `bool` - true if the NetworkFolder is successfully moved; otherwise, false. This method also returns false if the NetworkFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.MoveNetworkFolderTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->MoveNetworkFolderTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = project.MoveNetworkFolderTo(None, 0)
        ```

### AddSiteVolumeBinFolder(string) {#addsitevolumebinfolder-string}

Add a new SiteVolumeBinFolder into the Project.

```csharp
ISIAPISiteVolumeBinFolder AddSiteVolumeBinFolder(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` |  |

**Returns** [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = project.AddSiteVolumeBinFolder(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBinFolder> result;
        project->AddSiteVolumeBinFolder(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = project.AddSiteVolumeBinFolder(r"Example")
        ```

### RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder) {#removesitevolumebinfolder-isiapisitevolumebinfolder}

Remove a SiteVolumeBinFolder from the Project. All SiteVolumeBins in the SiteVolumeBinFolder will be removed. This method fails if any SiteVolumeBin in the Folder is used by Site.

```csharp
bool RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder siteVolumeBinFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBinFolder` | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | The SiteVolumeBinFolder to remove. |

**Returns** `bool` - true if the SiteVolumeBinFolder is successfully removed; otherwise, false. This method also returns false if the SiteVolumeBinFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.RemoveSiteVolumeBinFolder(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->RemoveSiteVolumeBinFolder(NULL, &result);
        ```

    === "Python"

        ```python
        result = project.RemoveSiteVolumeBinFolder(None)
        ```

### MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder, int) {#movesitevolumebinfolderto-isiapisitevolumebinfolder--int}

Move a SiteVolumeBinFolder to a new position.

```csharp
bool MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder siteVolumeBinFolder, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBinFolder` | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | The SiteVolumeBinFolder to move. |
| `newPosition` | `int` | The zero-based position that the SiteVolumeBinFolder should be moved to. |

**Returns** `bool` - true if the SiteVolumeBinFolder is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBinFolder does not exist in this Project.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = project.MoveSiteVolumeBinFolderTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        project->MoveSiteVolumeBinFolderTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = project.MoveSiteVolumeBinFolderTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroute.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRoute
title: Route
name: ISIAPIRoute
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 86BE04E8-CC7C-4EFA-BCF2-75F768B58D78
members:
  - ISIAPIRouteNwSite AddRouteNwSite(ISIAPINetworkSite networkSite, int origin, int destination)
  - bool CheckIsValidForSignalOffsetCalc()
  - bool UpdateModifiedInfo()
  - bool Process()
  - bool RemoveRouteNwSite(ISIAPIRouteNwSite routeNwSite)
  - bool RemoveOutputData()
  - string Name
  - string RouteID
  - int Position
  - string Title
  - int LOSMethod
  - int RouteSummaryOption
  - bool IsIncludedInOutputNetworkByRoutes
  - bool IsIncludedInSignalOffsetCal
  - int SignalOffsetPriority
  - int SignalOffsetMethod
  - int SignalOffsetCalMCClass
  - DateTime Created_date
  - string Created_by
  - string Created_by_company
  - string Created_version
  - DateTime Modified_date
  - string Modified_by
  - string Modified_by_company
  - string Modified_version
  - ISIAPIRouteNwSites RouteNwSites
  - ISIAPINetwork Network
  - ISIAPIOutputNetwork OutputRoute
  - string LastErrorMessage
  - bool IsIncludedInProjectSummary
  - bool Is_time_distance_reverse_included
  - int Time_distance_direction
  - ISIAPIRouteMCs RouteMCs
  - bool ShowSecondaryPlatoons
---

# Route

Type `ISIAPIRoute` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `86BE04E8-CC7C-4EFA-BCF2-75F768B58D78`

## Declaration

```csharp
[Guid("86BE04E8-CC7C-4EFA-BCF2-75F768B58D78")]
public interface ISIAPIRoute
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [RouteID](#routeid) | `string` |  |
| [Position](#position) | `int` | The Route Position in the Network's Routes collection. It is a zero-base integer. |
| [Title](#title) | `string` |  |
| [LOSMethod](#losmethod) | `int` | Network Level of Service Method |
| [RouteSummaryOption](#routesummaryoption) | `int` | Route Summary Output Option |
| [IsIncludedInOutputNetworkByRoutes](#isincludedinoutputnetworkbyroutes) | `bool` |  |
| [IsIncludedInSignalOffsetCal](#isincludedinsignaloffsetcal) | `bool` |  |
| [SignalOffsetPriority](#signaloffsetpriority) | `int` | The priority of the Route in the Signal Offset Calculation. |
| [SignalOffsetMethod](#signaloffsetmethod) | `int` | The method of this Route for the program calculation of Signal Offsets |
| [SignalOffsetCalMCClass](#signaloffsetcalmcclass) | `int` | Movement Class in this Route for the program calculation of Signal Offsets |
| [Created_date](#created_date) | `DateTime` |  |
| [Created_by](#created_by) | `string` |  |
| [Created_by_company](#created_by_company) | `string` |  |
| [Created_version](#created_version) | `string` |  |
| [Modified_date](#modified_date) | `DateTime` |  |
| [Modified_by](#modified_by) | `string` |  |
| [Modified_by_company](#modified_by_company) | `string` |  |
| [Modified_version](#modified_version) | `string` |  |
| [RouteNwSites](#routenwsites) | [`ISIAPIRouteNwSites`](sidrasolutions.si.api.isiapiroutenwsites.md) | Collection of Network Sites in the Route |
| [Network](#network) | [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md) |  |
| [OutputRoute](#outputroute) | [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md) | Route Output Data, this data structure is same as the OutputNetwork but it is a different set of output data. |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [IsIncludedInProjectSummary](#isincludedinprojectsummary) | `bool` |  |
| [Is_time_distance_reverse_included](#is_time_distance_reverse_included) | `bool` |  |
| [Time_distance_direction](#time_distance_direction) | `int` | Main Route Direction in the Time-Distance Display |
| [RouteMCs](#routemcs) | [`ISIAPIRouteMCs`](sidrasolutions.si.api.isiapiroutemcs.md) |  |
| [ShowSecondaryPlatoons](#showsecondaryplatoons) | `bool` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddRouteNwSite(ISIAPINetworkSite, int, int)](#addroutenwsite-isiapinetworksite--int--int) | [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md) | Add a Network Site to the Route to build the path of the Route. |
| [CheckIsValidForSignalOffsetCalc()](#checkisvalidforsignaloffsetcalc) | `bool` |  |
| [UpdateModifiedInfo()](#updatemodifiedinfo) | `bool` | Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number |
| [Process()](#process) | `bool` | Process this Route. The Network needs to be processed before Route statistics can be calculated. If the Network has not been processed, process the Network. The Routes in the Network will be processed as well. If the Route is created after the Network is processed, call this method to process this Route only. |
| [RemoveRouteNwSite(ISIAPIRouteNwSite)](#removeroutenwsite-isiapiroutenwsite) | `bool` | Remove a Network Site from the Route. The Network Sites that are after this one in the Route will also be removed. |
| [RemoveOutputData()](#removeoutputdata) | `bool` | Remove this Route Output data. |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = route.Name;
        route.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        route->get_Name(&name);
        route->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = route.Name
        route.Name = r"Example"
        ```

### RouteID {#routeid}

```csharp
string RouteID { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string routeID = route.RouteID;
        route.RouteID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR routeID;
        route->get_RouteID(&routeID);
        route->put_RouteID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        route_id = route.RouteID
        route.RouteID = r"id-1"
        ```

### Position {#position}

The Route Position in the Network's Routes collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = route.Position;
        ```

    === "C++"

        ```cpp
        long position;
        route->get_Position(&position);
        ```

    === "Python"

        ```python
        position = route.Position
        ```

### Title {#title}

```csharp
string Title { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string title = route.Title;
        route.Title = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR title;
        route->get_Title(&title);
        route->put_Title(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        title = route.Title
        route.Title = r"value"
        ```

### LOSMethod {#losmethod}

Network Level of Service Method

```csharp
int LOSMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - SIDRA Speed Efficiency
- `2` - HCM 2010 Speed Efficiency
- `3` - HCM 6 Speed Efficiency

???- example "Code samples"

    === "C#"

        ```csharp
        int lOSMethod = route.LOSMethod;
        route.LOSMethod = 0;
        ```

    === "C++"

        ```cpp
        long lOSMethod;
        route->get_LOSMethod(&lOSMethod);
        route->put_LOSMethod(0);
        ```

    === "Python"

        ```python
        los_method = route.LOSMethod
        route.LOSMethod = 0
        ```

### RouteSummaryOption {#routesummaryoption}

Route Summary Output Option

```csharp
int RouteSummaryOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Movements
- `2` - Approaches
- `3` - Sites

???- example "Code samples"

    === "C#"

        ```csharp
        int routeSummaryOption = route.RouteSummaryOption;
        route.RouteSummaryOption = 0;
        ```

    === "C++"

        ```cpp
        long routeSummaryOption;
        route->get_RouteSummaryOption(&routeSummaryOption);
        route->put_RouteSummaryOption(0);
        ```

    === "Python"

        ```python
        route_summary_option = route.RouteSummaryOption
        route.RouteSummaryOption = 0
        ```

### IsIncludedInOutputNetworkByRoutes {#isincludedinoutputnetworkbyroutes}

```csharp
bool IsIncludedInOutputNetworkByRoutes { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInOutputNetworkByRoutes = route.IsIncludedInOutputNetworkByRoutes;
        route.IsIncludedInOutputNetworkByRoutes = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInOutputNetworkByRoutes;
        route->get_IsIncludedInOutputNetworkByRoutes(&isIncludedInOutputNetworkByRoutes);
        route->put_IsIncludedInOutputNetworkByRoutes(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_output_network_by_routes = route.IsIncludedInOutputNetworkByRoutes
        route.IsIncludedInOutputNetworkByRoutes = True
        ```

### IsIncludedInSignalOffsetCal {#isincludedinsignaloffsetcal}

```csharp
bool IsIncludedInSignalOffsetCal { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInSignalOffsetCal = route.IsIncludedInSignalOffsetCal;
        route.IsIncludedInSignalOffsetCal = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInSignalOffsetCal;
        route->get_IsIncludedInSignalOffsetCal(&isIncludedInSignalOffsetCal);
        route->put_IsIncludedInSignalOffsetCal(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_signal_offset_cal = route.IsIncludedInSignalOffsetCal
        route.IsIncludedInSignalOffsetCal = True
        ```

### SignalOffsetPriority {#signaloffsetpriority}

The priority of the Route in the Signal Offset Calculation.

```csharp
int SignalOffsetPriority { get; set; }
```

**Type** `int`

**Remarks**

When Network Signal Offset Option is set to Program, i.e. SIAPINetwork.SignalOffsetOption = 0, the program will use selected Signal valid Routes to calculate the Signals Offsets. 
Call SIAPIRoute.CheckIsValidForSignalOffsetCalc() method to determine if the Route is valid for Signal Offset Calculation. This method will initialise the SignalOffsetPriority value. 
Set SIAPIRoute.IsIncludedInSignalOffsetCal = true to include the Route into the program calculation of Signal Offsets.

If the Route is not valid for the program calculation of Signals Offsets, its SignalOffsetPriority will be larger than 1000 and cannot be changed.

???- example "Code samples"

    === "C#"

        ```csharp
        int signalOffsetPriority = route.SignalOffsetPriority;
        route.SignalOffsetPriority = 0;
        ```

    === "C++"

        ```cpp
        long signalOffsetPriority;
        route->get_SignalOffsetPriority(&signalOffsetPriority);
        route->put_SignalOffsetPriority(0);
        ```

    === "Python"

        ```python
        signal_offset_priority = route.SignalOffsetPriority
        route.SignalOffsetPriority = 0
        ```

### SignalOffsetMethod {#signaloffsetmethod}

The method of this Route for the program calculation of Signal Offsets

```csharp
int SignalOffsetMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Start of Green (Leading)
- `2` - End of Green (Trailing)
- `3` - Middle of Green
- `4` - Simultaneous

???- example "Code samples"

    === "C#"

        ```csharp
        int signalOffsetMethod = route.SignalOffsetMethod;
        route.SignalOffsetMethod = 0;
        ```

    === "C++"

        ```cpp
        long signalOffsetMethod;
        route->get_SignalOffsetMethod(&signalOffsetMethod);
        route->put_SignalOffsetMethod(0);
        ```

    === "Python"

        ```python
        signal_offset_method = route.SignalOffsetMethod
        route.SignalOffsetMethod = 0
        ```

### SignalOffsetCalMCClass {#signaloffsetcalmcclass}

Movement Class in this Route for the program calculation of Signal Offsets

```csharp
int SignalOffsetCalMCClass { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int signalOffsetCalMCClass = route.SignalOffsetCalMCClass;
        route.SignalOffsetCalMCClass = 0;
        ```

    === "C++"

        ```cpp
        long signalOffsetCalMCClass;
        route->get_SignalOffsetCalMCClass(&signalOffsetCalMCClass);
        route->put_SignalOffsetCalMCClass(0);
        ```

    === "Python"

        ```python
        signal_offset_cal_mc_class = route.SignalOffsetCalMCClass
        route.SignalOffsetCalMCClass = 0
        ```

### Created_date {#created_date}

```csharp
DateTime Created_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var created_date = route.Created_date;
        ```

    === "C++"

        ```cpp
        VARIANT created_date;
        route->get_Created_date(&created_date);
        ```

    === "Python"

        ```python
        created_date = route.Created_date
        ```

### Created_by {#created_by}

```csharp
string Created_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by = route.Created_by;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by;
        route->get_Created_by(&created_by);
        ```

    === "Python"

        ```python
        created_by = route.Created_by
        ```

### Created_by_company {#created_by_company}

```csharp
string Created_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by_company = route.Created_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by_company;
        route->get_Created_by_company(&created_by_company);
        ```

    === "Python"

        ```python
        created_by_company = route.Created_by_company
        ```

### Created_version {#created_version}

```csharp
string Created_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_version = route.Created_version;
        ```

    === "C++"

        ```cpp
        CComBSTR created_version;
        route->get_Created_version(&created_version);
        ```

    === "Python"

        ```python
        created_version = route.Created_version
        ```

### Modified_date {#modified_date}

```csharp
DateTime Modified_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var modified_date = route.Modified_date;
        ```

    === "C++"

        ```cpp
        VARIANT modified_date;
        route->get_Modified_date(&modified_date);
        ```

    === "Python"

        ```python
        modified_date = route.Modified_date
        ```

### Modified_by {#modified_by}

```csharp
string Modified_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by = route.Modified_by;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by;
        route->get_Modified_by(&modified_by);
        ```

    === "Python"

        ```python
        modified_by = route.Modified_by
        ```

### Modified_by_company {#modified_by_company}

```csharp
string Modified_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by_company = route.Modified_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by_company;
        route->get_Modified_by_company(&modified_by_company);
        ```

    === "Python"

        ```python
        modified_by_company = route.Modified_by_company
        ```

### Modified_version {#modified_version}

```csharp
string Modified_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_version = route.Modified_version;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_version;
        route->get_Modified_version(&modified_version);
        ```

    === "Python"

        ```python
        modified_version = route.Modified_version
        ```

### RouteNwSites {#routenwsites}

Collection of Network Sites in the Route

```csharp
ISIAPIRouteNwSites RouteNwSites { get; }
```

**Type** [`ISIAPIRouteNwSites`](sidrasolutions.si.api.isiapiroutenwsites.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var routeNwSites = route.RouteNwSites;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteNwSites> routeNwSites;
        route->get_RouteNwSites(&routeNwSites);
        ```

    === "Python"

        ```python
        route_nw_sites = route.RouteNwSites
        ```

### Network {#network}

```csharp
ISIAPINetwork Network { get; }
```

**Type** [`ISIAPINetwork`](sidrasolutions.si.api.isiapinetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var network = route.Network;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetwork> network;
        route->get_Network(&network);
        ```

    === "Python"

        ```python
        network = route.Network
        ```

### OutputRoute {#outputroute}

Route Output Data, this data structure is same as the OutputNetwork but it is a different set of output data.

```csharp
ISIAPIOutputNetwork OutputRoute { get; }
```

**Type** [`ISIAPIOutputNetwork`](sidrasolutions.si.api.isiapioutputnetwork.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputRoute = route.OutputRoute;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputNetwork> outputRoute;
        route->get_OutputRoute(&outputRoute);
        ```

    === "Python"

        ```python
        output_route = route.OutputRoute
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = route.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        route->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = route.LastErrorMessage
        ```

### IsIncludedInProjectSummary {#isincludedinprojectsummary}

```csharp
bool IsIncludedInProjectSummary { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInProjectSummary = route.IsIncludedInProjectSummary;
        route.IsIncludedInProjectSummary = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInProjectSummary;
        route->get_IsIncludedInProjectSummary(&isIncludedInProjectSummary);
        route->put_IsIncludedInProjectSummary(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_project_summary = route.IsIncludedInProjectSummary
        route.IsIncludedInProjectSummary = True
        ```

### Is_time_distance_reverse_included {#is_time_distance_reverse_included}

```csharp
bool Is_time_distance_reverse_included { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_time_distance_reverse_included = route.Is_time_distance_reverse_included;
        route.Is_time_distance_reverse_included = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_time_distance_reverse_included;
        route->get_Is_time_distance_reverse_included(&is_time_distance_reverse_included);
        route->put_Is_time_distance_reverse_included(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_time_distance_reverse_included = route.Is_time_distance_reverse_included
        route.Is_time_distance_reverse_included = True
        ```

### Time_distance_direction {#time_distance_direction}

Main Route Direction in the Time-Distance Display

```csharp
int Time_distance_direction { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Up (Vertical)
- `1` - Down (Vertical)
- `2` - Left to Right (Horizontal)
- `3` - Right to Left (Horizontal)

???- example "Code samples"

    === "C#"

        ```csharp
        int time_distance_direction = route.Time_distance_direction;
        route.Time_distance_direction = 0;
        ```

    === "C++"

        ```cpp
        long time_distance_direction;
        route->get_Time_distance_direction(&time_distance_direction);
        route->put_Time_distance_direction(0);
        ```

    === "Python"

        ```python
        time_distance_direction = route.Time_distance_direction
        route.Time_distance_direction = 0
        ```

### RouteMCs {#routemcs}

```csharp
ISIAPIRouteMCs RouteMCs { get; }
```

**Type** [`ISIAPIRouteMCs`](sidrasolutions.si.api.isiapiroutemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var routeMCs = route.RouteMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteMCs> routeMCs;
        route->get_RouteMCs(&routeMCs);
        ```

    === "Python"

        ```python
        route_m_cs = route.RouteMCs
        ```

### ShowSecondaryPlatoons {#showsecondaryplatoons}

```csharp
bool ShowSecondaryPlatoons { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool showSecondaryPlatoons = route.ShowSecondaryPlatoons;
        route.ShowSecondaryPlatoons = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL showSecondaryPlatoons;
        route->get_ShowSecondaryPlatoons(&showSecondaryPlatoons);
        route->put_ShowSecondaryPlatoons(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        show_secondary_platoons = route.ShowSecondaryPlatoons
        route.ShowSecondaryPlatoons = True
        ```

## Methods

### AddRouteNwSite(ISIAPINetworkSite, int, int) {#addroutenwsite-isiapinetworksite--int--int}

Add a Network Site to the Route to build the path of the Route.

```csharp
ISIAPIRouteNwSite AddRouteNwSite(ISIAPINetworkSite networkSite, int origin, int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `networkSite` | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) | The Network Site to add into the Route |
| `origin` | `int` | The origin of the vehicle movement on the Network Site that will be added into the Route |
| `destination` | `int` | The destination of the vehicle movement on the Network Site that will be added into the Route |

**Returns** [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md) - A new added Route Network Site

???- example "Code samples"

    === "C#"

        ```csharp
        var result = route.AddRouteNwSite(null, 0, 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteNwSite> result;
        route->AddRouteNwSite(NULL, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = route.AddRouteNwSite(None, 0, 0)
        ```

### CheckIsValidForSignalOffsetCalc() {#checkisvalidforsignaloffsetcalc}

```csharp
bool CheckIsValidForSignalOffsetCalc()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = route.CheckIsValidForSignalOffsetCalc();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        route->CheckIsValidForSignalOffsetCalc(&result);
        ```

    === "Python"

        ```python
        result = route.CheckIsValidForSignalOffsetCalc()
        ```

### UpdateModifiedInfo() {#updatemodifiedinfo}

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

```csharp
bool UpdateModifiedInfo()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = route.UpdateModifiedInfo();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        route->UpdateModifiedInfo(&result);
        ```

    === "Python"

        ```python
        result = route.UpdateModifiedInfo()
        ```

### Process() {#process}

Process this Route. The Network needs to be processed before Route statistics can be calculated. 
If the Network has not been processed, process the Network. The Routes in the Network will be processed as well. 
If the Route is created after the Network is processed, call this method to process this Route only.

```csharp
bool Process()
```

**Returns** `bool` - true if this Route is processed successfully.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = route.Process();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        route->Process(&result);
        ```

    === "Python"

        ```python
        result = route.Process()
        ```

### RemoveRouteNwSite(ISIAPIRouteNwSite) {#removeroutenwsite-isiapiroutenwsite}

Remove a Network Site from the Route. The Network Sites that are after this one in the Route will also be removed.

```csharp
bool RemoveRouteNwSite(ISIAPIRouteNwSite routeNwSite)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `routeNwSite` | [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md) | The Network Site to remove. |

**Returns** `bool` - true if the Network Site is successfully removed; otherwise, false. This method also returns false if the Network Site does not exist in this Route.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = route.RemoveRouteNwSite(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        route->RemoveRouteNwSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = route.RemoveRouteNwSite(None)
        ```

### RemoveOutputData() {#removeoutputdata}

Remove this Route Output data.

```csharp
bool RemoveOutputData()
```

**Returns** `bool` - true if the Output data are successfully removed

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = route.RemoveOutputData();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        route->RemoveOutputData(&result);
        ```

    === "Python"

        ```python
        result = route.RemoveOutputData()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroutemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRouteMC
title: RouteMC
name: ISIAPIRouteMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 562A8D97-07F0-4160-ABA4-50241723E32F
members:
  - int MC_class
  - int DesiredSpeedMethod
  - float DesiredSpeed
  - float LowerLimitOfSpeedEfficiency
  - ISIAPIRoute Route
---

# RouteMC

Type `ISIAPIRouteMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `562A8D97-07F0-4160-ABA4-50241723E32F`

## Declaration

```csharp
[Guid("562A8D97-07F0-4160-ABA4-50241723E32F")]
public interface ISIAPIRouteMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MC_class](#mc_class) | `int` | Movement Class Number |
| [DesiredSpeedMethod](#desiredspeedmethod) | `int` | Desired Speed Method or Option |
| [DesiredSpeed](#desiredspeed) | `float` |  |
| [LowerLimitOfSpeedEfficiency](#lowerlimitofspeedefficiency) | `float` |  |
| [Route](#route) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) |  |

</div>

## Properties

### MC_class {#mc_class}

Movement Class Number

```csharp
int MC_class { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mC_class = routeMC.MC_class;
        ```

    === "C++"

        ```cpp
        long mC_class;
        routeMC->get_MC_class(&mC_class);
        ```

    === "Python"

        ```python
        mc_class = routeMC.MC_class
        ```

### DesiredSpeedMethod {#desiredspeedmethod}

Desired Speed Method or Option

```csharp
int DesiredSpeedMethod { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - User Input
- `1` - Program

???- example "Code samples"

    === "C#"

        ```csharp
        int desiredSpeedMethod = routeMC.DesiredSpeedMethod;
        routeMC.DesiredSpeedMethod = 0;
        ```

    === "C++"

        ```cpp
        long desiredSpeedMethod;
        routeMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
        routeMC->put_DesiredSpeedMethod(0);
        ```

    === "Python"

        ```python
        desired_speed_method = routeMC.DesiredSpeedMethod
        routeMC.DesiredSpeedMethod = 0
        ```

### DesiredSpeed {#desiredspeed}

```csharp
float DesiredSpeed { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float desiredSpeed = routeMC.DesiredSpeed;
        routeMC.DesiredSpeed = 0.0;
        ```

    === "C++"

        ```cpp
        double desiredSpeed;
        routeMC->get_DesiredSpeed(&desiredSpeed);
        routeMC->put_DesiredSpeed(0.0);
        ```

    === "Python"

        ```python
        desired_speed = routeMC.DesiredSpeed
        routeMC.DesiredSpeed = 0.0
        ```

### LowerLimitOfSpeedEfficiency {#lowerlimitofspeedefficiency}

```csharp
float LowerLimitOfSpeedEfficiency { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lowerLimitOfSpeedEfficiency = routeMC.LowerLimitOfSpeedEfficiency;
        routeMC.LowerLimitOfSpeedEfficiency = 0.0;
        ```

    === "C++"

        ```cpp
        double lowerLimitOfSpeedEfficiency;
        routeMC->get_LowerLimitOfSpeedEfficiency(&lowerLimitOfSpeedEfficiency);
        routeMC->put_LowerLimitOfSpeedEfficiency(0.0);
        ```

    === "Python"

        ```python
        lower_limit_of_speed_efficiency = routeMC.LowerLimitOfSpeedEfficiency
        routeMC.LowerLimitOfSpeedEfficiency = 0.0
        ```

### Route {#route}

```csharp
ISIAPIRoute Route { get; }
```

**Type** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var route = routeMC.Route;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> route;
        routeMC->get_Route(&route);
        ```

    === "Python"

        ```python
        route = routeMC.Route
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroutemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRouteMCs
title: RouteMCs
name: ISIAPIRouteMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 5F3473D7-7148-42C3-ACF2-D05D43B4F689
members:
  - ISIAPIRouteMC this[int mcClass]
  - int Count
---

# RouteMCs

Type `ISIAPIRouteMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `5F3473D7-7148-42C3-ACF2-D05D43B4F689`

## Declaration

```csharp
[Guid("5F3473D7-7148-42C3-ACF2-D05D43B4F689")]
public interface ISIAPIRouteMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIRouteMC`](sidrasolutions.si.api.isiapiroutemc.md) |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = routeMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        routeMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = routeMCs.Count
        ```

### this[] {#this}

```csharp
ISIAPIRouteMC this[] { get; }
```

**Type** [`ISIAPIRouteMC`](sidrasolutions.si.api.isiapiroutemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = routeMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteMC> this[];
        routeMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = routeMCs.this[]
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroutenwsite.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRouteNwSite
title: RouteNwSite
name: ISIAPIRouteNwSite
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2F4ADE50-2FAB-46E9-A73D-205CCDEEAB93
members:
  - string SiteName
  - int Position
  - int Origin
  - int Destination
  - ISIAPIRoute Route
  - ISIAPINetworkSite NetworkSite
---

# RouteNwSite

Type `ISIAPIRouteNwSite` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2F4ADE50-2FAB-46E9-A73D-205CCDEEAB93`

## Declaration

```csharp
[Guid("2F4ADE50-2FAB-46E9-A73D-205CCDEEAB93")]
public interface ISIAPIRouteNwSite
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [SiteName](#sitename) | `string` |  |
| [Position](#position) | `int` | The RouteNwSite position in the Route. It is a zero-base integer. |
| [Origin](#origin) | `int` |  |
| [Destination](#destination) | `int` |  |
| [Route](#route) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) |  |
| [NetworkSite](#networksite) | [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md) |  |

</div>

## Properties

### SiteName {#sitename}

```csharp
string SiteName { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string siteName = routeNwSite.SiteName;
        ```

    === "C++"

        ```cpp
        CComBSTR siteName;
        routeNwSite->get_SiteName(&siteName);
        ```

    === "Python"

        ```python
        site_name = routeNwSite.SiteName
        ```

### Position {#position}

The RouteNwSite position in the Route. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = routeNwSite.Position;
        ```

    === "C++"

        ```cpp
        long position;
        routeNwSite->get_Position(&position);
        ```

    === "Python"

        ```python
        position = routeNwSite.Position
        ```

### Origin {#origin}

```csharp
int Origin { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = routeNwSite.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        routeNwSite->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = routeNwSite.Origin
        ```

### Destination {#destination}

```csharp
int Destination { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = routeNwSite.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        routeNwSite->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = routeNwSite.Destination
        ```

### Route {#route}

```csharp
ISIAPIRoute Route { get; }
```

**Type** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var route = routeNwSite.Route;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> route;
        routeNwSite->get_Route(&route);
        ```

    === "Python"

        ```python
        route = routeNwSite.Route
        ```

### NetworkSite {#networksite}

```csharp
ISIAPINetworkSite NetworkSite { get; }
```

**Type** [`ISIAPINetworkSite`](sidrasolutions.si.api.isiapinetworksite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var networkSite = routeNwSite.NetworkSite;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPINetworkSite> networkSite;
        routeNwSite->get_NetworkSite(&networkSite);
        ```

    === "Python"

        ```python
        network_site = routeNwSite.NetworkSite
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroutenwsites.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRouteNwSites
title: RouteNwSites
name: ISIAPIRouteNwSites
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8019B17F-8F56-4C6A-9EE7-4654EC7288C1
members:
  - bool RouteNwSiteExists(string sitename)
  - ISIAPIRouteNwSite this[string sitename]
  - ISIAPIRouteNwSite this[int index]
  - int Count
---

# RouteNwSites

Type `ISIAPIRouteNwSites` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8019B17F-8F56-4C6A-9EE7-4654EC7288C1`

## Declaration

```csharp
[Guid("8019B17F-8F56-4C6A-9EE7-4654EC7288C1")]
public interface ISIAPIRouteNwSites
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md) |  |
| [this[]](#this) | [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [RouteNwSiteExists(string)](#routenwsiteexists-string) | `bool` | Queries whether a particular Route Network Site exists in the collection |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = routeNwSites.Count;
        ```

    === "C++"

        ```cpp
        long count;
        routeNwSites->get_Count(&count);
        ```

    === "Python"

        ```python
        count = routeNwSites.Count
        ```

### this[] {#this}

```csharp
ISIAPIRouteNwSite this[] { get; }
```

**Type** [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = routeNwSites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteNwSite> this[];
        routeNwSites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = routeNwSites.this[]
        ```

### this[] {#this}

```csharp
ISIAPIRouteNwSite this[] { get; }
```

**Type** [`ISIAPIRouteNwSite`](sidrasolutions.si.api.isiapiroutenwsite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = routeNwSites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRouteNwSite> this[];
        routeNwSites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = routeNwSites.this[]
        ```

## Methods

### RouteNwSiteExists(string) {#routenwsiteexists-string}

Queries whether a particular Route Network Site exists in the collection

```csharp
bool RouteNwSiteExists(string sitename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sitename` | `string` | Site name to query |

**Returns** `bool` - True, if a Route Network Site with the given Site name exists in the collection. False otherwise

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = routeNwSites.RouteNwSiteExists(@"Main Intersection");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        routeNwSites->RouteNwSiteExists(CComBSTR(L"Main Intersection"), &result);
        ```

    === "Python"

        ```python
        result = routeNwSites.RouteNwSiteExists(r"Main Intersection")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapiroutes.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPIRoutes
title: Routes
name: ISIAPIRoutes
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B4E925F0-B40E-4706-AFDF-C4B16C8AA89F
members:
  - bool RouteExists(string routeName)
  - ISIAPIRoute this[string routeName]
  - ISIAPIRoute this[int index]
  - int Count
---

# Routes

Type `ISIAPIRoutes` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B4E925F0-B40E-4706-AFDF-C4B16C8AA89F`

## Declaration

```csharp
[Guid("B4E925F0-B40E-4706-AFDF-C4B16C8AA89F")]
public interface ISIAPIRoutes
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) |  |
| [this[]](#this) | [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [RouteExists(string)](#routeexists-string) | `bool` | Queries whether a particular Route exists in the collection |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = routes.Count;
        ```

    === "C++"

        ```cpp
        long count;
        routes->get_Count(&count);
        ```

    === "Python"

        ```python
        count = routes.Count
        ```

### this[] {#this}

```csharp
ISIAPIRoute this[] { get; }
```

**Type** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = routes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> this[];
        routes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = routes.this[]
        ```

### this[] {#this}

```csharp
ISIAPIRoute this[] { get; }
```

**Type** [`ISIAPIRoute`](sidrasolutions.si.api.isiapiroute.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = routes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIRoute> this[];
        routes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = routes.this[]
        ```

## Methods

### RouteExists(string) {#routeexists-string}

Queries whether a particular Route exists in the collection

```csharp
bool RouteExists(string routeName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `routeName` | `string` | Route name to query |

**Returns** `bool` - True, if a Route with the given name exists in the collection. False otherwise

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = routes.RouteExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        routes->RouteExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = routes.RouteExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisensitivity.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISensitivity
title: Sensitivity
name: ISIAPISensitivity
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 9A3A1922-E8D3-41D2-82DB-0CF119851325
members:
  - int Groupno
  - int Selected_parameter
  - float Lower
  - float Upper
  - float Increment
  - bool Is_constant_factor_applied
  - float Constant_factor
---

# Sensitivity

Type `ISIAPISensitivity` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `9A3A1922-E8D3-41D2-82DB-0CF119851325`

## Declaration

```csharp
[Guid("9A3A1922-E8D3-41D2-82DB-0CF119851325")]
public interface ISIAPISensitivity
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Groupno](#groupno) | `int` | Sensitivity Parameter Group Number |
| [Selected_parameter](#selected_parameter) | `int` | Selected Sensitivity Parameter |
| [Lower](#lower) | `float` |  |
| [Upper](#upper) | `float` |  |
| [Increment](#increment) | `float` |  |
| [Is_constant_factor_applied](#is_constant_factor_applied) | `bool` |  |
| [Constant_factor](#constant_factor) | `float` |  |

</div>

## Properties

### Groupno {#groupno}

Sensitivity Parameter Group Number

```csharp
int Groupno { get; }
```

**Type** `int`

**Value**

One of:

- `0` - General Parameter Group
- `1` - Roundabout Parameter Group

???- example "Code samples"

    === "C#"

        ```csharp
        int groupno = sensitivity.Groupno;
        ```

    === "C++"

        ```cpp
        long groupno;
        sensitivity->get_Groupno(&groupno);
        ```

    === "Python"

        ```python
        groupno = sensitivity.Groupno
        ```

### Selected_parameter {#selected_parameter}

Selected Sensitivity Parameter

```csharp
int Selected_parameter { get; set; }
```

**Type** `int`

**Value**

One of:

- `1` - Critical Gap Follow-up Headway
- `2` - Basic Saturation Flow
- `3` - Lane Width
- `4` - Lane Utilisation Ratio
- `5` - Cruise Speed
- `6` - Vehicle Queue Space
- `7` - Inscribed Diameter
- `8` - Entry Angle
- `9` - Entry Radius

**Remarks**

Values 1 - 6 are only available in General Parameter Group (Group No. = 0). Values 7 - 9 are only available in Roundabout Parameter Group (Group No. = 1)

???- example "Code samples"

    === "C#"

        ```csharp
        int selected_parameter = sensitivity.Selected_parameter;
        sensitivity.Selected_parameter = 0;
        ```

    === "C++"

        ```cpp
        long selected_parameter;
        sensitivity->get_Selected_parameter(&selected_parameter);
        sensitivity->put_Selected_parameter(0);
        ```

    === "Python"

        ```python
        selected_parameter = sensitivity.Selected_parameter
        sensitivity.Selected_parameter = 0
        ```

### Lower {#lower}

```csharp
float Lower { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float lower = sensitivity.Lower;
        sensitivity.Lower = 0.0;
        ```

    === "C++"

        ```cpp
        double lower;
        sensitivity->get_Lower(&lower);
        sensitivity->put_Lower(0.0);
        ```

    === "Python"

        ```python
        lower = sensitivity.Lower
        sensitivity.Lower = 0.0
        ```

### Upper {#upper}

```csharp
float Upper { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float upper = sensitivity.Upper;
        sensitivity.Upper = 0.0;
        ```

    === "C++"

        ```cpp
        double upper;
        sensitivity->get_Upper(&upper);
        sensitivity->put_Upper(0.0);
        ```

    === "Python"

        ```python
        upper = sensitivity.Upper
        sensitivity.Upper = 0.0
        ```

### Increment {#increment}

```csharp
float Increment { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float increment = sensitivity.Increment;
        sensitivity.Increment = 0.0;
        ```

    === "C++"

        ```cpp
        double increment;
        sensitivity->get_Increment(&increment);
        sensitivity->put_Increment(0.0);
        ```

    === "Python"

        ```python
        increment = sensitivity.Increment
        sensitivity.Increment = 0.0
        ```

### Is_constant_factor_applied {#is_constant_factor_applied}

```csharp
bool Is_constant_factor_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_constant_factor_applied = sensitivity.Is_constant_factor_applied;
        sensitivity.Is_constant_factor_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_constant_factor_applied;
        sensitivity->get_Is_constant_factor_applied(&is_constant_factor_applied);
        sensitivity->put_Is_constant_factor_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_constant_factor_applied = sensitivity.Is_constant_factor_applied
        sensitivity.Is_constant_factor_applied = True
        ```

### Constant_factor {#constant_factor}

```csharp
float Constant_factor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float constant_factor = sensitivity.Constant_factor;
        sensitivity.Constant_factor = 0.0;
        ```

    === "C++"

        ```cpp
        double constant_factor;
        sensitivity->get_Constant_factor(&constant_factor);
        sensitivity->put_Constant_factor(0.0);
        ```

    === "Python"

        ```python
        constant_factor = sensitivity.Constant_factor
        sensitivity.Constant_factor = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisequence.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISequence
title: Sequence
name: ISIAPISequence
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 3BE91ECF-5A7F-4DA5-8F7F-72C9E2320809
members:
  - ISIAPIPhase AddPhase(string name)
  - bool RemovePhase(ISIAPIPhase phase)
  - ISIAPIPhase InsertPhase(int position, string name)
  - ISIAPIPhase ClonePhase(ISIAPIPhase phase)
  - bool MovePhaseTo(ISIAPIPhase phase, int newPosition)
  - string Name
  - int Position
  - bool Is_selected
  - int Cycle_time_option
  - float Practical_max_cycle_time
  - bool Practical_cycle_rounding_applied
  - int Practical_cycle_rounding
  - bool Optimum_cycle_time_lower_user
  - int Optimum_cycle_time_lower
  - int Optimum_cycle_time_upper
  - int Optimum_cycle_time_increment
  - int Optimum_cycle_time_perf_measure
  - int Optimum_cycle_time_optim_method
  - int Optimum_max_green_percent_lower
  - int Optimum_max_green_percent_upper
  - int Optimum_max_green_percent_increment
  - int Optimum_max_green_perf_measure
  - int Optimum_max_green_optim_method
  - int Variable_phasing_perf_measure
  - float Usergiven_cycle_time
  - int Green_split_priority_option
  - float Actuated_max_green_major_mov
  - float Actuated_max_green_minor_mov
  - float Actuated_gap_major_mov
  - float Actuated_gap_minor_mov
  - float Eff_det_zone_len_major_mov
  - float Eff_det_zone_len_minor_mov
  - ISIAPISite Site
  - ISIAPIPhases Phases
  - string LastErrorMessage
  - int Lane_blockage_effect_option
  - bool Is_timing_optimised_for_selected_result
---

# Sequence

Type `ISIAPISequence` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `3BE91ECF-5A7F-4DA5-8F7F-72C9E2320809`

## Declaration

```csharp
[Guid("3BE91ECF-5A7F-4DA5-8F7F-72C9E2320809")]
public interface ISIAPISequence
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` |  |
| [Position](#position) | `int` | The Sequence Position in the Site's Sequences collection. It is a zero-base integer. |
| [Is_selected](#is_selected) | `bool` | Get or Set this Sequence is selected for analysis. More than one Sequence can be selected for analysis. |
| [Cycle_time_option](#cycle_time_option) | `int` | Cycle Time Option |
| [Practical_max_cycle_time](#practical_max_cycle_time) | `float` |  |
| [Practical_cycle_rounding_applied](#practical_cycle_rounding_applied) | `bool` |  |
| [Practical_cycle_rounding](#practical_cycle_rounding) | `int` |  |
| [Optimum_cycle_time_lower_user](#optimum_cycle_time_lower_user) | `bool` |  |
| [Optimum_cycle_time_lower](#optimum_cycle_time_lower) | `int` |  |
| [Optimum_cycle_time_upper](#optimum_cycle_time_upper) | `int` |  |
| [Optimum_cycle_time_increment](#optimum_cycle_time_increment) | `int` |  |
| [Optimum_cycle_time_perf_measure](#optimum_cycle_time_perf_measure) | `int` |  |
| [Optimum_cycle_time_optim_method](#optimum_cycle_time_optim_method) | `int` |  |
| [Optimum_max_green_percent_lower](#optimum_max_green_percent_lower) | `int` |  |
| [Optimum_max_green_percent_upper](#optimum_max_green_percent_upper) | `int` |  |
| [Optimum_max_green_percent_increment](#optimum_max_green_percent_increment) | `int` |  |
| [Optimum_max_green_perf_measure](#optimum_max_green_perf_measure) | `int` |  |
| [Optimum_max_green_optim_method](#optimum_max_green_optim_method) | `int` |  |
| [Variable_phasing_perf_measure](#variable_phasing_perf_measure) | `int` |  |
| [Usergiven_cycle_time](#usergiven_cycle_time) | `float` |  |
| [Green_split_priority_option](#green_split_priority_option) | `int` | Green Split Priority |
| [Actuated_max_green_major_mov](#actuated_max_green_major_mov) | `float` |  |
| [Actuated_max_green_minor_mov](#actuated_max_green_minor_mov) | `float` |  |
| [Actuated_gap_major_mov](#actuated_gap_major_mov) | `float` |  |
| [Actuated_gap_minor_mov](#actuated_gap_minor_mov) | `float` |  |
| [Eff_det_zone_len_major_mov](#eff_det_zone_len_major_mov) | `float` |  |
| [Eff_det_zone_len_minor_mov](#eff_det_zone_len_minor_mov) | `float` |  |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [Phases](#phases) | [`ISIAPIPhases`](sidrasolutions.si.api.isiapiphases.md) |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [Lane_blockage_effect_option](#lane_blockage_effect_option) | `int` | Lane Blockage Effect Option: In Network analysis, include Lane Blockage effects in determining Phase Times. |
| [Is_timing_optimised_for_selected_result](#is_timing_optimised_for_selected_result) | `bool` |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddPhase(string)](#addphase-string) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | Add a new Phase to the end of this Sequence. |
| [RemovePhase(ISIAPIPhase)](#removephase-isiapiphase) | `bool` | Remove a Phase from this Sequence. |
| [InsertPhase(int, string)](#insertphase-int--string) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | Insert a new Phase into this Sequence at the specified position. |
| [ClonePhase(ISIAPIPhase)](#clonephase-isiapiphase) | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | Clone a Phase. |
| [MovePhaseTo(ISIAPIPhase, int)](#movephaseto-isiapiphase--int) | `bool` | Move a Phase to a new position. |

</div>

## Properties

### Name {#name}

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = sequence.Name;
        sequence.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        sequence->get_Name(&name);
        sequence->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = sequence.Name
        sequence.Name = r"Example"
        ```

### Position {#position}

The Sequence Position in the Site's Sequences collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = sequence.Position;
        ```

    === "C++"

        ```cpp
        long position;
        sequence->get_Position(&position);
        ```

    === "Python"

        ```python
        position = sequence.Position
        ```

### Is_selected {#is_selected}

Get or Set this Sequence is selected for analysis.  
More than one Sequence can be selected for analysis.

```csharp
bool Is_selected { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_selected = sequence.Is_selected;
        sequence.Is_selected = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_selected;
        sequence->get_Is_selected(&is_selected);
        sequence->put_Is_selected(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_selected = sequence.Is_selected
        sequence.Is_selected = True
        ```

### Cycle_time_option {#cycle_time_option}

Cycle Time Option

```csharp
int Cycle_time_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Practical Cycle Time
- `1` - Optimum Cycle Time
- `2` - User-Given Cycle Time
- `3` - User-Given Phase Time
- `4` - Optimum Maximum Green Settings

???- example "Code samples"

    === "C#"

        ```csharp
        int cycle_time_option = sequence.Cycle_time_option;
        sequence.Cycle_time_option = 0;
        ```

    === "C++"

        ```cpp
        long cycle_time_option;
        sequence->get_Cycle_time_option(&cycle_time_option);
        sequence->put_Cycle_time_option(0);
        ```

    === "Python"

        ```python
        cycle_time_option = sequence.Cycle_time_option
        sequence.Cycle_time_option = 0
        ```

### Practical_max_cycle_time {#practical_max_cycle_time}

```csharp
float Practical_max_cycle_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float practical_max_cycle_time = sequence.Practical_max_cycle_time;
        sequence.Practical_max_cycle_time = 0.0;
        ```

    === "C++"

        ```cpp
        double practical_max_cycle_time;
        sequence->get_Practical_max_cycle_time(&practical_max_cycle_time);
        sequence->put_Practical_max_cycle_time(0.0);
        ```

    === "Python"

        ```python
        practical_max_cycle_time = sequence.Practical_max_cycle_time
        sequence.Practical_max_cycle_time = 0.0
        ```

### Practical_cycle_rounding_applied {#practical_cycle_rounding_applied}

```csharp
bool Practical_cycle_rounding_applied { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool practical_cycle_rounding_applied = sequence.Practical_cycle_rounding_applied;
        sequence.Practical_cycle_rounding_applied = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL practical_cycle_rounding_applied;
        sequence->get_Practical_cycle_rounding_applied(&practical_cycle_rounding_applied);
        sequence->put_Practical_cycle_rounding_applied(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        practical_cycle_rounding_applied = sequence.Practical_cycle_rounding_applied
        sequence.Practical_cycle_rounding_applied = True
        ```

### Practical_cycle_rounding {#practical_cycle_rounding}

```csharp
int Practical_cycle_rounding { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int practical_cycle_rounding = sequence.Practical_cycle_rounding;
        sequence.Practical_cycle_rounding = 0;
        ```

    === "C++"

        ```cpp
        long practical_cycle_rounding;
        sequence->get_Practical_cycle_rounding(&practical_cycle_rounding);
        sequence->put_Practical_cycle_rounding(0);
        ```

    === "Python"

        ```python
        practical_cycle_rounding = sequence.Practical_cycle_rounding
        sequence.Practical_cycle_rounding = 0
        ```

### Optimum_cycle_time_lower_user {#optimum_cycle_time_lower_user}

```csharp
bool Optimum_cycle_time_lower_user { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool optimum_cycle_time_lower_user = sequence.Optimum_cycle_time_lower_user;
        sequence.Optimum_cycle_time_lower_user = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL optimum_cycle_time_lower_user;
        sequence->get_Optimum_cycle_time_lower_user(&optimum_cycle_time_lower_user);
        sequence->put_Optimum_cycle_time_lower_user(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower_user = sequence.Optimum_cycle_time_lower_user
        sequence.Optimum_cycle_time_lower_user = True
        ```

### Optimum_cycle_time_lower {#optimum_cycle_time_lower}

```csharp
int Optimum_cycle_time_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_lower = sequence.Optimum_cycle_time_lower;
        sequence.Optimum_cycle_time_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_lower;
        sequence->get_Optimum_cycle_time_lower(&optimum_cycle_time_lower);
        sequence->put_Optimum_cycle_time_lower(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_lower = sequence.Optimum_cycle_time_lower
        sequence.Optimum_cycle_time_lower = 0
        ```

### Optimum_cycle_time_upper {#optimum_cycle_time_upper}

```csharp
int Optimum_cycle_time_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_upper = sequence.Optimum_cycle_time_upper;
        sequence.Optimum_cycle_time_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_upper;
        sequence->get_Optimum_cycle_time_upper(&optimum_cycle_time_upper);
        sequence->put_Optimum_cycle_time_upper(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_upper = sequence.Optimum_cycle_time_upper
        sequence.Optimum_cycle_time_upper = 0
        ```

### Optimum_cycle_time_increment {#optimum_cycle_time_increment}

```csharp
int Optimum_cycle_time_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_increment = sequence.Optimum_cycle_time_increment;
        sequence.Optimum_cycle_time_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_increment;
        sequence->get_Optimum_cycle_time_increment(&optimum_cycle_time_increment);
        sequence->put_Optimum_cycle_time_increment(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_increment = sequence.Optimum_cycle_time_increment
        sequence.Optimum_cycle_time_increment = 0
        ```

### Optimum_cycle_time_perf_measure {#optimum_cycle_time_perf_measure}

```csharp
int Optimum_cycle_time_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_perf_measure = sequence.Optimum_cycle_time_perf_measure;
        sequence.Optimum_cycle_time_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_perf_measure;
        sequence->get_Optimum_cycle_time_perf_measure(&optimum_cycle_time_perf_measure);
        sequence->put_Optimum_cycle_time_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_perf_measure = sequence.Optimum_cycle_time_perf_measure
        sequence.Optimum_cycle_time_perf_measure = 0
        ```

### Optimum_cycle_time_optim_method {#optimum_cycle_time_optim_method}

```csharp
int Optimum_cycle_time_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_cycle_time_optim_method = sequence.Optimum_cycle_time_optim_method;
        sequence.Optimum_cycle_time_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_cycle_time_optim_method;
        sequence->get_Optimum_cycle_time_optim_method(&optimum_cycle_time_optim_method);
        sequence->put_Optimum_cycle_time_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_cycle_time_optim_method = sequence.Optimum_cycle_time_optim_method
        sequence.Optimum_cycle_time_optim_method = 0
        ```

### Optimum_max_green_percent_lower {#optimum_max_green_percent_lower}

```csharp
int Optimum_max_green_percent_lower { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_lower = sequence.Optimum_max_green_percent_lower;
        sequence.Optimum_max_green_percent_lower = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_lower;
        sequence->get_Optimum_max_green_percent_lower(&optimum_max_green_percent_lower);
        sequence->put_Optimum_max_green_percent_lower(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_lower = sequence.Optimum_max_green_percent_lower
        sequence.Optimum_max_green_percent_lower = 0
        ```

### Optimum_max_green_percent_upper {#optimum_max_green_percent_upper}

```csharp
int Optimum_max_green_percent_upper { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_upper = sequence.Optimum_max_green_percent_upper;
        sequence.Optimum_max_green_percent_upper = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_upper;
        sequence->get_Optimum_max_green_percent_upper(&optimum_max_green_percent_upper);
        sequence->put_Optimum_max_green_percent_upper(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_upper = sequence.Optimum_max_green_percent_upper
        sequence.Optimum_max_green_percent_upper = 0
        ```

### Optimum_max_green_percent_increment {#optimum_max_green_percent_increment}

```csharp
int Optimum_max_green_percent_increment { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_percent_increment = sequence.Optimum_max_green_percent_increment;
        sequence.Optimum_max_green_percent_increment = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_percent_increment;
        sequence->get_Optimum_max_green_percent_increment(&optimum_max_green_percent_increment);
        sequence->put_Optimum_max_green_percent_increment(0);
        ```

    === "Python"

        ```python
        optimum_max_green_percent_increment = sequence.Optimum_max_green_percent_increment
        sequence.Optimum_max_green_percent_increment = 0
        ```

### Optimum_max_green_perf_measure {#optimum_max_green_perf_measure}

```csharp
int Optimum_max_green_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_perf_measure = sequence.Optimum_max_green_perf_measure;
        sequence.Optimum_max_green_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_perf_measure;
        sequence->get_Optimum_max_green_perf_measure(&optimum_max_green_perf_measure);
        sequence->put_Optimum_max_green_perf_measure(0);
        ```

    === "Python"

        ```python
        optimum_max_green_perf_measure = sequence.Optimum_max_green_perf_measure
        sequence.Optimum_max_green_perf_measure = 0
        ```

### Optimum_max_green_optim_method {#optimum_max_green_optim_method}

```csharp
int Optimum_max_green_optim_method { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int optimum_max_green_optim_method = sequence.Optimum_max_green_optim_method;
        sequence.Optimum_max_green_optim_method = 0;
        ```

    === "C++"

        ```cpp
        long optimum_max_green_optim_method;
        sequence->get_Optimum_max_green_optim_method(&optimum_max_green_optim_method);
        sequence->put_Optimum_max_green_optim_method(0);
        ```

    === "Python"

        ```python
        optimum_max_green_optim_method = sequence.Optimum_max_green_optim_method
        sequence.Optimum_max_green_optim_method = 0
        ```

### Variable_phasing_perf_measure {#variable_phasing_perf_measure}

```csharp
int Variable_phasing_perf_measure { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int variable_phasing_perf_measure = sequence.Variable_phasing_perf_measure;
        sequence.Variable_phasing_perf_measure = 0;
        ```

    === "C++"

        ```cpp
        long variable_phasing_perf_measure;
        sequence->get_Variable_phasing_perf_measure(&variable_phasing_perf_measure);
        sequence->put_Variable_phasing_perf_measure(0);
        ```

    === "Python"

        ```python
        variable_phasing_perf_measure = sequence.Variable_phasing_perf_measure
        sequence.Variable_phasing_perf_measure = 0
        ```

### Usergiven_cycle_time {#usergiven_cycle_time}

```csharp
float Usergiven_cycle_time { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float usergiven_cycle_time = sequence.Usergiven_cycle_time;
        sequence.Usergiven_cycle_time = 0.0;
        ```

    === "C++"

        ```cpp
        double usergiven_cycle_time;
        sequence->get_Usergiven_cycle_time(&usergiven_cycle_time);
        sequence->put_Usergiven_cycle_time(0.0);
        ```

    === "Python"

        ```python
        usergiven_cycle_time = sequence.Usergiven_cycle_time
        sequence.Usergiven_cycle_time = 0.0
        ```

### Green_split_priority_option {#green_split_priority_option}

Green Split Priority

```csharp
int Green_split_priority_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - None
- `1` - Coordinated Movements
- `2` - User-Specified Movements

???- example "Code samples"

    === "C#"

        ```csharp
        int green_split_priority_option = sequence.Green_split_priority_option;
        sequence.Green_split_priority_option = 0;
        ```

    === "C++"

        ```cpp
        long green_split_priority_option;
        sequence->get_Green_split_priority_option(&green_split_priority_option);
        sequence->put_Green_split_priority_option(0);
        ```

    === "Python"

        ```python
        green_split_priority_option = sequence.Green_split_priority_option
        sequence.Green_split_priority_option = 0
        ```

### Actuated_max_green_major_mov {#actuated_max_green_major_mov}

```csharp
float Actuated_max_green_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_max_green_major_mov = sequence.Actuated_max_green_major_mov;
        sequence.Actuated_max_green_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_max_green_major_mov;
        sequence->get_Actuated_max_green_major_mov(&actuated_max_green_major_mov);
        sequence->put_Actuated_max_green_major_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_max_green_major_mov = sequence.Actuated_max_green_major_mov
        sequence.Actuated_max_green_major_mov = 0.0
        ```

### Actuated_max_green_minor_mov {#actuated_max_green_minor_mov}

```csharp
float Actuated_max_green_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_max_green_minor_mov = sequence.Actuated_max_green_minor_mov;
        sequence.Actuated_max_green_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_max_green_minor_mov;
        sequence->get_Actuated_max_green_minor_mov(&actuated_max_green_minor_mov);
        sequence->put_Actuated_max_green_minor_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_max_green_minor_mov = sequence.Actuated_max_green_minor_mov
        sequence.Actuated_max_green_minor_mov = 0.0
        ```

### Actuated_gap_major_mov {#actuated_gap_major_mov}

```csharp
float Actuated_gap_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_gap_major_mov = sequence.Actuated_gap_major_mov;
        sequence.Actuated_gap_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_gap_major_mov;
        sequence->get_Actuated_gap_major_mov(&actuated_gap_major_mov);
        sequence->put_Actuated_gap_major_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_gap_major_mov = sequence.Actuated_gap_major_mov
        sequence.Actuated_gap_major_mov = 0.0
        ```

### Actuated_gap_minor_mov {#actuated_gap_minor_mov}

```csharp
float Actuated_gap_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float actuated_gap_minor_mov = sequence.Actuated_gap_minor_mov;
        sequence.Actuated_gap_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double actuated_gap_minor_mov;
        sequence->get_Actuated_gap_minor_mov(&actuated_gap_minor_mov);
        sequence->put_Actuated_gap_minor_mov(0.0);
        ```

    === "Python"

        ```python
        actuated_gap_minor_mov = sequence.Actuated_gap_minor_mov
        sequence.Actuated_gap_minor_mov = 0.0
        ```

### Eff_det_zone_len_major_mov {#eff_det_zone_len_major_mov}

```csharp
float Eff_det_zone_len_major_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_det_zone_len_major_mov = sequence.Eff_det_zone_len_major_mov;
        sequence.Eff_det_zone_len_major_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double eff_det_zone_len_major_mov;
        sequence->get_Eff_det_zone_len_major_mov(&eff_det_zone_len_major_mov);
        sequence->put_Eff_det_zone_len_major_mov(0.0);
        ```

    === "Python"

        ```python
        eff_det_zone_len_major_mov = sequence.Eff_det_zone_len_major_mov
        sequence.Eff_det_zone_len_major_mov = 0.0
        ```

### Eff_det_zone_len_minor_mov {#eff_det_zone_len_minor_mov}

```csharp
float Eff_det_zone_len_minor_mov { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float eff_det_zone_len_minor_mov = sequence.Eff_det_zone_len_minor_mov;
        sequence.Eff_det_zone_len_minor_mov = 0.0;
        ```

    === "C++"

        ```cpp
        double eff_det_zone_len_minor_mov;
        sequence->get_Eff_det_zone_len_minor_mov(&eff_det_zone_len_minor_mov);
        sequence->put_Eff_det_zone_len_minor_mov(0.0);
        ```

    === "Python"

        ```python
        eff_det_zone_len_minor_mov = sequence.Eff_det_zone_len_minor_mov
        sequence.Eff_det_zone_len_minor_mov = 0.0
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = sequence.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        sequence->get_Site(&site);
        ```

    === "Python"

        ```python
        site = sequence.Site
        ```

### Phases {#phases}

```csharp
ISIAPIPhases Phases { get; }
```

**Type** [`ISIAPIPhases`](sidrasolutions.si.api.isiapiphases.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var phases = sequence.Phases;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhases> phases;
        sequence->get_Phases(&phases);
        ```

    === "Python"

        ```python
        phases = sequence.Phases
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = sequence.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        sequence->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = sequence.LastErrorMessage
        ```

### Lane_blockage_effect_option {#lane_blockage_effect_option}

Lane Blockage Effect Option:  
In Network analysis, include Lane Blockage effects in determining Phase Times.

```csharp
int Lane_blockage_effect_option { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Without Lane Blockage Effects
- `1` - With Lane Blockage Effects

???- example "Code samples"

    === "C#"

        ```csharp
        int lane_blockage_effect_option = sequence.Lane_blockage_effect_option;
        sequence.Lane_blockage_effect_option = 0;
        ```

    === "C++"

        ```cpp
        long lane_blockage_effect_option;
        sequence->get_Lane_blockage_effect_option(&lane_blockage_effect_option);
        sequence->put_Lane_blockage_effect_option(0);
        ```

    === "Python"

        ```python
        lane_blockage_effect_option = sequence.Lane_blockage_effect_option
        sequence.Lane_blockage_effect_option = 0
        ```

### Is_timing_optimised_for_selected_result {#is_timing_optimised_for_selected_result}

```csharp
bool Is_timing_optimised_for_selected_result { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_timing_optimised_for_selected_result = sequence.Is_timing_optimised_for_selected_result;
        sequence.Is_timing_optimised_for_selected_result = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_timing_optimised_for_selected_result;
        sequence->get_Is_timing_optimised_for_selected_result(&is_timing_optimised_for_selected_result);
        sequence->put_Is_timing_optimised_for_selected_result(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_timing_optimised_for_selected_result = sequence.Is_timing_optimised_for_selected_result
        sequence.Is_timing_optimised_for_selected_result = True
        ```

## Methods

### AddPhase(string) {#addphase-string}

Add a new Phase to the end of this Sequence.

```csharp
ISIAPIPhase AddPhase(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | The name of the new Phase. |

**Returns** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) - The new added Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = sequence.AddPhase(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> result;
        sequence->AddPhase(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = sequence.AddPhase(r"Example")
        ```

### RemovePhase(ISIAPIPhase) {#removephase-isiapiphase}

Remove a Phase from this Sequence.

```csharp
bool RemovePhase(ISIAPIPhase phase)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `phase` | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | The Phase to remove. |

**Returns** `bool` - true if the Phase is successfully removed; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = sequence.RemovePhase(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        sequence->RemovePhase(NULL, &result);
        ```

    === "Python"

        ```python
        result = sequence.RemovePhase(None)
        ```

### InsertPhase(int, string) {#insertphase-int--string}

Insert a new Phase into this Sequence at the specified position.

```csharp
ISIAPIPhase InsertPhase(int position, string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `position` | `int` | The zero-based position at which the new Phase should be inserted. |
| `name` | `string` | The name of the new Phase. |

**Returns** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) - The new added Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = sequence.InsertPhase(0, @"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> result;
        sequence->InsertPhase(0, CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = sequence.InsertPhase(0, r"Example")
        ```

### ClonePhase(ISIAPIPhase) {#clonephase-isiapiphase}

Clone a Phase.

```csharp
ISIAPIPhase ClonePhase(ISIAPIPhase phase)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `phase` | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | The Phase to clone. |

**Returns** [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) - The new cloned Phase.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = sequence.ClonePhase(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIPhase> result;
        sequence->ClonePhase(NULL, &result);
        ```

    === "Python"

        ```python
        result = sequence.ClonePhase(None)
        ```

### MovePhaseTo(ISIAPIPhase, int) {#movephaseto-isiapiphase--int}

Move a Phase to a new position.

```csharp
bool MovePhaseTo(ISIAPIPhase phase, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `phase` | [`ISIAPIPhase`](sidrasolutions.si.api.isiapiphase.md) | The Phase to move. |
| `newPosition` | `int` | The zero-based position that the Phase should be moved to. |

**Returns** `bool` - true if the Phase is successfully moved; otherwise, false. This method also returns false if the Phase does not exist in this Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = sequence.MovePhaseTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        sequence->MovePhaseTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = sequence.MovePhaseTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisequences.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISequences
title: Sequences
name: ISIAPISequences
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B9BE0559-44B9-48BD-8CC8-3AD7129C690E
members:
  - bool SequenceExists(string name)
  - ISIAPISequence this[string name]
  - ISIAPISequence this[int index]
  - int Count
---

# Sequences

Type `ISIAPISequences` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B9BE0559-44B9-48BD-8CC8-3AD7129C690E`

## Declaration

```csharp
[Guid("B9BE0559-44B9-48BD-8CC8-3AD7129C690E")]
public interface ISIAPISequences
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) |  |
| [this[]](#this) | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SequenceExists(string)](#sequenceexists-string) | `bool` |  |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = sequences.Count;
        ```

    === "C++"

        ```cpp
        long count;
        sequences->get_Count(&count);
        ```

    === "Python"

        ```python
        count = sequences.Count
        ```

### this[] {#this}

```csharp
ISIAPISequence this[] { get; }
```

**Type** [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = sequences.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequence> this[];
        sequences->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = sequences.this[]
        ```

### this[] {#this}

```csharp
ISIAPISequence this[] { get; }
```

**Type** [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = sequences.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequence> this[];
        sequences->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = sequences.this[]
        ```

## Methods

### SequenceExists(string) {#sequenceexists-string}

```csharp
bool SequenceExists(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = sequences.SequenceExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        sequences->SequenceExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = sequences.SequenceExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisite.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISite
title: Site
name: ISIAPISite
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 44804DC5-326B-4BA7-B90C-F1D7FDD3AC22
summary: SIDRA INTERSECTION Site wrapper interface
members:
  - bool Process()
  - bool ResetMovementVehicleODMCExists()
  - bool ResetLaneMovements()
  - bool ResetSitePrioritiesData()
  - bool UpdateModifiedInfo()
  - ISIAPILeg AddLeg(int orientation)
  - ISIAPILeg AddLegWithLanes(int orientation, int legGeometry)
  - bool RemoveLeg(int orientation)
  - bool Rotate(int step)
  - bool UpdateGeometryData()
  - ISIAPISequence AddSequence(string name)
  - bool RemoveSequence(ISIAPISequence sequence)
  - byte[] CreateLayoutPngData()
  - bool CreateLayoutPngFile(string filename)
  - ISIAPISequence CloneSequence(ISIAPISequence sequence)
  - bool MoveSequenceTo(ISIAPISequence sequence, int newPosition)
  - bool RemoveOutputData()
  - ISIAPISiteScenario AddSiteScenario(ISIAPISiteVolumeBin siteVolumeBin)
  - bool RemoveSiteScenario(ISIAPISiteScenario siteScenario)
  - ISIAPISiteScenario CloneSiteScenario(ISIAPISiteScenario siteScenario)
  - bool MoveSiteScenarioTo(ISIAPISiteScenario siteScenario, int newPosition)
  - string Name
  - string Intersectionid
  - int Position
  - string Site_id
  - ISIAPIMovementClasses MovementClasses
  - ISIAPILegs Legs
  - ISIAPIMovement_vehicle_ods MovementVehicleODs
  - ISIAPIMovement_peds MovementPeds
  - ISIAPISequences Sequences
  - ISIAPIModelSetting ModelSetting
  - ISIAPIAnalysis Analysis
  - ISIAPIGapAcceptanceSpecificApp GapAcceptanceTurnOnRed
  - ISIAPITwoWaySignControlAdjMajorNumLanes TwoWaySignControlAdjMajorNumLanes
  - ISIAPITwoWaySignControlAdjGeometryControls TwoWaySignControlAdjGeometryControls
  - ISIAPIOutputset Outputset
  - ISIAPIProject Project
  - string ProcessingError
  - string ProcessingWarnings
  - bool HasWarnings
  - string LastErrorMessage
  - int DiagnosticStatus
  - ISIAPIDiagnosticMsgs DiagnosticMsgs
  - int Sitetype
  - int Sitecontroltype
  - bool Driveonleft
  - int Units
  - bool Hcm
  - string Modelsignature
  - string ModelName
  - int Freeway_orientation
  - DateTime Created_date
  - string Created_by
  - string Created_by_company
  - string Created_version
  - DateTime Modified_date
  - string Modified_by
  - string Modified_by_company
  - string Modified_version
  - string Description
  - string Title
  - int Unittimeforvolumes
  - int Peakflowperiod
  - int Signal_analysis_method
  - string Costunit
  - float Rou_stopline_setback_dist
  - float Rou_metered_start_loss
  - float Rou_metered_end_gain
  - float Rou_controlling_detector_setback_dist
  - int Rou_metered_leg_orientation
  - int Rou_controlling_leg_orientation
  - string Category
  - bool IsIncludedInProjectSummary
  - ISIAPISiteFolder SiteFolder
  - bool Is_multi_sequence_enabled
  - bool IsUserModel
  - ISIAPISiteScenarios SiteScenarios
  - ISIAPIMapCoordinate MapCoordinate
  - bool IsInputDataCompatible
  - bool IsOutputDataCompatible
  - string MinViableVersionL1
  - string MinViableVersionL2
  - string MinViableVersionL3
---

# Site

Type `ISIAPISite` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `44804DC5-326B-4BA7-B90C-F1D7FDD3AC22`

SIDRA INTERSECTION Site wrapper interface

## Declaration

```csharp
[Guid("44804DC5-326B-4BA7-B90C-F1D7FDD3AC22")]
public interface ISIAPISite
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | Site name |
| [Intersectionid](#intersectionid) | `string` | Site ID in the Intersection dialog and reports. It was named as "Intersection ID" in the old versions. |
| [Position](#position) | `int` | The Site Position in the Site Folder's Sites collection. It is a zero-base integer. |
| [Site_id](#site_id) | `string` | The GUID of the Site object. |
| [MovementClasses](#movementclasses) | [`ISIAPIMovementClasses`](sidrasolutions.si.api.isiapimovementclasses.md) | Collection of the Site's Movement Classes |
| [Legs](#legs) | [`ISIAPILegs`](sidrasolutions.si.api.isiapilegs.md) |  |
| [MovementVehicleODs](#movementvehicleods) | [`ISIAPIMovement_vehicle_ods`](sidrasolutions.si.api.isiapimovement_vehicle_ods.md) | Collection of the Site's Vehicle Approach Movements |
| [MovementPeds](#movementpeds) | [`ISIAPIMovement_peds`](sidrasolutions.si.api.isiapimovement_peds.md) | Collection of the Site's Pedestrian Movements |
| [Sequences](#sequences) | [`ISIAPISequences`](sidrasolutions.si.api.isiapisequences.md) |  |
| [ModelSetting](#modelsetting) | [`ISIAPIModelSetting`](sidrasolutions.si.api.isiapimodelsetting.md) |  |
| [Analysis](#analysis) | [`ISIAPIAnalysis`](sidrasolutions.si.api.isiapianalysis.md) |  |
| [GapAcceptanceTurnOnRed](#gapacceptanceturnonred) | [`ISIAPIGapAcceptanceSpecificApp`](sidrasolutions.si.api.isiapigapacceptancespecificapp.md) |  |
| [TwoWaySignControlAdjMajorNumLanes](#twowaysigncontroladjmajornumlanes) | [`ISIAPITwoWaySignControlAdjMajorNumLanes`](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlanes.md) |  |
| [TwoWaySignControlAdjGeometryControls](#twowaysigncontroladjgeometrycontrols) | [`ISIAPITwoWaySignControlAdjGeometryControls`](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrols.md) |  |
| [Outputset](#outputset) | [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md) | Site output data |
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) |  |
| [ProcessingError](#processingerror) | `string` | Error message after a failed call to Process |
| [ProcessingWarnings](#processingwarnings) | `string` | Processing warnings generated during a call to Process |
| [HasWarnings](#haswarnings) | `bool` | Flag indicating whether warnings were generated during a call to Process |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [DiagnosticStatus](#diagnosticstatus) | `int` | Diagnostic Status |
| [DiagnosticMsgs](#diagnosticmsgs) | [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md) |  |
| [Sitetype](#sitetype) | `int` | Site Intersection type |
| [Sitecontroltype](#sitecontroltype) | `int` | Control method used at site |
| [Driveonleft](#driveonleft) | `bool` | Flag indicating the "Drive Rule" of the site |
| [Units](#units) | `int` | General unit system used for data within the site |
| [Hcm](#hcm) | `bool` | Flag indicating whether the site uses HCM |
| [Modelsignature](#modelsignature) | `string` | The internal SIDRA INTERSECTION Software Setup signature GUID used by this site |
| [ModelName](#modelname) | `string` | The internal SIDRA INTERSECTION Software Setup name |
| [Freeway_orientation](#freeway_orientation) | `int` |  |
| [Created_date](#created_date) | `DateTime` |  |
| [Created_by](#created_by) | `string` |  |
| [Created_by_company](#created_by_company) | `string` |  |
| [Created_version](#created_version) | `string` |  |
| [Modified_date](#modified_date) | `DateTime` |  |
| [Modified_by](#modified_by) | `string` |  |
| [Modified_by_company](#modified_by_company) | `string` |  |
| [Modified_version](#modified_version) | `string` |  |
| [Description](#description) | `string` | Site description |
| [Title](#title) | `string` | Site title |
| [Unittimeforvolumes](#unittimeforvolumes) | `int` | Unit time for traffic volumes in minutes |
| [Peakflowperiod](#peakflowperiod) | `int` | Peak flow period in minutes |
| [Signal_analysis_method](#signal_analysis_method) | `int` | Signalised Site analysis method |
| [Costunit](#costunit) | `string` |  |
| [Rou_stopline_setback_dist](#rou_stopline_setback_dist) | `float` |  |
| [Rou_metered_start_loss](#rou_metered_start_loss) | `float` |  |
| [Rou_metered_end_gain](#rou_metered_end_gain) | `float` |  |
| [Rou_controlling_detector_setback_dist](#rou_controlling_detector_setback_dist) | `float` |  |
| [Rou_metered_leg_orientation](#rou_metered_leg_orientation) | `int` |  |
| [Rou_controlling_leg_orientation](#rou_controlling_leg_orientation) | `int` |  |
| [Category](#category) | `string` | Site Category |
| [IsIncludedInProjectSummary](#isincludedinprojectsummary) | `bool` |  |
| [SiteFolder](#sitefolder) | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) |  |
| [Is_multi_sequence_enabled](#is_multi_sequence_enabled) | `bool` |  |
| [IsUserModel](#isusermodel) | `bool` | Flag indicating whether the internal SIDRA INTERSECTION Software Setup that is used by this Site is a User Software Setup or a Standard Software Setup. |
| [SiteScenarios](#sitescenarios) | [`ISIAPISiteScenarios`](sidrasolutions.si.api.isiapisitescenarios.md) | Collection of the Site Scenarios |
| [MapCoordinate](#mapcoordinate) | [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md) |  |
| [IsInputDataCompatible](#isinputdatacompatible) | `bool` |  |
| [IsOutputDataCompatible](#isoutputdatacompatible) | `bool` |  |
| [MinViableVersionL1](#minviableversionl1) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Site's Level 1 Compatibility |
| [MinViableVersionL2](#minviableversionl2) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Site's Level 2 Compatibility |
| [MinViableVersionL3](#minviableversionl3) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Site's Level 3 Compatibility |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Process()](#process) | `bool` | Processes the Site |
| [ResetMovementVehicleODMCExists()](#resetmovementvehicleodmcexists) | `bool` | Reset all Movement_vehicle_od_mc.Exists values according to the LaneApproachMovementMC.Exists values (i.e. Lane Disciplines) |
| [ResetLaneMovements()](#resetlanemovements) | `bool` | Reset the Lane Movements to the default vaules |
| [ResetSitePrioritiesData()](#resetsiteprioritiesdata) | `bool` | Reset Priority Data to the default vaules |
| [UpdateModifiedInfo()](#updatemodifiedinfo) | `bool` | Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number |
| [AddLeg(int)](#addleg-int) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) | Add a new Leg to the Site at the specified orientation. The Leg is created automatically without any Approach Lane, Exit Lane or Island. |
| [AddLegWithLanes(int, int)](#addlegwithlanes-int--int) | [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) | Add a new Leg to the Site at the specified orientation. The Leg is created automatically with a default set of Approach Lanes, Exit Lanes and / or Island depending on the legGeometry parameter. |
| [RemoveLeg(int)](#removeleg-int) | `bool` | Remove a Leg from the Site. |
| [Rotate(int)](#rotate-int) | `bool` | Rotate the Site. |
| [UpdateGeometryData()](#updategeometrydata) | `bool` | Update the Geometry Data. Call this method manually after Leg(s) are added / removed, or after Lane(s) are added / removed. |
| [AddSequence(string)](#addsequence-string) | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) | Add a Sequence. A new Sequence is created and added to this Site. |
| [RemoveSequence(ISIAPISequence)](#removesequence-isiapisequence) | `bool` | Remove a Sequence from the Site. |
| [CreateLayoutPngData()](#createlayoutpngdata) | `byte[]` |  |
| [CreateLayoutPngFile(string)](#createlayoutpngfile-string) | `bool` |  |
| [CloneSequence(ISIAPISequence)](#clonesequence-isiapisequence) | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) | Clone a Sequence. |
| [MoveSequenceTo(ISIAPISequence, int)](#movesequenceto-isiapisequence--int) | `bool` | Move a Sequence to a new position. |
| [RemoveOutputData()](#removeoutputdata) | `bool` | Remove this Site and relevant Networks' Output data. |
| [AddSiteScenario(ISIAPISiteVolumeBin)](#addsitescenario-isiapisitevolumebin) | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | Add a new Site Scenario that links to a Site Volume Bin. |
| [RemoveSiteScenario(ISIAPISiteScenario)](#removesitescenario-isiapisitescenario) | `bool` | Remove a Site Scenario from this Site. |
| [CloneSiteScenario(ISIAPISiteScenario)](#clonesitescenario-isiapisitescenario) | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | Clone a Site Scenario. |
| [MoveSiteScenarioTo(ISIAPISiteScenario, int)](#movesitescenarioto-isiapisitescenario--int) | `bool` | Move a Site Scenario to a new position in the collection. |

</div>

## Properties

### Name {#name}

Site name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The site name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = site.Name;
        site.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        site->get_Name(&name);
        site->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = site.Name
        site.Name = r"Example"
        ```

### Intersectionid {#intersectionid}

Site ID in the Intersection dialog and reports. It was named as "Intersection ID" in the old versions.

```csharp
string Intersectionid { get; set; }
```

**Type** `string`

**Value**

Site ID, max length = 10.

???- example "Code samples"

    === "C#"

        ```csharp
        string intersectionid = site.Intersectionid;
        site.Intersectionid = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR intersectionid;
        site->get_Intersectionid(&intersectionid);
        site->put_Intersectionid(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        intersectionid = site.Intersectionid
        site.Intersectionid = r"id-1"
        ```

### Position {#position}

The Site Position in the Site Folder's Sites collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = site.Position;
        ```

    === "C++"

        ```cpp
        long position;
        site->get_Position(&position);
        ```

    === "Python"

        ```python
        position = site.Position
        ```

### Site_id {#site_id}

The GUID of the Site object.

```csharp
string Site_id { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string site_id = site.Site_id;
        ```

    === "C++"

        ```cpp
        CComBSTR site_id;
        site->get_Site_id(&site_id);
        ```

    === "Python"

        ```python
        site_id = site.Site_id
        ```

### MovementClasses {#movementclasses}

Collection of the Site's Movement Classes

```csharp
ISIAPIMovementClasses MovementClasses { get; }
```

**Type** [`ISIAPIMovementClasses`](sidrasolutions.si.api.isiapimovementclasses.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementClasses = site.MovementClasses;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovementClasses> movementClasses;
        site->get_MovementClasses(&movementClasses);
        ```

    === "Python"

        ```python
        movement_classes = site.MovementClasses
        ```

### Legs {#legs}

```csharp
ISIAPILegs Legs { get; }
```

**Type** [`ISIAPILegs`](sidrasolutions.si.api.isiapilegs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var legs = site.Legs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILegs> legs;
        site->get_Legs(&legs);
        ```

    === "Python"

        ```python
        legs = site.Legs
        ```

### MovementVehicleODs {#movementvehicleods}

Collection of the Site's Vehicle Approach Movements

```csharp
ISIAPIMovement_vehicle_ods MovementVehicleODs { get; }
```

**Type** [`ISIAPIMovement_vehicle_ods`](sidrasolutions.si.api.isiapimovement_vehicle_ods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementVehicleODs = site.MovementVehicleODs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_vehicle_ods> movementVehicleODs;
        site->get_MovementVehicleODs(&movementVehicleODs);
        ```

    === "Python"

        ```python
        movement_vehicle_o_ds = site.MovementVehicleODs
        ```

### MovementPeds {#movementpeds}

Collection of the Site's Pedestrian Movements

```csharp
ISIAPIMovement_peds MovementPeds { get; }
```

**Type** [`ISIAPIMovement_peds`](sidrasolutions.si.api.isiapimovement_peds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var movementPeds = site.MovementPeds;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMovement_peds> movementPeds;
        site->get_MovementPeds(&movementPeds);
        ```

    === "Python"

        ```python
        movement_peds = site.MovementPeds
        ```

### Sequences {#sequences}

```csharp
ISIAPISequences Sequences { get; }
```

**Type** [`ISIAPISequences`](sidrasolutions.si.api.isiapisequences.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var sequences = site.Sequences;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequences> sequences;
        site->get_Sequences(&sequences);
        ```

    === "Python"

        ```python
        sequences = site.Sequences
        ```

### ModelSetting {#modelsetting}

```csharp
ISIAPIModelSetting ModelSetting { get; }
```

**Type** [`ISIAPIModelSetting`](sidrasolutions.si.api.isiapimodelsetting.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var modelSetting = site.ModelSetting;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIModelSetting> modelSetting;
        site->get_ModelSetting(&modelSetting);
        ```

    === "Python"

        ```python
        model_setting = site.ModelSetting
        ```

### Analysis {#analysis}

```csharp
ISIAPIAnalysis Analysis { get; }
```

**Type** [`ISIAPIAnalysis`](sidrasolutions.si.api.isiapianalysis.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var analysis = site.Analysis;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIAnalysis> analysis;
        site->get_Analysis(&analysis);
        ```

    === "Python"

        ```python
        analysis = site.Analysis
        ```

### GapAcceptanceTurnOnRed {#gapacceptanceturnonred}

```csharp
ISIAPIGapAcceptanceSpecificApp GapAcceptanceTurnOnRed { get; }
```

**Type** [`ISIAPIGapAcceptanceSpecificApp`](sidrasolutions.si.api.isiapigapacceptancespecificapp.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var gapAcceptanceTurnOnRed = site.GapAcceptanceTurnOnRed;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIGapAcceptanceSpecificApp> gapAcceptanceTurnOnRed;
        site->get_GapAcceptanceTurnOnRed(&gapAcceptanceTurnOnRed);
        ```

    === "Python"

        ```python
        gap_acceptance_turn_on_red = site.GapAcceptanceTurnOnRed
        ```

### TwoWaySignControlAdjMajorNumLanes {#twowaysigncontroladjmajornumlanes}

```csharp
ISIAPITwoWaySignControlAdjMajorNumLanes TwoWaySignControlAdjMajorNumLanes { get; }
```

**Type** [`ISIAPITwoWaySignControlAdjMajorNumLanes`](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlanes.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var twoWaySignControlAdjMajorNumLanes = site.TwoWaySignControlAdjMajorNumLanes;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPITwoWaySignControlAdjMajorNumLanes> twoWaySignControlAdjMajorNumLanes;
        site->get_TwoWaySignControlAdjMajorNumLanes(&twoWaySignControlAdjMajorNumLanes);
        ```

    === "Python"

        ```python
        two_way_sign_control_adj_major_num_lanes = site.TwoWaySignControlAdjMajorNumLanes
        ```

### TwoWaySignControlAdjGeometryControls {#twowaysigncontroladjgeometrycontrols}

```csharp
ISIAPITwoWaySignControlAdjGeometryControls TwoWaySignControlAdjGeometryControls { get; }
```

**Type** [`ISIAPITwoWaySignControlAdjGeometryControls`](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrols.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var twoWaySignControlAdjGeometryControls = site.TwoWaySignControlAdjGeometryControls;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPITwoWaySignControlAdjGeometryControls> twoWaySignControlAdjGeometryControls;
        site->get_TwoWaySignControlAdjGeometryControls(&twoWaySignControlAdjGeometryControls);
        ```

    === "Python"

        ```python
        two_way_sign_control_adj_geometry_controls = site.TwoWaySignControlAdjGeometryControls
        ```

### Outputset {#outputset}

Site output data

```csharp
ISIAPIOutputset Outputset { get; }
```

**Type** [`ISIAPIOutputset`](sidrasolutions.si.api.isiapioutputset.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var outputset = site.Outputset;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIOutputset> outputset;
        site->get_Outputset(&outputset);
        ```

    === "Python"

        ```python
        outputset = site.Outputset
        ```

### Project {#project}

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var project = site.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        site->get_Project(&project);
        ```

    === "Python"

        ```python
        project = site.Project
        ```

### ProcessingError {#processingerror}

Error message after a failed call to Process

```csharp
string ProcessingError { get; }
```

**Type** `string`

**Value**

Error message

???- example "Code samples"

    === "C#"

        ```csharp
        string processingError = site.ProcessingError;
        ```

    === "C++"

        ```cpp
        CComBSTR processingError;
        site->get_ProcessingError(&processingError);
        ```

    === "Python"

        ```python
        processing_error = site.ProcessingError
        ```

### ProcessingWarnings {#processingwarnings}

Processing warnings generated during a call to Process

```csharp
string ProcessingWarnings { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string processingWarnings = site.ProcessingWarnings;
        ```

    === "C++"

        ```cpp
        CComBSTR processingWarnings;
        site->get_ProcessingWarnings(&processingWarnings);
        ```

    === "Python"

        ```python
        processing_warnings = site.ProcessingWarnings
        ```

### HasWarnings {#haswarnings}

Flag indicating whether warnings were generated during a call to Process

```csharp
bool HasWarnings { get; }
```

**Type** `bool`

**Value**

True if warnings were generated. False otherwise.

???- example "Code samples"

    === "C#"

        ```csharp
        bool hasWarnings = site.HasWarnings;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL hasWarnings;
        site->get_HasWarnings(&hasWarnings);
        ```

    === "Python"

        ```python
        has_warnings = site.HasWarnings
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = site.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        site->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = site.LastErrorMessage
        ```

### DiagnosticStatus {#diagnosticstatus}

Diagnostic Status

```csharp
int DiagnosticStatus { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Processed
- `2` - Not Processed
- `3` - Input Warning
- `4` - Processing Warning
- `5` - Error

???- example "Code samples"

    === "C#"

        ```csharp
        int diagnosticStatus = site.DiagnosticStatus;
        ```

    === "C++"

        ```cpp
        long diagnosticStatus;
        site->get_DiagnosticStatus(&diagnosticStatus);
        ```

    === "Python"

        ```python
        diagnostic_status = site.DiagnosticStatus
        ```

### DiagnosticMsgs {#diagnosticmsgs}

```csharp
ISIAPIDiagnosticMsgs DiagnosticMsgs { get; }
```

**Type** [`ISIAPIDiagnosticMsgs`](sidrasolutions.si.api.isiapidiagnosticmsgs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var diagnosticMsgs = site.DiagnosticMsgs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIDiagnosticMsgs> diagnosticMsgs;
        site->get_DiagnosticMsgs(&diagnosticMsgs);
        ```

    === "Python"

        ```python
        diagnostic_msgs = site.DiagnosticMsgs
        ```

### Sitetype {#sitetype}

Site Intersection type

```csharp
int Sitetype { get; }
```

**Type** `int`

**Value**

One of:

- `0` - At-Grade Intersection
- `1` - Roundabout (Unsignalised)
- `2` - Giveway/Yield (Two-Way)
- `3` - Stop (Two-Way)
- `4` - Stop (All-Way)
- `5` - Single Point Interchange (Signals)
- `6` - Pedestrian Crossing (Signalised)
- `7` - Roundabout (Metering Signals)
- `8` - Pedestrian Crossing (Unsignalised)
- `9` - Arterial Segment
- `10` - Freeway Basic Segment
- `11` - Freeway Segment with Ramps (Two-Way)
- `12` - Freeway Segment with Ramps (One-Way)
- `13` - Turbo Roundabout

???- example "Code samples"

    === "C#"

        ```csharp
        int sitetype = site.Sitetype;
        ```

    === "C++"

        ```cpp
        long sitetype;
        site->get_Sitetype(&sitetype);
        ```

    === "Python"

        ```python
        sitetype = site.Sitetype
        ```

### Sitecontroltype {#sitecontroltype}

Control method used at site

```csharp
int Sitecontroltype { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Signals
- `1` - Roundabout
- `2` - Sign Control
- `3` - All Way Stop
- `4` - Uninterrupted

???- example "Code samples"

    === "C#"

        ```csharp
        int sitecontroltype = site.Sitecontroltype;
        ```

    === "C++"

        ```cpp
        long sitecontroltype;
        site->get_Sitecontroltype(&sitecontroltype);
        ```

    === "Python"

        ```python
        sitecontroltype = site.Sitecontroltype
        ```

### Driveonleft {#driveonleft}

Flag indicating the "Drive Rule" of the site

```csharp
bool Driveonleft { get; }
```

**Type** `bool`

**Value**

True if driving on the left. False if driving on the right.

???- example "Code samples"

    === "C#"

        ```csharp
        bool driveonleft = site.Driveonleft;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL driveonleft;
        site->get_Driveonleft(&driveonleft);
        ```

    === "Python"

        ```python
        driveonleft = site.Driveonleft
        ```

### Units {#units}

General unit system used for data within the site

```csharp
int Units { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Metric
- `1` - US Units

???- example "Code samples"

    === "C#"

        ```csharp
        int units = site.Units;
        ```

    === "C++"

        ```cpp
        long units;
        site->get_Units(&units);
        ```

    === "Python"

        ```python
        units = site.Units
        ```

### Hcm {#hcm}

Flag indicating whether the site uses HCM

```csharp
bool Hcm { get; }
```

**Type** `bool`

**Value**

True, if site uses HCM, False otherwise.

???- example "Code samples"

    === "C#"

        ```csharp
        bool hcm = site.Hcm;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL hcm;
        site->get_Hcm(&hcm);
        ```

    === "Python"

        ```python
        hcm = site.Hcm
        ```

### Modelsignature {#modelsignature}

The internal SIDRA INTERSECTION Software Setup signature GUID used by this site

```csharp
string Modelsignature { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modelsignature = site.Modelsignature;
        ```

    === "C++"

        ```cpp
        CComBSTR modelsignature;
        site->get_Modelsignature(&modelsignature);
        ```

    === "Python"

        ```python
        modelsignature = site.Modelsignature
        ```

### ModelName {#modelname}

The internal SIDRA INTERSECTION Software Setup name

```csharp
string ModelName { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modelName = site.ModelName;
        ```

    === "C++"

        ```cpp
        CComBSTR modelName;
        site->get_ModelName(&modelName);
        ```

    === "Python"

        ```python
        model_name = site.ModelName
        ```

### Freeway_orientation {#freeway_orientation}

```csharp
int Freeway_orientation { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int freeway_orientation = site.Freeway_orientation;
        ```

    === "C++"

        ```cpp
        long freeway_orientation;
        site->get_Freeway_orientation(&freeway_orientation);
        ```

    === "Python"

        ```python
        freeway_orientation = site.Freeway_orientation
        ```

### Created_date {#created_date}

```csharp
DateTime Created_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var created_date = site.Created_date;
        ```

    === "C++"

        ```cpp
        VARIANT created_date;
        site->get_Created_date(&created_date);
        ```

    === "Python"

        ```python
        created_date = site.Created_date
        ```

### Created_by {#created_by}

```csharp
string Created_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by = site.Created_by;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by;
        site->get_Created_by(&created_by);
        ```

    === "Python"

        ```python
        created_by = site.Created_by
        ```

### Created_by_company {#created_by_company}

```csharp
string Created_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by_company = site.Created_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by_company;
        site->get_Created_by_company(&created_by_company);
        ```

    === "Python"

        ```python
        created_by_company = site.Created_by_company
        ```

### Created_version {#created_version}

```csharp
string Created_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_version = site.Created_version;
        ```

    === "C++"

        ```cpp
        CComBSTR created_version;
        site->get_Created_version(&created_version);
        ```

    === "Python"

        ```python
        created_version = site.Created_version
        ```

### Modified_date {#modified_date}

```csharp
DateTime Modified_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var modified_date = site.Modified_date;
        ```

    === "C++"

        ```cpp
        VARIANT modified_date;
        site->get_Modified_date(&modified_date);
        ```

    === "Python"

        ```python
        modified_date = site.Modified_date
        ```

### Modified_by {#modified_by}

```csharp
string Modified_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by = site.Modified_by;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by;
        site->get_Modified_by(&modified_by);
        ```

    === "Python"

        ```python
        modified_by = site.Modified_by
        ```

### Modified_by_company {#modified_by_company}

```csharp
string Modified_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by_company = site.Modified_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by_company;
        site->get_Modified_by_company(&modified_by_company);
        ```

    === "Python"

        ```python
        modified_by_company = site.Modified_by_company
        ```

### Modified_version {#modified_version}

```csharp
string Modified_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_version = site.Modified_version;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_version;
        site->get_Modified_version(&modified_version);
        ```

    === "Python"

        ```python
        modified_version = site.Modified_version
        ```

### Description {#description}

Site description

```csharp
string Description { get; set; }
```

**Type** `string`

**Value**

Site description, max length = 500.

???- example "Code samples"

    === "C#"

        ```csharp
        string description = site.Description;
        site.Description = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR description;
        site->get_Description(&description);
        site->put_Description(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        description = site.Description
        site.Description = r"value"
        ```

### Title {#title}

Site title

```csharp
string Title { get; set; }
```

**Type** `string`

**Value**

Site title, max length = 500.

???- example "Code samples"

    === "C#"

        ```csharp
        string title = site.Title;
        site.Title = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR title;
        site->get_Title(&title);
        site->put_Title(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        title = site.Title
        site.Title = r"value"
        ```

### Unittimeforvolumes {#unittimeforvolumes}

Unit time for traffic volumes in minutes

```csharp
int Unittimeforvolumes { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int unittimeforvolumes = site.Unittimeforvolumes;
        site.Unittimeforvolumes = 0;
        ```

    === "C++"

        ```cpp
        long unittimeforvolumes;
        site->get_Unittimeforvolumes(&unittimeforvolumes);
        site->put_Unittimeforvolumes(0);
        ```

    === "Python"

        ```python
        unittimeforvolumes = site.Unittimeforvolumes
        site.Unittimeforvolumes = 0
        ```

### Peakflowperiod {#peakflowperiod}

Peak flow period in minutes

```csharp
int Peakflowperiod { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int peakflowperiod = site.Peakflowperiod;
        site.Peakflowperiod = 0;
        ```

    === "C++"

        ```cpp
        long peakflowperiod;
        site->get_Peakflowperiod(&peakflowperiod);
        site->put_Peakflowperiod(0);
        ```

    === "Python"

        ```python
        peakflowperiod = site.Peakflowperiod
        site.Peakflowperiod = 0
        ```

### Signal_analysis_method {#signal_analysis_method}

Signalised Site analysis method

```csharp
int Signal_analysis_method { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Fixed-Time/Pretimed
- `1` - Actuated

???- example "Code samples"

    === "C#"

        ```csharp
        int signal_analysis_method = site.Signal_analysis_method;
        site.Signal_analysis_method = 0;
        ```

    === "C++"

        ```cpp
        long signal_analysis_method;
        site->get_Signal_analysis_method(&signal_analysis_method);
        site->put_Signal_analysis_method(0);
        ```

    === "Python"

        ```python
        signal_analysis_method = site.Signal_analysis_method
        site.Signal_analysis_method = 0
        ```

### Costunit {#costunit}

```csharp
string Costunit { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string costunit = site.Costunit;
        site.Costunit = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR costunit;
        site->get_Costunit(&costunit);
        site->put_Costunit(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        costunit = site.Costunit
        site.Costunit = r"value"
        ```

### Rou_stopline_setback_dist {#rou_stopline_setback_dist}

```csharp
float Rou_stopline_setback_dist { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_stopline_setback_dist = site.Rou_stopline_setback_dist;
        site.Rou_stopline_setback_dist = 0.0;
        ```

    === "C++"

        ```cpp
        double rou_stopline_setback_dist;
        site->get_Rou_stopline_setback_dist(&rou_stopline_setback_dist);
        site->put_Rou_stopline_setback_dist(0.0);
        ```

    === "Python"

        ```python
        rou_stopline_setback_dist = site.Rou_stopline_setback_dist
        site.Rou_stopline_setback_dist = 0.0
        ```

### Rou_metered_start_loss {#rou_metered_start_loss}

```csharp
float Rou_metered_start_loss { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_metered_start_loss = site.Rou_metered_start_loss;
        site.Rou_metered_start_loss = 0.0;
        ```

    === "C++"

        ```cpp
        double rou_metered_start_loss;
        site->get_Rou_metered_start_loss(&rou_metered_start_loss);
        site->put_Rou_metered_start_loss(0.0);
        ```

    === "Python"

        ```python
        rou_metered_start_loss = site.Rou_metered_start_loss
        site.Rou_metered_start_loss = 0.0
        ```

### Rou_metered_end_gain {#rou_metered_end_gain}

```csharp
float Rou_metered_end_gain { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_metered_end_gain = site.Rou_metered_end_gain;
        site.Rou_metered_end_gain = 0.0;
        ```

    === "C++"

        ```cpp
        double rou_metered_end_gain;
        site->get_Rou_metered_end_gain(&rou_metered_end_gain);
        site->put_Rou_metered_end_gain(0.0);
        ```

    === "Python"

        ```python
        rou_metered_end_gain = site.Rou_metered_end_gain
        site.Rou_metered_end_gain = 0.0
        ```

### Rou_controlling_detector_setback_dist {#rou_controlling_detector_setback_dist}

```csharp
float Rou_controlling_detector_setback_dist { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float rou_controlling_detector_setback_dist = site.Rou_controlling_detector_setback_dist;
        site.Rou_controlling_detector_setback_dist = 0.0;
        ```

    === "C++"

        ```cpp
        double rou_controlling_detector_setback_dist;
        site->get_Rou_controlling_detector_setback_dist(&rou_controlling_detector_setback_dist);
        site->put_Rou_controlling_detector_setback_dist(0.0);
        ```

    === "Python"

        ```python
        rou_controlling_detector_setback_dist = site.Rou_controlling_detector_setback_dist
        site.Rou_controlling_detector_setback_dist = 0.0
        ```

### Rou_metered_leg_orientation {#rou_metered_leg_orientation}

```csharp
int Rou_metered_leg_orientation { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int rou_metered_leg_orientation = site.Rou_metered_leg_orientation;
        site.Rou_metered_leg_orientation = 0;
        ```

    === "C++"

        ```cpp
        long rou_metered_leg_orientation;
        site->get_Rou_metered_leg_orientation(&rou_metered_leg_orientation);
        site->put_Rou_metered_leg_orientation(0);
        ```

    === "Python"

        ```python
        rou_metered_leg_orientation = site.Rou_metered_leg_orientation
        site.Rou_metered_leg_orientation = 0
        ```

### Rou_controlling_leg_orientation {#rou_controlling_leg_orientation}

```csharp
int Rou_controlling_leg_orientation { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int rou_controlling_leg_orientation = site.Rou_controlling_leg_orientation;
        site.Rou_controlling_leg_orientation = 0;
        ```

    === "C++"

        ```cpp
        long rou_controlling_leg_orientation;
        site->get_Rou_controlling_leg_orientation(&rou_controlling_leg_orientation);
        site->put_Rou_controlling_leg_orientation(0);
        ```

    === "Python"

        ```python
        rou_controlling_leg_orientation = site.Rou_controlling_leg_orientation
        site.Rou_controlling_leg_orientation = 0
        ```

### Category {#category}

Site Category

```csharp
string Category { get; set; }
```

**Type** `string`

**Value**

Site Category, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string category = site.Category;
        site.Category = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR category;
        site->get_Category(&category);
        site->put_Category(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        category = site.Category
        site.Category = r"value"
        ```

### IsIncludedInProjectSummary {#isincludedinprojectsummary}

```csharp
bool IsIncludedInProjectSummary { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncludedInProjectSummary = site.IsIncludedInProjectSummary;
        site.IsIncludedInProjectSummary = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncludedInProjectSummary;
        site->get_IsIncludedInProjectSummary(&isIncludedInProjectSummary);
        site->put_IsIncludedInProjectSummary(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included_in_project_summary = site.IsIncludedInProjectSummary
        site.IsIncludedInProjectSummary = True
        ```

### SiteFolder {#sitefolder}

```csharp
ISIAPISiteFolder SiteFolder { get; }
```

**Type** [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteFolder = site.SiteFolder;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteFolder> siteFolder;
        site->get_SiteFolder(&siteFolder);
        ```

    === "Python"

        ```python
        site_folder = site.SiteFolder
        ```

### Is_multi_sequence_enabled {#is_multi_sequence_enabled}

```csharp
bool Is_multi_sequence_enabled { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool is_multi_sequence_enabled = site.Is_multi_sequence_enabled;
        site.Is_multi_sequence_enabled = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL is_multi_sequence_enabled;
        site->get_Is_multi_sequence_enabled(&is_multi_sequence_enabled);
        site->put_Is_multi_sequence_enabled(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_multi_sequence_enabled = site.Is_multi_sequence_enabled
        site.Is_multi_sequence_enabled = True
        ```

### IsUserModel {#isusermodel}

Flag indicating whether the internal SIDRA INTERSECTION Software Setup that is used by this Site 
is a User Software Setup or a Standard Software Setup.

```csharp
bool IsUserModel { get; }
```

**Type** `bool`

**Value**

True if the Software Setup is a User Software Setup. False if the Software Setup is a Standard Software Setup.

???- example "Code samples"

    === "C#"

        ```csharp
        bool isUserModel = site.IsUserModel;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isUserModel;
        site->get_IsUserModel(&isUserModel);
        ```

    === "Python"

        ```python
        is_user_model = site.IsUserModel
        ```

### SiteScenarios {#sitescenarios}

Collection of the Site Scenarios

```csharp
ISIAPISiteScenarios SiteScenarios { get; }
```

**Type** [`ISIAPISiteScenarios`](sidrasolutions.si.api.isiapisitescenarios.md)

**Remarks**

The first Local Scenario is created when creating a Site. This Scenario's Volume Type == 0 (Local). The Site's local 
volumes defined in the Vehicle Approach Movement by Movement Class data (ISIAPIMovement_vehicle_od_mc.Volume) are applied.

More Scenarios that link to Site Volume Bins can be added into a Site.

???- example "Code samples"

    === "C#"

        ```csharp
        var siteScenarios = site.SiteScenarios;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenarios> siteScenarios;
        site->get_SiteScenarios(&siteScenarios);
        ```

    === "Python"

        ```python
        site_scenarios = site.SiteScenarios
        ```

### MapCoordinate {#mapcoordinate}

```csharp
ISIAPIMapCoordinate MapCoordinate { get; }
```

**Type** [`ISIAPIMapCoordinate`](sidrasolutions.si.api.isiapimapcoordinate.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var mapCoordinate = site.MapCoordinate;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIMapCoordinate> mapCoordinate;
        site->get_MapCoordinate(&mapCoordinate);
        ```

    === "Python"

        ```python
        map_coordinate = site.MapCoordinate
        ```

### IsInputDataCompatible {#isinputdatacompatible}

```csharp
bool IsInputDataCompatible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isInputDataCompatible = site.IsInputDataCompatible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isInputDataCompatible;
        site->get_IsInputDataCompatible(&isInputDataCompatible);
        ```

    === "Python"

        ```python
        is_input_data_compatible = site.IsInputDataCompatible
        ```

### IsOutputDataCompatible {#isoutputdatacompatible}

```csharp
bool IsOutputDataCompatible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isOutputDataCompatible = site.IsOutputDataCompatible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isOutputDataCompatible;
        site->get_IsOutputDataCompatible(&isOutputDataCompatible);
        ```

    === "Python"

        ```python
        is_output_data_compatible = site.IsOutputDataCompatible
        ```

### MinViableVersionL1 {#minviableversionl1}

Minimum Viable SIDRA INTERSECTION Version for this Site's Level 1 Compatibility

```csharp
string MinViableVersionL1 { get; }
```

**Type** `string`

**Remarks**

Level 1 Compatibility means that this Site's Input and Output data are fully compatible with 
the current SIDRA INTERSECTION version.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL1 = site.MinViableVersionL1;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL1;
        site->get_MinViableVersionL1(&minViableVersionL1);
        ```

    === "Python"

        ```python
        min_viable_version_l1 = site.MinViableVersionL1
        ```

### MinViableVersionL2 {#minviableversionl2}

Minimum Viable SIDRA INTERSECTION Version for this Site's Level 2 Compatibility

```csharp
string MinViableVersionL2 { get; }
```

**Type** `string`

**Remarks**

Level 2 Compatibility means that some of this Site's Input and Output data are incompatible with 
the current SIDRA INTERSECTION version but the current version is still able to edit these Input data, proccess the Site,  
and access the Output data.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL2, 
ISIAPISite.IsInputDataCompatible return false.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL2 = site.MinViableVersionL2;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL2;
        site->get_MinViableVersionL2(&minViableVersionL2);
        ```

    === "Python"

        ```python
        min_viable_version_l2 = site.MinViableVersionL2
        ```

### MinViableVersionL3 {#minviableversionl3}

Minimum Viable SIDRA INTERSECTION Version for this Site's Level 3 Compatibility

```csharp
string MinViableVersionL3 { get; }
```

**Type** `string`

**Remarks**

Level 3 Compatibility means that this Site's Input data are not compatible with the current SIDRA INTERSECTION version 
but the Output data are compatible. The current version cannot access the Input data or process the Site but can access 
the Output data that were prepared by a later version of SIDRA INTERSECTION.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL3, the Site's Input and Output data 
are not accessible. The Site cannot be processed. ISIAPISite.IsOutputDataCompatible return false.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL3 = site.MinViableVersionL3;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL3;
        site->get_MinViableVersionL3(&minViableVersionL3);
        ```

    === "Python"

        ```python
        min_viable_version_l3 = site.MinViableVersionL3
        ```

## Methods

### Process() {#process}

Processes the Site

```csharp
bool Process()
```

**Returns** `bool` - True, if processing was successful. False, if errors were generated during processing - check `SIDRASolutions.SI.API.ISIAPISite.ProcessingError` for details. Note: The `SIDRASolutions.SI.API.ISIAPISite.HasWarnings` property should always be checked after processing in case warnings were generated. Warnings may occur even if processing was successful.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.Process();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->Process(&result);
        ```

    === "Python"

        ```python
        result = site.Process()
        ```

### ResetMovementVehicleODMCExists() {#resetmovementvehicleodmcexists}

Reset all Movement_vehicle_od_mc.Exists values according to the LaneApproachMovementMC.Exists values (i.e. Lane Disciplines)

```csharp
bool ResetMovementVehicleODMCExists()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.ResetMovementVehicleODMCExists();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->ResetMovementVehicleODMCExists(&result);
        ```

    === "Python"

        ```python
        result = site.ResetMovementVehicleODMCExists()
        ```

### ResetLaneMovements() {#resetlanemovements}

Reset the Lane Movements to the default vaules

```csharp
bool ResetLaneMovements()
```

**Returns** `bool`

**Remarks**

This needs to be called manually after Approach / Exit Lanes are added or removed, or after SIAPILaneApproachMovementMC.Exists (i.e. Lane Discipline) values are changed.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.ResetLaneMovements();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->ResetLaneMovements(&result);
        ```

    === "Python"

        ```python
        result = site.ResetLaneMovements()
        ```

### ResetSitePrioritiesData() {#resetsiteprioritiesdata}

Reset Priority Data to the default vaules

```csharp
bool ResetSitePrioritiesData()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.ResetSitePrioritiesData();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->ResetSitePrioritiesData(&result);
        ```

    === "Python"

        ```python
        result = site.ResetSitePrioritiesData()
        ```

### UpdateModifiedInfo() {#updatemodifiedinfo}

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

```csharp
bool UpdateModifiedInfo()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.UpdateModifiedInfo();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->UpdateModifiedInfo(&result);
        ```

    === "Python"

        ```python
        result = site.UpdateModifiedInfo()
        ```

### AddLeg(int) {#addleg-int}

Add a new Leg to the Site at the specified orientation. The Leg is created automatically without any Approach Lane, Exit Lane or Island.

```csharp
ISIAPILeg AddLeg(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) - The new added Leg

**Remarks**

Call ISIAPISite.UpdateGeometryData() manually after Leg(s) are added or removed.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.AddLeg(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> result;
        site->AddLeg(0, &result);
        ```

    === "Python"

        ```python
        result = site.AddLeg(0)
        ```

### AddLegWithLanes(int, int) {#addlegwithlanes-int--int}

Add a new Leg to the Site at the specified orientation. The Leg is created automatically with a default set of Approach Lanes, Exit Lanes and / or Island depending on the legGeometry parameter.

```csharp
ISIAPILeg AddLegWithLanes(int orientation, int legGeometry)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `legGeometry` | `int` | One of: - `1` - Two Way - `2` - One-Way Approach - `3` - One-Way Exit |

**Returns** [`ISIAPILeg`](sidrasolutions.si.api.isiapileg.md) - The new added Leg

**Remarks**

Call ISIAPISite.UpdateGeometryData() manually after Leg(s) are added or removed.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.AddLegWithLanes(0, 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPILeg> result;
        site->AddLegWithLanes(0, 0, &result);
        ```

    === "Python"

        ```python
        result = site.AddLegWithLanes(0, 0)
        ```

### RemoveLeg(int) {#removeleg-int}

Remove a Leg from the Site.

```csharp
bool RemoveLeg(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if the Leg is successfully removed. This method returns false if the Leg does not exist.

**Remarks**

Call ISIAPISite.UpdateGeometryData() manually after Leg(s) are added or removed.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.RemoveLeg(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->RemoveLeg(0, &result);
        ```

    === "Python"

        ```python
        result = site.RemoveLeg(0)
        ```

### Rotate(int) {#rotate-int}

Rotate the Site.

```csharp
bool Rotate(int step)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `step` | `int` | If step is a positive integer, rotate the Site clockwise. If step is a negative integer, rotate the Site anti-clockwise. One step equals 45 degrees. |

**Returns** `bool`

**Remarks**

If the Site Geometry has been changed, e.g. a Leg or Lane has been added or removed, call the method UpdateGeometryData() to update the Geometry Data before calling this.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.Rotate(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->Rotate(0, &result);
        ```

    === "Python"

        ```python
        result = site.Rotate(0)
        ```

### UpdateGeometryData() {#updategeometrydata}

Update the Geometry Data. Call this method manually after Leg(s) are added / removed, or after Lane(s) are added / removed.

```csharp
bool UpdateGeometryData()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.UpdateGeometryData();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->UpdateGeometryData(&result);
        ```

    === "Python"

        ```python
        result = site.UpdateGeometryData()
        ```

### AddSequence(string) {#addsequence-string}

Add a Sequence. A new Sequence is created and added to this Site.

```csharp
ISIAPISequence AddSequence(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | The name of the new Sequence. |

**Returns** [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) - The new Sequence

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.AddSequence(@"Example");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequence> result;
        site->AddSequence(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = site.AddSequence(r"Example")
        ```

### RemoveSequence(ISIAPISequence) {#removesequence-isiapisequence}

Remove a Sequence from the Site.

```csharp
bool RemoveSequence(ISIAPISequence sequence)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sequence` | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) | The Sequence to remove. |

**Returns** `bool` - true if the Sequence is successfully removed; otherwise, false. This method also returns false if the Sequence does not exist in this Site.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.RemoveSequence(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->RemoveSequence(NULL, &result);
        ```

    === "Python"

        ```python
        result = site.RemoveSequence(None)
        ```

### CreateLayoutPngData() {#createlayoutpngdata}

```csharp
byte[] CreateLayoutPngData()
```

**Returns** `byte[]`

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.CreateLayoutPngData();
        ```

    === "C++"

        ```cpp
        VARIANT result;
        site->CreateLayoutPngData(&result);
        ```

    === "Python"

        ```python
        result = site.CreateLayoutPngData()
        ```

### CreateLayoutPngFile(string) {#createlayoutpngfile-string}

```csharp
bool CreateLayoutPngFile(string filename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `filename` | `string` |  |

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.CreateLayoutPngFile(@"C:\path\to\project.sipx");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->CreateLayoutPngFile(CComBSTR(L"C:\\path\\to\\project.sipx"), &result);
        ```

    === "Python"

        ```python
        result = site.CreateLayoutPngFile(r"C:\path\to\project.sipx")
        ```

### CloneSequence(ISIAPISequence) {#clonesequence-isiapisequence}

Clone a Sequence.

```csharp
ISIAPISequence CloneSequence(ISIAPISequence sequence)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sequence` | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) | The Sequence to be cloned. |

**Returns** [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) - The new cloned Sequence.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.CloneSequence(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISequence> result;
        site->CloneSequence(NULL, &result);
        ```

    === "Python"

        ```python
        result = site.CloneSequence(None)
        ```

### MoveSequenceTo(ISIAPISequence, int) {#movesequenceto-isiapisequence--int}

Move a Sequence to a new position.

```csharp
bool MoveSequenceTo(ISIAPISequence sequence, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sequence` | [`ISIAPISequence`](sidrasolutions.si.api.isiapisequence.md) | The Sequence to move. |
| `newPosition` | `int` | The zero-based position that the Sequence should be moved to. |

**Returns** `bool` - true if the Sequence is successfully moved; otherwise, false. This method also returns false if the Sequence does not exist in this Site.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.MoveSequenceTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->MoveSequenceTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = site.MoveSequenceTo(None, 0)
        ```

### RemoveOutputData() {#removeoutputdata}

Remove this Site and relevant Networks' Output data.

```csharp
bool RemoveOutputData()
```

**Returns** `bool` - true if the Output data are successfully removed

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.RemoveOutputData();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->RemoveOutputData(&result);
        ```

    === "Python"

        ```python
        result = site.RemoveOutputData()
        ```

### AddSiteScenario(ISIAPISiteVolumeBin) {#addsitescenario-isiapisitevolumebin}

Add a new Site Scenario that links to a Site Volume Bin.

```csharp
ISIAPISiteScenario AddSiteScenario(ISIAPISiteVolumeBin siteVolumeBin)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin` | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | The Site Volume Bin to be linked to the new Site Scenario. |

**Returns** [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) - The new added Site Scenario.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.AddSiteScenario(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenario> result;
        site->AddSiteScenario(NULL, &result);
        ```

    === "Python"

        ```python
        result = site.AddSiteScenario(None)
        ```

### RemoveSiteScenario(ISIAPISiteScenario) {#removesitescenario-isiapisitescenario}

Remove a Site Scenario from this Site.

```csharp
bool RemoveSiteScenario(ISIAPISiteScenario siteScenario)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteScenario` | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | The Site Scenario to remove. |

**Returns** `bool` - true if the Site Scenario is successfully removed; otherwise, false. This method also returns false if the Site Scenario does not exist in this Site.

**Remarks**

The first Site Local Scenario that links to the Site Local Volumes data cannot be removed.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.RemoveSiteScenario(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->RemoveSiteScenario(NULL, &result);
        ```

    === "Python"

        ```python
        result = site.RemoveSiteScenario(None)
        ```

### CloneSiteScenario(ISIAPISiteScenario) {#clonesitescenario-isiapisitescenario}

Clone a Site Scenario.

```csharp
ISIAPISiteScenario CloneSiteScenario(ISIAPISiteScenario siteScenario)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteScenario` | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | The Site Scenario to be cloned. |

**Returns** [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) - The new cloned Site Scenario.

**Remarks**

The first Site Local Scenario that links to the Site Local Volumes data cannot be cloned.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = site.CloneSiteScenario(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenario> result;
        site->CloneSiteScenario(NULL, &result);
        ```

    === "Python"

        ```python
        result = site.CloneSiteScenario(None)
        ```

### MoveSiteScenarioTo(ISIAPISiteScenario, int) {#movesitescenarioto-isiapisitescenario--int}

Move a Site Scenario to a new position in the collection.

```csharp
bool MoveSiteScenarioTo(ISIAPISiteScenario siteScenario, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteScenario` | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | The Site Scenario to move. |
| `newPosition` | `int` | The zero-based position that the Site Scenario should be moved to. The newPosition cannot be 0 because it is for the Site Local Scenario that links to the Site Local Volumes data. |

**Returns** `bool` - true if the Site Scenario is successfully moved; otherwise, false. This method also returns false if the Site Scenario does not exist in this Site.

**Remarks**

The first Site Local Scenario that links to the Site Local Volumes data cannot be moved. The other Scenarios cannot be moved to the first, i.e. Position 0.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = site.MoveSiteScenarioTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        site->MoveSiteScenarioTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = site.MoveSiteScenarioTo(None, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitefolder.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteFolder
title: SiteFolder
name: ISIAPISiteFolder
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 1C46EBD8-6483-441F-8BF6-73B68FA734F2
summary: SiteFolder wrapper interface
members:
  - ISIAPISite AddSite(int siteType, int softwareSetup)
  - ISIAPISite AddSiteWithGeometry(int siteType, int softwareSetup, int majorRoadOrientation)
  - ISIAPISite AddSite(int siteType, string softwareSetupSignature)
  - ISIAPISite AddSiteWithGeometry(int siteType, string softwareSetupSignature, int majorRoadOrientation)
  - bool RemoveSite(ISIAPISite site)
  - ISIAPISite CloneSite(ISIAPISite site)
  - bool MoveSiteTo(ISIAPISite site, int newPosition)
  - int MoveSitesToFolder(string siteNames, ISIAPISiteFolder destFolder)
  - string Name
  - int Position
  - ISIAPISites Sites
  - ISIAPIProject Project
---

# SiteFolder

Type `ISIAPISiteFolder` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `1C46EBD8-6483-441F-8BF6-73B68FA734F2`

SiteFolder wrapper interface

## Declaration

```csharp
[Guid("1C46EBD8-6483-441F-8BF6-73B68FA734F2")]
public interface ISIAPISiteFolder
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | SiteFolder name |
| [Position](#position) | `int` | This SiteFolder Position in the collection. It is a zero-base integer. |
| [Sites](#sites) | [`ISIAPISites`](sidrasolutions.si.api.isiapisites.md) | Collection of Sites in this SiteFolder |
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddSite(int, int)](#addsite-int--int) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Add a new Site into this SiteFolder. The Site is created automatically without the Geometry data ( e.g. Legs and Lanes) or Phasing and Timing data. The Site is created by using a Standard Software Setup. |
| [AddSite(int, string)](#addsite-int--string) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Add a new Site into this SiteFolder. The Site is created automatically without the Geometry data ( e.g. Legs and Lanes) or Phasing and Timing data. The Site is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature. |
| [AddSiteWithGeometry(int, int, int)](#addsitewithgeometry-int--int--int) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Add a new Site into this SiteFolder. The Site is created automatically with the default Geometry data, e.g. Legs and Lanes. If it is a Signalised Site, the default set of Sequences and Phases are added. The Site is created by using a Standard Software Setup. |
| [AddSiteWithGeometry(int, string, int)](#addsitewithgeometry-int--string--int) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Add a new Site into this SiteFolder. The Site is created automatically with the default Geometry data, e.g. Legs and Lanes. If it is a Signalised Site, the default set of Sequences and Phases are added. The Site is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature. |
| [RemoveSite(ISIAPISite)](#removesite-isiapisite) | `bool` | Remove a Site from this SiteFolder. |
| [CloneSite(ISIAPISite)](#clonesite-isiapisite) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Clone a Site. |
| [MoveSiteTo(ISIAPISite, int)](#movesiteto-isiapisite--int) | `bool` | Move a Site to a new position in the same SiteFolder. |
| [MoveSitesToFolder(string, ISIAPISiteFolder)](#movesitestofolder-string--isiapisitefolder) | `int` | Move Site(s) from this Site Folder to another Site Folder in this Project. |

</div>

## Properties

### Name {#name}

SiteFolder name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The SiteFolder name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = siteFolder.Name;
        siteFolder.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        siteFolder->get_Name(&name);
        siteFolder->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = siteFolder.Name
        siteFolder.Name = r"Example"
        ```

### Position {#position}

This SiteFolder Position in the collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = siteFolder.Position;
        ```

    === "C++"

        ```cpp
        long position;
        siteFolder->get_Position(&position);
        ```

    === "Python"

        ```python
        position = siteFolder.Position
        ```

### Sites {#sites}

Collection of Sites in this SiteFolder

```csharp
ISIAPISites Sites { get; }
```

**Type** [`ISIAPISites`](sidrasolutions.si.api.isiapisites.md)

**Value**

Sites collection

???- example "Code samples"

    === "C#"

        ```csharp
        var sites = siteFolder.Sites;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISites> sites;
        siteFolder->get_Sites(&sites);
        ```

    === "Python"

        ```python
        sites = siteFolder.Sites
        ```

### Project {#project}

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var project = siteFolder.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        siteFolder->get_Project(&project);
        ```

    === "Python"

        ```python
        project = siteFolder.Project
        ```

## Methods

### AddSite(int, int) {#addsite-int--int}

Add a new Site into this SiteFolder. The Site is created automatically without the Geometry data ( e.g. Legs and Lanes) or Phasing and Timing data.  
The Site is created by using a Standard Software Setup.

```csharp
ISIAPISite AddSite(int siteType, int softwareSetup)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteType` | `int` | One of: - Site Intersection Type: - `0` - At-Grade Intersection - `1` - Roundabout (Unsignalised) - `2` - Giveway / Yield (Two-Way) - `3` - Stop (Two-Way) - `4` - Stop (All-Way) - `7` - Roundabout (Metering Signals) |
| `softwareSetup` | `int` | One of: - Standard Software Setup that is used to create the Site - `1` - Standard Left - `2` - New Zealand - `3` - New South Wales - `4` - Standard Right - `5` - US HCM (Metric) - `6` - US HCM (Customary) |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) - The new added Site.

**Remarks**

"Single Point Interchange", "Pedestrian Crossing", "Arterial Segment", "Freeway Segment" or "Turbo Roundabout" Site cannot be created by this method. Use the method AddSiteWithGeometry() to add these Sites.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteFolder.AddSite(0, 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        siteFolder->AddSite(0, 0, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.AddSite(0, 0)
        ```

### AddSite(int, string) {#addsite-int--string}

Add a new Site into this SiteFolder. The Site is created automatically without the Geometry data ( e.g. Legs and Lanes) or Phasing and Timing data.  
The Site is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.

```csharp
ISIAPISite AddSite(int siteType, string softwareSetupSignature)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteType` | `int` | One of: - Site Intersection Type: - `0` - At-Grade Intersection - `1` - Roundabout (Unsignalised) - `2` - Giveway / Yield (Two-Way) - `3` - Stop (Two-Way) - `4` - Stop (All-Way) - `7` - Roundabout (Metering Signals) |
| `softwareSetupSignature` | `string` | The signature string of a User Software Setup or a Standard Software Setup. |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) - The new added Site.

**Remarks**

"Single Point Interchange", "Pedestrian Crossing", "Arterial Segment", "Freeway Segment" or "Turbo Roundabout" Site cannot be created by this method. Use the method AddSiteWithGeometry() to add these Sites.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteFolder.AddSite(0, @"value");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        siteFolder->AddSite(0, CComBSTR(L"value"), &result);
        ```

    === "Python"

        ```python
        result = siteFolder.AddSite(0, r"value")
        ```

### AddSiteWithGeometry(int, int, int) {#addsitewithgeometry-int--int--int}

Add a new Site into this SiteFolder. The Site is created automatically with the default Geometry data, e.g. Legs and Lanes. If it is a Signalised Site, the default set of Sequences and Phases are added.  
The Site is created by using a Standard Software Setup.

```csharp
ISIAPISite AddSiteWithGeometry(int siteType, int softwareSetup, int majorRoadOrientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteType` | `int` | One of: - Site Intersection Type: - `0` - At-Grade Intersection - `1` - Roundabout (Unsignalised) - `2` - Giveway / Yield (Two-Way) - `3` - Stop (Two-Way) - `4` - Stop (All-Way) - `5` - Single Point Interchange (Signals) - `6` - Pedestrian Crossing (Signalised) - `7` - Roundabout (Metering Signals) - `8` - Pedestrian Crossing (Unsignalised) - `9` - Arterial Segment - `10` - Freeway Basic Segment - `11` - Freeway Segment with Ramps (Two-Way) - `12` - Freeway Segment with Ramps (One-Way) - `13` - Turbo Roundabout |
| `softwareSetup` | `int` | One of: - Standard Software Setup that is used to create the Site - `1` - Standard Left - `2` - New Zealand - `3` - New South Wales - `4` - Standard Right - `5` - US HCM (Metric) - `6` - US HCM (Customary) |
| `majorRoadOrientation` | `int` | One of: - Major Road Orientation, for Giveway / Yield (Two-Way) or Stop (Two-Way) Site only. This parameter is ignored on the other types of Sites - `0` - Major Road on North and South - `1` - Major Road on NorthWest and SouthEast - `2` - Major Road on East and West - `3` - Major Road on NorthEast and SouthWest |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) - The new added Site.

**Remarks**

If the default Legs do not match the actual Geometry Layout, they can be changed by rotating the Site, removing Leg(s) or adding Leg(s) to the Site.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteFolder.AddSiteWithGeometry(0, 0, 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        siteFolder->AddSiteWithGeometry(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.AddSiteWithGeometry(0, 0, 0)
        ```

### AddSiteWithGeometry(int, string, int) {#addsitewithgeometry-int--string--int}

Add a new Site into this SiteFolder. The Site is created automatically with the default Geometry data, e.g. Legs and Lanes. If it is a Signalised Site, the default set of Sequences and Phases are added.  
The Site is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.

```csharp
ISIAPISite AddSiteWithGeometry(int siteType, string softwareSetupSignature, int majorRoadOrientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteType` | `int` | One of: - Site Intersection Type: - `0` - At-Grade Intersection - `1` - Roundabout (Unsignalised) - `2` - Giveway / Yield (Two-Way) - `3` - Stop (Two-Way) - `4` - Stop (All-Way) - `5` - Single Point Interchange (Signals) - `6` - Pedestrian Crossing (Signalised) - `7` - Roundabout (Metering Signals) - `8` - Pedestrian Crossing (Unsignalised) - `9` - Arterial Segment - `10` - Freeway Basic Segment - `11` - Freeway Segment with Ramps (Two-Way) - `12` - Freeway Segment with Ramps (One-Way) - `13` - Turbo Roundabout |
| `softwareSetupSignature` | `string` | The signature string of a User Software Setup or a Standard Software Setup. |
| `majorRoadOrientation` | `int` | One of: - Major Road Orientation, for Giveway / Yield (Two-Way) or Stop (Two-Way) Site only. This parameter is ignored on the other types of Sites - `0` - Major Road on North and South - `1` - Major Road on NorthWest and SouthEast - `2` - Major Road on East and West - `3` - Major Road on NorthEast and SouthWest |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) - The new added Site.

**Remarks**

If the default Legs do not match the actual Geometry Layout, they can be changed by rotating the Site, removing Leg(s) or adding Leg(s) to the Site.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteFolder.AddSiteWithGeometry(0, @"value", 0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        siteFolder->AddSiteWithGeometry(0, CComBSTR(L"value"), 0, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.AddSiteWithGeometry(0, r"value", 0)
        ```

### RemoveSite(ISIAPISite) {#removesite-isiapisite}

Remove a Site from this SiteFolder.

```csharp
bool RemoveSite(ISIAPISite site)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `site` | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | The Site to remove. |

**Returns** `bool` - true if the Site is successfully removed; otherwise, false. This method also returns false if the Site does not exist in this SiteFolder.

**Remarks**

The Site cannot be used in any Networks.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteFolder.RemoveSite(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteFolder->RemoveSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.RemoveSite(None)
        ```

### CloneSite(ISIAPISite) {#clonesite-isiapisite}

Clone a Site.

```csharp
ISIAPISite CloneSite(ISIAPISite site)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `site` | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | The Site to be cloned. |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) - The new cloned Site.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteFolder.CloneSite(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        siteFolder->CloneSite(NULL, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.CloneSite(None)
        ```

### MoveSiteTo(ISIAPISite, int) {#movesiteto-isiapisite--int}

Move a Site to a new position in the same SiteFolder.

```csharp
bool MoveSiteTo(ISIAPISite site, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `site` | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | The Site to move. |
| `newPosition` | `int` | The zero-based position that the Site should be moved to. |

**Returns** `bool` - true if the Site is successfully moved; otherwise, false. This method also returns false if the Site does not exist in this SiteFolder.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteFolder.MoveSiteTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteFolder->MoveSiteTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.MoveSiteTo(None, 0)
        ```

### MoveSitesToFolder(string, ISIAPISiteFolder) {#movesitestofolder-string--isiapisitefolder}

Move Site(s) from this Site Folder to another Site Folder in this Project.

```csharp
int MoveSitesToFolder(string siteNames, ISIAPISiteFolder destFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteNames` | `string` | The name(s) of the Site(s) to move. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples: |
| `destFolder` | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | The destination Site Folder |

**Returns** `int` - The number of successfully moved Sites

**Remarks**

If Site(s) to move are used in Network(s). All the Sites in the Network(s) are required to move together to another folder 
because all Sites in a Network need to be in the same folder.

???- example "Code samples"

    === "C#"

        ```csharp
        int result = siteFolder.MoveSitesToFolder(@"Main Intersection", null);
        ```

    === "C++"

        ```cpp
        long result;
        siteFolder->MoveSitesToFolder(CComBSTR(L"Main Intersection"), NULL, &result);
        ```

    === "Python"

        ```python
        result = siteFolder.MoveSitesToFolder(r"Main Intersection", None)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitefolders.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteFolders
title: SiteFolders
name: ISIAPISiteFolders
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 422C915D-C65C-4E49-BE6A-9F77C6E031BE
summary: SiteFolder collection wrapper interface
members:
  - bool SiteFolderExists(string name)
  - ISIAPISiteFolder this[string name]
  - ISIAPISiteFolder this[int index]
  - int Count
---

# SiteFolders

Type `ISIAPISiteFolders` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `422C915D-C65C-4E49-BE6A-9F77C6E031BE`

SiteFolder collection wrapper interface

## Declaration

```csharp
[Guid("422C915D-C65C-4E49-BE6A-9F77C6E031BE")]
public interface ISIAPISiteFolders
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of SiteFolders contained in the collection. |
| [this[]](#this) | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | Get the SiteFolder from the collection by the SiteFolder name. |
| [this[]](#this) | [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md) | Get the SiteFolder at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SiteFolderExists(string)](#sitefolderexists-string) | `bool` | Queries whether a particular SiteFolder exists in the collection |

</div>

## Properties

### Count {#count}

Gets the number of SiteFolders contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteFolders.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteFolders->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteFolders.Count
        ```

### this[] {#this}

Get the SiteFolder from the collection by the SiteFolder name.

```csharp
ISIAPISiteFolder this[] { get; }
```

**Type** [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md)

**Remarks**

The SiteFolder name is not unique in the collection. It is possible that more than one SiteFolder has the same name.
The first SiteFolder found by name is returned. If no SiteFolder is found, null / Nothing is returned.

In C#, use ISIAPISiteFolders[] to get a SiteFolder by its name or its position in the collection.  
In VBA, use Item() to get a SiteFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteFolder> this[];
        siteFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteFolders.this[]
        ```

### this[] {#this}

Get the SiteFolder at the specified index.

```csharp
ISIAPISiteFolder this[] { get; }
```

**Type** [`ISIAPISiteFolder`](sidrasolutions.si.api.isiapisitefolder.md)

**Remarks**

In C#, use ISIAPISiteFolders[] to get a SiteFolder by its name or its position in the collection.  
In VBA, use Item() to get a SiteFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteFolder> this[];
        siteFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteFolders.this[]
        ```

## Methods

### SiteFolderExists(string) {#sitefolderexists-string}

Queries whether a particular SiteFolder exists in the collection

```csharp
bool SiteFolderExists(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | SiteFolder name to query |

**Returns** `bool` - True, if any SiteFolder with the given name exists in the collection. False otherwise

**Remarks**

The SiteFolder name is not unique in the collection. It is possible that more than one SiteFolder has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteFolders.SiteFolderExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteFolders->SiteFolderExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = siteFolders.SiteFolderExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisites.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISites
title: Sites
name: ISIAPISites
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 625B0EF4-D136-4519-ABEF-8D442950790A
summary: Site collection wrapper interface
members:
  - bool SiteExists(string sitename)
  - ISIAPISite GetSiteByID(string site_id)
  - ISIAPISite this[string sitename]
  - ISIAPISite this[int index]
  - int Count
---

# Sites

Type `ISIAPISites` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `625B0EF4-D136-4519-ABEF-8D442950790A`

Site collection wrapper interface

## Declaration

```csharp
[Guid("625B0EF4-D136-4519-ABEF-8D442950790A")]
public interface ISIAPISites
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of Sites contained in the collection. |
| [this[]](#this) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Get the Site from the collection by the Site name. |
| [this[]](#this) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Get the Site at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SiteExists(string)](#siteexists-string) | `bool` | Queries whether a particular Site exists in the collection by its name. |
| [GetSiteByID(string)](#getsitebyid-string) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) | Get the Site by its GUID. |

</div>

## Properties

### Count {#count}

Gets the number of Sites contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = sites.Count;
        ```

    === "C++"

        ```cpp
        long count;
        sites->get_Count(&count);
        ```

    === "Python"

        ```python
        count = sites.Count
        ```

### this[] {#this}

Get the Site from the collection by the Site name.

```csharp
ISIAPISite this[] { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

**Remarks**

The Site name is not unique in the collection. It is possible that more than one Site has the same name. 
The first Site found by name is returned. If no Site is found, null / Nothing is returned.

In C#, use ISIAPISites[] to get a Site by its name or its position in the collection.  
In VBA, use Item() to get a Site by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a Site by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = sites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> this[];
        sites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = sites.this[]
        ```

### this[] {#this}

Get the Site at the specified index.

```csharp
ISIAPISite this[] { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

**Remarks**

In C#, use ISIAPISites[] to get a Site by its name or its position in the collection.  
In VBA, use Item() to get a Site by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a Site by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = sites.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> this[];
        sites->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = sites.this[]
        ```

## Methods

### SiteExists(string) {#siteexists-string}

Queries whether a particular Site exists in the collection by its name.

```csharp
bool SiteExists(string sitename)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `sitename` | `string` | Site name to query |

**Returns** `bool` - True, if any Site with the given name exists in the collection. False otherwise

**Remarks**

The Site name is not unique in the collection. It is possible that more than one Site has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = sites.SiteExists(@"Main Intersection");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        sites->SiteExists(CComBSTR(L"Main Intersection"), &result);
        ```

    === "Python"

        ```python
        result = sites.SiteExists(r"Main Intersection")
        ```

### GetSiteByID(string) {#getsitebyid-string}

Get the Site by its GUID.

```csharp
ISIAPISite GetSiteByID(string site_id)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `site_id` | `string` | The GUID of the Site object, i.e. ISIAPISite.Site_id. This is different from the "Site ID" in the Intersection dialog, i.e. ISIAPISite.Intersectionid. |

**Returns** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = sites.GetSiteByID(@"id-1");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> result;
        sites->GetSiteByID(CComBSTR(L"id-1"), &result);
        ```

    === "Python"

        ```python
        result = sites.GetSiteByID(r"id-1")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitescenario.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteScenario
title: SiteScenario
name: ISIAPISiteScenario
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 57A33882-9109-4551-BA83-0398584E5C57
members:
  - string Name
  - string ID
  - int Position
  - int VolumeType
  - bool Analyse
  - ISIAPISite Site
  - ISIAPISiteVolumeBin SiteVolumeBin
---

# SiteScenario

Type `ISIAPISiteScenario` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `57A33882-9109-4551-BA83-0398584E5C57`

## Declaration

```csharp
[Guid("57A33882-9109-4551-BA83-0398584E5C57")]
public interface ISIAPISiteScenario
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | Site Scenario name |
| [ID](#id) | `string` | Site Scenario ID in the Site Scenarios dialog and reports. |
| [Position](#position) | `int` |  |
| [VolumeType](#volumetype) | `int` | Site Scenario Volume Type |
| [Analyse](#analyse) | `bool` | Flag indicating this Site Scenario is applied to the Site. |
| [Site](#site) | [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md) |  |
| [SiteVolumeBin](#sitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Site Volume Bin that is linked to this Scenario. |

</div>

## Properties

### Name {#name}

Site Scenario name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The Site Scenario name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = siteScenario.Name;
        siteScenario.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        siteScenario->get_Name(&name);
        siteScenario->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = siteScenario.Name
        siteScenario.Name = r"Example"
        ```

### ID {#id}

Site Scenario ID in the Site Scenarios dialog and reports.

```csharp
string ID { get; set; }
```

**Type** `string`

**Value**

Site Scenario ID, max length = 10.

???- example "Code samples"

    === "C#"

        ```csharp
        string iD = siteScenario.ID;
        siteScenario.ID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR iD;
        siteScenario->get_ID(&iD);
        siteScenario->put_ID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        id = siteScenario.ID
        siteScenario.ID = r"id-1"
        ```

### Position {#position}

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = siteScenario.Position;
        ```

    === "C++"

        ```cpp
        long position;
        siteScenario->get_Position(&position);
        ```

    === "Python"

        ```python
        position = siteScenario.Position
        ```

### VolumeType {#volumetype}

Site Scenario Volume Type

```csharp
int VolumeType { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Local, the Site's local volumes are applied
- `1` - Linked, the linked SiteVolumeBin's volumes are applied

???- example "Code samples"

    === "C#"

        ```csharp
        int volumeType = siteScenario.VolumeType;
        ```

    === "C++"

        ```cpp
        long volumeType;
        siteScenario->get_VolumeType(&volumeType);
        ```

    === "Python"

        ```python
        volume_type = siteScenario.VolumeType
        ```

### Analyse {#analyse}

Flag indicating this Site Scenario is applied to the Site.

```csharp
bool Analyse { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool analyse = siteScenario.Analyse;
        siteScenario.Analyse = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL analyse;
        siteScenario->get_Analyse(&analyse);
        siteScenario->put_Analyse(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        analyse = siteScenario.Analyse
        siteScenario.Analyse = True
        ```

### Site {#site}

```csharp
ISIAPISite Site { get; }
```

**Type** [`ISIAPISite`](sidrasolutions.si.api.isiapisite.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var site = siteScenario.Site;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISite> site;
        siteScenario->get_Site(&site);
        ```

    === "Python"

        ```python
        site = siteScenario.Site
        ```

### SiteVolumeBin {#sitevolumebin}

Site Volume Bin that is linked to this Scenario.

```csharp
ISIAPISiteVolumeBin SiteVolumeBin { get; set; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

**Remarks**

This SiteVolumeBin property only applies to the SiteScenario which VolumeType == 1 (Linked).

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBin = siteScenario.SiteVolumeBin;
        siteScenario.SiteVolumeBin = null;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
        siteScenario->get_SiteVolumeBin(&siteVolumeBin);
        siteScenario->put_SiteVolumeBin(NULL);
        ```

    === "Python"

        ```python
        site_volume_bin = siteScenario.SiteVolumeBin
        siteScenario.SiteVolumeBin = None
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitescenarios.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteScenarios
title: SiteScenarios
name: ISIAPISiteScenarios
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 88B31F79-E79E-4201-AE13-1D3C94EA14C5
members:
  - bool SiteScenarioExists(string siteScenarioName)
  - ISIAPISiteScenario this[string siteScenarioName]
  - ISIAPISiteScenario this[int index]
  - int Count
---

# SiteScenarios

Type `ISIAPISiteScenarios` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `88B31F79-E79E-4201-AE13-1D3C94EA14C5`

## Declaration

```csharp
[Guid("88B31F79-E79E-4201-AE13-1D3C94EA14C5")]
public interface ISIAPISiteScenarios
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of SiteScenarios contained in the collection. |
| [this[]](#this) | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | Get the SiteScenario from the collection by its name. |
| [this[]](#this) | [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md) | Get the SiteScenario at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SiteScenarioExists(string)](#sitescenarioexists-string) | `bool` | Queries whether a particular SiteScenario exists in the collection by its name. |

</div>

## Properties

### Count {#count}

Gets the number of SiteScenarios contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteScenarios.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteScenarios->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteScenarios.Count
        ```

### this[] {#this}

Get the SiteScenario from the collection by its name.

```csharp
ISIAPISiteScenario this[] { get; }
```

**Type** [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md)

**Remarks**

The SiteScenario name is not unique in the collection. It is possible that more than one SiteScenario has the same name. 
The first SiteScenario found by name is returned. If no SiteScenario is found, null / Nothing is returned.

In C#, use ISIAPISiteScenarios[] to get a SiteScenario by its name or its position in the collection.  
In VBA, use Item() to get a SiteScenario by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteScenario by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteScenarios.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenario> this[];
        siteScenarios->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteScenarios.this[]
        ```

### this[] {#this}

Get the SiteScenario at the specified index.

```csharp
ISIAPISiteScenario this[] { get; }
```

**Type** [`ISIAPISiteScenario`](sidrasolutions.si.api.isiapisitescenario.md)

**Remarks**

In C#, use ISIAPISiteScenarios[] to get a SiteScenario by its name or its position in the collection.  
In VBA, use Item() to get a SiteScenario by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteScenario by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteScenarios.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteScenario> this[];
        siteScenarios->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteScenarios.this[]
        ```

## Methods

### SiteScenarioExists(string) {#sitescenarioexists-string}

Queries whether a particular SiteScenario exists in the collection by its name.

```csharp
bool SiteScenarioExists(string siteScenarioName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteScenarioName` | `string` | SiteScenario name to query |

**Returns** `bool` - True, if any SiteScenario with the given name exists in the collection. False otherwise

**Remarks**

The SiteScenario name is not unique in the collection. It is possible that more than one SiteScenario has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteScenarios.SiteScenarioExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteScenarios->SiteScenarioExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = siteScenarios.SiteScenarioExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumebin.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeBin
title: SiteVolumeBin
name: ISIAPISiteVolumeBin
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 390838EE-09C7-472E-B3AB-FAE18E33AC81
summary: SiteVolumeBin wrapper interface
members:
  - bool UpdateModifiedInfo()
  - string SiteVolumeBin_id
  - string Name
  - string ID
  - int Position
  - bool IsInputDataCompatible
  - string MinViableVersionL1
  - string MinViableVersionL2
  - bool DriveOnLeft
  - int Units
  - string Title
  - string Description
  - int UnitTimeForVolumes
  - int PeakFlowPeriod
  - int HoursPerYear
  - DateTime Created_date
  - string Created_by
  - string Created_by_company
  - string Created_version
  - DateTime Modified_date
  - string Modified_by
  - string Modified_by_company
  - string Modified_version
  - string LastErrorMessage
  - ISIAPISiteVolumeBinFolder SiteVolumeBinFolder
  - ISIAPISiteVolumeMCs SiteVolumeMCs
  - ISIAPISiteVolumeLegs SiteVolumeLegs
  - ISIAPISiteVolumeMovVehODs SiteVolumeMovVehODs
  - ISIAPISiteVolumeMovPeds SiteVolumeMovPeds
---

# SiteVolumeBin

Type `ISIAPISiteVolumeBin` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `390838EE-09C7-472E-B3AB-FAE18E33AC81`

SiteVolumeBin wrapper interface

## Declaration

```csharp
[Guid("390838EE-09C7-472E-B3AB-FAE18E33AC81")]
public interface ISIAPISiteVolumeBin
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [SiteVolumeBin_id](#sitevolumebin_id) | `string` | The GUID of the Site Volume Bin object. |
| [Name](#name) | `string` | Site Volume Bin Name |
| [ID](#id) | `string` | Site Volume Bin ID in the Site Bin Setup dialog |
| [Position](#position) | `int` |  |
| [IsInputDataCompatible](#isinputdatacompatible) | `bool` |  |
| [MinViableVersionL1](#minviableversionl1) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 1 Compatibility |
| [MinViableVersionL2](#minviableversionl2) | `string` | Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 2 Compatibility |
| [DriveOnLeft](#driveonleft) | `bool` | Flag indicating the "Drive Rule" of the Site Volume Bin |
| [Units](#units) | `int` | General unit system used for data within the Site Volume Bin |
| [Title](#title) | `string` | Site Volume Bin title |
| [Description](#description) | `string` | Site Volume Bin description |
| [UnitTimeForVolumes](#unittimeforvolumes) | `int` | Unit time for traffic volumes in minutes |
| [PeakFlowPeriod](#peakflowperiod) | `int` | Peak flow period in minutes |
| [HoursPerYear](#hoursperyear) | `int` |  |
| [Created_date](#created_date) | `DateTime` |  |
| [Created_by](#created_by) | `string` |  |
| [Created_by_company](#created_by_company) | `string` |  |
| [Created_version](#created_version) | `string` |  |
| [Modified_date](#modified_date) | `DateTime` |  |
| [Modified_by](#modified_by) | `string` |  |
| [Modified_by_company](#modified_by_company) | `string` |  |
| [Modified_version](#modified_version) | `string` |  |
| [LastErrorMessage](#lasterrormessage) | `string` |  |
| [SiteVolumeBinFolder](#sitevolumebinfolder) | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) |  |
| [SiteVolumeMCs](#sitevolumemcs) | [`ISIAPISiteVolumeMCs`](sidrasolutions.si.api.isiapisitevolumemcs.md) |  |
| [SiteVolumeLegs](#sitevolumelegs) | [`ISIAPISiteVolumeLegs`](sidrasolutions.si.api.isiapisitevolumelegs.md) | Site Volume Legs in this Volume Bin All eight Legs are created when creating a Site Volume Bin. The South, East, North and West Legs' Geometry are set to 1 (Two Way), the other Legs' Geometry are set to 0 ('No Leg') by default. |
| [SiteVolumeMovVehODs](#sitevolumemovvehods) | [`ISIAPISiteVolumeMovVehODs`](sidrasolutions.si.api.isiapisitevolumemovvehods.md) |  |
| [SiteVolumeMovPeds](#sitevolumemovpeds) | [`ISIAPISiteVolumeMovPeds`](sidrasolutions.si.api.isiapisitevolumemovpeds.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [UpdateModifiedInfo()](#updatemodifiedinfo) | `bool` | Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number |

</div>

## Properties

### SiteVolumeBin_id {#sitevolumebin_id}

The GUID of the Site Volume Bin object.

```csharp
string SiteVolumeBin_id { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string siteVolumeBin_id = siteVolumeBin.SiteVolumeBin_id;
        ```

    === "C++"

        ```cpp
        CComBSTR siteVolumeBin_id;
        siteVolumeBin->get_SiteVolumeBin_id(&siteVolumeBin_id);
        ```

    === "Python"

        ```python
        site_volume_bin_id = siteVolumeBin.SiteVolumeBin_id
        ```

### Name {#name}

Site Volume Bin Name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

Site Volume Bin Name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = siteVolumeBin.Name;
        siteVolumeBin.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        siteVolumeBin->get_Name(&name);
        siteVolumeBin->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = siteVolumeBin.Name
        siteVolumeBin.Name = r"Example"
        ```

### ID {#id}

Site Volume Bin ID in the Site Bin Setup dialog

```csharp
string ID { get; set; }
```

**Type** `string`

**Value**

Site Volume Bin ID, max length = 10.

???- example "Code samples"

    === "C#"

        ```csharp
        string iD = siteVolumeBin.ID;
        siteVolumeBin.ID = @"id-1";
        ```

    === "C++"

        ```cpp
        CComBSTR iD;
        siteVolumeBin->get_ID(&iD);
        siteVolumeBin->put_ID(CComBSTR(L"id-1"));
        ```

    === "Python"

        ```python
        id = siteVolumeBin.ID
        siteVolumeBin.ID = r"id-1"
        ```

### Position {#position}

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = siteVolumeBin.Position;
        ```

    === "C++"

        ```cpp
        long position;
        siteVolumeBin->get_Position(&position);
        ```

    === "Python"

        ```python
        position = siteVolumeBin.Position
        ```

### IsInputDataCompatible {#isinputdatacompatible}

```csharp
bool IsInputDataCompatible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isInputDataCompatible = siteVolumeBin.IsInputDataCompatible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isInputDataCompatible;
        siteVolumeBin->get_IsInputDataCompatible(&isInputDataCompatible);
        ```

    === "Python"

        ```python
        is_input_data_compatible = siteVolumeBin.IsInputDataCompatible
        ```

### MinViableVersionL1 {#minviableversionl1}

Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 1 Compatibility

```csharp
string MinViableVersionL1 { get; }
```

**Type** `string`

**Remarks**

Level 1 Compatibility means that this Site Volume Bin's Input data are fully compatible with 
the current SIDRA INTERSECTION version.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL1 = siteVolumeBin.MinViableVersionL1;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL1;
        siteVolumeBin->get_MinViableVersionL1(&minViableVersionL1);
        ```

    === "Python"

        ```python
        min_viable_version_l1 = siteVolumeBin.MinViableVersionL1
        ```

### MinViableVersionL2 {#minviableversionl2}

Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 2 Compatibility

```csharp
string MinViableVersionL2 { get; }
```

**Type** `string`

**Remarks**

Level 2 Compatibility means that some of this Site Volume Bin's Input data are incompatible with 
the current SIDRA INTERSECTION version but the current version is still able to edit these Input data.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL2, 
ISIAPISiteVolumeBin.IsInputDataCompatible return false.

???- example "Code samples"

    === "C#"

        ```csharp
        string minViableVersionL2 = siteVolumeBin.MinViableVersionL2;
        ```

    === "C++"

        ```cpp
        CComBSTR minViableVersionL2;
        siteVolumeBin->get_MinViableVersionL2(&minViableVersionL2);
        ```

    === "Python"

        ```python
        min_viable_version_l2 = siteVolumeBin.MinViableVersionL2
        ```

### DriveOnLeft {#driveonleft}

Flag indicating the "Drive Rule" of the Site Volume Bin

```csharp
bool DriveOnLeft { get; }
```

**Type** `bool`

**Value**

True if driving on the left. False if driving on the right.

???- example "Code samples"

    === "C#"

        ```csharp
        bool driveOnLeft = siteVolumeBin.DriveOnLeft;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL driveOnLeft;
        siteVolumeBin->get_DriveOnLeft(&driveOnLeft);
        ```

    === "Python"

        ```python
        drive_on_left = siteVolumeBin.DriveOnLeft
        ```

### Units {#units}

General unit system used for data within the Site Volume Bin

```csharp
int Units { get; }
```

**Type** `int`

**Value**

One of:

- `0` - Metric
- `1` - US Units

???- example "Code samples"

    === "C#"

        ```csharp
        int units = siteVolumeBin.Units;
        ```

    === "C++"

        ```cpp
        long units;
        siteVolumeBin->get_Units(&units);
        ```

    === "Python"

        ```python
        units = siteVolumeBin.Units
        ```

### Title {#title}

Site Volume Bin title

```csharp
string Title { get; set; }
```

**Type** `string`

**Value**

Site Volume Bin title, max length = 500.

???- example "Code samples"

    === "C#"

        ```csharp
        string title = siteVolumeBin.Title;
        siteVolumeBin.Title = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR title;
        siteVolumeBin->get_Title(&title);
        siteVolumeBin->put_Title(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        title = siteVolumeBin.Title
        siteVolumeBin.Title = r"value"
        ```

### Description {#description}

Site Volume Bin description

```csharp
string Description { get; set; }
```

**Type** `string`

**Value**

Site Volume Bin description, max length = 500.

???- example "Code samples"

    === "C#"

        ```csharp
        string description = siteVolumeBin.Description;
        siteVolumeBin.Description = @"value";
        ```

    === "C++"

        ```cpp
        CComBSTR description;
        siteVolumeBin->get_Description(&description);
        siteVolumeBin->put_Description(CComBSTR(L"value"));
        ```

    === "Python"

        ```python
        description = siteVolumeBin.Description
        siteVolumeBin.Description = r"value"
        ```

### UnitTimeForVolumes {#unittimeforvolumes}

Unit time for traffic volumes in minutes

```csharp
int UnitTimeForVolumes { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int unitTimeForVolumes = siteVolumeBin.UnitTimeForVolumes;
        siteVolumeBin.UnitTimeForVolumes = 0;
        ```

    === "C++"

        ```cpp
        long unitTimeForVolumes;
        siteVolumeBin->get_UnitTimeForVolumes(&unitTimeForVolumes);
        siteVolumeBin->put_UnitTimeForVolumes(0);
        ```

    === "Python"

        ```python
        unit_time_for_volumes = siteVolumeBin.UnitTimeForVolumes
        siteVolumeBin.UnitTimeForVolumes = 0
        ```

### PeakFlowPeriod {#peakflowperiod}

Peak flow period in minutes

```csharp
int PeakFlowPeriod { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int peakFlowPeriod = siteVolumeBin.PeakFlowPeriod;
        siteVolumeBin.PeakFlowPeriod = 0;
        ```

    === "C++"

        ```cpp
        long peakFlowPeriod;
        siteVolumeBin->get_PeakFlowPeriod(&peakFlowPeriod);
        siteVolumeBin->put_PeakFlowPeriod(0);
        ```

    === "Python"

        ```python
        peak_flow_period = siteVolumeBin.PeakFlowPeriod
        siteVolumeBin.PeakFlowPeriod = 0
        ```

### HoursPerYear {#hoursperyear}

```csharp
int HoursPerYear { get; set; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int hoursPerYear = siteVolumeBin.HoursPerYear;
        siteVolumeBin.HoursPerYear = 0;
        ```

    === "C++"

        ```cpp
        long hoursPerYear;
        siteVolumeBin->get_HoursPerYear(&hoursPerYear);
        siteVolumeBin->put_HoursPerYear(0);
        ```

    === "Python"

        ```python
        hours_per_year = siteVolumeBin.HoursPerYear
        siteVolumeBin.HoursPerYear = 0
        ```

### Created_date {#created_date}

```csharp
DateTime Created_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var created_date = siteVolumeBin.Created_date;
        ```

    === "C++"

        ```cpp
        VARIANT created_date;
        siteVolumeBin->get_Created_date(&created_date);
        ```

    === "Python"

        ```python
        created_date = siteVolumeBin.Created_date
        ```

### Created_by {#created_by}

```csharp
string Created_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by = siteVolumeBin.Created_by;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by;
        siteVolumeBin->get_Created_by(&created_by);
        ```

    === "Python"

        ```python
        created_by = siteVolumeBin.Created_by
        ```

### Created_by_company {#created_by_company}

```csharp
string Created_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_by_company = siteVolumeBin.Created_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR created_by_company;
        siteVolumeBin->get_Created_by_company(&created_by_company);
        ```

    === "Python"

        ```python
        created_by_company = siteVolumeBin.Created_by_company
        ```

### Created_version {#created_version}

```csharp
string Created_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string created_version = siteVolumeBin.Created_version;
        ```

    === "C++"

        ```cpp
        CComBSTR created_version;
        siteVolumeBin->get_Created_version(&created_version);
        ```

    === "Python"

        ```python
        created_version = siteVolumeBin.Created_version
        ```

### Modified_date {#modified_date}

```csharp
DateTime Modified_date { get; }
```

**Type** `DateTime`

???- example "Code samples"

    === "C#"

        ```csharp
        var modified_date = siteVolumeBin.Modified_date;
        ```

    === "C++"

        ```cpp
        VARIANT modified_date;
        siteVolumeBin->get_Modified_date(&modified_date);
        ```

    === "Python"

        ```python
        modified_date = siteVolumeBin.Modified_date
        ```

### Modified_by {#modified_by}

```csharp
string Modified_by { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by = siteVolumeBin.Modified_by;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by;
        siteVolumeBin->get_Modified_by(&modified_by);
        ```

    === "Python"

        ```python
        modified_by = siteVolumeBin.Modified_by
        ```

### Modified_by_company {#modified_by_company}

```csharp
string Modified_by_company { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_by_company = siteVolumeBin.Modified_by_company;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_by_company;
        siteVolumeBin->get_Modified_by_company(&modified_by_company);
        ```

    === "Python"

        ```python
        modified_by_company = siteVolumeBin.Modified_by_company
        ```

### Modified_version {#modified_version}

```csharp
string Modified_version { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string modified_version = siteVolumeBin.Modified_version;
        ```

    === "C++"

        ```cpp
        CComBSTR modified_version;
        siteVolumeBin->get_Modified_version(&modified_version);
        ```

    === "Python"

        ```python
        modified_version = siteVolumeBin.Modified_version
        ```

### LastErrorMessage {#lasterrormessage}

```csharp
string LastErrorMessage { get; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string lastErrorMessage = siteVolumeBin.LastErrorMessage;
        ```

    === "C++"

        ```cpp
        CComBSTR lastErrorMessage;
        siteVolumeBin->get_LastErrorMessage(&lastErrorMessage);
        ```

    === "Python"

        ```python
        last_error_message = siteVolumeBin.LastErrorMessage
        ```

### SiteVolumeBinFolder {#sitevolumebinfolder}

```csharp
ISIAPISiteVolumeBinFolder SiteVolumeBinFolder { get; }
```

**Type** [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBinFolder = siteVolumeBin.SiteVolumeBinFolder;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBinFolder> siteVolumeBinFolder;
        siteVolumeBin->get_SiteVolumeBinFolder(&siteVolumeBinFolder);
        ```

    === "Python"

        ```python
        site_volume_bin_folder = siteVolumeBin.SiteVolumeBinFolder
        ```

### SiteVolumeMCs {#sitevolumemcs}

```csharp
ISIAPISiteVolumeMCs SiteVolumeMCs { get; }
```

**Type** [`ISIAPISiteVolumeMCs`](sidrasolutions.si.api.isiapisitevolumemcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeMCs = siteVolumeBin.SiteVolumeMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMCs> siteVolumeMCs;
        siteVolumeBin->get_SiteVolumeMCs(&siteVolumeMCs);
        ```

    === "Python"

        ```python
        site_volume_m_cs = siteVolumeBin.SiteVolumeMCs
        ```

### SiteVolumeLegs {#sitevolumelegs}

Site Volume Legs in this Volume Bin

All eight Legs are created when creating a Site Volume Bin. The South, East, North and West Legs' Geometry are set to 1 (Two Way), 
the other Legs' Geometry are set to 0 ('No Leg') by default.

```csharp
ISIAPISiteVolumeLegs SiteVolumeLegs { get; }
```

**Type** [`ISIAPISiteVolumeLegs`](sidrasolutions.si.api.isiapisitevolumelegs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeLegs = siteVolumeBin.SiteVolumeLegs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeLegs> siteVolumeLegs;
        siteVolumeBin->get_SiteVolumeLegs(&siteVolumeLegs);
        ```

    === "Python"

        ```python
        site_volume_legs = siteVolumeBin.SiteVolumeLegs
        ```

### SiteVolumeMovVehODs {#sitevolumemovvehods}

```csharp
ISIAPISiteVolumeMovVehODs SiteVolumeMovVehODs { get; }
```

**Type** [`ISIAPISiteVolumeMovVehODs`](sidrasolutions.si.api.isiapisitevolumemovvehods.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeMovVehODs = siteVolumeBin.SiteVolumeMovVehODs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovVehODs> siteVolumeMovVehODs;
        siteVolumeBin->get_SiteVolumeMovVehODs(&siteVolumeMovVehODs);
        ```

    === "Python"

        ```python
        site_volume_mov_veh_o_ds = siteVolumeBin.SiteVolumeMovVehODs
        ```

### SiteVolumeMovPeds {#sitevolumemovpeds}

```csharp
ISIAPISiteVolumeMovPeds SiteVolumeMovPeds { get; }
```

**Type** [`ISIAPISiteVolumeMovPeds`](sidrasolutions.si.api.isiapisitevolumemovpeds.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeMovPeds = siteVolumeBin.SiteVolumeMovPeds;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovPeds> siteVolumeMovPeds;
        siteVolumeBin->get_SiteVolumeMovPeds(&siteVolumeMovPeds);
        ```

    === "Python"

        ```python
        site_volume_mov_peds = siteVolumeBin.SiteVolumeMovPeds
        ```

## Methods

### UpdateModifiedInfo() {#updatemodifiedinfo}

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

```csharp
bool UpdateModifiedInfo()
```

**Returns** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBin.UpdateModifiedInfo();
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBin->UpdateModifiedInfo(&result);
        ```

    === "Python"

        ```python
        result = siteVolumeBin.UpdateModifiedInfo()
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumebinfolder.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeBinFolder
title: SiteVolumeBinFolder
name: ISIAPISiteVolumeBinFolder
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 0781C83D-1FBD-4E54-B026-2D0B1C2A6255
summary: SiteVolumeBinFolder wrapper interface
members:
  - ISIAPISiteVolumeBin AddSiteVolumeBin(int softwareSetup)
  - ISIAPISiteVolumeBin AddSiteVolumeBin(string softwareSetupSignature)
  - bool RemoveSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)
  - ISIAPISiteVolumeBin CloneSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)
  - bool MoveSiteVolumeBinTo(ISIAPISiteVolumeBin siteVolumeBin, int newPosition)
  - bool MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin siteVolumeBin, ISIAPISiteVolumeBinFolder destFolder)
  - string Name
  - int Position
  - ISIAPISiteVolumeBins SiteVolumeBins
  - ISIAPIProject Project
---

# SiteVolumeBinFolder

Type `ISIAPISiteVolumeBinFolder` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `0781C83D-1FBD-4E54-B026-2D0B1C2A6255`

SiteVolumeBinFolder wrapper interface

## Declaration

```csharp
[Guid("0781C83D-1FBD-4E54-B026-2D0B1C2A6255")]
public interface ISIAPISiteVolumeBinFolder
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Name](#name) | `string` | Site Volume Bin Folder Name |
| [Position](#position) | `int` | This SiteVolumeBinFolder object's Position in the collection. It is a zero-base integer. |
| [SiteVolumeBins](#sitevolumebins) | [`ISIAPISiteVolumeBins`](sidrasolutions.si.api.isiapisitevolumebins.md) | Collection of SiteVolumeBins in this Folder |
| [Project](#project) | [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md) |  |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [AddSiteVolumeBin(int)](#addsitevolumebin-int) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Create a new SiteVolumeBin by using a Standard Software Setup and add it into this Folder. |
| [AddSiteVolumeBin(string)](#addsitevolumebin-string) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Create a new SiteVolumeBin and add it into this Folder. The SiteVolumeBin is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature. |
| [RemoveSiteVolumeBin(ISIAPISiteVolumeBin)](#removesitevolumebin-isiapisitevolumebin) | `bool` | Remove a SiteVolumeBin from this Folder. |
| [CloneSiteVolumeBin(ISIAPISiteVolumeBin)](#clonesitevolumebin-isiapisitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Clone a SiteVolumeBin. |
| [MoveSiteVolumeBinTo(ISIAPISiteVolumeBin, int)](#movesitevolumebinto-isiapisitevolumebin--int) | `bool` | Move a SiteVolumeBin to a new position in the same Folder. |
| [MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin, ISIAPISiteVolumeBinFolder)](#movesitevolumebintofolder-isiapisitevolumebin--isiapisitevolumebinfolder) | `bool` | Move a SiteVolumeBin from this Site Volume Bin Folder to another Site Volume Bin Folder in this Project. |

</div>

## Properties

### Name {#name}

Site Volume Bin Folder Name

```csharp
string Name { get; set; }
```

**Type** `string`

**Value**

The Site Volume Bin Folder's name, max length = 100.

???- example "Code samples"

    === "C#"

        ```csharp
        string name = siteVolumeBinFolder.Name;
        siteVolumeBinFolder.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        siteVolumeBinFolder->get_Name(&name);
        siteVolumeBinFolder->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = siteVolumeBinFolder.Name
        siteVolumeBinFolder.Name = r"Example"
        ```

### Position {#position}

This SiteVolumeBinFolder object's Position in the collection. It is a zero-base integer.

```csharp
int Position { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int position = siteVolumeBinFolder.Position;
        ```

    === "C++"

        ```cpp
        long position;
        siteVolumeBinFolder->get_Position(&position);
        ```

    === "Python"

        ```python
        position = siteVolumeBinFolder.Position
        ```

### SiteVolumeBins {#sitevolumebins}

Collection of SiteVolumeBins in this Folder

```csharp
ISIAPISiteVolumeBins SiteVolumeBins { get; }
```

**Type** [`ISIAPISiteVolumeBins`](sidrasolutions.si.api.isiapisitevolumebins.md)

**Value**

SiteVolumeBins collection

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBins = siteVolumeBinFolder.SiteVolumeBins;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBins> siteVolumeBins;
        siteVolumeBinFolder->get_SiteVolumeBins(&siteVolumeBins);
        ```

    === "Python"

        ```python
        site_volume_bins = siteVolumeBinFolder.SiteVolumeBins
        ```

### Project {#project}

```csharp
ISIAPIProject Project { get; }
```

**Type** [`ISIAPIProject`](sidrasolutions.si.api.isiapiproject.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var project = siteVolumeBinFolder.Project;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPIProject> project;
        siteVolumeBinFolder->get_Project(&project);
        ```

    === "Python"

        ```python
        project = siteVolumeBinFolder.Project
        ```

## Methods

### AddSiteVolumeBin(int) {#addsitevolumebin-int}

Create a new SiteVolumeBin by using a Standard Software Setup and add it into this Folder.

```csharp
ISIAPISiteVolumeBin AddSiteVolumeBin(int softwareSetup)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `softwareSetup` | `int` | One of: - Standard Software Setup that is used to create the Site - `1` - Standard Left - `2` - New Zealand - `3` - New South Wales - `4` - Standard Right - `5` - US HCM (Metric) - `6` - US HCM (Customary) |

**Returns** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) - The new added SiteVolumeBin.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteVolumeBinFolder.AddSiteVolumeBin(0);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> result;
        siteVolumeBinFolder->AddSiteVolumeBin(0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.AddSiteVolumeBin(0)
        ```

### AddSiteVolumeBin(string) {#addsitevolumebin-string}

Create a new SiteVolumeBin and add it into this Folder.  
The SiteVolumeBin is created by using a User Software Setup or a Standard Software Setup. The Software Setup is identified by the string parameter softwareSetupSignature.

```csharp
ISIAPISiteVolumeBin AddSiteVolumeBin(string softwareSetupSignature)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `softwareSetupSignature` | `string` | The signature string of a User Software Setup or a Standard Software Setup. |

**Returns** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) - The new added SiteVolumeBin.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteVolumeBinFolder.AddSiteVolumeBin(@"value");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> result;
        siteVolumeBinFolder->AddSiteVolumeBin(CComBSTR(L"value"), &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.AddSiteVolumeBin(r"value")
        ```

### RemoveSiteVolumeBin(ISIAPISiteVolumeBin) {#removesitevolumebin-isiapisitevolumebin}

Remove a SiteVolumeBin from this Folder.

```csharp
bool RemoveSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin` | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | The SiteVolumeBin to remove. |

**Returns** `bool` - true if the SiteVolumeBin is successfully removed; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder.

**Remarks**

The SiteVolumeBin cannot be used in any Site.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBinFolder.RemoveSiteVolumeBin(null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBinFolder->RemoveSiteVolumeBin(NULL, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.RemoveSiteVolumeBin(None)
        ```

### CloneSiteVolumeBin(ISIAPISiteVolumeBin) {#clonesitevolumebin-isiapisitevolumebin}

Clone a SiteVolumeBin.

```csharp
ISIAPISiteVolumeBin CloneSiteVolumeBin(ISIAPISiteVolumeBin siteVolumeBin)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin` | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | The SiteVolumeBin to be cloned. |

**Returns** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) - The new cloned SiteVolumeBin.

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteVolumeBinFolder.CloneSiteVolumeBin(null);
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> result;
        siteVolumeBinFolder->CloneSiteVolumeBin(NULL, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.CloneSiteVolumeBin(None)
        ```

### MoveSiteVolumeBinTo(ISIAPISiteVolumeBin, int) {#movesitevolumebinto-isiapisitevolumebin--int}

Move a SiteVolumeBin to a new position in the same Folder.

```csharp
bool MoveSiteVolumeBinTo(ISIAPISiteVolumeBin siteVolumeBin, int newPosition)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin` | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | The SiteVolumeBin to move. |
| `newPosition` | `int` | The zero-based position that the SiteVolumeBin should be moved to. |

**Returns** `bool` - true if the SiteVolumeBin is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBinFolder.MoveSiteVolumeBinTo(null, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBinFolder->MoveSiteVolumeBinTo(NULL, 0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.MoveSiteVolumeBinTo(None, 0)
        ```

### MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin, ISIAPISiteVolumeBinFolder) {#movesitevolumebintofolder-isiapisitevolumebin--isiapisitevolumebinfolder}

Move a SiteVolumeBin from this Site Volume Bin Folder to another Site Volume Bin Folder in this Project.

```csharp
bool MoveSiteVolumeBinToFolder(ISIAPISiteVolumeBin siteVolumeBin, ISIAPISiteVolumeBinFolder destFolder)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin` | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | The SiteVolumeBin to move. |
| `destFolder` | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | The destination Site Volume Bin Folder |

**Returns** `bool` - true if the SiteVolumeBin is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBin does not exist in this Folder before moving it.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(null, null);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBinFolder->MoveSiteVolumeBinToFolder(NULL, NULL, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolder.MoveSiteVolumeBinToFolder(None, None)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumebinfolders.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeBinFolders
title: SiteVolumeBinFolders
name: ISIAPISiteVolumeBinFolders
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B602B00A-E559-413F-BE3C-0904AB67B1CE
summary: SiteVolumeBinFolder collection wrapper interface
members:
  - bool SiteVolumeBinFolderExists(string name)
  - ISIAPISiteVolumeBinFolder this[string name]
  - ISIAPISiteVolumeBinFolder this[int index]
  - int Count
---

# SiteVolumeBinFolders

Type `ISIAPISiteVolumeBinFolders` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B602B00A-E559-413F-BE3C-0904AB67B1CE`

SiteVolumeBinFolder collection wrapper interface

## Declaration

```csharp
[Guid("B602B00A-E559-413F-BE3C-0904AB67B1CE")]
public interface ISIAPISiteVolumeBinFolders
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of SiteVolumeBinFolders contained in the collection. |
| [this[]](#this) | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | Get the SiteVolumeBinFolder from the collection by the Folder name. |
| [this[]](#this) | [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md) | Get the SiteVolumeBinFolder at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SiteVolumeBinFolderExists(string)](#sitevolumebinfolderexists-string) | `bool` | Queries whether a particular SiteVolumeBinFolder exists in the collection |

</div>

## Properties

### Count {#count}

Gets the number of SiteVolumeBinFolders contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeBinFolders.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeBinFolders->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeBinFolders.Count
        ```

### this[] {#this}

Get the SiteVolumeBinFolder from the collection by the Folder name.

```csharp
ISIAPISiteVolumeBinFolder this[] { get; }
```

**Type** [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md)

**Remarks**

The SiteVolumeBinFolder name is not unique in the collection. It is possible that more than one SiteVolumeBinFolder has the same name.
The first SiteVolumeBinFolder found by name is returned. If no SiteVolumeBinFolder is found, null / Nothing is returned.

In C#, use ISIAPISiteVolumeBinFolders[] to get a SiteVolumeBinFolder by its name or its position in the collection.  
In VBA, use Item() to get a SiteVolumeBinFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteVolumeBinFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeBinFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBinFolder> this[];
        siteVolumeBinFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeBinFolders.this[]
        ```

### this[] {#this}

Get the SiteVolumeBinFolder at the specified index.

```csharp
ISIAPISiteVolumeBinFolder this[] { get; }
```

**Type** [`ISIAPISiteVolumeBinFolder`](sidrasolutions.si.api.isiapisitevolumebinfolder.md)

**Remarks**

In C#, use ISIAPISiteVolumeBinFolders[] to get a SiteVolumeBinFolder by its name or its position in the collection.  
In VBA, use Item() to get a SiteVolumeBinFolder by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteVolumeBinFolder by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeBinFolders.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBinFolder> this[];
        siteVolumeBinFolders->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeBinFolders.this[]
        ```

## Methods

### SiteVolumeBinFolderExists(string) {#sitevolumebinfolderexists-string}

Queries whether a particular SiteVolumeBinFolder exists in the collection

```csharp
bool SiteVolumeBinFolderExists(string name)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `name` | `string` | SiteVolumeBinFolder name to query |

**Returns** `bool` - True, if any SiteVolumeBinFolder with the given name exists in the collection. False otherwise

**Remarks**

The SiteVolumeBinFolder name is not unique in the collection. It is possible that more than one SiteVolumeBinFolder has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBinFolders.SiteVolumeBinFolderExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBinFolders->SiteVolumeBinFolderExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBinFolders.SiteVolumeBinFolderExists(r"Example")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumebins.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeBins
title: SiteVolumeBins
name: ISIAPISiteVolumeBins
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: D5CC5F3A-584F-4075-9877-FED977A3C7A8
summary: SiteVolumeBin collection wrapper interface
members:
  - bool SiteVolumeBinExists(string siteVolumeBinName)
  - ISIAPISiteVolumeBin GetSiteVolumeBinByID(string siteVolumeBin_id)
  - ISIAPISiteVolumeBin this[string siteVolumeBinName]
  - ISIAPISiteVolumeBin this[int index]
  - int Count
---

# SiteVolumeBins

Type `ISIAPISiteVolumeBins` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `D5CC5F3A-584F-4075-9877-FED977A3C7A8`

SiteVolumeBin collection wrapper interface

## Declaration

```csharp
[Guid("D5CC5F3A-584F-4075-9877-FED977A3C7A8")]
public interface ISIAPISiteVolumeBins
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` | Gets the number of SiteVolumeBins contained in the collection. |
| [this[]](#this) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Get the SiteVolumeBin from the collection by its name. |
| [this[]](#this) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Get the SiteVolumeBin at the specified index. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [SiteVolumeBinExists(string)](#sitevolumebinexists-string) | `bool` | Queries whether a particular SiteVolumeBin exists in the collection by its name. |
| [GetSiteVolumeBinByID(string)](#getsitevolumebinbyid-string) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) | Get the SiteVolumeBin by its GUID. |

</div>

## Properties

### Count {#count}

Gets the number of SiteVolumeBins contained in the collection.

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeBins.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeBins->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeBins.Count
        ```

### this[] {#this}

Get the SiteVolumeBin from the collection by its name.

```csharp
ISIAPISiteVolumeBin this[] { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

**Remarks**

The SiteVolumeBin name is not unique in the collection. It is possible that more than one SiteVolumeBin has the same name.
The first SiteVolumeBin found by name is returned. If no SiteVolumeBin is found, null / Nothing is returned.

In C#, use ISIAPISiteVolumeBins[] to get a Site by its name or its position in the collection.  
In VBA, use Item() to get a SiteVolumeBin by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteVolumeBin by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeBins.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> this[];
        siteVolumeBins->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeBins.this[]
        ```

### this[] {#this}

Get the SiteVolumeBin at the specified index.

```csharp
ISIAPISiteVolumeBin this[] { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

**Remarks**

In C#, use ISIAPISiteVolumeBins[] to get a SiteVolumeBin by its name or its position in the collection.  
In VBA, use Item() to get a SiteVolumeBin by its name or use Item_2() to get by its position.  
In C++, use get_Item() to get a SiteVolumeBin by its name or use get_Item_2() by its position.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeBins.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> this[];
        siteVolumeBins->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeBins.this[]
        ```

## Methods

### SiteVolumeBinExists(string) {#sitevolumebinexists-string}

Queries whether a particular SiteVolumeBin exists in the collection by its name.

```csharp
bool SiteVolumeBinExists(string siteVolumeBinName)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBinName` | `string` | SiteVolumeBin name to query |

**Returns** `bool` - True, if any SiteVolumeBin with the given name exists in the collection. False otherwise

**Remarks**

The SiteVolumeBin name is not unique in the collection. It is possible that more than one SiteVolumeBin has the same name.

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeBins.SiteVolumeBinExists(@"Example");
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeBins->SiteVolumeBinExists(CComBSTR(L"Example"), &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBins.SiteVolumeBinExists(r"Example")
        ```

### GetSiteVolumeBinByID(string) {#getsitevolumebinbyid-string}

Get the SiteVolumeBin by its GUID.

```csharp
ISIAPISiteVolumeBin GetSiteVolumeBinByID(string siteVolumeBin_id)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `siteVolumeBin_id` | `string` | The GUID of the SiteVolumeBin object, i.e. ISIAPISiteVolumeBin.SiteVolumeBin_id. This is different from the "Site Volume Bin ID" in the Site Bin Setup dialog, i.e. ISIAPISiteVolumeBin.ID. |

**Returns** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var result = siteVolumeBins.GetSiteVolumeBinByID(@"id-1");
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> result;
        siteVolumeBins->GetSiteVolumeBinByID(CComBSTR(L"id-1"), &result);
        ```

    === "Python"

        ```python
        result = siteVolumeBins.GetSiteVolumeBinByID(r"id-1")
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumeleg.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeLeg
title: SiteVolumeLeg
name: ISIAPISiteVolumeLeg
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: F338BDE5-A67A-49A2-B141-7E0FDFCBFDBD
members:
  - int Orientation
  - int LegGeometry
  - int PedMainCrossingVolumeOption
  - float PedMainCrossingVolume
  - float PedMainCrossingPeakFlowFactor
  - float PedMainCrossingFlowScale
  - float PedMainCrossingGrowthRate
  - ISIAPISiteVolumeBin SiteVolumeBin
---

# SiteVolumeLeg

Type `ISIAPISiteVolumeLeg` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `F338BDE5-A67A-49A2-B141-7E0FDFCBFDBD`

## Declaration

```csharp
[Guid("F338BDE5-A67A-49A2-B141-7E0FDFCBFDBD")]
public interface ISIAPISiteVolumeLeg
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Orientation](#orientation) | `int` | Leg Orientation |
| [LegGeometry](#leggeometry) | `int` | Leg Geometry |
| [PedMainCrossingVolumeOption](#pedmaincrossingvolumeoption) | `int` | Pedestrian Volume Data Option for Main Crossing (Full and Staged) |
| [PedMainCrossingVolume](#pedmaincrossingvolume) | `float` |  |
| [PedMainCrossingPeakFlowFactor](#pedmaincrossingpeakflowfactor) | `float` |  |
| [PedMainCrossingFlowScale](#pedmaincrossingflowscale) | `float` |  |
| [PedMainCrossingGrowthRate](#pedmaincrossinggrowthrate) | `float` |  |
| [SiteVolumeBin](#sitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) |  |

</div>

## Properties

### Orientation {#orientation}

Leg Orientation

```csharp
int Orientation { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int orientation = siteVolumeLeg.Orientation;
        ```

    === "C++"

        ```cpp
        long orientation;
        siteVolumeLeg->get_Orientation(&orientation);
        ```

    === "Python"

        ```python
        orientation = siteVolumeLeg.Orientation
        ```

### LegGeometry {#leggeometry}

Leg Geometry

```csharp
int LegGeometry { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - No Leg
- `1` - Two Way
- `2` - One-Way Approach
- `3` - One-Way Exit

???- example "Code samples"

    === "C#"

        ```csharp
        int legGeometry = siteVolumeLeg.LegGeometry;
        siteVolumeLeg.LegGeometry = 0;
        ```

    === "C++"

        ```cpp
        long legGeometry;
        siteVolumeLeg->get_LegGeometry(&legGeometry);
        siteVolumeLeg->put_LegGeometry(0);
        ```

    === "Python"

        ```python
        leg_geometry = siteVolumeLeg.LegGeometry
        siteVolumeLeg.LegGeometry = 0
        ```

### PedMainCrossingVolumeOption {#pedmaincrossingvolumeoption}

Pedestrian Volume Data Option for Main Crossing (Full and Staged)

```csharp
int PedMainCrossingVolumeOption { get; set; }
```

**Type** `int`

**Value**

One of:

- `0` - Overall Value for Full and Staged Crossings (All Stages)
- `1` - Separate Value for Full and Staged Crossings

**Remarks**

When this Option is set to 0 (Overall Value), the overall pedestrian volume data (Volume, Peak Flow Factor, Flow Scale and 
Growth Rate) in the ISIAPISiteVolumeLeg object are applied for the Pedestrian Full and Staged Crossings Movementes. 
The volume data in the corresponding ISIAPISiteVolumeMovPed object are ignored. When this Option is set to 1 (Separate Value), 
the volume data in the corresponding ISIAPISiteVolumeMovPed object are applied.

This option does not affect the volume data of Slip/Bypass Lane Crossing. The volume data in the corresponding 
ISIAPISiteVolumeMovPed object for the Slip/Bypass Lane Crossing are applied.

???- example "Code samples"

    === "C#"

        ```csharp
        int pedMainCrossingVolumeOption = siteVolumeLeg.PedMainCrossingVolumeOption;
        siteVolumeLeg.PedMainCrossingVolumeOption = 0;
        ```

    === "C++"

        ```cpp
        long pedMainCrossingVolumeOption;
        siteVolumeLeg->get_PedMainCrossingVolumeOption(&pedMainCrossingVolumeOption);
        siteVolumeLeg->put_PedMainCrossingVolumeOption(0);
        ```

    === "Python"

        ```python
        ped_main_crossing_volume_option = siteVolumeLeg.PedMainCrossingVolumeOption
        siteVolumeLeg.PedMainCrossingVolumeOption = 0
        ```

### PedMainCrossingVolume {#pedmaincrossingvolume}

```csharp
float PedMainCrossingVolume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingVolume = siteVolumeLeg.PedMainCrossingVolume;
        siteVolumeLeg.PedMainCrossingVolume = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingVolume;
        siteVolumeLeg->get_PedMainCrossingVolume(&pedMainCrossingVolume);
        siteVolumeLeg->put_PedMainCrossingVolume(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_volume = siteVolumeLeg.PedMainCrossingVolume
        siteVolumeLeg.PedMainCrossingVolume = 0.0
        ```

### PedMainCrossingPeakFlowFactor {#pedmaincrossingpeakflowfactor}

```csharp
float PedMainCrossingPeakFlowFactor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingPeakFlowFactor = siteVolumeLeg.PedMainCrossingPeakFlowFactor;
        siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingPeakFlowFactor;
        siteVolumeLeg->get_PedMainCrossingPeakFlowFactor(&pedMainCrossingPeakFlowFactor);
        siteVolumeLeg->put_PedMainCrossingPeakFlowFactor(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_peak_flow_factor = siteVolumeLeg.PedMainCrossingPeakFlowFactor
        siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0
        ```

### PedMainCrossingFlowScale {#pedmaincrossingflowscale}

```csharp
float PedMainCrossingFlowScale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingFlowScale = siteVolumeLeg.PedMainCrossingFlowScale;
        siteVolumeLeg.PedMainCrossingFlowScale = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingFlowScale;
        siteVolumeLeg->get_PedMainCrossingFlowScale(&pedMainCrossingFlowScale);
        siteVolumeLeg->put_PedMainCrossingFlowScale(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_flow_scale = siteVolumeLeg.PedMainCrossingFlowScale
        siteVolumeLeg.PedMainCrossingFlowScale = 0.0
        ```

### PedMainCrossingGrowthRate {#pedmaincrossinggrowthrate}

```csharp
float PedMainCrossingGrowthRate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float pedMainCrossingGrowthRate = siteVolumeLeg.PedMainCrossingGrowthRate;
        siteVolumeLeg.PedMainCrossingGrowthRate = 0.0;
        ```

    === "C++"

        ```cpp
        double pedMainCrossingGrowthRate;
        siteVolumeLeg->get_PedMainCrossingGrowthRate(&pedMainCrossingGrowthRate);
        siteVolumeLeg->put_PedMainCrossingGrowthRate(0.0);
        ```

    === "Python"

        ```python
        ped_main_crossing_growth_rate = siteVolumeLeg.PedMainCrossingGrowthRate
        siteVolumeLeg.PedMainCrossingGrowthRate = 0.0
        ```

### SiteVolumeBin {#sitevolumebin}

```csharp
ISIAPISiteVolumeBin SiteVolumeBin { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBin = siteVolumeLeg.SiteVolumeBin;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
        siteVolumeLeg->get_SiteVolumeBin(&siteVolumeBin);
        ```

    === "Python"

        ```python
        site_volume_bin = siteVolumeLeg.SiteVolumeBin
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumelegs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeLegs
title: SiteVolumeLegs
name: ISIAPISiteVolumeLegs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 054C4737-ACF6-42B1-AF5B-B5F6358FD3CA
members:
  - bool LegExists(int orientation)
  - ISIAPISiteVolumeLeg this[int orientation]
  - int Count
---

# SiteVolumeLegs

Type `ISIAPISiteVolumeLegs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `054C4737-ACF6-42B1-AF5B-B5F6358FD3CA`

## Declaration

```csharp
[Guid("054C4737-ACF6-42B1-AF5B-B5F6358FD3CA")]
public interface ISIAPISiteVolumeLegs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISiteVolumeLeg`](sidrasolutions.si.api.isiapisitevolumeleg.md) | Get a Site Volume Bin Leg. Return a Site Volume Bin Leg if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [LegExists(int)](#legexists-int) | `bool` | Get a value indicating whether a Site Volume Bin Leg exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeLegs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeLegs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeLegs.Count
        ```

### this[] {#this}

Get a Site Volume Bin Leg.  
Return a Site Volume Bin Leg if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPISiteVolumeLeg this[] { get; }
```

**Type** [`ISIAPISiteVolumeLeg`](sidrasolutions.si.api.isiapisitevolumeleg.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeLegs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeLeg> this[];
        siteVolumeLegs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeLegs.this[]
        ```

## Methods

### LegExists(int) {#legexists-int}

Get a value indicating whether a Site Volume Bin Leg exists in the data storage.

```csharp
bool LegExists(int orientation)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `orientation` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeLegs.LegExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeLegs->LegExists(0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeLegs.LegExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMC
title: SiteVolumeMC
name: ISIAPISiteVolumeMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: AD3528EC-D1B6-4D51-B0EF-03C7F3EDE7A8
members:
  - int MCClass
  - string Name
  - bool IsIncluded
  - bool IsUserClass
  - ISIAPISiteVolumeBin SiteVolumeBin
---

# SiteVolumeMC

Type `ISIAPISiteVolumeMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `AD3528EC-D1B6-4D51-B0EF-03C7F3EDE7A8`

## Declaration

```csharp
[Guid("AD3528EC-D1B6-4D51-B0EF-03C7F3EDE7A8")]
public interface ISIAPISiteVolumeMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MCClass](#mcclass) | `int` | Movement Class Number |
| [Name](#name) | `string` | Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. IsUserClass == true. |
| [IsIncluded](#isincluded) | `bool` | Flag indicating whether this Movement Class is included in the Site Volume Bin. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included. |
| [IsUserClass](#isuserclass) | `bool` |  |
| [SiteVolumeBin](#sitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) |  |

</div>

## Properties

### MCClass {#mcclass}

Movement Class Number

```csharp
int MCClass { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mCClass = siteVolumeMC.MCClass;
        ```

    === "C++"

        ```cpp
        long mCClass;
        siteVolumeMC->get_MCClass(&mCClass);
        ```

    === "Python"

        ```python
        mc_class = siteVolumeMC.MCClass
        ```

### Name {#name}

Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. IsUserClass == true.

```csharp
string Name { get; set; }
```

**Type** `string`

???- example "Code samples"

    === "C#"

        ```csharp
        string name = siteVolumeMC.Name;
        siteVolumeMC.Name = @"Example";
        ```

    === "C++"

        ```cpp
        CComBSTR name;
        siteVolumeMC->get_Name(&name);
        siteVolumeMC->put_Name(CComBSTR(L"Example"));
        ```

    === "Python"

        ```python
        name = siteVolumeMC.Name
        siteVolumeMC.Name = r"Example"
        ```

### IsIncluded {#isincluded}

Flag indicating whether this Movement Class is included in the Site Volume Bin. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included.

```csharp
bool IsIncluded { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isIncluded = siteVolumeMC.IsIncluded;
        siteVolumeMC.IsIncluded = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isIncluded;
        siteVolumeMC->get_IsIncluded(&isIncluded);
        siteVolumeMC->put_IsIncluded(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        is_included = siteVolumeMC.IsIncluded
        siteVolumeMC.IsIncluded = True
        ```

### IsUserClass {#isuserclass}

```csharp
bool IsUserClass { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isUserClass = siteVolumeMC.IsUserClass;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isUserClass;
        siteVolumeMC->get_IsUserClass(&isUserClass);
        ```

    === "Python"

        ```python
        is_user_class = siteVolumeMC.IsUserClass
        ```

### SiteVolumeBin {#sitevolumebin}

```csharp
ISIAPISiteVolumeBin SiteVolumeBin { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBin = siteVolumeMC.SiteVolumeBin;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
        siteVolumeMC->get_SiteVolumeBin(&siteVolumeBin);
        ```

    === "Python"

        ```python
        site_volume_bin = siteVolumeMC.SiteVolumeBin
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMCs
title: SiteVolumeMCs
name: ISIAPISiteVolumeMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 2D40E19F-8A0C-4516-884C-E7B195B71B7D
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPISiteVolumeMC this[int mcClass]
  - int Count
---

# SiteVolumeMCs

Type `ISIAPISiteVolumeMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `2D40E19F-8A0C-4516-884C-E7B195B71B7D`

## Declaration

```csharp
[Guid("2D40E19F-8A0C-4516-884C-E7B195B71B7D")]
public interface ISIAPISiteVolumeMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISiteVolumeMC`](sidrasolutions.si.api.isiapisitevolumemc.md) | Get a Site Volume Bin Movement Class. Return a Site Volume Bin Movement Class if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` | Get a value indicating whether a Site Volume Bin Movement Class exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeMCs.Count
        ```

### this[] {#this}

Get a Site Volume Bin Movement Class.  
Return a Site Volume Bin Movement Class if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPISiteVolumeMC this[] { get; }
```

**Type** [`ISIAPISiteVolumeMC`](sidrasolutions.si.api.isiapisitevolumemc.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMC> this[];
        siteVolumeMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

Get a value indicating whether a Site Volume Bin Movement Class exists in the data storage.

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` | One of: - `1` - Light Vehicles - `2` - Heavy Vehicles - `3` - Buses - `4` - Bicycles - `5` - Large Trucks - `6` - Trams - `7` - User Class 1 - `8` - User Class 2 - `9` - User Class 3 - `10` - User Class 4 - `11` - User Class 5 - `12` - User Class 6 |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovped.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovPed
title: SiteVolumeMovPed
name: ISIAPISiteVolumeMovPed
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: C457322F-040F-4B2C-97A8-01F1C58B728E
members:
  - int Type
  - int Origin
  - int Stage
  - bool Exists
  - float Volume
  - float PeakFlowFactor
  - float FlowScale
  - float GrowthRate
  - ISIAPISiteVolumeBin SiteVolumeBin
---

# SiteVolumeMovPed

Type `ISIAPISiteVolumeMovPed` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `C457322F-040F-4B2C-97A8-01F1C58B728E`

## Declaration

```csharp
[Guid("C457322F-040F-4B2C-97A8-01F1C58B728E")]
public interface ISIAPISiteVolumeMovPed
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Type](#type) | `int` | The type of a Pedestrian Movement |
| [Origin](#origin) | `int` | Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs |
| [Stage](#stage) | `int` | Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian Movements on each Leg allowing modelling of "staged" pedestrian crossings. |
| [Exists](#exists) | `bool` | Flag indicating whether this Pedestrian Movement "exists" (not banned) in the current Site Volume Bin. |
| [Volume](#volume) | `float` | Pedestrian Volume |
| [PeakFlowFactor](#peakflowfactor) | `float` | Peak Flow Factor (%) |
| [FlowScale](#flowscale) | `float` | Flow Scale (Constant) (%) |
| [GrowthRate](#growthrate) | `float` | Growth Rate (%/year) |
| [SiteVolumeBin](#sitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) |  |

</div>

## Properties

### Type {#type}

The type of a Pedestrian Movement

```csharp
int Type { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Full Crossing
- `2` - Slip Lane
- `3` - Staged
- `4` - Diagonal

???- example "Code samples"

    === "C#"

        ```csharp
        int type = siteVolumeMovPed.Type;
        ```

    === "C++"

        ```cpp
        long type;
        siteVolumeMovPed->get_Type(&type);
        ```

    === "Python"

        ```python
        type = siteVolumeMovPed.Type
        ```

### Origin {#origin}

Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = siteVolumeMovPed.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        siteVolumeMovPed->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = siteVolumeMovPed.Origin
        ```

### Stage {#stage}

Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian
Movements on each Leg allowing modelling of "staged" pedestrian crossings.

```csharp
int Stage { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Stage 1 (Approach-side crossing)
- `2` - Stage 2 (Exit-side crossing)

???- example "Code samples"

    === "C#"

        ```csharp
        int stage = siteVolumeMovPed.Stage;
        ```

    === "C++"

        ```cpp
        long stage;
        siteVolumeMovPed->get_Stage(&stage);
        ```

    === "Python"

        ```python
        stage = siteVolumeMovPed.Stage
        ```

### Exists {#exists}

Flag indicating whether this Pedestrian Movement "exists" (not banned) in the current Site Volume Bin.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = siteVolumeMovPed.Exists;
        siteVolumeMovPed.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        siteVolumeMovPed->get_Exists(&exists);
        siteVolumeMovPed->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = siteVolumeMovPed.Exists
        siteVolumeMovPed.Exists = True
        ```

### Volume {#volume}

Pedestrian Volume

```csharp
float Volume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float volume = siteVolumeMovPed.Volume;
        siteVolumeMovPed.Volume = 0.0;
        ```

    === "C++"

        ```cpp
        double volume;
        siteVolumeMovPed->get_Volume(&volume);
        siteVolumeMovPed->put_Volume(0.0);
        ```

    === "Python"

        ```python
        volume = siteVolumeMovPed.Volume
        siteVolumeMovPed.Volume = 0.0
        ```

### PeakFlowFactor {#peakflowfactor}

Peak Flow Factor (%)

```csharp
float PeakFlowFactor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float peakFlowFactor = siteVolumeMovPed.PeakFlowFactor;
        siteVolumeMovPed.PeakFlowFactor = 0.0;
        ```

    === "C++"

        ```cpp
        double peakFlowFactor;
        siteVolumeMovPed->get_PeakFlowFactor(&peakFlowFactor);
        siteVolumeMovPed->put_PeakFlowFactor(0.0);
        ```

    === "Python"

        ```python
        peak_flow_factor = siteVolumeMovPed.PeakFlowFactor
        siteVolumeMovPed.PeakFlowFactor = 0.0
        ```

### FlowScale {#flowscale}

Flow Scale (Constant) (%)

```csharp
float FlowScale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flowScale = siteVolumeMovPed.FlowScale;
        siteVolumeMovPed.FlowScale = 0.0;
        ```

    === "C++"

        ```cpp
        double flowScale;
        siteVolumeMovPed->get_FlowScale(&flowScale);
        siteVolumeMovPed->put_FlowScale(0.0);
        ```

    === "Python"

        ```python
        flow_scale = siteVolumeMovPed.FlowScale
        siteVolumeMovPed.FlowScale = 0.0
        ```

### GrowthRate {#growthrate}

Growth Rate (%/year)

```csharp
float GrowthRate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float growthRate = siteVolumeMovPed.GrowthRate;
        siteVolumeMovPed.GrowthRate = 0.0;
        ```

    === "C++"

        ```cpp
        double growthRate;
        siteVolumeMovPed->get_GrowthRate(&growthRate);
        siteVolumeMovPed->put_GrowthRate(0.0);
        ```

    === "Python"

        ```python
        growth_rate = siteVolumeMovPed.GrowthRate
        siteVolumeMovPed.GrowthRate = 0.0
        ```

### SiteVolumeBin {#sitevolumebin}

```csharp
ISIAPISiteVolumeBin SiteVolumeBin { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBin = siteVolumeMovPed.SiteVolumeBin;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
        siteVolumeMovPed->get_SiteVolumeBin(&siteVolumeBin);
        ```

    === "Python"

        ```python
        site_volume_bin = siteVolumeMovPed.SiteVolumeBin
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovpeds.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovPeds
title: SiteVolumeMovPeds
name: ISIAPISiteVolumeMovPeds
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: B0B3CDDA-629B-4CE5-9E9D-4B7B4D2E778B
members:
  - bool MovementExists(int type, int origin, int stage)
  - ISIAPISiteVolumeMovPed this[int type, int origin, int stage]
  - int Count
---

# SiteVolumeMovPeds

Type `ISIAPISiteVolumeMovPeds` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `B0B3CDDA-629B-4CE5-9E9D-4B7B4D2E778B`

## Declaration

```csharp
[Guid("B0B3CDDA-629B-4CE5-9E9D-4B7B4D2E778B")]
public interface ISIAPISiteVolumeMovPeds
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISiteVolumeMovPed`](sidrasolutions.si.api.isiapisitevolumemovped.md) | Get a Site Volume Bin Pedestrian Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int, int)](#movementexists-int--int--int) | `bool` | Get a value indicating whether a Site Volume Bin Pedestrian Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeMovPeds.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeMovPeds->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeMovPeds.Count
        ```

### this[] {#this}

Get a Site Volume Bin Pedestrian Movement.

```csharp
ISIAPISiteVolumeMovPed this[] { get; }
```

**Type** [`ISIAPISiteVolumeMovPed`](sidrasolutions.si.api.isiapisitevolumemovped.md) - Return a Site Volume Bin Pedestrian Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeMovPeds.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovPed> this[];
        siteVolumeMovPeds->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeMovPeds.this[]
        ```

## Methods

### MovementExists(int, int, int) {#movementexists-int--int--int}

Get a value indicating whether a Site Volume Bin Pedestrian Movement exists in the data storage.

```csharp
bool MovementExists(int type, int origin, int stage)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `type` | `int` | One of: - `1` - Full Crossing - `2` - Slip Lane - `3` - Staged - `4` - Diagonal |
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `stage` | `int` | One of: - `1` - Stage 1 (Approach-side crossing) - `2` - Stage 2 (Exit-side crossing) |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeMovPeds.MovementExists(0, 0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeMovPeds->MovementExists(0, 0, 0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeMovPeds.MovementExists(0, 0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovvehod.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovVehOD
title: SiteVolumeMovVehOD
name: ISIAPISiteVolumeMovVehOD
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: A1188259-4813-4003-B8F8-CA17BDE7CBB9
members:
  - int Origin
  - int Destination
  - bool IsPossible
  - bool Exists
  - float Total_volume
  - ISIAPISiteVolumeBin SiteVolumeBin
  - ISIAPISiteVolumeMovVehODMCs SiteVolumeMovVehODMCs
---

# SiteVolumeMovVehOD

Type `ISIAPISiteVolumeMovVehOD` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `A1188259-4813-4003-B8F8-CA17BDE7CBB9`

## Declaration

```csharp
[Guid("A1188259-4813-4003-B8F8-CA17BDE7CBB9")]
public interface ISIAPISiteVolumeMovVehOD
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Origin](#origin) | `int` | Movement Origin Leg |
| [Destination](#destination) | `int` | Movement Destination Leg |
| [IsPossible](#ispossible) | `bool` | Flag indicating whether this Approach Movement is Geometry Possible, i.e. the Origin Volume Bin Leg Geometry is Two-way or One-Way Approach, and the Destination Volume Bin Leg Geometry is Two-way or One-Way Exit. |
| [Exists](#exists) | `bool` | Flag indicating whether this Approach Movement "exists" (not banned) in the current Site Volume Bin. The state of this property corresponds to the setting of the "Movement Exists" checkbox in the SIDRA INTERSECTION "Site Bin Setup" dialog - "Approach Movements" tab for the given Approach Movement. |
| [Total_volume](#total_volume) | `float` |  |
| [SiteVolumeBin](#sitevolumebin) | [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md) |  |
| [SiteVolumeMovVehODMCs](#sitevolumemovvehodmcs) | [`ISIAPISiteVolumeMovVehODMCs`](sidrasolutions.si.api.isiapisitevolumemovvehodmcs.md) |  |

</div>

## Properties

### Origin {#origin}

Movement Origin Leg

```csharp
int Origin { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int origin = siteVolumeMovVehOD.Origin;
        ```

    === "C++"

        ```cpp
        long origin;
        siteVolumeMovVehOD->get_Origin(&origin);
        ```

    === "Python"

        ```python
        origin = siteVolumeMovVehOD.Origin
        ```

### Destination {#destination}

Movement Destination Leg

```csharp
int Destination { get; }
```

**Type** `int`

**Value**

One of:

- `0` - South
- `1` - South East
- `2` - East
- `3` - North East
- `4` - North
- `5` - North West
- `6` - West
- `7` - South West

???- example "Code samples"

    === "C#"

        ```csharp
        int destination = siteVolumeMovVehOD.Destination;
        ```

    === "C++"

        ```cpp
        long destination;
        siteVolumeMovVehOD->get_Destination(&destination);
        ```

    === "Python"

        ```python
        destination = siteVolumeMovVehOD.Destination
        ```

### IsPossible {#ispossible}

Flag indicating whether this Approach Movement is Geometry Possible, i.e. the Origin Volume Bin Leg Geometry is Two-way or One-Way Approach, and the Destination Volume Bin Leg Geometry is Two-way or One-Way Exit.

```csharp
bool IsPossible { get; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool isPossible = siteVolumeMovVehOD.IsPossible;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL isPossible;
        siteVolumeMovVehOD->get_IsPossible(&isPossible);
        ```

    === "Python"

        ```python
        is_possible = siteVolumeMovVehOD.IsPossible
        ```

### Exists {#exists}

Flag indicating whether this Approach Movement "exists" (not banned) in the current Site Volume Bin.

The state of this property corresponds to the setting of the "Movement Exists" checkbox in the 
SIDRA INTERSECTION "Site Bin Setup" dialog - "Approach Movements" tab for the given Approach Movement.

```csharp
bool Exists { get; set; }
```

**Type** `bool`

???- example "Code samples"

    === "C#"

        ```csharp
        bool exists = siteVolumeMovVehOD.Exists;
        siteVolumeMovVehOD.Exists = true;
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL exists;
        siteVolumeMovVehOD->get_Exists(&exists);
        siteVolumeMovVehOD->put_Exists(VARIANT_TRUE);
        ```

    === "Python"

        ```python
        exists = siteVolumeMovVehOD.Exists
        siteVolumeMovVehOD.Exists = True
        ```

### Total_volume {#total_volume}

```csharp
float Total_volume { get; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float total_volume = siteVolumeMovVehOD.Total_volume;
        ```

    === "C++"

        ```cpp
        double total_volume;
        siteVolumeMovVehOD->get_Total_volume(&total_volume);
        ```

    === "Python"

        ```python
        total_volume = siteVolumeMovVehOD.Total_volume
        ```

### SiteVolumeBin {#sitevolumebin}

```csharp
ISIAPISiteVolumeBin SiteVolumeBin { get; }
```

**Type** [`ISIAPISiteVolumeBin`](sidrasolutions.si.api.isiapisitevolumebin.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeBin = siteVolumeMovVehOD.SiteVolumeBin;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
        siteVolumeMovVehOD->get_SiteVolumeBin(&siteVolumeBin);
        ```

    === "Python"

        ```python
        site_volume_bin = siteVolumeMovVehOD.SiteVolumeBin
        ```

### SiteVolumeMovVehODMCs {#sitevolumemovvehodmcs}

```csharp
ISIAPISiteVolumeMovVehODMCs SiteVolumeMovVehODMCs { get; }
```

**Type** [`ISIAPISiteVolumeMovVehODMCs`](sidrasolutions.si.api.isiapisitevolumemovvehodmcs.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeMovVehODMCs = siteVolumeMovVehOD.SiteVolumeMovVehODMCs;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovVehODMCs> siteVolumeMovVehODMCs;
        siteVolumeMovVehOD->get_SiteVolumeMovVehODMCs(&siteVolumeMovVehODMCs);
        ```

    === "Python"

        ```python
        site_volume_mov_veh_odm_cs = siteVolumeMovVehOD.SiteVolumeMovVehODMCs
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovvehodmc.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovVehODMC
title: SiteVolumeMovVehODMC
name: ISIAPISiteVolumeMovVehODMC
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 8F90B992-9855-4819-8CEA-44CAFF66F85A
members:
  - int MCClass
  - float Volume
  - float Occupancy
  - float PeakFlowFactor
  - float FlowScale
  - float GrowthRate
  - ISIAPISiteVolumeMovVehOD SiteVolumeMovVehOD
---

# SiteVolumeMovVehODMC

Type `ISIAPISiteVolumeMovVehODMC` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `8F90B992-9855-4819-8CEA-44CAFF66F85A`

## Declaration

```csharp
[Guid("8F90B992-9855-4819-8CEA-44CAFF66F85A")]
public interface ISIAPISiteVolumeMovVehODMC
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [MCClass](#mcclass) | `int` | Movement Class Number |
| [Volume](#volume) | `float` | Volume (veh) |
| [Occupancy](#occupancy) | `float` | Vehicle Occupancy (persons/veh) |
| [PeakFlowFactor](#peakflowfactor) | `float` | Peak Flow Factor (%) |
| [FlowScale](#flowscale) | `float` | Flow Scale (Constant) (%) |
| [GrowthRate](#growthrate) | `float` | Growth rate (%/year) |
| [SiteVolumeMovVehOD](#sitevolumemovvehod) | [`ISIAPISiteVolumeMovVehOD`](sidrasolutions.si.api.isiapisitevolumemovvehod.md) |  |

</div>

## Properties

### MCClass {#mcclass}

Movement Class Number

```csharp
int MCClass { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Light Vehicles
- `2` - Heavy Vehicles
- `3` - Buses
- `4` - Bicycles
- `5` - Large Trucks
- `6` - Trams
- `7` - User Class 1
- `8` - User Class 2
- `9` - User Class 3
- `10` - User Class 4
- `11` - User Class 5
- `12` - User Class 6

???- example "Code samples"

    === "C#"

        ```csharp
        int mCClass = siteVolumeMovVehODMC.MCClass;
        ```

    === "C++"

        ```cpp
        long mCClass;
        siteVolumeMovVehODMC->get_MCClass(&mCClass);
        ```

    === "Python"

        ```python
        mc_class = siteVolumeMovVehODMC.MCClass
        ```

### Volume {#volume}

Volume (veh)

```csharp
float Volume { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float volume = siteVolumeMovVehODMC.Volume;
        siteVolumeMovVehODMC.Volume = 0.0;
        ```

    === "C++"

        ```cpp
        double volume;
        siteVolumeMovVehODMC->get_Volume(&volume);
        siteVolumeMovVehODMC->put_Volume(0.0);
        ```

    === "Python"

        ```python
        volume = siteVolumeMovVehODMC.Volume
        siteVolumeMovVehODMC.Volume = 0.0
        ```

### Occupancy {#occupancy}

Vehicle Occupancy (persons/veh)

```csharp
float Occupancy { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float occupancy = siteVolumeMovVehODMC.Occupancy;
        siteVolumeMovVehODMC.Occupancy = 0.0;
        ```

    === "C++"

        ```cpp
        double occupancy;
        siteVolumeMovVehODMC->get_Occupancy(&occupancy);
        siteVolumeMovVehODMC->put_Occupancy(0.0);
        ```

    === "Python"

        ```python
        occupancy = siteVolumeMovVehODMC.Occupancy
        siteVolumeMovVehODMC.Occupancy = 0.0
        ```

### PeakFlowFactor {#peakflowfactor}

Peak Flow Factor (%)

```csharp
float PeakFlowFactor { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float peakFlowFactor = siteVolumeMovVehODMC.PeakFlowFactor;
        siteVolumeMovVehODMC.PeakFlowFactor = 0.0;
        ```

    === "C++"

        ```cpp
        double peakFlowFactor;
        siteVolumeMovVehODMC->get_PeakFlowFactor(&peakFlowFactor);
        siteVolumeMovVehODMC->put_PeakFlowFactor(0.0);
        ```

    === "Python"

        ```python
        peak_flow_factor = siteVolumeMovVehODMC.PeakFlowFactor
        siteVolumeMovVehODMC.PeakFlowFactor = 0.0
        ```

### FlowScale {#flowscale}

Flow Scale (Constant) (%)

```csharp
float FlowScale { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float flowScale = siteVolumeMovVehODMC.FlowScale;
        siteVolumeMovVehODMC.FlowScale = 0.0;
        ```

    === "C++"

        ```cpp
        double flowScale;
        siteVolumeMovVehODMC->get_FlowScale(&flowScale);
        siteVolumeMovVehODMC->put_FlowScale(0.0);
        ```

    === "Python"

        ```python
        flow_scale = siteVolumeMovVehODMC.FlowScale
        siteVolumeMovVehODMC.FlowScale = 0.0
        ```

### GrowthRate {#growthrate}

Growth rate (%/year)

```csharp
float GrowthRate { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float growthRate = siteVolumeMovVehODMC.GrowthRate;
        siteVolumeMovVehODMC.GrowthRate = 0.0;
        ```

    === "C++"

        ```cpp
        double growthRate;
        siteVolumeMovVehODMC->get_GrowthRate(&growthRate);
        siteVolumeMovVehODMC->put_GrowthRate(0.0);
        ```

    === "Python"

        ```python
        growth_rate = siteVolumeMovVehODMC.GrowthRate
        siteVolumeMovVehODMC.GrowthRate = 0.0
        ```

### SiteVolumeMovVehOD {#sitevolumemovvehod}

```csharp
ISIAPISiteVolumeMovVehOD SiteVolumeMovVehOD { get; }
```

**Type** [`ISIAPISiteVolumeMovVehOD`](sidrasolutions.si.api.isiapisitevolumemovvehod.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var siteVolumeMovVehOD = siteVolumeMovVehODMC.SiteVolumeMovVehOD;
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovVehOD> siteVolumeMovVehOD;
        siteVolumeMovVehODMC->get_SiteVolumeMovVehOD(&siteVolumeMovVehOD);
        ```

    === "Python"

        ```python
        site_volume_mov_veh_od = siteVolumeMovVehODMC.SiteVolumeMovVehOD
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovvehodmcs.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovVehODMCs
title: SiteVolumeMovVehODMCs
name: ISIAPISiteVolumeMovVehODMCs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 62F2391B-7034-4853-A590-E49ECBABF4EF
members:
  - bool MovementClassExists(int mcClass)
  - ISIAPISiteVolumeMovVehODMC this[int mcClass]
  - int Count
---

# SiteVolumeMovVehODMCs

Type `ISIAPISiteVolumeMovVehODMCs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `62F2391B-7034-4853-A590-E49ECBABF4EF`

## Declaration

```csharp
[Guid("62F2391B-7034-4853-A590-E49ECBABF4EF")]
public interface ISIAPISiteVolumeMovVehODMCs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISiteVolumeMovVehODMC`](sidrasolutions.si.api.isiapisitevolumemovvehodmc.md) | Get a Site Volume Bin Vehicle Movement by Movement Class. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementClassExists(int)](#movementclassexists-int) | `bool` | Get a value indicating whether a Site Volume Bin Vehicle Movement by Movement Class exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeMovVehODMCs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeMovVehODMCs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeMovVehODMCs.Count
        ```

### this[] {#this}

Get a Site Volume Bin Vehicle Movement by Movement Class.

```csharp
ISIAPISiteVolumeMovVehODMC this[] { get; }
```

**Type** [`ISIAPISiteVolumeMovVehODMC`](sidrasolutions.si.api.isiapisitevolumemovvehodmc.md) - Return a Site Volume Bin Vehicle Movement by Movement Class if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeMovVehODMCs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovVehODMC> this[];
        siteVolumeMovVehODMCs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeMovVehODMCs.this[]
        ```

## Methods

### MovementClassExists(int) {#movementclassexists-int}

Get a value indicating whether a Site Volume Bin Vehicle Movement by Movement Class exists in the data storage.

```csharp
bool MovementClassExists(int mcClass)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `mcClass` | `int` | One of: - `1` - Light Vehicles - `2` - Heavy Vehicles - `3` - Buses - `4` - Bicycles - `5` - Large Trucks - `6` - Trams - `7` - User Class 1 - `8` - User Class 2 - `9` - User Class 3 - `10` - User Class 4 - `11` - User Class 5 - `12` - User Class 6 |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeMovVehODMCs.MovementClassExists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeMovVehODMCs->MovementClassExists(0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeMovVehODMCs.MovementClassExists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapisitevolumemovvehods.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPISiteVolumeMovVehODs
title: SiteVolumeMovVehODs
name: ISIAPISiteVolumeMovVehODs
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: E1F108F6-7251-4DD7-A1F5-640AB3F13D00
members:
  - bool MovementExists(int origin, int destination)
  - ISIAPISiteVolumeMovVehOD this[int origin, int destination]
  - int Count
---

# SiteVolumeMovVehODs

Type `ISIAPISiteVolumeMovVehODs` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `E1F108F6-7251-4DD7-A1F5-640AB3F13D00`

## Declaration

```csharp
[Guid("E1F108F6-7251-4DD7-A1F5-640AB3F13D00")]
public interface ISIAPISiteVolumeMovVehODs
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPISiteVolumeMovVehOD`](sidrasolutions.si.api.isiapisitevolumemovvehod.md) | Get a Site Volume Bin Vehicle Movement. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [MovementExists(int, int)](#movementexists-int--int) | `bool` | Get a value indicating whether a Site Volume Bin Vehicle Movement exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = siteVolumeMovVehODs.Count;
        ```

    === "C++"

        ```cpp
        long count;
        siteVolumeMovVehODs->get_Count(&count);
        ```

    === "Python"

        ```python
        count = siteVolumeMovVehODs.Count
        ```

### this[] {#this}

Get a Site Volume Bin Vehicle Movement.

```csharp
ISIAPISiteVolumeMovVehOD this[] { get; }
```

**Type** [`ISIAPISiteVolumeMovVehOD`](sidrasolutions.si.api.isiapisitevolumemovvehod.md) - Return a Site Volume Bin Vehicle Movement if it exists in the data storage; otherwise, null/Nothing.

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = siteVolumeMovVehODs.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPISiteVolumeMovVehOD> this[];
        siteVolumeMovVehODs->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = siteVolumeMovVehODs.this[]
        ```

## Methods

### MovementExists(int, int) {#movementexists-int--int}

Get a value indicating whether a Site Volume Bin Vehicle Movement exists in the data storage.

```csharp
bool MovementExists(int origin, int destination)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `origin` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |
| `destination` | `int` | One of: - `0` - South - `1` - South East - `2` - East - `3` - North East - `4` - North - `5` - North West - `6` - West - `7` - South West |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = siteVolumeMovVehODs.MovementExists(0, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        siteVolumeMovVehODs->MovementExists(0, 0, &result);
        ```

    === "Python"

        ```python
        result = siteVolumeMovVehODs.MovementExists(0, 0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrol.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPITwoWaySignControlAdjGeometryControl
title: TwoWaySignControlAdjGeometryControl
name: ISIAPITwoWaySignControlAdjGeometryControl
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 46EA6E3C-A54F-4CCE-B545-F3BC95A08CB7
members:
  - int Type
  - float Critical_gap_adj
  - float Followup_headway_adj
---

# TwoWaySignControlAdjGeometryControl

Type `ISIAPITwoWaySignControlAdjGeometryControl` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `46EA6E3C-A54F-4CCE-B545-F3BC95A08CB7`

## Declaration

```csharp
[Guid("46EA6E3C-A54F-4CCE-B545-F3BC95A08CB7")]
public interface ISIAPITwoWaySignControlAdjGeometryControl
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Type](#type) | `int` | The type of adjustment |
| [Critical_gap_adj](#critical_gap_adj) | `float` |  |
| [Followup_headway_adj](#followup_headway_adj) | `float` |  |

</div>

## Properties

### Type {#type}

The type of adjustment

```csharp
int Type { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Giveway/Yield Sign Control
- `2` - One-Way Major Road
- `3` - T-Intersection (Minor Road Turn)
- `4` - Entry Road Grade (for each per cent grade)
- `5` - Staged Crossing - Stage 1
- `6` - Staged Crossing - Stage 2
- `7` - U Turn (Major Road)
- `8` - User Adjustment

???- example "Code samples"

    === "C#"

        ```csharp
        int type = twoWaySignControlAdjGeometryControl.Type;
        ```

    === "C++"

        ```cpp
        long type;
        twoWaySignControlAdjGeometryControl->get_Type(&type);
        ```

    === "Python"

        ```python
        type = twoWaySignControlAdjGeometryControl.Type
        ```

### Critical_gap_adj {#critical_gap_adj}

```csharp
float Critical_gap_adj { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap_adj = twoWaySignControlAdjGeometryControl.Critical_gap_adj;
        twoWaySignControlAdjGeometryControl.Critical_gap_adj = 0.0;
        ```

    === "C++"

        ```cpp
        double critical_gap_adj;
        twoWaySignControlAdjGeometryControl->get_Critical_gap_adj(&critical_gap_adj);
        twoWaySignControlAdjGeometryControl->put_Critical_gap_adj(0.0);
        ```

    === "Python"

        ```python
        critical_gap_adj = twoWaySignControlAdjGeometryControl.Critical_gap_adj
        twoWaySignControlAdjGeometryControl.Critical_gap_adj = 0.0
        ```

### Followup_headway_adj {#followup_headway_adj}

```csharp
float Followup_headway_adj { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway_adj = twoWaySignControlAdjGeometryControl.Followup_headway_adj;
        twoWaySignControlAdjGeometryControl.Followup_headway_adj = 0.0;
        ```

    === "C++"

        ```cpp
        double followup_headway_adj;
        twoWaySignControlAdjGeometryControl->get_Followup_headway_adj(&followup_headway_adj);
        twoWaySignControlAdjGeometryControl->put_Followup_headway_adj(0.0);
        ```

    === "Python"

        ```python
        followup_headway_adj = twoWaySignControlAdjGeometryControl.Followup_headway_adj
        twoWaySignControlAdjGeometryControl.Followup_headway_adj = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrols.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPITwoWaySignControlAdjGeometryControls
title: TwoWaySignControlAdjGeometryControls
name: ISIAPITwoWaySignControlAdjGeometryControls
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: FF932A3A-F444-41B8-8BB5-CDCA5A604311
members:
  - bool Exists(int geoControlType)
  - ISIAPITwoWaySignControlAdjGeometryControl this[int geoControlType]
  - int Count
---

# TwoWaySignControlAdjGeometryControls

Type `ISIAPITwoWaySignControlAdjGeometryControls` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `FF932A3A-F444-41B8-8BB5-CDCA5A604311`

## Declaration

```csharp
[Guid("FF932A3A-F444-41B8-8BB5-CDCA5A604311")]
public interface ISIAPITwoWaySignControlAdjGeometryControls
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPITwoWaySignControlAdjGeometryControl`](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrol.md) | Get a data object for the specified Type of Geometry and Control. Return an object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Exists(int)](#exists-int) | `bool` | Get a value indicating whether the data object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = twoWaySignControlAdjGeometryControls.Count;
        ```

    === "C++"

        ```cpp
        long count;
        twoWaySignControlAdjGeometryControls->get_Count(&count);
        ```

    === "Python"

        ```python
        count = twoWaySignControlAdjGeometryControls.Count
        ```

### this[] {#this}

Get a data object for the specified Type of Geometry and Control.  
Return an object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPITwoWaySignControlAdjGeometryControl this[] { get; }
```

**Type** [`ISIAPITwoWaySignControlAdjGeometryControl`](sidrasolutions.si.api.isiapitwowaysigncontroladjgeometrycontrol.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = twoWaySignControlAdjGeometryControls.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPITwoWaySignControlAdjGeometryControl> this[];
        twoWaySignControlAdjGeometryControls->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = twoWaySignControlAdjGeometryControls.this[]
        ```

## Methods

### Exists(int) {#exists-int}

Get a value indicating whether the data object exists in the data storage.

```csharp
bool Exists(int geoControlType)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `geoControlType` | `int` | One of: - `1` - Give-Way / Yield Sign Control - `2` - One-Way Major Road - `3` - T Intersection (Minor Road Turn) - `4` - Entry Road Grade (for each per cent grade) - `5` - Staged Crossing - Stage 1 - `6` - Staged Crossing - Stage 2 - `7` - U Turn (Major Road) - `8` - User Adjustment |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = twoWaySignControlAdjGeometryControls.Exists(0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        twoWaySignControlAdjGeometryControls->Exists(0, &result);
        ```

    === "Python"

        ```python
        result = twoWaySignControlAdjGeometryControls.Exists(0)
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlane.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPITwoWaySignControlAdjMajorNumLane
title: TwoWaySignControlAdjMajorNumLane
name: ISIAPITwoWaySignControlAdjMajorNumLane
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 4214D4ED-C798-4BE8-A49B-4CF1114132F2
members:
  - int Major_num_lane
  - int Movement_type
  - float Critical_gap_adj
  - float Followup_headway_adj
---

# TwoWaySignControlAdjMajorNumLane

Type `ISIAPITwoWaySignControlAdjMajorNumLane` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `4214D4ED-C798-4BE8-A49B-4CF1114132F2`

## Declaration

```csharp
[Guid("4214D4ED-C798-4BE8-A49B-4CF1114132F2")]
public interface ISIAPITwoWaySignControlAdjMajorNumLane
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Major_num_lane](#major_num_lane) | `int` | Major Road Number of Lanes |
| [Movement_type](#movement_type) | `int` | Movement Type |
| [Critical_gap_adj](#critical_gap_adj) | `float` |  |
| [Followup_headway_adj](#followup_headway_adj) | `float` |  |

</div>

## Properties

### Major_num_lane {#major_num_lane}

Major Road Number of Lanes

```csharp
int Major_num_lane { get; }
```

**Type** `int`

**Value**

Can be 2, 3, 5, 6.

???- example "Code samples"

    === "C#"

        ```csharp
        int major_num_lane = twoWaySignControlAdjMajorNumLane.Major_num_lane;
        ```

    === "C++"

        ```cpp
        long major_num_lane;
        twoWaySignControlAdjMajorNumLane->get_Major_num_lane(&major_num_lane);
        ```

    === "Python"

        ```python
        major_num_lane = twoWaySignControlAdjMajorNumLane.Major_num_lane
        ```

### Movement_type {#movement_type}

Movement Type

```csharp
int Movement_type { get; }
```

**Type** `int`

**Value**

One of:

- `1` - Minor Road Left Turn
- `2` - Minor Road Through
- `3` - Minor Road Right Turn
- `4` - Major Road Turn (Right or Left)

???- example "Code samples"

    === "C#"

        ```csharp
        int movement_type = twoWaySignControlAdjMajorNumLane.Movement_type;
        ```

    === "C++"

        ```cpp
        long movement_type;
        twoWaySignControlAdjMajorNumLane->get_Movement_type(&movement_type);
        ```

    === "Python"

        ```python
        movement_type = twoWaySignControlAdjMajorNumLane.Movement_type
        ```

### Critical_gap_adj {#critical_gap_adj}

```csharp
float Critical_gap_adj { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float critical_gap_adj = twoWaySignControlAdjMajorNumLane.Critical_gap_adj;
        twoWaySignControlAdjMajorNumLane.Critical_gap_adj = 0.0;
        ```

    === "C++"

        ```cpp
        double critical_gap_adj;
        twoWaySignControlAdjMajorNumLane->get_Critical_gap_adj(&critical_gap_adj);
        twoWaySignControlAdjMajorNumLane->put_Critical_gap_adj(0.0);
        ```

    === "Python"

        ```python
        critical_gap_adj = twoWaySignControlAdjMajorNumLane.Critical_gap_adj
        twoWaySignControlAdjMajorNumLane.Critical_gap_adj = 0.0
        ```

### Followup_headway_adj {#followup_headway_adj}

```csharp
float Followup_headway_adj { get; set; }
```

**Type** `float`

???- example "Code samples"

    === "C#"

        ```csharp
        float followup_headway_adj = twoWaySignControlAdjMajorNumLane.Followup_headway_adj;
        twoWaySignControlAdjMajorNumLane.Followup_headway_adj = 0.0;
        ```

    === "C++"

        ```cpp
        double followup_headway_adj;
        twoWaySignControlAdjMajorNumLane->get_Followup_headway_adj(&followup_headway_adj);
        twoWaySignControlAdjMajorNumLane->put_Followup_headway_adj(0.0);
        ```

    === "Python"

        ```python
        followup_headway_adj = twoWaySignControlAdjMajorNumLane.Followup_headway_adj
        twoWaySignControlAdjMajorNumLane.Followup_headway_adj = 0.0
        ```

==============================================================================
SOURCE: api/sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlanes.md
==============================================================================

---
uid: SIDRASolutions.SI.API.ISIAPITwoWaySignControlAdjMajorNumLanes
title: TwoWaySignControlAdjMajorNumLanes
name: ISIAPITwoWaySignControlAdjMajorNumLanes
type: Interface
namespace: SIDRASolutions.SI.API
assembly: SIDRASolutions.SI.API
com_guid: 495A9B34-3AD7-466D-978D-E9FF7291141F
members:
  - bool Exists(int majorRoadNumOfLane, int movType)
  - ISIAPITwoWaySignControlAdjMajorNumLane this[int majorRoadNumOfLane, int movType]
  - int Count
---

# TwoWaySignControlAdjMajorNumLanes

Type `ISIAPITwoWaySignControlAdjMajorNumLanes` &middot; Interface  
Namespace `SIDRASolutions.SI.API`  
Assembly `SIDRASolutions.SI.API.dll`  
COM CLSID `495A9B34-3AD7-466D-978D-E9FF7291141F`

## Declaration

```csharp
[Guid("495A9B34-3AD7-466D-978D-E9FF7291141F")]
public interface ISIAPITwoWaySignControlAdjMajorNumLanes
```

## Members

<div class="api-member-index" markdown>

**Properties**

| Property | Type | Summary |
|---|---|---|
| [Count](#count) | `int` |  |
| [this[]](#this) | [`ISIAPITwoWaySignControlAdjMajorNumLane`](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlane.md) | Get a data object for the specified Number of Lanes on Major Road and the Movement Type. Return an object if it exists in the data storage; otherwise, null/Nothing. |

**Methods**

| Method | Returns | Summary |
|---|---|---|
| [Exists(int, int)](#exists-int--int) | `bool` | Get a value indicating whether the data object exists in the data storage. |

</div>

## Properties

### Count {#count}

```csharp
int Count { get; }
```

**Type** `int`

???- example "Code samples"

    === "C#"

        ```csharp
        int count = twoWaySignControlAdjMajorNumLanes.Count;
        ```

    === "C++"

        ```cpp
        long count;
        twoWaySignControlAdjMajorNumLanes->get_Count(&count);
        ```

    === "Python"

        ```python
        count = twoWaySignControlAdjMajorNumLanes.Count
        ```

### this[] {#this}

Get a data object for the specified Number of Lanes on Major Road and the Movement Type.  
Return an object if it exists in the data storage; otherwise, null/Nothing.

```csharp
ISIAPITwoWaySignControlAdjMajorNumLane this[] { get; }
```

**Type** [`ISIAPITwoWaySignControlAdjMajorNumLane`](sidrasolutions.si.api.isiapitwowaysigncontroladjmajornumlane.md)

???- example "Code samples"

    === "C#"

        ```csharp
        var this[] = twoWaySignControlAdjMajorNumLanes.this[];
        ```

    === "C++"

        ```cpp
        CComPtr<ISIAPITwoWaySignControlAdjMajorNumLane> this[];
        twoWaySignControlAdjMajorNumLanes->get_this[](&this[]);
        ```

    === "Python"

        ```python
        this[] = twoWaySignControlAdjMajorNumLanes.this[]
        ```

## Methods

### Exists(int, int) {#exists-int--int}

Get a value indicating whether the data object exists in the data storage.

```csharp
bool Exists(int majorRoadNumOfLane, int movType)
```

**Parameters**

| Name | Type | Description |
|---|---|---|
| `majorRoadNumOfLane` | `int` | Can be 2, 3, 5, 6. |
| `movType` | `int` | One of: - `1` - Minor Road Left Turn - `2` - Minor Road Through - `3` - Minor Road Right Turn - `4` - Major Road Turn (Right or Left) |

**Returns** `bool` - true if it exists in the data storage; otherwise, false

???- example "Code samples"

    === "C#"

        ```csharp
        bool result = twoWaySignControlAdjMajorNumLanes.Exists(1, 0);
        ```

    === "C++"

        ```cpp
        VARIANT_BOOL result;
        twoWaySignControlAdjMajorNumLanes->Exists(1, 0, &result);
        ```

    === "Python"

        ```python
        result = twoWaySignControlAdjMajorNumLanes.Exists(1, 0)
        ```