AssignVolumeBin¶

Type ISIAPIAssignVolumeBin · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 45F138E1-8E57-48B8-85D0-F088E063ACC9

AssignVolumeBin wrapper interface

Declaration¶

[Guid("45F138E1-8E57-48B8-85D0-F088E063ACC9")]
public interface ISIAPIAssignVolumeBin

Members¶

Properties

Property	Type	Summary
AssignVolumeBin_id	`string`	The GUID of the Assign Volume Bin object.
Name	`string`	Assign Volume Bin Name
ID	`string`	Assign Volume Bin ID in the Assign Bin Setup dialog.
Position	`int`
IsInputDataCompatible	`bool`
MinViableVersionL1	`string`	Minimum Viable SIDRA INTERSECTION Version for this Assign Volume Bin's Level 1 Compatibility
MinViableVersionL2	`string`	Minimum Viable SIDRA INTERSECTION Version for this Assign Volume Bin's Level 2 Compatibility
DriveOnLeft	`bool`	Flag indicating the "Drive Rule" of the Assign Volume Bin
Units	`int`	General unit system used for data within the Assign Volume Bin
Title	`string`	Assign Volume Bin title
Description	`string`	Assign Volume Bin description
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`
AssignVolumeBinFolder	`ISIAPIAssignVolumeBinFolder`
AssignVolumeMCs	`ISIAPIAssignVolumeMCs`
AssignZones	`ISIAPIAssignZones`
AssignVolumeSets	`ISIAPIAssignVolumeSets`
Created_by_source_app_type	`int`	The type of the application that created this Assign Volume Bin.
Created_by_source_app	`string`	The name of the application that created this Assign Volume Bin.
Modified_by_source_app_type	`int`	The type of the application that modified this Assign Volume Bin.
Modified_by_source_app	`string`	The name of the application that modified this Assign Volume Bin.

Methods

Method	Returns	Summary
UpdateModifiedInfo()	`bool`	Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number
AddAssignZone()	`ISIAPIAssignZone`
RemoveAssignZone(ISIAPIAssignZone)	`bool`	Remove an Assign Zone from the current Assign Volume Bin.
CloneAssignZone(ISIAPIAssignZone)	`ISIAPIAssignZone`
MoveAssignZoneTo(ISIAPIAssignZone, int)	`bool`
AddAssignVolumeSet()	`ISIAPIAssignVolumeSet`
RemoveAssignVolumeSet(ISIAPIAssignVolumeSet)	`bool`	Remove an Assign O-D Volume Set (also known as Assign Volume Set) from the current Assign Volume Bin.
CloneAssignVolumeSet(ISIAPIAssignVolumeSet)	`ISIAPIAssignVolumeSet`
MoveAssignVolumeSetTo(ISIAPIAssignVolumeSet, int)	`bool`

Properties¶

AssignVolumeBin_id¶

The GUID of the Assign Volume Bin object.

string AssignVolumeBin_id { get; }

Type string

Code samples

C#C++Python

string assignVolumeBin_id = assignVolumeBin.AssignVolumeBin_id;

CComBSTR assignVolumeBin_id;
assignVolumeBin->get_AssignVolumeBin_id(&assignVolumeBin_id);

assign_volume_bin_id = assignVolumeBin.AssignVolumeBin_id

Name¶

Assign Volume Bin Name

string Name { get; set; }

Type string

Value

Type: System.String

Assign Volume Bin Name, max length = 100.

Code samples

C#C++Python

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

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

name = assignVolumeBin.Name
assignVolumeBin.Name = r"Example"

ID¶

Assign Volume Bin ID in the Assign Bin Setup dialog.

string ID { get; set; }

Type string

Value

Type: System.String

Assign Volume Bin ID, max length = 10.

Code samples

C#C++Python

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

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

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

Position¶

int Position { get; }

Type int

Code samples

C#C++Python

int position = assignVolumeBin.Position;

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

position = assignVolumeBin.Position

IsInputDataCompatible¶

bool IsInputDataCompatible { get; }

Type bool

Code samples

C#C++Python

bool isInputDataCompatible = assignVolumeBin.IsInputDataCompatible;

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

is_input_data_compatible = assignVolumeBin.IsInputDataCompatible

MinViableVersionL1¶

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

string MinViableVersionL1 { get; }

Type string

Remarks

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

Code samples

C#C++Python

string minViableVersionL1 = assignVolumeBin.MinViableVersionL1;

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

min_viable_version_l1 = assignVolumeBin.MinViableVersionL1

MinViableVersionL2¶

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

string MinViableVersionL2 { get; }

Type string

Remarks

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

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

Code samples

C#C++Python

string minViableVersionL2 = assignVolumeBin.MinViableVersionL2;

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

min_viable_version_l2 = assignVolumeBin.MinViableVersionL2

DriveOnLeft¶

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

bool DriveOnLeft { get; }

Type bool

Value

Type: System.Boolean.

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

Code samples

C#C++Python

bool driveOnLeft = assignVolumeBin.DriveOnLeft;

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

drive_on_left = assignVolumeBin.DriveOnLeft

Units¶

General unit system used for data within the Assign Volume Bin

int Units { get; }

Type int

Value

Type: System.Int32.

0 = Metric,
1 = US Units.

Code samples

C#C++Python

int units = assignVolumeBin.Units;

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

units = assignVolumeBin.Units

Title¶

Assign Volume Bin title

string Title { get; set; }

Type string

Value

Type: System.String.

Assign Volume Bin title, max length = 500.

Code samples

C#C++Python

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

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

title = assignVolumeBin.Title
assignVolumeBin.Title = r"value"

Description¶

Assign Volume Bin description

string Description { get; set; }

Type string

Value

Type: System.String.

Assign Volume Bin description, max length = 500.

Code samples

C#C++Python

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

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

description = assignVolumeBin.Description
assignVolumeBin.Description = r"value"

Created_date¶

DateTime Created_date { get; }

Type DateTime

Code samples

C#C++Python

var created_date = assignVolumeBin.Created_date;

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

created_date = assignVolumeBin.Created_date

Created_by¶

string Created_by { get; }

Type string

Code samples

C#C++Python

string created_by = assignVolumeBin.Created_by;

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

created_by = assignVolumeBin.Created_by

Created_by_company¶

string Created_by_company { get; }

Type string

Code samples

C#C++Python

string created_by_company = assignVolumeBin.Created_by_company;

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

created_by_company = assignVolumeBin.Created_by_company

Created_version¶

string Created_version { get; }

Type string

Code samples

C#C++Python

string created_version = assignVolumeBin.Created_version;

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

created_version = assignVolumeBin.Created_version

Modified_date¶

DateTime Modified_date { get; }

Type DateTime

Code samples

C#C++Python

var modified_date = assignVolumeBin.Modified_date;

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

modified_date = assignVolumeBin.Modified_date

Modified_by¶

string Modified_by { get; }

Type string

Code samples

C#C++Python

string modified_by = assignVolumeBin.Modified_by;

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

modified_by = assignVolumeBin.Modified_by

Modified_by_company¶

string Modified_by_company { get; }

Type string

Code samples

C#C++Python

string modified_by_company = assignVolumeBin.Modified_by_company;

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

modified_by_company = assignVolumeBin.Modified_by_company

Modified_version¶

string Modified_version { get; }

Type string

Code samples

C#C++Python

string modified_version = assignVolumeBin.Modified_version;

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

modified_version = assignVolumeBin.Modified_version

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#C++Python

string lastErrorMessage = assignVolumeBin.LastErrorMessage;

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

last_error_message = assignVolumeBin.LastErrorMessage

AssignVolumeBinFolder¶

ISIAPIAssignVolumeBinFolder AssignVolumeBinFolder { get; }

Type ISIAPIAssignVolumeBinFolder

Code samples

C#C++Python

var assignVolumeBinFolder = assignVolumeBin.AssignVolumeBinFolder;

CComPtr<ISIAPIAssignVolumeBinFolder> assignVolumeBinFolder;
assignVolumeBin->get_AssignVolumeBinFolder(&assignVolumeBinFolder);

assign_volume_bin_folder = assignVolumeBin.AssignVolumeBinFolder

AssignVolumeMCs¶

ISIAPIAssignVolumeMCs AssignVolumeMCs { get; }

Type ISIAPIAssignVolumeMCs

Code samples

C#C++Python

var assignVolumeMCs = assignVolumeBin.AssignVolumeMCs;

CComPtr<ISIAPIAssignVolumeMCs> assignVolumeMCs;
assignVolumeBin->get_AssignVolumeMCs(&assignVolumeMCs);

assign_volume_m_cs = assignVolumeBin.AssignVolumeMCs

AssignZones¶

ISIAPIAssignZones AssignZones { get; }

Type ISIAPIAssignZones

Code samples

C#C++Python

var assignZones = assignVolumeBin.AssignZones;

CComPtr<ISIAPIAssignZones> assignZones;
assignVolumeBin->get_AssignZones(&assignZones);

assign_zones = assignVolumeBin.AssignZones

AssignVolumeSets¶

ISIAPIAssignVolumeSets AssignVolumeSets { get; }

Type ISIAPIAssignVolumeSets

Code samples

C#C++Python

var assignVolumeSets = assignVolumeBin.AssignVolumeSets;

CComPtr<ISIAPIAssignVolumeSets> assignVolumeSets;
assignVolumeBin->get_AssignVolumeSets(&assignVolumeSets);

assign_volume_sets = assignVolumeBin.AssignVolumeSets

Created_by_source_app_type¶

The type of the application that created this Assign Volume Bin.

int Created_by_source_app_type { get; }

Type int

Value

One of:

1 - SIDRA INTERSECTION Main Application
2 - SI API Application

Code samples

C#C++Python

int created_by_source_app_type = assignVolumeBin.Created_by_source_app_type;

long created_by_source_app_type;
assignVolumeBin->get_Created_by_source_app_type(&created_by_source_app_type);

created_by_source_app_type = assignVolumeBin.Created_by_source_app_type

Created_by_source_app¶

The name of the application that created this Assign Volume Bin.

string Created_by_source_app { get; }

Type string

Code samples

C#C++Python

string created_by_source_app = assignVolumeBin.Created_by_source_app;

CComBSTR created_by_source_app;
assignVolumeBin->get_Created_by_source_app(&created_by_source_app);

created_by_source_app = assignVolumeBin.Created_by_source_app

Modified_by_source_app_type¶

The type of the application that modified this Assign Volume Bin.

int Modified_by_source_app_type { get; }

Type int

Value

One of:

1 - SIDRA INTERSECTION Main Application
2 - SI API Application

Code samples

C#C++Python

int modified_by_source_app_type = assignVolumeBin.Modified_by_source_app_type;

long modified_by_source_app_type;
assignVolumeBin->get_Modified_by_source_app_type(&modified_by_source_app_type);

modified_by_source_app_type = assignVolumeBin.Modified_by_source_app_type

Modified_by_source_app¶

The name of the application that modified this Assign Volume Bin.

string Modified_by_source_app { get; }

Type string

Code samples

C#C++Python

string modified_by_source_app = assignVolumeBin.Modified_by_source_app;

CComBSTR modified_by_source_app;
assignVolumeBin->get_Modified_by_source_app(&modified_by_source_app);

modified_by_source_app = assignVolumeBin.Modified_by_source_app

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++Python

bool result = assignVolumeBin.UpdateModifiedInfo();

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

result = assignVolumeBin.UpdateModifiedInfo()

AddAssignZone()¶

ISIAPIAssignZone AddAssignZone()

Returns ISIAPIAssignZone

Code samples

C#C++Python

var result = assignVolumeBin.AddAssignZone();

CComPtr<ISIAPIAssignZone> result;
assignVolumeBin->AddAssignZone(&result);

result = assignVolumeBin.AddAssignZone()

RemoveAssignZone(ISIAPIAssignZone)¶

Remove an Assign Zone from the current Assign Volume Bin.

bool RemoveAssignZone(ISIAPIAssignZone assignZone)

Parameters

Name	Type	Description
`assignZone`	`ISIAPIAssignZone`	the Assign Zone to be removed

Returns bool - true if the Assign Zone is removed successfully.

Remarks

An Exception or Error is thrown if the Assign Zone has been connected to a Network Site in an Assign Network.

Code samples

C#C++Python

bool result = assignVolumeBin.RemoveAssignZone(null);

VARIANT_BOOL result;
assignVolumeBin->RemoveAssignZone(NULL, &result);

result = assignVolumeBin.RemoveAssignZone(None)

CloneAssignZone(ISIAPIAssignZone)¶

ISIAPIAssignZone CloneAssignZone(ISIAPIAssignZone assignZone)

Parameters

Name	Type	Description
`assignZone`	`ISIAPIAssignZone`

Returns ISIAPIAssignZone

Code samples

C#C++Python

var result = assignVolumeBin.CloneAssignZone(null);

CComPtr<ISIAPIAssignZone> result;
assignVolumeBin->CloneAssignZone(NULL, &result);

result = assignVolumeBin.CloneAssignZone(None)

MoveAssignZoneTo(ISIAPIAssignZone, int)¶

bool MoveAssignZoneTo(ISIAPIAssignZone assignZone, int newPosition)

Parameters

Name	Type	Description
`assignZone`	`ISIAPIAssignZone`
`newPosition`	`int`

Returns bool

Code samples

C#C++Python

bool result = assignVolumeBin.MoveAssignZoneTo(null, 0);

VARIANT_BOOL result;
assignVolumeBin->MoveAssignZoneTo(NULL, 0, &result);

result = assignVolumeBin.MoveAssignZoneTo(None, 0)

AddAssignVolumeSet()¶

ISIAPIAssignVolumeSet AddAssignVolumeSet()

Returns ISIAPIAssignVolumeSet

Code samples

C#C++Python

var result = assignVolumeBin.AddAssignVolumeSet();

CComPtr<ISIAPIAssignVolumeSet> result;
assignVolumeBin->AddAssignVolumeSet(&result);

result = assignVolumeBin.AddAssignVolumeSet()

RemoveAssignVolumeSet(ISIAPIAssignVolumeSet)¶

Remove an Assign O-D Volume Set (also known as Assign Volume Set) from the current Assign Volume Bin.

bool RemoveAssignVolumeSet(ISIAPIAssignVolumeSet assignVolSet)

Parameters

Name	Type	Description
`assignVolSet`	`ISIAPIAssignVolumeSet`	the Assign O-D Volume Set to be removed

Returns bool - true if the Assign O-D Volume Set is removed successfully.

Remarks

An Exception or Error is thrown if the O-D Volume Set has been linked to an Assign Network's Scenario.

Code samples

C#C++Python

bool result = assignVolumeBin.RemoveAssignVolumeSet(null);

VARIANT_BOOL result;
assignVolumeBin->RemoveAssignVolumeSet(NULL, &result);

result = assignVolumeBin.RemoveAssignVolumeSet(None)

CloneAssignVolumeSet(ISIAPIAssignVolumeSet)¶

ISIAPIAssignVolumeSet CloneAssignVolumeSet(ISIAPIAssignVolumeSet assignVolSet)

Parameters

Name	Type	Description
`assignVolSet`	`ISIAPIAssignVolumeSet`

Returns ISIAPIAssignVolumeSet

Code samples

C#C++Python

var result = assignVolumeBin.CloneAssignVolumeSet(null);

CComPtr<ISIAPIAssignVolumeSet> result;
assignVolumeBin->CloneAssignVolumeSet(NULL, &result);

result = assignVolumeBin.CloneAssignVolumeSet(None)

MoveAssignVolumeSetTo(ISIAPIAssignVolumeSet, int)¶

bool MoveAssignVolumeSetTo(ISIAPIAssignVolumeSet assignVolSet, int newPosition)

Parameters

Name	Type	Description
`assignVolSet`	`ISIAPIAssignVolumeSet`
`newPosition`	`int`

Returns bool

Code samples

C#C++Python

bool result = assignVolumeBin.MoveAssignVolumeSetTo(null, 0);

VARIANT_BOOL result;
assignVolumeBin->MoveAssignVolumeSetTo(NULL, 0, &result);

result = assignVolumeBin.MoveAssignVolumeSetTo(None, 0)