ISIAPINetworkScenario Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: ACE73758-FDD9-4C77-8349-BB5846E313A9

Declaration¶

[Guid("ACE73758-FDD9-4C77-8349-BB5846E313A9")]
public interface ISIAPINetworkScenario

Get an instance¶

C#VB.NETPythonPowerShell

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

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

# Navigate to the ISIAPINetworkScenario you need via the ISIAPI tree.
# See ISIAPI for the activation root.
networkScenario = ...

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

Properties¶

Name¶

Network Scenario name

string Name { get; set; }

Type string

Value

The Network Scenario name, max length = 100.

Code samples

C#VB.NETPythonPowerShell

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

Dim name As String = networkScenario.Name
networkScenario.Name = "Example"

name = networkScenario.Name
networkScenario.Name = r"Example"

$name = $networkScenario.Name
$networkScenario.Name = "Example"

ID¶

Network Scenario ID in the Network Scenarios dialog and reports.

string ID { get; set; }

Type string

Value

Network Scenario ID, max length = 10.

Code samples

C#VB.NETPythonPowerShell

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

Dim iD As String = networkScenario.ID
networkScenario.ID = "id-1"

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

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

Position¶

int Position { get; }

Type int

Code samples

C#VB.NETPythonPowerShell

int position = networkScenario.Position;

Dim position As Integer = networkScenario.Position

position = networkScenario.Position

$position = $networkScenario.Position

VolumeType¶

Network Scenario Volume Type

int VolumeType { get; }

Type int

Value

One of:

0 - Local, the local volumes of the Sites in the Network are applied
2 - Custom, the Site Scenarios defined in the property NetworkSiteScenarios collection are applied

Code samples

C#VB.NETPythonPowerShell

int volumeType = networkScenario.VolumeType;

Dim volumeType As Integer = networkScenario.VolumeType

volume_type = networkScenario.VolumeType

$volumeType = $networkScenario.VolumeType

Analyse¶

Flag indicating this Network Scenario is applied to the Network.

bool Analyse { get; set; }

Type bool

Code samples

C#VB.NETPythonPowerShell

bool analyse = networkScenario.Analyse;
networkScenario.Analyse = true;

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

analyse = networkScenario.Analyse
networkScenario.Analyse = True

$analyse = $networkScenario.Analyse
$networkScenario.Analyse = $true

Network¶

ISIAPINetwork Network { get; }

Type ISIAPINetwork

Code samples

C#VB.NETPythonPowerShell

var network = networkScenario.Network;

Dim network As ISIAPINetwork = networkScenario.Network

network = networkScenario.Network

$network = $networkScenario.Network

NetworkSiteScenarios¶

NetworkSiteScenarios collection for this Scenario.

ISIAPINetworkSiteScenarios NetworkSiteScenarios { get; }

Type ISIAPINetworkSiteScenarios

Remarks

This NetworkSiteScenarios property only applies to the Network Scenario which VolumeType == 2 (Custom).

Code samples

C#VB.NETPythonPowerShell

var networkSiteScenarios = networkScenario.NetworkSiteScenarios;

Dim networkSiteScenarios As ISIAPINetworkSiteScenarios = networkScenario.NetworkSiteScenarios

network_site_scenarios = networkScenario.NetworkSiteScenarios

$networkSiteScenarios = $networkScenario.NetworkSiteScenarios