Skip to content

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

Get an instance

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

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

# Navigate to the ISIAPISiteVolumeBin you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteVolumeBin = ...

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

Properties

SiteVolumeBin_id

The GUID of the Site Volume Bin object.

string SiteVolumeBin_id { get; }

Type string

Code samples 
string siteVolumeBin_id = siteVolumeBin.SiteVolumeBin_id;

Dim siteVolumeBin_id As String = siteVolumeBin.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 
string name = siteVolumeBin.Name;
siteVolumeBin.Name = @"Example";

Dim name As String = siteVolumeBin.Name
siteVolumeBin.Name = "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 
string iD = siteVolumeBin.ID;
siteVolumeBin.ID = @"id-1";

Dim iD As String = siteVolumeBin.ID
siteVolumeBin.ID = "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 
int position = siteVolumeBin.Position;

Dim position As Integer = siteVolumeBin.Position

position = siteVolumeBin.Position

$position = $siteVolumeBin.Position

IsInputDataCompatible

bool IsInputDataCompatible { get; }

Type bool

Code samples 
bool isInputDataCompatible = siteVolumeBin.IsInputDataCompatible;

Dim isInputDataCompatible As Boolean = siteVolumeBin.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 
string minViableVersionL1 = siteVolumeBin.MinViableVersionL1;

Dim minViableVersionL1 As String = siteVolumeBin.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 
string minViableVersionL2 = siteVolumeBin.MinViableVersionL2;

Dim minViableVersionL2 As String = siteVolumeBin.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 
bool driveOnLeft = siteVolumeBin.DriveOnLeft;

Dim driveOnLeft As Boolean = siteVolumeBin.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 
int units = siteVolumeBin.Units;

Dim units As Integer = siteVolumeBin.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 
string title = siteVolumeBin.Title;
siteVolumeBin.Title = @"value";

Dim title As String = siteVolumeBin.Title
siteVolumeBin.Title = "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 
string description = siteVolumeBin.Description;
siteVolumeBin.Description = @"value";

Dim description As String = siteVolumeBin.Description
siteVolumeBin.Description = "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 
int unitTimeForVolumes = siteVolumeBin.UnitTimeForVolumes;
siteVolumeBin.UnitTimeForVolumes = 0;

Dim unitTimeForVolumes As Integer = siteVolumeBin.UnitTimeForVolumes
siteVolumeBin.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 
int peakFlowPeriod = siteVolumeBin.PeakFlowPeriod;
siteVolumeBin.PeakFlowPeriod = 0;

Dim peakFlowPeriod As Integer = siteVolumeBin.PeakFlowPeriod
siteVolumeBin.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 
int hoursPerYear = siteVolumeBin.HoursPerYear;
siteVolumeBin.HoursPerYear = 0;

Dim hoursPerYear As Integer = siteVolumeBin.HoursPerYear
siteVolumeBin.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 
var created_date = siteVolumeBin.Created_date;

Dim created_date As DateTime = siteVolumeBin.Created_date

created_date = siteVolumeBin.Created_date

$created_date = $siteVolumeBin.Created_date

Created_by

string Created_by { get; }

Type string

Code samples 
string created_by = siteVolumeBin.Created_by;

Dim created_by As String = siteVolumeBin.Created_by

created_by = siteVolumeBin.Created_by

$created_by = $siteVolumeBin.Created_by

Created_by_company

string Created_by_company { get; }

Type string

Code samples 
string created_by_company = siteVolumeBin.Created_by_company;

Dim created_by_company As String = siteVolumeBin.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 
string created_version = siteVolumeBin.Created_version;

Dim created_version As String = siteVolumeBin.Created_version

created_version = siteVolumeBin.Created_version

$created_version = $siteVolumeBin.Created_version

Modified_date

DateTime Modified_date { get; }

Type DateTime

Code samples 
var modified_date = siteVolumeBin.Modified_date;

Dim modified_date As DateTime = siteVolumeBin.Modified_date

modified_date = siteVolumeBin.Modified_date

$modified_date = $siteVolumeBin.Modified_date

Modified_by

string Modified_by { get; }

Type string

Code samples 
string modified_by = siteVolumeBin.Modified_by;

Dim modified_by As String = siteVolumeBin.Modified_by

modified_by = siteVolumeBin.Modified_by

$modified_by = $siteVolumeBin.Modified_by

Modified_by_company

string Modified_by_company { get; }

Type string

Code samples 
string modified_by_company = siteVolumeBin.Modified_by_company;

Dim modified_by_company As String = siteVolumeBin.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 
string modified_version = siteVolumeBin.Modified_version;

Dim modified_version As String = siteVolumeBin.Modified_version

modified_version = siteVolumeBin.Modified_version

$modified_version = $siteVolumeBin.Modified_version

LastErrorMessage

string LastErrorMessage { get; }

Type string

Code samples 
string lastErrorMessage = siteVolumeBin.LastErrorMessage;

Dim lastErrorMessage As String = siteVolumeBin.LastErrorMessage

last_error_message = siteVolumeBin.LastErrorMessage

$lastErrorMessage = $siteVolumeBin.LastErrorMessage

SiteVolumeBinFolder

ISIAPISiteVolumeBinFolder SiteVolumeBinFolder { get; }

Type ISIAPISiteVolumeBinFolder

Code samples 
var siteVolumeBinFolder = siteVolumeBin.SiteVolumeBinFolder;

Dim siteVolumeBinFolder As ISIAPISiteVolumeBinFolder = siteVolumeBin.SiteVolumeBinFolder

site_volume_bin_folder = siteVolumeBin.SiteVolumeBinFolder

$siteVolumeBinFolder = $siteVolumeBin.SiteVolumeBinFolder

SiteVolumeMCs

ISIAPISiteVolumeMCs SiteVolumeMCs { get; }

Type ISIAPISiteVolumeMCs

Code samples 
var siteVolumeMCs = siteVolumeBin.SiteVolumeMCs;

Dim siteVolumeMCs As ISIAPISiteVolumeMCs = siteVolumeBin.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 
var siteVolumeLegs = siteVolumeBin.SiteVolumeLegs;

Dim siteVolumeLegs As ISIAPISiteVolumeLegs = siteVolumeBin.SiteVolumeLegs

site_volume_legs = siteVolumeBin.SiteVolumeLegs

$siteVolumeLegs = $siteVolumeBin.SiteVolumeLegs

SiteVolumeMovVehODs

ISIAPISiteVolumeMovVehODs SiteVolumeMovVehODs { get; }

Type ISIAPISiteVolumeMovVehODs

Code samples 
var siteVolumeMovVehODs = siteVolumeBin.SiteVolumeMovVehODs;

Dim siteVolumeMovVehODs As ISIAPISiteVolumeMovVehODs = siteVolumeBin.SiteVolumeMovVehODs

site_volume_mov_veh_o_ds = siteVolumeBin.SiteVolumeMovVehODs

$siteVolumeMovVehODs = $siteVolumeBin.SiteVolumeMovVehODs

SiteVolumeMovPeds

ISIAPISiteVolumeMovPeds SiteVolumeMovPeds { get; }

Type ISIAPISiteVolumeMovPeds

Code samples 
var siteVolumeMovPeds = siteVolumeBin.SiteVolumeMovPeds;

Dim siteVolumeMovPeds As ISIAPISiteVolumeMovPeds = siteVolumeBin.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 
bool result = siteVolumeBin.UpdateModifiedInfo();

Dim result As Boolean = siteVolumeBin.UpdateModifiedInfo()

result = siteVolumeBin.UpdateModifiedInfo()

$result = $siteVolumeBin.UpdateModifiedInfo()