ISIAPIOutputNetwork Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: ADA253F7-3B57-4801-AB60-D8B4474D7662

Declaration¶

[Guid("ADA253F7-3B57-4801-AB60-D8B4474D7662")]
public interface ISIAPIOutputNetwork

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPIOutputNetwork you need via the ISIAPI tree.
# See ISIAPI for the activation root.
outputNetwork = ...

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

Properties¶

Network¶

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#VB.NETPythonPowerShell

var network = outputNetwork.Network;

Dim network As ISIAPINetwork = outputNetwork.Network

network = outputNetwork.Network

$network = $outputNetwork.Network

GeneratedTime¶

DateTime GeneratedTime { get; }

Type DateTime

Code samples

C#VB.NETPythonPowerShell

var generatedTime = outputNetwork.GeneratedTime;

Dim generatedTime As DateTime = outputNetwork.GeneratedTime

generated_time = outputNetwork.GeneratedTime

$generatedTime = $outputNetwork.GeneratedTime

IterationsCount¶

The number of iterations that have been run to get this network output result

int IterationsCount { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int iterationsCount = outputNetwork.IterationsCount;

Dim iterationsCount As Integer = outputNetwork.IterationsCount

iterations_count = outputNetwork.IterationsCount

$iterationsCount = $outputNetwork.IterationsCount

OutputNetworkVehicle¶

ISIAPIOutputNetworkVehicle OutputNetworkVehicle { get; }

Type ISIAPIOutputNetworkVehicle

Code samples

C#VB.NETPythonPowerShell

var outputNetworkVehicle = outputNetwork.OutputNetworkVehicle;

Dim outputNetworkVehicle As ISIAPIOutputNetworkVehicle = outputNetwork.OutputNetworkVehicle

output_network_vehicle = outputNetwork.OutputNetworkVehicle

$outputNetworkVehicle = $outputNetwork.OutputNetworkVehicle

OutputNetworkPedestrian¶

ISIAPIOutputNetworkPedestrian OutputNetworkPedestrian { get; }

Type ISIAPIOutputNetworkPedestrian

Code samples

C#VB.NETPythonPowerShell

var outputNetworkPedestrian = outputNetwork.OutputNetworkPedestrian;

Dim outputNetworkPedestrian As ISIAPIOutputNetworkPedestrian = outputNetwork.OutputNetworkPedestrian

output_network_pedestrian = outputNetwork.OutputNetworkPedestrian

$outputNetworkPedestrian = $outputNetwork.OutputNetworkPedestrian

OutputNetworkPerson¶

ISIAPIOutputNetworkPerson OutputNetworkPerson { get; }

Type ISIAPIOutputNetworkPerson

Code samples

C#VB.NETPythonPowerShell

var outputNetworkPerson = outputNetwork.OutputNetworkPerson;

Dim outputNetworkPerson As ISIAPIOutputNetworkPerson = outputNetwork.OutputNetworkPerson

output_network_person = outputNetwork.OutputNetworkPerson

$outputNetworkPerson = $outputNetwork.OutputNetworkPerson

GeneratedByVersion¶

string GeneratedByVersion { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string generatedByVersion = outputNetwork.GeneratedByVersion;

Dim generatedByVersion As String = outputNetwork.GeneratedByVersion

generated_by_version = outputNetwork.GeneratedByVersion

$generatedByVersion = $outputNetwork.GeneratedByVersion

NetworkCycleTime¶

float NetworkCycleTime { get; }

Type float

Code samples

C#VB.NETPythonPowerShell

float networkCycleTime = outputNetwork.NetworkCycleTime;

Dim networkCycleTime As Single = outputNetwork.NetworkCycleTime

network_cycle_time = outputNetwork.NetworkCycleTime

$networkCycleTime = $outputNetwork.NetworkCycleTime

NetworkSummaryType¶

Network Summary Type, the summary type of this SIAPIOutputNetwork.

int NetworkSummaryType { get; }

Type int

Value

One of:

1 - Whole Network
2 - Summary for selected Routes
3 - Summary for a particular Route

Code samples

C#VB.NETPythonPowerShell

int networkSummaryType = outputNetwork.NetworkSummaryType;

Dim networkSummaryType As Integer = outputNetwork.NetworkSummaryType

network_summary_type = outputNetwork.NetworkSummaryType

$networkSummaryType = $outputNetwork.NetworkSummaryType

Route¶

ISIAPIRoute Route { get; }

Type ISIAPIRoute

Code samples

C#VB.NETPythonPowerShell

var route = outputNetwork.Route;

Dim route As ISIAPIRoute = outputNetwork.Route

route = outputNetwork.Route

$route = $outputNetwork.Route

Analysis_method_flag¶

int Analysis_method_flag { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int analysis_method_flag = outputNetwork.Analysis_method_flag;

Dim analysis_method_flag As Integer = outputNetwork.Analysis_method_flag

analysis_method_flag = outputNetwork.Analysis_method_flag

$analysis_method_flag = $outputNetwork.Analysis_method_flag

Analysis_method¶

int Analysis_method { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int analysis_method = outputNetwork.Analysis_method;

Dim analysis_method As Integer = outputNetwork.Analysis_method

analysis_method = outputNetwork.Analysis_method

$analysis_method = $outputNetwork.Analysis_method

Analysis_status¶

int Analysis_status { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int analysis_status = outputNetwork.Analysis_status;

Dim analysis_status As Integer = outputNetwork.Analysis_status

analysis_status = outputNetwork.Analysis_status

$analysis_status = $outputNetwork.Analysis_status

Selected_future_year¶

int Selected_future_year { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int selected_future_year = outputNetwork.Selected_future_year;

Dim selected_future_year As Integer = outputNetwork.Selected_future_year

selected_future_year = outputNetwork.Selected_future_year

$selected_future_year = $outputNetwork.Selected_future_year

Largest_movement_flow_scale¶

float Largest_movement_flow_scale { get; }

Type float

Code samples

C#VB.NETPythonPowerShell

float largest_movement_flow_scale = outputNetwork.Largest_movement_flow_scale;

Dim largest_movement_flow_scale As Single = outputNetwork.Largest_movement_flow_scale

largest_movement_flow_scale = outputNetwork.Largest_movement_flow_scale

$largest_movement_flow_scale = $outputNetwork.Largest_movement_flow_scale

Selected_parameter_scale¶

float Selected_parameter_scale { get; }

Type float

Code samples

C#VB.NETPythonPowerShell

float selected_parameter_scale = outputNetwork.Selected_parameter_scale;

Dim selected_parameter_scale As Single = outputNetwork.Selected_parameter_scale

selected_parameter_scale = outputNetwork.Selected_parameter_scale

$selected_parameter_scale = $outputNetwork.Selected_parameter_scale

Single_ccg¶

int Single_ccg { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int single_ccg = outputNetwork.Single_ccg;

Dim single_ccg As Integer = outputNetwork.Single_ccg

single_ccg = outputNetwork.Single_ccg

$single_ccg = $outputNetwork.Single_ccg

Cycle_time_option¶

int Cycle_time_option { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int cycle_time_option = outputNetwork.Cycle_time_option;

Dim cycle_time_option As Integer = outputNetwork.Cycle_time_option

cycle_time_option = outputNetwork.Cycle_time_option

$cycle_time_option = $outputNetwork.Cycle_time_option

OutputNetworkGraphTuples¶

ISIAPIOutputNetworkGraphTuples OutputNetworkGraphTuples { get; }

Type ISIAPIOutputNetworkGraphTuples

Code samples

C#VB.NETPythonPowerShell

var outputNetworkGraphTuples = outputNetwork.OutputNetworkGraphTuples;

Dim outputNetworkGraphTuples As ISIAPIOutputNetworkGraphTuples = outputNetwork.OutputNetworkGraphTuples

output_network_graph_tuples = outputNetwork.OutputNetworkGraphTuples

$outputNetworkGraphTuples = $outputNetwork.OutputNetworkGraphTuples

OutputRouteMovementBasedVehicle¶

ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle { get; }

Type ISIAPIOutputRouteMovementBasedVehicle

Code samples

C#VB.NETPythonPowerShell

var outputRouteMovementBasedVehicle = outputNetwork.OutputRouteMovementBasedVehicle;

Dim outputRouteMovementBasedVehicle As ISIAPIOutputRouteMovementBasedVehicle = outputNetwork.OutputRouteMovementBasedVehicle

output_route_movement_based_vehicle = outputNetwork.OutputRouteMovementBasedVehicle

$outputRouteMovementBasedVehicle = $outputNetwork.OutputRouteMovementBasedVehicle

OutputRouteMovementBasedPerson¶

ISIAPIOutputRouteMovementBasedPerson OutputRouteMovementBasedPerson { get; }

Type ISIAPIOutputRouteMovementBasedPerson

Code samples

C#VB.NETPythonPowerShell

var outputRouteMovementBasedPerson = outputNetwork.OutputRouteMovementBasedPerson;

Dim outputRouteMovementBasedPerson As ISIAPIOutputRouteMovementBasedPerson = outputNetwork.OutputRouteMovementBasedPerson

output_route_movement_based_person = outputNetwork.OutputRouteMovementBasedPerson

$outputRouteMovementBasedPerson = $outputNetwork.OutputRouteMovementBasedPerson

TwoLoops_TotalInnerIterations¶

The total number of Inner Loop iterations performed during the Two-Loops process for this Network Output.

int TwoLoops_TotalInnerIterations { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int twoLoops_TotalInnerIterations = outputNetwork.TwoLoops_TotalInnerIterations;

Dim twoLoops_TotalInnerIterations As Integer = outputNetwork.TwoLoops_TotalInnerIterations

two_loops__total_inner_iterations = outputNetwork.TwoLoops_TotalInnerIterations

$twoLoops_TotalInnerIterations = $outputNetwork.TwoLoops_TotalInnerIterations