SiteVolumeBin¶

Type ISIAPISiteVolumeBin · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 390838EE-09C7-472E-B3AB-FAE18E33AC81

SiteVolumeBin wrapper interface

Declaration¶

[Guid("390838EE-09C7-472E-B3AB-FAE18E33AC81")]
public interface ISIAPISiteVolumeBin

Members¶

Properties

Property	Type	Summary
SiteVolumeBin_id	`string`	The GUID of the Site Volume Bin object.
Name	`string`	Site Volume Bin Name
ID	`string`	Site Volume Bin ID in the Site Bin Setup dialog
Position	`int`
IsInputDataCompatible	`bool`
MinViableVersionL1	`string`	Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 1 Compatibility
MinViableVersionL2	`string`	Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 2 Compatibility
DriveOnLeft	`bool`	Flag indicating the "Drive Rule" of the Site Volume Bin
Units	`int`	General unit system used for data within the Site Volume Bin
Title	`string`	Site Volume Bin title
Description	`string`	Site Volume Bin description
UnitTimeForVolumes	`int`	Unit time for traffic volumes in minutes
PeakFlowPeriod	`int`	Peak flow period in minutes
HoursPerYear	`int`
Created_date	`DateTime`
Created_by	`string`
Created_by_company	`string`
Created_version	`string`
Modified_date	`DateTime`
Modified_by	`string`
Modified_by_company	`string`
Modified_version	`string`
LastErrorMessage	`string`
SiteVolumeBinFolder	`ISIAPISiteVolumeBinFolder`
SiteVolumeMCs	`ISIAPISiteVolumeMCs`
SiteVolumeLegs	`ISIAPISiteVolumeLegs`	Site Volume Legs in this Volume Bin All eight Legs are created when creating a Site Volume Bin. The South, East, North and West Legs' Geometry are set to 1 (Two Way), the other Legs' Geometry are set to 0 ('No Leg') by default.
SiteVolumeMovVehODs	`ISIAPISiteVolumeMovVehODs`
SiteVolumeMovPeds	`ISIAPISiteVolumeMovPeds`

Methods

Method	Returns	Summary
UpdateModifiedInfo()	`bool`	Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

Properties¶

SiteVolumeBin_id¶

The GUID of the Site Volume Bin object.

string SiteVolumeBin_id { get; }

Type string

Code samples

C#C++PythonPowerShell

string siteVolumeBin_id = siteVolumeBin.SiteVolumeBin_id;

CComBSTR siteVolumeBin_id;
siteVolumeBin->get_SiteVolumeBin_id(&siteVolumeBin_id);

site_volume_bin_id = siteVolumeBin.SiteVolumeBin_id

$siteVolumeBin_id = $siteVolumeBin.SiteVolumeBin_id

Name¶

Site Volume Bin Name

string Name { get; set; }

Type string

Value

Site Volume Bin Name, max length = 100.

Code samples

C#C++PythonPowerShell

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

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

name = siteVolumeBin.Name
siteVolumeBin.Name = r"Example"

$name = $siteVolumeBin.Name
$siteVolumeBin.Name = "Example"

ID¶

Site Volume Bin ID in the Site Bin Setup dialog

string ID { get; set; }

Type string

Value

Site Volume Bin ID, max length = 10.

Code samples

C#C++PythonPowerShell

string iD = siteVolumeBin.ID;
siteVolumeBin.ID = @"id-1";

CComBSTR iD;
siteVolumeBin->get_ID(&iD);
siteVolumeBin->put_ID(CComBSTR(L"id-1"));

id = siteVolumeBin.ID
siteVolumeBin.ID = r"id-1"

$iD = $siteVolumeBin.ID
$siteVolumeBin.ID = "id-1"

Position¶

int Position { get; }

Type int

Code samples

C#C++PythonPowerShell

int position = siteVolumeBin.Position;

long position;
siteVolumeBin->get_Position(&position);

position = siteVolumeBin.Position

$position = $siteVolumeBin.Position

IsInputDataCompatible¶

bool IsInputDataCompatible { get; }

Type bool

Code samples

C#C++PythonPowerShell

bool isInputDataCompatible = siteVolumeBin.IsInputDataCompatible;

VARIANT_BOOL isInputDataCompatible;
siteVolumeBin->get_IsInputDataCompatible(&isInputDataCompatible);

is_input_data_compatible = siteVolumeBin.IsInputDataCompatible

$isInputDataCompatible = $siteVolumeBin.IsInputDataCompatible

MinViableVersionL1¶

Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 1 Compatibility

string MinViableVersionL1 { get; }

Type string

Remarks

Level 1 Compatibility means that this Site Volume Bin's Input data are fully compatible with the current SIDRA INTERSECTION version.

Code samples

C#C++PythonPowerShell

string minViableVersionL1 = siteVolumeBin.MinViableVersionL1;

CComBSTR minViableVersionL1;
siteVolumeBin->get_MinViableVersionL1(&minViableVersionL1);

min_viable_version_l1 = siteVolumeBin.MinViableVersionL1

$minViableVersionL1 = $siteVolumeBin.MinViableVersionL1

MinViableVersionL2¶

Minimum Viable SIDRA INTERSECTION Version for this Site Volume Bin's Level 2 Compatibility

string MinViableVersionL2 { get; }

Type string

Remarks

Level 2 Compatibility means that some of this Site Volume Bin's Input data are incompatible with the current SIDRA INTERSECTION version but the current version is still able to edit these Input data.

If the current SIDRA INTERSECTION Version is smaller than the MinViableVersionL2, ISIAPISiteVolumeBin.IsInputDataCompatible return false.

Code samples

C#C++PythonPowerShell

string minViableVersionL2 = siteVolumeBin.MinViableVersionL2;

CComBSTR minViableVersionL2;
siteVolumeBin->get_MinViableVersionL2(&minViableVersionL2);

min_viable_version_l2 = siteVolumeBin.MinViableVersionL2

$minViableVersionL2 = $siteVolumeBin.MinViableVersionL2

DriveOnLeft¶

Flag indicating the "Drive Rule" of the Site Volume Bin

bool DriveOnLeft { get; }

Type bool

Value

True if driving on the left. False if driving on the right.

Code samples

C#C++PythonPowerShell

bool driveOnLeft = siteVolumeBin.DriveOnLeft;

VARIANT_BOOL driveOnLeft;
siteVolumeBin->get_DriveOnLeft(&driveOnLeft);

drive_on_left = siteVolumeBin.DriveOnLeft

$driveOnLeft = $siteVolumeBin.DriveOnLeft

Units¶

General unit system used for data within the Site Volume Bin

int Units { get; }

Type int

Value

One of:

0 - Metric
1 - US Units

Code samples

C#C++PythonPowerShell

int units = siteVolumeBin.Units;

long units;
siteVolumeBin->get_Units(&units);

units = siteVolumeBin.Units

$units = $siteVolumeBin.Units

Title¶

Site Volume Bin title

string Title { get; set; }

Type string

Value

Site Volume Bin title, max length = 500.

Code samples

C#C++PythonPowerShell

string title = siteVolumeBin.Title;
siteVolumeBin.Title = @"value";

CComBSTR title;
siteVolumeBin->get_Title(&title);
siteVolumeBin->put_Title(CComBSTR(L"value"));

title = siteVolumeBin.Title
siteVolumeBin.Title = r"value"

$title = $siteVolumeBin.Title
$siteVolumeBin.Title = "value"

Description¶

Site Volume Bin description

string Description { get; set; }

Type string

Value

Site Volume Bin description, max length = 500.

Code samples

C#C++PythonPowerShell

string description = siteVolumeBin.Description;
siteVolumeBin.Description = @"value";

CComBSTR description;
siteVolumeBin->get_Description(&description);
siteVolumeBin->put_Description(CComBSTR(L"value"));

description = siteVolumeBin.Description
siteVolumeBin.Description = r"value"

$description = $siteVolumeBin.Description
$siteVolumeBin.Description = "value"

UnitTimeForVolumes¶

Unit time for traffic volumes in minutes

int UnitTimeForVolumes { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int unitTimeForVolumes = siteVolumeBin.UnitTimeForVolumes;
siteVolumeBin.UnitTimeForVolumes = 0;

long unitTimeForVolumes;
siteVolumeBin->get_UnitTimeForVolumes(&unitTimeForVolumes);
siteVolumeBin->put_UnitTimeForVolumes(0);

unit_time_for_volumes = siteVolumeBin.UnitTimeForVolumes
siteVolumeBin.UnitTimeForVolumes = 0

$unitTimeForVolumes = $siteVolumeBin.UnitTimeForVolumes
$siteVolumeBin.UnitTimeForVolumes = 0

PeakFlowPeriod¶

Peak flow period in minutes

int PeakFlowPeriod { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int peakFlowPeriod = siteVolumeBin.PeakFlowPeriod;
siteVolumeBin.PeakFlowPeriod = 0;

long peakFlowPeriod;
siteVolumeBin->get_PeakFlowPeriod(&peakFlowPeriod);
siteVolumeBin->put_PeakFlowPeriod(0);

peak_flow_period = siteVolumeBin.PeakFlowPeriod
siteVolumeBin.PeakFlowPeriod = 0

$peakFlowPeriod = $siteVolumeBin.PeakFlowPeriod
$siteVolumeBin.PeakFlowPeriod = 0

HoursPerYear¶

int HoursPerYear { get; set; }

Type int

Code samples

C#C++PythonPowerShell

int hoursPerYear = siteVolumeBin.HoursPerYear;
siteVolumeBin.HoursPerYear = 0;

long hoursPerYear;
siteVolumeBin->get_HoursPerYear(&hoursPerYear);
siteVolumeBin->put_HoursPerYear(0);

hours_per_year = siteVolumeBin.HoursPerYear
siteVolumeBin.HoursPerYear = 0

$hoursPerYear = $siteVolumeBin.HoursPerYear
$siteVolumeBin.HoursPerYear = 0

Created_date¶

DateTime Created_date { get; }

Type DateTime

Code samples

C#C++PythonPowerShell

var created_date = siteVolumeBin.Created_date;

VARIANT created_date;
siteVolumeBin->get_Created_date(&created_date);

created_date = siteVolumeBin.Created_date

$created_date = $siteVolumeBin.Created_date

Created_by¶

string Created_by { get; }

Type string

Code samples

C#C++PythonPowerShell

string created_by = siteVolumeBin.Created_by;

CComBSTR created_by;
siteVolumeBin->get_Created_by(&created_by);

created_by = siteVolumeBin.Created_by

$created_by = $siteVolumeBin.Created_by

Created_by_company¶

string Created_by_company { get; }

Type string

Code samples

C#C++PythonPowerShell

string created_by_company = siteVolumeBin.Created_by_company;

CComBSTR created_by_company;
siteVolumeBin->get_Created_by_company(&created_by_company);

created_by_company = siteVolumeBin.Created_by_company

$created_by_company = $siteVolumeBin.Created_by_company

Created_version¶

string Created_version { get; }

Type string

Code samples

C#C++PythonPowerShell

string created_version = siteVolumeBin.Created_version;

CComBSTR created_version;
siteVolumeBin->get_Created_version(&created_version);

created_version = siteVolumeBin.Created_version

$created_version = $siteVolumeBin.Created_version

Modified_date¶

DateTime Modified_date { get; }

Type DateTime

Code samples

C#C++PythonPowerShell

var modified_date = siteVolumeBin.Modified_date;

VARIANT modified_date;
siteVolumeBin->get_Modified_date(&modified_date);

modified_date = siteVolumeBin.Modified_date

$modified_date = $siteVolumeBin.Modified_date

Modified_by¶

string Modified_by { get; }

Type string

Code samples

C#C++PythonPowerShell

string modified_by = siteVolumeBin.Modified_by;

CComBSTR modified_by;
siteVolumeBin->get_Modified_by(&modified_by);

modified_by = siteVolumeBin.Modified_by

$modified_by = $siteVolumeBin.Modified_by

Modified_by_company¶

string Modified_by_company { get; }

Type string

Code samples

C#C++PythonPowerShell

string modified_by_company = siteVolumeBin.Modified_by_company;

CComBSTR modified_by_company;
siteVolumeBin->get_Modified_by_company(&modified_by_company);

modified_by_company = siteVolumeBin.Modified_by_company

$modified_by_company = $siteVolumeBin.Modified_by_company

Modified_version¶

string Modified_version { get; }

Type string

Code samples

C#C++PythonPowerShell

string modified_version = siteVolumeBin.Modified_version;

CComBSTR modified_version;
siteVolumeBin->get_Modified_version(&modified_version);

modified_version = siteVolumeBin.Modified_version

$modified_version = $siteVolumeBin.Modified_version

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#C++PythonPowerShell

string lastErrorMessage = siteVolumeBin.LastErrorMessage;

CComBSTR lastErrorMessage;
siteVolumeBin->get_LastErrorMessage(&lastErrorMessage);

last_error_message = siteVolumeBin.LastErrorMessage

$lastErrorMessage = $siteVolumeBin.LastErrorMessage

SiteVolumeBinFolder¶

ISIAPISiteVolumeBinFolder SiteVolumeBinFolder { get; }

Type ISIAPISiteVolumeBinFolder

Code samples

C#C++PythonPowerShell

var siteVolumeBinFolder = siteVolumeBin.SiteVolumeBinFolder;

CComPtr<ISIAPISiteVolumeBinFolder> siteVolumeBinFolder;
siteVolumeBin->get_SiteVolumeBinFolder(&siteVolumeBinFolder);

site_volume_bin_folder = siteVolumeBin.SiteVolumeBinFolder

$siteVolumeBinFolder = $siteVolumeBin.SiteVolumeBinFolder

SiteVolumeMCs¶

ISIAPISiteVolumeMCs SiteVolumeMCs { get; }

Type ISIAPISiteVolumeMCs

Code samples

C#C++PythonPowerShell

var siteVolumeMCs = siteVolumeBin.SiteVolumeMCs;

CComPtr<ISIAPISiteVolumeMCs> siteVolumeMCs;
siteVolumeBin->get_SiteVolumeMCs(&siteVolumeMCs);

site_volume_m_cs = siteVolumeBin.SiteVolumeMCs

$siteVolumeMCs = $siteVolumeBin.SiteVolumeMCs

SiteVolumeLegs¶

Site Volume Legs in this Volume Bin

All eight Legs are created when creating a Site Volume Bin. The South, East, North and West Legs' Geometry are set to 1 (Two Way), the other Legs' Geometry are set to 0 ('No Leg') by default.

ISIAPISiteVolumeLegs SiteVolumeLegs { get; }

Type ISIAPISiteVolumeLegs

Code samples

C#C++PythonPowerShell

var siteVolumeLegs = siteVolumeBin.SiteVolumeLegs;

CComPtr<ISIAPISiteVolumeLegs> siteVolumeLegs;
siteVolumeBin->get_SiteVolumeLegs(&siteVolumeLegs);

site_volume_legs = siteVolumeBin.SiteVolumeLegs

$siteVolumeLegs = $siteVolumeBin.SiteVolumeLegs

SiteVolumeMovVehODs¶

ISIAPISiteVolumeMovVehODs SiteVolumeMovVehODs { get; }

Type ISIAPISiteVolumeMovVehODs

Code samples

C#C++PythonPowerShell

var siteVolumeMovVehODs = siteVolumeBin.SiteVolumeMovVehODs;

CComPtr<ISIAPISiteVolumeMovVehODs> siteVolumeMovVehODs;
siteVolumeBin->get_SiteVolumeMovVehODs(&siteVolumeMovVehODs);

site_volume_mov_veh_o_ds = siteVolumeBin.SiteVolumeMovVehODs

$siteVolumeMovVehODs = $siteVolumeBin.SiteVolumeMovVehODs

SiteVolumeMovPeds¶

ISIAPISiteVolumeMovPeds SiteVolumeMovPeds { get; }

Type ISIAPISiteVolumeMovPeds

Code samples

C#C++PythonPowerShell

var siteVolumeMovPeds = siteVolumeBin.SiteVolumeMovPeds;

CComPtr<ISIAPISiteVolumeMovPeds> siteVolumeMovPeds;
siteVolumeBin->get_SiteVolumeMovPeds(&siteVolumeMovPeds);

site_volume_mov_peds = siteVolumeBin.SiteVolumeMovPeds

$siteVolumeMovPeds = $siteVolumeBin.SiteVolumeMovPeds

Methods¶

UpdateModifiedInfo()¶

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

bool UpdateModifiedInfo()

Returns bool

Code samples

C#C++PythonPowerShell

bool result = siteVolumeBin.UpdateModifiedInfo();

VARIANT_BOOL result;
siteVolumeBin->UpdateModifiedInfo(&result);

result = siteVolumeBin.UpdateModifiedInfo()

$result = $siteVolumeBin.UpdateModifiedInfo()