AssignSchemeParameter

Type ISIAPIAssignSchemeParameter · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 5C06822C-6D66-4D4F-9E33-112D674BD7D6

AssignSchemeParameter wrapper interface

Declaration

[Guid("5C06822C-6D66-4D4F-9E33-112D674BD7D6")]
public interface ISIAPIAssignSchemeParameter

Members

Properties

Property	Type	Summary
AssignmentMethod	int	Assignment Method
IsMinimumSiteMovementDemandApplied	bool
MinimumSiteMovementDemand	float
IncrementalNumberIncrements	int	Number of Increments for the Incremental Assignment Method
UEMaxNumberIterations	int	Maximum Number of Iterations for the User Equilibrium Method
UEGapTolerance	float	Duality Gap Tolerance for the User Equilibrium Method
SUEMaxNumberIterations	int	Maximum Number of Iterations for the Stochastic User Equilibrium Method
SUEPerceptionFactor	float	Travel Time Coefficient (also known as Perception Factor) Travel Time Coefficient is the multiplier of the Route Travel time (Cost) variable of a linear utility function for a Route, which is used in the context of Stochastic User Equilibrium (SUE) Assignment.
SUEMaxNewRoutesPerIterations	int	Maximum Number of New Routes per Iteration for the Stochastic User Equilibrium Method
SUEGapTolerance	float	Duality Gap Tolerance for the Stochastic User Equilibrium Method
AssignScheme	ISIAPIAssignScheme

Properties

AssignmentMethod

Assignment Method

int AssignmentMethod { get; set; }

Type int

Value

Type: System.Int32;

1 = All-or-Nothing,
2 = Incremental,
3 = User Equilibrium,
4 = Stochastic User Equilibrium.

Code samples

C#C++Python

int assignmentMethod = assignSchemeParameter.AssignmentMethod;
assignSchemeParameter.AssignmentMethod = 0;

long assignmentMethod;
assignSchemeParameter->get_AssignmentMethod(&assignmentMethod);
assignSchemeParameter->put_AssignmentMethod(0);

assignment_method = assignSchemeParameter.AssignmentMethod
assignSchemeParameter.AssignmentMethod = 0

IsMinimumSiteMovementDemandApplied

bool IsMinimumSiteMovementDemandApplied { get; set; }

Type bool

Code samples

C#C++Python

bool isMinimumSiteMovementDemandApplied = assignSchemeParameter.IsMinimumSiteMovementDemandApplied;
assignSchemeParameter.IsMinimumSiteMovementDemandApplied = true;

VARIANT_BOOL isMinimumSiteMovementDemandApplied;
assignSchemeParameter->get_IsMinimumSiteMovementDemandApplied(&isMinimumSiteMovementDemandApplied);
assignSchemeParameter->put_IsMinimumSiteMovementDemandApplied(VARIANT_TRUE);

is_minimum_site_movement_demand_applied = assignSchemeParameter.IsMinimumSiteMovementDemandApplied
assignSchemeParameter.IsMinimumSiteMovementDemandApplied = True

MinimumSiteMovementDemand

float MinimumSiteMovementDemand { get; set; }

Type float

Code samples

C#C++Python

float minimumSiteMovementDemand = assignSchemeParameter.MinimumSiteMovementDemand;
assignSchemeParameter.MinimumSiteMovementDemand = 0.0;

double minimumSiteMovementDemand;
assignSchemeParameter->get_MinimumSiteMovementDemand(&minimumSiteMovementDemand);
assignSchemeParameter->put_MinimumSiteMovementDemand(0.0);

minimum_site_movement_demand = assignSchemeParameter.MinimumSiteMovementDemand
assignSchemeParameter.MinimumSiteMovementDemand = 0.0

IncrementalNumberIncrements

Number of Increments for the Incremental Assignment Method

int IncrementalNumberIncrements { get; set; }

Type int

Code samples

C#C++Python

int incrementalNumberIncrements = assignSchemeParameter.IncrementalNumberIncrements;
assignSchemeParameter.IncrementalNumberIncrements = 1;

long incrementalNumberIncrements;
assignSchemeParameter->get_IncrementalNumberIncrements(&incrementalNumberIncrements);
assignSchemeParameter->put_IncrementalNumberIncrements(1);

incremental_number_increments = assignSchemeParameter.IncrementalNumberIncrements
assignSchemeParameter.IncrementalNumberIncrements = 1

UEMaxNumberIterations

Maximum Number of Iterations for the User Equilibrium Method

int UEMaxNumberIterations { get; set; }

Type int

Code samples

C#C++Python

int uEMaxNumberIterations = assignSchemeParameter.UEMaxNumberIterations;
assignSchemeParameter.UEMaxNumberIterations = 1;

long uEMaxNumberIterations;
assignSchemeParameter->get_UEMaxNumberIterations(&uEMaxNumberIterations);
assignSchemeParameter->put_UEMaxNumberIterations(1);

ue_max_number_iterations = assignSchemeParameter.UEMaxNumberIterations
assignSchemeParameter.UEMaxNumberIterations = 1

UEGapTolerance

Duality Gap Tolerance for the User Equilibrium Method

float UEGapTolerance { get; set; }

Type float

Code samples

C#C++Python

float uEGapTolerance = assignSchemeParameter.UEGapTolerance;
assignSchemeParameter.UEGapTolerance = 0.0;

double uEGapTolerance;
assignSchemeParameter->get_UEGapTolerance(&uEGapTolerance);
assignSchemeParameter->put_UEGapTolerance(0.0);

ue_gap_tolerance = assignSchemeParameter.UEGapTolerance
assignSchemeParameter.UEGapTolerance = 0.0

SUEMaxNumberIterations

Maximum Number of Iterations for the Stochastic User Equilibrium Method

int SUEMaxNumberIterations { get; set; }

Type int

Code samples

C#C++Python

int sUEMaxNumberIterations = assignSchemeParameter.SUEMaxNumberIterations;
assignSchemeParameter.SUEMaxNumberIterations = 1;

long sUEMaxNumberIterations;
assignSchemeParameter->get_SUEMaxNumberIterations(&sUEMaxNumberIterations);
assignSchemeParameter->put_SUEMaxNumberIterations(1);

sue_max_number_iterations = assignSchemeParameter.SUEMaxNumberIterations
assignSchemeParameter.SUEMaxNumberIterations = 1

SUEPerceptionFactor

Travel Time Coefficient (also known as Perception Factor)
Travel Time Coefficient is the multiplier of the Route Travel time (Cost) variable of a linear utility function for a Route, which is used in the context of Stochastic User Equilibrium (SUE) Assignment.

float SUEPerceptionFactor { get; set; }

Type float

Code samples

C#C++Python

float sUEPerceptionFactor = assignSchemeParameter.SUEPerceptionFactor;
assignSchemeParameter.SUEPerceptionFactor = 0.0;

double sUEPerceptionFactor;
assignSchemeParameter->get_SUEPerceptionFactor(&sUEPerceptionFactor);
assignSchemeParameter->put_SUEPerceptionFactor(0.0);

sue_perception_factor = assignSchemeParameter.SUEPerceptionFactor
assignSchemeParameter.SUEPerceptionFactor = 0.0

SUEMaxNewRoutesPerIterations

Maximum Number of New Routes per Iteration for the Stochastic User Equilibrium Method

int SUEMaxNewRoutesPerIterations { get; set; }

Type int

Code samples

C#C++Python

int sUEMaxNewRoutesPerIterations = assignSchemeParameter.SUEMaxNewRoutesPerIterations;
assignSchemeParameter.SUEMaxNewRoutesPerIterations = 0;

long sUEMaxNewRoutesPerIterations;
assignSchemeParameter->get_SUEMaxNewRoutesPerIterations(&sUEMaxNewRoutesPerIterations);
assignSchemeParameter->put_SUEMaxNewRoutesPerIterations(0);

sue_max_new_routes_per_iterations = assignSchemeParameter.SUEMaxNewRoutesPerIterations
assignSchemeParameter.SUEMaxNewRoutesPerIterations = 0

SUEGapTolerance

Duality Gap Tolerance for the Stochastic User Equilibrium Method

float SUEGapTolerance { get; set; }

Type float

Code samples

C#C++Python

float sUEGapTolerance = assignSchemeParameter.SUEGapTolerance;
assignSchemeParameter.SUEGapTolerance = 0.0;

double sUEGapTolerance;
assignSchemeParameter->get_SUEGapTolerance(&sUEGapTolerance);
assignSchemeParameter->put_SUEGapTolerance(0.0);

sue_gap_tolerance = assignSchemeParameter.SUEGapTolerance
assignSchemeParameter.SUEGapTolerance = 0.0

AssignScheme

ISIAPIAssignScheme AssignScheme { get; }

Type ISIAPIAssignScheme

Code samples

C#C++Python

var assignScheme = assignSchemeParameter.AssignScheme;

CComPtr<ISIAPIAssignScheme> assignScheme;
assignSchemeParameter->get_AssignScheme(&assignScheme);

assign_scheme = assignSchemeParameter.AssignScheme