OutputNetwork

Type 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

Members

Properties

Property	Type	Summary
Network	ISIAPINetwork
GeneratedTime	DateTime
IterationsCount	int	The number of iterations that have been run to get this network output result
OutputNetworkVehicle	ISIAPIOutputNetworkVehicle
OutputNetworkPedestrian	ISIAPIOutputNetworkPedestrian
OutputNetworkPerson	ISIAPIOutputNetworkPerson
GeneratedByVersion	string
NetworkCycleTime	float
NetworkSummaryType	int	Network Summary Type, the summary type of this SIAPIOutputNetwork.
Route	ISIAPIRoute
Analysis_method_flag	int
Analysis_method	int
Analysis_status	int
Selected_future_year	int
Largest_movement_flow_scale	float
Selected_parameter_scale	float
Single_ccg	int
Cycle_time_option	int
OutputNetworkGraphTuples	ISIAPIOutputNetworkGraphTuples
OutputRouteMovementBasedVehicle	ISIAPIOutputRouteMovementBasedVehicle
OutputRouteMovementBasedPerson	ISIAPIOutputRouteMovementBasedPerson
TwoLoops_TotalInnerIterations	int	The total number of Inner Loop Iterations that have been performed when the Network is processed using the Two-Loop Convergence Method.
Is_settled	bool	Flag indicating if the Iterations settle.
Is_minPSC_regenerated	bool	Flag indicating if the result of the Outer Loop Iteration with the Minimum Percentage Stopping Condition is regenerated when the Two-Loop Convergence Method is applied.
MinPSC	float	Minimum Percentage Stopping Condition found in the Two-Loop Convergence Method when the iterations do not settle. When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.
MinPSC_iteration	int	The Iteration Number of the Outer Loop Iteration with the Minimum Percentage Stopping Condition when the Two-Loop Convergence Method iterations settle. When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.

Properties

Network

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#C++PythonPowerShell

var network = outputNetwork.Network;

CComPtr<ISIAPINetwork> network;
outputNetwork->get_Network(&network);

network = outputNetwork.Network

$network = $outputNetwork.Network

GeneratedTime

DateTime GeneratedTime { get; }

Type DateTime

Code samples

C#C++PythonPowerShell

var generatedTime = outputNetwork.GeneratedTime;

VARIANT generatedTime;
outputNetwork->get_GeneratedTime(&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#C++PythonPowerShell

int iterationsCount = outputNetwork.IterationsCount;

long iterationsCount;
outputNetwork->get_IterationsCount(&iterationsCount);

iterations_count = outputNetwork.IterationsCount

$iterationsCount = $outputNetwork.IterationsCount

OutputNetworkVehicle

ISIAPIOutputNetworkVehicle OutputNetworkVehicle { get; }

Type ISIAPIOutputNetworkVehicle

Code samples

C#C++PythonPowerShell

var outputNetworkVehicle = outputNetwork.OutputNetworkVehicle;

CComPtr<ISIAPIOutputNetworkVehicle> outputNetworkVehicle;
outputNetwork->get_OutputNetworkVehicle(&outputNetworkVehicle);

output_network_vehicle = outputNetwork.OutputNetworkVehicle

$outputNetworkVehicle = $outputNetwork.OutputNetworkVehicle

OutputNetworkPedestrian

ISIAPIOutputNetworkPedestrian OutputNetworkPedestrian { get; }

Type ISIAPIOutputNetworkPedestrian

Code samples

C#C++PythonPowerShell

var outputNetworkPedestrian = outputNetwork.OutputNetworkPedestrian;

CComPtr<ISIAPIOutputNetworkPedestrian> outputNetworkPedestrian;
outputNetwork->get_OutputNetworkPedestrian(&outputNetworkPedestrian);

output_network_pedestrian = outputNetwork.OutputNetworkPedestrian

$outputNetworkPedestrian = $outputNetwork.OutputNetworkPedestrian

OutputNetworkPerson

ISIAPIOutputNetworkPerson OutputNetworkPerson { get; }

Type ISIAPIOutputNetworkPerson

Code samples

C#C++PythonPowerShell

var outputNetworkPerson = outputNetwork.OutputNetworkPerson;

CComPtr<ISIAPIOutputNetworkPerson> outputNetworkPerson;
outputNetwork->get_OutputNetworkPerson(&outputNetworkPerson);

output_network_person = outputNetwork.OutputNetworkPerson

$outputNetworkPerson = $outputNetwork.OutputNetworkPerson

GeneratedByVersion

string GeneratedByVersion { get; }

Type string

Code samples

C#C++PythonPowerShell

string generatedByVersion = outputNetwork.GeneratedByVersion;

CComBSTR generatedByVersion;
outputNetwork->get_GeneratedByVersion(&generatedByVersion);

generated_by_version = outputNetwork.GeneratedByVersion

$generatedByVersion = $outputNetwork.GeneratedByVersion

NetworkCycleTime

float NetworkCycleTime { get; }

Type float

Code samples

C#C++PythonPowerShell

float networkCycleTime = outputNetwork.NetworkCycleTime;

double networkCycleTime;
outputNetwork->get_NetworkCycleTime(&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#C++PythonPowerShell

int networkSummaryType = outputNetwork.NetworkSummaryType;

long networkSummaryType;
outputNetwork->get_NetworkSummaryType(&networkSummaryType);

network_summary_type = outputNetwork.NetworkSummaryType

$networkSummaryType = $outputNetwork.NetworkSummaryType

Route

ISIAPIRoute Route { get; }

Type ISIAPIRoute

Code samples

C#C++PythonPowerShell

var route = outputNetwork.Route;

CComPtr<ISIAPIRoute> route;
outputNetwork->get_Route(&route);

route = outputNetwork.Route

$route = $outputNetwork.Route

Analysis_method_flag

int Analysis_method_flag { get; }

Type int

Code samples

C#C++PythonPowerShell

int analysis_method_flag = outputNetwork.Analysis_method_flag;

long analysis_method_flag;
outputNetwork->get_Analysis_method_flag(&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#C++PythonPowerShell

int analysis_method = outputNetwork.Analysis_method;

long analysis_method;
outputNetwork->get_Analysis_method(&analysis_method);

analysis_method = outputNetwork.Analysis_method

$analysis_method = $outputNetwork.Analysis_method

Analysis_status

int Analysis_status { get; }

Type int

Code samples

C#C++PythonPowerShell

int analysis_status = outputNetwork.Analysis_status;

long analysis_status;
outputNetwork->get_Analysis_status(&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#C++PythonPowerShell

int selected_future_year = outputNetwork.Selected_future_year;

long selected_future_year;
outputNetwork->get_Selected_future_year(&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#C++PythonPowerShell

float largest_movement_flow_scale = outputNetwork.Largest_movement_flow_scale;

double largest_movement_flow_scale;
outputNetwork->get_Largest_movement_flow_scale(&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#C++PythonPowerShell

float selected_parameter_scale = outputNetwork.Selected_parameter_scale;

double selected_parameter_scale;
outputNetwork->get_Selected_parameter_scale(&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#C++PythonPowerShell

int single_ccg = outputNetwork.Single_ccg;

long single_ccg;
outputNetwork->get_Single_ccg(&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#C++PythonPowerShell

int cycle_time_option = outputNetwork.Cycle_time_option;

long cycle_time_option;
outputNetwork->get_Cycle_time_option(&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#C++PythonPowerShell

var outputNetworkGraphTuples = outputNetwork.OutputNetworkGraphTuples;

CComPtr<ISIAPIOutputNetworkGraphTuples> outputNetworkGraphTuples;
outputNetwork->get_OutputNetworkGraphTuples(&outputNetworkGraphTuples);

output_network_graph_tuples = outputNetwork.OutputNetworkGraphTuples

$outputNetworkGraphTuples = $outputNetwork.OutputNetworkGraphTuples

OutputRouteMovementBasedVehicle

ISIAPIOutputRouteMovementBasedVehicle OutputRouteMovementBasedVehicle { get; }

Type ISIAPIOutputRouteMovementBasedVehicle

Code samples

C#C++PythonPowerShell

var outputRouteMovementBasedVehicle = outputNetwork.OutputRouteMovementBasedVehicle;

CComPtr<ISIAPIOutputRouteMovementBasedVehicle> outputRouteMovementBasedVehicle;
outputNetwork->get_OutputRouteMovementBasedVehicle(&outputRouteMovementBasedVehicle);

output_route_movement_based_vehicle = outputNetwork.OutputRouteMovementBasedVehicle

$outputRouteMovementBasedVehicle = $outputNetwork.OutputRouteMovementBasedVehicle

OutputRouteMovementBasedPerson

ISIAPIOutputRouteMovementBasedPerson OutputRouteMovementBasedPerson { get; }

Type ISIAPIOutputRouteMovementBasedPerson

Code samples

C#C++PythonPowerShell

var outputRouteMovementBasedPerson = outputNetwork.OutputRouteMovementBasedPerson;

CComPtr<ISIAPIOutputRouteMovementBasedPerson> outputRouteMovementBasedPerson;
outputNetwork->get_OutputRouteMovementBasedPerson(&outputRouteMovementBasedPerson);

output_route_movement_based_person = outputNetwork.OutputRouteMovementBasedPerson

$outputRouteMovementBasedPerson = $outputNetwork.OutputRouteMovementBasedPerson

TwoLoops_TotalInnerIterations

The total number of Inner Loop Iterations that have been performed when the Network is processed using the Two-Loop Convergence Method.

int TwoLoops_TotalInnerIterations { get; }

Type int

Code samples

C#C++PythonPowerShell

int twoLoops_TotalInnerIterations = outputNetwork.TwoLoops_TotalInnerIterations;

long twoLoops_TotalInnerIterations;
outputNetwork->get_TwoLoops_TotalInnerIterations(&twoLoops_TotalInnerIterations);

two_loops__total_inner_iterations = outputNetwork.TwoLoops_TotalInnerIterations

$twoLoops_TotalInnerIterations = $outputNetwork.TwoLoops_TotalInnerIterations

Is_settled

Flag indicating if the Iterations settle.

bool Is_settled { get; }

Type bool

Code samples

C#C++PythonPowerShell

bool is_settled = outputNetwork.Is_settled;

VARIANT_BOOL is_settled;
outputNetwork->get_Is_settled(&is_settled);

is_settled = outputNetwork.Is_settled

$is_settled = $outputNetwork.Is_settled

Is_minPSC_regenerated

Flag indicating if the result of the Outer Loop Iteration with the Minimum Percentage Stopping Condition is regenerated when the Two-Loop Convergence Method is applied.

bool Is_minPSC_regenerated { get; }

Type bool

Code samples

C#C++PythonPowerShell

bool is_minPSC_regenerated = outputNetwork.Is_minPSC_regenerated;

VARIANT_BOOL is_minPSC_regenerated;
outputNetwork->get_Is_minPSC_regenerated(&is_minPSC_regenerated);

is_min_psc_regenerated = outputNetwork.Is_minPSC_regenerated

$is_minPSC_regenerated = $outputNetwork.Is_minPSC_regenerated

MinPSC

Minimum Percentage Stopping Condition found in the Two-Loop Convergence Method when the iterations do not settle.

When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.

float MinPSC { get; }

Type float

Code samples

C#C++PythonPowerShell

float minPSC = outputNetwork.MinPSC;

double minPSC;
outputNetwork->get_MinPSC(&minPSC);

min_psc = outputNetwork.MinPSC

$minPSC = $outputNetwork.MinPSC

MinPSC_iteration

The Iteration Number of the Outer Loop Iteration with the Minimum Percentage Stopping Condition when the Two-Loop Convergence Method iterations settle.

When the Two-Loop Convergence Method iterations settle or the One-Loop Convergence Method is applied, this returns a meaningless value, 0.

int MinPSC_iteration { get; }

Type int

Code samples

C#C++PythonPowerShell

int minPSC_iteration = outputNetwork.MinPSC_iteration;

long minPSC_iteration;
outputNetwork->get_MinPSC_iteration(&minPSC_iteration);

min_psc_iteration = outputNetwork.MinPSC_iteration

$minPSC_iteration = $outputNetwork.MinPSC_iteration