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

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPISiteScenario you need via the ISIAPI tree.
# See ISIAPI for the activation root.
siteScenario = ...

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

Properties¶

Name¶

Site Scenario name

string Name { get; set; }

Type string

Value

The Site Scenario name, max length = 100.

Code samples

C#VB.NETPythonPowerShell

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

Dim name As String = siteScenario.Name
siteScenario.Name = "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#VB.NETPythonPowerShell

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

Dim iD As String = siteScenario.ID
siteScenario.ID = "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#VB.NETPythonPowerShell

int position = siteScenario.Position;

Dim position As Integer = siteScenario.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#VB.NETPythonPowerShell

int volumeType = siteScenario.VolumeType;

Dim volumeType As Integer = siteScenario.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#VB.NETPythonPowerShell

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

Dim analyse As Boolean = siteScenario.Analyse
siteScenario.Analyse = true

analyse = siteScenario.Analyse
siteScenario.Analyse = True

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

Site¶

ISIAPISite Site { get; }

Type ISIAPISite

Code samples

C#VB.NETPythonPowerShell

var site = siteScenario.Site;

Dim site As ISIAPISite = siteScenario.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#VB.NETPythonPowerShell

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

Dim siteVolumeBin As ISIAPISiteVolumeBin = siteScenario.SiteVolumeBin
siteScenario.SiteVolumeBin = Nothing

site_volume_bin = siteScenario.SiteVolumeBin
siteScenario.SiteVolumeBin = None

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