AssignSchemeDemandScenario

Type ISIAPIAssignSchemeDemandScenario · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 855904A2-C597-43A4-AEAA-700D0EA1E1C2

AssignSchemeDemandScenario wrapper interface

Declaration

[Guid("855904A2-C597-43A4-AEAA-700D0EA1E1C2")]
public interface ISIAPIAssignSchemeDemandScenario

Members

Properties

Property	Type	Summary
Name	string	Assign Scheme Demand Scenario name
ID	string	Assign Scheme Demand Scenario ID in the Assign Scenarios dialog and reports.
Position	int
Analyse	bool	Flag indicating this Assign Scheme Demand Scenario is applied to the Assign Network.
AddSiteVolumesAsBase	bool	Flag indicating the Site Volumes are used to initiate the Assign Network Volumes.
AssignScheme	ISIAPIAssignScheme
AssignVolumeSet	ISIAPIAssignVolumeSet	Assign Volume Set that is linked to this Scenario.

Properties

Name

Assign Scheme Demand Scenario name

string Name { get; set; }

Type string

Value

Type: System.String

The Assign Scheme Demand Scenario's name, max length = 100.

Code samples

C#C++Python

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

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

name = assignSchemeDemandScenario.Name
assignSchemeDemandScenario.Name = r"Example"

ID

Assign Scheme Demand Scenario ID in the Assign Scenarios dialog and reports.

string ID { get; set; }

Type string

Value

Type: System.String

The Assign Scheme Demand Scenario's ID, max length = 10.

Code samples

C#C++Python

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

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

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

Position

int Position { get; }

Type int

Code samples

C#C++Python

int position = assignSchemeDemandScenario.Position;

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

position = assignSchemeDemandScenario.Position

Analyse

Flag indicating this Assign Scheme Demand Scenario is applied to the Assign Network.

bool Analyse { get; set; }

Type bool

Code samples

C#C++Python

bool analyse = assignSchemeDemandScenario.Analyse;
assignSchemeDemandScenario.Analyse = true;

VARIANT_BOOL analyse;
assignSchemeDemandScenario->get_Analyse(&analyse);
assignSchemeDemandScenario->put_Analyse(VARIANT_TRUE);

analyse = assignSchemeDemandScenario.Analyse
assignSchemeDemandScenario.Analyse = True

AddSiteVolumesAsBase

Flag indicating the Site Volumes are used to initiate the Assign Network Volumes.

bool AddSiteVolumesAsBase { get; set; }

Type bool

Remarks

This is corresponding to the Initial Vehicle Volume option in the Assign Scenarios dialog. When this is true, the option is set to "Use Site Volumes"; otherwise, the option is set to "None".

Code samples

C#C++Python

bool addSiteVolumesAsBase = assignSchemeDemandScenario.AddSiteVolumesAsBase;
assignSchemeDemandScenario.AddSiteVolumesAsBase = true;

VARIANT_BOOL addSiteVolumesAsBase;
assignSchemeDemandScenario->get_AddSiteVolumesAsBase(&addSiteVolumesAsBase);
assignSchemeDemandScenario->put_AddSiteVolumesAsBase(VARIANT_TRUE);

add_site_volumes_as_base = assignSchemeDemandScenario.AddSiteVolumesAsBase
assignSchemeDemandScenario.AddSiteVolumesAsBase = True

AssignScheme

ISIAPIAssignScheme AssignScheme { get; }

Type ISIAPIAssignScheme

Code samples

C#C++Python

var assignScheme = assignSchemeDemandScenario.AssignScheme;

CComPtr<ISIAPIAssignScheme> assignScheme;
assignSchemeDemandScenario->get_AssignScheme(&assignScheme);

assign_scheme = assignSchemeDemandScenario.AssignScheme

AssignVolumeSet

Assign Volume Set that is linked to this Scenario.

ISIAPIAssignVolumeSet AssignVolumeSet { get; set; }

Type ISIAPIAssignVolumeSet

Code samples

C#C++Python

var assignVolumeSet = assignSchemeDemandScenario.AssignVolumeSet;
assignSchemeDemandScenario.AssignVolumeSet = null;

CComPtr<ISIAPIAssignVolumeSet> assignVolumeSet;
assignSchemeDemandScenario->get_AssignVolumeSet(&assignVolumeSet);
assignSchemeDemandScenario->put_AssignVolumeSet(NULL);

assign_volume_set = assignSchemeDemandScenario.AssignVolumeSet
assignSchemeDemandScenario.AssignVolumeSet = None