Skip to content

Movement_vehicle_od

Type ISIAPIMovement_vehicle_od · 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

[Guid("FCE0F299-3272-4D64-A0F6-8D591EE0B5E9")]
public interface ISIAPIMovement_vehicle_od

Members

Properties

Property Type Summary
Origin int Approach Movement Origin Leg
Destination int Approach Movement Destination Leg
ODMovDesignation int Approach Movement Designation
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 ISIAPIMovement_vehicle_od_mcs
Site ISIAPISite
Opposingmovement_vehicles ISIAPIOpposingmovement_vehicles
Opposingmovement_peds ISIAPIOpposingmovement_peds
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 int Approach Movement turn designation
Display_od_id string
Display_ltr_id string
Is_TWSC_adj_applied bool
Is_gap_acceptance_usergiven bool
Critical_gap float
Followup_headway float
End_departures float
Minimum_departures float
Exit_flow_effect float
Percent_opposed_by_nearest float
Opposing_ped_effect_option_signals int Opposing Pedestrian Effect Option (Signalised)
Opposing_ped_effect_option int Opposing Pedestrian Effect Option
Opposing_ped_effect_start_loss float
Total_volume float
Zebra_ped_gap_acceptance_option int Gap Acceptance Option for opposing Zebra Crossing Pedestrians
Zebra_ped_critical_gap float
Zebra_ped_followup_headway float
Zebra_ped_minimum_departures float

Properties

Origin

Approach Movement Origin Leg

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
Code samples
int origin = movement_vehicle_od.Origin;
long origin;
movement_vehicle_od->get_Origin(&origin);
origin = movement_vehicle_od.Origin
$origin = $movement_vehicle_od.Origin

Destination

Approach Movement Destination Leg

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
Code samples
int destination = movement_vehicle_od.Destination;
long destination;
movement_vehicle_od->get_Destination(&destination);
destination = movement_vehicle_od.Destination
$destination = $movement_vehicle_od.Destination

ODMovDesignation

Approach Movement Designation

int ODMovDesignation { get; }

Type int

Value

One of:

  • 0 - U
  • 1 - L3
  • 2 - L2
  • 3 - L1
  • 4 - T1
  • 5 - R1
  • 6 - R2
  • 7 - R3
Code samples
int oDMovDesignation = movement_vehicle_od.ODMovDesignation;
long oDMovDesignation;
movement_vehicle_od->get_ODMovDesignation(&oDMovDesignation);
od_mov_designation = movement_vehicle_od.ODMovDesignation
$oDMovDesignation = $movement_vehicle_od.ODMovDesignation

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.

bool IsPossible { get; }

Type bool

Code samples
bool isPossible = movement_vehicle_od.IsPossible;
VARIANT_BOOL isPossible;
movement_vehicle_od->get_IsPossible(&isPossible);
is_possible = movement_vehicle_od.IsPossible
$isPossible = $movement_vehicle_od.IsPossible

MovementVehicleODMCs

ISIAPIMovement_vehicle_od_mcs MovementVehicleODMCs { get; }

Type ISIAPIMovement_vehicle_od_mcs

Code samples
var movementVehicleODMCs = movement_vehicle_od.MovementVehicleODMCs;
CComPtr<ISIAPIMovement_vehicle_od_mcs> movementVehicleODMCs;
movement_vehicle_od->get_MovementVehicleODMCs(&movementVehicleODMCs);
movement_vehicle_odm_cs = movement_vehicle_od.MovementVehicleODMCs
$movementVehicleODMCs = $movement_vehicle_od.MovementVehicleODMCs

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples
var site = movement_vehicle_od.Site;
CComPtr<ISIAPISite> site;
movement_vehicle_od->get_Site(&site);
site = movement_vehicle_od.Site
$site = $movement_vehicle_od.Site

Opposingmovement_vehicles

ISIAPIOpposingmovement_vehicles Opposingmovement_vehicles { get; }

Type ISIAPIOpposingmovement_vehicles

Code samples
var opposingmovement_vehicles = movement_vehicle_od.Opposingmovement_vehicles;
CComPtr<ISIAPIOpposingmovement_vehicles> opposingmovement_vehicles;
movement_vehicle_od->get_Opposingmovement_vehicles(&opposingmovement_vehicles);
opposingmovement_vehicles = movement_vehicle_od.Opposingmovement_vehicles
$opposingmovement_vehicles = $movement_vehicle_od.Opposingmovement_vehicles

Opposingmovement_peds

ISIAPIOpposingmovement_peds Opposingmovement_peds { get; }

Type ISIAPIOpposingmovement_peds

Code samples
var opposingmovement_peds = movement_vehicle_od.Opposingmovement_peds;
CComPtr<ISIAPIOpposingmovement_peds> opposingmovement_peds;
movement_vehicle_od->get_Opposingmovement_peds(&opposingmovement_peds);
opposingmovement_peds = movement_vehicle_od.Opposingmovement_peds
$opposingmovement_peds = $movement_vehicle_od.Opposingmovement_peds

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.

bool Exists { get; set; }

Type bool

Code samples
bool exists = movement_vehicle_od.Exists;
movement_vehicle_od.Exists = true;
VARIANT_BOOL exists;
movement_vehicle_od->get_Exists(&exists);
movement_vehicle_od->put_Exists(VARIANT_TRUE);
exists = movement_vehicle_od.Exists
movement_vehicle_od.Exists = True
$exists = $movement_vehicle_od.Exists
$movement_vehicle_od.Exists = $true

Turndesignation

Approach Movement turn designation

int Turndesignation { get; set; }

Type int

Value

One of:

  • 1 - Left
  • 2 - Through
  • 3 - Right
Code samples
int turndesignation = movement_vehicle_od.Turndesignation;
movement_vehicle_od.Turndesignation = 0;
long turndesignation;
movement_vehicle_od->get_Turndesignation(&turndesignation);
movement_vehicle_od->put_Turndesignation(0);
turndesignation = movement_vehicle_od.Turndesignation
movement_vehicle_od.Turndesignation = 0
$turndesignation = $movement_vehicle_od.Turndesignation
$movement_vehicle_od.Turndesignation = 0

Display_od_id

string Display_od_id { get; set; }

Type string

Code samples
string display_od_id = movement_vehicle_od.Display_od_id;
movement_vehicle_od.Display_od_id = @"id-1";
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"));
display_od_id = movement_vehicle_od.Display_od_id
movement_vehicle_od.Display_od_id = r"id-1"
$display_od_id = $movement_vehicle_od.Display_od_id
$movement_vehicle_od.Display_od_id = "id-1"

Display_ltr_id

string Display_ltr_id { get; set; }

Type string

Code samples
string display_ltr_id = movement_vehicle_od.Display_ltr_id;
movement_vehicle_od.Display_ltr_id = @"id-1";
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"));
display_ltr_id = movement_vehicle_od.Display_ltr_id
movement_vehicle_od.Display_ltr_id = r"id-1"
$display_ltr_id = $movement_vehicle_od.Display_ltr_id
$movement_vehicle_od.Display_ltr_id = "id-1"

Is_TWSC_adj_applied

bool Is_TWSC_adj_applied { get; set; }

Type bool

Code samples
bool is_TWSC_adj_applied = movement_vehicle_od.Is_TWSC_adj_applied;
movement_vehicle_od.Is_TWSC_adj_applied = true;
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);
is_twsc_adj_applied = movement_vehicle_od.Is_TWSC_adj_applied
movement_vehicle_od.Is_TWSC_adj_applied = True
$is_TWSC_adj_applied = $movement_vehicle_od.Is_TWSC_adj_applied
$movement_vehicle_od.Is_TWSC_adj_applied = $true

Is_gap_acceptance_usergiven

bool Is_gap_acceptance_usergiven { get; set; }

Type bool

Code samples
bool is_gap_acceptance_usergiven = movement_vehicle_od.Is_gap_acceptance_usergiven;
movement_vehicle_od.Is_gap_acceptance_usergiven = true;
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);
is_gap_acceptance_usergiven = movement_vehicle_od.Is_gap_acceptance_usergiven
movement_vehicle_od.Is_gap_acceptance_usergiven = True
$is_gap_acceptance_usergiven = $movement_vehicle_od.Is_gap_acceptance_usergiven
$movement_vehicle_od.Is_gap_acceptance_usergiven = $true

Critical_gap

float Critical_gap { get; set; }

Type float

Code samples
float critical_gap = movement_vehicle_od.Critical_gap;
movement_vehicle_od.Critical_gap = 0.0;
double critical_gap;
movement_vehicle_od->get_Critical_gap(&critical_gap);
movement_vehicle_od->put_Critical_gap(0.0);
critical_gap = movement_vehicle_od.Critical_gap
movement_vehicle_od.Critical_gap = 0.0
$critical_gap = $movement_vehicle_od.Critical_gap
$movement_vehicle_od.Critical_gap = 0.0

Followup_headway

float Followup_headway { get; set; }

Type float

Code samples
float followup_headway = movement_vehicle_od.Followup_headway;
movement_vehicle_od.Followup_headway = 0.0;
double followup_headway;
movement_vehicle_od->get_Followup_headway(&followup_headway);
movement_vehicle_od->put_Followup_headway(0.0);
followup_headway = movement_vehicle_od.Followup_headway
movement_vehicle_od.Followup_headway = 0.0
$followup_headway = $movement_vehicle_od.Followup_headway
$movement_vehicle_od.Followup_headway = 0.0

End_departures

float End_departures { get; set; }

Type float

Code samples
float end_departures = movement_vehicle_od.End_departures;
movement_vehicle_od.End_departures = 0.0;
double end_departures;
movement_vehicle_od->get_End_departures(&end_departures);
movement_vehicle_od->put_End_departures(0.0);
end_departures = movement_vehicle_od.End_departures
movement_vehicle_od.End_departures = 0.0
$end_departures = $movement_vehicle_od.End_departures
$movement_vehicle_od.End_departures = 0.0

Minimum_departures

float Minimum_departures { get; set; }

Type float

Code samples
float minimum_departures = movement_vehicle_od.Minimum_departures;
movement_vehicle_od.Minimum_departures = 0.0;
double minimum_departures;
movement_vehicle_od->get_Minimum_departures(&minimum_departures);
movement_vehicle_od->put_Minimum_departures(0.0);
minimum_departures = movement_vehicle_od.Minimum_departures
movement_vehicle_od.Minimum_departures = 0.0
$minimum_departures = $movement_vehicle_od.Minimum_departures
$movement_vehicle_od.Minimum_departures = 0.0

Exit_flow_effect

float Exit_flow_effect { get; set; }

Type float

Code samples
float exit_flow_effect = movement_vehicle_od.Exit_flow_effect;
movement_vehicle_od.Exit_flow_effect = 0.0;
double exit_flow_effect;
movement_vehicle_od->get_Exit_flow_effect(&exit_flow_effect);
movement_vehicle_od->put_Exit_flow_effect(0.0);
exit_flow_effect = movement_vehicle_od.Exit_flow_effect
movement_vehicle_od.Exit_flow_effect = 0.0
$exit_flow_effect = $movement_vehicle_od.Exit_flow_effect
$movement_vehicle_od.Exit_flow_effect = 0.0

Percent_opposed_by_nearest

float Percent_opposed_by_nearest { get; set; }

Type float

Code samples
float percent_opposed_by_nearest = movement_vehicle_od.Percent_opposed_by_nearest;
movement_vehicle_od.Percent_opposed_by_nearest = 0.0;
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);
percent_opposed_by_nearest = movement_vehicle_od.Percent_opposed_by_nearest
movement_vehicle_od.Percent_opposed_by_nearest = 0.0
$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 Pedestrian Effect Option (Signalised)

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)
Code samples
int opposing_ped_effect_option_signals = movement_vehicle_od.Opposing_ped_effect_option_signals;
movement_vehicle_od.Opposing_ped_effect_option_signals = 0;
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);
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_signals = $movement_vehicle_od.Opposing_ped_effect_option_signals
$movement_vehicle_od.Opposing_ped_effect_option_signals = 0

Opposing_ped_effect_option

Opposing Pedestrian Effect Option

int Opposing_ped_effect_option { get; set; }

Type int

Value

One of:

  • 0 - None
  • 1 - Program (Flow)
Code samples
int opposing_ped_effect_option = movement_vehicle_od.Opposing_ped_effect_option;
movement_vehicle_od.Opposing_ped_effect_option = 0;
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);
opposing_ped_effect_option = movement_vehicle_od.Opposing_ped_effect_option
movement_vehicle_od.Opposing_ped_effect_option = 0
$opposing_ped_effect_option = $movement_vehicle_od.Opposing_ped_effect_option
$movement_vehicle_od.Opposing_ped_effect_option = 0

Opposing_ped_effect_start_loss

float Opposing_ped_effect_start_loss { get; set; }

Type float

Code samples
float opposing_ped_effect_start_loss = movement_vehicle_od.Opposing_ped_effect_start_loss;
movement_vehicle_od.Opposing_ped_effect_start_loss = 0.0;
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);
opposing_ped_effect_start_loss = movement_vehicle_od.Opposing_ped_effect_start_loss
movement_vehicle_od.Opposing_ped_effect_start_loss = 0.0
$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

float Total_volume { get; }

Type float

Code samples
float total_volume = movement_vehicle_od.Total_volume;
double total_volume;
movement_vehicle_od->get_Total_volume(&total_volume);
total_volume = movement_vehicle_od.Total_volume
$total_volume = $movement_vehicle_od.Total_volume

Zebra_ped_gap_acceptance_option

Gap Acceptance Option for opposing Zebra Crossing Pedestrians

int Zebra_ped_gap_acceptance_option { get; set; }

Type int

Value

One of:

  • 1 - Program
  • 2 - User Input
Code samples
int zebra_ped_gap_acceptance_option = movement_vehicle_od.Zebra_ped_gap_acceptance_option;
movement_vehicle_od.Zebra_ped_gap_acceptance_option = 0;
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);
zebra_ped_gap_acceptance_option = movement_vehicle_od.Zebra_ped_gap_acceptance_option
movement_vehicle_od.Zebra_ped_gap_acceptance_option = 0
$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

float Zebra_ped_critical_gap { get; set; }

Type float

Code samples
float zebra_ped_critical_gap = movement_vehicle_od.Zebra_ped_critical_gap;
movement_vehicle_od.Zebra_ped_critical_gap = 0.0;
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);
zebra_ped_critical_gap = movement_vehicle_od.Zebra_ped_critical_gap
movement_vehicle_od.Zebra_ped_critical_gap = 0.0
$zebra_ped_critical_gap = $movement_vehicle_od.Zebra_ped_critical_gap
$movement_vehicle_od.Zebra_ped_critical_gap = 0.0

Zebra_ped_followup_headway

float Zebra_ped_followup_headway { get; set; }

Type float

Code samples
float zebra_ped_followup_headway = movement_vehicle_od.Zebra_ped_followup_headway;
movement_vehicle_od.Zebra_ped_followup_headway = 0.0;
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);
zebra_ped_followup_headway = movement_vehicle_od.Zebra_ped_followup_headway
movement_vehicle_od.Zebra_ped_followup_headway = 0.0
$zebra_ped_followup_headway = $movement_vehicle_od.Zebra_ped_followup_headway
$movement_vehicle_od.Zebra_ped_followup_headway = 0.0

Zebra_ped_minimum_departures

float Zebra_ped_minimum_departures { get; set; }

Type float

Code samples
float zebra_ped_minimum_departures = movement_vehicle_od.Zebra_ped_minimum_departures;
movement_vehicle_od.Zebra_ped_minimum_departures = 0.0;
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);
zebra_ped_minimum_departures = movement_vehicle_od.Zebra_ped_minimum_departures
movement_vehicle_od.Zebra_ped_minimum_departures = 0.0
$zebra_ped_minimum_departures = $movement_vehicle_od.Zebra_ped_minimum_departures
$movement_vehicle_od.Zebra_ped_minimum_departures = 0.0