ISIAPISiteVolumeMovPed Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: C457322F-040F-4B2C-97A8-01F1C58B728E

Declaration¶

[Guid("C457322F-040F-4B2C-97A8-01F1C58B728E")]
public interface ISIAPISiteVolumeMovPed

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPISiteVolumeMovPed you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeMovPed = ...

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

Properties¶

Type¶

The type of a Pedestrian Movement

int Type { get; }

Type int

Value

One of:

1 - Full Crossing
2 - Slip Lane
3 - Staged
4 - Diagonal

Code samples

C#VB.NETPythonPowerShell

int type = siteVolumeMovPed.Type;

Dim type As Integer = siteVolumeMovPed.Type

type = siteVolumeMovPed.Type

$type = $siteVolumeMovPed.Type

Origin¶

Pedestrian Movement Origin Leg, ie the Leg across which the Movement runs

int Origin { 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 origin = siteVolumeMovPed.Origin;

Dim origin As Integer = siteVolumeMovPed.Origin

origin = siteVolumeMovPed.Origin

$origin = $siteVolumeMovPed.Origin

Stage¶

Pedestrian Movement Stage. SIDRA INTERSECTION supports up to two Pedestrian Movements on each Leg allowing modelling of "staged" pedestrian crossings.

int Stage { get; }

Type int

Value

One of:

1 - Stage 1 (Approach-side crossing)
2 - Stage 2 (Exit-side crossing)

Code samples

C#VB.NETPythonPowerShell

int stage = siteVolumeMovPed.Stage;

Dim stage As Integer = siteVolumeMovPed.Stage

stage = siteVolumeMovPed.Stage

$stage = $siteVolumeMovPed.Stage

Exists¶

Flag indicating whether this Pedestrian Movement "exists" (not banned) in the current Site Volume Bin.

bool Exists { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool exists = siteVolumeMovPed.Exists;
siteVolumeMovPed.Exists = true;

Dim exists As Boolean = siteVolumeMovPed.Exists
siteVolumeMovPed.Exists = true

exists = siteVolumeMovPed.Exists
siteVolumeMovPed.Exists = True

$exists = $siteVolumeMovPed.Exists
$siteVolumeMovPed.Exists = $true

Volume¶

Pedestrian Volume

float Volume { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float volume = siteVolumeMovPed.Volume;
siteVolumeMovPed.Volume = 0.0;

Dim volume As Single = siteVolumeMovPed.Volume
siteVolumeMovPed.Volume = 0.0

volume = siteVolumeMovPed.Volume
siteVolumeMovPed.Volume = 0.0

$volume = $siteVolumeMovPed.Volume
$siteVolumeMovPed.Volume = 0.0

PeakFlowFactor¶

Peak Flow Factor (%)

float PeakFlowFactor { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float peakFlowFactor = siteVolumeMovPed.PeakFlowFactor;
siteVolumeMovPed.PeakFlowFactor = 0.0;

Dim peakFlowFactor As Single = siteVolumeMovPed.PeakFlowFactor
siteVolumeMovPed.PeakFlowFactor = 0.0

peak_flow_factor = siteVolumeMovPed.PeakFlowFactor
siteVolumeMovPed.PeakFlowFactor = 0.0

$peakFlowFactor = $siteVolumeMovPed.PeakFlowFactor
$siteVolumeMovPed.PeakFlowFactor = 0.0

FlowScale¶

Flow Scale (Constant) (%)

float FlowScale { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float flowScale = siteVolumeMovPed.FlowScale;
siteVolumeMovPed.FlowScale = 0.0;

Dim flowScale As Single = siteVolumeMovPed.FlowScale
siteVolumeMovPed.FlowScale = 0.0

flow_scale = siteVolumeMovPed.FlowScale
siteVolumeMovPed.FlowScale = 0.0

$flowScale = $siteVolumeMovPed.FlowScale
$siteVolumeMovPed.FlowScale = 0.0

GrowthRate¶

Growth Rate (%/year)

float GrowthRate { get; set; }

Type float

Code samples

C#VB.NETPythonPowerShell

float growthRate = siteVolumeMovPed.GrowthRate;
siteVolumeMovPed.GrowthRate = 0.0;

Dim growthRate As Single = siteVolumeMovPed.GrowthRate
siteVolumeMovPed.GrowthRate = 0.0

growth_rate = siteVolumeMovPed.GrowthRate
siteVolumeMovPed.GrowthRate = 0.0

$growthRate = $siteVolumeMovPed.GrowthRate
$siteVolumeMovPed.GrowthRate = 0.0

SiteVolumeBin¶

ISIAPISiteVolumeBin SiteVolumeBin { get; }

Type ISIAPISiteVolumeBin

Code samples

C#VB.NETPythonPowerShell

var siteVolumeBin = siteVolumeMovPed.SiteVolumeBin;

Dim siteVolumeBin As ISIAPISiteVolumeBin = siteVolumeMovPed.SiteVolumeBin

site_volume_bin = siteVolumeMovPed.SiteVolumeBin

$siteVolumeBin = $siteVolumeMovPed.SiteVolumeBin