SiteVolumeMC¶

Type ISIAPISiteVolumeMC · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID AD3528EC-D1B6-4D51-B0EF-03C7F3EDE7A8

Declaration¶

[Guid("AD3528EC-D1B6-4D51-B0EF-03C7F3EDE7A8")]
public interface ISIAPISiteVolumeMC

Members¶

Properties

Property	Type	Summary
MCClass	`int`	Movement Class Number
Name	`string`	Movement Class Name, this Property can be changed only if this is a User Movement Class, i.e. IsUserClass == true.
IsIncluded	`bool`	Flag indicating whether this Movement Class is included in the Site Volume Bin. This Property can be changed if this Movement Class is not Light Vehicles or Heavy Vehicles. These two Movement Classes must be included.
IsUserClass	`bool`
SiteVolumeBin	`ISIAPISiteVolumeBin`

Properties¶

MCClass¶

Movement Class Number

int MCClass { 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 mCClass = siteVolumeMC.MCClass;

long mCClass;
siteVolumeMC->get_MCClass(&mCClass);

mc_class = siteVolumeMC.MCClass

$mCClass = $siteVolumeMC.MCClass

Name¶

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

string Name { get; set; }

Type string

Code samples

C#C++PythonPowerShell

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

CComBSTR name;
siteVolumeMC->get_Name(&name);
siteVolumeMC->put_Name(CComBSTR(L"Example"));

name = siteVolumeMC.Name
siteVolumeMC.Name = r"Example"

$name = $siteVolumeMC.Name
$siteVolumeMC.Name = "Example"

IsIncluded¶

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

bool IsIncluded { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool isIncluded = siteVolumeMC.IsIncluded;
siteVolumeMC.IsIncluded = true;

VARIANT_BOOL isIncluded;
siteVolumeMC->get_IsIncluded(&isIncluded);
siteVolumeMC->put_IsIncluded(VARIANT_TRUE);

is_included = siteVolumeMC.IsIncluded
siteVolumeMC.IsIncluded = True

$isIncluded = $siteVolumeMC.IsIncluded
$siteVolumeMC.IsIncluded = $true

IsUserClass¶

bool IsUserClass { get; }

Type bool

Code samples

C#C++PythonPowerShell

bool isUserClass = siteVolumeMC.IsUserClass;

VARIANT_BOOL isUserClass;
siteVolumeMC->get_IsUserClass(&isUserClass);

is_user_class = siteVolumeMC.IsUserClass

$isUserClass = $siteVolumeMC.IsUserClass

SiteVolumeBin¶

ISIAPISiteVolumeBin SiteVolumeBin { get; }

Type ISIAPISiteVolumeBin

Code samples

C#C++PythonPowerShell

var siteVolumeBin = siteVolumeMC.SiteVolumeBin;

CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
siteVolumeMC->get_SiteVolumeBin(&siteVolumeBin);

site_volume_bin = siteVolumeMC.SiteVolumeBin

$siteVolumeBin = $siteVolumeMC.SiteVolumeBin