Skip to content

ISIAPIMovement_ped Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: BE5BC694-3D12-4F23-993B-96695CF219FA

SIDRA INTERSECTION Pedestrian Movement wrapper interface

Declaration

[Guid("BE5BC694-3D12-4F23-993B-96695CF219FA")]
public interface ISIAPIMovement_ped

Get an instance

// Navigate to the ISIAPIMovement_ped you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var movement_ped = /* ... */;

' Navigate to the ISIAPIMovement_ped you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim movement_ped As ISIAPIMovement_ped = Nothing

# Navigate to the ISIAPIMovement_ped you need via the ISIAPI tree.
# See ISIAPI for the activation root.
movement_ped = ...

# Navigate to the ISIAPIMovement_ped you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$movement_ped = $null

Properties

Type

The type of a Pedestrian Movement

int Type { get; }

Type int

Value

One of:

  • 1 - Full Crossing
  • 2 - Slip Lane
  • 3 - Staged
  • 4 - Diagonal
Code samples 
int type = movement_ped.Type;

Dim type As Integer = movement_ped.Type

type = movement_ped.Type

$type = $movement_ped.Type

Origin

Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs

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_ped.Origin;

Dim origin As Integer = movement_ped.Origin

origin = movement_ped.Origin

$origin = $movement_ped.Origin

Stage

Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian Movements on each Leg allowing modelling of "staged" pedestrian crossings.

int Stage { get; }

Type int

Value

One of:

  • 1 - Stage 1 (Approach-side crossing)
  • 2 - Stage 2 (Exit-side crossing)
Code samples 
int stage = movement_ped.Stage;

Dim stage As Integer = movement_ped.Stage

stage = movement_ped.Stage

$stage = $movement_ped.Stage

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples 
var site = movement_ped.Site;

Dim site As ISIAPISite = movement_ped.Site

site = movement_ped.Site

$site = $movement_ped.Site

Exists

Flag indicating whether this Pedestrian Movement "exists" (not banned) in the current Site.

bool Exists { get; set; }

Type bool

Code samples 
bool exists = movement_ped.Exists;
movement_ped.Exists = true;

Dim exists As Boolean = movement_ped.Exists
movement_ped.Exists = true

exists = movement_ped.Exists
movement_ped.Exists = True

$exists = $movement_ped.Exists
$movement_ped.Exists = $true

Display_id

Movement ID, a simple text descriptor for the movement used in many SIDRA INTERSECTION reports to signify the movement.

string Display_id { get; set; }

Type string

Code samples 
string display_id = movement_ped.Display_id;
movement_ped.Display_id = @"id-1";

Dim display_id As String = movement_ped.Display_id
movement_ped.Display_id = "id-1"

display_id = movement_ped.Display_id
movement_ped.Display_id = r"id-1"

$display_id = $movement_ped.Display_id
$movement_ped.Display_id = "id-1"

Volume

Pedestrian Volume

float Volume { get; set; }

Type float

Code samples 
float volume = movement_ped.Volume;
movement_ped.Volume = 0.0;

Dim volume As Single = movement_ped.Volume
movement_ped.Volume = 0.0

volume = movement_ped.Volume
movement_ped.Volume = 0.0

$volume = $movement_ped.Volume
$movement_ped.Volume = 0.0

Peak_flow_factor

Peak Flow Factor (%)

float Peak_flow_factor { get; set; }

Type float

Code samples 
float peak_flow_factor = movement_ped.Peak_flow_factor;
movement_ped.Peak_flow_factor = 0.0;

Dim peak_flow_factor As Single = movement_ped.Peak_flow_factor
movement_ped.Peak_flow_factor = 0.0

peak_flow_factor = movement_ped.Peak_flow_factor
movement_ped.Peak_flow_factor = 0.0

$peak_flow_factor = $movement_ped.Peak_flow_factor
$movement_ped.Peak_flow_factor = 0.0

Flow_scale

Flow Scale (Constant) (%)

float Flow_scale { get; set; }

Type float

Code samples 
float flow_scale = movement_ped.Flow_scale;
movement_ped.Flow_scale = 0.0;

Dim flow_scale As Single = movement_ped.Flow_scale
movement_ped.Flow_scale = 0.0

flow_scale = movement_ped.Flow_scale
movement_ped.Flow_scale = 0.0

$flow_scale = $movement_ped.Flow_scale
$movement_ped.Flow_scale = 0.0

Growth_rate

Growth Rate (%/year)

float Growth_rate { get; set; }

Type float

Code samples 
float growth_rate = movement_ped.Growth_rate;
movement_ped.Growth_rate = 0.0;

Dim growth_rate As Single = movement_ped.Growth_rate
movement_ped.Growth_rate = 0.0

growth_rate = movement_ped.Growth_rate
movement_ped.Growth_rate = 0.0

$growth_rate = $movement_ped.Growth_rate
$movement_ped.Growth_rate = 0.0

Opposing_ped_factor

float Opposing_ped_factor { get; set; }

Type float

Code samples 
float opposing_ped_factor = movement_ped.Opposing_ped_factor;
movement_ped.Opposing_ped_factor = 0.0;

Dim opposing_ped_factor As Single = movement_ped.Opposing_ped_factor
movement_ped.Opposing_ped_factor = 0.0

opposing_ped_factor = movement_ped.Opposing_ped_factor
movement_ped.Opposing_ped_factor = 0.0

$opposing_ped_factor = $movement_ped.Opposing_ped_factor
$movement_ped.Opposing_ped_factor = 0.0

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.

bool Practical_degree_of_saturation_user { get; set; }

Type bool

Code samples 
bool practical_degree_of_saturation_user = movement_ped.Practical_degree_of_saturation_user;
movement_ped.Practical_degree_of_saturation_user = true;

Dim practical_degree_of_saturation_user As Boolean = movement_ped.Practical_degree_of_saturation_user
movement_ped.Practical_degree_of_saturation_user = true

practical_degree_of_saturation_user = movement_ped.Practical_degree_of_saturation_user
movement_ped.Practical_degree_of_saturation_user = True

$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

float Practical_degree_of_saturation { get; set; }

Type float

Code samples 
float practical_degree_of_saturation = movement_ped.Practical_degree_of_saturation;
movement_ped.Practical_degree_of_saturation = 0.0;

Dim practical_degree_of_saturation As Single = movement_ped.Practical_degree_of_saturation
movement_ped.Practical_degree_of_saturation = 0.0

practical_degree_of_saturation = movement_ped.Practical_degree_of_saturation
movement_ped.Practical_degree_of_saturation = 0.0

$practical_degree_of_saturation = $movement_ped.Practical_degree_of_saturation
$movement_ped.Practical_degree_of_saturation = 0.0

Approach_distance

Approach Travel Distance

float Approach_distance { get; set; }

Type float

Code samples 
float approach_distance = movement_ped.Approach_distance;
movement_ped.Approach_distance = 0.0;

Dim approach_distance As Single = movement_ped.Approach_distance
movement_ped.Approach_distance = 0.0

approach_distance = movement_ped.Approach_distance
movement_ped.Approach_distance = 0.0

$approach_distance = $movement_ped.Approach_distance
$movement_ped.Approach_distance = 0.0

Queue_space

Queue Space

float Queue_space { get; set; }

Type float

Code samples 
float queue_space = movement_ped.Queue_space;
movement_ped.Queue_space = 0.0;

Dim queue_space As Single = movement_ped.Queue_space
movement_ped.Queue_space = 0.0

queue_space = movement_ped.Queue_space
movement_ped.Queue_space = 0.0

$queue_space = $movement_ped.Queue_space
$movement_ped.Queue_space = 0.0

Walking_speed

Walking Speed (Average)

float Walking_speed { get; set; }

Type float

Code samples 
float walking_speed = movement_ped.Walking_speed;
movement_ped.Walking_speed = 0.0;

Dim walking_speed As Single = movement_ped.Walking_speed
movement_ped.Walking_speed = 0.0

walking_speed = movement_ped.Walking_speed
movement_ped.Walking_speed = 0.0

$walking_speed = $movement_ped.Walking_speed
$movement_ped.Walking_speed = 0.0

Exit_distance

Exit (Downstream) Distance

float Exit_distance { get; set; }

Type float

Code samples 
float exit_distance = movement_ped.Exit_distance;
movement_ped.Exit_distance = 0.0;

Dim exit_distance As Single = movement_ped.Exit_distance
movement_ped.Exit_distance = 0.0

exit_distance = movement_ped.Exit_distance
movement_ped.Exit_distance = 0.0

$exit_distance = $movement_ped.Exit_distance
$movement_ped.Exit_distance = 0.0

Saturation_flow_rate

Saturation Flow (ped/h)

int Saturation_flow_rate { get; set; }

Type int

Code samples 
int saturation_flow_rate = movement_ped.Saturation_flow_rate;
movement_ped.Saturation_flow_rate = 0;

Dim saturation_flow_rate As Integer = movement_ped.Saturation_flow_rate
movement_ped.Saturation_flow_rate = 0

saturation_flow_rate = movement_ped.Saturation_flow_rate
movement_ped.Saturation_flow_rate = 0

$saturation_flow_rate = $movement_ped.Saturation_flow_rate
$movement_ped.Saturation_flow_rate = 0

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.

bool Crossing_distance_user { get; set; }

Type bool

Code samples 
bool crossing_distance_user = movement_ped.Crossing_distance_user;
movement_ped.Crossing_distance_user = true;

Dim crossing_distance_user As Boolean = movement_ped.Crossing_distance_user
movement_ped.Crossing_distance_user = true

crossing_distance_user = movement_ped.Crossing_distance_user
movement_ped.Crossing_distance_user = True

$crossing_distance_user = $movement_ped.Crossing_distance_user
$movement_ped.Crossing_distance_user = $true

Crossing_distance

Crossing Distance

float Crossing_distance { get; set; }

Type float

Code samples 
float crossing_distance = movement_ped.Crossing_distance;
movement_ped.Crossing_distance = 0.0;

Dim crossing_distance As Single = movement_ped.Crossing_distance
movement_ped.Crossing_distance = 0.0

crossing_distance = movement_ped.Crossing_distance
movement_ped.Crossing_distance = 0.0

$crossing_distance = $movement_ped.Crossing_distance
$movement_ped.Crossing_distance = 0.0

Minimum_green_time_user

bool Minimum_green_time_user { get; set; }

Type bool

Code samples 
bool minimum_green_time_user = movement_ped.Minimum_green_time_user;
movement_ped.Minimum_green_time_user = true;

Dim minimum_green_time_user As Boolean = movement_ped.Minimum_green_time_user
movement_ped.Minimum_green_time_user = true

minimum_green_time_user = movement_ped.Minimum_green_time_user
movement_ped.Minimum_green_time_user = True

$minimum_green_time_user = $movement_ped.Minimum_green_time_user
$movement_ped.Minimum_green_time_user = $true

Minimum_green_time

float Minimum_green_time { get; set; }

Type float

Code samples 
float minimum_green_time = movement_ped.Minimum_green_time;
movement_ped.Minimum_green_time = 0.0;

Dim minimum_green_time As Single = movement_ped.Minimum_green_time
movement_ped.Minimum_green_time = 0.0

minimum_green_time = movement_ped.Minimum_green_time
movement_ped.Minimum_green_time = 0.0

$minimum_green_time = $movement_ped.Minimum_green_time
$movement_ped.Minimum_green_time = 0.0

Maximum_green_time_user

bool Maximum_green_time_user { get; set; }

Type bool

Code samples 
bool maximum_green_time_user = movement_ped.Maximum_green_time_user;
movement_ped.Maximum_green_time_user = true;

Dim maximum_green_time_user As Boolean = movement_ped.Maximum_green_time_user
movement_ped.Maximum_green_time_user = true

maximum_green_time_user = movement_ped.Maximum_green_time_user
movement_ped.Maximum_green_time_user = True

$maximum_green_time_user = $movement_ped.Maximum_green_time_user
$movement_ped.Maximum_green_time_user = $true

Maximum_green_time

float Maximum_green_time { get; set; }

Type float

Code samples 
float maximum_green_time = movement_ped.Maximum_green_time;
movement_ped.Maximum_green_time = 0.0;

Dim maximum_green_time As Single = movement_ped.Maximum_green_time
movement_ped.Maximum_green_time = 0.0

maximum_green_time = movement_ped.Maximum_green_time
movement_ped.Maximum_green_time = 0.0

$maximum_green_time = $movement_ped.Maximum_green_time
$movement_ped.Maximum_green_time = 0.0

Is_walk_time_extended

bool Is_walk_time_extended { get; set; }

Type bool

Code samples 
bool is_walk_time_extended = movement_ped.Is_walk_time_extended;
movement_ped.Is_walk_time_extended = true;

Dim is_walk_time_extended As Boolean = movement_ped.Is_walk_time_extended
movement_ped.Is_walk_time_extended = true

is_walk_time_extended = movement_ped.Is_walk_time_extended
movement_ped.Is_walk_time_extended = True

$is_walk_time_extended = $movement_ped.Is_walk_time_extended
$movement_ped.Is_walk_time_extended = $true

Crossing_speed

float Crossing_speed { get; set; }

Type float

Code samples 
float crossing_speed = movement_ped.Crossing_speed;
movement_ped.Crossing_speed = 0.0;

Dim crossing_speed As Single = movement_ped.Crossing_speed
movement_ped.Crossing_speed = 0.0

crossing_speed = movement_ped.Crossing_speed
movement_ped.Crossing_speed = 0.0

$crossing_speed = $movement_ped.Crossing_speed
$movement_ped.Crossing_speed = 0.0

Minimum_walk_time

float Minimum_walk_time { get; set; }

Type float

Code samples 
float minimum_walk_time = movement_ped.Minimum_walk_time;
movement_ped.Minimum_walk_time = 0.0;

Dim minimum_walk_time As Single = movement_ped.Minimum_walk_time
movement_ped.Minimum_walk_time = 0.0

minimum_walk_time = movement_ped.Minimum_walk_time
movement_ped.Minimum_walk_time = 0.0

$minimum_walk_time = $movement_ped.Minimum_walk_time
$movement_ped.Minimum_walk_time = 0.0

Minimum_clearance_time

float Minimum_clearance_time { get; set; }

Type float

Code samples 
float minimum_clearance_time = movement_ped.Minimum_clearance_time;
movement_ped.Minimum_clearance_time = 0.0;

Dim minimum_clearance_time As Single = movement_ped.Minimum_clearance_time
movement_ped.Minimum_clearance_time = 0.0

minimum_clearance_time = movement_ped.Minimum_clearance_time
movement_ped.Minimum_clearance_time = 0.0

$minimum_clearance_time = $movement_ped.Minimum_clearance_time
$movement_ped.Minimum_clearance_time = 0.0

Clearance1_time_user

bool Clearance1_time_user { get; set; }

Type bool

Code samples 
bool clearance1_time_user = movement_ped.Clearance1_time_user;
movement_ped.Clearance1_time_user = true;

Dim clearance1_time_user As Boolean = movement_ped.Clearance1_time_user
movement_ped.Clearance1_time_user = true

clearance1_time_user = movement_ped.Clearance1_time_user
movement_ped.Clearance1_time_user = True

$clearance1_time_user = $movement_ped.Clearance1_time_user
$movement_ped.Clearance1_time_user = $true

Clearance1_time

float Clearance1_time { get; set; }

Type float

Code samples 
float clearance1_time = movement_ped.Clearance1_time;
movement_ped.Clearance1_time = 0.0;

Dim clearance1_time As Single = movement_ped.Clearance1_time
movement_ped.Clearance1_time = 0.0

clearance1_time = movement_ped.Clearance1_time
movement_ped.Clearance1_time = 0.0

$clearance1_time = $movement_ped.Clearance1_time
$movement_ped.Clearance1_time = 0.0

Clearance2_time_option

Clearance 2 Time Option

int Clearance2_time_option { get; set; }

Type int

Value

One of:

  • 0 - User Input (default)
  • 1 - Yellow Time
  • 2 - Intergreen Time
Code samples 
int clearance2_time_option = movement_ped.Clearance2_time_option;
movement_ped.Clearance2_time_option = 0;

Dim clearance2_time_option As Integer = movement_ped.Clearance2_time_option
movement_ped.Clearance2_time_option = 0

clearance2_time_option = movement_ped.Clearance2_time_option
movement_ped.Clearance2_time_option = 0

$clearance2_time_option = $movement_ped.Clearance2_time_option
$movement_ped.Clearance2_time_option = 0

Clearance2_time

float Clearance2_time { get; set; }

Type float

Code samples 
float clearance2_time = movement_ped.Clearance2_time;
movement_ped.Clearance2_time = 0.0;

Dim clearance2_time As Single = movement_ped.Clearance2_time
movement_ped.Clearance2_time = 0.0

clearance2_time = movement_ped.Clearance2_time
movement_ped.Clearance2_time = 0.0

$clearance2_time = $movement_ped.Clearance2_time
$movement_ped.Clearance2_time = 0.0

Start_loss

float Start_loss { get; set; }

Type float

Code samples 
float start_loss = movement_ped.Start_loss;
movement_ped.Start_loss = 0.0;

Dim start_loss As Single = movement_ped.Start_loss
movement_ped.Start_loss = 0.0

start_loss = movement_ped.Start_loss
movement_ped.Start_loss = 0.0

$start_loss = $movement_ped.Start_loss
$movement_ped.Start_loss = 0.0

End_gain

float End_gain { get; set; }

Type float

Code samples 
float end_gain = movement_ped.End_gain;
movement_ped.End_gain = 0.0;

Dim end_gain As Single = movement_ped.End_gain
movement_ped.End_gain = 0.0

end_gain = movement_ped.End_gain
movement_ped.End_gain = 0.0

$end_gain = $movement_ped.End_gain
$movement_ped.End_gain = 0.0

Actuation_option

int Actuation_option { get; set; }

Type int

Code samples 
int actuation_option = movement_ped.Actuation_option;
movement_ped.Actuation_option = 0;

Dim actuation_option As Integer = movement_ped.Actuation_option
movement_ped.Actuation_option = 0

actuation_option = movement_ped.Actuation_option
movement_ped.Actuation_option = 0

$actuation_option = $movement_ped.Actuation_option
$movement_ped.Actuation_option = 0

Actuation_percent

float Actuation_percent { get; set; }

Type float

Code samples 
float actuation_percent = movement_ped.Actuation_percent;
movement_ped.Actuation_percent = 0.0;

Dim actuation_percent As Single = movement_ped.Actuation_percent
movement_ped.Actuation_percent = 0.0

actuation_percent = movement_ped.Actuation_percent
movement_ped.Actuation_percent = 0.0

$actuation_percent = $movement_ped.Actuation_percent
$movement_ped.Actuation_percent = 0.0

Is_high_priority

High Priority for Green Splits

bool Is_high_priority { get; set; }

Type bool

Code samples 
bool is_high_priority = movement_ped.Is_high_priority;
movement_ped.Is_high_priority = true;

Dim is_high_priority As Boolean = movement_ped.Is_high_priority
movement_ped.Is_high_priority = true

is_high_priority = movement_ped.Is_high_priority
movement_ped.Is_high_priority = True

$is_high_priority = $movement_ped.Is_high_priority
$movement_ped.Is_high_priority = $true

Crosswalk_space

float Crosswalk_space { get; set; }

Type float

Code samples 
float crosswalk_space = movement_ped.Crosswalk_space;
movement_ped.Crosswalk_space = 0.0;

Dim crosswalk_space As Single = movement_ped.Crosswalk_space
movement_ped.Crosswalk_space = 0.0

crosswalk_space = movement_ped.Crosswalk_space
movement_ped.Crosswalk_space = 0.0

$crosswalk_space = $movement_ped.Crosswalk_space
$movement_ped.Crosswalk_space = 0.0

Conflict_zone_length_user

bool Conflict_zone_length_user { get; set; }

Type bool

Code samples 
bool conflict_zone_length_user = movement_ped.Conflict_zone_length_user;
movement_ped.Conflict_zone_length_user = true;

Dim conflict_zone_length_user As Boolean = movement_ped.Conflict_zone_length_user
movement_ped.Conflict_zone_length_user = true

conflict_zone_length_user = movement_ped.Conflict_zone_length_user
movement_ped.Conflict_zone_length_user = True

$conflict_zone_length_user = $movement_ped.Conflict_zone_length_user
$movement_ped.Conflict_zone_length_user = $true

Conflict_zone_length

float Conflict_zone_length { get; set; }

Type float

Code samples 
float conflict_zone_length = movement_ped.Conflict_zone_length;
movement_ped.Conflict_zone_length = 0.0;

Dim conflict_zone_length As Single = movement_ped.Conflict_zone_length
movement_ped.Conflict_zone_length = 0.0

conflict_zone_length = movement_ped.Conflict_zone_length
movement_ped.Conflict_zone_length = 0.0

$conflict_zone_length = $movement_ped.Conflict_zone_length
$movement_ped.Conflict_zone_length = 0.0

Control_type

int Control_type { get; set; }

Type int

Code samples 
int control_type = movement_ped.Control_type;
movement_ped.Control_type = 0;

Dim control_type As Integer = movement_ped.Control_type
movement_ped.Control_type = 0

control_type = movement_ped.Control_type
movement_ped.Control_type = 0

$control_type = $movement_ped.Control_type
$movement_ped.Control_type = 0