ISIAPIMovementClass Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: DFDEB358-FB26-4A07-BDE9-134E0DEDC1C3

Declaration¶

[Guid("DFDEB358-FB26-4A07-BDE9-134E0DEDC1C3")]
public interface ISIAPIMovementClass

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPIMovementClass you need via the ISIAPI tree.
# See ISIAPI for the activation root.
movementClass = ...

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

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

C#VB.NETPythonPowerShell

int mC_class = movementClass.MC_class;

Dim mC_class As Integer = movementClass.MC_class

mc_class = movementClass.MC_class

$mC_class = $movementClass.MC_class

Is_included¶

Flag indicating whether this Movement Class is included in the Site. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included into any Site.

bool Is_included { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool is_included = movementClass.Is_included;
movementClass.Is_included = true;

Dim is_included As Boolean = movementClass.Is_included
movementClass.Is_included = true

is_included = movementClass.Is_included
movementClass.Is_included = True

$is_included = $movementClass.Is_included
$movementClass.Is_included = $true

Is_userclass¶

bool Is_userclass { get; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool is_userclass = movementClass.Is_userclass;

Dim is_userclass As Boolean = movementClass.Is_userclass

is_userclass = movementClass.Is_userclass

$is_userclass = $movementClass.Is_userclass

Name¶

Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

string Name { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

string name = movementClass.Name;
movementClass.Name = @"Example";

Dim name As String = movementClass.Name
movementClass.Name = "Example"

name = movementClass.Name
movementClass.Name = r"Example"

$name = $movementClass.Name
$movementClass.Name = "Example"

Display_id¶

Movement Class Display ID, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

string Display_id { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

string display_id = movementClass.Display_id;
movementClass.Display_id = @"id-1";

Dim display_id As String = movementClass.Display_id
movementClass.Display_id = "id-1"

display_id = movementClass.Display_id
movementClass.Display_id = r"id-1"

$display_id = $movementClass.Display_id
$movementClass.Display_id = "id-1"

Base_class¶

The Standard Movement Class that this Movement Class is based on. This Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.

int Base_class { get; set; }

Type int

Code samples

C#VB.NETPythonPowerShell

int base_class = movementClass.Base_class;
movementClass.Base_class = 0;

Dim base_class As Integer = movementClass.Base_class
movementClass.Base_class = 0

base_class = movementClass.Base_class
movementClass.Base_class = 0

$base_class = $movementClass.Base_class
$movementClass.Base_class = 0

Model_designation¶

Model Designation

int Model_designation { get; }

Type int

Value

One of:

1 - Light Vehicle
2 - Heavy Vehicle

Code samples

C#VB.NETPythonPowerShell

int model_designation = movementClass.Model_designation;

Dim model_designation As Integer = movementClass.Model_designation

model_designation = movementClass.Model_designation

$model_designation = $movementClass.Model_designation

MovementClassFuelEmissions¶

ISIAPIMovementClassFuelEmissions MovementClassFuelEmissions { get; }

Type ISIAPIMovementClassFuelEmissions

Code samples

C#VB.NETPythonPowerShell

var movementClassFuelEmissions = movementClass.MovementClassFuelEmissions;

Dim movementClassFuelEmissions As ISIAPIMovementClassFuelEmissions = movementClass.MovementClassFuelEmissions

movement_class_fuel_emissions = movementClass.MovementClassFuelEmissions

$movementClassFuelEmissions = $movementClass.MovementClassFuelEmissions

Site¶

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#VB.NETPythonPowerShell

var site = movementClass.Site;

Dim site As ISIAPISite = movementClass.Site

site = movementClass.Site

$site = $movementClass.Site

Pc_equivalent¶

Passenger Car Equivalent

float Pc_equivalent { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float pc_equivalent = movementClass.Pc_equivalent;
movementClass.Pc_equivalent = 0.0;

Dim pc_equivalent As Single = movementClass.Pc_equivalent
movementClass.Pc_equivalent = 0.0

pc_equivalent = movementClass.Pc_equivalent
movementClass.Pc_equivalent = 0.0

$pc_equivalent = $movementClass.Pc_equivalent
$movementClass.Pc_equivalent = 0.0

Is_cost_included¶

bool Is_cost_included { get; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool is_cost_included = movementClass.Is_cost_included;

Dim is_cost_included As Boolean = movementClass.Is_cost_included

is_cost_included = movementClass.Is_cost_included

$is_cost_included = $movementClass.Is_cost_included

Cost_method¶

Cost Method

int Cost_method { get; set; }

Type int

Value

One of:

1 - Operating Cost
2 - User Cost

Code samples

C#VB.NETPythonPowerShell

int cost_method = movementClass.Cost_method;
movementClass.Cost_method = 0;

Dim cost_method As Integer = movementClass.Cost_method
movementClass.Cost_method = 0

cost_method = movementClass.Cost_method
movementClass.Cost_method = 0

$cost_method = $movementClass.Cost_method
$movementClass.Cost_method = 0

Fuel_pump_price¶

Pump Price of Fuel

float Fuel_pump_price { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float fuel_pump_price = movementClass.Fuel_pump_price;
movementClass.Fuel_pump_price = 0.0;

Dim fuel_pump_price As Single = movementClass.Fuel_pump_price
movementClass.Fuel_pump_price = 0.0

fuel_pump_price = movementClass.Fuel_pump_price
movementClass.Fuel_pump_price = 0.0

$fuel_pump_price = $movementClass.Fuel_pump_price
$movementClass.Fuel_pump_price = 0.0

Resource_cost_factor¶

Fuel Resource Cost Factor

float Resource_cost_factor { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float resource_cost_factor = movementClass.Resource_cost_factor;
movementClass.Resource_cost_factor = 0.0;

Dim resource_cost_factor As Single = movementClass.Resource_cost_factor
movementClass.Resource_cost_factor = 0.0

resource_cost_factor = movementClass.Resource_cost_factor
movementClass.Resource_cost_factor = 0.0

$resource_cost_factor = $movementClass.Resource_cost_factor
$movementClass.Resource_cost_factor = 0.0

Run_cost_fuel_ratio¶

Ratio of Running Cost to Fuel Cost

float Run_cost_fuel_ratio { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float run_cost_fuel_ratio = movementClass.Run_cost_fuel_ratio;
movementClass.Run_cost_fuel_ratio = 0.0;

Dim run_cost_fuel_ratio As Single = movementClass.Run_cost_fuel_ratio
movementClass.Run_cost_fuel_ratio = 0.0

run_cost_fuel_ratio = movementClass.Run_cost_fuel_ratio
movementClass.Run_cost_fuel_ratio = 0.0

$run_cost_fuel_ratio = $movementClass.Run_cost_fuel_ratio
$movementClass.Run_cost_fuel_ratio = 0.0

Average_income¶

float Average_income { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float average_income = movementClass.Average_income;
movementClass.Average_income = 0.0;

Dim average_income As Single = movementClass.Average_income
movementClass.Average_income = 0.0

average_income = movementClass.Average_income
movementClass.Average_income = 0.0

$average_income = $movementClass.Average_income
$movementClass.Average_income = 0.0

Time_value_factor¶

float Time_value_factor { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float time_value_factor = movementClass.Time_value_factor;
movementClass.Time_value_factor = 0.0;

Dim time_value_factor As Single = movementClass.Time_value_factor
movementClass.Time_value_factor = 0.0

time_value_factor = movementClass.Time_value_factor
movementClass.Time_value_factor = 0.0

$time_value_factor = $movementClass.Time_value_factor
$movementClass.Time_value_factor = 0.0

Mass¶

float Mass { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float mass = movementClass.Mass;
movementClass.Mass = 0.0;

Dim mass As Single = movementClass.Mass
movementClass.Mass = 0.0

mass = movementClass.Mass
movementClass.Mass = 0.0

$mass = $movementClass.Mass
$movementClass.Mass = 0.0

Max_power¶

float Max_power { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float max_power = movementClass.Max_power;
movementClass.Max_power = 0.0;

Dim max_power As Single = movementClass.Max_power
movementClass.Max_power = 0.0

max_power = movementClass.Max_power
movementClass.Max_power = 0.0

$max_power = $movementClass.Max_power
$movementClass.Max_power = 0.0

Co2_to_fuel_ratio¶

CO2 to Fuel Consumption Rate

float Co2_to_fuel_ratio { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float co2_to_fuel_ratio = movementClass.Co2_to_fuel_ratio;
movementClass.Co2_to_fuel_ratio = 0.0;

Dim co2_to_fuel_ratio As Single = movementClass.Co2_to_fuel_ratio
movementClass.Co2_to_fuel_ratio = 0.0

co2_to_fuel_ratio = movementClass.Co2_to_fuel_ratio
movementClass.Co2_to_fuel_ratio = 0.0

$co2_to_fuel_ratio = $movementClass.Co2_to_fuel_ratio
$movementClass.Co2_to_fuel_ratio = 0.0

DesiredSpeedMethod¶

Desired Speed Method

int DesiredSpeedMethod { get; set; }

Type int

Value

One of:

0 - User Input
1 - Program

Code samples

C#VB.NETPythonPowerShell

int desiredSpeedMethod = movementClass.DesiredSpeedMethod;
movementClass.DesiredSpeedMethod = 0;

Dim desiredSpeedMethod As Integer = movementClass.DesiredSpeedMethod
movementClass.DesiredSpeedMethod = 0

desired_speed_method = movementClass.DesiredSpeedMethod
movementClass.DesiredSpeedMethod = 0

$desiredSpeedMethod = $movementClass.DesiredSpeedMethod
$movementClass.DesiredSpeedMethod = 0

DesiredSpeed¶

float DesiredSpeed { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float desiredSpeed = movementClass.DesiredSpeed;
movementClass.DesiredSpeed = 0.0;

Dim desiredSpeed As Single = movementClass.DesiredSpeed
movementClass.DesiredSpeed = 0.0

desired_speed = movementClass.DesiredSpeed
movementClass.DesiredSpeed = 0.0

$desiredSpeed = $movementClass.DesiredSpeed
$movementClass.DesiredSpeed = 0.0

LowerLimitOfSpeedEfficiency¶

float LowerLimitOfSpeedEfficiency { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float lowerLimitOfSpeedEfficiency = movementClass.LowerLimitOfSpeedEfficiency;
movementClass.LowerLimitOfSpeedEfficiency = 0.0;

Dim lowerLimitOfSpeedEfficiency As Single = movementClass.LowerLimitOfSpeedEfficiency
movementClass.LowerLimitOfSpeedEfficiency = 0.0

lower_limit_of_speed_efficiency = movementClass.LowerLimitOfSpeedEfficiency
movementClass.LowerLimitOfSpeedEfficiency = 0.0

$lowerLimitOfSpeedEfficiency = $movementClass.LowerLimitOfSpeedEfficiency
$movementClass.LowerLimitOfSpeedEfficiency = 0.0

Gap_acceptance_factor_sliplane_zebra¶

Gap Acceptance Factor for Zebra Crossing on Slip Lane

float Gap_acceptance_factor_sliplane_zebra { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float gap_acceptance_factor_sliplane_zebra = movementClass.Gap_acceptance_factor_sliplane_zebra;
movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0;

Dim gap_acceptance_factor_sliplane_zebra As Single = movementClass.Gap_acceptance_factor_sliplane_zebra
movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0

gap_acceptance_factor_sliplane_zebra = movementClass.Gap_acceptance_factor_sliplane_zebra
movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0

$gap_acceptance_factor_sliplane_zebra = $movementClass.Gap_acceptance_factor_sliplane_zebra
$movementClass.Gap_acceptance_factor_sliplane_zebra = 0.0

Gap_acceptance_factor_midblock_zebra¶

Gap Acceptance Factor for Midblock Zebra Crossing

float Gap_acceptance_factor_midblock_zebra { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float gap_acceptance_factor_midblock_zebra = movementClass.Gap_acceptance_factor_midblock_zebra;
movementClass.Gap_acceptance_factor_midblock_zebra = 0.0;

Dim gap_acceptance_factor_midblock_zebra As Single = movementClass.Gap_acceptance_factor_midblock_zebra
movementClass.Gap_acceptance_factor_midblock_zebra = 0.0

gap_acceptance_factor_midblock_zebra = movementClass.Gap_acceptance_factor_midblock_zebra
movementClass.Gap_acceptance_factor_midblock_zebra = 0.0

$gap_acceptance_factor_midblock_zebra = $movementClass.Gap_acceptance_factor_midblock_zebra
$movementClass.Gap_acceptance_factor_midblock_zebra = 0.0

MergeParam¶

ISIAPIMovementClassMergeParam MergeParam { get; }

Type ISIAPIMovementClassMergeParam

Code samples

C#VB.NETPythonPowerShell

var mergeParam = movementClass.MergeParam;

Dim mergeParam As ISIAPIMovementClassMergeParam = movementClass.MergeParam

merge_param = movementClass.MergeParam

$mergeParam = $movementClass.MergeParam