ISIAPIAnalysis Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 7E3AF260-B181-4F2D-A974-FEE9F6888AE6

Declaration

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

Get an instance

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPIAnalysis you need via the ISIAPI tree.
# See ISIAPI for the activation root.
analysis = ...

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

Properties

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#VB.NETPythonPowerShell

var site = analysis.Site;

Dim site As ISIAPISite = analysis.Site

site = analysis.Site

$site = $analysis.Site

Analysis_option

Analysis Option

int Analysis_option { get; set; }

Type int

Value

One of:

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

Code samples

C#VB.NETPythonPowerShell

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

Dim analysis_option As Integer = analysis.Analysis_option
analysis.Analysis_option = 0

analysis_option = analysis.Analysis_option
analysis.Analysis_option = 0

$analysis_option = $analysis.Analysis_option
$analysis.Analysis_option = 0

Selected_sensitivity_groupno

Selected Sensitivity Parameter Group Number

int Selected_sensitivity_groupno { get; set; }

Type int

Value

One of:

• 0 - General Parameter Group
• 1 - Roundabout Parameter Group

Code samples

C#VB.NETPythonPowerShell

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

Dim selected_sensitivity_groupno As Integer = analysis.Selected_sensitivity_groupno
analysis.Selected_sensitivity_groupno = 0

selected_sensitivity_groupno = analysis.Selected_sensitivity_groupno
analysis.Selected_sensitivity_groupno = 0

$selected_sensitivity_groupno = $analysis.Selected_sensitivity_groupno
$analysis.Selected_sensitivity_groupno = 0

Design_Life_Objective

Design Life Analysis Objective

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

Code samples

C#VB.NETPythonPowerShell

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

Dim design_Life_Objective As Integer = analysis.Design_Life_Objective
analysis.Design_Life_Objective = 0

design__life__objective = analysis.Design_Life_Objective
analysis.Design_Life_Objective = 0

$design_Life_Objective = $analysis.Design_Life_Objective
$analysis.Design_Life_Objective = 0

Design_Life_Growth_Model

Design Life Analysis Growth Model

int Design_Life_Growth_Model { get; set; }

Type int

Value

One of:

• 0 - Uniform
• 1 - Compound

Code samples

C#VB.NETPythonPowerShell

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

Dim design_Life_Growth_Model As Integer = analysis.Design_Life_Growth_Model
analysis.Design_Life_Growth_Model = 0

design__life__growth__model = analysis.Design_Life_Growth_Model
analysis.Design_Life_Growth_Model = 0

$design_Life_Growth_Model = $analysis.Design_Life_Growth_Model
$analysis.Design_Life_Growth_Model = 0

Design_Life_Years

int Design_Life_Years { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim design_Life_Years As Integer = analysis.Design_Life_Years
analysis.Design_Life_Years = 0

design__life__years = analysis.Design_Life_Years
analysis.Design_Life_Years = 0

$design_Life_Years = $analysis.Design_Life_Years
$analysis.Design_Life_Years = 0

Design_Life_Is_constant_num_years_applied

bool Design_Life_Is_constant_num_years_applied { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

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;

Dim design_Life_Is_constant_num_years_applied As Boolean = analysis.Design_Life_Is_constant_num_years_applied
analysis.Design_Life_Is_constant_num_years_applied = true

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_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

int Design_Life_Constant_num_years { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim design_Life_Constant_num_years As Integer = analysis.Design_Life_Constant_num_years
analysis.Design_Life_Constant_num_years = 1

design__life__constant_num_years = analysis.Design_Life_Constant_num_years
analysis.Design_Life_Constant_num_years = 1

$design_Life_Constant_num_years = $analysis.Design_Life_Constant_num_years
$analysis.Design_Life_Constant_num_years = 1

Flow_Scale_Objective

Flow Scale Analysis Objective

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

Code samples

C#VB.NETPythonPowerShell

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

Dim flow_Scale_Objective As Integer = analysis.Flow_Scale_Objective
analysis.Flow_Scale_Objective = 0

flow__scale__objective = analysis.Flow_Scale_Objective
analysis.Flow_Scale_Objective = 0

$flow_Scale_Objective = $analysis.Flow_Scale_Objective
$analysis.Flow_Scale_Objective = 0

Flow_Scale_Lower

float Flow_Scale_Lower { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

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

Dim flow_Scale_Lower As Single = analysis.Flow_Scale_Lower
analysis.Flow_Scale_Lower = 0.0

flow__scale__lower = analysis.Flow_Scale_Lower
analysis.Flow_Scale_Lower = 0.0

$flow_Scale_Lower = $analysis.Flow_Scale_Lower
$analysis.Flow_Scale_Lower = 0.0

Flow_Scale_Upper

float Flow_Scale_Upper { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

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

Dim flow_Scale_Upper As Single = analysis.Flow_Scale_Upper
analysis.Flow_Scale_Upper = 0.0

flow__scale__upper = analysis.Flow_Scale_Upper
analysis.Flow_Scale_Upper = 0.0

$flow_Scale_Upper = $analysis.Flow_Scale_Upper
$analysis.Flow_Scale_Upper = 0.0

Flow_Scale_Is_constant_factor_applied

bool Flow_Scale_Is_constant_factor_applied { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

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

Dim flow_Scale_Is_constant_factor_applied As Boolean = analysis.Flow_Scale_Is_constant_factor_applied
analysis.Flow_Scale_Is_constant_factor_applied = true

flow__scale__is_constant_factor_applied = analysis.Flow_Scale_Is_constant_factor_applied
analysis.Flow_Scale_Is_constant_factor_applied = True

$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

float Flow_Scale_Constant_factor { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

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

Dim flow_Scale_Constant_factor As Single = analysis.Flow_Scale_Constant_factor
analysis.Flow_Scale_Constant_factor = 0.0

flow__scale__constant_factor = analysis.Flow_Scale_Constant_factor
analysis.Flow_Scale_Constant_factor = 0.0

$flow_Scale_Constant_factor = $analysis.Flow_Scale_Constant_factor
$analysis.Flow_Scale_Constant_factor = 0.0

SensitivityGeneralParameterGroup

ISIAPISensitivity SensitivityGeneralParameterGroup { get; }

Type ISIAPISensitivity

Code samples

C#VB.NETPythonPowerShell

var sensitivityGeneralParameterGroup = analysis.SensitivityGeneralParameterGroup;

Dim sensitivityGeneralParameterGroup As ISIAPISensitivity = analysis.SensitivityGeneralParameterGroup

sensitivity_general_parameter_group = analysis.SensitivityGeneralParameterGroup

$sensitivityGeneralParameterGroup = $analysis.SensitivityGeneralParameterGroup

SensitivityRoundaboutParameterGroup

ISIAPISensitivity SensitivityRoundaboutParameterGroup { get; }

Type ISIAPISensitivity

Code samples

C#VB.NETPythonPowerShell

var sensitivityRoundaboutParameterGroup = analysis.SensitivityRoundaboutParameterGroup;

Dim sensitivityRoundaboutParameterGroup As ISIAPISensitivity = analysis.SensitivityRoundaboutParameterGroup

sensitivity_roundabout_parameter_group = analysis.SensitivityRoundaboutParameterGroup

$sensitivityRoundaboutParameterGroup = $analysis.SensitivityRoundaboutParameterGroup

Result_option

Results For

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)

Code samples

C#VB.NETPythonPowerShell

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

Dim result_option As Integer = analysis.Result_option
analysis.Result_option = 0

result_option = analysis.Result_option
analysis.Result_option = 0

$result_option = $analysis.Result_option
$analysis.Result_option = 0

Result_leg_origin

int Result_leg_origin { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_leg_origin As Integer = analysis.Result_leg_origin
analysis.Result_leg_origin = 0

result_leg_origin = analysis.Result_leg_origin
analysis.Result_leg_origin = 0

$result_leg_origin = $analysis.Result_leg_origin
$analysis.Result_leg_origin = 0

Result_lane_origin

int Result_lane_origin { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_lane_origin As Integer = analysis.Result_lane_origin
analysis.Result_lane_origin = 0

result_lane_origin = analysis.Result_lane_origin
analysis.Result_lane_origin = 0

$result_lane_origin = $analysis.Result_lane_origin
$analysis.Result_lane_origin = 0

Result_laneno

int Result_laneno { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_laneno As Integer = analysis.Result_laneno
analysis.Result_laneno = 0

result_laneno = analysis.Result_laneno
analysis.Result_laneno = 0

$result_laneno = $analysis.Result_laneno
$analysis.Result_laneno = 0

Result_vehmov_origin

int Result_vehmov_origin { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_vehmov_origin As Integer = analysis.Result_vehmov_origin
analysis.Result_vehmov_origin = 0

result_vehmov_origin = analysis.Result_vehmov_origin
analysis.Result_vehmov_origin = 0

$result_vehmov_origin = $analysis.Result_vehmov_origin
$analysis.Result_vehmov_origin = 0

Result_vehmov_dest

int Result_vehmov_dest { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_vehmov_dest As Integer = analysis.Result_vehmov_dest
analysis.Result_vehmov_dest = 0

result_vehmov_dest = analysis.Result_vehmov_dest
analysis.Result_vehmov_dest = 0

$result_vehmov_dest = $analysis.Result_vehmov_dest
$analysis.Result_vehmov_dest = 0

Result_mc_class

int Result_mc_class { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_mc_class As Integer = analysis.Result_mc_class
analysis.Result_mc_class = 0

result_mc_class = analysis.Result_mc_class
analysis.Result_mc_class = 0

$result_mc_class = $analysis.Result_mc_class
$analysis.Result_mc_class = 0

Result_pedmov_option

Pedestrian Movement Results Option

int Result_pedmov_option { get; set; }

Type int

Value

One of:

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

Code samples

C#VB.NETPythonPowerShell

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

Dim result_pedmov_option As Integer = analysis.Result_pedmov_option
analysis.Result_pedmov_option = 0

result_pedmov_option = analysis.Result_pedmov_option
analysis.Result_pedmov_option = 0

$result_pedmov_option = $analysis.Result_pedmov_option
$analysis.Result_pedmov_option = 0

Result_pedmov_origin

int Result_pedmov_origin { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_pedmov_origin As Integer = analysis.Result_pedmov_origin
analysis.Result_pedmov_origin = 0

result_pedmov_origin = analysis.Result_pedmov_origin
analysis.Result_pedmov_origin = 0

$result_pedmov_origin = $analysis.Result_pedmov_origin
$analysis.Result_pedmov_origin = 0

Result_pedmov_type

int Result_pedmov_type { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_pedmov_type As Integer = analysis.Result_pedmov_type
analysis.Result_pedmov_type = 0

result_pedmov_type = analysis.Result_pedmov_type
analysis.Result_pedmov_type = 0

$result_pedmov_type = $analysis.Result_pedmov_type
$analysis.Result_pedmov_type = 0

Result_pedmov_stage_no

int Result_pedmov_stage_no { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

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

Dim result_pedmov_stage_no As Integer = analysis.Result_pedmov_stage_no
analysis.Result_pedmov_stage_no = 0

result_pedmov_stage_no = analysis.Result_pedmov_stage_no
analysis.Result_pedmov_stage_no = 0

$result_pedmov_stage_no = $analysis.Result_pedmov_stage_no
$analysis.Result_pedmov_stage_no = 0