Skip to content

ISIAPIOutputAnalysis Interface

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 264A9C9D-52AA-4812-9266-B632B1449E16

Declaration

[Guid("264A9C9D-52AA-4812-9266-B632B1449E16")]
public interface ISIAPIOutputAnalysis

Get an instance

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

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

# Navigate to the ISIAPIOutputAnalysis you need via the ISIAPI tree.
# See ISIAPI for the activation root.
outputAnalysis = ...

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

Properties

Design_Life_Selected_future_year

int Design_Life_Selected_future_year { get; }

Type int

Code samples 
int design_Life_Selected_future_year = outputAnalysis.Design_Life_Selected_future_year;

Dim design_Life_Selected_future_year As Integer = outputAnalysis.Design_Life_Selected_future_year

design__life__selected_future_year = outputAnalysis.Design_Life_Selected_future_year

$design_Life_Selected_future_year = $outputAnalysis.Design_Life_Selected_future_year

Design_Life_Analysis_status

Design Life Analysis Status

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
Code samples 
int design_Life_Analysis_status = outputAnalysis.Design_Life_Analysis_status;

Dim design_Life_Analysis_status As Integer = outputAnalysis.Design_Life_Analysis_status

design__life__analysis_status = outputAnalysis.Design_Life_Analysis_status

$design_Life_Analysis_status = $outputAnalysis.Design_Life_Analysis_status

Flow_Scale_Largest_movement_flow_scale

float Flow_Scale_Largest_movement_flow_scale { get; }

Type float

Code samples 
float flow_Scale_Largest_movement_flow_scale = outputAnalysis.Flow_Scale_Largest_movement_flow_scale;

Dim flow_Scale_Largest_movement_flow_scale As Single = outputAnalysis.Flow_Scale_Largest_movement_flow_scale

flow__scale__largest_movement_flow_scale = outputAnalysis.Flow_Scale_Largest_movement_flow_scale

$flow_Scale_Largest_movement_flow_scale = $outputAnalysis.Flow_Scale_Largest_movement_flow_scale

Flow_Scale_Analysis_status

Flow Scale Analysis Status

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
Code samples 
int flow_Scale_Analysis_status = outputAnalysis.Flow_Scale_Analysis_status;

Dim flow_Scale_Analysis_status As Integer = outputAnalysis.Flow_Scale_Analysis_status

flow__scale__analysis_status = outputAnalysis.Flow_Scale_Analysis_status

$flow_Scale_Analysis_status = $outputAnalysis.Flow_Scale_Analysis_status

Sensitivity_Selected_parameter_scale

float Sensitivity_Selected_parameter_scale { get; }

Type float

Code samples 
float sensitivity_Selected_parameter_scale = outputAnalysis.Sensitivity_Selected_parameter_scale;

Dim sensitivity_Selected_parameter_scale As Single = outputAnalysis.Sensitivity_Selected_parameter_scale

sensitivity__selected_parameter_scale = outputAnalysis.Sensitivity_Selected_parameter_scale

$sensitivity_Selected_parameter_scale = $outputAnalysis.Sensitivity_Selected_parameter_scale

Sensitivity_Analysis_status

Sensitivity Analysis Status

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
Code samples 
int sensitivity_Analysis_status = outputAnalysis.Sensitivity_Analysis_status;

Dim sensitivity_Analysis_status As Integer = outputAnalysis.Sensitivity_Analysis_status

sensitivity__analysis_status = outputAnalysis.Sensitivity_Analysis_status

$sensitivity_Analysis_status = $outputAnalysis.Sensitivity_Analysis_status