MovementClass

Type 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

Members

Properties

Property	Type	Summary
MC_class	int	Movement Class Number
Is_included	bool	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.
Is_userclass	bool
Name	string	Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.
Display_id	string	Movement Class Display ID, this Property can be changed only if this is a User Movement Class, i.e. Is_userclass == true.
Base_class	int	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.
Model_designation	int	Model Designation
MovementClassFuelEmissions	ISIAPIMovementClassFuelEmissions
Site	ISIAPISite
Pc_equivalent	float	Passenger Car Equivalent
Is_cost_included	bool
Cost_method	int	Cost Method
Fuel_pump_price	float	Pump Price of Fuel
Resource_cost_factor	float	Fuel Resource Cost Factor
Run_cost_fuel_ratio	float	Ratio of Running Cost to Fuel Cost
Average_income	float
Time_value_factor	float
Mass	float
Max_power	float
Co2_to_fuel_ratio	float	CO2 to Fuel Consumption Rate
DesiredSpeedMethod	int	Desired Speed Method
DesiredSpeed	float
LowerLimitOfSpeedEfficiency	float
Gap_acceptance_factor_sliplane_zebra	float	Gap Acceptance Factor for Zebra Crossing on Slip Lane
Gap_acceptance_factor_midblock_zebra	float	Gap Acceptance Factor for Midblock Zebra Crossing
MergeParam	ISIAPIMovementClassMergeParam

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#C++PythonPowerShell

int mC_class = movementClass.MC_class;

long mC_class;
movementClass->get_MC_class(&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#C++PythonPowerShell

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

VARIANT_BOOL is_included;
movementClass->get_Is_included(&is_included);
movementClass->put_Is_included(VARIANT_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#C++PythonPowerShell

bool is_userclass = movementClass.Is_userclass;

VARIANT_BOOL is_userclass;
movementClass->get_Is_userclass(&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#C++PythonPowerShell

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

CComBSTR name;
movementClass->get_Name(&name);
movementClass->put_Name(CComBSTR(L"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#C++PythonPowerShell

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

CComBSTR display_id;
movementClass->get_Display_id(&display_id);
movementClass->put_Display_id(CComBSTR(L"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#C++PythonPowerShell

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

long base_class;
movementClass->get_Base_class(&base_class);
movementClass->put_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#C++PythonPowerShell

int model_designation = movementClass.Model_designation;

long model_designation;
movementClass->get_Model_designation(&model_designation);

model_designation = movementClass.Model_designation

$model_designation = $movementClass.Model_designation

MovementClassFuelEmissions

ISIAPIMovementClassFuelEmissions MovementClassFuelEmissions { get; }

Type ISIAPIMovementClassFuelEmissions

Code samples

C#C++PythonPowerShell

var movementClassFuelEmissions = movementClass.MovementClassFuelEmissions;

CComPtr<ISIAPIMovementClassFuelEmissions> movementClassFuelEmissions;
movementClass->get_MovementClassFuelEmissions(&movementClassFuelEmissions);

movement_class_fuel_emissions = movementClass.MovementClassFuelEmissions

$movementClassFuelEmissions = $movementClass.MovementClassFuelEmissions

Site

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#C++PythonPowerShell

var site = movementClass.Site;

CComPtr<ISIAPISite> site;
movementClass->get_Site(&site);

site = movementClass.Site

$site = $movementClass.Site

Pc_equivalent

Passenger Car Equivalent

float Pc_equivalent { get; set; }

Type float

Code samples

C#C++PythonPowerShell

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

double pc_equivalent;
movementClass->get_Pc_equivalent(&pc_equivalent);
movementClass->put_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#C++PythonPowerShell

bool is_cost_included = movementClass.Is_cost_included;

VARIANT_BOOL is_cost_included;
movementClass->get_Is_cost_included(&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#C++PythonPowerShell

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

long cost_method;
movementClass->get_Cost_method(&cost_method);
movementClass->put_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#C++PythonPowerShell

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

double fuel_pump_price;
movementClass->get_Fuel_pump_price(&fuel_pump_price);
movementClass->put_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#C++PythonPowerShell

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

double resource_cost_factor;
movementClass->get_Resource_cost_factor(&resource_cost_factor);
movementClass->put_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#C++PythonPowerShell

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

double run_cost_fuel_ratio;
movementClass->get_Run_cost_fuel_ratio(&run_cost_fuel_ratio);
movementClass->put_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#C++PythonPowerShell

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

double average_income;
movementClass->get_Average_income(&average_income);
movementClass->put_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#C++PythonPowerShell

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

double time_value_factor;
movementClass->get_Time_value_factor(&time_value_factor);
movementClass->put_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#C++PythonPowerShell

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

double mass;
movementClass->get_Mass(&mass);
movementClass->put_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#C++PythonPowerShell

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

double max_power;
movementClass->get_Max_power(&max_power);
movementClass->put_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#C++PythonPowerShell

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

double co2_to_fuel_ratio;
movementClass->get_Co2_to_fuel_ratio(&co2_to_fuel_ratio);
movementClass->put_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#C++PythonPowerShell

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

long desiredSpeedMethod;
movementClass->get_DesiredSpeedMethod(&desiredSpeedMethod);
movementClass->put_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#C++PythonPowerShell

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

double desiredSpeed;
movementClass->get_DesiredSpeed(&desiredSpeed);
movementClass->put_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#C++PythonPowerShell

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

double lowerLimitOfSpeedEfficiency;
movementClass->get_LowerLimitOfSpeedEfficiency(&lowerLimitOfSpeedEfficiency);
movementClass->put_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#C++PythonPowerShell

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

double gap_acceptance_factor_sliplane_zebra;
movementClass->get_Gap_acceptance_factor_sliplane_zebra(&gap_acceptance_factor_sliplane_zebra);
movementClass->put_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#C++PythonPowerShell

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

double gap_acceptance_factor_midblock_zebra;
movementClass->get_Gap_acceptance_factor_midblock_zebra(&gap_acceptance_factor_midblock_zebra);
movementClass->put_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#C++PythonPowerShell

var mergeParam = movementClass.MergeParam;

CComPtr<ISIAPIMovementClassMergeParam> mergeParam;
movementClass->get_MergeParam(&mergeParam);

merge_param = movementClass.MergeParam

$mergeParam = $movementClass.MergeParam