SiteScenario¶

Type ISIAPISiteScenario · Interface
Namespace SIDRASolutions.SI.API
Assembly SIDRASolutions.SI.API.dll
COM CLSID 57A33882-9109-4551-BA83-0398584E5C57

Declaration¶

[Guid("57A33882-9109-4551-BA83-0398584E5C57")]
public interface ISIAPISiteScenario

Members¶

Properties

Property	Type	Summary
Name	`string`	Site Scenario name
ID	`string`	Site Scenario ID in the Site Scenarios dialog and reports.
Position	`int`
VolumeType	`int`	Site Scenario Volume Type
Analyse	`bool`	Flag indicating this Site Scenario is applied to the Site.
Site	`ISIAPISite`
SiteVolumeBin	`ISIAPISiteVolumeBin`	Site Volume Bin that is linked to this Scenario.

Properties¶

Name¶

Site Scenario name

string Name { get; set; }

Type string

Value

The Site Scenario name, max length = 100.

Code samples

C#C++PythonPowerShell

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

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

name = siteScenario.Name
siteScenario.Name = r"Example"

$name = $siteScenario.Name
$siteScenario.Name = "Example"

ID¶

Site Scenario ID in the Site Scenarios dialog and reports.

string ID { get; set; }

Type string

Value

Site Scenario ID, max length = 10.

Code samples

C#C++PythonPowerShell

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

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

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

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

Position¶

int Position { get; }

Type int

Code samples

C#C++PythonPowerShell

int position = siteScenario.Position;

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

position = siteScenario.Position

$position = $siteScenario.Position

VolumeType¶

Site Scenario Volume Type

int VolumeType { get; }

Type int

Value

One of:

0 - Local, the Site's local volumes are applied
1 - Linked, the linked SiteVolumeBin's volumes are applied

Code samples

C#C++PythonPowerShell

int volumeType = siteScenario.VolumeType;

long volumeType;
siteScenario->get_VolumeType(&volumeType);

volume_type = siteScenario.VolumeType

$volumeType = $siteScenario.VolumeType

Analyse¶

Flag indicating this Site Scenario is applied to the Site.

bool Analyse { get; set; }

Type bool

Code samples

C#C++PythonPowerShell

bool analyse = siteScenario.Analyse;
siteScenario.Analyse = true;

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

analyse = siteScenario.Analyse
siteScenario.Analyse = True

$analyse = $siteScenario.Analyse
$siteScenario.Analyse = $true

Site¶

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#C++PythonPowerShell

var site = siteScenario.Site;

CComPtr<ISIAPISite> site;
siteScenario->get_Site(&site);

site = siteScenario.Site

$site = $siteScenario.Site

SiteVolumeBin¶

Site Volume Bin that is linked to this Scenario.

ISIAPISiteVolumeBin SiteVolumeBin { get; set; }

Type ISIAPISiteVolumeBin

Remarks

This SiteVolumeBin property only applies to the SiteScenario which VolumeType == 1 (Linked).

Code samples

C#C++PythonPowerShell

var siteVolumeBin = siteScenario.SiteVolumeBin;
siteScenario.SiteVolumeBin = null;

CComPtr<ISIAPISiteVolumeBin> siteVolumeBin;
siteScenario->get_SiteVolumeBin(&siteVolumeBin);
siteScenario->put_SiteVolumeBin(NULL);

site_volume_bin = siteScenario.SiteVolumeBin
siteScenario.SiteVolumeBin = None

$siteVolumeBin = $siteScenario.SiteVolumeBin
$siteScenario.SiteVolumeBin = $null