Sensitivity¶

Type ISIAPISensitivity · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 9A3A1922-E8D3-41D2-82DB-0CF119851325

Declaration¶

[Guid("9A3A1922-E8D3-41D2-82DB-0CF119851325")]
public interface ISIAPISensitivity

Members¶

Properties

Property	Type	Summary
Groupno	`int`	Sensitivity Parameter Group Number
Selected_parameter	`int`	Selected Sensitivity Parameter
Lower	`float`
Upper	`float`
Increment	`float`
Is_constant_factor_applied	`bool`
Constant_factor	`float`

Properties¶

Groupno¶

Sensitivity Parameter Group Number

int Groupno { get; }

Type int

Value

One of:

0 - General Parameter Group
1 - Roundabout Parameter Group

Code samples

C#C++PythonPowerShell

int groupno = sensitivity.Groupno;

long groupno;
sensitivity->get_Groupno(&groupno);

groupno = sensitivity.Groupno

$groupno = $sensitivity.Groupno

Selected_parameter¶

Selected Sensitivity Parameter

int Selected_parameter { get; set; }

Type int

Value

One of:

1 - Critical Gap Follow-up Headway
2 - Basic Saturation Flow
3 - Lane Width
4 - Lane Utilisation Ratio
5 - Cruise Speed
6 - Vehicle Queue Space
7 - Inscribed Diameter
8 - Entry Angle
9 - Entry Radius

Remarks

Values 1 - 6 are only available in General Parameter Group (Group No. = 0). Values 7 - 9 are only available in Roundabout Parameter Group (Group No. = 1)

Code samples

C#C++PythonPowerShell

int selected_parameter = sensitivity.Selected_parameter;
sensitivity.Selected_parameter = 0;

long selected_parameter;
sensitivity->get_Selected_parameter(&selected_parameter);
sensitivity->put_Selected_parameter(0);

selected_parameter = sensitivity.Selected_parameter
sensitivity.Selected_parameter = 0

$selected_parameter = $sensitivity.Selected_parameter
$sensitivity.Selected_parameter = 0

Lower¶

float Lower { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float lower = sensitivity.Lower;
sensitivity.Lower = 0.0;

double lower;
sensitivity->get_Lower(&lower);
sensitivity->put_Lower(0.0);

lower = sensitivity.Lower
sensitivity.Lower = 0.0

$lower = $sensitivity.Lower
$sensitivity.Lower = 0.0

Upper¶

float Upper { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float upper = sensitivity.Upper;
sensitivity.Upper = 0.0;

double upper;
sensitivity->get_Upper(&upper);
sensitivity->put_Upper(0.0);

upper = sensitivity.Upper
sensitivity.Upper = 0.0

$upper = $sensitivity.Upper
$sensitivity.Upper = 0.0

Increment¶

float Increment { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float increment = sensitivity.Increment;
sensitivity.Increment = 0.0;

double increment;
sensitivity->get_Increment(&increment);
sensitivity->put_Increment(0.0);

increment = sensitivity.Increment
sensitivity.Increment = 0.0

$increment = $sensitivity.Increment
$sensitivity.Increment = 0.0

Is_constant_factor_applied¶

bool Is_constant_factor_applied { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool is_constant_factor_applied = sensitivity.Is_constant_factor_applied;
sensitivity.Is_constant_factor_applied = true;

VARIANT_BOOL is_constant_factor_applied;
sensitivity->get_Is_constant_factor_applied(&is_constant_factor_applied);
sensitivity->put_Is_constant_factor_applied(VARIANT_TRUE);

is_constant_factor_applied = sensitivity.Is_constant_factor_applied
sensitivity.Is_constant_factor_applied = True

$is_constant_factor_applied = $sensitivity.Is_constant_factor_applied
$sensitivity.Is_constant_factor_applied = $true

Constant_factor¶

float Constant_factor { get; set; }

Type float

Code samples

C#C++PythonPowerShell

float constant_factor = sensitivity.Constant_factor;
sensitivity.Constant_factor = 0.0;

double constant_factor;
sensitivity->get_Constant_factor(&constant_factor);
sensitivity->put_Constant_factor(0.0);

constant_factor = sensitivity.Constant_factor
sensitivity.Constant_factor = 0.0

$constant_factor = $sensitivity.Constant_factor
$sensitivity.Constant_factor = 0.0