ISIAPISiteVolumeLeg Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: F338BDE5-A67A-49A2-B141-7E0FDFCBFDBD

Declaration¶

[Guid("F338BDE5-A67A-49A2-B141-7E0FDFCBFDBD")]
public interface ISIAPISiteVolumeLeg

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPISiteVolumeLeg you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeLeg = ...

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

Properties¶

Orientation¶

Leg Orientation

int Orientation { get; }

Type int

Value

One of:

0 - South
1 - South East
2 - East
3 - North East
4 - North
5 - North West
6 - West
7 - South West

Code samples

C#VB.NETPythonPowerShell

int orientation = siteVolumeLeg.Orientation;

Dim orientation As Integer = siteVolumeLeg.Orientation

orientation = siteVolumeLeg.Orientation

$orientation = $siteVolumeLeg.Orientation

LegGeometry¶

Leg Geometry

int LegGeometry { get; set; }

Type int

Value

One of:

0 - No Leg
1 - Two Way
2 - One-Way Approach
3 - One-Way Exit

Code samples

C#VB.NETPythonPowerShell

int legGeometry = siteVolumeLeg.LegGeometry;
siteVolumeLeg.LegGeometry = 0;

Dim legGeometry As Integer = siteVolumeLeg.LegGeometry
siteVolumeLeg.LegGeometry = 0

leg_geometry = siteVolumeLeg.LegGeometry
siteVolumeLeg.LegGeometry = 0

$legGeometry = $siteVolumeLeg.LegGeometry
$siteVolumeLeg.LegGeometry = 0

PedMainCrossingVolumeOption¶

Pedestrian Volume Data Option for Main Crossing (Full and Staged)

int PedMainCrossingVolumeOption { get; set; }

Type int

Value

One of:

0 - Overall Value for Full and Staged Crossings (All Stages)
1 - Separate Value for Full and Staged Crossings

Remarks

When this Option is set to 0 (Overall Value), the overall pedestrian volume data (Volume, Peak Flow Factor, Flow Scale and Growth Rate) in the ISIAPISiteVolumeLeg object are applied for the Pedestrian Full and Staged Crossings Movementes. The volume data in the corresponding ISIAPISiteVolumeMovPed object are ignored. When this Option is set to 1 (Separate Value), the volume data in the corresponding ISIAPISiteVolumeMovPed object are applied.

This option does not affect the volume data of Slip/Bypass Lane Crossing. The volume data in the corresponding ISIAPISiteVolumeMovPed object for the Slip/Bypass Lane Crossing are applied.

Code samples

C#VB.NETPythonPowerShell

int pedMainCrossingVolumeOption = siteVolumeLeg.PedMainCrossingVolumeOption;
siteVolumeLeg.PedMainCrossingVolumeOption = 0;

Dim pedMainCrossingVolumeOption As Integer = siteVolumeLeg.PedMainCrossingVolumeOption
siteVolumeLeg.PedMainCrossingVolumeOption = 0

ped_main_crossing_volume_option = siteVolumeLeg.PedMainCrossingVolumeOption
siteVolumeLeg.PedMainCrossingVolumeOption = 0

$pedMainCrossingVolumeOption = $siteVolumeLeg.PedMainCrossingVolumeOption
$siteVolumeLeg.PedMainCrossingVolumeOption = 0

PedMainCrossingVolume¶

float PedMainCrossingVolume { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float pedMainCrossingVolume = siteVolumeLeg.PedMainCrossingVolume;
siteVolumeLeg.PedMainCrossingVolume = 0.0;

Dim pedMainCrossingVolume As Single = siteVolumeLeg.PedMainCrossingVolume
siteVolumeLeg.PedMainCrossingVolume = 0.0

ped_main_crossing_volume = siteVolumeLeg.PedMainCrossingVolume
siteVolumeLeg.PedMainCrossingVolume = 0.0

$pedMainCrossingVolume = $siteVolumeLeg.PedMainCrossingVolume
$siteVolumeLeg.PedMainCrossingVolume = 0.0

PedMainCrossingPeakFlowFactor¶

float PedMainCrossingPeakFlowFactor { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float pedMainCrossingPeakFlowFactor = siteVolumeLeg.PedMainCrossingPeakFlowFactor;
siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0;

Dim pedMainCrossingPeakFlowFactor As Single = siteVolumeLeg.PedMainCrossingPeakFlowFactor
siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0

ped_main_crossing_peak_flow_factor = siteVolumeLeg.PedMainCrossingPeakFlowFactor
siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0

$pedMainCrossingPeakFlowFactor = $siteVolumeLeg.PedMainCrossingPeakFlowFactor
$siteVolumeLeg.PedMainCrossingPeakFlowFactor = 0.0

PedMainCrossingFlowScale¶

float PedMainCrossingFlowScale { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float pedMainCrossingFlowScale = siteVolumeLeg.PedMainCrossingFlowScale;
siteVolumeLeg.PedMainCrossingFlowScale = 0.0;

Dim pedMainCrossingFlowScale As Single = siteVolumeLeg.PedMainCrossingFlowScale
siteVolumeLeg.PedMainCrossingFlowScale = 0.0

ped_main_crossing_flow_scale = siteVolumeLeg.PedMainCrossingFlowScale
siteVolumeLeg.PedMainCrossingFlowScale = 0.0

$pedMainCrossingFlowScale = $siteVolumeLeg.PedMainCrossingFlowScale
$siteVolumeLeg.PedMainCrossingFlowScale = 0.0

PedMainCrossingGrowthRate¶

float PedMainCrossingGrowthRate { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float pedMainCrossingGrowthRate = siteVolumeLeg.PedMainCrossingGrowthRate;
siteVolumeLeg.PedMainCrossingGrowthRate = 0.0;

Dim pedMainCrossingGrowthRate As Single = siteVolumeLeg.PedMainCrossingGrowthRate
siteVolumeLeg.PedMainCrossingGrowthRate = 0.0

ped_main_crossing_growth_rate = siteVolumeLeg.PedMainCrossingGrowthRate
siteVolumeLeg.PedMainCrossingGrowthRate = 0.0

$pedMainCrossingGrowthRate = $siteVolumeLeg.PedMainCrossingGrowthRate
$siteVolumeLeg.PedMainCrossingGrowthRate = 0.0

SiteVolumeBin¶

ISIAPISiteVolumeBin SiteVolumeBin { get; }

Type ISIAPISiteVolumeBin

Code samples

C#VB.NETPythonPowerShell

var siteVolumeBin = siteVolumeLeg.SiteVolumeBin;

Dim siteVolumeBin As ISIAPISiteVolumeBin = siteVolumeLeg.SiteVolumeBin

site_volume_bin = siteVolumeLeg.SiteVolumeBin

$siteVolumeBin = $siteVolumeLeg.SiteVolumeBin