Skip to content

RouteMC

Type ISIAPIRouteMC · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 562A8D97-07F0-4160-ABA4-50241723E32F

Declaration

[Guid("562A8D97-07F0-4160-ABA4-50241723E32F")]
public interface ISIAPIRouteMC

Members

Properties

Property Type Summary
MC_class int Movement Class Number
DesiredSpeedMethod int Desired Speed Method or Option
DesiredSpeed float
LowerLimitOfSpeedEfficiency float
Route ISIAPIRoute
UseAssignRouteVolumeFactor bool Flag indicating if Assign Fixed Trip O-D Volume Proportion is applied in the Assign Network analysis.
AssignRouteVolumeFactor float Assign Fixed Trip O-D Volume Proportion (also known as Assign Route Volume Factor)

Properties

MC_class

Movement Class Number

int MC_class { get; }

Type int

Value

One of:

  • 1 - Light Vehicles
  • 2 - Heavy Vehicles
  • 3 - Buses
  • 4 - Bicycles
  • 5 - Large Trucks
  • 6 - Trams
  • 7 - User Class 1
  • 8 - User Class 2
  • 9 - User Class 3
  • 10 - User Class 4
  • 11 - User Class 5
  • 12 - User Class 6
Code samples 
int mC_class = routeMC.MC_class;

long mC_class;
routeMC->get_MC_class(&mC_class);

mc_class = routeMC.MC_class

DesiredSpeedMethod

Desired Speed Method or Option

int DesiredSpeedMethod { get; set; }

Type int

Value

One of:

  • 0 - User Input
  • 1 - Program
Code samples 
int desiredSpeedMethod = routeMC.DesiredSpeedMethod;
routeMC.DesiredSpeedMethod = 0;

long desiredSpeedMethod;
routeMC->get_DesiredSpeedMethod(&desiredSpeedMethod);
routeMC->put_DesiredSpeedMethod(0);

desired_speed_method = routeMC.DesiredSpeedMethod
routeMC.DesiredSpeedMethod = 0

DesiredSpeed

float DesiredSpeed { get; set; }

Type float

Code samples 
float desiredSpeed = routeMC.DesiredSpeed;
routeMC.DesiredSpeed = 0.0;

double desiredSpeed;
routeMC->get_DesiredSpeed(&desiredSpeed);
routeMC->put_DesiredSpeed(0.0);

desired_speed = routeMC.DesiredSpeed
routeMC.DesiredSpeed = 0.0

LowerLimitOfSpeedEfficiency

float LowerLimitOfSpeedEfficiency { get; set; }

Type float

Code samples 
float lowerLimitOfSpeedEfficiency = routeMC.LowerLimitOfSpeedEfficiency;
routeMC.LowerLimitOfSpeedEfficiency = 0.0;

double lowerLimitOfSpeedEfficiency;
routeMC->get_LowerLimitOfSpeedEfficiency(&lowerLimitOfSpeedEfficiency);
routeMC->put_LowerLimitOfSpeedEfficiency(0.0);

lower_limit_of_speed_efficiency = routeMC.LowerLimitOfSpeedEfficiency
routeMC.LowerLimitOfSpeedEfficiency = 0.0

Route

ISIAPIRoute Route { get; }

Type ISIAPIRoute

Code samples 
var route = routeMC.Route;

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

route = routeMC.Route

UseAssignRouteVolumeFactor

Flag indicating if Assign Fixed Trip O-D Volume Proportion is applied in the Assign Network analysis.

bool UseAssignRouteVolumeFactor { get; set; }

Type bool

Remarks

This option takes effect only when this Route is in an Assign Network and connects an Origin Assign Zone to a Destination Assign Zone, i.e. the Origin Leg of the first Site in the Route is connected to an Assign Zone (Origin Assign Zone) and the Destination Leg of the last Site in the Route is connected to another Assign Zone (Destination Assign Zone).

Code samples 
bool useAssignRouteVolumeFactor = routeMC.UseAssignRouteVolumeFactor;
routeMC.UseAssignRouteVolumeFactor = true;

VARIANT_BOOL useAssignRouteVolumeFactor;
routeMC->get_UseAssignRouteVolumeFactor(&useAssignRouteVolumeFactor);
routeMC->put_UseAssignRouteVolumeFactor(VARIANT_TRUE);

use_assign_route_volume_factor = routeMC.UseAssignRouteVolumeFactor
routeMC.UseAssignRouteVolumeFactor = True

AssignRouteVolumeFactor

Assign Fixed Trip O-D Volume Proportion (also known as Assign Route Volume Factor)

float AssignRouteVolumeFactor { get; set; }

Type float

Value

Type: System.Single;
This value represents a percentage; 50.0 corresponds to 50.0%.

Code samples 
float assignRouteVolumeFactor = routeMC.AssignRouteVolumeFactor;
routeMC.AssignRouteVolumeFactor = 0.0;

double assignRouteVolumeFactor;
routeMC->get_AssignRouteVolumeFactor(&assignRouteVolumeFactor);
routeMC->put_AssignRouteVolumeFactor(0.0);

assign_route_volume_factor = routeMC.AssignRouteVolumeFactor
routeMC.AssignRouteVolumeFactor = 0.0